rack_router 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 371f49e5b4147144b7ea7237e66f2defafc621d99022b15031914f2f3011a2c4
+  data.tar.gz: 34d45cdc026561b2dd944b0d1bf438edb9a5997f25a0f994d934d7fb953c342e
+SHA512:
+  metadata.gz: a2e3780125208f53c537cce13dbe45ae10c147236eaba0df876a12a92678f94dcc2b1c019afc88b656020f7c517593fd1e88f3bf9d34414469eae832d781e32e
+  data.tar.gz: 21187ed1a1b03f411fa25038259104d6817ceb3ecd940c99e75f585c5b3aae982d9e3ae284d990e9c5b573a9c503de052a0119c6d6deaa6e2cdaafd182a5d1c1

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.7
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Change log
+
+## 0.1.0 (2020-01-08)
+* initial version

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at senid231@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rack_router.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'minitest', '~> 5.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Denis Talakevich
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# RackRouter
+
+Simple and functional rack middleware for routing requests.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack_router'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rack_router
+
+## Usage
+
+`config.ru`
+```ruby
+class App
+  def call(env)
+    method_name = env[Rack::Router::RACK_ROUTER_PATH]
+    public_send(method_name, env)
+  end
+
+  def posts_index(env)
+    [200, {}, ['OK']]
+  end
+
+  def posts_show(env)
+    id = env[Rack::Router::RACK_ROUTER_PATH_HASH][:id]
+    [200, {}, ['OK']]
+  end
+
+  def posts_create(env)
+    [201, {}, ['Created']]
+  end
+
+  def posts_update(env)
+    id = env[Rack::Router::RACK_ROUTER_PATH_HASH][:id]
+    [200, {}, ['Updated']]
+  end
+
+  def posts_destroy(env)
+    id = env[Rack::Router::RACK_ROUTER_PATH_HASH][:id]
+    [204, {}, []]
+  end
+end
+
+app = Rack::Builder.new do
+  use Rack::Router::Middleware do
+    get '/posts', 'posts_index'
+    get '/posts/:id', 'posts_show'
+    post '/posts', 'posts_create'
+    put '/posts/:id', 'posts_update'
+    delete '/posts/:id', 'posts_destroy'
+  end
+
+  run App.new
+end
+run app
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/senid231/rack_router. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rack_router/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RackRouter project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rack_router/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rack_router"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rack/router.rb

@@ -0,0 +1,12 @@
+require 'rack'
+require 'rack/router/route'
+require 'rack/router/route_builder'
+require 'rack/router/path_part'
+require 'rack/router/middleware'
+
+module Rack
+  module Router
+    RACK_ROUTER_PATH = 'rack.router.path'.freeze
+    RACK_ROUTER_PATH_HASH = 'rack.router.path_hash'.freeze
+  end
+end

data/lib/rack/router/middleware.rb

@@ -0,0 +1,128 @@
+require 'logger'
+
+module Rack
+  module Router
+    class Middleware
+      attr_reader :logger
+
+      def initialize(app, logger: nil, &block)
+        @app = app
+        @routes = RouteBuilder.new
+        @current_path = nil
+        @current_options = {}
+        @not_found = nil
+        @logger = logger || Logger.new(STDOUT)
+        @callbacks = []
+        instance_exec(&block)
+      end
+
+      def call(env)
+        route = @routes.match(env)
+        env[RACK_ROUTER_PATH] = route&.value
+        env[RACK_ROUTER_PATH_HASH] = route&.path_hash env[Rack::PATH_INFO]
+        run_after_route(env, route)
+
+        if route.nil? && !@not_found.nil?
+          logger.debug { "#{self.class}#call route was not found\n#{@routes.print_routes}" }
+          return render_not_found(env)
+        end
+
+        @app.call(env)
+      end
+
+      [:get, :post, :put, :patch, :delete, :option, :head].each do |http_method|
+        # @param path [String]
+        # @param value [String, Proc<Hash>]
+        # @param options [Hash<Symbol>,Hash]
+        #   :constraint [Hash<Symbol=>Proc<String>>]
+        #   :content_type [Array<String>,String]
+        define_method(http_method) do |path, value, options = {}|
+          define_path(http_method, path, value, options)
+        end
+      end
+
+      def match(path, value, options = {})
+        define_path(nil, path, value, options)
+      end
+
+      # @param path [String]
+      # @param options [Hash<Symbol>,Hash]
+      #   :constraint [Hash<Symbol=>Proc<String>>]
+      #   :content_type [String, Array<String>]
+      def nested(path, options = {})
+        old_current_path = @current_path
+        old_current_options = @current_options
+        @current_path = [@current_path, path].compact.join('/')
+        @current_options = @current_options.dup.merge(options)
+        yield
+      ensure
+        @current_path = old_current_path
+        @current_options = old_current_options
+      end
+
+      # @param path [String]
+      def namespace(path, &block)
+        nested(path, {}, &block)
+      end
+
+      # @param constraint [Hash<Symbol,Proc<String>>]
+      def with_constraint(constraint, &block)
+        nested(nil, constraint: constraint, &block)
+      end
+
+      # @param content_type [String, Array<String>]
+      def with_content_type(content_type, &block)
+        nested(nil, content_type: content_type, &block)
+      end
+
+      # @param accept [String, Array<String>]
+      def with_accept(accept, &block)
+        nested(nil, accept: accept, &block)
+      end
+
+      # @param http_method [String,Symbol]
+      # @param path [String]
+      # @param value [String, Proc<Hash>]
+      # @param options [Hash]
+      #   :constraint [Hash<Symbol=>Proc<String>>]
+      #   :content_type [Array<String>,String]
+      def define_path(http_method, path, value, options = {})
+        options = @current_options.dup.merge(options)
+        path = [@current_path, path].reject(&:empty?).join('/')
+        @routes.add(http_method, path, value, options)
+      end
+
+      def not_found(response)
+        response = default_not_found if response == :default
+        response = nil unless response
+        @not_found = response
+      end
+
+      # @yield after route match executed
+      # @yieldparam env [Hash]
+      # @yieldparam route [Rack::Router::Route, NilClass]
+      def after_route(&block)
+        raise ArgumentError, 'block must be given' unless block_given?
+
+        @callbacks.push(block)
+      end
+
+      private
+
+      def run_after_route(env, route)
+        @callbacks.each do |cb|
+          instance_exec(env, route, &cb)
+        end
+      end
+
+      def default_not_found
+        [404, { Rack::CONTENT_TYPE => 'text/plain' }, ['Route not found']]
+      end
+
+      def render_not_found(env)
+        return @not_found.call(env) if @not_found.is_a?(Proc)
+        @not_found
+      end
+    end
+  end
+end

data/lib/rack/router/path_part.rb

@@ -0,0 +1,18 @@
+module Rack
+  module Router
+    class PathPart
+      attr_reader :constraint
+
+      def initialize(constraint)
+        @constraint = constraint
+      end
+
+      def ==(str)
+        return true if constraint.nil?
+        !!constraint.call(str)
+      rescue TypeError, ArgumentError
+        false
+      end
+    end
+  end
+end

data/lib/rack/router/route.rb

@@ -0,0 +1,51 @@
+module Rack
+  module Router
+    # Route = Struct.new(:http_method, :path, :path_parts, :value, :constraint, :content_type) do
+    #   def value_for(env)
+    #     return value unless value.is_a?(Proc)
+    #     value.call(env)
+    #   end
+    # end
+
+
+    class Route
+      attr_reader :http_method, :path, :path_parts, :value, :constraint, :content_type, :accept
+
+      def initialize(http_method:, path:, value:, constraint: nil, content_type: nil, accept: nil)
+        @http_method = http_method.to_s.upcase
+        @path = path
+        @value = value
+        @constraint = constraint
+        @content_type = content_type ? Array.wrap(content_type) : nil
+        @accept = accept ? Array.wrap(accept) : nil
+        @path_parts = calculate_path_parts
+      end
+
+      def path_hash(request_path)
+        request_path = request_path.to_s.gsub(/\..*\z/, '')
+        request_path_parts = request_path.split('/').reject(&:empty?)
+        pairs = path.split('/').map.with_index do |part, idx|
+          next if part[0] != ':'
+          [part[1..-1].to_sym, request_path_parts[idx]]
+        end
+        pairs.reject(&:nil?).to_h
+      end
+
+      def print_route
+        str = "\t#{http_method} \t#{path}"
+        str += "\tcontent_type=[#{content_type.join(',')}]" unless content_type.nil?
+        str += "\taccept=[#{content_type.join(',')}]" unless accept.nil?
+        str
+      end
+
+      private
+
+      def calculate_path_parts
+        path.split('/').map do |part|
+          next part if part[0] != ':'
+          PathPart.new constraint&.fetch(part[1..-1].to_sym, nil)
+        end
+      end
+    end
+  end
+end

data/lib/rack/router/route_builder.rb

@@ -0,0 +1,58 @@
+module Rack
+  module Router
+    class RouteBuilder
+      def initialize
+        @routes = []
+      end
+
+      # @param http_method [Symbol,String]
+      # @param path [String]
+      # @param value [String, Proc<Hash>]
+      # @param options [Hash]
+      #   :constraint [Hash<Symbol,Proc<String>>]
+      #   :content_type [Array<String>,String]
+      def add(http_method, path, value, options = {})
+        path = path.split('/').reject(&:empty?).join('/')
+        route = Route.new(
+            http_method: http_method.to_s.upcase,
+            path: path,
+            value: value,
+            **options
+        )
+        @routes.push(route)
+        route
+      end
+
+      def match(env)
+        http_method = env[Rack::REQUEST_METHOD]
+        path = env[Rack::PATH_INFO].to_s.gsub(/\..*\z/, '')
+        content_type, *_ = env['CONTENT_TYPE'].to_s.split(';')
+        content_type = nil if !content_type.nil? && content_type.empty?
+        accept, *_ = env['HTTP_ACCEPT'].to_s.split(';')
+        accept = accept.to_s.split(',')
+
+        match_request(http_method, path, content_type: content_type, accept: accept)
+      end
+
+      # @param http_method [String] upcase GET POST PUT PATCH DELETE HEAD
+      # @param path [String]
+      # @param content_type [String, NilClass]
+      # @param accept [Array]
+      def match_request(http_method, path, content_type: nil, accept: [])
+        path_parts = path.split('/').reject(&:empty?)
+        @routes.detect do |route|
+          next false if route.http_method && route.http_method != http_method
+          next false if route.content_type && route.content_type.include?(content_type)
+          next false if route.accept && (route.accept & accept).empty? && !accept.include?('*/*')
+          next false if route.path_parts.size != path_parts.size
+          next false if route.path_parts.map.with_index { |part, idx| part != path_parts[idx] }.any?
+          true
+        end
+      end
+
+      def print_routes
+        "Routes (#{@routes.size}):\n" + @routes.map(&:print_route).join("\n") + "\n"
+      end
+    end
+  end
+end

data/lib/rack/router/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module Router
+    VERSION = '0.1.0'
+  end
+end

data/lib/rack_router.rb

@@ -0,0 +1 @@
+require 'rack/router'

data/rack_router.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/rack/router/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack_router'
+  spec.version       = Rack::Router::VERSION
+  spec.authors       = ['Denis Talakevich']
+  spec.email         = ['senid231@gmail.com']
+
+  spec.summary       = 'Rack middleware for routing requests.'
+  spec.description   = 'Simple and functional rack middleware for routing requests.'
+  spec.homepage      = 'https://github.com/senid231/rack_router'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rack'
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: rack_router
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Denis Talakevich
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple and functional rack middleware for routing requests.
+email:
+- senid231@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack/router.rb
+- lib/rack/router/middleware.rb
+- lib/rack/router/path_part.rb
+- lib/rack/router/route.rb
+- lib/rack/router/route_builder.rb
+- lib/rack/router/version.rb
+- lib/rack_router.rb
+- rack_router.gemspec
+homepage: https://github.com/senid231/rack_router
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/senid231/rack_router
+  source_code_uri: https://github.com/senid231/rack_router
+  changelog_uri: https://github.com/senid231/rack_router/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Rack middleware for routing requests.
+test_files: []