routing_data 0.1.0 → 0.2.0

data/README.md

@@ -43,7 +43,7 @@ RoutingData.actions_for(:users)
 # => [:index, :create, :new, :edit, :show, :update, :destroy, :show]
 ```
 
-You can also generate json-data about routes and use it in your Javascript (in progress):
+You can also generate json-data about routes and use it in your Javascript:
 
 ```ruby
 RoutingData.routes_data
@@ -53,6 +53,37 @@ RoutingData.routes_json_data
 # => "[{\"name\":\"root\",\"path\":\"/\",\"controller\":\"home\",\"action\":\"index\",\"parts\":[]},{\"name\":\"blogs\",\"path\":\"/blogs(.:format)\",\"controller\":\"blogs\",\"action\":\"index\",\"parts\":[\"format\"]},{\"name\":\"new_blog\",\"path\":\"/blogs/new(.:format)\",\"controller\":\"blogs\",\"action\":\"new\",\"parts\":[\"format\"]},{\"name\":\"edit_blog\",\"path\":\"/blogs/:id/edit(.:format)\",\"controller\":\"blogs\",\"action\":\"edit\",\"parts\":[\"id\",\"format\"]},{\"name\":\"blog\",\"path\":\"/blogs/:id(.:format)\",\"controller\":\"blogs\",\"action\":\"show\",\"parts\":[\"id\",\"format\"]},{\"name\":\"categories\",\"path\":\"/categories(.:format)\",\"controller\":\"categories\",\"action\":\"index\",\"parts\":[\"format\"]},{\"name\":\"new_category\",\"path\":\"/categories/new(.:format)\",\"controller\":\"categories\",\"action\":\"new\",\"parts\":[\"format\"]},{\"name\":\"edit_category\",\"path\":\"/categories/:id/edit(.:format)\",\"controller\":\"categories\",\"action\":\"edit\",\"parts\":[\"id\",\"format\"]},{\"name\":\"category\",\"path\":\"/categories/:id(.:format)\",\"controller\":\"categories\",\"action\":\"show\",\"parts\":[\"id\",\"format\"]},{\"name\":\"posts\",\"path\":\"/posts(.:format)\",\"controller\":\"posts\",\"action\":\"index\",\"parts\":[\"format\"]},{\"name\":\"new_post\",\"path\":\"/posts/new(.:format)\",\"controller\":\"posts\",\"action\":\"new\",\"parts\":[\"format\"]},{\"name\":\"edit_post\",\"path\":\"/posts/:id/edit(.:format)\",\"controller\":\"posts\",\"action\":\"edit\",\"parts\":[\"id\",\"format\"]},{\"name\":\"post\",\"path\":\"/posts/:id(.:format)\",\"controller\":\"posts\",\"action\":\"show\",\"parts\":[\"id\",\"format\"]},{\"name\":\"users\",\"path\":\"/users(.:format)\",\"controller\":\"users\",\"action\":\"index\",\"parts\":[\"format\"]},{\"name\":\"new_user\",\"path\":\"/users/new(.:format)\",\"controller\":\"users\",\"action\":\"new\",\"parts\":[\"format\"]},{\"name\":\"edit_user\",\"path\":\"/users/:id/edit(.:format)\",\"controller\":\"users\",\"action\":\"edit\",\"parts\":[\"id\",\"format\"]},{\"name\":\"user\",\"path\":\"/users/:id(.:format)\",\"controller\":\"users\",\"action\":\"show\",\"parts\":[\"id\",\"format\"]},{\"name\":\"show_user\",\"path\":\"/user/ololo/:user_id(.:format)\",\"controller\":\"users\",\"action\":\"show\",\"parts\":[\"user_id\",\"format\"]}]"
 ```
 
+In your Javascript you can use RoutingData object and url helpers through it. Just add
+
+``` //= require routing_data
+
+to app/assets/javascripts/application.js and
+
+```ruby
+  <%= include_routing_data %>
+```
+
+in your views before requiring javascripts.
+
+After this you can work with RoutingData object:
+
+```javascript
+RoutingData // { routes:{...}, helpers: {...} }
+```
+
+**RoutingData.routes** is made from data from RoutingData.routes_json_data method in Ruby.
+
+**RoutingData.helpers** contains url helpers with names like in you Ruby on Rails app. For example:
+
+```javascript
+RoutingData.helpers.new_post_path(); // "/posts/new"
+
+RoutingData.helpers.post_path({id: 1}); // "/posts/1"
+
+RoutingData.helpers.post_path({id: 1, format: 'xml'}); // "/posts/1.xml"
+```
+
+
 ## Contributing
 
 1. Fork it

data/lib/routing_data/engine.rb

@@ -0,0 +1,7 @@
+module RoutingData
+  class Engine < ::Rails::Engine
+    initializer "routing_data.view_helpers" do
+      ActionView::Base.send :include, ViewHelpers
+    end
+  end
+end

data/lib/routing_data/lib/assets/javascripts/routing_data.js

@@ -0,0 +1,34 @@
+(function(){
+  RoutingData = typeof(RoutingData) == 'undefined' ? {} : RoutingData;
+  RoutingData.helpers = {};
+
+  for(var route in RoutingData.routes) {
+    var routeData = RoutingData.routes[route];
+    RoutingData.helpers[route + '_path'] = createURLHelper(routeData);
+  };
+
+  function createURLHelper(routeData) {
+    return function() {
+      var args = typeof(arguments[0]) === 'object' ? arguments[0] : {}
+      var path = routeData.path;
+
+      for(var i in routeData.parts) {
+        var part = routeData.parts[i];
+        var replacement = '';
+
+        if(path.indexOf('/:' + part) !== -1) {
+          path = path.replace('/:' + part, '/' + args[part]);
+        } else if(path.indexOf('(:' + part + ')') !== -1) {
+          replacement = typeof(args[part]) !== 'undefined' ? args[part] : replacement;
+          path = path.replace('(:' + part + ')', replacement);
+        } else if(path.indexOf('(.:' + part + ')') !== -1) {
+          replacement = typeof(args[part]) !== 'undefined' ? '.' + args[part] : replacement;
+          path = path.replace('(.:' + part + ')', replacement);
+        };
+      };
+
+      console.log(path);
+      return path;
+    };
+  };
+})();

data/lib/routing_data/version.rb

@@ -1,3 +1,3 @@
 module RoutingData
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/routing_data/view_helpers.rb

@@ -0,0 +1,13 @@
+module RoutingData
+  module ViewHelpers
+    def include_routing_data
+      raw(<<-JAVASCRIPT
+        <script>
+          RoutingData = {};
+          RoutingData.routes = #{RoutingData.routes_json_data};
+        </script>
+      JAVASCRIPT
+      )
+    end
+  end
+end

data/lib/routing_data.rb

@@ -1,4 +1,6 @@
-require "routing_data/version"
+require 'routing_data/version'
+require 'routing_data/engine'
+require 'routing_data/view_helpers'
 
 module RoutingData
   # Returns Routes objects
@@ -61,17 +63,21 @@ module RoutingData
   end
 
   def self.routes_data(opts = {})
-    @routes_data ||= all_routes.to_a.map do |route|
-      if route.name
-        {
-          name:       route.name,
-          path:       route.path.spec.to_s,
-          controller: route.defaults[:controller],
-          action:     route.defaults[:action],
-          parts:      route.parts
-        }
+    unless @routes_data
+      @routes_data = {}
+
+      all_routes.to_a.each do |route|
+        if route.name
+          @routes_data[route.name] = {
+            name:       route.name,
+            path:       route.path.spec.to_s,
+            controller: route.defaults[:controller],
+            action:     route.defaults[:action],
+            parts:      route.parts
+          }
+        end
       end
-    end.compact!
+    end
 
     if opts[:for_name]
       routes_data = @routes_data.select { |route| route[:name] == opts[:for_name] }

data/routing_data.gemspec

@@ -16,4 +16,6 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
+
+  gem.add_dependency "railties", "~> 3.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: routing_data
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2012-12-09 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
 description: Simple solution that provides information about routes in your rails
   app.
 email:
@@ -25,7 +41,10 @@ files:
 - README.md
 - Rakefile
 - lib/routing_data.rb
+- lib/routing_data/engine.rb
+- lib/routing_data/lib/assets/javascripts/routing_data.js
 - lib/routing_data/version.rb
+- lib/routing_data/view_helpers.rb
 - routing_data.gemspec
 homepage: ''
 licenses: []