hyperloop-config 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbfe28115b632c56ba9de41cc1ddf85b03fca677
-  data.tar.gz: ba129aab203299356c2a014f5c46f24195d58918
+  metadata.gz: 7f732c8828c572f731b2515c7e4feef8cf1a63ce
+  data.tar.gz: 40b1671bcfa35dea5db6d2c9185901b831961509
 SHA512:
-  metadata.gz: 5ea1e85025c0ca6989ebe22b6d13867b66bd5e2db99febde06c7b438a5adcac6f69d618e1eb0324376318a3f2c413a167c32e2b0ca50db370ef530c54f600037
-  data.tar.gz: 5e94e29e21f7e202d0a301924b6401578fcfb05025d5b449a2e3b54faf82a20d03c96457fb0ae6502be8a018b9326ad37cc5187f7fc948ea4c038ef764891ef6
+  metadata.gz: e9ba99620f956083f59a4bd0b1829c341366b5c0f3c7a3e6b69c790ec7f0743e3ccb3348fff5f7b372700f7857068d9ea069802f1ff5cf207ed4c03b0ddaaf54
+  data.tar.gz: a015d311cd0127c840684fbcb4d9a1b7907becc073ca580a3747162b3e9374ac6837e95f9e1f6a0f67fe1250008f73fb8338156364f9edd3634204a8ffd5d39f

data/README.md

@@ -1,6 +1,27 @@
 # Hyperloop::Configuration
 
