react-router-rails 0.11.6 → 0.11.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d72ad34f48bc662329a91dfae33007998a9accfc
-  data.tar.gz: 9acca7f0f94fa759292a784c56aab7d9ce65ded8
+  metadata.gz: e07cf28306d1d239726cc55899f915debdfb561d
+  data.tar.gz: 51e18933b73b2b4d2713797dad291b4fcb56dc48
 SHA512:
-  metadata.gz: 3d5beb7f413194b17873d8ff435392f9c135320f844834c2037685752a088688903f070d330e2b289e2045c163a2308c56bfebeebe55dbb46d80e58029ff93f8
-  data.tar.gz: 2e457caa3607b621f351c1af0bb3e49c700e59c1ce338dc1075a34051ca87db53ddd785d95289ad6d74ab0814c1c81abcff79d53180a786f7ccf7331c873aa17
+  metadata.gz: ffb52fb0fe227097da416a3dfc4d0b8879e5eb260ddfb15177f20e7d6521b222810aca7b81f1dda8821f017146115135cc14d00c966180e4975b92c19938d35e
+  data.tar.gz: 644b2270f47b15caffbca27abbb76feec2809fef64c9cbb610904e18e0ece3af0c528a1a8daea3892e6e15848d9a0b92d9fd2e29212ad4884d5be2bfe3f2a84c

data/README.md

@@ -1,5 +1,7 @@
 # react-router-rails
 
+[![Gem Version](https://badge.fury.io/rb/react-router-rails.svg)](https://badge.fury.io/rb/react-router-rails.svg)
+
 [React Router](https://github.com/rackt/react-router/) for Rails asset pipeline
 
 - React Router version: [0.11.6](https://github.com/rackt/react-router/tree/v0.11.6)
@@ -30,9 +32,37 @@
   #= require react_router
   #OR
   #= require react_router.min
+
+  #Optional. Gives you the ability to use the view helper in your template
+  #= require react_router_ujs
+  ```
+3. Using the view helper:
+
+  Define your routes 'MyRoutes' in any javascript file like you would normally do:
+
+  ```coffeescript
+  Route = ReactRouter.Route
+
+  @AppRoutes = (
+    <Route handler={App}>
+      <Route name='home' handler={Home} path='/' />
+    </Route>
+  )
   ```
 
-3. Using React Router in your javascript:
+  In the view helper set the name of your routes component
+
+  ```erb
+  <%= react_router 'MyRoutes' %>
+  ```
+
+  Optionally set the location handler (defaults to HashLocation):
+
+  ```erb
+  <%= react_router 'MyRoutes', 'HistoryLocation' %>
+  ```
+
+4. Using React Router in your javascript :
 
   ```js
   ReactRouter.run(routes, function (Handler) {
@@ -50,6 +80,8 @@
 
 ## Acknowledgements
 
-[React Router](https://github.com/rackt/react-router/) by Ryan Florence, Michael Jackson licensed under the [MIT license](https://github.com/rackt/react-router/blob/master/LICENSE)
+This gem is highly inspired and based on [React Rails](https://github.com/reactjs/react-rails) code. Thanks!
+
+[React Router](https://github.com/rackt/react-router/) by [Ryan Florence](https://github.com/rpflorence), [Michael Jackson](https://github.com/mjackson) licensed under the [MIT license](https://github.com/rackt/react-router/blob/master/LICENSE)
 
 Copyright [Mario Peixoto](https://github.com/mariopeixoto), released under the [MIT license](https://github.com/mariopeixoto/react-router-rails/LICENSE).

data/lib/react/router/rails.rb

@@ -1,2 +1,4 @@
 require "react/router/rails/version"
-require "react/router/rails/engine"
+require 'react/router/rails/railtie'
+require "react/router/rails/engine"
+require 'react/router/rails/view_helper'

data/lib/react/router/rails/railtie.rb

@@ -0,0 +1,18 @@
+require 'rails'
+
+module React
+  module Router
+    module Rails
+      class Railtie < ::Rails::Railtie
+
+        # Include the react-router-rails view helper lazily
+        initializer "react_router_rails.setup_view_helpers" do |app|
+          ActiveSupport.on_load(:action_view) do
+            include ::React::Router::Rails::ViewHelper
+          end
+        end
+        
+      end
+    end
+  end
+end

data/lib/react/router/rails/version.rb

@@ -1,7 +1,7 @@
 module React
   module Router
     module Rails
-      VERSION = "0.11.6"
+      VERSION = "0.11.6.1"
     end
   end
 end

data/lib/react/router/rails/view_helper.rb

@@ -0,0 +1,17 @@
+module React
+  module Router
+    module Rails
+      module ViewHelper
+        def react_router(routes, location = 'HashLocation', &block)
+          html_options = {
+            :'data-react-router-class' => routes,
+            :'data-react-router-location' => location
+          }
+          
+          content_tag(:div, '', html_options, &block)
+        end
+
+      end
+    end
+  end
+end

data/vendor/assets/javascripts/react_router_ujs.js

@@ -0,0 +1,69 @@
+// Unobtrusive scripting adapter for React Router based on react-rails gem. 
+// https://github.com/reactjs/react-rails/blob/master/lib/assets/javascripts/react_ujs.js
+(function(document, window, React, ReactRouter) {
+  var ROUTER_CLASS_NAME = 'data-react-router-class';
+  var LOCATION_CLASS_NAME = 'data-react-router-location';
+
+  // jQuery is optional. Use it to support legacy browsers.
+  var $ = (typeof jQuery !== 'undefined') && jQuery;
+
+  var findReactRouterDOMNodes = function() {
+    var SELECTOR = '[' + ROUTER_CLASS_NAME + ']';
+    if ($) {
+      return $(SELECTOR);
+    } else {
+      return document.querySelectorAll(SELECTOR);
+    }
+  };
+
+  var mountReactRouter = function() {
+    var nodes = findReactRouterDOMNodes();
+    if (nodes.length >= 1) {
+      if (nodes.length > 1) {
+        console.warn('React Router is designed to have a single root router. ' + nodes.length + ' routers were found on the html. Using the first one.');        
+      }
+      var routerNode = nodes[0];
+      
+      // Assume className is simple and can be found at top-level (window).
+      // Fallback to eval to handle cases like 'My.React.ComponentName'.
+      var className = routerNode.getAttribute(ROUTER_CLASS_NAME);
+      var routes = window[className] || eval.call(window, className);
+
+      var locationName = routerNode.getAttribute(LOCATION_CLASS_NAME);
+      var location = ReactRouter[locationName] ;
+
+      ReactRouter.run(routes, location, function (Handler) {
+        React.render(React.createElement(Handler), routerNode);
+      });
+    }
+  };
+
+  var handleTurbolinksEvents = function() {
+    var handleEvent;
+    if ($) {
+      handleEvent = function(eventName, callback) {
+        $(document).on(eventName, callback);
+      }
+    } else {
+      handleEvent = function(eventName, callback) {
+        document.addEventListener(eventName, callback);
+      }
+    }
+    handleEvent('page:change', mountReactRouter);
+  };
+
+  var handleNativeEvents = function() {
+    if ($) {
+      $(mountReactRouter);
+    } else {
+      document.addEventListener('DOMContentLoaded', mountReactRouter);
+    }
+  };
+
+  if (typeof Turbolinks !== 'undefined' && Turbolinks.supported) {
+    handleTurbolinksEvents();
+  } else {
+    handleNativeEvents();
+  }
+
+})(document, window, React, ReactRouter);

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: react-router-rails
 version: !ruby/object:Gem::Version
-  version: 0.11.6
+  version: 0.11.6.1
 platform: ruby
 authors:
 - Mario Peixoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-22 00:00:00.000000000 Z
+date: 2015-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -63,9 +63,12 @@ files:
 - README.md
 - lib/react/router/rails.rb
 - lib/react/router/rails/engine.rb
+- lib/react/router/rails/railtie.rb
 - lib/react/router/rails/version.rb
+- lib/react/router/rails/view_helper.rb
 - vendor/assets/javascripts/react_router.js
 - vendor/assets/javascripts/react_router.min.js
+- vendor/assets/javascripts/react_router_ujs.js
 homepage: https://github.com/mariopeixoto/react-router-rails
 licenses:
 - MIT