reactssr-rails 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 412dd6289c7a0285914f65ba6fac234bea374e76
-  data.tar.gz: e3844a13ec50ca4c5efc97a19fdc94ed8bcc7c66
+  metadata.gz: b2e420b41a0ac2cbd7a80791eac20d8e54656917
+  data.tar.gz: 182e72687c06107c02c01322ee64a23277ba5564
 SHA512:
-  metadata.gz: a6c5dcef77c33be7987366253b1538bcc9d833199e9d82cdf84529747c5f49294568b6a3770e5152e29151bfb18d890e3cb828f02c24e834661570368683d403
-  data.tar.gz: 6737f09d1b615fd61da4edc142af155957c68d6ea0743f9033bee231a02c2bbecd0a211987ed3cb6e3d5c155ee71569ad824fb6025f6a620bbb566b06e7886a3
+  metadata.gz: 0239fd847a61cac5c7b901075b8946585ed4bd82fa637eab8ef7cb9da40ecfd4dadcdef33cc4607adf02ae2598a85d022904f78858f1b97cf58c10180d6ff496
+  data.tar.gz: 9f8f6a3980afa5e3c21e7fb043e2fc5deae38bc628f89843a7138e51dc3c4a619d3ab15e6a146b41c183b1ac1a71e69821859d1ae625a1e6256816bf0a0fafd5

data/README.md

@@ -4,8 +4,14 @@
 
 # Reactssr::Rails
 
-Works with `react-rails` and `webpackrails` to server render react components by
-views.
+React SSR in Rails.
+
+This gem is to solve one problem, that's `react-rails` will compile all React 
+components in one file. 
+
+This gem will works well with `webpackrails` to let you use commonjs feature, 
+and only evaluate js code as few as possible, and in production environment it
+will use precompiled static file **instead of** compiling the files again and again.
 
 ## Installation
 
@@ -25,19 +31,9 @@ Or install it yourself as:
 
 ## Usage
 
-The javascript assets folder structure is like views folder, but the base folder
-should be `components`, for example: 
-
-```
-javascripts -|
-  components -|
-    home -|
-      index -|
-```
-
-In the above folder structure, the home folder is the controller name, if your
-controller is under `some_namespace`, then the home folder should under `some_namespace`
-folder, just like `views` folder structure.
+The SSR file is a js file whose name ends with `ssr.js` under base folder, and 
+base folder is the folder where you put all your SSR files at, the default base
+folder name is `components`.
 
 You can config the base folder, put this within your `config/application.rb` file, 
 `config.reactssr.assets_base = 'folder_name'`.
@@ -48,41 +44,25 @@ You can config the base folder, put this within your `config/application.rb` fil
 an example how to use it:
 
 ```js
-<%= react_ssr('IndexView', {props}, {prerender: true}) %>
+<%= react_ssr('IndexView', {props}) %>
 ```
-If you specific `prerender: false` in the options, the `react_ssr` will use
-`react_component` instead (will be changed in future). For now, please just use
-`prerender: true`.
 
-So, how reactssr look up the `IndexView` react component in assets? Well, it will
-look up the view by controller name and action name, so the controller name is `home`
-and action name is `index`, then it will look up a file named `index.ssr.js` in 
-folder `components/home/index/`. You just put your components in that file and 
-expose those components on `Components` js global object. Here is an example of
-`index.ssr.js`:
+So, suppose the current `controller_path` is `home`, then reactssr-rails will look
+up a ssr file in components named `home.ssr.js`, just like below:
 
 ```js
-// index.ssr.js
+// home.ssr.js
 
 Components.IndexView = require('./IndexView.jsx');
 ```
 
-And put your `IndexView.jsx` file under `components/home/index/` folder. Such 
-file would be like this:
-
-```js
-// IndexView.jsx
+## Example
 
-module.exports = React.createClass({
-  render: function () {
-    return <p>Hello world</p>
-  }
-})
-```
+http://github.com/towry/reactssr-rails-example
 
-## NOTICE
+## TODO
 
-Not tested in production environment.
+- [x] In production env, do not run `webpackrails`
 
 ## Development
 
