lotus-router 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 221714d5d9c1a560423ad18e2153c17d88200680
-  data.tar.gz: 41706f3509decc6458e1852f53c5e404e30e4239
+  metadata.gz: b3fcb5db6c1bdb046aeb93c5d0950301d5ed551d
+  data.tar.gz: 577b5c170f3d469369ce4c43c11782f6f9d6ea3c
 SHA512:
-  metadata.gz: aaa5c9a07b4ca993792027a16b6ebaa62fe1c2b5ce48a85921ee4c3fa9efdc81884016c48efddb6280708c4fcd1b4a5d0653f4fad6493a3ba6e2b224850ebee7
-  data.tar.gz: 7e0f8ad5a549698236d8ee46d4b6d7d5af2029d9a1034db599a234b1098aa27809993bc77d8fe638a2353a59726c359d014c954b056da9a521a5b384c51a6fb1
+  metadata.gz: 189025ab49239109b74a6f939585d2cdc56b7568a9864c0a82af39fc166a36b8f4f4ae7e5335a53b5ca3bcadd2120b75705ca6dc8d12a1b9bf05501aaa45f652
+  data.tar.gz: 339c1ac13cb39971e7594675646b2c7f2a0baafa96a5bd7b44c16be0ce291d089857abbd797ab6fa6be44fa1b7a279c1d159562acd1d46c60ba97c43779d102f

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 # Lotus::Router
 Rack compatible HTTP router for Ruby
 
+## v0.4.0 - 2015-05-15
+### Added
+- [Alfonso Uceda Pompa] Nested RESTful resource(s)
+
+### Changed
+- [Alfonso Uceda Pompa] RESTful resource(s) have a correct pluralization/singularization for variables and named routes (eg. `/books/:id` is now `:book` instead of `:books`)
+
 ## v0.3.0 - 2015-03-23
 
 ## v0.2.1 - 2015-01-30

data/README.md

@@ -407,6 +407,27 @@ router.resource 'profile', controller: 'identity'
 router.path(:profile) # => /profile # Will route to Identity::Show
 ```
 
+#### Nested Resources
+
+We can nest resource(s):
+
+```ruby
+router = Lotus::Router.new
+router.resource :identity do
+  resource  :avatar
+  resources :api_keys
+end
+
+router.path(:identity_avatar)       # => /identity/avatar
+router.path(:new_identity_avatar)   # => /identity/avatar/new
+router.path(:edit_identity_avatar)  # => /identity/avatar/new
+
+router.path(:identity_api_keys)     # => /identity/api_keys
+router.path(:identity_api_key)      # => /identity/api_keys/:id
+router.path(:new_identity_api_key)  # => /identity/api_keys/new
+router.path(:edit_identity_api_key) # => /identity/api_keys/:id/edit
+```
+
 
 
 ### RESTful Resources:
@@ -438,14 +459,14 @@ It will map:
     <td>/flowers/:id</td>
     <td>Flowers::Show</td>
     <td>:show</td>
-    <td>:flowers</td>
+    <td>:flower</td>
   </tr>
   <tr>
     <td>GET</td>
     <td>/flowers/new</td>
     <td>Flowers::New</td>
     <td>:new</td>
-    <td>:new_flowers</td>
+    <td>:new_flower</td>
   </tr>
   <tr>
     <td>POST</td>
@@ -459,29 +480,29 @@ It will map:
     <td>/flowers/:id/edit</td>
     <td>Flowers::Edit</td>
     <td>:edit</td>
-    <td>:edit_flowers</td>
+    <td>:edit_flower</td>
   </tr>
   <tr>
     <td>PATCH</td>
     <td>/flowers/:id</td>
     <td>Flowers::Update</td>
     <td>:update</td>
-    <td>:flowers</td>
+    <td>:flower</td>
   </tr>
   <tr>
     <td>DELETE</td>
     <td>/flowers/:id</td>
     <td>Flowers::Destroy</td>
     <td>:destroy</td>
-    <td>:flowers</td>
+    <td>:flower</td>
   </tr>
 </table>
 
 
 ```ruby
-router.path(:flowers)              # => /flowers
-router.path(:flowers, id: 23)      # => /flowers/23
-router.path(:edit_flowers, id: 23) # => /flowers/23/edit
+router.path(:flowers)             # => /flowers
+router.path(:flower, id: 23)      # => /flowers/23
+router.path(:edit_flower, id: 23) # => /flowers/23/edit
 ```
 
 
@@ -512,8 +533,8 @@ router.resources 'flowers' do
   end
 end
 
-router.path(:toggle_flowers, id: 23)  # => /flowers/23/toggle
-router.path(:search_flowers)          # => /flowers/search
+router.path(:toggle_flower, id: 23)  # => /flowers/23/toggle
+router.path(:search_flowers)         # => /flowers/search
 ```
 
 
@@ -523,7 +544,28 @@ Configure controller:
 router = Lotus::Router.new
 router.resources 'blossoms', controller: 'flowers'
 
-router.path(:blossoms, id: 23) # => /blossoms/23 # Will route to Flowers::Show
+router.path(:blossom, id: 23) # => /blossoms/23 # Will route to Flowers::Show
+```
+
+#### Nested Resources
+
+We can nest resource(s):
+
+```ruby
+router = Lotus::Router.new
+router.resources :users do
+  resource  :avatar
+  resources :favorites
+end
+
+router.path(:user_avatar,      user_id: 1)  # => /users/1/avatar
+router.path(:new_user_avatar,  user_id: 1)  # => /users/1/avatar/new
+router.path(:edit_user_avatar, user_id: 1)  # => /users/1/avatar/edit
+
+router.path(:user_favorites, user_id: 1)             # => /users/1/favorites
+router.path(:user_favorite, user_id: 1, id: 2)       # => /users/1/favorites/2
+router.path(:new_user_favorites, user_id: 1)         # => /users/1/favorites/new
+router.path(:edit_user_favorites, user_id: 1, id: 2) # => /users/1/favorites/2/edit
 ```
 
 ## Testing

data/lib/lotus/router/version.rb

@@ -1,6 +1,6 @@
 module Lotus
   class Router
     # @since 0.1.0
-    VERSION = '0.3.0'.freeze
+    VERSION = '0.4.0'.freeze
   end
 end

data/lib/lotus/routing/resource.rb

@@ -15,6 +15,10 @@ module Lotus
     class Resource
       include Utils::ClassAttribute
 
+      # @api private
+      # @since 0.4.0
+      NESTED_ROUTES_SEPARATOR = '/'.freeze
+
       # Set of default routes
       #
       # @api private
@@ -43,30 +47,69 @@ module Lotus
       class_attribute :collection
       self.collection = Resource::CollectionAction
 
+      # @api private
+      # @since 0.4.0
+      attr_reader :parent
+
       # @api private
       # @since 0.1.0
-      def initialize(router, name, options = {}, &blk)
+      def initialize(router, name, options = {}, parent = nil, &blk)
         @router  = router
         @name    = name
+        @parent  = parent
         @options = Options.new(self.class.actions, options.merge(name: @name))
         generate(&blk)
       end
 
+      # Allow nested resources inside resource or resources
+      #
+      # @since 0.4.0
+      #
+      # @see Lotus::Router#resources
+      def resources(name, options = {}, &blk)
+        _resource(Resources, name, options, &blk)
+      end
+
+      # Allow nested resource inside resource or resources
+      #
+      # @since 0.4.0
+      #
+      # @see Lotus::Router#resource
+      def resource(name, options = {}, &blk)
+        _resource(Resource, name, options, &blk)
+      end
+
+      # Return separator
+      #
+      # @api private
+      # @since 0.4.0
+      def wildcard_param(route_param = nil)
+        NESTED_ROUTES_SEPARATOR
+      end
+
       private
+
+      # @api private
+      # @since 0.4.0
+      def _resource(klass, name, options, &blk)
+        options = options.merge(separator: @options[:separator], namespace: @options[:namespace])
+        klass.new(@router, [@name, name].join(NESTED_ROUTES_SEPARATOR), options, self, &blk)
+      end
+
       def generate(&blk)
         instance_eval(&blk) if block_given?
 
         @options.actions.each do |action|
-          self.class.action.generate(@router, action, @options)
+          self.class.action.generate(@router, action, @options, self)
         end
       end
 
       def member(&blk)
-        self.class.member.new(@router, @options, &blk)
+        self.class.member.new(@router, @options, self, &blk)
       end
 
       def collection(&blk)
-        self.class.collection.new(@router, @options, &blk)
+        self.class.collection.new(@router, @options, self, &blk)
       end
     end
   end

data/lib/lotus/routing/resource/action.rb

@@ -1,6 +1,7 @@
 require 'lotus/utils/string'
 require 'lotus/utils/path_prefix'
 require 'lotus/utils/class_attribute'
+require 'lotus/routing/resource/nested'
 
 module Lotus
   module Routing
@@ -15,6 +16,12 @@ module Lotus
       class Action
         include Utils::ClassAttribute
 
+        # Nested routes separator
+        #
+        # @api private
+        # @since 0.4.0
+        NESTED_ROUTES_SEPARATOR = '/'.freeze
+
         # Ruby namespace where lookup for default subclasses.
         #
         # @api private
@@ -41,25 +48,29 @@ module Lotus
         # @param router [Lotus::Router]
         # @param action [Lotus::Routing::Resource::Action]
         # @param options [Hash]
+        # @param resource [Lotus::Routing::Resource, Lotus::Routing::Resources]
         #
         # @api private
         #
         # @since 0.1.0
-        def self.generate(router, action, options)
-          class_for(action).new(router, options)
+        def self.generate(router, action, options = {}, resource = nil)
+          class_for(action).new(router, options, resource)
         end
 
         # Initialize an action
         #
         # @param router [Lotus::Router]
         # @param options [Hash]
+        # @param resource [Lotus::Routing::Resource, Lotus::Routing::Resources]
         # @param blk [Proc]
         #
         # @api private
         #
         # @since 0.1.0
-        def initialize(router, options, &blk)
-          @router, @options = router, options
+        def initialize(router, options = {}, resource = nil, &blk)
+          @router = router
+          @options = options
+          @resource = resource
           generate(&blk)
         end
 
@@ -77,6 +88,8 @@ module Lotus
 
         # Resource name
         #
+        # @return [String]
+        #
         # @api private
         # @since 0.1.0
         #
@@ -89,7 +102,7 @@ module Lotus
         #
         #   # 'identity' is the name passed in the @options
         def resource_name
-          @options[:name]
+          @resource_name ||= @options[:name].to_s
         end
 
         # Namespace
@@ -157,7 +170,7 @@ module Lotus
         # @api private
         # @since 0.1.0
         def rest_path
-          namespace.join(resource_name)
+          namespace.join(_nested_rest_path || resource_name.to_s)
         end
 
         # The namespaced name of the action within the whole context of the router.
@@ -179,7 +192,7 @@ module Lotus
         # @api private
         # @since 0.1.0
         def as
-          namespace.relative_join(resource_name, self.class.named_route_separator).to_sym
+          namespace.relative_join(_singularized_as, self.class.named_route_separator).to_sym
         end
 
         # The name of the RESTful action.
@@ -233,10 +246,30 @@ module Lotus
         #   # Same for other action names
         #
         # @api private
-        # @since x.x.x
+        # @since 0.4.0
         def controller_name
           @options[:controller] || resource_name
         end
+
+        private
+
+        # Singularize as (helper route)
+        #
+        # @api private
+        # @since 0.4.0
+        def _singularized_as
+          resource_name.split(NESTED_ROUTES_SEPARATOR).map do |name|
+            Lotus::Utils::String.new(name).singularize
+          end
+        end
+
+        # Create nested rest path
+        #
+        # @api private
+        # @since 0.4.0
+        def _nested_rest_path
+          Nested.new(resource_name, @resource).to_path
+        end
       end
 
       # Collection action

data/lib/lotus/routing/resource/nested.rb

@@ -0,0 +1,39 @@
+module Lotus
+  module Routing
+    class Resource
+      # Helper class to calculate nested path
+      #
+      # @api private
+      # @since 0.4.0
+      class Nested
+        # @api private
+        # @since 0.4.0
+        SEPARATOR = '/'.freeze
+
+        # @api private
+        # @since 0.4.0
+        def initialize(resource_name, resource)
+          @resource_name = resource_name.to_s.split(SEPARATOR)
+          @resource      = resource
+          @path          = []
+          _calculate(@resource_name.dup, @resource)
+        end
+
+        # @api private
+        # @since 0.4.0
+        def to_path
+          @path.reverse!.pop
+          @resource_name.zip(@path).flatten.join
+        end
+
+        private
+
+        def _calculate(param_wildcard, resource = nil)
+          return if resource.nil?
+          @path << resource.wildcard_param(param_wildcard.pop)
+          _calculate(param_wildcard, resource.parent)
+        end
+      end
+    end
+  end
+end

data/lib/lotus/routing/resources.rb

@@ -35,6 +35,14 @@ module Lotus
       # @api private
       # @since 0.1.0
       self.collection = Resources::CollectionAction
+
+      # Return wildcard param between separators
+      #
+      # @api private
+      # @since 0.4.0
+      def wildcard_param(route_param = nil)
+        "/:#{ Lotus::Utils::String.new(route_param).singularize }_id/"
+      end
     end
   end
 end

data/lib/lotus/routing/resources/action.rb

@@ -27,6 +27,21 @@ module Lotus
         self.identifier = ':id'.freeze
       end
 
+      # Pluralize concrete actions
+      #
+      # @api private
+      # @since 0.4.0
+      module PluralizedAction
+        private
+        # The name of the RESTful action.
+        #
+        # @api private
+        # @since 0.4.0
+        def as
+          Lotus::Utils::String.new(super).pluralize
+        end
+      end
+
       # Collection action
       # It implements #collection within a #resources block.
       #
@@ -34,6 +49,9 @@ module Lotus
       # @since 0.1.0
       # @see Lotus::Router#resources
       class CollectionAction < Resource::CollectionAction
+        def as(action_name)
+          Lotus::Utils::String.new(super(action_name)).pluralize
+        end
       end
 
       # Member action
@@ -66,6 +84,7 @@ module Lotus
       # @since 0.1.0
       # @see Lotus::Router#resources
       class Index < Action
+        include PluralizedAction
         self.verb = :get
       end
 
@@ -83,6 +102,7 @@ module Lotus
       # @since 0.1.0
       # @see Lotus::Router#resources
       class Create < Resource::Create
+        include PluralizedAction
       end
 
       # Show action

data/lotus-router.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.0.0'
 
   spec.add_dependency 'http_router', '~> 0.11'
-  spec.add_dependency 'lotus-utils', '~> 0.4'
+  spec.add_dependency 'lotus-utils', '~> 0.4', '>= 0.4.1'
 
   spec.add_development_dependency 'bundler',  '~> 1.5'
   spec.add_development_dependency 'minitest', '~> 5'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lotus-router
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-23 00:00:00.000000000 Z
+date: 2015-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http_router
@@ -31,6 +31,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,6 +41,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -102,6 +108,7 @@ files:
 - lib/lotus/routing/parsing/parser.rb
 - lib/lotus/routing/resource.rb
 - lib/lotus/routing/resource/action.rb
+- lib/lotus/routing/resource/nested.rb
 - lib/lotus/routing/resource/options.rb
 - lib/lotus/routing/resources.rb
 - lib/lotus/routing/resources/action.rb