contextuality 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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@contextuality --create

data/Gemfile

@@ -0,0 +1,22 @@
+def darwin_only(require_as)
+  RUBY_PLATFORM.include?('darwin') && require_as
+end
+
+def linux_only(require_as)
+  RUBY_PLATFORM.include?('linux') && require_as
+end
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cms_engine.gemspec
+gemspec
+
+gem 'rspec'
+gem 'guard'
+gem 'guard-rspec'
+
+group :test do
+  gem 'rb-fsevent', require: darwin_only('rb-inotify')
+  gem 'rb-inotify', require: linux_only('rb-inotify')
+  gem 'libnotify'
+end

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 pyromaniac
+
+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,112 @@
+# Contextuality
+
+Contextuality allows you to make global variables for individual contexts.
+It is threadsafe and can forward contexts inside `Thread.new {}` blocks.
+Context is just variables name-value hash.
+You can access any context variable inside context.
+
+It is better than global variables or singleton because variables could be set
+only higher in call stack and you know it. No more unexpected values.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'contextuality'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install contextuality
+
+## Usage
+
+### Simple usage
+
+```
+class Foo
+  include Contextuality
+
+  def self.foo
+    contextuality.foo
+  end
+
+  def foo
+    contextuality.foo
+  end
+end
+
+contextualize(foo: 'Hello') do
+  Foo.foo #=> "Hello"
+end #=> "Hello"
+
+contextualize(foo: 'Goodbye') do
+  Foo.new.foo #=> "Goodbye"
+end #=> "Goodbye"
+
+# If context variable is not set - it returns nil
+contextualize(bar: 'Hello') do
+  Foo.new.foo #=> nil
+end #=> nil
+
+# Contexts can be stacked along the callstack
+contextualize(foo: 'Hello') do
+  contextualize(bar: 'Goodbye') do
+    "#{Foo.new.foo} #{Foo.contextuality.bar}" #=> "Hello Goodbye"
+  end #=> "Hello Goodbye"
+end #=> "Hello Goodbye"
+
+# Also context variables can be redefined deeper
+contextualize(foo: 'Hello') do
+  contextualize(foo: 'Goodbye') do
+    Foo.new.foo #=> "Goodbye"
+  end #=> "Goodbye"
+  Foo.new.foo #=> "Hello"
+end #=> "Hello"
+```
+
+You can include `Contextuality` in Object and get access to context everywhere,
+or just include in classes on-demand.
+
+### More complex example
+
+```
+class Article < ActiveRecord::Base
+  include Contextuality
+
+  def self.for_current_host
+    if contextuality.host
+      where(host: contextuality.host)
+    else
+      for_default_host # or just .all
+    end
+  end
+end
+
+class ArticlesController < ActionController::Base
+  around_filter :setup_host
+
+  def index
+    @articles = Article.for_current_host
+  end
+
+private
+
+  def setup_host
+    contextualize(host: host_for(request.host)) do
+      yield
+    end
+  end
+end
+```
+
+## 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

data/Rakefile

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

data/contextuality.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'contextuality/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "contextuality"
+  gem.version       = Contextuality::VERSION
+  gem.authors       = ["pyromaniac"]
+  gem.email         = ["kinwizard@gmail.com"]
+  gem.description   = %q{Contextual global variables}
+  gem.summary       = %q{Contextual global variables}
+  gem.homepage      = ""
+
+  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"]
+end

data/lib/contextuality.rb

@@ -0,0 +1,37 @@
+require "contextuality/version"
+require "contextuality/context"
+
+module Contextuality
+  def self.included klass
+    klass.class_eval do
+      extend ContextualityMethods
+      include ContextualityMethods
+    end
+  end
+
+  module ContextualityMethods
+    def contextuality
+      ::Thread.current.contextuality
+    end
+  end
+
+  module ObjectMethods
+    def contextualize variables = {}, &block
+      ::Thread.current.contextuality.push variables
+      result = block.call
+      ::Thread.current.contextuality.pop
+      result
+    end
+  end
+
+  module ThreadMethods
+    def contextuality
+      self[:contextuality] ||= (Thread.main != self) ?
+        Thread.main.contextuality.dup :
+        Contextuality::Context.new
+    end
+  end
+end
+
+Object.send :include, Contextuality::ObjectMethods
+Thread.send :include, Contextuality::ThreadMethods

data/lib/contextuality/context.rb

@@ -0,0 +1,34 @@
+module Contextuality
+  class Context
+    def initialize
+      @scopes = []
+    end
+
+    def push variables
+      @scopes.unshift Hash[variables.map { |(name, variable)| [name.to_s, variable] }]
+    end
+
+    def pop
+      @scopes.shift
+    end
+
+    def [] name
+      name = name.to_s
+      scope = @scopes.detect { |scope| scope.key? name }
+      scope[name] if scope
+    end
+
+    def key? name
+      name = name.to_s
+      @scopes.any? { |scope| scope.key? name }
+    end
+
+    def empty?
+      !@scopes.any? { |scope| !scope.empty? }
+    end
+
+    def method_missing method, *args, &block
+      self[method]
+    end
+  end
+end

data/lib/contextuality/version.rb

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

data/spec/contextuality/context_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe Contextuality::Context do
+  subject { described_class.new }
+
+  describe '#initialize' do
+    it { should be_empty }
+  end
+
+  describe '#push' do
+    before { subject.push(:hello => 'world') }
+
+    it { should_not be_empty }
+  end
+
+  describe '#pop' do
+    context do
+      before do
+        subject.push(:hello => 'world')
+        subject.pop
+      end
+
+      it { should be_empty }
+      specify { expect { subject.pop }.not_to raise_error }
+    end
+
+    context do
+      before do
+        subject.push(:hello => 'world')
+        subject.push(:hello => 'world')
+        subject.pop
+      end
+
+      it { should_not be_empty }
+    end
+
+    context do
+      before do
+        subject.push(:hello => 'world')
+        subject.push(:hello => 'world')
+        subject.pop
+        subject.pop
+      end
+
+      it { should be_empty }
+    end
+  end
+
+  describe '#[] and key?' do
+    context 'indifferent access' do
+      before { subject.push(:hello => 'world') }
+
+      specify { subject[:hello].should == 'world' }
+      specify { subject['hello'].should == 'world' }
+      specify { subject[:goodbye].should be_nil }
+      specify { subject.key?(:hello).should be_true }
+      specify { subject.key?('hello').should be_true }
+      specify { subject.key?(:goodbye).should be_false }
+    end
+
+    context 'merging' do
+      before do
+        subject.push(:hello => 'world')
+        subject.push(:goodbye => 'hell')
+      end
+
+      specify { subject[:hello].should == 'world' }
+      specify { subject[:goodbye].should == 'hell' }
+      specify { subject.key?(:hello).should be_true }
+      specify { subject.key?(:goodbye).should be_true }
+    end
+
+    context 'overlapping' do
+      before do
+        subject.push(:hello => 'world')
+        subject.push(:hello => 'hell')
+      end
+
+      specify { subject[:hello].should == 'hell' }
+      specify { subject.key?(:hello).should be_true }
+    end
+
+    context 'overlapping cancel' do
+      before do
+        subject.push(:hello => 'world')
+        subject.push(:hello => 'hell')
+        subject.pop
+      end
+
+      specify { subject[:hello].should == 'world' }
+      specify { subject.key?(:hello).should be_true }
+    end
+  end
+
+  describe '#method_missing' do
+    before { subject.push(:hello => 'world') }
+    its(:hello) { should == 'world' }
+    its(:goodbye) { should be_nil }
+  end
+end

data/spec/contextuality_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe Contextuality do
+  let(:klass) do
+    Class.new do
+      include Contextuality
+
+      def hello
+        contextuality.hello
+      end
+
+      def goodbye
+        contextuality.goodbye
+      end
+    end
+  end
+  subject { klass.new }
+
+  context 'linear' do
+    specify { subject.hello.should be_nil }
+
+    specify do
+      contextualize do
+        subject.hello.should be_nil
+      end
+    end
+
+    specify do
+      contextualize(:hello => 'world') do
+        subject.hello.should == 'world'
+      end
+    end
+
+    specify do
+      contextualize(:hello => 'world') do
+        contextualize(:hello => 'hell') do
+          subject.hello.should == 'hell'
+        end
+      end
+    end
+
+    specify do
+      contextualize(:hello => 'world') do
+        contextualize(:goodbye => 'hell') do
+          subject.hello.should == 'world'
+        end
+      end
+    end
+  end
+
+  context 'threaded' do
+    specify do
+      contextualize(:hello => 'world') do
+        Thread.new do
+          Thread.current[:output] = subject.hello
+        end.join[:output].should == 'world'
+      end
+    end
+
+    specify do
+      contextualize(:hello => 'world') do
+        Thread.new do
+          contextualize(:hello => 'hell') do
+            Thread.current[:output] = subject.hello
+          end
+        end.join[:output].should == 'hell'
+      end
+    end
+
+    specify do
+      contextualize(:goodbye => 'hell') do
+        Thread.new do
+          contextualize(:hello => 'world') do
+            Thread.current[:output] = [subject.hello, subject.goodbye]
+          end
+        end.join[:output].should == ['world', 'hell']
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'contextuality'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: contextuality
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- pyromaniac
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-29 00:00:00.000000000 Z
+dependencies: []
+description: Contextual global variables
+email:
+- kinwizard@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- contextuality.gemspec
+- lib/contextuality.rb
+- lib/contextuality/context.rb
+- lib/contextuality/version.rb
+- spec/contextuality/context_spec.rb
+- spec/contextuality_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.24
+signing_key: 
+specification_version: 3
+summary: Contextual global variables
+test_files:
+- spec/contextuality/context_spec.rb
+- spec/contextuality_spec.rb
+- spec/spec_helper.rb