routing_data 0.0.1 → 0.1.0

data/.gitignore

@@ -14,4 +14,6 @@ rdoc
 spec/reports
 test/tmp
 test/version_tmp
+dummy/log
 tmp
+*~

data/README.md

@@ -1,6 +1,6 @@
 # RoutingData
 
-TODO: Write a gem description
+Simple solution that provides information about routes in your rails app.
 
 ## Installation
 
@@ -17,8 +17,41 @@ Or install it yourself as:
     $ gem install routing_data
 
 ## Usage
+With RoutingData you have access to url helpers in your models:
 
-TODO: Write usage instructions here
+```ruby
+RoutingData.url_helpers.new_user_path
+# => "/users/new"
+
+RoutingData.url_helpers.user_path(User.first)
+# => "/users/1"
+
+RoutingData.url_helpers.post_path(Post.last)
+# => "/posts/2"
+```
+
+You can access to lists of controllers and actions in your application (this is helpful for authorization purposes):
+
+```ruby
+RoutingData.controllers_actions_map
+# => {:home=>[:index], :blogs=>[:index, :create, :new, :edit, :show, :update, :destroy], :categories=>[:index, :create, :new, :edit, :show, :update, :destroy], :posts=>[:index, :create, :new, :edit, :show, :update, :destroy], :users=>[:index, :create, :new, :edit, :show, :update, :destroy, :show]}
+
+RoutingData.controllers
+# => [:home, :blogs, :categories, :posts, :users]
+
+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):
+
+```ruby
+RoutingData.routes_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]}]
+
+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\"]}]"
+```
 
 ## Contributing
 

data/lib/routing_data/version.rb

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

data/lib/routing_data.rb

@@ -11,6 +11,16 @@ module RoutingData
     @all_routes
   end
 
+  # Returns url helpers with pathes
+  def self.url_helpers
+    unless @url_helpers
+      Rails.application.reload_routes!
+      url_helpers_module = Rails.application.routes.url_helpers
+    end
+
+    @url_helpers ||= url_helpers_module
+  end
+
   # Returns controllers -> actions map
   # Example:
   # RoutingData.controlles_actions_map
@@ -40,9 +50,9 @@ module RoutingData
 
   # Returns array of actions for specific controller
   # Example:
-  # RoutingData.actions_of(:pages)
+  # RoutingData.actions_for(:pages)
   # #=> [:index, :show, :new, :edit, :create, :update, :destroy]
-  def self.actions_of(controller)
+  def self.actions_for(controller)
     controllers_actions_map[controller] || []
   end
 
@@ -50,4 +60,36 @@ module RoutingData
     @controllers ||= controllers_actions_map.keys
   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
+        }
+      end
+    end.compact!
+
+    if opts[:for_name]
+      routes_data = @routes_data.select { |route| route[:name] == opts[:for_name] }
+    elsif opts[:for_name_in]
+      routes_data = @routes_data.select { |route| route[:for_name_in].include? route[:name] }
+    elsif opts[:for_controller]
+      routes_data = @routes_data.select { |route| route[:controller] == opts[:for_controller] }
+    elsif opts[:for_controllers]
+      routes_data = @routes_data.select { |route| opts[:for_controllers].include? route[:controller] }
+    else
+      routes_data = @routes_data
+    end
+
+    routes_data
+  end
+
+  def self.routes_json_data(opts = {})
+    @routes_json_data ||= routes_data(opts).to_json
+  end
+
 end

data/routing_data.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version       = RoutingData::VERSION
   gem.authors       = ["Vladimir Melnick"]
   gem.email         = ["egotraumatic@gmail.com"]
-  gem.description   = %q{Simple solution that provides information about routing in your rails app.}
-  gem.summary       = %q{Simple solution that provides information about routing in your rails app.}
+  gem.description   = %q{Simple solution that provides information about routes in your rails app.}
+  gem.summary       = %q{Simple solution that provides information about routes in your rails app.}
   gem.homepage      = ""
 
   gem.files         = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: routing_data
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,9 +9,9 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-20 00:00:00.000000000 Z
+date: 2012-12-09 00:00:00.000000000 Z
 dependencies: []
-description: Simple solution that provides information about routing in your rails
+description: Simple solution that provides information about routes in your rails
   app.
 email:
 - egotraumatic@gmail.com
@@ -50,6 +50,6 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Simple solution that provides information about routing in your rails app.
+summary: Simple solution that provides information about routes in your rails app.
 test_files: []
 has_rdoc: