current_fu 3.2.0

data/.gitignore

@@ -0,0 +1,3 @@
+debug.log
+Gemfile.lock
+*.gem

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 1.9.3
+

data/CHANGELOG

@@ -0,0 +1,5 @@
+
+= 3.2.0
+
+* Initial release. Works with Rails ~> 3.2.0
+

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+gemspec
+

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2008-2012 Ken Collins
+
+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,27 @@
+
+# CurrentFu: The most evil gem you will hate to love.
+
+CurrentFu gives a standard interface to the current controller instance in your models with automatic delegation to #current_* named methods.
+
+
+## Installation
+
+Install the gem with bundler. We follow a semantic versioning format that tracks Rails' minor version. So this means to use the latest 3.2.x version of CurrentFu with any 3.2 Rails version.
+
+```ruby
+gem 'current_fu', '~> 3.2.0'
+```
+
+
+## Testing
+
+Simple! Just clone the repo, then run `bundle install` and `bundle exec rake`. The tests will begin to run. We also use Travis CI to run our tests too. Current build status is:
+
+[![Build Status](https://secure.travis-ci.org/metaskill/current_fu.png)](http://travis-ci.org/metaskills/current_fu)
+
+
+
+## License
+
+Released under the MIT license.
+Copyright (c) 2008-2012 Ken Collins

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler'
+require 'rake/testtask'
+
+Bundler::GemHelper.install_tasks
+
+desc 'Test the CurrentFu gem.'
+Rake::TestTask.new do |t|
+  t.libs = ['lib','test']
+  t.test_files = Dir.glob("test/**/*_test.rb").sort
+  t.verbose = true
+end
+
+task :default => [:test]

data/lib/current_fu.rb

@@ -0,0 +1,8 @@
+require 'active_record'
+require 'action_controller'
+require 'current_fu/version'
+require 'current_fu/errors'
+require 'current_fu/object'
+require 'current_fu/getter'
+require 'current_fu/controller_concerns'
+

data/lib/current_fu/controller_concerns.rb

@@ -0,0 +1,28 @@
+require 'active_support/concern'
+
+module CurrentFu
+  module ControllerConcerns
+    
+    extend ActiveSupport::Concern
+    
+    included do
+      around_filter :set_current
+    end
+    
+    protected
+    
+    def current
+      @current ||= CurrentFu::Object.new(self)
+    end
+
+    def set_current
+      CurrentFu::Object.instance = current
+      yield
+    ensure
+      CurrentFu::Object.instance = nil
+    end
+    
+  end
+end
+
+ActiveSupport.on_load(:action_controller) { include CurrentFu::ControllerConcerns }

data/lib/current_fu/errors.rb

@@ -0,0 +1,7 @@
+module CurrentFu
+  
+  class CurrentFuError < StandardError #:nodoc:
+  end
+
+
+end

data/lib/current_fu/getter.rb

@@ -0,0 +1,22 @@
+require 'active_support/concern'
+
+module CurrentFu
+  module Getter
+    
+    extend ActiveSupport::Concern
+    
+    module ClassMethods
+      
+      def current
+        CurrentFu::Object.instance
+      end
+      
+    end
+    
+    def current
+      self.class.current
+    end
+    
+  end
+end
+

data/lib/current_fu/object.rb

@@ -0,0 +1,52 @@
+module CurrentFu
+  class Object
+    
+    def initialize(current_owner)
+      @current_owner = current_owner
+    end
+
+    class << self
+
+      def instance
+        Thread.current[:current_fu_instance]
+      end
+
+      def instance=(current_instance)
+        Thread.current[:current_fu_instance] = current_instance
+      end
+
+    end
+    
+    def instance
+      @current_owner
+    end
+
+    def respond_to?(method)
+      current_owner_respond_to?(method) || super
+    end
+
+    
+    protected
+    
+    def current_method(method)
+      :"current_#{method}"
+    end
+    
+    def current_owner_respond_to?(method)
+      @current_owner.respond_to? current_method(method)
+    end
+    
+    def method_missing(method, *args)
+      if current_owner_respond_to?(method)
+        if block_given?
+          @current_owner.send(current_method(method),*args) { |*block_args| yield(*block_args) }
+        else
+          @current_owner.send(current_method(method),*args)
+        end
+      else
+        block_given? ? super { |*block_args| yield(*block_args) } : super
+      end
+    end
+    
+  end
+end

data/lib/current_fu/version.rb

@@ -0,0 +1,3 @@
+module CurrentFu
+  VERSION = '3.2.0'
+end

data/test/cases/base_test.rb

@@ -0,0 +1,75 @@
+
+require 'helper'
+
+class CurrentFu::BaseTest < CurrentFu::TestCase
+  
+  let(:base_klass)        { ActionController::Base }
+  let(:base_instance)     { base_klass.new }
+  let(:base_current)      { CurrentFu::Object.new(base_instance) }
+  let(:app_instance)      { TestApplicationController.new }
+  let(:app_current)       { CurrentFu::Object.new(app_instance) }
+  let(:employee_klass)    { Employee }
+  let(:employee_instance) { employee_klass.new }
+  
+  describe 'ControllerConcerns' do
+    
+    it 'mixins in #current method' do
+      base_klass.protected_instance_methods.map(&:to_s).must_include 'current'
+    end
+  
+    it 'wraps self via #current' do
+      base_instance.send(:current).instance.must_equal base_instance
+    end
+    
+    it 'sets up an around filter to #set_current' do
+      callback = base_klass._process_action_callbacks.detect { |cb| cb.kind == :around && cb.filter == :set_current }
+      assert callback
+    end
+    
+    it 'sets the current instance with #set_current and always returns current instance to nil' do
+      CurrentFu::Object.instance.must_be_nil
+      base_instance.send :set_current do
+        CurrentFu::Object.instance.must_be_instance_of CurrentFu::Object
+        CurrentFu::Object.instance.instance.must_equal base_instance
+      end
+      CurrentFu::Object.instance.must_be_nil
+    end
+    
+  end
+  
+  describe 'Getter' do
+    
+    it 'has both a class and instance for current instance object' do
+      employee_klass.current.must_be_nil
+      employee_instance.send(:current).must_be_nil
+      CurrentFu::Object.instance = base_current
+      employee_klass.current.must_be_instance_of CurrentFu::Object
+      employee_klass.current.instance.must_equal base_instance
+      employee_instance.current.instance.must_equal base_instance
+    end
+    
+  end
+  
+  describe 'Object' do
+    
+    it 'delegates via #respond_to? and #method_missing to current_* methods of the instance' do
+      user = Employee.first
+      app_instance.current_user = user
+      CurrentFu::Object.instance = app_current
+      employee_instance.current.respond_to?(:user)
+      employee_instance.current.user.must_equal user
+    end
+
+    it 'is thread safe' do
+      bk1 = base_klass.new
+      bk2 = base_klass.new
+      t1 = Thread.new { CurrentFu::Object.instance = CurrentFu::Object.new(bk1) }.join
+      t2 = Thread.new { CurrentFu::Object.instance = CurrentFu::Object.new(bk2) }.join
+      t1[:current_fu_instance].instance.must_equal bk1
+      t2[:current_fu_instance].instance.must_equal bk2
+    end
+    
+  end
+  
+end
+

data/test/helper.rb

@@ -0,0 +1,69 @@
+require 'rubygems'
+require 'bundler'
+require "bundler/setup"
+Bundler.require
+require 'current_fu'
+require 'active_record/base'
+require 'action_controller/base'
+require 'minitest/autorun'
+require 'logger'
+
+
+ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__),'debug.log'))
+ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => ':memory:'
+
+
+module CurrentFu
+  class TestCase < MiniTest::Spec
+    
+    before { setup_environment }
+    after  { cleanup }
+    
+    protected
+    
+    def cleanup
+      CurrentFu::Object.instance = nil
+    end
+    
+    def setup_environment
+      setup_database
+      setup_data
+    end
+    
+    def setup_database
+      ActiveRecord::Base.class_eval do
+        silence do
+          connection.create_table :employees, :force => true do |t|
+            t.column :name,  :string
+            t.column :email, :string
+            t.column :age,   :integer
+          end
+        end
+      end
+    end
+    
+    def setup_data
+      Employee.create :name => 'Ken Collins', :email => 'ken@metaskills.net', :age => 39
+    end
+    
+  end
+end
+
+class Employee < ActiveRecord::Base
+  include CurrentFu::Getter
+end
+
+module TestAuthSystem
+  include CurrentFu::Getter
+  def current_user
+    @current_user ||= Employee.first
+  end
+  def current_user=(user)
+    @current_user = user
+  end
+end
+
+class TestApplicationController < ActionController::Base
+  include TestAuthSystem
+end
+

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: current_fu
+version: !ruby/object:Gem::Version
+  version: 3.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Ken Collins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70214029672660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70214029672660
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70214029721340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70214029721340
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70214029720880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70214029720880
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70214029720460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70214029720460
+- !ruby/object:Gem::Dependency
+  name: m
+  requirement: &70214029720040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70214029720040
+description: ! 'CurrentFu gives a standard interface to the current controller instance
+  in your models with automatic delegation to #current_* named methods.'
+email:
+- ken@metaskills.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/current_fu.rb
+- lib/current_fu/controller_concerns.rb
+- lib/current_fu/errors.rb
+- lib/current_fu/getter.rb
+- lib/current_fu/object.rb
+- lib/current_fu/version.rb
+- test/cases/base_test.rb
+- test/helper.rb
+homepage: http://github.com/metaskills/current_fu/
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+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.17
+signing_key: 
+specification_version: 3
+summary: The most evil gem you will hate to love.
+test_files:
+- test/cases/base_test.rb
+- test/helper.rb