request_store 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/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - rbx-19mode
+  - jruby-19mode
+  - ruby-head
+  - 1.8.7
+  - ree

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Steve Klabnik
+
+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,77 @@
+# RequestStore [![build status](https://secure.travis-ci.org/steveklabnik/request_store.png?branch=master)](https://secure.travis-ci.org/steveklabnik/request_store) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/steveklabnik/request_store)
+
+Ever needed to use a global variable in Rails? Ugh, that's the worst. If you
+need gobal state, you've probably reached for `Thread.current`. Like this:
+
+```
+def self.foo
+  Thread.current[:foo] ||= 0
+end
+
+def self.foo=(value)
+  Thread.current[:foo] = value
+end
+```
+
+Ugh! I hate it. But you gotta do what you gotta do...
+
+### The problem
+
+Everyone's worrying about concurrency these days. So people are using those
+fancy threaded web servers, like Thin or Puma. But if you use `Thread.current`,
+and you use one of those servers, watch out! Values can stick around longer
+than you'd expect, and this can cause bugs. For example, if we had this in
+our controller:
+
+```
+def index
+  Thread.current[:counter] ||= 0
+  Thread.current[:counter] += 1
+  
+  render :text => Thread.current[:counter]
+end
+```
+
+If we ran this on MRI with Webrick, you'd get `1` as output, every time. But if
+you run it with Thin, you get `1`, then `2`, then `3`...
+
+### The solution
+
+Add this line to your application's Gemfile:
+
+    gem 'request_store'
+
+And change the code to this:
+
+```
+def index
+  RequestStore.store[:foo] ||= 0
+  RequestStore.store[:foo] += 1
+
+  render :text => RequestStore.store[:foo]
+end
+```
+
+Yep, everywhere you used `Thread.current` just change it to
+`RequestStore.store`. Now no matter what server you use, you'll get `1` every
+time: the storage is local to that request.
+
+### No Rails? No Problem!
+
+A Railtie is added that configures the Middleware for you, but if you're not
+using Rails, no biggie! Just use the Middelware yourself, however you need.
+You'll probably have to shove this somewhere:
+
+```
+use RequestStore::Middleware
+```
+
+## 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
+
+Don't forget to run the tests with `rake`.

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.test_files = FileList['test/*_test.rb']
+  t.ruby_opts = ['-r./test/test_helper.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/request_store.rb

@@ -0,0 +1,21 @@
+require "request_store/version"
+
+require "request_store/railtie" if defined?(Rails)
+
+module RequestStore
+  def self.store
+    Thread.current[:request_store] ||= {}
+    Thread.current[:request_store]
+  end
+
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+    
+    def call(env)
+      Thread.current[:request_store] = {}
+      @app.call(env)
+    end
+  end
+end

data/lib/request_store/railtie.rb

@@ -0,0 +1,7 @@
+module RequestStore
+  class Railtie < Rails::Railtie
+    initializer "request_store.insert_middleware" do |app|
+      app.config.middleware.use RequestStore::Middleware
+    end
+  end
+end

data/lib/request_store/version.rb

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

data/request_store.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'request_store/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "request_store"
+  gem.version       = RequestStore::VERSION
+  gem.authors       = ["Steve Klabnik"]
+  gem.email         = ["steve@steveklabnik.com"]
+  gem.description   = %q{RequestStore gives you per-request global storage.}
+  gem.summary       = %q{RequestStore gives you per-request global storage.}
+  gem.homepage      = "http://github.com/steveklabnik/request_store"
+
+  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_development_dependency "rake"
+  gem.add_development_dependency 'minitest', '~> 3.0'
+end

data/test/request_store_test.rb

@@ -0,0 +1,28 @@
+require 'minitest/autorun'
+
+require 'request_store'
+
+class RequestStoreTest < Minitest::Unit::TestCase
+  def test_quacks_like_hash
+    RequestStore.store[:foo] = 1
+    assert_equal 1, RequestStore.store[:foo]
+    assert_equal 1, RequestStore.store.fetch(:foo)
+  end
+
+  def test_delegates_to_thread
+    RequestStore.store[:foo] = 1
+    assert_equal 1, Thread.current[:request_store][:foo]
+  end
+end
+
+class MiddlewareTest < Minitest::Unit::TestCase
+  def test_middleware_resets_store
+    app = RackApp.new
+    middleware = RequestStore::Middleware.new(app)
+
+    middleware.call({})
+    middleware.call({})
+
+    assert_equal 1, Thread.current[:request_store][:foo]
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+class RackApp
+  def call(env)
+    RequestStore.store[:foo] ||= 0
+    RequestStore.store[:foo] += 1
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: request_store
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Steve Klabnik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-17 00:00:00.000000000 Z
+dependencies:
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: RequestStore gives you per-request global storage.
+email:
+- steve@steveklabnik.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/request_store.rb
+- lib/request_store/railtie.rb
+- lib/request_store/version.rb
+- request_store.gemspec
+- test/request_store_test.rb
+- test/test_helper.rb
+homepage: http://github.com/steveklabnik/request_store
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: RequestStore gives you per-request global storage.
+test_files:
+- test/request_store_test.rb
+- test/test_helper.rb
+has_rdoc: