merged updates to rails installers and docs

Author: catmando

docs/installation/installation.md

@@ -32,7 +32,7 @@ Add the rails-hyperstack gem to your Gemfile, and then bundle install.  This can
 bundle add 'rails-hyperstack', --version "~> 1.0.alpha1.0"
 ```
 
-> If you want to use the unreleased edge branch your gem specification will be:  
+> If you want to use the unreleased edge branch your gem specification will be:
 ```ruby
 gem 'rails-hyperstack',
      git: 'git://github.com/hyperstack-org/hyperstack.git',
@@ -57,14 +57,24 @@ Each of these pieces can be skipped or installed independently either using
 built in installers and generators, or manually as explained in the
 following sections.
 
+At this point, you're fully installed.
+
+If you're installing into a new rails app, you can run bundle exec foreman start
+to start the server, and "app" will display on the top left hand side of the page.
+
+If you're installing into an existing Rails apps, you can run bundle exec foreman start
+to start the server, and your app should funcion exactly as it always has. From here, you'll need to
+[add a Hypercomponent](#<user-content-adding-a-single-component-to-your-application>)
+to have Hyperstack funcionality.
+
 ## Summary of Installers and Generators
 
 ```
 bundle exec ... # for best results always use bundle exec!
 rails hyperstack:install                  # full system install
-rails hyperstack:install:webpack-only     # just add webpack
+rails hyperstack:install:webpack          # just add webpack
 rails hyperstack:install:skip-webpack     # all but webpack
-rails hyperstack:install:hyper-model-only # just add hyper-model
+rails hyperstack:install:hyper-model      # just add hyper-model
 rails hyperstack:install:skip-hyper-model # all but hyper-model
 rails hyperstack:install:hotloader-only   # just add the hotloader
 rails hyperstack:install:skip-hotloader   # skip the hotloader
@@ -98,8 +108,8 @@ rails g hyper:router CompName        # adds a router component
 # Note that hyperstack:install is the same as running:
 
 rails g hyper:component App --add-route
-rails hyperstack:install:webpack-only
-rails hyperstack:install:hyper-model-only
+rails hyperstack:install:webpack
+rails hyperstack:install:hyper-model
 rails hyperstack:install:hotloader-only
 ```
 
@@ -113,9 +123,9 @@ The following subdirectories are standard:
 app/
   ...
   hyperstack/
-    components/  
-    models/      
-    operations/   
+    components/
+    models/
+    operations/
     stores/
     shared/
     lib/
@@ -158,8 +168,8 @@ class HyperComponent
   param_accessor_style :accessors
 end
 ```
-> Note: You can override the base class name using the `--base-class` switch:  
-> For example if you prefer ApplicationComponent rather than HyperComponent  
+> Note: You can override the base class name using the `--base-class` switch:
+> For example if you prefer ApplicationComponent rather than HyperComponent
 ```bash
 bundle exec rails g hyper:component Test --base-class=ApplicationComponent
 ```
@@ -200,7 +210,7 @@ and override the default layout
 
 For example
 ```erb
-   <% render_component 'Dashboard', user: @user %>
+   <%= react_component 'Dashboard', user: @user %>
 ```
 > Note that you may have several component trees mounted in a single page using the `render_component` helper.  While this is not typical for a clean sheet Hyperstack design, it is useful when mixing Hyperstack with legacy applications.
 
@@ -253,7 +263,7 @@ various routing methods.
 
 > Note that in a large app you may have several single page apps working together,
 along with some legacy routes.
-In such an application the router structure might look like this:  
+In such an application the router structure might look like this:
 ```ruby
 Rails.application.routes.draw do
   ... # legacy routes
@@ -332,7 +342,7 @@ Webpacker uses manifests to determine how to package up assets.  Hyperstack depe
 >
 > This means that page load time is comparable to any other Rails view, and that Rails can cache the pages like any other view.
 >
-> But to make this work packages that rely on the `browser` object cannot be used during prerendering.  Well structured packages that depend on the `browser` object will have a way to run in the prerendering environment.  
+> But to make this work packages that rely on the `browser` object cannot be used during prerendering.  Well structured packages that depend on the `browser` object will have a way to run in the prerendering environment.
 
 These two files look like this and are placed in the `app/javascript/packs` directory:
 ```javascript
@@ -387,13 +397,13 @@ include them in the sprockets asset pipeline.
 To add the packages using yarn run these commands:
 
 ```bash
-yarn 'react', '16'
-yarn 'react-dom', '16'
-yarn 'react-router', '^5.0.0'
-yarn 'react-router-dom', '^5.0.0'
-yarn 'react_ujs', '^2.5.0'
+yarn add react@16
+yarn add react-dom@16
+yarn add react-router@^5.0.0
+yarn add react-router-dom@^5.0.0
+yarn add react_ujs@^2.5.0
+yarn add jquery@^3.4.1
 ```
-
 And then add a `cancel_import` directive to the `hyperstack.rb` initializer in your the Rails `config/initializers` directory:
 
 ```ruby
@@ -464,7 +474,7 @@ policies for legacy parts of your system.
 
 #### Moving the `application_record.rb` File.
 
-Once you have a basic Policy defined the client can access your Rails models.  For your ActiveRecord model class definitions to be visible on the client you need to move them to the `app/hyperstack/models` directory.  This directory (along with `app/hyperstack/operations` and `app/hyperstack/shared`) are *isomorphic* directories.  The code in these directories will be accessible on both the client and the server.  
+Once you have a basic Policy defined the client can access your Rails models.  For your ActiveRecord model class definitions to be visible on the client you need to move them to the `app/hyperstack/models` directory.  This directory (along with `app/hyperstack/operations` and `app/hyperstack/shared`) are *isomorphic* directories.  The code in these directories will be accessible on both the client and the server.
 > Moving the files is necessary both because of the way Rails is structured, but its also very useful when evolving legacy systems to Hyperstack.  Until a class
 definition is moved to the `hyperstack/models` directory it will be ignored by Hyperstack.
 
@@ -537,14 +547,14 @@ bundle exec hyperstack-hotloader -p 25222 -d app/hyperstack
 This will tell the Hotloader to use port 25222, and to scan the
 `app/hyperstack` directory.
 
-> If for some reason you cannot use port 25222 you can change it, but you need to also configure this in the Hyperstack initializer file:  
+> If for some reason you cannot use port 25222 you can change it, but you need to also configure this in the Hyperstack initializer file:
 ```ruby
   ...
   config.hotloader_port = 12345 # override default of 25222
   ...
 ```
 
-Now that the Hotloader is running, you can start your Rails server the normal way, and refresh your browser page.  
+Now that the Hotloader is running, you can start your Rails server the normal way, and refresh your browser page.
 You should now see `require 'hyperstack/hotloader' # CLIENT ONLY` added to the manifest,
 and you will also see a message indicating that your browser has connected to the Hotloader.
 
@@ -629,7 +639,7 @@ Hyperstack.configuration do |config|
   config.import 'path/to/file', client_only: true # but only in the client manifest
   config.import 'path/to/file', server_only: true # but only on the server_only manifest
 
-  # The cancel_import directive removes an import.  This is used when we replace  
+  # The cancel_import directive removes an import.  This is used when we replace
   # assets from the rails side with those loaded by webpacker
   config.cancel_import 'path/to/file'
 end

ruby/rails-hyperstack/lib/generators/hyperstack/install_generator.rb

@@ -25,7 +25,7 @@ def add_hotloader
       unless Hyperstack.imported? 'hyperstack/hotloader'
         inject_into_initializer(
           "Hyperstack.import 'hyperstack/hotloader', "\
-          "client_only: true if Rails.env.development?"
+          'client_only: true if Rails.env.development?'
         )
       end
       create_file 'Procfile', <<-TEXT
@@ -80,7 +80,6 @@ def add_webpacker_manifests
   config.assets.paths << Rails.root.join('public', 'packs-test', 'js').to_s
         RUBY
       end
-
     end
 
     def add_webpacks
@@ -98,24 +97,24 @@ def cancel_react_source_import
       return if skip_webpack?
       inject_into_initializer(
         "Hyperstack.cancel_import 'react/react-source-browser' "\
-        "# bring your own React and ReactRouter via Yarn/Webpacker"
+        '# bring your own React and ReactRouter via Yarn/Webpacker'
       )
     end
 
     def install_webpacker
       return if skip_webpack?
       gem 'webpacker'
       Bundler.with_clean_env do
-        run "bundle install"
+        run 'bundle install'
       end
       run 'bundle exec rails webpacker:install'
     end
 
     def create_policies_directory
       return if skip_hyper_model?
-      policy_file = File.join('app', 'hyperstack', 'models', 'application_record.rb')
-      unless File.exists? policy_file
-        create_file 'policy_file', <<-RUBY
+      policy_file = File.join('app', 'policies', 'application_policy.rb')
+      unless File.exist? policy_file
+        create_file policy_file, <<-RUBY
   # #{policy_file}
 
   # Policies regulate access to your public models
@@ -141,7 +140,7 @@ def move_and_update_application_record
       return if skip_hyper_model?
       rails_app_record_file = File.join('app', 'models', 'application_record.rb')
       hyper_app_record_file = File.join('app', 'hyperstack', 'models', 'application_record.rb')
-      unless File.exists? hyper_app_record_file
+      unless File.exist? hyper_app_record_file
         empty_directory File.join('app', 'hyperstack', 'models')
         `mv #{rails_app_record_file} #{hyper_app_record_file}`
         create_file rails_app_record_file, <<-RUBY
@@ -162,21 +161,24 @@ def add_engine_route
     def report
       say "\n\n"
       unless skip_adding_component?
-        say "🎢 Top Level App Component successfully installed at app/hyperstack/components/app.rb 🎢", :green
+        say '🎢 Top Level App Component successfully installed at app/hyperstack/components/app.rb 🎢', :green
+      end
+      if !new_rails_app?
+        say '🎢 Top Level App Component skipped, you can manually generate it later 🎢', :green
       end
       unless skip_webpack?
-        say "📦 Webpack integrated with Hyperstack.  "\
-            "Add javascript assets to app/javascript/packs/client_only.js and /client_and_server.js 📦", :green
+        say '📦 Webpack integrated with Hyperstack.  '\
+            'Add javascript assets to app/javascript/packs/client_only.js and /client_and_server.js 📦', :green
       end
       unless skip_hyper_model?
-        say "👩‍✈️ Basic development policy defined.  See app/policies/application_policy.rb 👨🏽‍✈️", :green
-        say "💽 HyperModel installed. Move any Active Record models to the app/hyperstack/models to access them from the client 📀", :green
+        say '👩‍✈️ Basic development policy defined.  See app/policies/application_policy.rb 👨🏽‍✈️', :green
+        say '💽 HyperModel installed. Move any Active Record models to the app/hyperstack/models to access them from the client 📀', :green
       end
-      if File.exists?(init = File.join('config', 'initializers', 'hyperstack.rb'))
+      if File.exist?(init = File.join('config', 'initializers', 'hyperstack.rb'))
         say "☑️  Check #{init} for other configuration options. ☑️", :green
       end
       unless skip_hotloader?
-        say "🚒 Hyperstack Hotloader installed - use bundle exec foreman start and visit localhost:5000 🚒", :green
+        say '🚒 Hyperstack Hotloader installed - use bundle exec foreman start and visit localhost:5000 🚒', :green
       end
 
       say "\n\n"
@@ -185,7 +187,7 @@ def report
     private
 
     def skip_adding_component?
-      options['hotloader-only'] || options['webpack-only'] || options['hyper-model-only']
+      options['hotloader-only'] || options['webpack-only'] || options['hyper-model-only'] || !new_rails_app?
     end
 
     def skip_hotloader?
@@ -200,9 +202,24 @@ def skip_hyper_model?
       options['hotloader-only'] || options['webpack-only'] || options['skip-hyper-model']
     end
 
+    def new_rails_app?
+      # check to see if there are any routes set up and remember it, cause we might add a route in the process
+      @new_rails_app ||= begin
+        route_file = File.join('config', 'routes.rb')
+        count = File.foreach(route_file).inject(0) do |c, line|
+          line = line.strip
+          next c if line.empty?
+          next c if line.start_with?('#')
+          next c if line.start_with?('mount')
+          c + 1
+        end
+        count <= 2
+      end
+    end
+
     def inject_into_initializer(s)
       file_name = File.join('config', 'initializers', 'hyperstack.rb')
-      if File.exists?(file_name)
+      if File.exist?(file_name)
         prepend_to_file(file_name) { "#{s}\n" }
       else
         create_file file_name, <<-RUBY

ruby/rails-hyperstack/lib/generators/hyperstack/install_generator_base.rb

@@ -26,7 +26,7 @@ def create_component_file(template)
 
 
       def clear_cache
-        run 'rm -rf tmp/cache' unless Dir.exists?(File.join('app', 'hyperstack'))
+        run 'rm -rf tmp/cache' unless Dir.exist?(File.join('app', 'hyperstack'))
       end
 
       def insure_hyperstack_loader_installed
@@ -54,17 +54,16 @@ def insure_hyperstack_loader_installed
         end
       end
 
-
       def insure_base_component_class_exists
         @component_base_class = options['base-class'] || Hyperstack.component_base_class
         file_name = File.join(
           'app', 'hyperstack', 'components', "#{@component_base_class.underscore}.rb"
         )
-        template 'hyper_component_template.rb', file_name unless File.exists? file_name
+        template 'hyper_component_template.rb', file_name unless File.exist? file_name
       end
 
       def add_to_manifest(manifest, &block)
-        if File.exists? "app/javascript/packs/#{manifest}"
+        if File.exist? "app/javascript/packs/#{manifest}"
           append_file "app/javascript/packs/#{manifest}", &block
         else
           create_file "app/javascript/packs/#{manifest}", &block
@@ -82,11 +81,11 @@ def add_route
         end
         action_name = (@modules+[@file_name.underscore]).join('__')
         path = options['add-route'] == 'add-route' ? '/(*others)' : options['add-route']
-        routing_code = "get '#{path}', to: 'hyperstack##{action_name}'"
+        routing_code = "get '#{path}', to: 'hyperstack##{action_name}'\n"
         log :route, routing_code
         [/mount\s+Hyperstack::Engine[^\n]+\n/m, /\.routes\.draw do\s*\n/m].each do |sentinel|
           in_root do
-            x = inject_into_file "config/routes.rb", optimize_indentation(routing_code, 2), after: sentinel, verbose: false, force: false
+            inject_into_file 'config/routes.rb', routing_code.indent(2), after: sentinel, verbose: false, force: false
           end
         end
       end

ruby/rails-hyperstack/lib/tasks/hyperstack/install.rake

@@ -13,10 +13,10 @@ namespace :hyperstack do
     task "hotloader-only" do
       exec "#{RbConfig.ruby} #{bin_path}/rails g hyperstack:install --hotloader-only"
     end
-    task "webpack-only" do
+    task "webpack" do
       exec "#{RbConfig.ruby} #{bin_path}/rails g hyperstack:install --webpack-only"
     end
-    task "hyper-model-only" do
+    task "hyper-model" do
       exec "#{RbConfig.ruby} #{bin_path}/rails g hyperstack:install --hyper-model-only"
     end
     task "skip-hotloader" do