rails-hyperstack 1.0.alpha1.4 → 1.0.alpha1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03702710230166a76d49beb8d461771b8e0ea8f51d96189860742bd7eab0cac4
-  data.tar.gz: 322d226a3ca3c5462bdda5360ea6e5a10e6feac9a0bce9f3faf299f0fc76b850
+  metadata.gz: 8c8b7f53db3107e49c7b59eab1b4cc9d5548ef6cfee842fb971fa516b1b75469
+  data.tar.gz: b05b41840ccf479ff2011fa70dc35a879715100d99a4e33d2a1d1817d9c9e330
 SHA512:
-  metadata.gz: ed06a20e392fe2bcc404ff125a15d9abcdc2f762cd6a2e872b626e24d70f3bb9b2da71b812a450b47a4a6c5bac47440d4171f09c2fb6f6cb291e1baf711807f8
-  data.tar.gz: e21862ee2f9807bb5a4d730622ad9d34db6b05414759bb72c0e82157ac7a886826cd9b5ac51204f21492e80dd4675d2fcfc46d04cc3821283f082ff87cd79876
+  metadata.gz: 2c1a4c77d0def6a0895879f776ede450bc63e33ff96d555df70a19e33b666c9f510cd8c96bdad218446477386c1d31ac51961daae461189274b4024cbaf5513e
+  data.tar.gz: aa53c533efc6d297c77a3f34ae5f2f0385868685270f1c7f5742b75d980d61a6f32dfda4ccd9137edd0abdda3a471ba39b2ba86973afdc5709dc33401625fc2a

data/lib/generators/hyper/component_generator.rb

@@ -1,20 +1,7 @@
-require 'rails/generators'
 module Hyper
-  class Component < Rails::Generators::Base
-    source_root File.expand_path('../templates', __FILE__)
-
-    argument :components, type: :array
-    def create_component_file
-      self.components.each do |component|
-        component_array = component.split('::')
-        @modules = component_array[0..-2]
-        @file_name = component_array.last
-        @indent = 0
-        template 'component_template.rb',
-                 File.join('app/hyperstack/components',
-                           @modules.map(&:downcase).join('/'),
-                           "#{@file_name.underscore}.rb")
-      end
+  class Component < GeneratorBase
+    def add_component
+      create_component_file 'component_template.rb'
     end
   end
 end

data/lib/generators/hyper/generator_base.rb

@@ -0,0 +1,18 @@
+require 'rails/generators'
+module Hyper
+  class GeneratorBase < Rails::Generators::Base
+    class << self
+      alias rails_inherited inherited
+      def inherited(child)
+        rails_inherited(child)
+        child.class_eval do
+          source_root File.expand_path('../templates', __FILE__)
+          argument :components, type: :array
+          class_option 'base-class', :default => nil # will pull in value from config setting
+          class_option 'add-route', :default => nil
+          class_option 'no-help', :default => nil
+        end
+      end
+    end
+  end
+end

data/lib/generators/hyper/router_generator.rb

@@ -1,23 +1,7 @@
-require 'rails/generators'
 module Hyper
-  class Router < Rails::Generators::Base
-    source_root File.expand_path('../templates', __FILE__)
-
-    argument :component, type: :string
-    class_option :path, type: :string, default: '/(*other)'
-    def create_component_file
-      component_array = component.split('::')
-      @modules = component_array[0..-2]
-      @file_name = component_array.last
-      @indent = 0
-      template 'router_template.rb',
-               File.join('app/hyperstack/components',
-                         @modules.map(&:downcase).join('/'),
-                         "#{@file_name.underscore}.rb")
-    end
-
-    def add_route
-      route "get '#{options['path']}', to: 'hyperstack##{@file_name.underscore}'"
+  class Router < GeneratorBase
+    def add_router_component
+      create_component_file 'router_template.rb'
     end
   end
 end

data/lib/generators/hyper/templates/component_template.rb

@@ -1,15 +1,24 @@
 <%- @modules.each do |module_name| %><%= "  "* @indent %>module <%= module_name.camelize %><%- @indent += 1 %>
-<%- end %><%="  "* @indent %>class <%= @file_name %> < Hyperstack::Component
-
+<%- end %><%="  "* @indent %>class <%= @file_name %> < <%= @component_base_class %>
+<%- unless @no_help %>
 <%="  "* @indent %>  # param :my_param
 <%="  "* @indent %>  # param param_with_default: "default value"
 <%="  "* @indent %>  # param :param_with_default2, default: "default value" # alternative syntax
 <%="  "* @indent %>  # param :param_with_type, type: Hash
 <%="  "* @indent %>  # param :array_of_hashes, type: [Hash]
-<%="  "* @indent %>  # collect_other_params_as :attributes  # collects all other params into a hash
+<%="  "* @indent %>  # other :attributes  # collects all other params into a hash
+<%="  "* @indent %>  # fires :callback  # creates a callback param
+
+<%="  "* @indent %>  # access params using the param name
+<%="  "* @indent %>  # fire a callback using the callback name followed by a !
+
+<%="  "* @indent %>  # state is kept and read as normal instance variables
+<%="  "* @indent %>  # but when changing state prefix the statement with `mutate`
+<%="  "* @indent %>  # i.e. mutate @my_state = 12
+<%="  "* @indent %>  #      mutate @my_other_state[:bar] = 17
 
-<%="  "* @indent %>  # The following are the most common lifecycle call backs,
-<%="  "* @indent %>  # the following are the most common lifecycle call backs# delete any that you are not using.
+<%="  "* @indent %>  # the following are the most common lifecycle call backs,
+<%="  "* @indent %>  # delete any that you are not using.
 <%="  "* @indent %>  # call backs may also reference an instance method i.e. before_mount :my_method
 
 <%="  "* @indent %>  before_mount do
@@ -27,12 +36,14 @@
 <%="  "* @indent %>  end
 
 <%="  "* @indent %>  before_unmount do
-<%="  "* @indent %>    # cleanup any thing (i.e. timers) before component is destroyed
+<%="  "* @indent %>    # cleanup any thing before component is destroyed
+<%="  "* @indent %>    # note timers are broadcast receivers are cleaned up
+<%="  "* @indent %>    # automatically
 <%="  "* @indent %>  end
 
-<%="  "* @indent %>  render do
+<%- end %><%="  "* @indent %>  render do
 <%="  "* @indent %>    DIV do
-<%="  "* @indent %>      "<%= (@modules+[@file_name]).join('::') %>"
+<%="  "* @indent %>      '<%= (@modules+[@file_name]).join('::') %>'
 <%="  "* @indent %>    end
 <%="  "* @indent %>  end
 <%="  "* @indent %>end

data/lib/generators/hyper/templates/hyper_component_template.rb

@@ -0,0 +1,10 @@
+# app/hyperstack/hyper_component.rb
+class <%= @component_base_class %>
+  # All component classes must include Hyperstack::Component
+  include Hyperstack::Component
+  # The Observable module adds state handling
+  include Hyperstack::State::Observable
+  # The following turns on the new style param accessor
+  # i.e. param :foo is accessed by the foo method
+  param_accessor_style :accessors
+end

data/lib/generators/hyper/templates/router_template.rb

@@ -1,16 +1,16 @@
 <%- @modules.each do |module_name| %><%= "  "* @indent %>module <%= module_name.camelize %><%- @indent += 1 %>
-<%- end %><%="  "* @indent %>class <%= @file_name %> < HyperComponent
-<%="  "* @indent %>  include Hyperstack::State::Observer
+<%- end %><%="  "* @indent %>class <%= @file_name %> < <%= @component_base_class %>
+<%="  "* @indent %>  include Hyperstack::Router
 <%="  "* @indent %>  render do
 <%="  "* @indent %>    DIV do
 <%="  "* @indent %>      '<%= (@modules+[@file_name]).join('::') %>'
-<%="  "* @indent %>      # define routes using the Route psuedo component.  Examples:
+<%- unless @no_help %><%="  "* @indent %>      # define routes using the Route psuedo component.  Examples:
 <%="  "* @indent %>      # Route('/foo', mounts: Foo)                : match the path beginning with /foo and mount component Foo here
 <%="  "* @indent %>      # Route('/foo') { Foo(...) }                : display the contents of the block
 <%="  "* @indent %>      # Route('/', exact: true, mounts: Home)     : match the exact path / and mount the Home component
 <%="  "* @indent %>      # Route('/user/:id/name', mounts: UserName) : path segments beginning with a colon will be captured in the match param
 <%="  "* @indent %>      # see the hyper-router gem documentation for more details
-<%="  "* @indent %>    end
+<%- end %><%="  "* @indent %>    end
 <%="  "* @indent %>  end
 <%="  "* @indent %>end
 <%- @modules.each do %><%- @indent -= 1 %><%="  "* @indent %>end

data/lib/generators/hyperstack/install_generator.rb

@@ -2,76 +2,49 @@ require_relative 'install_generator_base'
 module Hyperstack
   class InstallGenerator < Rails::Generators::Base
 
+    class_option 'skip-hotloader', type: :boolean
     class_option 'skip-webpack', type: :boolean
-    class_option 'skip-hot-reloader', type: :boolean
-    class_option 'add-framework', type: :string
+    class_option 'skip-hyper-model', type: :boolean
+    class_option 'hotloader-only', type: :boolean
+    class_option 'webpack-only', type: :boolean
+    class_option 'hyper-model-only', type: :boolean
 
-    def insure_yarn_loaded
-      return if skip_webpack?
-      begin
-        yarn_version = `yarn --version`
-        raise Errno::ENOENT if yarn_version.blank?
-      rescue Errno::ENOENT
-        raise Thor::Error.new("please insure the yarn command is available if using webpacker")
+    def add_component
+      if skip_adding_component?
+        # normally this is handled by the hyper:component
+        # generator, but if we are skipping it we will check it
+        # now.
+        insure_hyperstack_loader_installed
+      else
+        generate 'hyper:router App --add-route'
       end
     end
 
-    def inject_react_file_js
-      append_file 'app/assets/javascripts/application.js' do
-        <<-'JS'
-//= require hyperstack-loader
-        JS
+    def add_hotloader
+      return if skip_hotloader?
+      unless Hyperstack.imported? 'hyperstack/hotloader'
+        inject_into_initializer(
+          "Hyperstack.import 'hyperstack/hotloader', "\
+          'client_only: true if Rails.env.development?'
+        )
       end
