lotus-router 0.0.0 → 0.1.0

data/lib/lotus/routing/namespace.rb

@@ -0,0 +1,86 @@
+require 'delegate'
+require 'lotus/utils/path_prefix'
+
+module Lotus
+  module Routing
+    # Namespace for routes.
+    # Implementation of Lotus::Router#namespace
+    #
+    # @since 0.1.0
+    #
+    # @api private
+    #
+    # @see Lotus::Router#namespace
+    class Namespace < SimpleDelegator
+      # @api private
+      # @since 0.1.0
+      def initialize(router, name, &blk)
+        @router = router
+        @name   = Utils::PathPrefix.new(name)
+        __setobj__(@router)
+        instance_eval(&blk)
+      end
+
+      # @api private
+      # @since 0.1.0
+      def get(path, options = {}, &endpoint)
+        super(@name.join(path), options, &endpoint)
+      end
+
+      # @api private
+      # @since 0.1.0
+      def post(path, options = {}, &endpoint)
+        super(@name.join(path), options, &endpoint)
+      end
+
+      # @api private
+      # @since 0.1.0
+      def put(path, options = {}, &endpoint)
+        super(@name.join(path), options, &endpoint)
+      end
+
+      # @api private
+      # @since 0.1.0
+      def patch(path, options = {}, &endpoint)
+        super(@name.join(path), options, &endpoint)
+      end
+
+      # @api private
+      # @since 0.1.0
+      def delete(path, options = {}, &endpoint)
+        super(@name.join(path), options, &endpoint)
+      end
+
+      # @api private
+      # @since 0.1.0
+      def trace(path, options = {}, &endpoint)
+        super(@name.join(path), options, &endpoint)
+      end
+
+      # @api private
+      # @since 0.1.0
+      def resource(name, options = {})
+        super name, options.merge(prefix: @name)
+      end
+
+      # @api private
+      # @since 0.1.0
+      def resources(name, options = {})
+        super name, options.merge(prefix: @name)
+      end
+
+      # @api private
+      # @since 0.1.0
+      def redirect(path, options = {}, &endpoint)
+        super(@name.join(path), options.merge(prefix: @name), &endpoint)
+      end
+
+      # Supports nested namespaces
+      # @api private
+      # @since 0.1.0
+      def namespace(name, &blk)
+        Routing::Namespace.new(self, name, &blk)
+      end
+    end
+  end
+end

data/lib/lotus/routing/resource.rb

@@ -0,0 +1,73 @@
+require 'lotus/utils/class_attribute'
+require 'lotus/routing/resource/options'
+require 'lotus/routing/resource/action'
+
+module Lotus
+  module Routing
+    # Set of RESTful resource routes
+    # Implementation of Lotus::Router#resource
+    #
+    # @since 0.1.0
+    #
+    # @api private
+    #
+    # @see Lotus::Router#resource
+    class Resource
+      include Utils::ClassAttribute
+
+      # Set of default routes
+      #
+      # @api private
+      # @since 0.1.0
+      class_attribute :actions
+      self.actions = [:new, :create, :show, :edit, :update, :destroy]
+
+      # Action class
+      #
+      # @api private
+      # @since 0.1.0
+      class_attribute :action
+      self.action = Resource::Action
+
+      # Member action class
+      #
+      # @api private
+      # @since 0.1.0
+      class_attribute :member
+      self.member = Resource::MemberAction
+
+      # Collection action class
+      #
+      # @api private
+      # @since 0.1.0
+      class_attribute :collection
+      self.collection = Resource::CollectionAction
+
+      # @api private
+      # @since 0.1.0
+      def initialize(router, name, options = {}, &blk)
+        @router  = router
+        @name    = name
+        @options = Options.new(self.class.actions, options.merge(name: @name))
+        generate(&blk)
+      end
+
+      private
+      def generate(&blk)
+        @options.actions.each do |action|
+          self.class.action.generate(@router, action, @options)
+        end
+
+        instance_eval(&blk) if block_given?
+      end
+
+      def member(&blk)
+        self.class.member.new(@router, @options.merge(prefix: @name), &blk)
+      end
+
+      def collection(&blk)
+        self.class.collection.new(@router, @options.merge(prefix: @name), &blk)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,340 @@
+require 'lotus/utils/string'
+require 'lotus/utils/path_prefix'
+require 'lotus/utils/class_attribute'
+
+module Lotus
+  module Routing
+    class Resource
+      # Action for RESTful resource
+      #
+      # @since 0.1.0
+      #
+      # @api private
+      #
+      # @see Lotus::Router#resource
+      class Action
+        include Utils::ClassAttribute
+
+        # Ruby namespace where lookup for default subclasses.
+        #
+        # @api private
+        # @since 0.1.0
+        class_attribute :namespace
+        self.namespace = Resource
+
+        # Accepted HTTP verb
+        #
+        # @api private
+        # @since 0.1.0
+        class_attribute :verb
+        self.verb = :get
+
+        # Generate an action for the given router
+        #
+        # @param router [Lotus::Router]
+        # @param action [Lotus::Routing::Resource::Action]
+        # @param options [Hash]
+        #
+        # @api private
+        #
+        # @since 0.1.0
+        def self.generate(router, action, options)
+          class_for(action).new(router, options)
+        end
+
+        # Initialize an action
+        #
+        # @param router [Lotus::Router]
+        # @param options [Hash]
+        # @param blk [Proc]
+        #
+        # @api private
+        #
+        # @since 0.1.0
+        def initialize(router, options, &blk)
+          @router, @options = router, options
+          generate(&blk)
+        end
+
+        # Generate an action for the given router
+        #
+        # @param blk [Proc]
+        #
+        # @api private
+        #
+        # @since 0.1.0
+        def generate(&blk)
+          @router.send verb, path, to: endpoint, as: as
+          instance_eval(&blk) if block_given?
+        end
+
+        # Resource name
+        #
+        # @api private
+        # @since 0.1.0
+        #
+        # @example
+        #   require 'lotus/router'
+        #
+        #   Lotus::Router.new do
+        #     resource 'identity'
+        #   end
+        #
+        #   # 'identity' is the name passed in the @options
+        def resource_name
+          @options[:name]
+        end
+
+        # Path prefix
+        #
+        # @api private
+        # @since 0.1.0
+        def prefix
+          @prefix ||= Utils::PathPrefix.new @options[:prefix]
+        end
+
+        private
+        # Load a subclass, according to the given action name
+        #
+        # @param action [String] the action name
+        #
+        # @example
+        #   Lotus::Routing::Resource::Action.send(:class_for, 'New') # =>
+        #     Lotus::Routing::Resource::New
+        #
+        # @api private
+        # @since 0.1.0
+        def self.class_for(action)
+          Utils::Class.load!(Utils::String.new(action).classify, namespace)
+        end
+
+        # Accepted HTTP verb
+        #
+        # @see Lotus::Routing::Resource::Action.verb
+        #
+        # @api private
+        # @since 0.1.0
+        def verb
+          self.class.verb
+        end
+
+        # The prefixed URL relative path
+        #
+        # @example
+        #   require 'lotus/router'
+        #
+        #   Lotus::Router.new do
+        #     resources 'flowers'
+        #
+        #     prefix 'animals' do
+        #       resources 'mammals'
+        #     end
+        #   end
+        #
+        #   # It will generate paths like '/flowers', '/flowers/:id' ..
+        #   # It will generate paths like '/animals/mammals', '/animals/mammals/:id' ..
+        #
+        # @api private
+        # @since 0.1.0
+        def path
+          prefix.join(rest_path)
+        end
+
+        # The URL relative path
+        #
+        # @example
+        #   '/flowers'
+        #   '/flowers/new'
+        #   '/flowers/:id'
+        #
+        # @api private
+        # @since 0.1.0
+        def rest_path
+          "/#{ resource_name }"
+        end
+
+        # The prefixed name of the action within the whole context of the router.
+        #
+        # @example
+        #   require 'lotus/router'
+        #
+        #   Lotus::Router.new do
+        #     resources 'flowers'
+        #
+        #     prefix 'animals' do
+        #       resources 'mammals'
+        #     end
+        #   end
+        #
+        #   # It will generate named routes like :flowers, :new_flowers ..
+        #   # It will generate named routes like :animals_mammals, :animals_new_mammals ..
+        #
+        # @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
+        end
+
+        # The name of the RESTful action.
+        #
+        # @example
+        #   'index'
+        #   'new'
+        #   'create'
+        #
+        # @api private
+        # @since 0.1.0
+        def action_name
+          Utils::String.new(self.class.name).demodulize.downcase
+        end
+
+        # A string that represents the endpoint to be loaded.
+        # It is composed by controller and action name.
+        #
+        # @see Lotus::Routing::Resource::Action#separator
+        #
+        # @example
+        #   'flowers#index'
+        #
+        # @api private
+        # @since 0.1.0
+        def endpoint
+          [ resource_name, action_name ].join separator
+        end
+
+        # Separator between controller and action name
+        #
+        # @see Lotus::Routing::EndpointResolver#separator
+        #
+        # @example
+        #   '#' # default
+        #
+        # @api private
+        # @since 0.1.0
+        def separator
+          @options[:separator]
+        end
+      end
+
+      # Collection action
+      # It implements #collection within a #resource block.
+      #
+      # @api private
+      # @since 0.1.0
+      # @see Lotus::Router#resource
+      class CollectionAction < Action
+        def generate(&blk)
+          instance_eval(&blk) if block_given?
+        end
+
+        protected
+        def method_missing(m, *args, &blk)
+          verb, path, _ = m, *args
+          @router.send verb, path(path), to: endpoint(path), as: as(path)
+        end
+
+        private
+        def path(path)
+          prefix.join(path)
+        end
+
+        def endpoint(path)
+          [ resource_name, path ].join separator
+        end
+
+        def as(path)
+          Utils::PathPrefix.new(path).relative_join(resource_name, '_').to_sym
+        end
+      end
+
+      # Collection action
+      # It implements #member within a #resource block.
+      #
+      # @api private
+      # @since 0.1.0
+      # @see Lotus::Router#resource
+      class MemberAction < CollectionAction
+      end
+
+      # Implementation of common methods for concrete member actions
+      #
+      # @api private
+      # @since 0.1.0
+      module DefaultMemberAction
+        private
+        def rest_path
+          "/#{ resource_name }/#{ action_name }"
+        end
+
+        def named_route
+          "#{ action_name }_#{ resource_name }"
+        end
+      end
+
+      # New action
+      #
+      # @api private
+      # @since 0.1.0
+      # @see Lotus::Router#resource
+      class New < Action
+        include DefaultMemberAction
+      end
+
+      # Create action
+      #
+      # @api private
+      # @since 0.1.0
+      # @see Lotus::Router#resource
+      class Create < Action
+        self.verb = :post
+      end
+
+      # Show action
+      #
+      # @api private
+      # @since 0.1.0
+      # @see Lotus::Router#resource
+      class Show < Action
+      end
+
+      # Edit action
+      #
+      # @api private
+      # @since 0.1.0
+      # @see Lotus::Router#resource
+      class Edit < Action
+        include DefaultMemberAction
+      end
+
+      # Update action
+      #
+      # @api private
+      # @since 0.1.0
+      # @see Lotus::Router#resource
+      class Update < Action
+        self.verb = :patch
+      end
+
+      # Destroy action
+      #
+      # @api private
+      # @since 0.1.0
+      # @see Lotus::Router#resource
+      class Destroy < Action
+        self.verb = :delete
+      end
+    end
+  end
+end