cache_counters 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Brian Bommarito
+
+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.rdoc

@@ -0,0 +1,17 @@
+= cache_counters
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Brian Bommarito. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "cache_counters"
+    gem.summary = %Q{Counter caches for general counters}
+    gem.description = %Q{Creates a generic counter cache for those counter caches that do not fit anywere else}
+    gem.email = "bommarito.brian.matthew@gmail.com"
+    gem.homepage = "http://github.com/bommaritobrianmatthew/cache_counters"
+    gem.authors = ["Brian Bommarito"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.files =  FileList["[A-Z]*", "{bin,rails_generators,lib,spec}/**/*", 'lib/jeweler/templates/.gitignore']
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cache_counters #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/cache_counters.rb

@@ -0,0 +1,2 @@
+require 'cache_counters/acts_as_cache'
+require 'cache_counters/class_methods'

data/lib/cache_counters/acts_as_cache.rb

@@ -0,0 +1,17 @@
+module ActiveRecord
+  module Acts
+    module CounterCaches
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def acts_as_counter
+          class_eval do
+            extend CacheCountersClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cache_counters/class_methods.rb

@@ -0,0 +1,33 @@
+module ActiveRecord
+  module Acts
+    module CounterCaches
+      module ClassMethods
+        module CacheCountersClassMethods
+          def [](key)
+            find_or_create_by_key(key.to_s).value  
+          end
+          
+          protected
+
+          def method_missing(method, *args, &block)
+            if method.to_s =~ /^increment_(.*)$/
+              record = self.find_or_create_by_key($1.to_s)
+              record.increment!(:value)
+            elsif method.to_s =~ /^decrement_(.*)$/
+              record = self.find_or_create_by_key($1.to_s)
+              record.decrement!(:value)
+            elsif method.to_s =~ /^reset_(.*)$/
+              record = self.find_or_create_by_key($1.to_s)
+              record.update_attribute(:value, 0)
+            elsif method.to_s =~ /^destroy_(.*)$/
+              record = self.find_or_create_by_key($1.to_s)
+              record.destroy
+            else
+              super
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rails_generators/cache_counters/cache_counters_generator.rb

@@ -0,0 +1,35 @@
+class CacheCountersGenerator < Rails::Generator::Base
+  attr_accessor :model_name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+
+    @model_name = @args[0] || 'counter'
+  end
+
+  def manifest
+    record do |m|
+      m.directory "app/models"
+
+      m.template "counter.rb", "app/models/#{model_singular_name}.rb"
+
+      m.migration_template "migration.rb", "db/migrate", :migration_file_name => "create_#{model_plural_name}"
+    end
+  end
+
+  def model_singular_name
+    model_name.underscore
+  end
+
+  def model_plural_name
+    model_singular_name.pluralize
+  end
+
+  def model_class_name
+    model_name.camelize
+  end
+
+  def model_plural_class_name
+    model_plural_name.camelize
+  end
+end

data/rails_generators/cache_counters/templates/counter.rb

@@ -0,0 +1,3 @@
+class <%= model_class_name %> < ActiveRecord::Base
+  acts_as_counter
+end

data/rails_generators/cache_counters/templates/migration.rb

@@ -0,0 +1,14 @@
+class Create<%= model_plural_class_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= model_plural_name %> do |t|
+      t.string :key, :null => false
+      t.integer :value, :null => false, :default => true
+    end
+    add_index(:<%= model_plural_name %>, :key)
+  end
+
+  def self.down
+    remove_index(:<%= model_plural_name %>, :key)
+    drop_table :<%= model_plural_name %>
+  end
+end

data/spec/cache_counters_spec.rb

@@ -0,0 +1,43 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "CacheCounters" do
+  before(:each) do
+    Counter.delete_all
+  end
+
+  it "should find an existing counter" do
+    Counter.create(:key => "count")
+    Counter[:count].should == 0
+  end
+
+  it "should create a non-existent key" do
+    Counter[:missing].should == 0
+  end
+
+  it "should increment a counter by 1" do
+    Counter[:count].should == 0
+    Counter.increment_count
+    Counter[:count].should == 1
+  end
+
+  it "should decrement a counter by 1" do
+    Counter.increment_count
+    Counter[:count].should == 1
+    Counter.decrement_count
+    Counter[:count].should == 0
+  end
+
+  it "should reset the counter to 0" do
+    Counter.increment_count
+    Counter[:count].should == 1
+    Counter.reset_count
+    Counter[:count].should == 0
+  end
+
+  it "should delete the counter" do
+    Counter[:count].should == 0
+    Counter.destroy_count
+    Counter.find_by_key("count").should be_nil
+    Counter.increment_count
+  end
+end

data/spec/debug.log

@@ -0,0 +1,81 @@
+# Logfile created on Sat Jan 23 10:59:45 -0500 2010 by logger.rb
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.
+** acts_as_counter: initialized properly.

data/spec/schema.rb

@@ -0,0 +1,8 @@
+ActiveRecord::Schema.define :version => 0 do
+  create_table "counters", :force => true do |t|
+    t.string   "key",   :null => false
+    t.integer  "value", :null => false, :default => 0
+  end
+
+  add_index "counters", ["key"], :name => "index_counters_on_key"
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'active_record'
+require 'cache_counters'
+require 'spec'
+require 'spec/autorun'
+
+TEST_DATABASE_FILE = File.join(File.dirname(__FILE__), '..', 'test.sqlite3')
+
+File.unlink(TEST_DATABASE_FILE) if File.exist?(TEST_DATABASE_FILE)
+ActiveRecord::Base.establish_connection(
+  "adapter" => "sqlite3", "database" => TEST_DATABASE_FILE
+)
+
+RAILS_DEFAULT_LOGGER = Logger.new(File.join(File.dirname(__FILE__), "debug.log"))
+
+ActiveRecord::Base.silence do
+  ActiveRecord::Migration.verbose = false
+  load(File.dirname(__FILE__) + '/schema.rb')
+end
+
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
+require File.join(File.dirname(__FILE__), '..', 'init')
+
+class Counter < ActiveRecord::Base
+  acts_as_counter
+end
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: cache_counters
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Brian Bommarito
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-23 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: Creates a generic counter cache for those counter caches that do not fit anywere else
+email: bommarito.brian.matthew@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/cache_counters.rb
+- lib/cache_counters/acts_as_cache.rb
+- lib/cache_counters/class_methods.rb
+- rails_generators/cache_counters/cache_counters_generator.rb
+- rails_generators/cache_counters/templates/counter.rb
+- rails_generators/cache_counters/templates/migration.rb
+- spec/cache_counters_spec.rb
+- spec/debug.log
+- spec/schema.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/bommaritobrianmatthew/cache_counters
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Counter caches for general counters
+test_files: 
+- spec/schema.rb
+- spec/cache_counters_spec.rb
+- spec/spec_helper.rb