dynamic_router 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: abc0a2d19bc3fb9974bba3a517de829a29fa82d1
-  data.tar.gz: 5ec55c93c6ff0b7f08e1f52aec5e73e1c33d0820
+  metadata.gz: 59b9c8ce0c8e7f5607f7f6f66dce1a35f31292f2
+  data.tar.gz: 7b9a38b8bea748f00c1029e6e33f8264855b6fd4
 SHA512:
-  metadata.gz: 78b07a36b939ca786e39b6ad039ac0b92508bdb551c7f2e5580639b7e74edc400aa90e07ecb63621ff434e6ea9b959a06352d83e31665fc2416f5b97a7fe37b4
-  data.tar.gz: 917822ef9a54f88c789402700b9e360e51578dd0166ab94e07fb58e87483e47d5a023a7fed2b483d5f7b7c83abb2febec4cf3dd991c37a4aaa35a7987e3c976a
+  metadata.gz: 076391a6883e1a5457bb6572cb24bbda2c5332e36ecd12e8a86672fab621ca72a006cefc98351502fe7ef3df17c424d66bdb4f82e3074d4f2ecc0cf5324dddec
+  data.tar.gz: 3458f3b113f4d67dfe49d1ebc7baffc9da0deb32a0064fe871431d7fb66446453f7fbaacbdf0da1f10d58cff56e2acfc8adbfb1228b77f86fcdfb6c9862ea0cd

data/.gitignore

@@ -52,4 +52,7 @@ build/
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
-.project
+.project
+
+## Dummy Project
+/spec/dummy/

data/README.md

@@ -1,8 +1,8 @@
 # DynamicRouter
 
-[![Build Status](https://travis-ci.org/gberdugo/dynamic_router.png?branch=master)](https://travis-ci.org/gberdugo/dynamic_router) [![Gem Version](https://badge.fury.io/rb/dynamic_router.png)](http://badge.fury.io/rb/dynamic_router) [![Coverage Status](https://coveralls.io/repos/coyosoftware/dynamic_router/badge.png)](https://coveralls.io/r/coyosoftware/dynamic_router)
+[![Build Status](https://travis-ci.org/coyosoftware/dynamic_router.svg?branch=master)](https://travis-ci.org/coyosoftware/dynamic_router) [![Gem Version](https://badge.fury.io/rb/dynamic_router.png)](http://badge.fury.io/rb/dynamic_router) [![Coverage Status](https://coveralls.io/repos/coyosoftware/dynamic_router/badge.png)](https://coveralls.io/r/coyosoftware/dynamic_router)
 
-Add dynamic routes to your project
+Add dynamic routes based on model attributes
 
 ## Installation
 
@@ -20,11 +20,48 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Suppose you want to create a friendly URL for a resource based on fields of an example model:
+
+	class Example < ActiveRecord::Base
+		# This model has a field called 'url'
+	end
+	
+You can create a route to a resource using this field as URL, just use the notation:
+
+	class Example < ActiveRecord::Base
+		# This model has a field called 'url'
+		
+		has_dynamic_route Proc.new {|example| "/#{example.url}"}, "dummy#dummy_method"
+	end
+	
+With this notation, when you create models like:
+
+	Example.create!(:url => "abc")
+	Example.create!(:url => "123")
+	
+The dynamic router will create the routes "/abc" and "/123" mapping to DummyController#dummy_method
+
+You can pass the desired HTTP method also:
+	
+	class Example < ActiveRecord::Base
+		# This model has a field called 'url'
+		
+		has_dynamic_route Proc.new {|example| "/#{example.url}"}, "dummy#dummy_method", :method => :post
+	end
+	
+And can specify default values to be passed, like:
+
+	class Example < ActiveRecord::Base
+		# This model has two fields called 'url' and 'default_field'
+		
+		has_dynamic_route Proc.new {|example| "/#{example.url}"}, "dummy#dummy_method", :defaults => {:some_value => Proc.new {|example| example.default_field}}
+	end
+	
+The dynamic router will map ALL records of the model on the startup and will create an after_save hook to create new routes as the models are created. 
 
 ## Contributing
 
-1. Fork it ( https://github.com/gberdugo/dynamic_router/fork )
+1. Fork it ( https://github.com/coyosoftware/dynamic_router/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/dynamic_router.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["gberdugo@gmail.com"]
   spec.summary       = %q{Add dynamic routes to your project}
   spec.description   = %q{Use this gem to add dynamic routes to your project.}
-  spec.homepage      = "http://rubygems.org/gems/dynamic_router"
+  spec.homepage      = "https://github.com/coyosoftware/dynamic_router"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/dynamic_router/class_methods.rb

@@ -9,7 +9,7 @@ module DynamicRouter
           klass.find_each do |model|
             defaults = DynamicRouter::ClassMethods.parse_defaults(options[:defaults], model)
             
-            self.send(method, url.call(model).to_s, :to => target.to_s, :defaults => defaults)
+            DynamicRouter::ClassMethods.draw_route(self, method, url.call(model).to_s, target.to_s, defaults)
           end
         end
       end
@@ -34,11 +34,16 @@ module DynamicRouter
         def create_route
           klass = self
           
-          Rails.application.routes.draw do
+          _routes = Rails.application.routes
+          _routes.disable_clear_and_finalize = true
+          
+          _routes.draw do
             defaults = DynamicRouter::ClassMethods.parse_defaults(klass._defaults, klass)
             
-            self.send(klass._method, klass._url.call(klass).to_s, :to => klass._target.to_s, :defaults => defaults)
+            DynamicRouter::ClassMethods.draw_route(self, klass._method, klass._url.call(klass).to_s, klass._target.to_s, defaults)
           end
+          
+          _routes.disable_clear_and_finalize = false
         end
       end
     end
@@ -55,5 +60,9 @@ module DynamicRouter
         
         defaults
       end
+      
+      def draw_route(route, method, url, target, defaults)
+        route.send(method, url, :to => target, :defaults => defaults) unless url.blank? || url.gsub(/\//, "").blank?
+      end
   end
 end

data/lib/dynamic_router/version.rb

@@ -1,3 +1,3 @@
 module DynamicRouter
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/spec/dynamic_router_spec.rb

@@ -6,7 +6,9 @@ RSpec.describe DynamicRouter do
       extend DynamicRouter
     end
     
+    Example.destroy_all
     Example.create!(:first_path => "path_a", :second_path => "path_a_a", :default_field => "default_value")
+    Example.create!(:first_path => "path_a", :second_path => "path_a_c", :default_field => "default_value")
   end
   
   it "should check the the existence of the table" do
@@ -22,6 +24,7 @@ RSpec.describe DynamicRouter do
     Example.send(:has_dynamic_route, Proc.new {|example| "/#{example.first_path}/#{example.second_path}"}, "dummy#dummy_method")
     
     expect(Rails.application.routes.recognize_path('/path_a/path_a_a', :method => :get))
+    expect(Rails.application.routes.recognize_path('/path_a/path_a_c', :method => :get))
   end
   
   it "should accept the method option" do
@@ -43,4 +46,19 @@ RSpec.describe DynamicRouter do
     
     expect(Rails.application.routes.recognize_path('/path_a/path_a_b', :method => :get))
   end
+  
+  it "should not create the route if the url is blank" do
+    Example.send(:has_dynamic_route, Proc.new {|example| ""}, "dummy#dummy_method")
+    
+    expect(Rails.application.routes.routes.named_routes).to be_empty
+  end
+  
+  it "should not create the route if the url eval to blank" do
+    Example.send(:has_dynamic_route, Proc.new {|example| "/#{example.first_path}/#{example.second_path}"}, "dummy#dummy_method")
+    
+    Example.create!(:first_path => "")
+    
+    expect(Rails.application.routes.routes.named_routes.size).to eq(2)
+    expect(Rails.application.routes.routes.size).to eq(2)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dynamic_router
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Gustavo Berdugo
@@ -150,7 +150,6 @@ files:
 - spec/dummy/config/locales/pt_BR.yml
 - spec/dummy/config/routes.rb
 - spec/dummy/db/test.sqlite3
-- spec/dummy/log/test.log
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
@@ -159,7 +158,7 @@ files:
 - spec/dummy/script/rails
 - spec/dynamic_router_spec.rb
 - spec/spec_helper.rb
-homepage: http://rubygems.org/gems/dynamic_router
+homepage: https://github.com/coyosoftware/dynamic_router
 licenses:
 - MIT
 metadata: {}
@@ -207,7 +206,6 @@ test_files:
 - spec/dummy/config/locales/pt_BR.yml
 - spec/dummy/config/routes.rb
 - spec/dummy/db/test.sqlite3
-- spec/dummy/log/test.log
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html