rack-current 1.0.0

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Charles Lowell
+
+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,29 @@
+# CurrentRequest
+
+Sometimes, in the coures of human events, you need to access the currently executing http request, and you
+don't always have the luxury of passing it around, especially when you're working with frameworks that manage
+the lifecycle of objects for you, or you want to include functionality from a module. That module might not have
+a clean way of getting a reference to the request object.
+
+### CurrentRequest can help
+
+CurrentRequest stores the current request in a thread local so that you can access it from anywhere inside the
+request stack.
+
+### Oooh. Thread locals, those are dangerous I hear.
+
+Not really. There are certain objects whose natural scope is the lifetime of an http request. The http request object
+itself is one such object. As long as the thread is the fundamental unit of concurrency in your server, you'll be ok.
+
+That said, you should ensure that you are in fact including this into methods that will be invoked inside the request
+stack, and not, say, like a background job (like sending email) that is fired off during the course of a request.
+
+### Example
+
+        class Foo
+          include CurrentRequest
+
+          def current_url
+            "#{current_request.protocol}://#{current_request.host}/#{current_request.path}
+          end
+        end

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/rack-current.rb

@@ -0,0 +1,8 @@
+require "rack-current/version"
+require 'rack-current/middleware'
+
+module Rack::Current
+  def current_request
+    Thread.current[:_current_request]
+  end
+end

data/lib/rack-current/middleware.rb

@@ -0,0 +1,25 @@
+require 'rack'
+
+module Rack::Current
+  class Middleware
+    include Rack::Current
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      before = self.current_request
+      self.current_request = Rack::Request.new(env)
+      @app.call(env)
+    ensure
+      self.current_request = before
+    end
+
+    private
+
+    def current_request=(request)
+      Thread.current[:_current_request] = request
+    end
+  end
+end

data/lib/rack-current/version.rb

@@ -0,0 +1,3 @@
+module CurrentRequest
+  VERSION = "1.0.0"
+end

data/rack-current.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rack-current/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["The Frontside Software"]
+  gem.email         = ["info@thefrontside.net"]
+  gem.description   = %q{Get the Currently running Rack::Request from anywhere inside the request-thread}
+  gem.summary       = %q{Reach out and grab the current Rack::Request just by including CurrentRequest}
+  gem.homepage      = "https://github.com/thefrontside/rack-current"
+
+  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.name          = "rack-current"
+  gem.require_paths = ["lib"]
+  gem.version       = CurrentRequest::VERSION
+
+  gem.add_dependency 'rack'
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+end

data/spec/current_request_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'rack-current'
+describe Rack::Current::Middleware do
+  describe "inside an application's middleware stack" do
+    include Rack::Current
+    before do
+      @app = mock(:app)
+      @middleware = Rack::Current::Middleware.new(@app)
+    end
+    describe "when I invoke it" do
+      before do
+        @app.stub(:call) do |env|
+          @env = env
+          @current_request = current_request
+        end
+        @middleware.call({:request => :env})
+      end
+      it "makes the current request available" do
+        @current_request.should be_kind_of Rack::Request
+        @current_request.env.should eql ({:request => :env})
+      end
+      it "invokes the upstream app" do
+        @env.should eql ({:request => :env})
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+$:.unshift File.expand_path '../../lib', __FILE__

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: rack-current
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- The Frontside Software
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  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'
+description: Get the Currently running Rack::Request from anywhere inside the request-thread
+email:
+- info@thefrontside.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rack-current.rb
+- lib/rack-current/middleware.rb
+- lib/rack-current/version.rb
+- rack-current.gemspec
+- spec/current_request_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/thefrontside/rack-current
+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: 4398315886198829610
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4398315886198829610
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Reach out and grab the current Rack::Request just by including CurrentRequest
+test_files:
+- spec/current_request_spec.rb
+- spec/spec_helper.rb