ar-simple-idmap 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+spec/debug.log
+.DS_Store
+spec/db/*.sqlite*
+*~

data/COPYING

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Sokolov Yura aka funny_falcon
+
+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

@@ -0,0 +1,61 @@
+IdentityMap
+===========
+
+Adds simple hand controlled identity map for ActiveRecord.
+
+Installing
+==========
+
+    gem install ar-simple-identity-map
+
+or
+
+
+Enabling
+========    
+    
+To enable in ApplicationController (it is not enabled by default).
+
+    class ApplicationController < ActionController::Base
+      use_identity_map #(installs around filter)
+      # or use_identity_map :only=>[:index, :show]
+      # or use_identity_map :except=>[:update]
+    end
+    
+If you decide to disable filter in sub controllers:
+
+    class ClientController < ApplicationController
+      dont_use_identity_map :only=>[:save, :update, :messy_action]
+    end
+
+Then you should enable identity map for each model class individually:
+
+    class TarifPlan < ActiveRecord::Base
+      use_id_map
+      has_many :clients
+    end
+    
+    class Client < ActiveRecord::Base
+      use_id_map
+      belongs_to :tarif_plan
+    end
+    
+To enable in rake task or script:
+
+    ActiveRecord.with_id_map do
+      # all things here goes with identity map
+    end
+
+If you found that identity logic does wrong thing in some particular place,
+you could temporary disable it:
+
+    ActiveRecord.without_id_map do
+      # all things here goes without identity map
+    end
+
+
+Copyright
+=========
+
+inspired by http://github.com/pjdavis/identity-map
+Copyright (c) 2010 Sokolov Yura aka funny_falcon, released under the MIT license.

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the identity_map plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the identity_map plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'IdentityMap'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "ar-simple-idmap"
+    gemspec.summary = "Simple identity map for ActiveRecord"
+    gemspec.description = "Add simple finegrained handcontrolled identity map for ActiveRecord"
+    gemspec.email = "funny.falcon@gmail.com"
+    gemspec.homepage = "http://github.com/funny-falcon/identity-map"
+    gemspec.authors = ["Sokolov Yura aka funny_falcon"]
+    gemspec.add_dependency('activerecord')
+    gemspec.rubyforge_project = 'ar-simple-idmap'
+  end
+  Jeweler::GemcutterTasks.new
+  Jeweler::RubyforgeTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), "lib", "identity_map")

data/install.rb

@@ -0,0 +1 @@
+puts IO.read(File.join(File.dirname(__FILE__), 'README'))

data/lib/autotest/discover.rb

@@ -0,0 +1,5 @@
+$:.push(File.join(File.dirname(__FILE__), %w[.. .. rspec]))
+
+Autotest.add_discovery do
+  "rspec"
+end

data/lib/identity_map/action_controller/dispatcher.rb

@@ -0,0 +1,63 @@
+module ActionController
+  class Base
+  	module IdentityMap
+  	  module InstanceMethods
+		def with_identity_map
+		  ActiveRecord::Base.with_id_map {
+			yield
+		  }
+		end
+		
+		def without_identity_map
+		  ActiveRecord::Base.without_id_map {
+			yield
+		  }
+		end
+	  end
+  	  
+  	  module ClassMethods
+  	  	def use_identity_map(*args)
+  	  	  skip_around_filter :without_identity_map, *args
+  	  	  around_filter :with_identity_map, *args
+  	  	end
+  	  	
+  	  	def dont_use_identity_map(*args)
+  	  	  skip_around_filter :with_identity_map, *args
+  	  	  around_filter :without_identity_map, *args
+  	  	end
+  	  	
+  	  	def use_dispater_identity_map
+  	  	  if defined? ::ActionDispatch
+  	  	  	ActionDispatch::Callbacks.before :create_identity_map
+  	  	  	ActionDispatch::Callbacks.after :remove_identity_map
+  	  	  else
+  	  	  	ActionController::Dispatcher.before_dispatch :create_identity_map
+  	  	  	ActionController::Dispatcher.after_dispatch :remove_identity_map
+  	  	  end
+  	  	end
+  	  end
+  	  
+
+  	end
+  	extend IdentityMap::ClassMethods
+  	include IdentityMap::InstanceMethods
+  end
+end
+
+module DispatcherMethods
+  def create_identity_map
+	ActiveRecord::Base.create_identity_map
+  end
+  
+  def remove_identity_map
+	ActiveRecord::Base.drop_identity_map
+  end
+end
+
+if defined? ::ActionDispatch
+  ActionDispatch::Callbacks.send :include, DispatcherMethods
+  RAILS_DEFAULT_LOGGER.warn "CACHING OBJECTS"
+else
+  ActionController::Dispatcher.send :include, DispatcherMethods
+  RAILS_DEFAULT_LOGGER.warn "CACHING OBJECTS"
+end

data/lib/identity_map/active_record/associations.rb

@@ -0,0 +1,31 @@
+module IdentityMap
+
+  def self.included(base)
+    base.extend(ClassMethods)
+    class << base
+      alias_method_chain :association_instance_set, :identity_map
+    end
+  end
+
+  module ClassMethods
+
+  private
+
+  # Set the specified association instance.
+  def association_instance_set_with_identity_map(name, association)
+    identity_map = Thread.current['identity_map']
+    unless identity_map
+      association_instance_set_without_identity_map("@#{name}", association)
+    else
+      association_instance_set_without_identity_map("@#{name}", identity_map.put(association))
+    end
+  end
+
+
+  end
+
+end
+
+if Object.const_defined?("ActiveRecord")
+  ActiveRecord::Associations.send :include, IdentityMap
+end

data/lib/identity_map/active_record/base.rb

@@ -0,0 +1,100 @@
+module ActiveRecord
+  class Base
+	module IdentityMap
+	  module ClassMethods
+		private
+		  def use_id_map
+			extend IdMapClassMethods
+			include IdMapInstanceMethods
+			class << self
+			  alias_method_chain :find, :identity_map
+			  alias_method_chain :instantiate, :identity_map
+			end
+			alias_method_chain :create, :identity_map
+		  end
+	  end
+	  
+	  module IdMapClassMethods
+
+		def id_map
+		  thread_id_map.try(:for_class, self)
+		end
+		
+		def if_id_map
+		  map = id_map
+		  yield map if map
+		end
+		
+		private
+	  
+		  def find_with_identity_map( *args )
+			if_id_map do |map|
+			  unless args.size > 1 && args[1].values.any?
+				args0 = args[0]
+				if args0.is_a?(Array)
+				  result, to_find = [], []
+				  args0.each do |id| 
+				  	if (obj = map[id])
+				  	  result << obj
+				  	else
+				  	  to_find << id
+				  	end
+				  end
+				  result + find_without_identity_map( to_find )
+				else
+				  map[args0] || find_without_identity_map(args0)
+				end
+			  end
+			end || find_without_identity_map(*args)
+		  end
+		  
+		  def instantiate_with_identity_map( record )
+			if_id_map do |map|
+			  id = record[primary_key]
+			  if (object = map[id])
+				attrs = object.instance_variable_get( :@attributes )
+				unless (changed = object.instance_variable_get( :@changed_attributes )).blank?
+				  for key, value in record
+				  	if changed.has_key? key
+				  	  changed[key] = value
+				  	else
+				  	  attrs[key] = value
+				  	end
+				  end
+				else
+				  attrs.merge!( record ) unless attrs == record
+				end
+				object
+			  else
+			  	map[id] = instantiate_without_identity_map( record )
+			  end
+			end || instantiate_without_identity_map( record )
+		  end
+		  
+		  def delete_with_identity_map( ids )
+		    res = delete_without_identity_map( ids )
+		    if_id_map{|map| [ *ids ].each{|id| map.delete(id) } }
+		    res
+		  end
+	  end
+	  
+	  module IdMapInstanceMethods
+		private
+		  def create_with_identity_map
+			id = create_without_identidy_map
+			self.class.if_id_map{|map| map[id] = self }
+			id
+		  end
+		  
+		  def destroy_with_identity_map
+		  	res = destroy_without_identity_map
+		    self.class.if_id_map{|map| map.delete(id) }
+		    res
+		  end
+	  end
+	end
+	
+	extend IdentityMap::ClassMethods
+  end
+end
+

data/lib/identity_map/cache.rb

@@ -0,0 +1,89 @@
+module ActiveRecord
+  class Base
+  	module ThreadIdentityMap
+	  class ClassIdMap
+		def initialize(klass)
+		  @objects = {}
+		  @object = klass.allocate
+		  @object.instance_variable_set(:@attributes, {:id=>nil})
+		  @object.instance_variable_set(:@attributes_cache, {})
+		end
+		
+		def [](id)
+		  @object.id = id
+		  @objects[@object.id]
+		end
+		
+		def []=(id, v)
+		  @object.id = id
+		  @objects[@object.id] = v
+		end
+		
+		def delete(id)
+		  @object.id = id
+		  @objects.delete(id)
+		end
+	  end
+	  
+	  class IdMap
+	  
+		def initialize
+		  @objects = {}
+		end
+	  
+		def for_class(klass)
+		  @objects[ klass.base_class ] ||= ClassIdMap.new(klass)
+		end
+		
+	  end
+	  
+	  module ClassMethods
+	  	def create_identity_map
+	  	  set_thread_id_map IdMap.new
+	  	end
+	  	
+	  	def drop_identity_map
+	  	  set_thread_id_map nil
+	  	end
+	  	
+		def with_id_map( fresh = true)
+		  old = thread_id_map
+		  create_identity_map if fresh || old.nil?
+		  yield
+		ensure
+		  set_thread_id_map old
+		end
+		
+		def without_id_map
+		  old = thread_id_map
+		  drop_identity_map
+		  yield
+		ensure
+		  set_thread_id_map old
+		end
+		
+#		def uncached_with_identity_map( &block )
+#		  without_id_map do
+#		  	uncached_without_identity_map &block
+#		  end
+#		end
+		
+		protected
+		
+		  def thread_id_map
+			Thread.current[:ar_identity_map]
+		  end
+		  
+		  def thread_id_map=(v)
+			Thread.current[:ar_identity_map] = v
+		  end
+		  
+		  alias set_thread_id_map thread_id_map=
+		
+	  end
+    end
+	
+	extend ThreadIdentityMap::ClassMethods
+#	self.class.send :alias_method_chain, :uncached, :identity_map
+  end
+end

data/lib/identity_map.rb

@@ -0,0 +1,3 @@
+require "identity_map/cache"
+require "identity_map/action_controller/dispatcher"
+require "identity_map/active_record/base"

data/spec/database.yml

@@ -0,0 +1,21 @@
+sqlite:
+  :adapter: sqlite
+  :database: vendor/plugins/identity_map/spec/db/identity_map_plugin.sqlite.db
+
+sqlite3:
+  :adapter: sqlite3
+  :database: vendor/plugins/identity_map/spec/db/identity_map_plugin.sqlite3.db
+
+postgresql:
+  :adapter: postgresql
+  :username: postgres
+  :password: postgres
+  :database: identity_map_plugin_test
+  :min_messages: ERROR
+
+mysql:
+  :adapter: mysql
+  :host: localhost
+  :username: root
+  :password:
+  :database: identity_map_plugin_test

data/spec/db/schema.rb

@@ -0,0 +1,10 @@
+ActiveRecord::Schema.define(:version => 0) do
+  puts "Creating Schema"
+  create_table :customers, :force => true do |t|
+    t.string :name
+  end
+  create_table :phone_numbers, :force => true do |t|
+    t.string :number
+    t.integer :customer_id
+  end
+end

data/spec/identity_map_spec.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Customers" do
+	
+	before(:each) do
+		Thread.current["identity_map"] = Cache.new
+	end
+	
+	it "should load the same model twice" do
+		c1 = Customer.first
+		c2 = Customer.first
+		c1.__id__.should == c2.__id__
+	end
+	
+	it "should work for has_many associations" do
+		p1 = PhoneNumber.first
+		p2 = Customer.first.phone_numbers.first
+		p1.__id__.should == p2.__id__
+	end
+	
+	it "should work for belongs_to assocations" do
+		d1 = Customer.first
+		d2 = PhoneNumber.first.customer
+		d1.__id__.should == d2.target.__id__
+	end
+	
+	it "should work for creating objects" do
+		c1 = Customer.create(:name => "billy")
+		c2 = Customer.find_by_name("billy")
+		c1.__id__.should == c2.__id__
+	end
+	
+	after(:each) do
+		Thread.current["identity_map"] = nil
+	end
+	
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+begin
+  require File.dirname(__FILE__) + '/../../../../spec/spec_helper'
+rescue LoadError
+  puts "You need to install rspec in your base app"
+  exit
+end
+
+plugin_spec_dir = File.dirname(__FILE__)
+ActiveRecord::Base.logger = Logger.new(plugin_spec_dir + "/debug.log")
+
+def load_schema
+  config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+  ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+
+  db_adapter = ENV['DB']
+  # no db passed, try one of these fine config-free DBs before bombing.
+  db_adapter ||=
+    begin
+      require 'rubygems'
+      require 'sqlite'
+      'sqlite'
+    rescue MissingSourceFile
+      begin
+        require 'sqlite3'
+        'sqlite3'
+      rescue MissingSourceFile
+      end
+    end
+
+  if db_adapter.nil?
+    raise "No DB Adapter selected. Pass the DB= option to pick one, or install Sqlite or Sqlite3."
+  end
+
+  ActiveRecord::Base.establish_connection(config[db_adapter])
+  load(File.dirname(__FILE__) + "/db/schema.rb")
+  require File.dirname(__FILE__) + '/../init.rb'
+end
+require File.dirname(__FILE__) + '/test_models.rb'

data/spec/test_models.rb

@@ -0,0 +1,13 @@
+load_schema
+
+class Customer < ActiveRecord::Base
+  has_many :phone_numbers
+end
+
+customer = Customer.create(:name => "Boneman")
+
+class PhoneNumber < ActiveRecord::Base
+  belongs_to :customer
+end
+
+phone_number = customer.phone_numbers.create(:number => "8675309")

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: ar-simple-idmap
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Sokolov Yura aka funny_falcon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-02 00:00:00 +04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Add simple finegrained handcontrolled identity map for ActiveRecord
+email: funny.falcon@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .gitignore
+- COPYING
+- README
+- Rakefile
+- init.rb
+- install.rb
+- lib/autotest/discover.rb
+- lib/identity_map.rb
+- lib/identity_map/action_controller/dispatcher.rb
+- lib/identity_map/active_record/associations.rb
+- lib/identity_map/active_record/base.rb
+- lib/identity_map/cache.rb
+- spec/database.yml
+- spec/db/schema.rb
+- spec/identity_map_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/test_models.rb
+has_rdoc: true
+homepage: http://github.com/funny-falcon/identity-map
+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 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: ar-simple-idmap
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple identity map for ActiveRecord
+test_files: 
+- spec/db/schema.rb
+- spec/test_models.rb
+- spec/identity_map_spec.rb
+- spec/spec_helper.rb