sinatra-bind 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3a615b6b16da64b73b4d395f04147811c80ffba3
+  data.tar.gz: a8fb7f8e65c7d70bc4baa72e944b37151cc4ef11
+SHA512:
+  metadata.gz: 5d6eba1c68520c0ba2259b2ef701eda4ecadeb5ba13f01c979d870e0c9c900446ce7a66f0f638f4f14e3ae52b5444bfcf175bc8e55e45a94c0bbe1e78dd72890
+  data.tar.gz: df0d55386c2304f1232edc80d69a9fa9e03f17ebd42f1500df2387c2e9be4016c9b3526a569d9bd5cbd9746c95c1c7fd57f353b49242f5da6e1d8717eec16ce4

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,20 @@
+lang: ruby
+before_install: gem install bundler --pre
+install:
+  - gem update --system
+  - bundle update
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - jruby-head
+  - rbx
+notifications:
+  recipients:
+    - namusyaka@gmail.com
+branches:
+  only:
+    - master
+matrix:
+  allow_failures:
+    - rvm: rbx
+    - rvm: jruby-head

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sinatra-bind.gemspec
+gemspec
+
+gem 'sinatra'
+gem 'rack-test'
+gem 'minitest'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 namusyaka
+
+MIT License
+
+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,76 @@
+# Sinatra::Bind
+
+[![Build Status](https://travis-ci.org/namusyaka/sinatra-bind.svg)](https://travis-ci.org/namusyaka/sinatra-bind)
+
+Binds instance method to routes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sinatra-bind'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sinatra-bind
+
+## Usage
+
+You can define a route without block smoothly.
+
+```ruby
+class App < Sinatra::Base
+  register Sinatra::Bind
+
+  def index
+    "hello world"
+  end
+
+  on "/", to: :index
+end
+```
+
+If specified the :type option, it will be used as request method.
+
+```ruby
+class App < Sinatra::Base
+  register Sinatra::Bind
+
+  def index
+    "hello world"
+  end
+
+  on "/", to: :index, type: :post
+end
+```
+
+If passed `:before` or `:after` inn the `:type` option, it will be added as the filters.
+
+```ruby
+class App < Sinatra::Base
+  register Sinatra::Bind
+
+  def before_index
+    @foo = "bob"
+  end
+
+  def index
+    "hello #{@foo}"
+  end
+
+  on "/", to: :before_index, type: :before
+  on "/", to: :index
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/namusyaka/sinatra-bind/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << "test"
+  test.test_files = Dir['test/*_test.rb']
+  test.verbose = true
+end
+task default: :test
+

data/lib/sinatra-bind.rb

@@ -0,0 +1 @@
+require 'sinatra/bind'

data/lib/sinatra/bind.rb

@@ -0,0 +1,87 @@
+require "sinatra/bind/version"
+
+module Sinatra
+  module Bind
+    # Sinatra::Bind enables to define a route by using instance method.
+    # In other words, you can define a route without block.
+    #
+    # @example
+    #   module AwesomeMethods
+    #     def before_article
+    #       @ex = params['id'] * "!"
+    #     end
+    #
+    #     def find_article(id)
+    #       "Article##{id} #{@ex}"
+    #     end
+    #   end
+    #
+    #   class App < Sinatra::Base
+    #     include AwesomeMethods
+    #
+    #     def index
+    #       "hello world"
+    #     end
+    #
+    #     on "/", to: :index
+    #
+    #     on "/articles/:id", to: :before_article, type: :before
+    #     on "/articles/:id", to: :find_article
+    #   end
+    def self.registered(app)
+      app.extend ClassMethods
+    end
+
+    module ClassMethods
+      FILTER_NAMES = ['BEFORE', 'AFTER'].freeze
+
+      # Defines a route without block smoothly
+      # @param  [String] path
+      # @option [String, Symbol] :to The method name that must be defined as instance method.
+      # @option [String, Symbol] :type The verb means REQUEST_METHOD, also can be received as filter names.
+      def on(path, options = {})
+        verb = (options.delete(:type) || 'GET').to_s.upcase
+        return bound_filter(verb, path, options) if FILTER_NAMES.include?(verb)
+        method_name = options.delete(:to)
+        process_bound_route(verb, path, method_name) do
+          method = instance_method(method_name)
+          bound_route(verb, path, options.merge(method_name: "#{verb} #{method_name}"), method)
+        end
+      end
+
+      def bound_route(verb, path, options, method)
+        host_name(options.delete(:host)) if options.key?(:host)
+        signature = compile_bound_route!(verb, path, method, options)
+        (@routes[verb] ||= []) << signature
+        invoke_hook(:route_added, verb, path, method)
+        signature
+      end
+
+      def bound_filter(type, path, options)
+        path, options = //, path if path.respond_to?(:each_pair)
+        method = instance_method(options.delete(:to))
+        filters[type.downcase.to_sym] << compile_bound_route!(type, path || //, method, options)
+      end
+
+      def compile_bound_route!(verb, path, unbound_method, options)
+        method_name = options.delete(:method_name)
+        options.each_pair { |option, args| send(option, *args) }
+        pattern, keys = compile path
+        conditions, @conditions = @conditions, []
+        wrapper = unbound_method.arity != 0 ?
+          proc { |a,p| unbound_method.bind(a).call(*p) } :
+          proc { |a,p| unbound_method.bind(a).call }
+        wrapper.instance_variable_set(:@route_name, method_name)
+        [ pattern, keys, conditions, wrapper ]
+      end
+
+      def process_bound_route(verb, path, method_name)
+        return yield unless verb == 'GET'
+        conditions = @conditions.dup; yield; @conditions = conditions
+        on path, to: method_name, type: 'HEAD'
+      end
+
+      private :bound_route, :bound_filter, :compile_bound_route!, :process_bound_route
+    end
+  end
+end

data/lib/sinatra/bind/version.rb

@@ -0,0 +1,5 @@
+module Sinatra
+  module Bind
+    VERSION = "0.0.1"
+  end
+end

data/sinatra-bind.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sinatra/bind/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sinatra-bind"
+  spec.version       = Sinatra::Bind::VERSION
+  spec.authors       = ["namusyaka"]
+  spec.email         = ["namusyaka@gmail.com"]
+  spec.summary       = %q{Binds instance method on routes}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/namusyaka/sinatra-bind"
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/test/bind_test.rb

@@ -0,0 +1,86 @@
+$:.unshift(File.dirname(__FILE__))
+require 'helper'
+
+describe Sinatra::Bind do
+  describe "basic usage" do
+    it "can define a route" do
+      mock_app do
+        def hello; "Hello World" end
+        on "/", to: :hello
+      end
+      get '/'
+      assert_equal 'Hello World', last_response.body
+    end
+
+    it "can define a route correctly even if path contains named params" do
+      mock_app do
+        def show(id, type); "id: #{id}, type: #{type}" end
+        on "/show/:id/:type", to: :show
+      end
+      get '/show/1234/frank'
+      assert_equal 'id: 1234, type: frank', last_response.body
+    end
+
+    it "should support instance variable sharing" do
+      mock_app do
+        before("/foo"){ @a = "hey" }
+        def hey; @a end
+        on "/foo", to: :hey
+      end
+      get '/foo'
+      assert_equal 'hey', last_response.body
+    end
+
+    it "can define a filter" do
+      mock_app do
+        def bar; @b = "bar" end
+        def show_bar; @b end
+        on "/bar", to: :bar, type: :before
+        on "/bar", to: :show_bar
+      end
+      get '/bar'
+      assert_equal 'bar', last_response.body
+    end
+  end
+
+  describe "compatbility with sinatra" do
+    it "can use route options" do
+      mock_app do
+        require 'json'
+        def hello; JSON.dump(:a => "b") end
+        on "/", to: :hello, provides: :json
+      end
+      get "/"
+      assert_equal "application/json", last_response.headers["Content-Type"]
+      assert_equal '{"a":"b"}', last_response.body
+    end
+
+    it "should add the HEAD route if the GET route is added" do
+      mock_app do
+        def hello; "hello world" end
+        on "/", to: :hello
+      end
+      head "/"
+      assert_equal 200, last_response.status
+    end
+
+    it "should invoke the :route_added hook when route is added" do
+      module RouteAddedTest
+        @routes, @procs = [], []
+        def self.routes ; @routes ; end
+        def self.procs ; @procs ; end
+        def self.route_added(verb, path, proc)
+          @routes << [verb, path]
+          @procs << proc
+        end
+      end
+      app = mock_app do
+        register RouteAddedTest
+        def hello; "hello world" end
+        on "/", to: :hello
+      end
+      assert_equal RouteAddedTest.routes, [["GET", "/"], ["HEAD", "/"]]
+      assert_equal RouteAddedTest.procs,  [app.send(:instance_method, :hello)] * 2
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,28 @@
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'rack/test'
+require 'sinatra/base'
+require 'sinatra/bind'
+
+class Sinatra::Base
+  include MiniTest::Assertions
+  register Sinatra::Bind
+end
+
+class MiniTest::Spec
+  include Rack::Test::Methods
+
+  class << self
+    alias context describe
+  end
+
+  def app
+    Rack::Lint.new(@app)
+  end
+
+  def mock_app(base = Sinatra::Base, &block)
+    @app = Sinatra.new(base, &block)
+    @app.set :logging, false
+  end
+end
+

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-bind
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- namusyaka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Binds instance method on routes
+email:
+- namusyaka@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sinatra-bind.rb
+- lib/sinatra/bind.rb
+- lib/sinatra/bind/version.rb
+- sinatra-bind.gemspec
+- test/bind_test.rb
+- test/helper.rb
+homepage: https://github.com/namusyaka/sinatra-bind
+licenses:
+- MIT
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Binds instance method on routes
+test_files:
+- test/bind_test.rb
+- test/helper.rb
+has_rdoc: