react_on_rails 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3d6a3770f22b5c124f17556203f1b1a74fd550b
-  data.tar.gz: 779c9ccbca94e36754c0fa90d60ab12aa8bf4785
+  metadata.gz: c32d5d1549cefdb05c11593b8fc46357c3a2b51a
+  data.tar.gz: c9a61af04d0b81767c48e155a6cd8af8e9081cc4
 SHA512:
-  metadata.gz: 47688d10f95c09bc2b9dcdb86744319c9e15b071d7c10de1c204c3a1815b793089ef2da7699a15a4bb7f314796e8d8dd7f608bdc43bc401497e2f9e61d239806
-  data.tar.gz: 5701bc9218429a92987a9160de14cd37a8965b5298bc2535eb632adb1639087afde627136a7a11f938bfa7cfa898b89631094f334dd25b5bb29a34ae5365c61a
+  metadata.gz: ebc8347894681090d81c8e1580aebadaf36fc0465ac9635e054362584c737d22d8d659ec4bd8412bd914cd7adb5b1a3a8cdf880fa5ea6db8ff3a3550d39a21a2
+  data.tar.gz: ff1e4ab63b241615882224a88666f8c2dc04ea29133881649ba31f539e816a638851924b85c45003e2dfdfd73506336e428f1cdbfbcc36daff7905a7b3286bbf

data/.gitignore

@@ -7,7 +7,7 @@
 /pkg/
 /spec/reports/
 /tmp/
-
+*.gem
 
 /spec/dummy/client/node_modules
 /spec/dummy/app/assets/javascripts/generated/
@@ -15,3 +15,4 @@
 # RVM
 .ruby-version
 .ruby-gemset
+

data/README.md

@@ -1,7 +1,11 @@
-# ReactOnRails
+# React On Rails
 
 Published: https://rubygems.org/gems/react_on_rails
 
+See [Action Plan for v1.0](https://github.com/shakacode/react_on_rails/issues/1)
+
+Feedback and pull-requests encouraged! Thanks in advance!
+
 Supports:
 
 1. Rails
@@ -10,6 +14,7 @@ Supports:
 4. Redux
 5. Turbolinks
 6. Server side rendering with fragment caching
+7. react-router for client side rendering (and maybe server side eventually)
 
 # Authors
 The Shaka Code team!
@@ -21,7 +26,7 @@ The Shaka Code team!
 And based on the work of the [react-rails gem](https://github.com/reactjs/react-rails)
 
 # Key Info
-Currently in proof of concept phase.
+Currently being implemented in 3 production projects (not yet live).
 
 1. https://github.com/justin808/react-webpack-rails-tutorial/
 2. http://www.railsonmaui.com/blog/2014/10/03/integrating-webpack-and-the-es6-transpiler-into-an-existing-rails-project/
@@ -56,13 +61,25 @@ Contributions and pull requests welcome!
 
 # Key Tips
 1. See sample app in `spec/dummy` for how to set this up. 
-2. The file used for server rendering is hard coded as generated/server.js
-   (assets/javascripts/generated/server.js)
-3. The default for rendering right now is `prerender: true`. **NOTE:** This does not work for
-   components, namely react-router, that use an async setup for server rendering.
+2. The file used for server rendering is hard coded as `generated/server.js`
+   (assets/javascripts/generated/server.js).
+3. If you're only doing client rendering, you still *MUST* create an empty version of this file. This
+   will soon change so that this is not necessary.
+3. The default for rendering right now is `prerender: false`. **NOTE:**  Server side rendering does 
+   not work for some components, namely react-router, that use an async setup for server rendering. 
+   You can configure the default for prerender in your config. 
 4. The API for objects exposed differs from the react-rails gem in that you expose a function that
    returns a react component. We'll be changing that to take either a function or a React component.
 
+# Example Configuration, config/react_on_rails.rb
+```ruby
+   ReactOnRails.configure do |config|
+     config.bundle_js_file = "app/assets/javascripts/generated/server.js" # This is the default
+     config.prerender = true # default is false
+   end
+```
+
+
 ## References
 * [Making the helper for server side rendering work with JS created by Webpack] (https://github.com/reactjs/react-rails/issues/301#issuecomment-133098974)
 * [Add Demonstration of Server Side Rendering](https://github.com/justin808/react-webpack-rails-tutorial/issues/2)

data/app/helpers/react_on_rails_helper.rb

@@ -25,9 +25,8 @@ module ReactOnRailsHelper
     # (re-hydrate the data). This enables react rendered on the client to see that the
     # server has already rendered the HTML.
     @react_component_index ||= 0
-
-    prerender = options[:prerender].nil? ? true : options[:prerender]
-    trace = options[:trace].nil? ? false : options[:trace]
+    prerender = options.fetch(:prerender) { ReactOnRails.configuration.prerender }
+    trace = options.fetch(:trace, false)
 
     dataVariable = "__#{component_name.camelize(:lower)}Data#{@react_component_index}__"
     reactComponent = component_name.camelize
@@ -49,7 +48,6 @@ module ReactOnRailsHelper
 
     # Create the HTML rendering part
     if prerender
-
       render_js_expression = <<-JS
           renderReactComponent(this.#{reactComponent}, #{props.to_json})
       JS

data/lib/react_on_rails.rb

@@ -1,4 +1,7 @@
+require "rails"
+
 require "react_on_rails/version"
+require "react_on_rails/configuration"
 
 module ReactOnRails
   class Engine < ::Rails::Engine

data/lib/react_on_rails/configuration.rb

@@ -0,0 +1,21 @@
+module ReactOnRails
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new(
+      bundle_js_file: "app/assets/javascripts/generated/server.js",
+      prerender: false
+    )
+  end
+
+  class Configuration
+    attr_accessor :bundle_js_file, :prerender
+
+    def initialize(bundle_js_file:, prerender:)
+      self.bundle_js_file = bundle_js_file
+      self.prerender = prerender
+    end
+  end
+end

data/lib/react_on_rails/react_renderer.rb

@@ -35,10 +35,8 @@ module ReactOnRails
     private
 
     def bundle_js_code
-      # Calling to_s to get contents of sprockets.
-
-      # TODO: Make this file name configurable
-      Rails.application.assets['generated/server.js'].to_s
+      js_file = Rails.root.join(ReactOnRails.configuration.bundle_js_file)
+      File.read(js_file)
     end
   end
 end

data/lib/react_on_rails/version.rb

@@ -1,3 +1,3 @@
 module ReactOnRails
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: react_on_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Justin Gordon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-28 00:00:00.000000000 Z
+date: 2015-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -97,6 +97,7 @@ files:
 - Rakefile
 - app/helpers/react_on_rails_helper.rb
 - lib/react_on_rails.rb
+- lib/react_on_rails/configuration.rb
 - lib/react_on_rails/react_renderer.rb
 - lib/react_on_rails/version.rb
 - react_on_rails.gemspec
@@ -125,3 +126,4 @@ signing_key:
 specification_version: 4
 summary: Rails with react server rendering with webpack.
 test_files: []
+has_rdoc: