dzema_dm-counter-cache 0.9.12

data/History.txt

@@ -0,0 +1,7 @@
+=== 0.9.12 / 2009-11-15
+
+* Version without class_eval
+
+=== 0.9.8 / 2008-12-07
+
+* Initial commit

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008-2009 Saimon Moore, Dmitriy Dzema
+
+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/Manifest.txt

@@ -0,0 +1,14 @@
+History.txt
+LICENSE
+Manifest.txt
+README.txt
+Rakefile
+TODO
+lib/dm-counter-cache.rb
+lib/dm-counter-cache/version.rb
+spec/integration/dm-counter-cache_spec.rb
+spec/integration/multiple_define_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/install.rb
+tasks/spec.rb

data/README.txt

@@ -0,0 +1,23 @@
+== README
+
+DataMapper::CounterCacheable automates the dec/incrementing of association counter fields. This is
+similar to counter caches in ActiveRecord.
+
+Example:
+
+class Post
+  include DataMapper::Resource
+
+  has n :comments
+
+  property :id, Integer, :serial => true
+  property :comments_count, Integer, :default => 0
+end
+
+class Comment
+  include DataMapper::Resource
+  include DataMapper::CounterCacheable  
+
+  belongs_to :post, :counter_cache => true
+
+end

data/Rakefile

@@ -0,0 +1,28 @@
+require 'pathname'
+require 'rubygems'
+require 'hoe'
+
+ROOT    = Pathname(__FILE__).dirname.expand_path
+JRUBY   = RUBY_PLATFORM =~ /java/
+WINDOWS = Gem.win_platform?
+SUDO    = (WINDOWS || JRUBY) ? '' : ('sudo' unless ENV['SUDOLESS'])
+
+require ROOT + 'lib/dm-counter-cache/version'
+
+AUTHOR = ['Saimon Moore', 'Dmitriy Dzema']
+EMAIL  = ['daimonmoore [a] gmail [d] com', 'dima [a] dzema [d] name']
+GEM_NAME = 'dzema_dm-counter-cache'
+GEM_VERSION = DataMapper::CounterCacheable::VERSION
+GEM_DEPENDENCIES = [['dm-core', "=#{GEM_VERSION}"]]
+GEM_CLEAN = %w[ log pkg coverage ]
+GEM_EXTRAS = { :has_rdoc => true, :extra_rdoc_files => %w[ README.txt LICENSE TODO History.txt ] }
+
+PROJECT_NAME = 'datamapper'
+PROJECT_URL  = "http://github.com/DimaD/dm-counter-cache"
+PROJECT_DESCRIPTION = PROJECT_SUMMARY = 'DataMapper plugin for counter caches ala ActiveRecord. Original idea and implementation by Saimon Moore (daimonmoore [a] gmail [d] com)'
+
+[ ROOT, ROOT.parent ].each do |dir|
+  Pathname.glob(dir.join('tasks/**/*.rb').to_s).each { |f| require f }
+end
+
+require 'tasks/hoe'

data/lib/dm-counter-cache/version.rb

@@ -0,0 +1,5 @@
+module DataMapper
+  module CounterCacheable
+    VERSION = '0.9.12'
+  end
+end

data/lib/dm-counter-cache.rb

@@ -0,0 +1,109 @@
+module DataMapper
+  # CounterCacheable allows you to transparently maintain counts on collection association of this model on the parent model.
+  # You can also specify a custom counter cache column by providing a column name instead of a true/false value 
+  # to this option (e.g., :counter_cache => :my_custom_counter.)
+  module CounterCacheable
+
+    def self.included(klass)
+      DataMapper::Associations::ManyToOne.module_eval do
+        extend DataMapper::CounterCacheable::ClassMethods
+        
+        (class << self; self; end).class_eval do
+          unless method_defined?(:setup_without_counter_caching)
+            alias_method :setup_without_counter_caching, :setup 
+            alias_method :setup, :setup_with_counter_caching
+          end
+        end
+
+      end
+    end
+
+    module ClassMethods
+      
+      def setup_with_counter_caching(name, model, options = {})
+        perform_counter_cache = options.delete(:counter_cache)
+
+        relationship = setup_without_counter_caching(name, model, options)
+
+        if perform_counter_cache
+          counter_cache_attribute = case perform_counter_cache
+                                    when String, Symbol
+                                      perform_counter_cache.to_sym
+                                    else
+                                      "#{model.storage_name}_count".to_sym
+                                    end
+
+          model.extend(ModelClassMethods)
+          model.__send__(:include, InstanceMethods)
+
+          model.define_counter_cache_callbacks_for(relationship, counter_cache_attribute)
+        end
+
+        relationship
+      end
+
+    end # ClassMethods
+
+    module ModelClassMethods
+      def define_counter_cache_callbacks_for(relationship, counter_cache_attribute)
+        return if defined_counter_cache_callbacks_for?(counter_cache_attribute)
+
+        self.after(:create)  { adjust_counter_cache_for(relationship, counter_cache_attribute, +1) }
+        self.after(:destroy) { adjust_counter_cache_for(relationship, counter_cache_attribute, -1) }
+
+        counter_caches[counter_cache_attribute] = true
+      end # register_counter_cache_callbacks_for(relationship, counter_cache_attribute)
+
+      def defined_counter_cache_callbacks_for?(attribute)
+        !counter_caches[attribute].nil?
+      end # defined_counter_cache_callbacks_for?(attribute)
+
+      def counter_caches
+        @_counter_caches ||= {}
+      end # counter_caches
+    end
+
+    module InstanceMethods
+      protected
+      def adjust_counter_cache_for(relationship, counter_cache_attribute, amount)
+        association = get_association(relationship)
+
+        return unless  relationship.parent_model.properties.has_property?(counter_cache_attribute)
+        association.update_attributes(counter_cache_attribute => association.reload.__send__(counter_cache_attribute) + amount)
+      end
+
+      def get_association(relationship)
+        self.__send__("#{relationship.name}_association".to_sym)
+      end # get_association(name)
+    end # InstanceMethods
+
+  end # CounterCacheable
+end # DataMapper
+
+if $0 == __FILE__
+  require 'rubygems'
+
+  gem 'dm-core', '~>0.9.8'
+  require 'dm-core'
+
+  FileUtils.touch(File.join(Dir.pwd, "migration_test.db"))
+  DataMapper.setup(:default, "sqlite3://#{Dir.pwd}/migration_test.db")
+
+  class Post
+    include DataMapper::Resource
+
+    property :id, Integer, :serial => true
+    has n, :comments
+  end
+  Post.auto_migrate!
+  
+  class Comment
+    include DataMapper::Resource
+    include DataMapper::CounterCacheable
+
+    belongs_to :post, :counter_cache => true
+  end
+  Comments.auto_migrate!
+
+  Post.create.comments.create
+end

data/spec/integration/dm-counter-cache_spec.rb

@@ -0,0 +1,87 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+describe DataMapper::CounterCacheable do
+  before :all do
+    class Post
+      include DataMapper::Resource
+
+      property :id, Integer, :serial => true
+      property :comments_count, Integer, :default => 0
+      has n, :comments
+    end
+    
+    class Comment
+      include DataMapper::Resource
+      include DataMapper::CounterCacheable  
+
+      property :id, Integer, :serial => true
+      belongs_to :post, :counter_cache => true
+
+    end
+    
+    class User
+      include DataMapper::Resource
+
+      property :id, Integer, :serial => true
+      property :groups_count, Integer, :default => 0      
+
+      has n, :group_memberships
+      has n, :groups, :through => :group_memberships, :class_name => "Group", :remote_name => :group, :parent_key => [:id], :child_key => [:user_id]
+    end
+    
+    class Group
+      include DataMapper::Resource
+
+      property :id, Integer, :serial => true
+      property :members_count, Integer, :default => 0
+      has n, :group_memberships
+      has n, :members, :through => :group_memberships, :class_name => "User", :remote_name => :user, :parent_key => [:id], :child_key => [:group_id]
+    end
+
+    class GroupMembership
+      include DataMapper::Resource
+      include DataMapper::CounterCacheable
+
+      property :id, Serial
+
+      belongs_to :group, :counter_cache => :members_count
+      belongs_to :member, :class_name => "User", :child_key => [:user_id], :counter_cache => :groups_count
+    end    
+
+    GroupMembership.auto_migrate!
+    User.auto_migrate!
+    Group.auto_migrate!
+    Comment.auto_migrate!
+    Post.auto_migrate!
+  end
+
+  before(:each) do
+    @post = Post.create
+    @user = User.create
+    @group = Group.create
+  end
+
+  it "should increment comments_count" do
+    @post.comments.create
+    @post.reload.comments_count.should == 1
+    
+    @user.group_memberships.create(:group => @group)
+    @user.reload.groups_count.should == 1
+    @group.reload.members_count.should == 1
+  end
+
+  it "should decrement comments_count" do
+    comment1 = @post.comments.create    
+    comment2 = @post.comments.create
+    comment2.destroy
+    @post.reload.comments_count.should == 1
+    
+    gm1 = @user.group_memberships.create(:group => @group)
+    gm2 = @user.group_memberships.create(:group => @group)
+    gm2.destroy
+    @user.reload.groups_count.should == 1
+    @group.reload.members_count.should == 1    
+  end
+
+end

data/spec/integration/multiple_define_spec.rb

@@ -0,0 +1,50 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe DataMapper::CounterCacheable do
+  context "when attribute with counter_cache declared twice" do
+    module Multiple
+      class Post
+        include DataMapper::Resource
+
+        property :id, Integer, :serial => true
+        property :comments_count, Integer, :default => 0
+        has n, :comments, :class_name => 'Multiple::Comment'
+      end
+
+      class Comment
+        include DataMapper::Resource
+        include DataMapper::CounterCacheable
+
+        property :id, Integer, :serial => true
+        belongs_to :post, :class_name => 'Multiple::Post', :counter_cache => :comments_count
+        belongs_to :post, :class_name => 'Multiple::Post', :counter_cache => :comments_count
+      end
+
+      Comment.auto_migrate!
+      Post.auto_migrate!
+    end
+
+    before :each do
+      @post = Multiple::Post.create
+    end
+
+    it "should increment counter only once" do
+      lambda do
+        @post.comments.create
+        @post.reload
+      end.should change(@post, :comments_count).by(+1)
+    end
+
+    it "should decrement counter only once" do
+      comment1 = @post.comments.create
+      comment2 = @post.comments.create
+      @post.reload
+
+      lambda do
+        comment1.destroy
+        @post.reload
+      end.should change(@post, :comments_count).by(-1)
+    end
+
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'pathname'
+require 'rubygems'
+
+gem 'rspec', '>1.1.11'
+require 'spec'
+
+gem 'dm-core', '0.9.12'
+require 'dm-core'
+
+require Pathname(__FILE__).dirname.parent.expand_path + 'lib/dm-counter-cache'
+
+def load_driver(name, default_uri)
+  return false if ENV['ADAPTER'] != name.to_s
+
+  begin
+    DataMapper.setup(name, ENV["#{name.to_s.upcase}_SPEC_URI"] || default_uri)
+    DataMapper::Repository.adapters[:default] =  DataMapper::Repository.adapters[name]
+    true
+  rescue LoadError => e
+    warn "Could not load do_#{name}: #{e}"
+    false
+  end
+end
+
+ENV['ADAPTER'] ||= 'sqlite3'
+
+HAS_SQLITE3  = load_driver(:sqlite3,  'sqlite3::memory:')
+HAS_MYSQL    = load_driver(:mysql,    'mysql://localhost/dm_core_test')
+HAS_POSTGRES = load_driver(:postgres, 'postgres://postgres@localhost/dm_core_test')

data/tasks/install.rb

@@ -0,0 +1,13 @@
+def sudo_gem(cmd)
+  sh "#{SUDO} #{RUBY} -S gem #{cmd}", :verbose => false
+end
+
+desc "Install #{GEM_NAME} #{GEM_VERSION}"
+task :install => [ :package ] do
+  sudo_gem "install --local pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources"
+end
+
+desc "Uninstall #{GEM_NAME} #{GEM_VERSION}"
+task :uninstall => [ :clobber ] do
+  sudo_gem "uninstall #{GEM_NAME} -v#{GEM_VERSION} -Ix"
+end

data/tasks/spec.rb

@@ -0,0 +1,25 @@
+begin
+  gem 'rspec', '~>1.1.11'
+  require 'spec'
+  require 'spec/rake/spectask'
+
+  task :default => [ :spec ]
+
+  desc 'Run specifications'
+  Spec::Rake::SpecTask.new(:spec) do |t|
+    t.spec_opts << '--options' << 'spec/spec.opts' if File.exists?('spec/spec.opts')
+    t.spec_files = Pathname.glob((ROOT + 'spec/**/*_spec.rb').to_s)
+
+    begin
+      gem 'rcov', '~>0.8'
+      t.rcov = JRUBY ? false : (ENV.has_key?('NO_RCOV') ? ENV['NO_RCOV'] != 'true' : true)
+      t.rcov_opts << '--exclude' << 'spec'
+      t.rcov_opts << '--text-summary'
+      t.rcov_opts << '--sort' << 'coverage' << '--sort-reverse'
+    rescue LoadError
+      # rcov not installed
+    end
+  end
+rescue LoadError
+  # rspec not installed
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: dzema_dm-counter-cache
+version: !ruby/object:Gem::Version 
+  version: 0.9.12
+platform: ruby
+authors: 
+- Saimon Moore
+- Dmitriy Dzema
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-15 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.12
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.3
+    version: 
+description: DataMapper plugin for counter caches ala ActiveRecord. Original idea and implementation by Saimon Moore (daimonmoore [a] gmail [d] com)
+email: 
+- daimonmoore [a] gmail [d] com
+- dima [a] dzema [d] name
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+- LICENSE
+- TODO
+- History.txt
+files: 
+- History.txt
+- LICENSE
+- Manifest.txt
+- README.txt
+- Rakefile
+- TODO
+- lib/dm-counter-cache.rb
+- lib/dm-counter-cache/version.rb
+- spec/integration/dm-counter-cache_spec.rb
+- spec/integration/multiple_define_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/install.rb
+- tasks/spec.rb
+has_rdoc: true
+homepage: http://github.com/DimaD/dm-counter-cache
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: datamapper
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: DataMapper plugin for counter caches ala ActiveRecord. Original idea and implementation by Saimon Moore (daimonmoore [a] gmail [d] com)
+test_files: []
+