sinatra-trails 0.0.6 → 0.0.7

data/{README.rdoc → README.md}

@@ -1,20 +1,16 @@
-sinatra-trails
---------------
+# sinatra-trails
 
-Is a very thin Rails inspired route naming DSL for using with Sinatra apps.
+Is a very thin Rails inspired route naming DSL for using with Sinatra apps. 
 It doesn't monkeypatch or overrides any Sinatra::Base methods 
 It provides helpers for generating routes for resources and single resource, namespaces and named routes.
 
-Instalation
-----------
+# Instalation
 
     $ [sudo] gem install sinatra-trails
 
-Usage
-----
+# Usage
 
-Basic
-=====
+## Basic
 
 Named routes are generated with map, not passing :to option sets the path to be the same as the name:
 
@@ -23,9 +19,9 @@ Named routes are generated with map, not passing :to option sets the path to be
     class MyApp < Sinatra::Base
       register Sinatra::Trails
 
-      map :dashboard                 # => '/dashboard'
-      map :home, :to => '/'          # => '/'
-      map :post, :to => '/posts/:id' # => '/posts/:id'
+      map :dashboard
+      map :home, :to => '/'
+      map :post, :to => '/posts/:id'
     end
 
     MyApp.print_routes
@@ -65,10 +61,9 @@ All defined routes will be available in the views and action blocks:
     end 
 
 
-Namespaces
-==========
+## Namespaces
 
-Pasing a symbol namespaces both the path and the route name:
+Passing a symbol namespaces both the path and the route name:
 
     namespace :admin do
       map(:dashboard)
@@ -93,8 +88,7 @@ Passing nil to namespace only sets a context:
     route_for(:dashboard) # => '/dashboard'
 
 
-Resources
-=========
+## Resources
   
 Restful routes for plural resources can be generated as follows, inside the resource
 definition block a route can be accessed by its name as a method call or using the path_for method:
@@ -134,10 +128,21 @@ definition block a route can be accessed by its name as a method call or using t
       delete user do
         ...
       end
+      
+      # generates new route with name :aprove_user
+      # GET /users/:id/aprove
+      get member(:aprove) do
+        ...
+      end
+
+      # generates new route with name :aproved_users
+      # GET /users/aproved
+      get collection(:aproved) do
+        ...
+      end
     end
 
-It is important to note that the order in wich the sinatra action blocks are defined is important.
-in this case `get(new_user)` must be defined before `get(user)`
+Route definition order for sinatra has precedence, in this case `get(new_user)` must be defined before `get(user)`
 
 As with previous examples routes can be defined beforehand:
 
@@ -148,10 +153,9 @@ As with previous examples routes can be defined beforehand:
     end
 
 
-Nested Resources
-================
+## Nested Resources
 
-Resources can be nested in a similar way as with Rails nested resources:
+Resources can be nested in a similar way as with Rails:
   
     resources :users do
       ...
@@ -195,25 +199,6 @@ And for actions that don't need to load the parent resource the route generation
     #          comment => /comments/:id
     #     edit_comment => /comments/:id/edit 
 
-There's an alternative way of generating routes for nested resources:
-
-    resources :users => {:posts => :comments}, :shallow => true do
-      ...
-    end
-    print_routes
-    #             users => /users
-    #          new_user => /users/new
-    #              user => /users/:id
-    #         edit_user => /users/:id/edit
-    #        user_posts => /users/:user_id/posts
-    #     new_user_post => /users/:user_id/posts/new
-    #              post => /posts/:id
-    #         edit_post => /posts/:id/edit
-    #     post_comments => /posts/:post_id/comments
-    #  new_post_comment => /posts/:post_id/comments/new
-    #           comment => /comments/:id
-    #      edit_comment => /comments/:id/edit  
-
 Some keys to the params hash are added when routes are defined using sinatra-trails:
     
     params[:resource]  # the name of the resource in REST actions
@@ -221,8 +206,7 @@ Some keys to the params hash are added when routes are defined using sinatra-tra
     params[:namespace] # the name of the current namespace
 
 
-Singleton Resource
-=================
+## Singleton Resource
 
 Same principles apply for singleton resource:
     
@@ -233,8 +217,7 @@ Same principles apply for singleton resource:
     #  edit_user => /user/edit
 
 
-Before and After Filters
-========================
+## Before and After Filters
 
 Defining a filter within a context (namespace, resources, resource) without passing any path will execute that filter for
 all actions defined in that context:
