lotus-router 0.0.0 → 0.1.0

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

@@ -0,0 +1,48 @@
+module Lotus
+  module Routing
+    class Resource
+      # Options for RESTFul resource(s)
+      #
+      # @api private
+      # @since 0.1.0
+      #
+      # @see Lotus::Router#resource
+      # @see Lotus::Router#resources
+      class Options < Hash
+        # @api private
+        # @since 0.1.0
+        attr_reader :actions
+
+        # Initialize the options for:
+        #   * Lotus::Router#resource
+        #   * Lotus::Router#resources
+        #
+        # @param actions [Array<Symbol>] the name of the actions
+        # @param options [Hash]
+        # @option options [Hash] :only white list of the default actions
+        # @option options [Hash] :except black list of the default actions
+        #
+        # @api private
+        # @since 0.1.0
+        #
+        # @see Lotus::Routing::Resource
+        # @see Lotus::Routing::Resources
+        #
+        # @example
+        #   require 'lotus/router'
+        #
+        #   Lotus::Router.new do
+        #     resources 'articles', only:   [:index]
+        #     resource  'profile',  except: [:new, :create, :destroy]
+        #   end
+        def initialize(actions, options = {})
+          only     = Array(options.delete(:only) || actions)
+          except   = Array(options.delete(:except))
+          @actions = ( actions & only ) - except
+
+          merge! options
+        end
+      end
+    end
+  end
+end

data/lib/lotus/routing/resources.rb

@@ -0,0 +1,40 @@
+require 'lotus/routing/resource'
+require 'lotus/routing/resources/action'
+
+module Lotus
+  module Routing
+    # Set of RESTful resources routes
+    # Implementation of Lotus::Router#resources
+    #
+    # @since 0.1.0
+    #
+    # @api private
+    #
+    # @see Lotus::Router#resources
+    class Resources < Resource
+      # Set of default routes
+      #
+      # @api private
+      # @since 0.1.0
+      self.actions = [:index, :new, :create, :show, :edit, :update, :destroy]
+
+      # Action class
+      #
+      # @api private
+      # @since 0.1.0
+      self.action = Resources::Action
+
+      # Member action class
+      #
+      # @api private
+      # @since 0.1.0
+      self.member = Resources::MemberAction
+
+      # Collection action class
+      #
+      # @api private
+      # @since 0.1.0
+      self.collection = Resources::CollectionAction
+    end
+  end
+end

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

@@ -0,0 +1,123 @@
+require 'lotus/utils/string'
+require 'lotus/utils/path_prefix'
+require 'lotus/routing/resource'
+
+module Lotus
+  module Routing
+    class Resources < Resource
+      # Action for RESTful resources
+      #
+      # @since 0.1.0
+      #
+      # @api private
+      #
+      # @see Lotus::Router#resources
+      class Action < Resource::Action
+        # Ruby namespace where lookup for default subclasses.
+        #
+        # @api private
+        # @since 0.1.0
+        self.namespace = Resources
+      end
+
+      # Collection action
+      # It implements #collection within a #resources block.
+      #
+      # @api private
+      # @since 0.1.0
+      # @see Lotus::Router#resources
+      class CollectionAction < Resource::CollectionAction
+      end
+
+      # Member action
+      # It implements #member within a #resources block.
+      #
+      # @api private
+      # @since 0.1.0
+      # @see Lotus::Router#resources
+      class MemberAction < Resource::MemberAction
+        private
+        def path(path)
+          prefix.join("/:id/#{ path }")
+        end
+      end
+
+      # Implementation of common methods for concrete member actions
+      #
+      # @api private
+      # @since 0.1.0
+      module DefaultMemberAction
+        private
+        def rest_path
+          "/#{ resource_name }/:id"
+        end
+      end
+
+      # Index action
+      #
+      # @api private
+      # @since 0.1.0
+      # @see Lotus::Router#resources
+      class Index < Action
+        self.verb = :get
+      end
+
+      # New action
+      #
+      # @api private
+      # @since 0.1.0
+      # @see Lotus::Router#resources
+      class New < Resource::New
+      end
+
+      # Create action
+      #
+      # @api private
+      # @since 0.1.0
+      # @see Lotus::Router#resources
+      class Create < Resource::Create
+      end
+
+      # Show action
+      #
+      # @api private
+      # @since 0.1.0
+      # @see Lotus::Router#resources
+      class Show < Resource::Show
+        include DefaultMemberAction
+      end
+
+      # Edit action
+      #
+      # @api private
+      # @since 0.1.0
+      # @see Lotus::Router#resources
+      class Edit < Resource::Edit
+        include DefaultMemberAction
+
+        private
+        def rest_path
+          "#{ super }/#{ action_name }"
+        end
+      end
+
+      # Update action
+      #
+      # @api private
+      # @since 0.1.0
+      # @see Lotus::Router#resources
+      class Update < Resource::Update
+        include DefaultMemberAction
+      end
+
+      # Destroy action
+      #
+      # @api private
+      # @since 0.1.0
+      # @see Lotus::Router#resources
+      class Destroy < Resource::Destroy
+        include DefaultMemberAction
+      end
+    end
+  end
+end

data/lib/lotus/routing/route.rb

@@ -0,0 +1,53 @@
+require 'http_router/route'
+
+module Lotus
+  module Routing
+    # Entry of the routing system
+    #
+    # @api private
+    #
+    # @since 0.1.0
+    #
+    # @see http://rdoc.info/gems/http_router/HttpRouter/Route
+    #
+    # @example
+    #   require 'lotus/router'
+    #
+    #   router = Lotus::Router.new
+    #   router.get('/', to: endpoint) # => #<Lotus::Routing::Route:0x007f83083ba028 ...>
+    class Route < HttpRouter::Route
+      # Asks the given resolver to return an endpoint that will be associated
+      #   with the other options.
+      #
+      # @param resolver [Lotus::Routing::EndpointResolver, #resolve] this may change
+      #   according to the :resolve option passed to Lotus::Router#initialize.
+      #
+      # @param options [Hash] options to customize the route
+      # @option options [Symbol] :as the name we want to use for the route
+      #
+      # @since 0.1.0
+      #
+      # @api private
+      #
+      # @see Lotus::Router#initialize
+      #
+      # @example
+      #   require 'lotus/router'
+      #
+      #   router = Lotus::Router.new
+      #   router.get('/', to: endpoint, as: :home_page).name # => :home_page
+      #
+      #   router.path(:home_page) # => '/'
+      def generate(resolver, options = {}, &endpoint)
+        self.to   = resolver.resolve(options, &endpoint)
+        self.name = options[:as].to_sym if options[:as]
+        self
+      end
+
+      private
+      def to=(dest = nil, &blk)
+        self.to dest, &blk
+      end
+    end
+  end
+end

data/lotus-router.gemspec

@@ -4,20 +4,24 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'lotus/router/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "lotus-router"
+  spec.name          = 'lotus-router'
   spec.version       = Lotus::Router::VERSION
-  spec.authors       = ["Luca Guidi"]
-  spec.email         = ["me@lucaguidi.com"]
-  spec.summary       = %q{HTTP router for Lotus}
-  spec.description   = %q{HTTP router for Lotus}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  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.homepage      = 'http://lotusrb.org'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.executables   = []
+  spec.test_files    = spec.files.grep(%r{^(test)/})
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
+  spec.add_dependency 'http_router', '~> 0'
+  spec.add_dependency 'lotus-utils', '~> 0'
+
+  spec.add_development_dependency 'bundler',  '~> 1.5'
+  spec.add_development_dependency 'minitest', '~> 5'
+  spec.add_development_dependency 'rake',     '~> 10'
 end

data/test/fixtures.rb

@@ -0,0 +1,193 @@
+class TestEndpoint
+  def call(env)
+    'Hi from TestEndpoint!'
+  end
+end #TestEndpoint
+
+class TestController
+  class Show
+    def call(env)
+      'Hi from Test::Show!'
+    end
+  end
+end #TestController
+
+class TestApp
+  class TestEndpoint
+    def call(env)
+      'Hi from TestApp::TestEndpoint!'
+    end
+  end
+
+  class Test2Controller
+    class Show
+      def call(env)
+        'Hi from TestApp::Test2Controller::Show!'
+      end
+    end
+  end
+end # TestApp
+
+class AvatarController
+  class New
+    def call(env)
+      [200, {}, ['Avatar::New']]
+    end
+  end
+
+  class Create
+    def call(env)
+      [200, {}, ['Avatar::Create']]
+    end
+  end
+
+  class Show
+    def call(env)
+      [200, {}, ['Avatar::Show']]
+    end
+  end
+
+  class Edit
+    def call(env)
+      [200, {}, ['Avatar::Edit']]
+    end
+  end
+
+  class Update
+    def call(env)
+      [200, {}, ['Avatar::Update']]
+    end
+  end
+
+  class Destroy
+    def call(env)
+      [200, {}, ['Avatar::Destroy']]
+    end
+  end
+end # AvatarController
+
+class ProfileController
+  class Show
+    def call(env)
+      [200, {}, ['Profile::Show']]
+    end
+  end
+
+  class New
+    def call(env)
+      [200, {}, ['Profile::New']]
+    end
+  end
+
+  class Create
+    def call(env)
+      [200, {}, ['Profile::Create']]
+    end
+  end
+
+  class Edit
+    def call(env)
+      [200, {}, ['Profile::Edit']]
+    end
+  end
+
+  class Update
+    def call(env)
+      [200, {}, ['Profile::Update']]
+    end
+  end
+
+  class Destroy
+    def call(env)
+      [200, {}, ['Profile::Destroy']]
+    end
+  end
+
+  class Activate
+    def call(env)
+      [200, {}, ['Profile::Activate']]
+    end
+  end
+
+  class Keys
+    def call(env)
+      [200, {}, ['Profile::Keys']]
+    end
+  end
+end # ProfileController
+
+class FlowersController
+  class Index
+    def call(env)
+      [200, {}, ['Flowers::Index']]
+    end
+  end
+
+  class New
+    def call(env)
+      [200, {}, ['Flowers::New']]
+    end
+  end
+
+  class Create
+    def call(env)
+      [200, {}, ['Flowers::Create']]
+    end
+  end
+
+  class Show
+    def call(env)
+      [200, {}, ['Flowers::Show ' + env['router.params'][:id]]]
+    end
+  end
+
+  class Edit
+    def call(env)
+      [200, {}, ['Flowers::Edit ' + env['router.params'][:id]]]
+    end
+  end
+
+  class Update
+    def call(env)
+      [200, {}, ['Flowers::Update ' + env['router.params'][:id]]]
+    end
+  end
+
+  class Destroy
+    def call(env)
+      [200, {}, ['Flowers::Destroy ' + env['router.params'][:id]]]
+    end
+  end
+end # FlowersController
+
+class KeyboardsController
+  class Index
+    def call(env)
+      [200, {}, ['Keyboards::Index']]
+    end
+  end
+
+  class Create
+    def call(env)
+      [200, {}, ['Keyboards::Create']]
+    end
+  end
+
+  class Edit
+    def call(env)
+      [200, {}, ['Keyboards::Edit ' + env['router.params'][:id]]]
+    end
+  end
+
+  class Search
+    def call(env)
+      [200, {}, ['Keyboards::Search']]
+    end
+  end
+
+  class Screenshot
+    def call(env)
+      [200, {}, ['Keyboards::Screenshot ' + env['router.params'][:id]]]
+    end
+  end
+end # KeyboardsController