dm-is-counter_cacheable 0.1.0

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title 'dm-predefined Documentation' --protected --files ChangeLog.md,LICENSE.txt

data/ChangeLog.md

@@ -0,0 +1,6 @@
+### 0.1.0 / 2010-11-05
+
+* Initial release:
+  * Supports adding counter cache columns to `belongs_to` relationships.
+  * Supports custom names for counter cache columns.
+

data/Gemfile

@@ -0,0 +1,147 @@
+# If you're working on more than one datamapper gem at a time, then it's
+# recommended to create a local Gemfile and use this instead of the git
+# sources. This will make sure that you are  developing against your
+# other local datamapper sources that you currently work on. Gemfile.local
+# will behave identically to the standard Gemfile apart from the fact that
+# it fetches the datamapper gems from local paths. This means that you can
+# use the same environment variables, like ADAPTER(S) or PLUGIN(S) when
+# running
+# bundle commands. Gemfile.local is added to .gitignore, so you don't need
+# to worry about accidentally checking local development paths into git.
+# In order to create a local Gemfile, all you need to do is run:
+#
+#   bundle exec rake local_gemfile
+#
+# This will give you a Gemfile.local file that points to your local clones
+# of the various datamapper gems. It's assumed that all datamapper repo
+# clones reside in the same directory. You can use the Gemfile.local like
+# so for running any bundle command:
+#
+#   BUNDLE_GEMFILE=Gemfile.local bundle foo
+#
+# You can also specify which adapter(s) should be part of the bundle by
+# setting an environment variable. This of course also works when using the
+# Gemfile.local
+#
+#   bundle foo                        # dm-sqlite-adapter
+#
+#   ADAPTER=mysql bundle foo          # dm-mysql-adapter
+#
+#   ADAPTERS=sqlite,mysql bundle foo  # dm-sqlite-adapter, dm-mysql-adapter
+#
+# Of course you can also use the ADAPTER(S) variable when using the
+# Gemfile.local and running specs against selected adapters.
+#
+# For easily working with adapters supported on your machine, it's
+# recommended that you first install all adapters that you are planning to
+# use or work on by doing something like
+#
+#   ADAPTERS=sqlite,mysql,postgres bundle install
+#
+# This will clone the various repositories and make them available to
+# bundler. Once you have them installed you can easily switch between
+# adapters for the various development tasks. Running something like
+#
+#   ADAPTER=mysql bundle exec rake spec
+#
+# will make sure that the dm-mysql-adapter is part of the bundle, and will
+# be used when running the specs.
+#
+# You can also specify which plugin(s) should be part of the bundle by
+# setting an environment variable. This also works when using the
+# Gemfile.local
+#
+#   bundle foo                                 # dm-migrations
+#
+#   PLUGINS=dm-validations bundle foo          # dm-migrations,
+#                                              # dm-validations
+#
+#   PLUGINS=dm-validations,dm-types bundle foo # dm-migrations,
+#                                              # dm-validations,
+#                                              # dm-types
+#
+# Of course you can combine the PLUGIN(S) and ADAPTER(S) env vars to run
+# specs for certain adapter/plugin combinations.
+#
+# Finally, to speed up running specs and other tasks, it's recommended to
+# run
+#
+#   bundle lock
+#
+# after running 'bundle install' for the first time. This will make
+# 'bundle exec' run a lot faster compared to the unlocked version. With an
+# unlocked bundle you would typically just run 'bundle install' from time
+# to time to fetch the latest sources from upstream. When you locked your
+# bundle, you need to run
+#
+#   bundle install --relock
+#
+# to make sure to fetch the latest updates and then lock the bundle again.
+# Gemfile.lock is added to the .gitignore file, so you don't need to worry
+# about accidentally checking it into version control.
+
+source :rubygems
+
+DATAMAPPER = 'http://github.com/datamapper'
+DM_VERSION = '~> 1.0.0'
+DO_VERSION = '~> 0.10.2'
+DM_DO_ADAPTERS = %w[ sqlite postgres mysql oracle sqlserver ]
+RAILS = 'http://github.com/rails/rails.git'
+
+if ENV['EXTLIB']
+  gem 'extlib',		'~> 0.9.15', :git => '#{DATAMAPPER}/extlib.git'
+else
+  gem 'activesupport',  '~> 3.0.0', :git => RAILS,
+                                    :branch => '3-0-stable',
+                                    :require => nil
+end
+
+gem 'dm-core',	DM_VERSION, :git => "#{DATAMAPPER}/dm-core.git"
+
+group :development do
+  case RUBY_PLATFORM
+  when 'java'
+    gem 'maruku',	'~> 0.6.0'
+  else
+    gem 'rdiscount',	'~> 1.6.3'
+  end
+
+  gem 'rake',		'~> 0.8.7'
+  gem 'ore',		'~> 0.2.0'
+  gem 'ore-tasks',	'~> 0.1.2'
+  gem 'rspec',		'~> 2.0.0'
+  gem 'yard',		'~> 0.6.0'
+end
+
+group :datamapper do
+  # We need this because we want to pin these dependencies to their git
+  # master sources
+
+  adapters = ENV['ADAPTER'] || ENV['ADAPTERS']
+  adapters = adapters.to_s.tr(',', ' ').split.uniq - %w[ in_memory ]
+
+  if (do_adapters = DM_DO_ADAPTERS & adapters).any?
+    options = {}
+    options[:git] = "#{DATAMAPPER}/do.git" if ENV['DO_GIT'] == 'true'
+
+    gem 'data_objects',  DO_VERSION, options.dup
+
+    do_adapters.each do |adapter|
+      adapter = 'sqlite3' if adapter == 'sqlite'
+      gem "do_#{adapter}", DO_VERSION, options.dup
+    end
+
+    gem 'dm-do-adapter', DM_VERSION, :git => "#{DATAMAPPER}/dm-do-adapter.git"
+  end
+
+  adapters.each do |adapter|
+    gem "dm-#{adapter}-adapter", DM_VERSION, :git => "#{DATAMAPPER}/dm-#{adapter}-adapter.git"
+  end
+
+  plugins = ENV['PLUGINS'] || ENV['PLUGIN']
+  plugins = plugins.to_s.tr(',', ' ').split.push('dm-migrations').uniq
+
+  plugins.each do |plugin|
+    gem plugin, DM_VERSION, :git => "#{DATAMAPPER}/#{plugin}.git"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2008-2010 Hal Brodigan
+
+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,47 @@
+# dm-is-countercacheable
+
+* [github.com/postmodern/dm-is-counter_cacheable](http://github.com/postmodern/dm-is-counter_cacheable)
+* [github.com/postmodern/dm-is-counter_cacheable/issues](http://github.com/postmodern/dm-is-counter_cacheable/issues)
+* Postmodern (postmodern.mod3 at gmail.com)
+
+## Description
+
+A DataMapper plugin for adding counter-cache properties to related models.
+
+## Example
+
+Adds counter properties to Post and User for the number of comments:
+
+    require 'dm-core'
+    
+    class Comment
+    
+      include DataMapper::Resource
+    
+      is :counter_cacheable
+    
+      property :id, Serial
+    
+      property :body, Text
+    
+      belongs_to :post
+    
+      belongs_to :user
+    
+      counter_cacheable :post
+      counter_cacheable :user, :counter_property => :post_comments_counter
+    
+    end
+
+## Requirements
+
+* [dm-core](http://github.com/datamapper/dm-core/) ~> 1.0.0
+
+## Install
+
+    $ sudo gem install dm-is-countercacheable
+
+## License
+
+See {file:LICENSE.txt} for license information.
+

data/Rakefile

@@ -0,0 +1,29 @@
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `gem install bundler` to install Bundler."
+  exit e.status_code
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'ore/tasks'
+Ore::Tasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/dm-is-counter_cacheable.gemspec

@@ -0,0 +1,10 @@
+# -*- encoding: utf-8 -*-
+
+begin
+  Ore::Specification.new do |gemspec|
+    # custom logic here
+  end
+rescue NameError
+  STDERR.puts "The 'contextify.gemspec' file requires Ore."
+  STDERR.puts "Run `gem install ore` to install Ore."
+end

data/gemspec.yml

@@ -0,0 +1,18 @@
+name: dm-is-counter_cacheable
+version: 0.1.0
+summary: DataMapper plugin for adding counter-caching to models.
+description:
+  A DataMapper plugin for adding counter-cache properties to related models.
+
+license: MIT
+authors: Postmodern
+email: postmodern.mod3@gmail.com
+homepage: http://github.com/postmodern/dm-is-counter_cacheable
+has_yard: true
+
+dependencies:
+  dm-core: ~> 1.0.0
+
+development_dependencies:
+  bundler: ~> 1.0.0
+  yard: ~> 0.6.0

data/lib/dm-is-counter_cacheable/is/counter_cacheable.rb

@@ -0,0 +1,121 @@
+module DataMapper
+  module Is
+    module CounterCacheable
+      #
+      # Fired when your plugin gets included into a Resource.
+      #
+      def is_counter_cacheable
+        extend DataMapper::Is::CounterCacheable::ClassMethods
+        include DataMapper::Is::CounterCacheable::InstanceMethods
+      end
+
+      module ClassMethods
+        attr_reader :counter_cache
+
+        #
+        # Adds a counter cache property to a related model.
+        #
+        # @param [Symbol] relationship_name
+        #   The name of the related model.
+        #
+        # @param [Hash] options
+        #   Additional options.
+        #
+        # @option options [Symbol] :counter_property
+        #   The optional property name to store the counter cache in.
+        #
+        # @option options [Boolean] :counter_index
+        #   Specifies to store the current count in newly created resources.
+        #
+        # @return [DataMapper::Property]
+        #   The newly added counter cache property.
+        #
+        def counter_cacheable(relationship_name,options={})
+          @counter_cache ||= []
+
+          unless self.relationships.has_key?(relationship_name)
+            raise(RuntimeError,"unknown relationship #{relationship_name} in #{self}",caller)
+          end
+
+          model_name = DataMapper::NamingConventions::Resource::UnderscoredAndPluralized.call(self.name.split('::').last)
+          counter_property = if options.has_key?(:counter_property)
+                               options[:counter_property]
+                             else
+                               :"#{model_name}_counter"
+                             end
+
+          relationship = self.relationships[relationship_name]
+          parent_model = case relationship
+                         when DataMapper::Associations::ManyToOne::Relationship,
+                              DataMapper::Associations::OneToOne::Relationship
+                           relationship.parent_model
+                         end
+
+          parent_model.property counter_property, Integer, :default => 0, :min => 0
+
+          if options[:counter_index]
+            counter_index = :"#{relationship_name}_#{model_name}_index"
+
+            self.property counter_index, Integer, :min => 1
+          else
+            counter_index = nil
+          end
+
+          @counter_cache << {
+            :relationship => relationship_name,
+            :counter_property => counter_property,
+            :counter_index => counter_index
+          }
+        end
+      end
+
+      module InstanceMethods
+        private
+
+        #
+        # Creates a resource and increments the cache counters of the model.
+        #
+        # @return [DataMapper::Resource]
+        #   The new resource.
+        #
+        def _save(*arguments)
+          if (self.new? && self.class.counter_cache)
+            self.class.counter_cache.each do |options|
+              parent_resource = self.send(options[:relationship])
+
+              count = parent_resource.attribute_get(options[:counter_property])
+              count += 1
+
+              parent_resource.attribute_set(options[:counter_property],count)
+
+              if options[:counter_index]
+                self.attribute_set(options[:counter_index],count)
+              end
+            end
+          end
+
+          super(*arguments)
+        end
+
+        #
+        # Destroys a resource and decrements the cache counters of the model.
+        #
+        # @return [Boolean]
+        #   Specifies whether the resource was successfully destroyed.
+        #
+        def _destroy(*arguments)
+          if self.class.counter_cache
+            self.class.counter_cache.each do |options|
+              parent_resource = self.send(options[:relationship])
+
+              count = parent_resource.attribute_get(options[:counter_property])
+              parent_resource.attribute_set(options[:counter_property],count - 1)
+            end
+          end
+
+          super(*arguments)
+        end
+      end
+    end
+  end
+end

data/lib/dm-is-counter_cacheable.rb

@@ -0,0 +1,4 @@
+require 'dm-core'
+require 'dm-is-counter_cacheable/is/counter_cacheable'
+
+DataMapper::Model.append_extensions DataMapper::Is::CounterCacheable

data/spec/integration/counter_cacheable_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe DataMapper::Is::CounterCacheable do
+  before(:all) do
+    DataMapper.auto_migrate!
+
+    User.create(
+      :name => 'bob',
+      :posts => [
+        {:title => 'Hello', :body => 'Hello there.'}
+      ]
+    )
+  end
+
+  before(:each) do
+    @user = User.first
+    @post = @user.posts.first
+  end
+
+  it "should define the default counter cache property" do
+    Post.properties.should be_named('comments_counter')
+  end
+
+  it "should allow defining custom named counter cache properties" do
+    User.properties.should be_named('post_comments_counter')
+  end
+
+  it "should optionally define a counter index column" do
+    Comment.properties.should be_named('user_comments_index')
+  end
+
+  it "should have a counter cache of 0 by default" do
+    @post.comments_counter.should == 0
+  end
+
+  it "should increment the counter cache by 1 when a new resource is created" do
+    orig_counter = @post.comments_counter
+
+    @post.comments.create(
+      :body => 'lol',
+      :user => @user
+    )
+
+    new_counter = @post.comments_counter
+
+    (new_counter - orig_counter).should == 1
+  end
+
+  it "should increment the counter cache by 1 when a new resource is saved" do
+    orig_counter = @post.comments_counter
+
+    @post.comments.new(
+      :body => 'omg',
+      :user => @user
+    ).save
+
+    new_counter = @post.comments_counter
+
+    (new_counter - orig_counter).should == 1
+  end
+
+  it "should set the counter index to the counter value when a new resource is created" do
+    @post.comments.create(
+      :body => 'lol',
+      :user => @user
+    )
+
+    @post.comments.last.user_comments_index.should == @user.post_comments_counter
+  end
+
+  it "should decrement the counter cache by 1 when a resource is destroyed" do
+    @post.comments.create(
+      :body => 'wtf',
+      :user => @user
+    )
+
+    orig_counter = @post.comments_counter
+
+    @post.comments.first.destroy
+
+    new_counter = @post.comments_counter
+
+    (new_counter - orig_counter).should == -1
+  end
+end

data/spec/integration/models/comment.rb

@@ -0,0 +1,23 @@
+require 'dm-core'
+require 'dm-migrations'
+
+class Comment
+
+  include DataMapper::Resource
+  include DataMapper::Migrations
+
+  is :counter_cacheable
+
+  property :id, Serial
+
+  property :body, Text
+
+  belongs_to :post
+
+  belongs_to :user
+
+  counter_cacheable :post
+  counter_cacheable :user, :counter_property => :post_comments_counter,
+                           :counter_index => true
+
+end

data/spec/integration/models/post.rb

@@ -0,0 +1,19 @@
+require 'dm-core'
+require 'dm-migrations'
+
+class Post
+
+  include DataMapper::Resource
+  include DataMapper::Migrations
+
+  property :id, Serial
+
+  property :title, String
+
+  property :body, Text
+
+  has 0..n, :comments
+
+  belongs_to :user
+
+end

data/spec/integration/models/user.rb

@@ -0,0 +1,17 @@
+require 'dm-core'
+require 'dm-migrations'
+
+class User
+
+  include DataMapper::Resource
+  include DataMapper::Migrations
+
+  property :id, Serial
+
+  property :name, String
+
+  has 0..n, :posts
+
+  has 0..n, :comments, :through => :posts
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rspec'
+require 'dm-core/spec/setup'
+require 'dm-core/spec/lib/adapter_helpers'
+
+require 'dm-is-counter_cacheable'
+
+require 'integration/models/user'
+require 'integration/models/post'
+require 'integration/models/comment'
+
+DataMapper::Spec.setup
+
+RSpec.configure do |config|
+  config.extend(DataMapper::Spec::Adapters::Helpers)
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: dm-is-counter_cacheable
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Postmodern
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-05 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+description: A DataMapper plugin for adding counter-cache properties to related models.
+email: postmodern.mod3@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .rspec
+- .yardopts
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dm-is-counter_cacheable.gemspec
+- gemspec.yml
+- lib/dm-is-counter_cacheable.rb
+- lib/dm-is-counter_cacheable/is/counter_cacheable.rb
+- spec/integration/counter_cacheable_spec.rb
+- spec/integration/models/comment.rb
+- spec/integration/models/post.rb
+- spec/integration/models/user.rb
+- spec/spec_helper.rb
+has_rdoc: yard
+homepage: http://github.com/postmodern/dm-is-counter_cacheable
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: dm-is-counter_cacheable
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: DataMapper plugin for adding counter-caching to models.
+test_files: 
+- spec/integration/counter_cacheable_spec.rb