js_render 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b8a50324a1e29411b656887a42e712abc725525
-  data.tar.gz: bbc79e9601ad177347554ffae6bad8f3b8bbb56a
+  metadata.gz: 931cdb27a1564cea7a6719b853ae02809767e3e1
+  data.tar.gz: 9c312aa181cc85b811fb42d1e5413c08031fe8c8
 SHA512:
-  metadata.gz: 5ae2860584985861a352d3de82327b7da28006d2be451bb7350fe5576ba8c7f244b131652ffa5ec5d375d3ce8ea3b636bd5b2a2133e7725d7ea477b41b4c0d27
-  data.tar.gz: 0f161814ea23b7f5d82d93eca445b1bbec78dcf9a2c13d94d6f2cd940c51a58ed38d7d1685abf31a7a14d6d60c4ed680e1ab12c5fd6e68b678b3ab8099e78879
+  metadata.gz: d0130b87cc4372619a790c24a53ba05905208a53e6faaa684e2e5b5828579064b8152176b08cd1e1c6ab791c52e6a1b968cd93e3b9cb660c6d1d774c97fbf2f2
+  data.tar.gz: 9d902e9d87c9a78fd2d834b572ed17f49b5c96024878af06aa36344d4b2b45189f58b18d23db93483a7fd68690ec0a4dbecd07b1bbbe92d69fa00a67269e4d0c

data/README.md

@@ -133,6 +133,25 @@ If you want the component name to be included in the name dynamically, you can u
 
 > Defaults to `window.render*Client` (eg for `MyComponent`, `window.renderMyComponentClient`)
 
+**asset_finder_class**
+
+`JsRender::Renderer` uses the `JsRender::AssetFinder::Base` class to find and read JS asset files it needs to generate the server HTML (with the server render function). If `use_asset_pipeline` is true, it will use `JSRender::Rails::AssetFinder` instead, which just overrides the `read` method. The `asset_finder_class` configuration option provides a hook to override how the JS assets are found or read.
+
+You can either provide a new class that provides a `#read_files` method (takes a component name and returns a string of JS from the files that component needs to render) or you can subclass `JsRender::AssetFinder::Base`.
+
+Methods you can override if you subclass `JsRender::AssetFinder::Base`:
+
+- `Base#find_files` takes the component name as a string and returns a list of paths to files.
+ - This method can be overridden to change how files are looked up, or to transform the pathnames (which might be useful if your JS assets are built outside of the asset pipeline or to another directory.
+
+- `Base#read_files` takes the component name as a string and calls `Base#find_files` to get all the files. It then reads each of these files with `Base#read`, concatenates them together and returns a string. This is the method that is actually used directly by `JsRender::Renderer`.
+ - This method will rarely need to be overridden as you can change the behavior of `Base#find_files` and `Base#read`.
+
+- `Base#read` takes a path as a string and returns the file contents as a string.
+ - This method can be overridden to apply a transformation on the contents of the file (like compiling ES2015 to ES5).
+
+> Defaults to `nil`
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -149,6 +168,6 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Motivation and Thanks
 
-This project came out of the desire to support server side rendering of React components. The most popular existing solution, [`react-rails`](https://github.com/reactjs/react-rails) is much more opinionated, but also does a lot implicitly under the hood. If your focus is on React server side rendering, and your experience primarily lies in Ruby on Rails, or you do not mind writing your JavaScript within the boundaries and opinions of react-rails, I highly recommend you take a look at it. Another good React/Rails specific library for server side React rendering to check out is [react_on_rails](https://github.com/shakacode/react_on_rails). Many thanks to the contributors of these projects as they were both influential in creating JsRender.
+This project came out of the desire to support server side rendering of React components. The most popular existing solution, [`react-rails`](https://github.com/reactjs/react-rails) is much more opinionated, but also does a lot implicitly under the hood. If your focus is on React server side rendering, and your experience primarily lies in Ruby on Rails, or you do not mind writing your JavaScript within the boundaries and opinions of react-rails, I highly recommend you take a look at it. Another good React/Rails specific library for server side React rendering to check out is [`react_on_rails`](https://github.com/shakacode/react_on_rails). Many thanks to the contributors of these projects as they were both influential in creating JsRender.
 
 The goal of this project is to be framework agnostic and support server side rendering for any JavaScript component library, popular or self-rolled. While Rails support is baked in, the ultimate goal of this project is to work anywhere where Ruby is used as the server side language.

data/examples/react/.gitignore

@@ -17,3 +17,5 @@
 /tmp
 
 /node_modules
+
+Gemfile.lock

data/examples/vanilla_js/.gitignore

@@ -15,3 +15,5 @@
 /log/*
 !/log/.keep
 /tmp
+
+Gemfile.lock

data/lib/js_render/asset_finder/base.rb

@@ -1,12 +1,26 @@
 module JsRender
   module AssetFinder
     class Base
-      def initialize
+      def find_files(component_name)
+        base_path = JsRender.config.base_path
+        paths = JsRender.config.component_paths
+        suffix = JsRender.config.component_suffix
+
+        paths.map do |path|
+          Dir[File.join(base_path, path)].select do |full_path|
+            full_path.match Regexp.new("/#{component_name}#{suffix}")
+          end
+        end.compact.flatten.uniq
+      end
+
+      def read_files(component_name)
+        files = find_files component_name
+        files.map { |file| read file }.join('')
       end
 
-      def find(path)
+      def read(path)
         if File.file? path
-          File.read(path)
+          File.read path
         else
           raise JsRender::Errors::AssetFileNotFound.new "Asset \"#{path}\" does not exist."
         end

data/lib/js_render/configuration.rb

@@ -21,7 +21,8 @@ module JsRender
                   :component_suffix,
                   :server_render_function,
                   :client_render_function,
-                  :use_asset_pipeline
+                  :use_asset_pipeline,
+                  :asset_finder_class
 
     def initialize
       @base_path = 'app/assets/javascripts'
@@ -30,6 +31,7 @@ module JsRender
       @server_render_function = 'window.render*Server'
       @client_render_function = 'window.render*Client'
       @use_asset_pipeline = false
+      @asset_finder_class = nil
     end
   end
 end

data/lib/js_render/rails/asset_finder.rb

@@ -2,11 +2,12 @@ module JsRender
   module Rails
     class AssetFinder < ::JsRender::AssetFinder::Base
       def initialize
+        super
         @environment = ::Rails.application.assets
         @manifest = ::Rails.application.assets_manifest
       end
 
-      def find(path)
+      def read(path)
         logical_path = path.gsub('app/assets/javascripts/', '')
         if @environment
           @environment[logical_path].to_s

data/lib/js_render/renderer.rb

@@ -3,7 +3,7 @@ require 'securerandom'
 
 module JsRender
   class Renderer
-    attr_reader :component_name, :json_data, :uuid
+    attr_reader :component_name, :json_data, :uuid, :asset_finder
 
     GLOBAL_CONTEXT = <<-JS
       var global = global || this;
@@ -33,7 +33,7 @@ module JsRender
           return '<span id="#{@uuid}">' + serverStr + '</span>';
         })()
       JS
-      renderer_code = js_context(find_renderer_files)
+      renderer_code = asset_finder.read_files(@component_name)
       context = ::ExecJS.compile(GLOBAL_CONTEXT + renderer_code)
       context.eval(server_code)
     rescue ExecJS::RuntimeError, ExecJS::ProgramError => error
@@ -52,26 +52,15 @@ module JsRender
 
     private
 
-    def find_renderer_files
-      base_path = JsRender.config.base_path
-      paths = JsRender.config.component_paths
-      suffix = JsRender.config.component_suffix
-
-      paths.map do |path|
-        Dir[File.join(base_path, path)].select do |full_path|
-          full_path.match Regexp.new("/#{@component_name}#{suffix}")
+    def asset_finder
+      @asset_finder ||=
+        if JsRender.config.asset_finder_class
+          JsRender.config.asset_finder_class.new
+        elsif defined?(::Rails) && JsRender.config.use_asset_pipeline
+          Rails::AssetFinder.new
+        else
+          AssetFinder::Base.new
         end
-      end.compact.flatten.uniq
-    end
-
-    def js_context(paths)
-      asset_finder = if defined?(::Rails) && JsRender.config.use_asset_pipeline
-        Rails::AssetFinder.new
-      else
-        AssetFinder::Base.new
-      end
-      paths.map { |path| asset_finder.find path }.join('')
     end
   end
-
 end

data/lib/js_render/version.rb

@@ -1,3 +1,3 @@
 module JsRender
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js_render
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jonathan Lehman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-11 00:00:00.000000000 Z
+date: 2016-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,7 +85,6 @@ files:
 - bin/setup
 - examples/react/.gitignore
 - examples/react/Gemfile
-- examples/react/Gemfile.lock
 - examples/react/README.rdoc
 - examples/react/Rakefile
 - examples/react/app/assets/images/.keep
@@ -149,7 +148,6 @@ files:
 - examples/react/vendor/assets/stylesheets/.keep
 - examples/vanilla_js/.gitignore
 - examples/vanilla_js/Gemfile
-- examples/vanilla_js/Gemfile.lock
 - examples/vanilla_js/README.rdoc
 - examples/vanilla_js/Rakefile
 - examples/vanilla_js/app/assets/images/.keep

data/examples/react/Gemfile.lock

@@ -1,171 +0,0 @@
-PATH
-  remote: ../../
-  specs:
-    js_render (0.1.1)
-      execjs
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionmailer (4.2.6)
-      actionpack (= 4.2.6)
-      actionview (= 4.2.6)
-      activejob (= 4.2.6)
-      mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-    actionpack (4.2.6)
-      actionview (= 4.2.6)
-      activesupport (= 4.2.6)
-      rack (~> 1.6)
-      rack-test (~> 0.6.2)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (4.2.6)
-      activesupport (= 4.2.6)
-      builder (~> 3.1)
-      erubis (~> 2.7.0)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    activejob (4.2.6)
-      activesupport (= 4.2.6)
-      globalid (>= 0.3.0)
-    activemodel (4.2.6)
-      activesupport (= 4.2.6)
-      builder (~> 3.1)
-    activerecord (4.2.6)
-      activemodel (= 4.2.6)
-      activesupport (= 4.2.6)
-      arel (~> 6.0)
-    activesupport (4.2.6)
-      i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
-      tzinfo (~> 1.1)
-    arel (6.0.3)
-    binding_of_caller (0.7.2)
-      debug_inspector (>= 0.0.1)
-    browserify-rails (3.0.1)
-      railties (>= 4.0.0, < 5.0)
-      sprockets (>= 3.5.2)
-    builder (3.2.2)
-    byebug (8.2.5)
-    coffee-rails (4.1.1)
-      coffee-script (>= 2.2.0)
-      railties (>= 4.0.0, < 5.1.x)
-    coffee-script (2.4.1)
-      coffee-script-source
-      execjs
-    coffee-script-source (1.10.0)
-    concurrent-ruby (1.0.2)
-    debug_inspector (0.0.2)
-    erubis (2.7.0)
-    execjs (2.6.0)
-    globalid (0.3.6)
-      activesupport (>= 4.1.0)
-    i18n (0.7.0)
-    jbuilder (2.4.1)
-      activesupport (>= 3.0.0, < 5.1)
-      multi_json (~> 1.2)
-    jquery-rails (4.1.1)
-      rails-dom-testing (>= 1, < 3)
-      railties (>= 4.2.0)
-      thor (>= 0.14, < 2.0)
-    json (1.8.3)
-    loofah (2.0.3)
-      nokogiri (>= 1.5.9)
-    mail (2.6.4)
-      mime-types (>= 1.16, < 4)
-    mime-types (3.0)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2016.0221)
-    mini_portile2 (2.0.0)
-    minitest (5.8.4)
-    multi_json (1.12.0)
-    nokogiri (1.6.7.2)
-      mini_portile2 (~> 2.0.0.rc2)
-    rack (1.6.4)
-    rack-test (0.6.3)
-      rack (>= 1.0)
-    rails (4.2.6)
-      actionmailer (= 4.2.6)
-      actionpack (= 4.2.6)
-      actionview (= 4.2.6)
-      activejob (= 4.2.6)
-      activemodel (= 4.2.6)
-      activerecord (= 4.2.6)
-      activesupport (= 4.2.6)
-      bundler (>= 1.3.0, < 2.0)
-      railties (= 4.2.6)
-      sprockets-rails
-    rails-deprecated_sanitizer (1.0.3)
-      activesupport (>= 4.2.0.alpha)
-    rails-dom-testing (1.0.7)
-      activesupport (>= 4.2.0.beta, < 5.0)
-      nokogiri (~> 1.6.0)
-      rails-deprecated_sanitizer (>= 1.0.1)
-    rails-html-sanitizer (1.0.3)
-      loofah (~> 2.0)
-    railties (4.2.6)
-      actionpack (= 4.2.6)
-      activesupport (= 4.2.6)
-      rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
-    rake (11.1.2)
-    rdoc (4.2.2)
-      json (~> 1.4)
-    sass (3.4.22)
-    sass-rails (5.0.4)
-      railties (>= 4.0.0, < 5.0)
-      sass (~> 3.1)
-      sprockets (>= 2.8, < 4.0)
-      sprockets-rails (>= 2.0, < 4.0)
-      tilt (>= 1.1, < 3)
-    sdoc (0.4.1)
-      json (~> 1.7, >= 1.7.7)
-      rdoc (~> 4.0)
-    spring (1.7.1)
-    sprockets (3.6.0)
-      concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.0.4)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
-      sprockets (>= 3.0.0)
-    sqlite3 (1.3.11)
-    thor (0.19.1)
-    thread_safe (0.3.5)
-    tilt (2.0.2)
-    turbolinks (2.5.3)
-      coffee-rails
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
-    uglifier (3.0.0)
-      execjs (>= 0.3.0, < 3)
-    web-console (2.3.0)
-      activemodel (>= 4.0)
-      binding_of_caller (>= 0.7.2)
-      railties (>= 4.0)
-      sprockets-rails (>= 2.0, < 4.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  browserify-rails
-  byebug
-  coffee-rails (~> 4.1.0)
-  jbuilder (~> 2.0)
-  jquery-rails
-  js_render!
-  rails (= 4.2.6)
-  sass-rails (~> 5.0)
-  sdoc (~> 0.4.0)
-  spring
-  sqlite3
-  turbolinks
-  uglifier (>= 1.3.0)
-  web-console (~> 2.0)
-
-BUNDLED WITH
-   1.12.1

data/examples/vanilla_js/Gemfile.lock

@@ -1,167 +0,0 @@
-PATH
-  remote: ../../
-  specs:
-    js_render (0.1.0)
-      execjs
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionmailer (4.2.6)
-      actionpack (= 4.2.6)
-      actionview (= 4.2.6)
-      activejob (= 4.2.6)
-      mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-    actionpack (4.2.6)
-      actionview (= 4.2.6)
-      activesupport (= 4.2.6)
-      rack (~> 1.6)
-      rack-test (~> 0.6.2)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (4.2.6)
-      activesupport (= 4.2.6)
-      builder (~> 3.1)
-      erubis (~> 2.7.0)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    activejob (4.2.6)
-      activesupport (= 4.2.6)
-      globalid (>= 0.3.0)
-    activemodel (4.2.6)
-      activesupport (= 4.2.6)
-      builder (~> 3.1)
-    activerecord (4.2.6)
-      activemodel (= 4.2.6)
-      activesupport (= 4.2.6)
-      arel (~> 6.0)
-    activesupport (4.2.6)
-      i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
-      tzinfo (~> 1.1)
-    arel (6.0.3)
-    binding_of_caller (0.7.2)
-      debug_inspector (>= 0.0.1)
-    builder (3.2.2)
-    byebug (8.2.5)
-    coffee-rails (4.1.1)
-      coffee-script (>= 2.2.0)
-      railties (>= 4.0.0, < 5.1.x)
-    coffee-script (2.4.1)
-      coffee-script-source
-      execjs
-    coffee-script-source (1.10.0)
-    concurrent-ruby (1.0.2)
-    debug_inspector (0.0.2)
-    erubis (2.7.0)
-    execjs (2.6.0)
-    globalid (0.3.6)
-      activesupport (>= 4.1.0)
-    i18n (0.7.0)
-    jbuilder (2.4.1)
-      activesupport (>= 3.0.0, < 5.1)
-      multi_json (~> 1.2)
-    jquery-rails (4.1.1)
-      rails-dom-testing (>= 1, < 3)
-      railties (>= 4.2.0)
-      thor (>= 0.14, < 2.0)
-    json (1.8.3)
-    loofah (2.0.3)
-      nokogiri (>= 1.5.9)
-    mail (2.6.4)
-      mime-types (>= 1.16, < 4)
-    mime-types (3.0)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2016.0221)
-    mini_portile2 (2.0.0)
-    minitest (5.8.4)
-    multi_json (1.12.0)
-    nokogiri (1.6.7.2)
-      mini_portile2 (~> 2.0.0.rc2)
-    rack (1.6.4)
-    rack-test (0.6.3)
-      rack (>= 1.0)
-    rails (4.2.6)
-      actionmailer (= 4.2.6)
-      actionpack (= 4.2.6)
-      actionview (= 4.2.6)
-      activejob (= 4.2.6)
-      activemodel (= 4.2.6)
-      activerecord (= 4.2.6)
-      activesupport (= 4.2.6)
-      bundler (>= 1.3.0, < 2.0)
-      railties (= 4.2.6)
-      sprockets-rails
-    rails-deprecated_sanitizer (1.0.3)
-      activesupport (>= 4.2.0.alpha)
-    rails-dom-testing (1.0.7)
-      activesupport (>= 4.2.0.beta, < 5.0)
-      nokogiri (~> 1.6.0)
-      rails-deprecated_sanitizer (>= 1.0.1)
-    rails-html-sanitizer (1.0.3)
-      loofah (~> 2.0)
-    railties (4.2.6)
-      actionpack (= 4.2.6)
-      activesupport (= 4.2.6)
-      rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
-    rake (11.1.2)
-    rdoc (4.2.2)
-      json (~> 1.4)
-    sass (3.4.22)
-    sass-rails (5.0.4)
-      railties (>= 4.0.0, < 5.0)
-      sass (~> 3.1)
-      sprockets (>= 2.8, < 4.0)
-      sprockets-rails (>= 2.0, < 4.0)
-      tilt (>= 1.1, < 3)
-    sdoc (0.4.1)
-      json (~> 1.7, >= 1.7.7)
-      rdoc (~> 4.0)
-    spring (1.7.1)
-    sprockets (3.6.0)
-      concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.0.4)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
-      sprockets (>= 3.0.0)
-    sqlite3 (1.3.11)
-    thor (0.19.1)
-    thread_safe (0.3.5)
-    tilt (2.0.2)
-    turbolinks (2.5.3)
-      coffee-rails
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
-    uglifier (3.0.0)
-      execjs (>= 0.3.0, < 3)
-    web-console (2.3.0)
-      activemodel (>= 4.0)
-      binding_of_caller (>= 0.7.2)
-      railties (>= 4.0)
-      sprockets-rails (>= 2.0, < 4.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  byebug
-  coffee-rails (~> 4.1.0)
-  jbuilder (~> 2.0)
-  jquery-rails
-  js_render!
-  rails (= 4.2.6)
-  sass-rails (~> 5.0)
-  sdoc (~> 0.4.0)
-  spring
-  sqlite3
-  turbolinks
-  uglifier (>= 1.3.0)
-  web-console (~> 2.0)
-
-BUNDLED WITH
-   1.12.1