signpost 0.1.0

data/lib/signpost/router.rb

@@ -0,0 +1,59 @@
+class Signpost
+  class Router
+    RACK_REQUEST_METHOD = 'REQUEST_METHOD'.freeze
+    RACK_REQUEST_PATH   = 'PATH_INFO'.freeze
+    RACK_QUERY_HASH     = 'rack.request.query_hash'.freeze
+
+    attr_reader :routes
+
+    attr_reader :named_routes
+
+    attr_reader :params_key
+
+    def call(env)
+      @routes[env[RACK_REQUEST_METHOD]].each do |route|
+        params = route.match(env[RACK_REQUEST_PATH], env)
+
+        case params
+          when nil
+            next
+          when Hash
+            if @options[:rack_params]
+              env[RACK_QUERY_HASH] = env[RACK_QUERY_HASH] ? env[RACK_QUERY_HASH].merge(params) : params
+            end
+
+            env[params_key] = params
+
+            return route.endpoint.call(env)
+          else
+            return params
+        end
+      end
+
+      default_action
+    end
+
+    def expand(name, data={})
+      @named_routes[name].expand(data)
+    end
+
+  private
+
+    def initialize(builders, options, root=false)
+      @routes = SUPPORTED_METHODS.each_with_object({}) { |m, h| h[m] = [] }.freeze
+      @named_routes = {}
+      @options = options
+      @root    = root
+
+      @params_key = options[:params_key]
+
+      builders.each do |builder|
+        builder.expose(self, @routes, @named_routes)
+      end
+    end
+
+    def default_action
+      @root ? [404, {}, ['']] : nil
+    end
+  end
+end

data/lib/signpost/sign/flat.rb

@@ -0,0 +1,79 @@
+class Signpost
+  class Sign
+
+    class Flat
+
+      ##
+      # Do not match given pattern
+      #
+      # Params:
+      # - pattern {String} pattern to ignore
+      #
+      # Examples:
+      #
+      #     delete('/pages/:id').except('/pages/1')
+      #     get('/pages/*slug/edit').except('/pages/system/*/edit')
+      #
+      def except(pattern)
+        @except = pattern
+        self
+      end
+
+      ##
+      # Define pattern constraints for the route
+      #
+      # Params:
+      # - constraints {Hash|Array|Symbol|RegExp|String}
+      #
+      # Examples:
+      #
+      #     get('/:id').capture(:digit)
+      #     get('/:id').capture(/\d+/)
+      #     get('/:id_or_slug').capture([/\d+/, :word])
+      #     get('/:id.:ext').capture(id: /\d+/, ext: ['png', 'jpg'])
+      #
+      def capture(constraints)
+        @capture = constraints
+        self
+      end
+
+      def expose(router, routing_table, named_routes)
+        route = Route::Simple.new(get_matcher, build_stack(router), build_params, @constraints, @name)
+        named_routes[route.name.to_sym] = route if route.name
+
+        http_methods.each do |method|
+          routing_table[method] << route
+        end
+      end
+
+    private
+
+      def initialize(pattern, options, &block)
+        @pattern   = pattern
+        @options   = options
+        @namespace = options[:namespace]
+
+        @params = {}
+        @endpoint_params = {}
+        @constraints = []
+
+        @block = block
+      end
+
+      ##
+      # Private: Build Mustermann matcher from given pattern and options
+      #
+      def get_matcher
+        matcher_opts = {
+          type: @options[:style] || :sinatra
+        }
+
+        matcher_opts[:capture] = @capture if @capture
+        matcher_opts[:except]  = @except  if @except
+
+        Mustermann.new(@pattern, matcher_opts)
+      end
+
+    end
+  end
+end

data/lib/signpost/sign/flat/path.rb

@@ -0,0 +1,114 @@
+class Signpost
+  class Sign
+    class Flat
+
+      class Path < self
+
+        ##
+        # Route endpoint specification
+        # Might be a string, hash or class wich defines controller and action
+        # names. Rack-compatible block is also acceptable.
+        #
+        # Params:
+        # - spec {String|Hash|Class|Proc} endpoint spec
+        #
+        # Examples:
+        #
+        #     get('/').to('admin/users#index')
+        #     get('/').to('Admin::Users#index')
+        #     get('/').to(controller: 'Admin::Users', action: 'index')
+        #     get('/').to(Admin::Users::List)
+        #     get('/').to do |env|
+        #       [200, {}, ['Hello world!']]
+        #     end
+        #
+        def to(spec=nil, &block)
+          @to = spec || block
+          self
+        end
+
+        ##
+        # Define named route
+        #
+        # Params:
+        # - name {String|Symbol} route name
+        #
+        def as(name, postfix=nil)
+          @name = (postfix ? [name, @namespace, postfix] : [@namespace, name]).flatten.compact.join('_')
+          self
+        end
+
+        ##
+        # Define domain constraints for the route
+        #
+        # Params:
+        # - constraints {Array}
+        #
+        # Examples:
+        #
+        #     get('/stats').constraint(->(env) { env['RACK_ENV'] == 'development' })
+        #
+        def constraint(*constraints)
+          @constraints = constraints
+          self
+        end
+        alias :constraints :constraint
+
+        ##
+        # Define default or additional params
+        #
+        # Params:
+        # - params {Hash}
+        #
+        # Examples:
+        #
+        #     get('/pages/:id').params(id: 1)
+        #     match('/:controller/:action').params(from: :dynamic_route)
+        #
+        def params(params)
+          @params = params
+          self
+        end
+
+      private
+
+        def build_stack(router)
+          if @block && @block.arity == 0
+            @to = Endpoint::Action.new(@block, router)
+          end
+
+          resolved = Endpoint::Resolver.new(@to || @block, @options).resolve
+
+          @endpoint_params = resolved.params
+
+          Endpoint::Builder.new(resolved.endpoint, @options[:middlewares] || []).build
+        end
+
+        def build_params
+          @endpoint_params.merge(@params)
+        end
+      end
+
+      Signpost::SUPPORTED_METHODS.each do |meth|
+        class_eval <<-BUILD, __FILE__, __LINE__
+      class #{meth} < Path
+        def http_methods
+          Set['#{meth}']
+        end
+      end
+        BUILD
+      end
+
+      class Any < Path
+        def via(*methods)
+          @http_methods = methods.map { |m| m.to_s.upcase }.keep_if { |m| Signpost::SUPPORTED_METHODS.include?(m) }.to_set
+        end
+
+        def http_methods
+          @http_methods || Signpost::SUPPORTED_METHODS
+        end
+      end
+
+    end
+  end
+end

data/lib/signpost/sign/flat/redirect.rb

@@ -0,0 +1,60 @@
+class Signpost
+  class Sign
+    class Flat
+
+      class Redirect < self
+
+        def to(path_or_name=nil, additional_values=nil, &block)
+          if block_given?
+            @to = block
+          else
+            @to = path_or_name
+            @additional = additional_values if additional_values
+          end
+
+          self
+        end
+
+        def permanent
+          @status = 301
+          self
+        end
+
+        def temporary
+          @status = 303
+          self
+        end
+
+        def with_status(status)
+          @status = status
+          self
+        end
+
+      private
+
+        def initialize(*)
+          super
+          @status = @options[:default_redirect_status]
+          @additional = @options[:default_redirect_additional_values] || :ignore
+        end
+
+        def build_stack(router)
+          to_opts = { additional_values: @additional }
+          to = @to.is_a?(String) ? Mustermann::Expander.new(@to, to_opts) : @to
+
+          endpoint = Signpost::Endpoint::Redirect.new(to || @block, router, @status)
+        end
+
+        def build_params
+          @endpoint_params
+        end
+
+        def http_methods
+          Signpost::SUPPORTED_METHODS
+        end
+
+      end
+
+    end
+  end
+end

data/lib/signpost/sign/namespace.rb

@@ -0,0 +1,11 @@
+class Signpost
+  class Sign
+
+    class Namespace < Nested
+      def builder
+        Builder::Namespace
+      end
+    end
+
+  end
+end

data/lib/signpost/sign/nested.rb

@@ -0,0 +1,39 @@
+class Signpost
+  class Sign
+
+    class Nested
+
+      def expose(_router, routing_table, named_routes)
+        subrouter = @builder.build
+        subroutes = subrouter.routes
+
+        named_routes.merge!(subrouter.named_routes)
+
+        subroutes.keys.reject { |m| subroutes[m].empty? }.each do |method|
+          routing_table[method] << Route::Nested.new(@subpath, subrouter)
+        end
+      end
+
+    private
+
+      def initialize(subpath, options, &block)
+        @subpath = subpath
+        @options = options
+        @builder = builder.new(builder_options, &block)
+      end
+
+      def builder
+        Builder::Nested
+      end
+
+      def builder_options
+        @options.merge({
+          subroute:    @subpath,
+          middlewares: @options[:middlewares].dup
+        })
+      end
+
+    end
+
+  end
+end

data/lib/signpost/version.rb

@@ -0,0 +1,13 @@
+class Signpost
+  module VERSION
+    MAJOR = 0.freeze
+    MINOR = 1.freeze
+    PATCH = 0.freeze
+
+    String = [MAJOR, MINOR, PATCH].join('.').freeze
+
+    def self.to_s
+      String
+    end
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: signpost
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrey Savchenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mustermann
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: inflecto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+description: Standalone router for rack and nothing else
+email:
+- andrey@aejis.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/signpost.rb
+- lib/signpost/builder.rb
+- lib/signpost/builder/namespace.rb
+- lib/signpost/builder/nested.rb
+- lib/signpost/endpoint/action.rb
+- lib/signpost/endpoint/builder.rb
+- lib/signpost/endpoint/dynamic.rb
+- lib/signpost/endpoint/redirect.rb
+- lib/signpost/endpoint/resolver.rb
+- lib/signpost/middleware.rb
+- lib/signpost/route/nested.rb
+- lib/signpost/route/simple.rb
+- lib/signpost/router.rb
+- lib/signpost/sign/flat.rb
+- lib/signpost/sign/flat/path.rb
+- lib/signpost/sign/flat/redirect.rb
+- lib/signpost/sign/namespace.rb
+- lib/signpost/sign/nested.rb
+- lib/signpost/version.rb
+homepage: https://github.com/Ptico/signpost
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Yet another router for rack
+test_files: []
+has_rdoc: