acts_as_current 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+*.gem

data/MIT-LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2010 Coroutine LLC
+
+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.
+
+--------------------------------------------------------------------
+
+acts_as_current was inspired by sentient_user. 
+
+Copyright (c) 2009 bokmann, also released under the MIT license.

data/README.rdoc

@@ -0,0 +1,113 @@
+= acts_as_current
+
+This library extends ActiveRecord classes so they can carry a reference to the 
+instance defined as current for the given request.
+
+<tt>acts_as_current</tt> can be applied to any model, but it's most common use case is 
+storing the authenticated user on the corresponding User model.  Doing so allows other models 
+and observers to access information about the user who made the request.  This is particularly 
+useful for auditing, versioning, etc.
+
+Here's how you'd set up the user example.  
+
+First, extend the User model.
+
+    class User < ActiveRecord::Base
+        acts_as_current
+    end
+	
+
+Then, tell your application controller to set the current user before all requests. (The controller 
+method can obviously be anything you want. Here, we use <tt>:current_user</tt> because that's our 
+convention at Coroutine.)
+
+    class ApplicationController < ActionController::Base
+        
+        before_filter { |controller| User.current = controller.send(:current_user) }
+
+        def current_user
+            # return user or nil
+        end
+    end
+
+
+Finally, in your observer, you can retrieve the value of current_user by using the accessor mixed 
+into the model class.
+
+    class AuditObserver < ActiveRecord::Observer
+        observe :account, :balance
+
+        def after_update(record)
+            AuditTrail.new({ :record => record, :action => :update, :whodunnit => User.current })
+        end
+    end
+	
+
+
+
+== Design Notes
+
+<tt>acts_as_current</tt> uses the hash Thread.current to store the current value for each class
+extended by the library.  Many consider this technique a hack, but for now, it is the only thread 
+safe way to store such data.  By coding the technique as a model extension, <tt>acts_as_current</tt> 
+abstracts reads and writes against Thread.current, greatly reducing the likelihood of 
+conflicts and errors.  
+
+We think the real benefits outweigh the perceived risks.
+
+
+
+
+== Helpful Links
+
+* <b>Repository:</b> http://github.com/coroutine/acts_as_current
+* <b>Gem:</b> http://rubygems.org/gems/acts_as_current
+* <b>Authors:</b> http://coroutine.com
+
+
+
+
+== Installation & Generators
+
+Install me from RubyGems.org and add a gem dependency in your configuration file.
+
+    $ sudo gem install acts_as_current
+
+Or install me as a plugin.
+
+    $ script/plugin install git://github.com/coroutine/acts_as_current.git
+
+	
+
+
+== Simple Controller Recipe
+
+He's an example of how you might set a current instance on a User class via a 
+current_user method, using a before filter in the application controller.
+
+    before_filter { |controller| User.current = controller.send(:current_user) }
+
+
+
+
+== Why Doesn't the Library Handle the Controller Logic For Me?
+
+Primarily, because we think ActiveRecord extensions have no business altering
+controller logic.  Doing so couples aspects of your application that Rails is going 
+out of its way to separate.
+
+But also because the before_filter syntax is already configurable and extremely expressive. 
+Writing the before filter is no harder than writing a module include statement, but the former 
+tells a code maintainer <b>considerably</b> more information than the latter.
+
+In summary, suck it up and write the controller code yourself. :-) 
+
+
+
+
+== License
+
+Copyright (c) 2010 {Coroutine LLC}[http://coroutine.com], released under the MIT license.
+
+acts_as_current was inspired by sentient_user, copyright (c) 2009 bokmann, also released under the 
+MIT license.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'jeweler'
+
+
+desc 'Default: run tests.'
+task :default => [:test]
+
+
+desc 'Test the plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+
+desc 'Generate documentation for the plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'acts_as_current'
+  rdoc.options << '--line-numbers --inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+begin
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.authors           = ["Coroutine", "John Dugan"]
+    gemspec.description       = "This acts_as extension modifies ActiveRecord classes so they can carry a reference to the instance defined as current for the given request.  The library is particularly useful for providing the authenticated user object to models."
+    gemspec.email             = "gem@coroutine.com"
+    gemspec.homepage          = "http://github.com/coroutine/acts_as_current"
+    gemspec.name              = "acts_as_current"
+    gemspec.summary           = "Gem version of acts_as_current Rails plugin."
+    
+    gemspec.add_dependency("activerecord")
+    gemspec.add_development_dependency("activesupport")
+    gemspec.files.include("lib/**/*.rb")
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/acts_as_current.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{acts_as_current}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Coroutine", "John Dugan"]
+  s.date = %q{2010-04-06}
+  s.description = %q{This acts_as extension modifies ActiveRecord classes so they can carry a reference to the instance defined as current for the given request.  The library is particularly useful for providing the authenticated user object to models.}
+  s.email = %q{gem@coroutine.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "acts_as_current.gemspec",
+     "init.rb",
+     "lib/acts_as_current.rb",
+     "lib/acts_as_current/base.rb",
+     "lib/acts_as_current/class_methods.rb",
+     "lib/acts_as_current/instance_methods.rb",
+     "rails/init.rb",
+     "test/acts_as_current/base_test.rb",
+     "test/acts_as_current/simple_test.rb",
+     "test/acts_as_current/sti_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/coroutine/acts_as_current}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Gem version of acts_as_current Rails plugin.}
+  s.test_files = [
+    "test/acts_as_current/base_test.rb",
+     "test/acts_as_current/simple_test.rb",
+     "test/acts_as_current/sti_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 0"])
+      s.add_development_dependency(%q<activesupport>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+  end
+end
+

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init.rb"

data/lib/acts_as_current.rb

@@ -0,0 +1,12 @@
+# external gems
+require "active_record"
+
+
+# acts_as_current extension
+require File.dirname(__FILE__) + "/acts_as_current/base"
+require File.dirname(__FILE__) + "/acts_as_current/class_methods"
+require File.dirname(__FILE__) + "/acts_as_current/instance_methods"
+
+
+# add extensions to active record
+::ActiveRecord::Base.send(:include, Coroutine::ActsAsCurrent::Base)

data/lib/acts_as_current/base.rb

@@ -0,0 +1,59 @@
+module Coroutine
+  
+  # This module is an acts_as extension that teaches an ActiveRecord model how to provide a reference
+  # to the instance owned by the current thread through a class method.
+  #
+  # The module includes class methods and instance methods that simplify the process of storing the 
+  # current reference in a thread safe manner.
+  #
+  # Because acts_as_current relies on the Thread.current hash, it should probably be used sparingly.
+  # 
+  module ActsAsCurrent
+    
+    # This module provides the base functionality for the acts_as_current extension.  It declares the
+    # class method acts_as_current and handles including all necessary sub modules when the class
+    # method is invoked.
+    # 
+    module Base
+      
+      def self.included(klass)        #:nodoc:
+        klass.class_eval do
+          
+          # This class method extends an ActiveRecord class with behavior appropriate for providing a
+          # current instance to the request.
+          #
+          # Including this method in a model definition adds two public class methods and two public 
+          # instance methods to the model. See modules below for method defintions.  Here's a simple
+          # skeleton that demonstrates the resulting interface.
+          #
+          #
+          # class MyClass < ActiveRecord::Base
+          #
+          #   def self.current
+          #   end
+          #
+          #   def self.current=(instance)
+          #   end
+          #
+          #   def current?
+          #   end
+          #
+          #   def current!
+          #   end
+          #
+          # end
+          #
+          def self.acts_as_current
+
+            # mixin methods
+            extend  Coroutine::ActsAsCurrent::ClassMethods
+            include Coroutine::ActsAsCurrent::InstanceMethods
+
+          end
+          
+        end
+      end      
+      
+    end    
+  end
+end

data/lib/acts_as_current/class_methods.rb

@@ -0,0 +1,39 @@
+module Coroutine
+  module ActsAsCurrent
+    
+    # This module defines methods that will be mixed into the class definition when acts_as_current
+    # is invoked.
+    #
+    # The notation used below assumes the module will be invoked using the :extend method, ensuring
+    # the wrapping scope is the class object.
+    #
+    module ClassMethods      
+    
+      # This method returns the reference to the instance defined as current.
+      #
+      def current
+        Thread.current[acts_as_current_symbol]
+      end
+      
+      # This method sets the reference to the instance defined as current.
+      #
+      def current=(instance)
+        unless (instance.is_a?(self) || instance.nil?)
+          raise(ArgumentError, "The method expected an instance of class '#{name}', but instead was given #{instance.inspect}") 
+        end
+        Thread.current[acts_as_current_symbol] = instance
+      end
+      
+      
+      private 
+      
+      # This method returns the singularized, underscored symbol for the class.
+      #
+      def acts_as_current_symbol
+        name.underscore.to_sym
+      end
+      
+    end
+  
+  end
+end

data/lib/acts_as_current/instance_methods.rb

@@ -0,0 +1,28 @@
+module Coroutine
+  module ActsAsCurrent
+    
+    # This module defines methods that will be mixed into the instance when acts_as_current is invoked.
+    #
+    # The notation used below assumes the module will be invoked using the :include method, ensuring
+    # the wrapping scope is the instance object.
+    #
+    module InstanceMethods      
+    
+      # This method returns a boolean indicating whether or not the instance is defined
+      # as the current instance of the class.
+      #
+      def current?
+        !self.class.current.nil? && self.id == self.class.current.id
+      end
+      
+      # This method forces the instance to become the defined current instance of the 
+      # class.
+      #
+      def current!
+        self.class.current = self
+      end
+    
+    end
+  
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require "acts_as_current"

data/test/acts_as_current/base_test.rb

@@ -0,0 +1,37 @@
+#---------------------------------------------------------
+# Requirements
+#---------------------------------------------------------
+
+# all generic stuff required by test helper
+require "test/test_helper"
+
+
+
+#---------------------------------------------------------
+# Tests
+#---------------------------------------------------------
+
+class ActsAsCurrentBaseTest < ActiveSupport::TestCase
+
+  #---------------------------------------------
+  # setup and teardown delegations
+  #---------------------------------------------
+  
+  def setup
+    setup_db
+  end
+  def teardown
+    teardown_db
+  end
+
+
+
+  #---------------------------------------------
+  # test composition
+  #---------------------------------------------
+  
+  def test_composition_of_class
+    assert_respond_to ::ActiveRecord::Base, :acts_as_current
+  end
+
+end

data/test/acts_as_current/simple_test.rb

@@ -0,0 +1,86 @@
+#---------------------------------------------------------
+# Requirements
+#---------------------------------------------------------
+
+# all generic stuff required by test helper
+require "test/test_helper"
+
+
+
+#---------------------------------------------------------
+# Tests
+#---------------------------------------------------------
+
+class ActsAsCurrentSimpleTest < ActiveSupport::TestCase
+
+  #---------------------------------------------
+  # setup and teardown delegations
+  #---------------------------------------------
+  
+  def setup
+    setup_db
+  end
+  def teardown
+    teardown_db
+  end
+
+
+
+  #---------------------------------------------
+  # test composition
+  #---------------------------------------------
+  
+  def test_composition_of_class
+    assert User.respond_to?(:current)
+    assert User.respond_to?(:current=)
+    
+    assert User.respond_to?(:acts_as_current_symbol,  true)
+  end
+
+  
+  def test_composition_of_instance
+    seed_users
+    @one = User.first
+    
+    assert @one.respond_to?(:current?)
+    assert @one.respond_to?(:current!)
+  end
+  
+  
+  
+  #---------------------------------------------
+  # test symbol method
+  #---------------------------------------------
+  
+  def test_symbol_method
+    assert_equal :user, User.send(:acts_as_current_symbol)              # this notation bypasses privacy
+  end
+  
+  
+  
+  #---------------------------------------------
+  # test current methods
+  #---------------------------------------------
+  
+  def test_current_methods
+    seed_users
+    @one = User.first
+    @two = User.last
+    
+    # starts as nil
+    assert User.current.nil?
+    
+    # set current to one explicitly (instances agree)
+    User.current = @one
+    assert_equal User.current, @one
+    assert @one.current?
+    assert !@two.current?
+    
+    # set current to two by conversion (instances agree)
+    @two.current!
+    assert_equal User.current, @two
+    assert !@one.current?
+    assert @two.current?
+  end
+  
+end

data/test/acts_as_current/sti_test.rb

@@ -0,0 +1,86 @@
+#---------------------------------------------------------
+# Requirements
+#---------------------------------------------------------
+
+# all generic stuff required by test helper
+require "test/test_helper"
+
+
+
+#---------------------------------------------------------
+# Tests
+#---------------------------------------------------------
+
+class ActsAsCurrentStiTest < ActiveSupport::TestCase
+
+  #---------------------------------------------
+  # setup and teardown delegations
+  #---------------------------------------------
+  
+  def setup
+    setup_db
+  end
+  def teardown
+    teardown_db
+  end
+
+
+
+  #---------------------------------------------
+  # test composition
+  #---------------------------------------------
+  
+  def test_composition_of_class
+    assert BillingFrequency.respond_to?(:current)
+    assert BillingFrequency.respond_to?(:current=)
+    
+    assert BillingFrequency.respond_to?(:acts_as_current_symbol,  true)
+  end
+
+  
+  def test_composition_of_instance
+    seed_billing_frequencies
+    @one = BillingFrequency.first
+    
+    assert @one.respond_to?(:current?)
+    assert @one.respond_to?(:current!)
+  end
+  
+  
+  
+  #---------------------------------------------
+  # test symbol method
+  #---------------------------------------------
+  
+  def test_symbol_method
+    assert_equal :billing_frequency, BillingFrequency.send(:acts_as_current_symbol)     # this notation bypasses privacy
+  end
+  
+  
+  
+  #---------------------------------------------
+  # test current methods
+  #---------------------------------------------
+  
+  def test_current_methods
+    seed_billing_frequencies
+    @one = BillingFrequency.first
+    @two = BillingFrequency.last
+    
+    # starts as nil
+    assert BillingFrequency.current.nil?
+    
+    # set current to one explicitly (instances agree)
+    BillingFrequency.current = @one
+    assert_equal BillingFrequency.current, @one
+    assert @one.current?
+    assert !@two.current?
+    
+    # set current to two by conversion (instances agree)
+    @two.current!
+    assert_equal BillingFrequency.current, @two
+    assert !@one.current?
+    assert @two.current?
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,110 @@
+#----------------------------------------------------------
+# Requirements
+#----------------------------------------------------------
+
+# rails stuff
+require "rubygems"
+require "active_record"
+require "active_support"
+require "active_support/test_case"
+require "test/unit"
+
+# the plugin itself
+require "#{File.dirname(__FILE__)}/../init"
+
+
+
+#---------------------------------------------------------
+# Database config
+#---------------------------------------------------------
+
+# establish db connection
+begin
+  ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+rescue ArgumentError
+  ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+end
+
+
+# define and seed tables
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :users do |t|
+      t.string  :email,                       :limit => 255
+      t.string  :crypted_password,            :limit => 255
+      
+      t.timestamps
+    end
+    add_index :users, :email, :unique
+  end
+  
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :labels do |t|
+      t.string  :type,                        :limit => 255
+      t.string  :system_label,                :limit => 255
+      t.string  :label,                       :limit => 255
+      
+      t.timestamps
+    end
+  end
+end
+
+
+# seed users
+def seed_users
+  User.create!({ :email => "user_1@coroutine.com", :crypted_password => "not_crypted_but_does_not_matter_here" })
+  User.create!({ :email => "user_2@coroutine.com", :crypted_password => "not_crypted_but_does_not_matter_here" })
+end
+
+# seed billing frequencies
+def seed_billing_frequencies
+  BillingFrequency.create!({ :system_label => "MONTHLY", :label => "Monthly" })
+  BillingFrequency.create!({ :system_label => "YEARLY",  :label => "Yearly"  })
+end
+
+
+# drop all tables
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+
+
+#---------------------------------------------------------
+# Model definitions
+#---------------------------------------------------------
+
+# users (simple case)
+class User < ActiveRecord::Base
+  acts_as_current
+end
+
+
+# labels (sti base)
+class Label < ActiveRecord::Base
+  acts_as_current
+end
+
+
+# billing frequencies (sti extension)
+class BillingFrequency < Label
+end
+
+
+
+#----------------------------------------------------------
+# Define global methods
+#----------------------------------------------------------
+
+class ActiveSupport::TestCase
+  
+  # This method allows us to use a convenient notation for testing
+  # model validations.
+  def assert_not_valid(object, msg="Object is valid when it should be invalid")
+    assert(!object.valid?, msg)
+  end
+  alias :assert_invalid :assert_not_valid
+
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_current
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Coroutine
+- John Dugan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-06 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: This acts_as extension modifies ActiveRecord classes so they can carry a reference to the instance defined as current for the given request.  The library is particularly useful for providing the authenticated user object to models.
+email: gem@coroutine.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- acts_as_current.gemspec
+- init.rb
+- lib/acts_as_current.rb
+- lib/acts_as_current/base.rb
+- lib/acts_as_current/class_methods.rb
+- lib/acts_as_current/instance_methods.rb
+- rails/init.rb
+- test/acts_as_current/base_test.rb
+- test/acts_as_current/simple_test.rb
+- test/acts_as_current/sti_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/coroutine/acts_as_current
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Gem version of acts_as_current Rails plugin.
+test_files: 
+- test/acts_as_current/base_test.rb
+- test/acts_as_current/simple_test.rb
+- test/acts_as_current/sti_test.rb
+- test/test_helper.rb