rails-hyperstack 1.0.alpha1.3 → 1.0.alpha1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba7acfe33dd7f17c186633976221b2cc51b0d69eca6b89b977a767984a9ccc94
-  data.tar.gz: 641e7d220b6507643ab89a74ed2d5b300c97f41dabad579b7f0532be6054c42f
+  metadata.gz: d462884d5534597640357e08ee818f10c707d3f6aa26b54828fcb926bbdeb254
+  data.tar.gz: f9dbb40d940d92fcbbf42b2705c19bd36da9559fafef3d8db513d5739cef9a08
 SHA512:
-  metadata.gz: 95c101a927cddcf91f024a6b68e0331933e107e4325338a97869c89f2021865998fe7612e74902bb3a2ddbebc3031f90f0e752960d59dc63e027dc4df02b1b39
-  data.tar.gz: 8ffeb939761faa504127b495175a5c7b0515f40699ebea40584ac5921d6ca8dc919c8edadd41a8c2eceea6242d18cf2679c13763d176b87a418f3ae77dfe4a41
+  metadata.gz: d759c5a5707af68c14a06fd391df52541214ac330f29ecd5db3c7ebe1879f19ccdd6b00625f219732406c08e92149d3c1ef9559935da29b1d606a76377c0a0f4
+  data.tar.gz: 06d9dcce5d271121ac1594f287a6bfb8beaba97c11e102ed73fb1b1698e9db20b518c051659699c35096d8ba871a293ba54397edcacf1300ce2e672f3355ecbb

data/.gitignore

@@ -11,6 +11,7 @@ capybara-*.html
 **.orig
 rerun.txt
 pickle-email-*.html
+TestApp/
 
 # TODO Comment out these rules if you are OK with secrets being uploaded to the repo
 config/initializers/secret_token.rb
@@ -46,3 +47,12 @@ bower.json
 
 # ignore Idea
 .idea
+
+# ignore Gemfile.locks https://yehudakatz.com/2010/12/16/clarifying-the-roles-of-the-gemspec-and-gemfile/
+/spec/test_app/Gemfile.lock
+/Gemfile.lock
+
+node_modules
+package.json
+spec/test_app
+yarn.lock

data/.ruby-version

@@ -0,0 +1 @@
+2.7.2

data/Gemfile

@@ -6,5 +6,6 @@ gem 'hyper-operation',   path: '../hyper-operation'
 gem 'hyper-model',       path: '../hyper-model'
 gem 'hyper-router',      path: '../hyper-router'
 gem 'hyper-spec',        path: '../hyper-spec'
-gem 'rails', '~> 5.2'
+gem 'webpacker'  # TODO: figure out why these two are necessary!
+gem 'turbolinks'
 gemspec

data/Rakefile

@@ -1,25 +1,35 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require 'pry'
 
 RSpec::Core::RakeTask.new(:spec)
 
 namespace :spec do
   task :prepare do
+    rails_version = `bundle info rails`.match(/\* rails \((.+)\)/)[1]
+    opal_version = `bundle info opal`.match(/\* opal \((.+)\)/)[1]
     Dir.chdir('spec') do
       sh('rm -rf test_app')
-      sh('bundle exec rails new test_app')
-      Dir.chdir('test_app') do
-        sh('bundle exec rails g hyperstack:install')
-        sh('mv Gemfile _Gemfile_')
-        sh('bundle exec rails generate model Sample name:string description:text')
-        sh('mv app/models/sample.rb app/hyperstack/models/sample.rb')
-        sh('bundle exec rake db:migrate')
-        sh('bundle exec rails dev:cache')
+      Bundler.with_unbundled_env do
+        sh("rails _#{rails_version}_ new test_app -T")
+      end
+      Bundler.with_unbundled_env do
+        Dir.chdir('test_app') do
+          sh('cat ../gems.rb >> Gemfile')
+          sh("echo 'gem \"opal\", \"#{opal_version}\"' >> Gemfile")
+          sh("bundle update")
+          sh('spring stop')
+          sh('bundle exec rails g hyperstack:install')
+          sh('bundle exec rails generate model Sample name:string description:text')
+          sh('mv app/models/sample.rb app/hyperstack/models/sample.rb')
+          sh("cat ../server_side_sample.rb >> app/models/sample.rb")
+          sh('bundle exec rake db:migrate')
+          sh('RAILS_ENV=test bundle exec rake db:setup')
+          # sh('bundle exec rails dev:cache') # not tested yet...
+        end
       end
     end
   end
 end
 