@@ -92,7 +72,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/reactssr-rails/fork )
+1. Fork it ( https://github.com/towry/reactssr-rails/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/reactssr/rails.rb

@@ -1,5 +1,6 @@
 require "reactssr/rails/version"
 require "reactssr/rails/view_helper"
 require "reactssr/rails/railtie"
+require "reactssr/rails/engine"
 require "reactssr/server_rendering/ssr_renderer"
 

data/lib/reactssr/rails/engine.rb

@@ -0,0 +1,11 @@
+module Reactssr
+  module Rails
+    class Engine < ::Rails::Engine 
+      initializer 'reactssr.assets.precompile' do |app|
+        base = app.config.reactssr.assets_base
+        precompile = File.join(base, '*.ssr.js')
+        app.config.assets.precompile += [precompile]
+      end
+    end
+  end
+end

data/lib/reactssr/rails/railtie.rb

@@ -6,10 +6,7 @@ module Reactssr
       # The folder that contains all the stuff
       config.reactssr.assets_base = 'components'
 
-      # entry js file
-      config.reactssr.entry = 'index.ssr.js'
-
-      initializer "react_rails_ssr.setup_view_helpers", group: :all do |app|
+      initializer "reactssr.setup_view_helpers", group: :all do |app|
         ActiveSupport.on_load(:action_view) do 
           include ::Reactssr::Rails::ViewHelper
         end

data/lib/reactssr/rails/version.rb

@@ -1,5 +1,5 @@
 module Reactssr
   module Rails
-    VERSION = "0.1.0"
+    VERSION = "1.0.0"
   end
 end

data/lib/reactssr/rails/view_helper.rb

@@ -8,10 +8,7 @@ module Reactssr
       def react_ssr(name, props = {}, options = {}, &block)
         options = {:tag => options} if options.is_a?(Symbol)
 
-        prerender_options = options[:prerender]
-        if !prerender_options and Rails.application.config.react.server_renderer != ::Reactssr::ServerRendering::SsrRenderer
-          return react_component(name, props, options, &block)
-        end
+        prerender_options = true
 
         # All the below stuff is to send the `controller_name`
         # and `action_name` to our ssr_renderer.

data/lib/reactssr/server_rendering/ssr_renderer.rb

@@ -1,4 +1,5 @@
 
+require 'multi_json'
 require 'react-rails'
 
 module Reactssr
@@ -15,6 +16,9 @@ module Reactssr
         end
 
         @before_render_code ||= File.read("#{File.dirname __FILE__}/../assets/before_render.js")
+        
+        @manifest_base ||= File.join(::Rails.public_path, ::Rails.application.config.assets.prefix)
+        load_asset_on_init
 
         super(options.merge(code: js_code))
       end
@@ -23,9 +27,10 @@ module Reactssr
         prerender_options = pre_options[:prerender_options]
 
         @controller_path = pre_options.fetch(:controller_path, nil)
-        @action_name = pre_options.fetch(:action_name, nil)
+        # @action_name = pre_options.fetch(:action_name, nil)
 
-        if @controller_path.nil? or @action_name.nil?
+        # if @controller_path.nil? or @action_name.nil?
+        if @controller_path.nil?
           raise Reactssr::ServerRendering::RuntimeCommonError.new("Could not found the controller path or action name in current context.")
         end
 
@@ -50,8 +55,18 @@ module Reactssr
       # So, we will gather all the code for that controller#action
       # in here.
       def before_render(component_name, props, prerender_options)
-        jscode = @before_render_code.dup 
-        jscode << ::Rails.application.assets[entry].to_s
+        jscode = @before_render_code.dup
+
+        success = false
+        if ::Rails.env.production?
+          content, success = load_asset(entry)
+        end
+
+        if not success
+          jscode << ::Rails.application.assets[entry].to_s
+        else 
+          jscode << content
+        end
 
         # the result is jscode
         jscode
@@ -88,9 +103,64 @@ module Reactssr
 
       def entry
         components = ::Rails.application.config.reactssr.assets_base || 'components'
-        entry_file = ::Rails.application.config.reactssr.entry || 'index.ssr.js'
-        sub_path = File.join(@controller_path, @action_name)
-        entry = File.join(components, sub_path, 'index.ssr.js')
+        entry = File.join(components, "#{@controller_path}.ssr.js")
+      end
+
+      private
+
+      # Return asset content
+      def load_asset(filename)
+        digest_path = assets[filename]
+
+        if digest_path.nil?
+          return '', false 
+        end
+
+        file = File.join(@manifest_base, digest_path)
+        if not File.exist?(file)
+          return '', false 
+        end
+
+        return File.read(file), true
+      end
+
+      def assets
+        @data['assets'] ||= {}
+      end
+
+      def files
+        @data['files'] ||= {}
+      end
+
+      # load assets from Rails.public_path
+      def load_asset_on_init
+        paths = Dir[File.join(@manifest_base, "manifest*.json")]
+        if paths.any?
+          path = paths.first
+        else 
+          # No precompile
+          return {}
+        end
+
+        begin
+          if File.exist?(path)
+            data = json_decode(File.read(path))
+          end
+        rescue ::MultiJson::DecodeError => e
+          return {}
+        end
+
+        @data = data.is_a?(Hash) ? data : {}
+      end
+
+      if ::MultiJson.respond_to?(:dump)
+        def json_decode(obj)
+          ::MultiJson.load(obj)
+        end
+      else
+        def json_decode(obj)
+          ::MultiJson.decode(obj)
+        end
       end
     end
 

data/reactssr-rails.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["towry"]
   spec.email         = ["tovvry@gmail.com"]
 
-  spec.summary       = %q{Server render React component by view.}
+  spec.summary       = %q{React SSR in Rails}
   spec.description   = %q{Works with `react-rails` and `webpackrails` to server render react components by
 views.}
   spec.homepage      = "https://github.com/towry/reactssr-rails"
@@ -33,4 +33,5 @@ views.}
 
   # This gem depend on `react-rails`
   spec.add_dependency 'react-rails', '>= 1.1.0'
+  spec.add_dependency 'multi_json', '>= 1.0'
 end

metadata

@@ -1,57 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: reactssr-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - towry
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-18 00:00:00.000000000 Z
+date: 2015-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: react-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: |-
   Works with `react-rails` and `webpackrails` to server render react components by
   views.
@@ -61,8 +75,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
+- .gitignore
+- .travis.yml
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -72,6 +86,7 @@ files:
 - bin/setup
 - lib/reactssr/assets/before_render.js
 - lib/reactssr/rails.rb
+- lib/reactssr/rails/engine.rb
 - lib/reactssr/rails/railtie.rb
 - lib/reactssr/rails/version.rb
 - lib/reactssr/rails/view_helper.rb
@@ -88,18 +103,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: Server render React component by view.
+summary: React SSR in Rails
 test_files: []