lotus-router 0.1.1 → 0.2.0

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

@@ -29,6 +29,13 @@ module Lotus
         class_attribute :verb
         self.verb = :get
 
+        # Separator for named routes
+        #
+        # @api private
+        # @since 0.2.0
+        class_attribute :named_route_separator
+        self.named_route_separator = '_'.freeze
+
         # Generate an action for the given router
         #
         # @param router [Lotus::Router]
@@ -85,12 +92,12 @@ module Lotus
           @options[:name]
         end
 
-        # Path prefix
+        # Namespace
         #
         # @api private
-        # @since 0.1.0
-        def prefix
-          @prefix ||= Utils::PathPrefix.new @options[:prefix]
+        # @since 0.2.0
+        def namespace
+          @namespace ||= Utils::PathPrefix.new @options[:namespace]
         end
 
         private
@@ -118,7 +125,7 @@ module Lotus
           self.class.verb
         end
 
-        # The prefixed URL relative path
+        # The namespaced URL relative path
         #
         # @example
         #   require 'lotus/router'
@@ -126,7 +133,7 @@ module Lotus
         #   Lotus::Router.new do
         #     resources 'flowers'
         #
-        #     prefix 'animals' do
+        #     namespace 'animals' do
         #       resources 'mammals'
         #     end
         #   end
@@ -137,7 +144,7 @@ module Lotus
         # @api private
         # @since 0.1.0
         def path
-          prefix.join(rest_path)
+          rest_path
         end
 
         # The URL relative path
@@ -150,10 +157,10 @@ module Lotus
         # @api private
         # @since 0.1.0
         def rest_path
-          "/#{ resource_name }"
+          namespace.join(resource_name)
         end
 
-        # The prefixed name of the action within the whole context of the router.
+        # The namespaced name of the action within the whole context of the router.
         #
         # @example
         #   require 'lotus/router'
@@ -161,7 +168,7 @@ module Lotus
         #   Lotus::Router.new do
         #     resources 'flowers'
         #
-        #     prefix 'animals' do
+        #     namespace 'animals' do
         #       resources 'mammals'
         #     end
         #   end
@@ -172,19 +179,7 @@ module Lotus
         # @api private
         # @since 0.1.0
         def as
-          prefix.relative_join(named_route, '_').to_sym
-        end
-
-        # The name of the action within the whole context of the router.
-        #
-        # @example
-        #   :flowers
-        #   :new_flowers
-        #
-        # @api private
-        # @since 0.1.0
-        def named_route
-          resource_name
+          namespace.relative_join(resource_name, self.class.named_route_separator).to_sym
         end
 
         # The name of the RESTful action.
@@ -240,22 +235,25 @@ module Lotus
         end
 
         protected
-        def method_missing(m, *args, &blk)
-          verb, path, _ = m, *args
-          @router.send verb, path(path), to: endpoint(path), as: as(path)
+        def method_missing(m, *args)
+          verb        = m
+          action_name = Utils::PathPrefix.new(args.first).relative_join(nil)
+
+          @router.__send__ verb, path(action_name),
+            to: endpoint(action_name), as: as(action_name)
         end
 
         private
-        def path(path)
-          prefix.join(path)
+        def path(action_name)
+          rest_path.join(action_name)
         end
 
-        def endpoint(path)
-          [ resource_name, path ].join separator
+        def endpoint(action_name)
+          [ resource_name, action_name ].join separator
         end
 
-        def as(path)
-          Utils::PathPrefix.new(path).relative_join(resource_name, '_').to_sym
+        def as(action_name)
+          [ action_name, super() ].join(self.class.named_route_separator).to_sym
         end
       end
 
@@ -274,12 +272,12 @@ module Lotus
       # @since 0.1.0
       module DefaultMemberAction
         private
-        def rest_path
-          "/#{ resource_name }/#{ action_name }"
+        def path
+          rest_path.join(action_name)
         end
 
-        def named_route
-          "#{ action_name }_#{ resource_name }"
+        def as
+          [ action_name, super ].join(self.class.named_route_separator).to_sym
         end
       end
 

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

@@ -18,6 +18,13 @@ module Lotus
         # @api private
         # @since 0.1.0
         self.namespace = Resources
+
+        # Id route variable
+        #
+        # @since 0.2.0
+        # @api private
+        class_attribute :identifier
+        self.identifier = ':id'.freeze
       end
 
       # Collection action
@@ -37,8 +44,8 @@ module Lotus
       # @see Lotus::Router#resources
       class MemberAction < Resource::MemberAction
         private
-        def path(path)
-          prefix.join("/:id/#{ path }")
+        def path(action_name)
+          rest_path.join(Action.identifier, action_name)
         end
       end
 
@@ -48,8 +55,8 @@ module Lotus
       # @since 0.1.0
       module DefaultMemberAction
         private
-        def rest_path
-          "/#{ resource_name }/:id"
+        def path
+          rest_path.join(Action.identifier)
         end
       end
 
@@ -96,8 +103,8 @@ module Lotus
         include DefaultMemberAction
 
         private
-        def rest_path
-          "#{ super }/#{ action_name }"
+        def path
+          super.join(action_name)
         end
       end
 

data/lib/lotus/routing/route.rb

@@ -44,6 +44,15 @@ module Lotus
         self
       end
 
+      # Introspect the given route to understand if there is a wrapped
+      # Lotus::Router
+      #
+      # @since 0.2.0
+      # @api private
+      def nested_router
+        dest.routes if dest.respond_to?(:routes)
+      end
+
       private
       def to=(dest = nil, &blk)
         self.to dest, &blk

data/lib/lotus/routing/routes_inspector.rb

@@ -0,0 +1,168 @@
+require 'lotus/utils/path_prefix'
+
+module Lotus
+  module Routing
+    # Routes inspector
+    #
+    # @since 0.2.0
+    class RoutesInspector
+      # Default route formatter
+      #
+      # @since 0.2.0
+      # @api private
+      FORMATTER = "%<name>20s %<methods>-10s %<path>-30s %<endpoint>-30s\n".freeze
+
+      # Default HTTP methods separator
+      #
+      # @since 0.2.0
+      # @api private
+      HTTP_METHODS_SEPARATOR = ', '.freeze
+
+      # Instantiate a new inspector
+      #
+      # @return [Lotus::Routing::RoutesInspector] the new instance
+      #
+      # @since 0.2.0
+      # @api private
+      def initialize(routes)
+        @routes = routes
+      end
+
+      # Return a formatted string that describes all the routes
+      #
+      # @param formatter [String] the optional formatter for a route
+      # @param base_path [String] the base path of a nested route
+      #
+      # @return [String] routes pretty print
+      #
+      # @since 0.2.0
+      #
+      # @see Lotus::Routing::RoutesInspector::FORMATTER
+      #
+      # @example Default formatter
+      #   require 'lotus/router'
+      #
+      #   router = Lotus::Router.new do
+      #     get    '/',       to: 'home#index'
+      #     get    '/login',  to: 'sessions#new',     as: :login
+      #     post   '/login',  to: 'sessions#create'
+      #     delete '/logout', to: 'sessions#destroy', as: :logout
+      #   end
+      #
+      #   puts router.inspector.to_s
+      #     # =>        GET, HEAD  /                        Home::Index
+      #          login  GET, HEAD  /login                   Sessions::New
+      #                 POST       /login                   Sessions::Create
+      #          logout GET, HEAD  /logout                  Sessions::Destroy
+      #
+      # @example Custom formatter
+      #   require 'lotus/router'
+      #
+      #   router = Lotus::Router.new do
+      #     get    '/',       to: 'home#index'
+      #     get    '/login',  to: 'sessions#new',     as: :login
+      #     post   '/login',  to: 'sessions#create'
+      #     delete '/logout', to: 'sessions#destroy', as: :logout
+      #   end
+      #
+      #   formatter = "| %{methods} | %{name} | %{path} | %{endpoint} |\n"
+      #
+      #   puts router.inspector.to_s(formatter)
+      #     # => | GET, HEAD |        | /       | Home::Index       |
+      #          | GET, HEAD | login  | /login  | Sessions::New     |
+      #          | POST      |        | /login  | Sessions::Create  |
+      #          | GET, HEAD | logout | /logout | Sessions::Destroy |
+      #
+      # @example Nested routes
+      #   require 'lotus/router'
+      #
+      #   class AdminLotusApp
+      #     def call(env)
+      #     end
+      #     def routes
+      #       Lotus::Router.new {
+      #         get '/home', to: 'home#index'
+      #       }
+      #     end
+      #   end
+      #
+      #   router = Lotus::Router.new {
+      #     get '/fakeroute', to: 'fake#index'
+      #     mount AdminLotusApp, at: '/admin'
+      #     mount Lotus::Router.new {
+      #       get '/posts', to: 'posts#index'
+      #       mount Lotus::Router.new {
+      #         get '/comments', to: 'comments#index'
+      #       }, at: '/second_mount'
+      #     }, at: '/api'
+      #   }
+      #
+      #   formatter = "| %{methods} | %{name} | %{path} | %{endpoint} |\n"
+      #
+      #   puts router.inspector.to_s(formatter)
+      #     # => | GET, HEAD |  | /fakeroute                 | Fake::Index     |
+      #          | GET, HEAD |  | /admin/home                | Home::Index     |
+      #          | GET, HEAD |  | /api/posts                 | Posts::Index    |
+      #          | GET, HEAD |  | /api/second_mount/comments | Comments::Index |
+      def to_s(formatter = FORMATTER, base_path = nil)
+        base_path = Utils::PathPrefix.new(base_path)
+        result    = ''
+
+        # TODO refactoring: replace conditional with polymorphism
+        # We're exposing too much knowledge from Routing::Route:
+        # #path_for_generation and #base_path
+        @routes.each do |route|
+          result << if router = route.nested_router
+            inspect_router(formatter, router, route, base_path)
+          else
+            inspect_route(formatter, route, base_path)
+          end
+        end
+
+        result
+      end
+
+      private
+
+      # Returns a string representation of the given route
+      #
+      # @param formatter [String] the template for the output
+      # @param route [Lotus::Routing::Route] a route
+      # @param base_path [Lotus::Utils::PathPrefix] the base path
+      #
+      # @return [String] serialized route
+      #
+      # @since 0.2.0
+      # @api private
+      #
+      # @see Lotus::Routing::RoutesInspector#FORMATTER
+      # @see Lotus::Routing::RoutesInspector#to_s
+      def inspect_route(formatter, route, base_path)
+        formatter % Hash[
+          name:     route.name,
+          methods:  route.request_methods.to_a.join(HTTP_METHODS_SEPARATOR),
+          path:     base_path.join(route.path_for_generation),
+          endpoint: route.dest.inspect
+        ]
+      end
+
+      # Returns a string representation of the given router
+      #
+      # @param formatter [String] the template for the output
+      # @param router [Lotus::Router] a router
+      # @param route [Lotus::Routing::Route] a route
+      # @param base_path [Lotus::Utils::PathPrefix] the base path
+      #
+      # @return [String] serialized routes from router
+      #
+      # @since 0.2.0
+      # @api private
+      #
+      # @see Lotus::Routing::RoutesInspector#FORMATTER
+      # @see Lotus::Routing::RoutesInspector#to_s
+      def inspect_router(formatter, router, route, base_path)
+        router.inspector.to_s(formatter, base_path.join(route.path_for_generation))
+      end
+    end
+  end
+end