-This gem is used internally by other [Hyperloop](http://ruby-hyperloop.io) gems for keeping config settings.
+This gem is used internally by other [Hyperloop](http://ruby-hyperloop.io) gems for keeping config settings, and for registering client side autoload requirements.
+
+To indicate gems to be autoloaded on client side:
+
+```ruby
+require 'hyperloop-config'
+Hyperloop.require 'my-gem-name', gem: true
+Hyperloop.require_gem 'my-gem_name' # short for above
+Hyperloop.require_gem 'my-gem-name', server_only: true
+Hyperloop.require_gem 'my-gem-name', client_only: true
+Hyperloop.require 'path', tree: true  # same as saying require_tree 'path' in a manifest file
+Hyperloop.require 'asset_name' # same as saying require 'asset_name' in a manifest file
+```
+
+The difference between `require_gem`, and `require` is that require_gem can be used inside a gem file spec.  
+
+Once a gem file spec does a `Hyperloop.require_gem` the listed gem will be automatically added to the `hyperloop-loader` manifest.   This means all you do is add a gem
+to rails, and it will get sent on to the client (plus any other dependencies you care to require.)
+
+The require method can be used in the hyperloop initializer as well to add code to the manifest (i.e. add a gem to that is not using Hyperloop.require_gem)
+
+To define an initializer:
 
 ```ruby
 module Hyperloop

data/hyperloop-config.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "hyperloop-config"
-  spec.version       = "0.9.0"
+  spec.version       = "0.9.1"
   spec.authors       = ["catmando"]
   spec.email         = ["mitch@catprint.com"]
 
@@ -21,4 +21,16 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_development_dependency 'hyper-spec'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'opal-rails'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'rails'
+  spec.add_development_dependency 'jquery-rails'
+
+  # Keep linter-rubocop happy
+  spec.add_development_dependency 'rubocop'
+
 end

data/lib/hyperloop-config.rb

@@ -10,11 +10,5 @@ else
   require 'hyperloop/rail_tie' if defined? Rails
   Hyperloop.require 'opal', gem: true
   Hyperloop.require 'hyperloop-config', gem: true
-  # class Sprockets::DirectiveProcessor
-  #   def process_depend_on_config_directive(file)
-  #     path = File.expand_path(file, "#{Rails.root}/config")
-  #     resolve(path)
-  #   end
-  # end
   Opal.append_path(File.expand_path('../', __FILE__).untaint)
 end

data/lib/hyperloop-prerender-loader.rb.erb

@@ -0,0 +1 @@
+<%= Hyperloop.generate_requires(:server, __FILE__) %>

data/lib/hyperloop/rail_tie.rb

@@ -6,9 +6,10 @@ module Hyperloop
       def delete_first(a, e)
         a.delete_at(a.index(e) || a.length)
       end
-      def add_paths=(x)
+
+      def auto_config=(on)
         Rails.configuration.tap do |config|
-          if x
+          if on
             config.eager_load_paths += %W(#{config.root}/app/hyperloop/models)
             config.autoload_paths += %W(#{config.root}/app/hyperloop/models)
             # config.eager_load_paths += %W(#{config.root}/app/hyperloop/stores)
@@ -17,9 +18,6 @@ module Hyperloop
             config.autoload_paths += %W(#{config.root}/app/hyperloop/operations)
 
             config.assets.paths.unshift ::Rails.root.join('app', 'hyperloop').to_s
-            config.eager_load_paths += %W(#{config.root}/app/models/public)
-            config.autoload_paths += %W(#{config.root}/app/models/public)
-            config.assets.paths.unshift ::Rails.root.join('app', 'models').to_s
          else
             delete_first config.eager_load_paths, "#{config.root}/app/hyperloop/models"
             delete_first config.autoload_paths, "#{config.root}/app/hyperloop/models"
@@ -29,31 +27,31 @@ module Hyperloop
             delete_first config.autoload_paths, "#{config.root}/app/hyperloop/operations"
 
             delete_first config.assets.paths, ::Rails.root.join('app', 'hyperloop').to_s
-            delete_first config.eager_load_paths, %W(#{config.root}/app/models/public)
-            delete_first config.autoload_paths, %W(#{config.root}/app/models/public)
-            delete_first config.assets.paths, ::Rails.root.join('app', 'models').to_s
           end
         end
         super
       end
     end
 
-    def add_hyperloop_directories(config)
-      return if config.hyperloop.key?(:add_directories) && !config.hyperloop.add_directories
-      Hyperloop.require_tree('views/components')
-      Hyperloop.require_tree('hyperloop')
-      Hyperloop.require_gem 'opal-jquery', override_with: :opal_jquery, client_only: true # move to hyper-component once things are working
-    end
-
     # note in case of problems with eager load paths have a look at
     # https://github.com/opal/opal-rails/blob/master/lib/opal/rails/engine.rb
     config.hyperloop = Options.new
 
     config.before_configuration do |app|
-      config.hyperloop.add_paths = true
+      config.hyperloop.auto_config = true
     end
+
+    FILES = {files: ['hyperloop-prerender-loader.js']}
+
     config.after_initialize do |app|
-      add_hyperloop_directories(app.config)
+      next unless config.hyperloop.auto_config
+      Hyperloop.require_tree('hyperloop')
+      next unless config.respond_to?(:react)
+      if (opts = config.react.server_renderer_options)
+        opts.merge! FILES
+      else
+        config.react.server_renderer_options = FILES
+      end
     end
   end
 end

data/lib/hyperloop/requires.rb

@@ -4,72 +4,90 @@ module Hyperloop
       @requires ||= []
     end
 
-    def require(value, gem: nil, override_with: nil, client_only: nil, tree: nil)
-      if override_with
-        define_class_method "#{override_with}=" do |value|
-          requires.detect do |name, _value, _client_only, _kind|
-            name == override_with
-          end[1] = value
+    def require(value, gem: nil, instead_of: nil, client_only: nil, server_only: nil, tree: nil)
+      if instead_of
+        current_spec = requires.detect { |old_value, *_rest| instead_of == old_value }
+        if current_spec
+          current_spec[0] = value
+        else
+          raise [
+            "Could not substitute require '#{instead_of}' with '#{value}'.  '#{instead_of}' not found.",
+            'The following requires are listed:',
+            *requires.collect { |old_value, *_rest| old_value }
+          ].join("\n")
         end
+      else
+        kind = if gem
+                 :gem
+               elsif tree
+                 :tree
+               end
+        requires << [value, !client_only, !server_only, kind]
       end
-      kind = if gem
-        :gem
-      elsif tree
-        :tree
-      end
-      requires << [override_with, value, client_only, kind]
     end
 
-    def require_tree(value, override_with: nil, client_only: nil)
-      require(value, override_with: override_with, client_only: client_only, tree: true)
+    def unrequire(value)
+      require(nil, instead_of: value)
     end
 
-    def require_gem(value, override_with: nil, client_only: nil)
-      require(value, override_with: override_with, client_only: client_only, gem: true)
+    def require_tree(value, instead_of: nil, client_only: nil, server_only: nil)
+      require(value, instead_of: instead_of, client_only: client_only, server_only: server_only, tree: true)
+    end
+
+    def require_gem(value, instead_of: nil, client_only: nil, server_only: nil)
+      require(value, instead_of: instead_of, client_only: client_only, server_only: server_only, gem: true)
     end
 
     def generate_requires(mode, file)
       puts "***** generating requires for #{mode} - #{file}"
-      requires.collect do |name, value, client_only, kind|
+      requires.collect do |value, render_on_server, render_on_client, kind|
         next unless value
-        next if client_only && mode != :client
+        next if mode == :client && !render_on_client
+        next if mode == :server && !render_on_server
         if kind == :tree
-          generate_require_tree(value, client_only)
+          generate_require_tree(value, render_on_server, render_on_client)
         elsif kind == :gem
-          r = "require '#{value}' #{client_guard(client_only)}"
+          r = "require '#{value}' #{client_guard(render_on_server, render_on_client)}"
           puts r
           "puts \"#{r}\"; #{r}"
         else
-          generate_directive(:require, value, file, client_only)
+          generate_directive(:require, value, file, render_on_server, render_on_client)
         end
       end.compact.join("\n")
     end
 
-    def generate_directive(directive, to, file, client_only = false)
+    def generate_directive(directive, to, file, render_on_server, render_on_client)
       gem_path = File.expand_path('../', file).split('/')
       comp_path = Rails.root.join('app', 'hyperloop', to).to_s.split('/')
       while comp_path.first == gem_path.first do
         gem_path.shift
         comp_path.shift
       end
-      r = "#{directive} '#{(['.'] + ['..'] * gem_path.length + comp_path).join('/')}' #{client_guard(client_only)}"
+      r = "#{directive} '#{(['.'] + ['..'] * gem_path.length + comp_path).join('/')}' #{client_guard(render_on_server, render_on_client)}"
       puts r
       "puts \"#{r}\"; #{r}"
     end
 
-    def generate_require_tree(path, client_only)
+    def generate_require_tree(path, render_on_server, render_on_client)
       base_name = Rails.root.join('app', path).to_s+'/'
       Dir.glob(Rails.root.join('app', path, '**', '*')).collect do |fname|
-        if ['.js', '.rb', '.erb'].include? File.extname(fname)
-          r = "require '#{fname.gsub(base_name, '')}' #{client_guard(client_only)}"
+        fname = fname.gsub(/^#{base_name}/, '')
+        fname = fname.gsub(/\.erb$/, '')
+        if fname =~ /(\.js$)|(\.rb$)/
+          fname = fname.gsub(/(\.js$)|(\.rb$)/, '')
+          r = "require '#{fname}' #{client_guard(render_on_server, render_on_client)}"
           puts r
           "puts \"#{r}\"; #{r}"
         end
       end.compact.join("\n")
     end
 
-    def client_guard(client_only)
-      "# CLIENT ONLY" if client_only
+    def client_guard(render_on_server, render_on_client)
+      if !render_on_server
+        '# CLIENT ONLY'
+      elsif !render_on_client
+        '# SERVER ONLY'
+      end
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hyperloop-config
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - catmando
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-11 00:00:00.000000000 Z
+date: 2017-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opal
@@ -52,6 +52,118 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: hyper-spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: opal-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - mitch@catprint.com
@@ -65,12 +177,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- hyperloop-config-0.8.1.gem
 - hyperloop-config.gemspec
-- lib/components.rb.erb
 - lib/hyperloop-config.rb
 - lib/hyperloop-loader.js
 - lib/hyperloop-loader2.rb.erb
+- lib/hyperloop-prerender-loader.rb.erb
 - lib/hyperloop/client_readers.rb
 - lib/hyperloop/client_stubs.rb
 - lib/hyperloop/config_settings.rb

data/lib/components.rb.erb

@@ -1 +0,0 @@
-<%= Hyperloop.generate_requires(:prerendering, __FILE__) %>