passes its test

Author: catmando

hyperloop-config-0.8.1.gem

@@ -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

hyperloop-config.gemspec

@@ -10,11 +10,5 @@
   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

lib/components.rb.erb

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

lib/hyperloop-config.rb

@@ -6,9 +6,10 @@ class Options < ActiveSupport::OrderedOptions
       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 @@ def add_paths=(x)
             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 @@ def add_paths=(x)
             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

lib/hyperloop-prerender-loader.rb.erb

@@ -4,72 +4,90 @@ def requires
       @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

lib/hyperloop/rail_tie.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+# rubocop:disable Metrics/BlockLength
+describe 'Hyperloop Auto Config', js: true do
+
+  after(:each) do
+    Timecop.return
+  end
+
+  it 'will find and load everything and expand erb files' do
+    `rm -rf spec/test_app/tmp/cache`
+    Timecop.freeze
+    visit '/'
+    expect(evaluate_script("Opal.Test.$const_get('TIME')")).to eq("#{Time.now}")
+  end
+
+end

lib/hyperloop/requires.rb

@@ -0,0 +1,17 @@
+require 'hyper-spec'
+require 'pry'
+require 'opal-rails'
+require 'hyperloop-config'
+require 'jquery-rails'
+
+
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../test_app/config/environment', __FILE__)
+
+require 'rspec/rails'
+require 'timecop'
+
+RSpec.configure do |config|
+  config.color = true
+  config.formatter = :documentation
+end

spec/hyperloop_config_spec.rb

@@ -0,0 +1,21 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore Byebug command history file.
+.byebug_history

spec/spec_helper.rb

@@ -0,0 +1,40 @@
+source 'https://rubygems.org'
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
+  "https://github.com/#{repo_name}.git"
+end
+
+
+gem 'rails', '~> 5.0.1'
+gem 'sqlite3'
+gem 'puma', '~> 3.6.0'
+gem 'jquery-rails'
+
+gem 'hyperloop-config', path: '../..'
+gem 'hyper-spec', git: 'https://www.github.com/ruby-hyperloop/hyper-spec'
+gem 'opal', '~> 0.9.0'
+gem 'opal-browser'
+gem 'opal-jquery'
+gem 'opal-rails', '~> 0.9.0'
+gem 'therubyracer', platforms: :ruby
+gem 'react-rails', '~> 1.9.0'
+
+group :development, :test do
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  gem 'byebug', platform: :mri
+  gem 'rspec-steps'
+end
+
+group :development do
+  # Access an IRB console on exception pages or by using <%= console %> anywhere in the code.
+  gem 'web-console', '>= 3.3.0'
+  gem 'listen', '~> 3.0.5'
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'spring'
+  gem 'spring-watcher-listen', '~> 2.0.0'
+  gem 'rubocop', require: false
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]