@@ -273,9 +256,7 @@ A symbol can be passed to the filter definition and it will be lazily evaluated
       end
     end
 
-
-Accessing Routes from Outside the App
-=====================================
+## Accessing Routes from Outside the App
 
 On registering Sinatra::Trails a dynamic module for the Sinatra app is created and it is assigned to the constant `Routes`
 including that module in another class gives that class access to the app's paths, a single class can access paths for

data/lib/sinatra/trails.rb

@@ -115,12 +115,12 @@ module Sinatra
         @routes += Scope.new(@sinatra_app, path, [*ancestors, self]).generate_routes!(&block)
       end
 
-      def resource *names, &block
-        restful_routes Resource, names, &block
+      def resource name, opts = {}, &block
+        restful_routes Resource, name, opts, &block
       end
 
-      def resources *names, &block
-        restful_routes Resources, names, &block
+      def resources name, opts = {}, &block
+        restful_routes Resources, name, opts, &block
       end
 
       def before *args, &block
@@ -151,50 +151,16 @@ module Sinatra
 
       private
       def method_missing name, *args, &block
-        return @sinatra_app.send(name, *args, &block) if @sinatra_app.respond_to?(name)
-        if route = route_for(name)
-          return route unless block_given?
-          @routes = @routes | route.scope.generate_routes!(&block)
+        if @sinatra_app.respond_to? name
+          @sinatra_app.send name, *args, &block 
         else
-          super
+          route_for(name) or super
         end
       end
 
-      def restful_routes builder, names, &block
-        opts = {}
-        hash = Hash === names.last ? names.pop : {}
-        hash.delete_if { |key, val| opts[key] = val if !(Symbol === val || Enumerable === val) }
-
-        nested = []
-        mash = Proc.new do |hash, acc|
-          hash.map do |key, val| 
-            case val
-            when Hash
-              [*acc, key, *mash.call(val, key).flatten]
-            when Array
-              nested += val.map{ |r| [*acc, key, r] } and next
-            else
-              [key, val]
-            end
-          end 
-        end
-
-        hash = (mash.call(hash) + nested).compact.map do |array|
-          array.reverse.inject(Proc.new{}) do |proc, name|
-            Proc.new{ send(builder == Resource ? :resource : :resources, name, opts, &proc) }
-          end.call
-        end
-
-        make = lambda do |name|
-          builder.new(@sinatra_app, name, [*ancestors, self], (@opts || {}).merge(opts))
-        end
-
-        if names.size == 1 && hash.empty?
-          @routes += make.call(names.first).generate_routes!(&block)
-        else
-          names.each { |name| @routes += make.call(name).generate_routes! }
-          instance_eval &block if block_given?
-        end
+      def restful_routes builder, name, opts, &block
+        scope = builder.new(@sinatra_app, name, [*ancestors, self], (@opts || {}).merge(opts))
+        @routes += scope.generate_routes!(&block)
       end
     end
 

data/lib/sinatra/trails/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module Trails
-    VERSION = "0.0.6"
+    VERSION = "0.0.7"
   end
 end

data/spec/route_generation_spec.rb

@@ -154,8 +154,8 @@ describe 'trails' do
 
     describe 'basic' do
       before :all do
-        app.resources :users, 'posts' do
-        end
+        app.resources :users
+        app.resources :posts
       end
       it_should_behave_like 'generates routes for users'
       it_should_behave_like 'generates routes for posts'
@@ -248,74 +248,14 @@ describe 'trails' do
       it_should_behave_like 'generates routes for users'
       it_should_behave_like 'generates routes for shallow user posts'
     end
-
-    describe 'hash nested' do
-      before :all do
-        app.resources :users => :posts
-      end
-      it_should_behave_like 'generates routes for users'
-      it_should_behave_like 'generates routes for nested user posts'
-    end
-
-    describe 'hash nested with block' do
-      before :all do
-        app.resources :users => :posts do
-          map :flag
-        end
-      end
-      it_should_behave_like 'generates routes for users'
-      it_should_behave_like 'generates routes for nested user posts'
-      it { app.route_for(:flag).should == '/flag' }
-    end
-
-    describe 'nested shallow with hash' do
-      before :all do
-        app.resources :users => :posts, :shallow => true
-      end
-      it_should_behave_like 'generates routes for users'
-      it_should_behave_like 'generates routes for shallow user posts'
-    end
-
-    describe 'deep nested with hash' do
-      before :all do
-        app.resources :users => {:posts => :comments}
-      end
-      it_should_behave_like 'generates routes for users'
-      it_should_behave_like 'generates routes for nested user posts'
-      describe 'exageration' do
-        it { app.route_for(:user_post_comments).should     == '/users/:user_id/posts/:post_id/comments' }
-        it { app.route_for(:new_user_post_comment).should  == '/users/:user_id/posts/:post_id/comments/new' }
-        it { app.route_for(:user_post_comment).should      == '/users/:user_id/posts/:post_id/comments/:id' }
-        it { app.route_for(:edit_user_post_comment).should == '/users/:user_id/posts/:post_id/comments/:id/edit' }
-      end
-    end
-    
-    describe 'deep nested shallow with hash' do
-      before :all do
-        app.resources :users => {:posts => :comments}, :shallow => true
-      end
-      it_should_behave_like 'generates routes for users'
-      it_should_behave_like 'generates routes for shallow user posts'
-      it { app.route_for(:post_comments).should     == '/posts/:post_id/comments' }
-      it { app.route_for(:new_post_comment).should  == '/posts/:post_id/comments/new' }
-      it { app.route_for(:comment).should           == '/comments/:id' }
-      it { app.route_for(:edit_comment).should      == '/comments/:id/edit' }
-    end
-
-    describe 'nested with array' do
-      before :all do
-        app.resources :users => [:posts, :comments]
-      end
-      it { app.route_for(:users).should           == '/users' }
-      it { app.route_for(:user_comments).should   == '/users/:user_id/comments' }
-      it { app.route_for(:user_posts).should      == '/users/:user_id/posts' }
-    end
   end
 
   describe 'single resource' do
     describe 'basic' do
       before :all do
-        app.resource :user => :profile
+        app.resource :user do
+          resource :profile
+        end
       end
       it { app.route_for(:user).should               == '/user' }
       it { app.route_for(:new_user).should           == '/user/new' }
@@ -389,30 +329,6 @@ describe 'trails' do
       end
     end
 
-    describe 'using route as scope' do
-      before :all do
-        app.resources(:users => :posts, :shallow => true) do
-          users do
-            get(member(:aprove)) { path_for(:aprove_user, params[:id]) }
-          end
-
-          user_posts do
-            get(member(:aprove)) { path_for(:aprove_post, params[:id]) }
-          end
-        end
-      end
-
-      it 'should define action for users member' do
-        get '/users/1/aprove'
-        last_response.body.should == '/users/1/aprove'
-      end
-
-      it 'should define action for user_posts member' do
-        get '/posts/1/aprove'
-        last_response.body.should == '/posts/1/aprove'
-      end
-    end
-
     describe 'before without args' do
       before :all do
         app.instance_eval do
@@ -533,9 +449,11 @@ describe 'trails' do
 
     describe 'having access to resource name' do
       before :all do
-        app.resources(:users => :posts) do
+        app.resources :users do
           get(users){ params[:resource].to_s }
-          get(user_posts){ params[:resource].to_s }
+          resources :posts do
+            get(user_posts){ params[:resource].to_s }
+          end
         end
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-trails
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-29 00:00:00.000000000 -06:00
+date: 2011-11-30 00:00:00.000000000 -06:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70095708882740 !ruby/object:Gem::Requirement
+  requirement: &70214353481380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70095708882740
+  version_requirements: *70214353481380
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70095708881640 !ruby/object:Gem::Requirement
+  requirement: &70214353480840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70095708881640
+  version_requirements: *70214353480840
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70095708880780 !ruby/object:Gem::Requirement
+  requirement: &70214353479960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70095708880780
+  version_requirements: *70214353479960
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70095708880260 !ruby/object:Gem::Requirement
+  requirement: &70214353479280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70095708880260
+  version_requirements: *70214353479280
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70095708879500 !ruby/object:Gem::Requirement
+  requirement: &70214353474980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70095708879500
+  version_requirements: *70214353474980
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70095708878680 !ruby/object:Gem::Requirement
+  requirement: &70214353471960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,7 +77,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70095708878680
+  version_requirements: *70214353471960
 description: A named routes Sinatra DSL inspired by Rails routing
 email:
 - macarui@gmail.com
@@ -88,7 +88,7 @@ files:
 - .gitignore
 - .rspec
 - Gemfile
-- README.rdoc
+- README.md
 - Rakefile
 - lib/sinatra/trails.rb
 - lib/sinatra/trails/version.rb