-    end
-
-    def create_hyperstack_directories
-      create_file 'app/hyperstack/components/hyper_component.rb', <<-RUBY
-  class HyperComponent
-    include Hyperstack::Component
-    include Hyperstack::State::Observer
-  end
-        RUBY
-      create_file 'app/hyperstack/operations/.keep', ''
-      create_file 'app/hyperstack/stores/.keep', ''
-      create_file 'app/hyperstack/models/.keep', ''
-    end
-
-    def move_and_update_application_record
-      unless File.exists? 'app/hyperstack/models/application_record.rb'
-        `mv app/models/application_record.rb app/hyperstack/models/application_record.rb`
-        create_file 'app/models/application_record.rb', <<-RUBY
-# app/models/application_record.rb
-# the presence of this file prevents rails migrations from recreating application_record.rb see https://github.com/rails/rails/issues/29407
-
-require 'models/application_record.rb'
-        RUBY
+      create_file 'Procfile', <<-TEXT
+web:        bundle exec rails s -b 0.0.0.0
+hot-loader: bundle exec hyperstack-hotloader -p 25222 -d app/hyperstack
+      TEXT
+      gem_group :development do
+        gem 'foreman'
       end
     end
 
-    def create_policies_directory
-      create_file 'app/policies/application_policy.rb', <<-RUBY
-# app/policies/application_policy
-
-# Policies regulate access to your public models
-# The following policy will open up full access (but only in development)
-# The policy system is very flexible and powerful.  See the documentation
-# for complete details.
-class Hyperstack::ApplicationPolicy
-  # Allow any session to connect:
-  always_allow_connection
-  # Send all attributes from all public models
-  regulate_all_broadcasts { |policy| policy.send_all }
-  # Allow all changes to public models
-  allow_change(to: :all, on: [:create, :update, :destroy]) { true }
-  # allow remote access to all scopes - i.e. you can count or get a list of ids
-  # for any scope or relationship
-  ApplicationRecord.regulate_scope :all
-end unless Rails.env.production?
-      RUBY
-    end
-
-    def add_router
-      generate "hyper:router", "App"
+    def insure_yarn_loaded
+      return if skip_webpack?
+      begin
+        yarn_version = `yarn --version`
+        raise Errno::ENOENT if yarn_version.blank?
+      rescue Errno::ENOENT
+        raise Thor::Error.new("please insure nodejs is installed and the yarn command is available if using webpacker")
+      end
     end
 
     def add_webpacker_manifests
@@ -84,20 +57,27 @@ History = require('history');                  // react-router history library
 ReactRouter = require('react-router');         // react-router js library
 ReactRouterDOM = require('react-router-dom');  // react-router DOM interface
 ReactRailsUJS = require('react_ujs');          // interface to react-rails
-// to add additional NPM packages call run yarn package-name@version
+// to add additional NPM packages run `yarn add package-name@version`
 // then add the require here.
       JAVASCRIPT
       create_file 'app/javascript/packs/client_only.js', <<-JAVASCRIPT
 //app/javascript/packs/client_only.js
 // add any requires for packages that will run client side only
 ReactDOM = require('react-dom');               // react-js client side code
-jQuery = require('jquery');
-// to add additional NPM packages call run yarn package-name@version
+jQuery = require('jquery');                    // remove if you don't need jQuery
+// to add additional NPM packages call run yarn add package-name@version
 // then add the require here.
       JAVASCRIPT
       append_file 'config/initializers/assets.rb' do
         <<-RUBY
-Rails.application.config.assets.paths << Rails.root.join('public', 'packs').to_s
+Rails.application.config.assets.paths << Rails.root.join('public', 'packs', 'js').to_s
+        RUBY
+      end
+      inject_into_file 'config/environments/test.rb', before: /^end/ do
+        <<-RUBY
+
+  # added by hyperstack installer
+  config.assets.paths << Rails.root.join('public', 'packs-test', 'js').to_s
         RUBY
       end
     end
@@ -106,74 +86,182 @@ Rails.application.config.assets.paths << Rails.root.join('public', 'packs').to_s
       return if skip_webpack?
       yarn 'react', '16'
       yarn 'react-dom', '16'
-      yarn 'react-router', '4.2'
-      yarn 'react-router-dom', '4.2'
-      yarn 'history', '4.2'
-      yarn 'react_ujs'
-      yarn 'jquery'
+      yarn 'react-router', '^5.0.0'
+      yarn 'react-router-dom', '^5.0.0'
+      # yarn 'history'#, '4.2' this will be brought in by react-router
+      yarn 'react_ujs', '^2.5.0'
+      yarn 'jquery', '^3.4.1'
     end
 
-    def add_framework
-      framework = options['add-framework']
-      return unless framework
-      generate "hyperstack:install_#{framework}", "--no-build"
+    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'
+      )
     end
 
-    def build_webpack
-      system('bin/webpack')
+    def install_webpacker
+      return if skip_webpack?
+      gem 'webpacker'
+      Bundler.with_clean_env do
+        run 'bundle install'
+      end
+      run 'bundle exec rails webpacker:install'
     end
 
-    # all generators should be run before the initializer due to the opal-rails opal-jquery
-    # conflict
+    def create_policies_directory
+      return if skip_hyper_model?
+      policy_file = File.join('app', 'policies', 'application_policy.rb')
+      unless File.exist? policy_file
+        create_file policy_file, <<-RUBY
+  # #{policy_file}
 
-    def create_initializer
-      create_file 'config/initializers/hyperstack.rb', <<-RUBY
-# config/initializers/hyperstack.rb
-# If you are not using ActionCable, see http://hyperstack.orgs/docs/models/configuring-transport/
-Hyperstack.configuration do |config|
-  config.transport = :action_cable # or :pusher or :simpler_poller or :none
-  config.prerendering = :off # or :on
-#{"  config.import 'jquery', client_only: true  # remove this line if you don't need jquery" if skip_webpack?}
-  config.import 'hyperstack/component/jquery', client_only: true # remove this line if you don't need jquery
-#{"  config.import 'hyperstack/hotloader', client_only: true if Rails.env.development?" unless options['skip-hot-reloader']}
-end
+  # Policies regulate access to your public models
+  # The following policy will open up full access (but only in development)
+  # The policy system is very flexible and powerful.  See the documentation
+  # for complete details.
+  class Hyperstack::ApplicationPolicy
+    # Allow any session to connect:
+    always_allow_connection
+    # Send all attributes from all public models
+    regulate_all_broadcasts { |policy| policy.send_all }
+    # Allow all changes to models
+    allow_change(to: :all, on: [:create, :update, :destroy]) { true }
+    # allow remote access to all scopes - i.e. you can count or get a list of ids
+    # for any scope or relationship
+    ApplicationRecord.regulate_scope :all
+  end unless Rails.env.production?
         RUBY
+      end
     end
 
-    def inject_engine_to_routes
-      # this needs to be the first route, thus it must be the last method executed
-      route 'mount Hyperstack::Engine => \'/hyperstack\''  # this route should be first in the routes file so it always matches
-    end
+    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.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
+# #{rails_app_record_file}
+# the presence of this file prevents rails migrations from recreating application_record.rb
+# see https://github.com/rails/rails/issues/29407
 
-    def add_opal_hot_reloader
-      return if options['skip-hot-reloader']
-      create_file 'Procfile', <<-TEXT
-web:        bundle exec rails s -b 0.0.0.0
-hot-loader: bundle exec hyperstack-hotloader -d app/hyperstack
-      TEXT
-      gem_group :development do
-        gem 'foreman'
+require 'models/application_record.rb'
+        RUBY
       end
     end
 
-    def add_gems
-      # gem 'hyper-model', Hyperstack::VERSION
-      # gem 'hyper-router', Hyperstack::ROUTERVERSION
-      # gem 'opal-rails', '~> 0.9.4'
-      # gem 'opal-jquery'
-      # gem "opal-jquery", git: "https://github.com/opal/opal-jquery.git", branch: "master"
+    def add_engine_route
+      return if skip_hyper_model?
+      route 'mount Hyperstack::Engine => \'/hyperstack\'  # this route should be first in the routes file so it always matches'
     end
 
-    def install
-      Bundler.with_clean_env do
-        run "bundle install"
+    def report
+      say "\n\n"
+      unless skip_adding_component?
+        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
+      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
+      end
+      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
+      end
+
+      say "\n\n"
     end
 
     private
 
+    def skip_adding_component?
+      options['hotloader-only'] || options['webpack-only'] || options['hyper-model-only'] || !new_rails_app?
+    end
+
+    def skip_hotloader?
+      options['skip-hotloader'] || options['webpack-only'] || options['hyper-model-only']
+    end
+
     def skip_webpack?
-      options['skip-webpack'] || !defined?(Webpacker)
+      options['hotloader-only'] || options['skip-webpack'] || options['hyper-model-only']
+    end
+
+    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.exist?(file_name)
+        prepend_to_file(file_name) { "#{s}\n" }
+      else
+        create_file file_name, <<-RUBY
+#{s}
+# set the component base class
+
+Hyperstack.component_base_class = 'HyperComponent' # i.e. 'ApplicationComponent'
+
+# prerendering is default :off, you should wait until your
+# application is relatively well debugged before turning on.
+
+Hyperstack.prerendering = :off # or :on
+
+# transport controls how push (websocket) communications are
+# implemented.  The default is :action_cable.
+# Other possibilities are :pusher (see www.pusher.com) or
+# :simple_poller which is sometimes handy during system debug.
+
+Hyperstack.transport = :action_cable # or :none, :pusher,  :simple_poller
+
+# add this line if you need jQuery AND ARE NOT USING WEBPACK
+# Hyperstack.import 'hyperstack/component/jquery', client_only: true
+
+# change definition of on_error to control how errors such as validation
+# exceptions are reported on the server
+module Hyperstack
+  def self.on_error(operation, err, params, formatted_error_message)
+    ::Rails.logger.debug(
+      "\#{formatted_error_message}\\n\\n" +
+      Pastel.new.red(
+        'To further investigate you may want to add a debugging '\\
+        'breakpoint to the on_error method in config/initializers/hyperstack.rb'
+      )
+    )
+  end
+end if Rails.env.development?
+        RUBY
+      end
+      # whenever we modify the initializer its best to empty the cache, BUT
+      # we only need to it once per generator execution
+      run 'rm -rf tmp/cache' unless @cache_emptied_already
+      @cache_emptied_already = true
     end
   end
 end

data/lib/generators/hyperstack/install_generator_base.rb

@@ -6,14 +6,90 @@ module Rails
 
       protected
 
+      def create_component_file(template)
+        clear_cache
+        insure_hyperstack_loader_installed
+        insure_base_component_class_exists
+        @no_help = options.key?('no-help')
+        self.components.each do |component|
+          component_array = component.split('::')
+          @modules = component_array[0..-2]
+          @file_name = component_array.last
+          @indent = 0
+          template template,
+                   File.join('app', 'hyperstack', 'components',
+                             *@modules.map(&:downcase),
+                             "#{@file_name.underscore}.rb")
+        end
+        add_route
+      end
+
+
+      def clear_cache
+        run 'rm -rf tmp/cache' unless Dir.exist?(File.join('app', 'hyperstack'))
+      end
+
+      def insure_hyperstack_loader_installed
+        application_js = File.join(
+          'app', 'assets', 'javascripts', 'application.js'
+        )
+        require_tree = %r{//=\s+require_tree\s+}
+        hyperstack_loader = %r{//=\s+require\s+hyperstack-loader\s+}
+        unless File.foreach(application_js).any? { |l| l =~ hyperstack_loader }
+          if File.foreach(application_js).any? { |l| l =~ require_tree }
+            inject_into_file 'app/assets/javascripts/application.js', before: require_tree do
+              "//= require hyperstack-loader\n"
+            end
+          else
+            puts " ***********************************************************\n"\
+                 " * Could not add `//= require hyperstack-loader` directive *\n"\
+                 " * to the app/assets/application.js file.                  *\n"\
+                 " * Normally this directive is added just before the        *\n"\
+                 " * `//= require_tree .` directive at the end of the file,  *\n"\
+                 " * but no require_tree directive was found.  You need to   *\n"\
+                 " * manually add `//= require hyperstack-loader` to the     *\n"\
+                 " * app/assets/application.js file.                         *\n"\
+                 " ***********************************************************\n"
+          end
+        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.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
         end
       end
 
+      def add_route
+        return unless options['add-route']
+        if self.components.count > 1
+          puts " ***********************************************************\n"\
+               " * The add-route option ignored because more than one      *\n"\
+               " * component is being generated.                           *\n"\
+               " ***********************************************************\n"
+          return
+        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}'\n"
+        log :route, routing_code
+        [/mount\s+Hyperstack::Engine[^\n]+\n/m, /\.routes\.draw do\s*\n/m].each do |sentinel|
+          in_root do
+            inject_into_file 'config/routes.rb', routing_code.indent(2), after: sentinel, verbose: false, force: false
+          end
+        end
+      end
+
       def yarn(package, version = nil)
         return if system("yarn add #{package}#{'@' + version if version}")
         raise Thor::Error.new("yarn failed to install #{package} with version #{version}")

data/lib/generators/install/hyperstack_generator.rb

@@ -0,0 +1,229 @@
+require_relative '../hyperstack/install_generator_base'
+module Install
+  class HyperstackGenerator < Rails::Generators::Base
+
+    class_option 'skip-webpack', type: :boolean
+    class_option 'skip-hot-reloader', type: :boolean
+    class_option 'add-framework', type: :string
+
+    def insure_yarn_loaded
+      return if skip_webpack?
+      begin
+        yarn_version = `yarn --version`
+        raise Errno::ENOENT if yarn_version.blank?
+      rescue Errno::ENOENT
+        raise Thor::Error.new("please insure the yarn command is available if using webpacker")
+      end
+    end
+
+    APPJS = 'app/assets/javascripts/application.js'
+
+    def inject_hyperstack_loader_js
+      unless File.foreach(APPJS).any?{ |l| l['//= require hyperstack-loader'] }
+        inject_into_file 'app/assets/javascripts/application.js', before: %r{//= require_tree .} do
+          "//= require hyperstack-loader\n"
+        end
+      end
+    end
+
+    def create_hyperstack_files_and_directories
+      create_file 'app/hyperstack/components/hyper_component.rb', <<-RUBY
+  class HyperComponent
+    include Hyperstack::Component
+    include Hyperstack::State::Observable
+    param_accessor_style :accessors
+  end
+        RUBY
+      create_file 'app/hyperstack/operations/.keep', ''
+      create_file 'app/hyperstack/stores/.keep', ''
+      create_file 'app/hyperstack/models/.keep', ''
+    end
+
+    def move_and_update_application_record
+      unless File.exists? 'app/hyperstack/models/application_record.rb'
+        `mv app/models/application_record.rb app/hyperstack/models/application_record.rb`
+        create_file 'app/models/application_record.rb', <<-RUBY
+# app/models/application_record.rb
+# the presence of this file prevents rails migrations from recreating application_record.rb see https://github.com/rails/rails/issues/29407
+
+require 'models/application_record.rb'
+        RUBY
+      end
+    end
+
+    def create_policies_directory
+      create_file 'app/policies/application_policy.rb', <<-RUBY
+# app/policies/application_policy.rb
+
+# Policies regulate access to your public models
+# The following policy will open up full access (but only in development)
+# The policy system is very flexible and powerful.  See the documentation
+# for complete details.
+class Hyperstack::ApplicationPolicy
+  # Allow any session to connect:
+  always_allow_connection
+  # Send all attributes from all public models
+  regulate_all_broadcasts { |policy| policy.send_all }
+  # Allow all changes to models
+  allow_change(to: :all, on: [:create, :update, :destroy]) { true }
+  # allow remote access to all scopes - i.e. you can count or get a list of ids
+  # for any scope or relationship
+  ApplicationRecord.regulate_scope :all
+end unless Rails.env.production?
+      RUBY
+    end
+
+    def add_router
+      generate "hyper:router", "App"
+      route "get '/(*other)', to: 'hyperstack#app'"
+    end
+if false
+    def add_webpackin
+      run 'yarn add react'
+      run 'yarn add react-dom'
+      run 'yarn add react-router'
+      create_file 'app/javascript/packs/hyperstack.js', <<-CODE
+        // Import all the modules
+        import React from 'react';
+        import ReactDOM from 'react-dom';
+
+        // for opal/hyperstack modules to find React and others they must explicitly be saved
+        // to the global space, otherwise webpack will encapsulate them locally here
+        global.React = React;
+        global.ReactDOM = ReactDOM;
+        CODE
+      inject_into_file 'app/views/layouts/application.html.erb', before: %r{<%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>} do
+<<-CODE
+<%= javascript_pack_tag 'hyperstack' %>
+CODE
+      end
+      gem 'webpacker'
+    end
+
+
+else
+    def add_webpacker_manifests
+      return if skip_webpack?
+      create_file 'app/javascript/packs/client_and_server.js', <<-JAVASCRIPT
+//app/javascript/packs/client_and_server.js
+// these packages will be loaded both during prerendering and on the client
+React = require('react');                      // react-js library
+History = require('history');                  // react-router history library
+ReactRouter = require('react-router');         // react-router js library
+ReactRouterDOM = require('react-router-dom');  // react-router DOM interface
+ReactRailsUJS = require('react_ujs');          // interface to react-rails
+// to add additional NPM packages call run yarn add package-name@version
+// then add the require here.
+      JAVASCRIPT
+      create_file 'app/javascript/packs/client_only.js', <<-JAVASCRIPT
+//app/javascript/packs/client_only.js
+// add any requires for packages that will run client side only
+ReactDOM = require('react-dom');               // react-js client side code
+jQuery = require('jquery');
+// to add additional NPM packages call run yarn add package-name@version
+// then add the require here.
+      JAVASCRIPT
+      append_file 'config/initializers/assets.rb' do
+        <<-RUBY
+Rails.application.config.assets.paths << Rails.root.join('public', 'packs', 'js').to_s
+        RUBY
+      end
+      inject_into_file 'config/environments/test.rb', before: /^end/ do
+        <<-RUBY
+
+  # added by hyperstack installer
+  config.assets.paths << Rails.root.join('public', 'packs-test', 'js').to_s
+        RUBY
+      end
+
+    end
+
+    def add_webpacks
+      return if skip_webpack?
+      yarn 'react', '16'
+      yarn 'react-dom', '16'
+      yarn 'react-router', '^5.0.0'
+      yarn 'react-router-dom', '^5.0.0'
+      # yarn 'history'#, '4.2' this will be brought in by react-router
+      yarn 'react_ujs', '^2.5.0'
+      yarn 'jquery', '^3.4.1'
+    end
+
+    def add_webpacker_gem
+      gem 'webpacker'
+    end
+
+    def add_framework
+      framework = options['add-framework']
+      return unless framework
+      generate "hyperstack:install_#{framework}", "--no-build"
+    end
+
+    # def build_webpack
+    #   system('bin/webpack')
+    # end
+end
+    # all generators should be run before the initializer due to the opal-rails opal-jquery
+    # conflict
+
+    def create_initializer
+      create_file 'config/initializers/hyperstack.rb', <<-CODE
+      # config/initializers/hyperstack.rb
+      # If you are not using ActionCable, see http://hyperstack.orgs/docs/models/configuring-transport/
+      Hyperstack.configuration do |config|
+        config.transport = :action_cable
+        config.prerendering = :off # or :on
+        config.cancel_import 'react/react-source-browser' # bring your own React and ReactRouter via Yarn/Webpacker
+        config.import 'hyperstack/component/jquery', client_only: true # remove this line if you don't need jquery
+        config.import 'hyperstack/hotloader', client_only: true if Rails.env.development?
+      end
+
+      # useful for debugging
+      module Hyperstack
+        def self.on_error(operation, err, params, formatted_error_message)
+          ::Rails.logger.debug(
+            "\#{formatted_error_message}\\n\\n" +
+            Pastel.new.red(
+              'To further investigate you may want to add a debugging '\\
+              'breakpoint to the on_error method in config/initializers/hyperstack.rb'
+            )
+          )
+        end
+      end if Rails.env.development?
+      CODE
+    end
+
+    def inject_engine_to_routes
+      # this needs to be the first route, thus it must be the last method executed
+      route 'mount Hyperstack::Engine => \'/hyperstack\''  # this route should be first in the routes file so it always matches
+    end
+
+    def add_opal_hot_reloader
+      return if options['skip-hot-reloader']
+      create_file 'Procfile', <<-TEXT
+web:        bundle exec rails s -b 0.0.0.0
+hot-loader: bundle exec hyperstack-hotloader -p 25222 -d app/hyperstack
+      TEXT
+      gem_group :development do
+        gem 'foreman'
+      end
+    end
+
+    def add_gems
+
+    end
+
+    def install
+      Bundler.with_clean_env do
+        run "bundle install"
+      end
+      run 'bundle exec rails webpacker:install'
+    end
+
+    private
+
+    def skip_webpack?
+      options['skip-webpack'] #|| !defined?(Webpacker)
+    end
+  end
+end

data/lib/generators/install/hyperstack_generator_base.rb

@@ -0,0 +1,76 @@
+require 'rails/generators'
+
+module Rails
+  module Generators
+    class Base < Thor::Group
+
+      protected
+
+      def clear_cache
+        run 'rm -rf tmp/cache' unless Dir.exists?(File.join('app', 'hyperstack'))
+      end
+
+      def insure_hyperstack_loader_installed
+        application_js = File.join(
+          'app', 'assets', 'javascripts', 'application.js'
+        )
+        require_tree = %r{//=\s+require_tree\s+}
+        hyperstack_loader = %r{//=\s+require\s+hyperstack-loader\s+}
+        unless File.foreach(application_js).any? { |l| l =~ hyperstack_loader }
+          if File.foreach(application_js).any? { |l| l =~ require_tree }
+            inject_into_file 'app/assets/javascripts/application.js', before: require_tree do
+              "//= require hyperstack-loader\n"
+            end
+          else
+            puts " ***********************************************************\n"\
+                 " * Could not add `//= require hyperstack-loader` directive *\n"\
+                 " * to the app/assets/application.js file.                  *\n"\
+                 " * Normally this directive is added just before the        *\n"\
+                 " * `//= require_tree .` directive at the end of the file,  *\n"\
+                 " * but no require_tree directive was found.  You need to   *\n"\
+                 " * manually add `//= require hyperstack-loader` to the     *\n"\
+                 " * app/assets/application.js file.                         *\n"\
+                 " ***********************************************************\n"
+          end
+        end
+      end
+
+
+      def insure_base_component_class_exists
+        @component_base_class = options['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
+      end
+
+      def add_to_manifest(manifest, &block)
+        if File.exists? "app/javascript/packs/#{manifest}"
+          append_file "app/javascript/packs/#{manifest}", &block
+        else
+          create_file "app/javascript/packs/#{manifest}", &block
+        end
+      end
+
+      def add_route
+        return unless options['add-route']
+        if self.components.count > 1
+          puts " ***********************************************************\n"\
+               " * The add-route option ignored because more than one      *\n"\
+               " * component is being generated.                           *\n"\
+               " ***********************************************************\n"
+          return
+        end
+        action_name = (@modules+[@file_name.underscore]).join('__')
+        path = options['add-route'] == 'add-route' ? '/(*others)' : options['add-route']
+        route "get '#{path}', to: 'hyperstack##{action_name}'"
+      end
+
+
+      def yarn(package, version = nil)
+        return if system("yarn add #{package}#{'@' + version if version}")
+        raise Thor::Error.new("yarn failed to install #{package} with version #{version}")
+      end
+    end
+  end
+end

data/lib/hyperstack/version.rb

@@ -1,3 +1,3 @@
 module Hyperstack
-  ROUTERVERSION = VERSION = '1.0.alpha1.4'
+  ROUTERVERSION = VERSION = '1.0.alpha1.5'
 end

data/lib/rails-hyperstack.rb

@@ -14,6 +14,7 @@ Hyperstack.import 'hyper-model'
 Hyperstack.import 'hyper-state'
 
 require 'generators/hyperstack/install_generator'
+require 'generators/hyper/generator_base'
 require 'generators/hyper/component_generator'
 require 'generators/hyper/router_generator'
 begin
@@ -26,3 +27,11 @@ require 'react-rails'
 require 'opal-browser'
 require 'mini_racer'
 require 'hyperstack/version'
+
+class RailsHyperstack < Rails::Railtie
+  rake_tasks do
+    Dir[File.join(File.dirname(__FILE__),'tasks/hyperstack/*.rake')].each { |f| puts "loading #{f}"; load f }
+  end
+end
+
+Hyperstack.define_setting :component_base_class, 'HyperComponent'

data/lib/tasks/hyperstack/install.rake

@@ -0,0 +1,32 @@
+# install_template_path = File.expand_path("../../install/template.rb", __dir__).freeze
+bin_path = ENV["BUNDLE_BIN"] || "./bin"
+require 'optparse'
+
+namespace :hyperstack do
+  desc "Install Hyperstack in this application"
+  task :install do
+    exec "#{RbConfig.ruby} #{bin_path}/rails g hyperstack:install"
+  end
+  namespace :install do
+    task :default do
+    end
+    task "hotloader" do
+      exec "#{RbConfig.ruby} #{bin_path}/rails g hyperstack:install --hotloader-only"
+    end
+    task "webpack" do
+      exec "#{RbConfig.ruby} #{bin_path}/rails g hyperstack:install --webpack-only"
+    end
+    task "hyper-model" do
+      exec "#{RbConfig.ruby} #{bin_path}/rails g hyperstack:install --hyper-model-only"
+    end
+    task "skip-hotloader" do
+      exec "#{RbConfig.ruby} #{bin_path}/rails g hyperstack:install --skip-hotloader"
+    end
+    task "skip-webpack" do
+      exec "#{RbConfig.ruby} #{bin_path}/rails g hyperstack:install --skip-webpack"
+    end
+    task "skip-hyper-model" do
+      exec "#{RbConfig.ruby} #{bin_path}/rails g hyperstack:install --skip-hyper-model"
+    end
+  end
+end

data/rails-hyperstack.gemspec

@@ -18,6 +18,41 @@ Gem::Specification.new do |spec|
   # }
   spec.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(tasks)/}) }
   spec.require_paths = ['lib']
+  spec.post_install_message = %q{
+*******************************************************************************
+
+Welcome to Hyperstack!
+
+For a quick start simply add a component using one of the generators:
+
+  >> bundle exec rails generate hyper:component CompName --add-route="/test/(*others)"
+     # Add a new component named CompName and route to it with /test/
+
+  >> bundle exec rails generate hyper:router CompName --add-route="/test/(*others)"
+     # Add a top level router named CompName and route to it
+
+The generators will insure you have the minimal additions to your system for the
+new component to run.  And note: --add-route is optional.
+
+For a complete install run the hyperstack install task:
+
+  >> bundle exec rails hyperstack:install
+
+This will add everything you need including the hotloader, webpack integration,
+hyper-model (active record model client synchronization) and a top level
+component to get you started.
+
+You can control how much of the stack gets installed as well:
+
+  >> bundle exec rails hyperstack:install:webpack          # just add webpack
+  >> bundle exec rails hyperstack:install:skip-webpack     # all but webpack
+  >> bundle exec rails hyperstack:install:hyper-model      # just add hyper-model
+  >> bundle exec rails hyperstack:install:skip-hyper-model # all but hyper-model
+  >> bundle exec rails hyperstack:install:hotloader        # just add the hotloader
+  >> bundle exec rails hyperstack:install:skip-hotloader   # skip the hotloader
+
+*******************************************************************************
+}
 
   spec.add_dependency 'hyper-model', Hyperstack::VERSION
   spec.add_dependency 'hyper-router', Hyperstack::ROUTERVERSION

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-hyperstack
 version: !ruby/object:Gem::Version
-  version: 1.0.alpha1.4
+  version: 1.0.alpha1.5
 platform: ruby
 authors:
 - Loic Boutet
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-16 00:00:00.000000000 Z
+date: 2019-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hyper-model
@@ -19,42 +19,42 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.alpha1.4
+        version: 1.0.alpha1.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.alpha1.4
+        version: 1.0.alpha1.5
 - !ruby/object:Gem::Dependency
   name: hyper-router
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.alpha1.4
+        version: 1.0.alpha1.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.alpha1.4
+        version: 1.0.alpha1.5
 - !ruby/object:Gem::Dependency
   name: hyperstack-config
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.alpha1.4
+        version: 1.0.alpha1.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.alpha1.4
+        version: 1.0.alpha1.5
 - !ruby/object:Gem::Dependency
   name: opal-rails
   requirement: !ruby/object:Gem::Requirement
@@ -185,14 +185,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.alpha1.4
+        version: 1.0.alpha1.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.alpha1.4
+        version: 1.0.alpha1.5
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -389,15 +389,20 @@ files:
 - Gemfile
 - Rakefile
 - lib/generators/hyper/component_generator.rb
+- lib/generators/hyper/generator_base.rb
 - lib/generators/hyper/router_generator.rb
 - lib/generators/hyper/templates/component_template.rb
+- lib/generators/hyper/templates/hyper_component_template.rb
 - lib/generators/hyper/templates/router_template.rb
 - lib/generators/hyperstack/install_bootstrap_generator.rb
 - lib/generators/hyperstack/install_generator.rb
 - lib/generators/hyperstack/install_generator_base.rb
 - lib/generators/hyperstack/install_mui_generator.rb
+- lib/generators/install/hyperstack_generator.rb
+- lib/generators/install/hyperstack_generator_base.rb
 - lib/hyperstack/version.rb
 - lib/rails-hyperstack.rb
+- lib/tasks/hyperstack/install.rake
 - rails-hyperstack.gemspec
 - spec/rails_hyperstack_spec.rb
 - spec/spec_helper.rb
@@ -405,7 +410,41 @@ homepage: http://hyperstack.org
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: |2
+
+  *******************************************************************************
+
+  Welcome to Hyperstack!
+
+  For a quick start simply add a component using one of the generators:
+
+    >> bundle exec rails generate hyper:component CompName --add-route="/test/(*others)"
+       # Add a new component named CompName and route to it with /test/
+
+    >> bundle exec rails generate hyper:router CompName --add-route="/test/(*others)"
+       # Add a top level router named CompName and route to it
+
+  The generators will insure you have the minimal additions to your system for the
+  new component to run.  And note: --add-route is optional.
+
+  For a complete install run the hyperstack install task:
+
+    >> bundle exec rails hyperstack:install
+
+  This will add everything you need including the hotloader, webpack integration,
+  hyper-model (active record model client synchronization) and a top level
+  component to get you started.
+
+  You can control how much of the stack gets installed as well:
+
+    >> bundle exec rails hyperstack:install:webpack          # just add webpack
+    >> bundle exec rails hyperstack:install:skip-webpack     # all but webpack
+    >> bundle exec rails hyperstack:install:hyper-model      # just add hyper-model
+    >> bundle exec rails hyperstack:install:skip-hyper-model # all but hyper-model
+    >> bundle exec rails hyperstack:install:hotloader        # just add the hotloader
+    >> bundle exec rails hyperstack:install:skip-hotloader   # skip the hotloader
+
+  *******************************************************************************
 rdoc_options: []
 require_paths:
 - lib
@@ -420,7 +459,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Hyperstack for Rails with generators