data/lotus-router.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Lotus::Router::VERSION
   spec.authors       = ['Luca Guidi']
   spec.email         = ['me@lucaguidi.com']
-  spec.description   = %q{HTTP Router for Lotus}
-  spec.summary       = %q{Ruby HTTP Router for Lotus}
+  spec.description   = %q{Rack compatible HTTP router for Ruby}
+  spec.summary       = %q{Rack compatible HTTP router for Ruby and Lotus}
   spec.homepage      = 'http://lotusrb.org'
   spec.license       = 'MIT'
 
@@ -17,9 +17,10 @@ Gem::Specification.new do |spec|
   spec.executables   = []
   spec.test_files    = spec.files.grep(%r{^(test)/})
   spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_dependency 'http_router', '~> 0'
-  spec.add_dependency 'lotus-utils', '~> 0'
+  spec.add_dependency 'http_router', '~> 0.11'
+  spec.add_dependency 'lotus-utils', '~> 0.3', '>= 0.3.2'
 
   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.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-23 00:00:00.000000000 Z
+date: 2014-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http_router
@@ -16,28 +16,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: lotus-utils
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +86,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
-description: HTTP Router for Lotus
+description: Rack compatible HTTP router for Ruby
 email:
 - me@lucaguidi.com
 executables: []
@@ -97,12 +103,16 @@ files:
 - lib/lotus/routing/endpoint_resolver.rb
 - lib/lotus/routing/http_router.rb
 - lib/lotus/routing/namespace.rb
+- lib/lotus/routing/parsers.rb
+- lib/lotus/routing/parsing/json_parser.rb
+- lib/lotus/routing/parsing/parser.rb
 - lib/lotus/routing/resource.rb
 - lib/lotus/routing/resource/action.rb
 - lib/lotus/routing/resource/options.rb
 - lib/lotus/routing/resources.rb
 - lib/lotus/routing/resources/action.rb
 - lib/lotus/routing/route.rb
+- lib/lotus/routing/routes_inspector.rb
 - lotus-router.gemspec
 homepage: http://lotusrb.org
 licenses:
@@ -116,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -127,6 +137,6 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Ruby HTTP Router for Lotus
+summary: Rack compatible HTTP router for Ruby and Lotus
 test_files: []
 has_rdoc: