dependor-sinatra 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc
+gems.tags
+tags

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,14 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'ctags-bundler', :src_path => ["lib", "spec"] do
+  watch(/^(lib|spec)\/.*\.rb$/)
+  watch('Gemfile.lock')
+end
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.md

@@ -0,0 +1,9 @@
+# The MIT License (MIT)
+
+Copyright (c) 2012-2013 Adam Pohorecki
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Adam Pohorecki
+
+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,104 @@
+# dependor-sinatra
+
+This gem provides integration between [Dependor][dependor] and [Sinatra][sinatra].
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dependor-sinatra'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dependor-sinatra
+
+## Usage
+
+Require dependor-sinatra:
+
+    require 'dependor-sinatra'
+
+and (optionally), the shortcut notation for defining constructors:
+
+    require 'dependor/shorty'
+
+This teaches Sinatra to inject dependencies into your actions:
+
+```ruby
+class Greeter
+  takes :params
+
+  def greet
+    "Hello, #{params[:name]}!"
+  end
+end
+
+get "/hello/:name" do |greeter|
+  greeter.greet
+end
+```
+
+You can specify your own injector:
+
+```ruby
+# this is exacly how the default injector class (Dependor::Sinatra::DefaultInjector) 
+# looks like
+class MyInjector
+  include Dependor::AutoInject
+  include Dependor::Sinatra::Objects
+
+  def initialize(objects)
+    sinatra_objects(objects)
+  end
+
+  # define anything you want here
+  def user_db
+    User
+  end
+end
+
+injector{ |objects| MyInjector.new(objects) }
+
+get "/" do |user_db|
+  @users = user_db.all
+end
+```
+
+You can dependency injection in the following Sinatra elements:
+
+- routes (`get`, `post`, `put`, etc.)
+- filters (`before`, `after`)
+- conditions (`condition`)
+
+By default, you can inject the following objects from Sinatra:
+
+- params
+- session
+- request
+- response
+- env
+
+You can read more about Dependor [here][dependor].
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+## License
+
+MIT
+
+## Author
+
+Adam Pohorecki (adam [at] pohorecki [dot] pl)
+
+[dependor]: https://github.com/psyho/dependor
+[sinatra]: http://sinatrarb.com

data/Rakefile

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

data/dependor-sinatra.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dependor-sinatra/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "dependor-sinatra"
+  gem.version       = Dependor::Sinatra::VERSION
+  gem.authors       = ["Adam Pohorecki"]
+  gem.email         = ["adam@pohorecki.pl"]
+  gem.description   = %q{An extension to Sinatra enabling dependency injection}
+  gem.summary       = %q{An extension to Sinatra enabling dependency injection}
+  gem.homepage      = "https://github.com/psyho/dependor-sinatra"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'dependor'
+  gem.add_dependency 'sinatra'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'guard-ctags-bundler'
+  gem.add_development_dependency 'growl'
+  gem.add_development_dependency 'rb-inotify', '~> 0.8.8'
+  gem.add_development_dependency 'relish'
+  gem.add_development_dependency 'rack-test'
+end

data/examples/hello.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require "sinatra"
+require "dependor-sinatra"
+require "dependor/shorty"
+
+class Greeter
+  takes :params
+
+  def greet
+    "Hello, #{params[:name]}!"
+  end
+end
+
+get "/hello/:name" do |greeter|
+  greeter.greet
+end

data/lib/dependor-sinatra.rb

@@ -0,0 +1,10 @@
+require "sinatra"
+require "dependor"
+
+require "dependor-sinatra/block_wrapper"
+require "dependor-sinatra/enabler"
+require "dependor-sinatra/has_injector"
+require "dependor-sinatra/objects"
+require "dependor-sinatra/version"
+require "dependor-sinatra/default_injector"
+require "dependor-sinatra/monkey_patches"

data/lib/dependor-sinatra/block_wrapper.rb

@@ -0,0 +1,13 @@
+module Dependor
+  module Sinatra
+    module BlockWrapper
+      def self.wrap(block)
+        proc do
+          dependency_names = block.parameters.map(&:last)
+          dependencies = dependency_names.map{|name| injector.__send__(name)}
+          instance_exec(*dependencies, &block)
+        end
+      end
+    end
+  end
+end

data/lib/dependor-sinatra/default_injector.rb

@@ -0,0 +1,12 @@
+module Dependor
+  module Sinatra
+    class DefaultInjector
+      include Dependor::AutoInject
+      include Dependor::Sinatra::Objects
+
+      def initialize(objects)
+        sinatra_objects(objects)
+      end
+    end
+  end
+end

data/lib/dependor-sinatra/enabler.rb

@@ -0,0 +1,19 @@
+module Dependor
+  module Sinatra
+    module Enabler
+      def enable_dependor(method)
+        without_dependor = :"#{method}_without_dependor"
+
+        # the only way to alias a private method
+        instance_eval("alias #{without_dependor} #{method}")
+
+        define_singleton_method(method) do |*args, &block|
+          wrapped_block = Dependor::Sinatra::BlockWrapper.wrap(block)
+          __send__(without_dependor, *args) do
+            instance_eval(&wrapped_block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dependor-sinatra/has_injector.rb

@@ -0,0 +1,25 @@
+module Dependor
+  module Sinatra
+    module HasInjector
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      def injector
+        @injector ||= self.class.injector_creator.call(self)
+      end
+
+      module ClassMethods
+        attr_writer :injector_creator
+
+        def injector_creator
+          @injector_creator ||= proc{ |objects| Dependor::Sinatra::DefaultInjector.new(objects) }
+        end
+
+        def injector(&block)
+          self.injector_creator = block
+        end
+      end
+    end
+  end
+end

data/lib/dependor-sinatra/monkey_patches.rb

@@ -0,0 +1,9 @@
+class Sinatra::Base
+  include Dependor::Sinatra::HasInjector
+  extend Dependor::Sinatra::Enabler
+  enable_dependor :route
+  enable_dependor :add_filter
+  enable_dependor :condition
+end
+
+Sinatra::Delegator.delegate :injector

data/lib/dependor-sinatra/objects.rb

@@ -0,0 +1,15 @@
+module Dependor
+  module Sinatra
+    module Objects
+      attr_reader :params, :env, :request, :response, :session
+
+      def sinatra_objects(objects)
+        @params = objects.params
+        @env = objects.env
+        @request = objects.request
+        @response = objects.response
+        @session = objects.session
+      end
+    end
+  end
+end

data/lib/dependor-sinatra/version.rb

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

data/spec/integration/before_and_after_filters_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+class SetsCurrentUser
+  takes :params
+
+  def set(name)
+    params[:current_user] = name
+  end
+end
+
+class AppWithFilters < Sinatra::Base
+  set :environment, :test
+
+  before "/hello" do |sets_current_user|
+    sets_current_user.set("John")
+  end
+
+  after "/bye" do |sets_current_user|
+    sets_current_user.set("Betty")
+    body "After bye, #{params[:current_user]}"
+  end
+
+  get "/hello" do
+    body "Hello, #{params[:current_user]}"
+  end
+
+  get "/bye" do
+    body "Bye"
+  end
+end
+
+describe "Before and after filters" do
+  let(:app) { AppWithFilters }
+
+  it "injects dependencies into before filters" do
+
+    get "/hello"
+
+    last_response.body.should == "Hello, John"
+  end
+
+  it "injects dependencies into after filters" do
+    get "/bye"
+
+    last_response.body.should == "After bye, Betty"
+  end
+end

data/spec/integration/conditions_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+class ChecksIfAdmin
+  takes :session
+
+  def admin?
+    !!session[:admin]
+  end
+end
+
+class AppWithConditions < Sinatra::Base
+  set(:admin_user) do |is_admin|
+    condition do |checks_if_admin|
+      checks_if_admin.admin? == is_admin
+    end
+  end
+
+  set :environment, :test
+  enable :sessions
+
+  post "/login" do
+    session[:admin] = true
+    "Hello!"
+  end
+
+  get "/admin", admin_user: true do
+    "Hello admin"
+  end
+
+  get "/admin", admin_user: false do
+    "Bye intruder"
+  end
+end
+
+describe "conditions" do
+  let(:app) { AppWithConditions }
+
+  it "injects objects into the conditions" do
+    post "/login"
+    get "/admin"
+
+    last_response.body.should == "Hello admin"
+  end
+end

data/spec/integration/custom_injector_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+class AppWithCustomInjector < Sinatra::Base
+  injector{ |o| MyCustomInjector.new(o) }
+
+  get "/hello" do |current_user|
+    "Hello, #{current_user}!"
+  end
+end
+
+class MyCustomInjector < Dependor::Sinatra::DefaultInjector
+  def current_user
+    "John"
+  end
+end
+
+describe "providing a custom injector" do
+  let(:app) { AppWithCustomInjector }
+
+  it "injects objects from the injector" do
+    get "/hello"
+
+    last_response.body.should == "Hello, John!"
+  end
+end

data/spec/integration/injecting_sinatra_provided_data_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe "Injecting Sinatra provided data" do
+  class Greeter
+    takes :params
+
+    def greet
+      "Hello, #{params[:name]}!"
+    end
+  end
+
+  class SinatraAppWithDependor < Sinatra::Base
+    set :environment, :test
+
+    get "/hello/:name" do |greeter|
+      greeter.greet
+    end
+  end
+
+  let(:app) { SinatraAppWithDependor }
+
+  it "uses the injected objects to generate a response" do
+    get "/hello/foo"
+
+    last_response.body.should == "Hello, foo!"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rack/test'
+require 'dependor-sinatra'
+require 'dependor/shorty'
+
+RSpec.configure do |c|
+  c.color_enabled = true
+  c.include Rack::Test::Methods
+end

metadata

@@ -0,0 +1,254 @@
+--- !ruby/object:Gem::Specification
+name: dependor-sinatra
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Adam Pohorecki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dependor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-ctags-bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: growl
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+- !ruby/object:Gem::Dependency
+  name: relish
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An extension to Sinatra enabling dependency injection
+email:
+- adam@pohorecki.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- dependor-sinatra.gemspec
+- examples/hello.rb
+- lib/dependor-sinatra.rb
+- lib/dependor-sinatra/block_wrapper.rb
+- lib/dependor-sinatra/default_injector.rb
+- lib/dependor-sinatra/enabler.rb
+- lib/dependor-sinatra/has_injector.rb
+- lib/dependor-sinatra/monkey_patches.rb
+- lib/dependor-sinatra/objects.rb
+- lib/dependor-sinatra/version.rb
+- spec/integration/before_and_after_filters_spec.rb
+- spec/integration/conditions_spec.rb
+- spec/integration/custom_injector_spec.rb
+- spec/integration/injecting_sinatra_provided_data_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/psyho/dependor-sinatra
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 206932367
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 206932367
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: An extension to Sinatra enabling dependency injection
+test_files:
+- spec/integration/before_and_after_filters_spec.rb
+- spec/integration/conditions_spec.rb
+- spec/integration/custom_injector_spec.rb
+- spec/integration/injecting_sinatra_provided_data_spec.rb
+- spec/spec_helper.rb