spine-routing 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0b4af1297fc05c078970f0aacecd00179de2740
+  data.tar.gz: 713a8f22eede139cc7577ed5511fc6efdb595992
+SHA512:
+  metadata.gz: 29167c916364a39f208e2026e442217df277678b0fabcbaa3b429bc3896d367003293c33943288429502c5e6c554a2b46d58e05ef9048a52376cfab9ee158775
+  data.tar.gz: 4cca9e3f93628fb78f0b360a8b15faa3c2075be64e2f1597e91cded81239a73ad0b8ec29483394f66063a450d6031ae46a52373a94b358d078385f5737f66268

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/bin/
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require config/default

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in spine-routing.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    spine-routing (0.1.0)
+      rack (~> 1.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rack (1.6.1)
+    rake (10.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  rake (~> 10.0)
+  rspec (~> 3.2)
+  spine-routing!

data/LICENSE

@@ -0,0 +1,12 @@
+Copyright (c) 2015, TOGGL LLC
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the TOGGL LLC nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,35 @@
+# Spine::Routing
+
+[![Gem Version](https://badge.fury.io/rb/spine-routing.svg)](http://badge.fury.io/rb/spine-routing)
+[![Dependency Status](https://gemnasium.com/rspine/routing.svg)](https://gemnasium.com/rspine/routing)
+[![Code Climate](https://codeclimate.com/github/rspine/routing/badges/gpa.svg)](https://codeclimate.com/github/rspine/routing)
+[ ![Codeship Status for rspine/routing](https://codeship.com/projects/f340c940-e121-0132-7351-0acdf541758b/status?branch=master)](https://codeship.com/projects/81073)
+
+Router for Rack application. Supports scopes, path parameters and HTTP verbs
+(GET, POST, PUT, PATCH, DELETE).
+
+## Installation
+
+To install it, add the gem to your Gemfile:
+
+```ruby
+gem 'spine-routing'
+```
+
+Then run `bundle`. If you're not using Bundler, just `gem install spine-routing`.
+
+## Usage
+
+```ruby
+router = Spine::Routing::Router.new
+router.configure do
+  scope :users do
+    get '', to: Users::List
+    post ':id', to: Users::Add
+  end
+
+  get :status, to: -> (env) { [200, {}, []] }
+end
+
+router.call(env)
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/spine/routing.rb

@@ -0,0 +1,13 @@
+module Spine
+  module Routing
+    autoload :Route, 'spine/routing/route'
+    autoload :Router, 'spine/routing/router'
+    autoload :NestedRouter, 'spine/routing/nested_router'
+
+    module Syntax
+      autoload :Match, 'spine/routing/syntax/match'
+      autoload :Verbs, 'spine/routing/syntax/verbs'
+      autoload :Namespacing, 'spine/routing/syntax/namespacing'
+    end
+  end
+end

data/lib/spine/routing/nested_router.rb

@@ -0,0 +1,20 @@
+module Spine
+  module Routing
+    class NestedRouter < Router
+      attr_reader :parent
+
+      def initialize(path, parent)
+        @path = path
+        @parent = parent
+      end
+
+      def add(route)
+        parent.add(route)
+      end
+
+      def build(pattern, options)
+        parent.build([@path, normalize_path(pattern)].join, options)
+      end
+    end
+  end
+end

data/lib/spine/routing/route.rb

@@ -0,0 +1,61 @@
+require 'delegate'
+
+module Spine
+  module Routing
+    class Route
+      VARIABLES_PATTERN = /\:([a-zA-Z0-9_-]+)/.freeze
+      WILDCARD_PATTERN = /\*([a-zA-Z0-9_-]+)/.freeze
+      EMPTY_WILDCARD_PATTERN = /\*(\/|\Z)/.freeze
+
+      attr_reader :name, :pattern, :app, :verb
+
+      def initialize(name, pattern, app, verb)
+        @name = name
+        @pattern = pattern
+        @app = app
+        @verb = verb
+      end
+
+      def match(verb, path)
+        return nil unless verb == self.verb
+
+        matches = path.match(regex)
+        return nil unless matches
+
+        Match.new(self, Hash[matches.names.map(&:to_sym).zip(matches.captures)])
+      end
+
+      private
+
+      def regex
+        @regex ||= compile
+      end
+
+      def compile
+        Regexp.new("\\A#{ prepare }\/?\\Z")
+      end
+
+      def prepare
+        add_format(
+          pattern
+            .gsub(EMPTY_WILDCARD_PATTERN, '*paths\1')
+            .gsub(WILDCARD_PATTERN,'(?<\1>[^.$]+)')
+            .gsub(VARIABLES_PATTERN, '(?<\1>[^./$]+)')
+        )
+      end
+
+      def add_format(path)
+        path + '(?:\.(?<format>.*))?'
+      end
+
+      class Match < SimpleDelegator
+        attr_reader :parameters
+
+        def initialize(route, parameters)
+          super(route)
+          @parameters = parameters
+        end
+      end
+    end
+  end
+end

data/lib/spine/routing/router.rb

@@ -0,0 +1,68 @@
+module Spine
+  module Routing
+    class Router
+      include Syntax::Match
+      include Syntax::Verbs
+      include Syntax::Namespacing
+
+      VERB = 'REQUEST_METHOD'.freeze
+      PATH = 'PATH_INFO'.freeze
+      PATH_PARAMETERS = 'router.parameters'.freeze
+      NOT_FOUND_RESPONSE = [404, {}, ['']].freeze
+
+
+      def routes
+        @routes ||= [] # TODO: use set instead of array
+      end
+
+      def build(pattern, options)
+        Route.new(
+          '',
+          normalize_path(pattern),
+          options.fetch(:to),
+          options.fetch(:verb)
+        )
+      end
+
+      def configure(&block)
+        instance_eval &block
+      end
+
+      def add(route)
+        routes << route
+      end
+
+      def recognise(verb, path)
+        routes.each do |route|
+          match = route.match(verb, path)
+          return match if match
+        end
+        nil
+      end
+
+      def call(env)
+        verb = env[VERB].downcase.gsub('head', 'get').to_sym
+        route = recognise(verb, env[PATH])
+        if route
+          env[PATH_PARAMETERS] = route.parameters
+          run(route.app, env)
+        else
+          NOT_FOUND_RESPONSE # TODO: set default app
+        end
+      end
+
+      def run(app, env)
+        app.call(env)
+      end
+
+      protected
+
+      def normalize_path(path)
+        '/' + path.split('/')
+          .map(&:strip)
+          .select { |part| part && part != '' }
+          .join('/')
+      end
+    end
+  end
+end

data/lib/spine/routing/syntax/match.rb

@@ -0,0 +1,11 @@
+module Spine
+  module Routing
+    module Syntax
+      module Match
+        def match(pattern, options)
+          add(build(pattern.to_s, options))
+        end
+      end
+    end
+  end
+end

data/lib/spine/routing/syntax/namespacing.rb

@@ -0,0 +1,13 @@
+module Spine
+  module Routing
+    module Syntax
+      module Namespacing
+        def scope(path, &block)
+          nested = NestedRouter.new(normalize_path(path.to_s), self)
+          nested.instance_eval &block
+          self
+        end
+      end
+    end
+  end
+end

data/lib/spine/routing/syntax/verbs.rb

@@ -0,0 +1,27 @@
+module Spine
+  module Routing
+    module Syntax
+      module Verbs
+        def get(pattern, options)
+          match(pattern, options.merge(verb: :get))
+        end
+
+        def post(pattern, options)
+          match(pattern, options.merge(verb: :post))
+        end
+
+        def put(pattern, options)
+          match(pattern, options.merge(verb: :put))
+        end
+
+        def patch(pattern, options)
+          match(pattern, options.merge(verb: :patch))
+        end
+
+        def delete(pattern, options)
+          match(pattern, options.merge(verb: :delete))
+        end
+      end
+    end
+  end
+end

data/lib/spine/routing/version.rb

@@ -0,0 +1,5 @@
+module Spine
+  module Routing
+    VERSION = "0.1.0"
+  end
+end

data/spec/config/default.rb

@@ -0,0 +1,20 @@
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.order = :random
+
+  Kernel.srand config.seed
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+  end
+end

data/spec/spine/routing/route_spec.rb

@@ -0,0 +1,89 @@
+require 'spine/routing'
+
+module Spine
+  module Routing
+    # TODO:
+    # * variables constraints
+
+    describe Route do
+      subject { Route.new('test', '/testing', handler, :get) }
+
+      let(:handler) { double }
+
+      it 'has name' do
+        expect(subject.name).to eql('test')
+      end
+
+      it 'has pattern' do
+        expect(subject.pattern).to eql('/testing')
+      end
+
+      it 'has app' do
+        expect(subject.app).to be
+      end
+
+      it 'has verb' do
+        expect(subject.verb).to eql(:get)
+      end
+
+      describe 'when matching route' do
+        it 'matches route' do
+          expect(subject.match(:get, '/testing')).to be
+        end
+
+        it 'do not match route' do
+          expect(subject.match(:get, '/testing1')).not_to be
+        end
+
+        it 'do not match route with different verb' do
+          expect(subject.match(:post, '/testing')).not_to be
+        end
+      end
+
+      describe 'when extracting path variables' do
+        subject { Route.new('test', '/testing/:id', handler, :get) }
+
+        it 'parses variable value' do
+          expect(subject.match(:get, '/testing/1').parameters)
+            .to eql(id: '1', format: nil)
+        end
+      end
+
+      describe 'when extracting wildcard variables' do
+        subject { Route.new('test', '/*', handler, :get) }
+
+        it 'parses values' do
+          expect(subject.match(:get, '/testing/1').parameters)
+            .to eql(paths: 'testing/1', format: nil)
+        end
+
+        describe 'and path variables' do
+          subject { Route.new('test', '/:action/*/:id', handler, :get) }
+
+          it 'parses values' do
+            expect(subject.match(:get, '/testing/this/is/some/random/stuff/1').parameters)
+              .to eql(paths: 'this/is/some/random/stuff', action: 'testing', id: '1', format: nil)
+          end
+        end
+
+        describe 'and path variables and wildcard is named' do
+          subject { Route.new('test', '/:action/*stuff/:id', handler, :get) }
+
+          it 'parses variables' do
+            expect(subject.match(:get, '/testing/this/is/some/random/stuff/1').parameters)
+              .to eql(stuff: 'this/is/some/random/stuff', action: 'testing', id: '1', format: nil)
+          end
+        end
+
+        describe 'and path variables and wildcard at the end' do
+          subject { Route.new('test', '/:action/*stuff', handler, :get) }
+
+          it 'parses variables' do
+            expect(subject.match(:get, '/testing/this/is/some/random/stuff').parameters)
+              .to eql(stuff: 'this/is/some/random/stuff', action: 'testing', format: nil)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spine/routing/router_spec.rb

@@ -0,0 +1,81 @@
+require 'spine/routing'
+
+module Spine
+  module Routing
+    describe Router do
+      let(:handler) { double }
+
+      it 'has routes' do
+        expect(subject.routes).to be
+      end
+
+      it 'adds route by get verb' do
+        subject.get('/', to: handler)
+        expect(subject.routes.size).to eql(1)
+        expect(subject.routes.first.verb).to eql(:get)
+      end
+
+      it 'adds route by post verb' do
+        subject.post('/', to: handler)
+        expect(subject.routes.size).to eql(1)
+        expect(subject.routes.first.verb).to eql(:post)
+      end
+
+      it 'adds route by put verb' do
+        subject.put('/', to: handler)
+        expect(subject.routes.size).to eql(1)
+        expect(subject.routes.first.verb).to eql(:put)
+      end
+
+      it 'adds route by patch verb' do
+        subject.patch('/', to: handler)
+        expect(subject.routes.size).to eql(1)
+        expect(subject.routes.first.verb).to eql(:patch)
+      end
+
+      it 'adds route by delete verb' do
+        subject.delete('/', to: handler)
+        expect(subject.routes.size).to eql(1)
+        expect(subject.routes.first.verb).to eql(:delete)
+      end
+
+      it 'adds route in scope' do
+        handler = double
+        subject.scope('level-1') do
+          get('test', to: handler)
+        end
+        expect(subject.routes.size).to eql(1)
+        expect(subject.routes.first.pattern).to eql('/level-1/test')
+      end
+
+      it 'adds route in multiple scopes' do
+        handler = double
+        subject.scope('level-1') do
+          scope('level-2') do
+            get('test', to: handler)
+          end
+        end
+        expect(subject.routes.size).to eql(1)
+        expect(subject.routes.first.pattern).to eql('/level-1/level-2/test')
+      end
+
+      it 'parses variable from scope' do
+        handler = double
+        subject.scope('level-1/:level_id') do
+          get('test', to: handler)
+        end
+        expect(subject.recognise(:get, '/level-1/1/test').parameters)
+          .to eql(level_id: '1', format: nil)
+      end
+
+      it 'parses variable scope' do
+        handler = double
+        subject.scope(':level_id') do
+          get('test', to: handler)
+        end
+        expect(subject.recognise(:get, '/1/test').parameters)
+          .to eql(level_id: '1', format: nil)
+      end
+    end
+  end
+end

data/spine-routing.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spine/routing/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spine-routing"
+  spec.version       = Spine::Routing::VERSION
+  spec.authors       = ["TOGGL LLC"]
+  spec.email         = ["support@toggl.com"]
+  spec.summary       = 'Rack router'
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/rspine/routing'
+  spec.license       = 'BSD-3-Clause'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.add_dependency 'rack', "~> 1.6"
+
+  spec.add_development_dependency 'bundler', "~> 1.7"
+  spec.add_development_dependency 'rake', "~> 10.0"
+  spec.add_development_dependency 'rspec', "~> 3.2"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: spine-routing
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- TOGGL LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: ''
+email:
+- support@toggl.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/spine/routing.rb
+- lib/spine/routing/nested_router.rb
+- lib/spine/routing/route.rb
+- lib/spine/routing/router.rb
+- lib/spine/routing/syntax/match.rb
+- lib/spine/routing/syntax/namespacing.rb
+- lib/spine/routing/syntax/verbs.rb
+- lib/spine/routing/version.rb
+- spec/config/default.rb
+- spec/spine/routing/route_spec.rb
+- spec/spine/routing/router_spec.rb
+- spine-routing.gemspec
+homepage: https://github.com/rspine/routing
+licenses:
+- BSD-3-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Rack router
+test_files:
+- spec/config/default.rb
+- spec/spine/routing/route_spec.rb
+- spec/spine/routing/router_spec.rb