-task :default do
-  
-end
+task :default => :spec

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 and 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,178 +2,178 @@ 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
-
-    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")
+    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 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
+      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 inject_react_file_js
-      append_file 'app/assets/javascripts/application.js' do
-        <<-'JS'
-//= require hyperstack-loader
-        JS
+    def install_webpack
+      return super unless skip_webpack?
+
+      inject_into_initializer(
+        "Hyperstack.import 'react/react-source-browser' "\
+        "# bring in hyperstack's copy of react, comment this out "\
+        "if you bring it in from webpacker\n"
+      )
+    end
+
+    def add_component
+      # add_component AFTER webpack so component generator webpack check works
+      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
+        check_javascript_link_directory
+      else
+        generate 'hyper:router App --add-route'
       end
     end
 
-    def create_hyperstack_directories
-      create_file 'app/hyperstack/components/hyper_component.rb', <<-RUBY
-  class HyperComponent
-    include Hyperstack::Component
-    include Hyperstack::State::Observer
+    def create_policies_directory
+      return if skip_hyper_model?
+      policy_file = Rails.root.join('app', 'policies', 'hyperstack', 'application_policy.rb')
+      unless File.exist? policy_file
+        create_file policy_file, <<-RUBY
+  # #{policy_file}
+
+  # 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.
+  module Hyperstack
+    class 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 }
+    end unless Rails.env.production?
   end
         RUBY
-      create_file 'app/hyperstack/operations/.keep', ''
-      create_file 'app/hyperstack/stores/.keep', ''
-      create_file 'app/hyperstack/models/.keep', ''
+      end
     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
+      return if skip_hyper_model?
+      rails_app_record_file = Rails.root.join('app', 'models', 'application_record.rb')
+      hyper_app_record_file = Rails.root.join('app', 'hyperstack', 'models', 'application_record.rb')
+      unless File.exist? hyper_app_record_file
+        empty_directory Rails.root.join('app', 'hyperstack', 'models')
+        `mv #{rails_app_record_file} #{hyper_app_record_file}`
+        inject_into_file hyper_app_record_file, before: /^end/, verbose: false do
+          "  # allow remote access to all scopes - i.e. you can count or get a list of ids\n"\
+          "  # for any scope or relationship\n"\
+          "  ApplicationRecord.regulate_scope :all unless Hyperstack.env.production?\n"
+        end
+
+#         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
+#
+# require 'models/application_record.rb'
+#         RUBY
       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?
+    def turn_on_transport
+      inject_into_initializer <<-RUBY
+
+# transport controls how push (websocket) communications are
+# implemented.  The default is :none.
+# Other possibilities are :action_cable, :pusher (see www.pusher.com)
+# or :simple_poller which is sometimes handy during system debug.
+
+Hyperstack.transport = :action_cable # :pusher, :simple_poller or :none
+
       RUBY
     end
 
-    def add_router
-      generate "hyper:router", "App"
+    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 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 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
-// 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
-        RUBY
+    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 = Rails.root.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
-    end
 
-    def add_webpacks
-      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'
-    end
+      say "\n\n"
 
-    def add_framework
-      framework = options['add-framework']
-      return unless framework
-      generate "hyperstack:install_#{framework}", "--no-build"
+      warnings.each { |warning| say "#{warning}", :yellow }
     end
 
-    def build_webpack
-      system('bin/webpack')
-    end
+    private
 
-    # 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', <<-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
-        RUBY
+    def skip_adding_component?
+      options['hotloader-only'] || options['webpack-only'] || options['hyper-model-only'] || !new_rails_app?
     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
+    def skip_hotloader?
+      options['skip-hotloader'] || options['webpack-only'] || options['hyper-model-only']
     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 -d app/hyperstack
-      TEXT
-      gem_group :development do
-        gem 'foreman'
-      end
+    def skip_webpack?
+      options['hotloader-only'] || options['skip-webpack'] || options['hyper-model-only']
     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 skip_hyper_model?
+      options['hotloader-only'] || options['webpack-only'] || options['skip-hyper-model']
     end
 
-    def install
-      Bundler.with_clean_env do
-        run "bundle install"
+    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 = Rails.root.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
-
-    private
-
-    def skip_webpack?
-      options['skip-webpack'] || !defined?(Webpacker)
-    end
   end
 end