counter-cache 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 381fdac0060611f59b5314096aa953310c927a98
+  data.tar.gz: 94cfd0f2f7f91c8e7fd3e6c2f2579d26fee90904
+SHA512:
+  metadata.gz: 41ac6baff5ade8a503c71244efcbfd584982e0ec9ea00bde813c0797100f30044e9304c922e3f20afbab0a3e82b3c5e4c9efb5cc90125cadab6d52901b85e0b8
+  data.tar.gz: aa2e8b95531190a0cddcc33d5f88f4a7a332a2646f8ff39784db5ecaea567e431a6fb7af23ab06375172b613d6f28c24081cc6f5b9b043bd7f65bf7066cbd041

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+notifications:
+  email:
+    on_success: never
+webhooks: "http://ci.wanelo.com/projects/2f4c3438-a0bc-434e-a9fb-30c0c335b432/status"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in counter-cache.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 James Hart & Matt Camuto
+
+MIT License
+
+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,29 @@
+# Counter::Cache
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'counter-cache'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install counter-cache
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/counter-cache/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/counter-cache.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'counter/cache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "counter-cache"
+  spec.version       = Counter::Cache::VERSION
+  spec.authors       = ["Paul Henry & Matt Camuto"]
+  spec.email         = ["dev@wanelo.com"]
+  spec.summary       = %q{Counting is hard.}
+  spec.description   = %q{This makes it easier.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", ">= 3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 3.0"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "fakeredis"
+  spec.add_development_dependency "sqlite3"
+end

data/lib/counter/cache.rb

@@ -0,0 +1,28 @@
+require "counter/cache/version"
+require "counter/cache/active_record_updater"
+require "counter/cache/options_parser"
+require "counter/cache/config"
+require "counter/cache/counters/buffer_counter"
+require "counter/cache/redis"
+
+module Counter
+
+  module Cache
+    def self.configure
+      yield configuration
+    end
+
+    def self.configuration
+      @configuration ||= Counter::Cache::Config.new
+    end
+
+    def self.included(base)
+      base.instance_eval do
+        def counter_cache_on(options)
+          after_create ActiveRecordUpdater.new(options)
+          after_destroy ActiveRecordUpdater.new(options)
+        end
+      end
+    end
+  end
+end

data/lib/counter/cache/active_record_updater.rb

@@ -0,0 +1,23 @@
+module Counter
+  module Cache
+    class ActiveRecordUpdater < Struct.new(:options)
+      def after_create(record)
+        counter_for(record).update(:incr)
+      end
+
+      def after_destroy(record)
+        counter_for(record).update(:decr)
+      end
+
+      private
+
+      def counter_for(object)
+        counter_class.new(object, options)
+      end
+
+      def counter_class
+        options[:counter_class] || Counter::Cache::Counters::BufferCounter
+      end
+    end
+  end
+end

data/lib/counter/cache/config.rb

@@ -0,0 +1,12 @@
+module Counter
+  module Cache
+    class Config
+      # TODO:: Confer with paul/kig about adapting the counting data store
+      attr_accessor :default_worker_adapter, :recalculation_delay, :redis_pool, :counting_data_store
+
+      def initialize
+        self.counting_data_store = Counter::Cache::Redis.new
+      end
+    end
+  end
+end

data/lib/counter/cache/counters/buffer_counter.rb

@@ -0,0 +1,25 @@
+require 'counter/cache/counters/buffer_counter/updater'
+require 'counter/cache/counters/buffer_counter/saver'
+
+module Counter
+  module Cache
+    module Counters
+      class BufferCounter
+        attr_accessor :source_object, :options
+
+        def initialize(source_object, options)
+          @options = Counter::Cache::OptionsParser.new(options)
+          @source_object = source_object
+        end
+
+        def update(direction)
+          Updater.new(source_object, options, self.class.name).update!(direction)
+        end
+
+        def save!(&block)
+          Saver.new(options).save!(&block)
+        end
+      end
+    end
+  end
+end

data/lib/counter/cache/counters/buffer_counter/enqueuer.rb

@@ -0,0 +1,27 @@
+module Counter
+  module Cache
+    module Counters
+      class BufferCounter
+        class Enqueuer < Struct.new(:options, :source_object_class_name, :relation_id, :relation_class, :counter_class_name)
+          def enqueue!(source_object)
+            create_and_enqueue(options.wait(source_object), options.cached?)
+            create_and_enqueue(options.recalculation_delay, false) if options.recalculation?
+          end
+
+          private
+
+          def create_and_enqueue(delay, cached)
+            options.worker_adapter.enqueue(delay,
+                                           source_object_class_name,
+                                           { relation_class_name: relation_class,
+                                             relation_id: relation_id,
+                                             column: options.column,
+                                             method: options.method,
+                                             cache: cached,
+                                             counter: counter_class_name })
+          end
+        end
+      end
+    end
+  end
+end

data/lib/counter/cache/counters/buffer_counter/key.rb

@@ -0,0 +1,23 @@
+module Counter
+  module Cache
+    module Counters
+      class BufferCounter
+        class Key < Struct.new(:source_object, :options)
+          def to_s
+            "cc:#{relation_finder.relation_class.to_s[0..1]}:#{relation_finder.relation_id}:#{column}"
+          end
+
+          protected
+
+          def column
+            options.column.to_s.gsub(/_count/, '')
+          end
+
+          def relation_finder
+            RelationFinder.new(source_object, options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/counter/cache/counters/buffer_counter/relation_finder.rb

@@ -0,0 +1,29 @@
+module Counter
+  module Cache
+    module Counters
+      class BufferCounter
+        class RelationFinder < Struct.new(:source_object, :options)
+          def relation_class
+            return options.relation_class_name if options.relation_class_name
+            return polymorphic_type if options.polymorphic?
+            reflection_type
+          end
+
+          def relation_id
+            options.relation_id || source_object.send("#{options.relation}_id")
+          end
+
+          private
+
+          def polymorphic_type
+            source_object.send("#{options.relation}_type")
+          end
+
+          def reflection_type
+            source_object.reflections[options.relation.to_sym].class_name.to_s.camelize # let AR give us the correct class name :)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/counter/cache/counters/buffer_counter/saver.rb

@@ -0,0 +1,70 @@
+module Counter
+  module Cache
+    module Counters
+      class BufferCounter
+        class Saver < Struct.new(:options)
+          def save!
+            return unless relation_object
+
+            old_value = current_column_value
+            new_value = calculate_new_value
+
+            save_new_value!(new_value)
+
+            yield old_value, new_value, relation_object, options.column if block_given?
+          end
+
+          private
+
+          def save_new_value!(value)
+            relation_object.send("#{options.column}=", value)
+            relation_object.save!(validate: false)
+          end
+
+          def calculate_new_value
+            return current_column_value + counter_value.to_i if options.cached? && counter_value
+            non_cached_count.to_i
+          end
+
+          def non_cached_count
+            method = options.method
+            return relation_object.send(method) if method && relation_object.respond_to?(method)
+            relation_object.send(options.source_object_class_name.table_name).count
+          end
+
+          def current_column_value
+            relation_object.send(options.column).to_i
+          end
+
+          def counter_value
+            @counter_value ||= get.tap { |v| reset if v }
+          end
+
+          def get
+            counting_data_store.get(key)
+          end
+
+          def reset
+            counting_data_store.del(key)
+          end
+
+          def key
+            Key.new(nil, options).to_s
+          end
+
+          def counting_data_store
+            Counter::Cache.configuration.counting_data_store
+          end
+
+          def relation_object
+            @relation_object ||= constantized_relation.find_by_id(options.relation_id)
+          end
+
+          def constantized_relation
+            Object.const_get(options.relation_class_name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/counter/cache/counters/buffer_counter/updater.rb

@@ -0,0 +1,54 @@
+require 'counter/cache/counters/buffer_counter/relation_finder'
+require 'counter/cache/counters/buffer_counter/enqueuer'
+require 'counter/cache/counters/buffer_counter/key'
+
+module Counter
+  module Cache
+    module Counters
+      class BufferCounter
+        class Updater < Struct.new(:source_object, :options, :counter_class_name)
+          def update!(direction)
+            return unless valid?
+            incr if direction == :incr
+            decr if direction == :decr
+            enqueue
+          end
+
+          private
+
+          def enqueue
+            Enqueuer.new(options,
+                         source_object.class.name,
+                         relation_finder.relation_id,
+                         relation_finder.relation_class,
+                         counter_class_name).enqueue!(source_object)
+          end
+
+          def relation_finder
+            RelationFinder.new(source_object, options)
+          end
+
+          def valid?
+            (!options.if_value || options.if_value.call(source_object)) && !relation_finder.relation_id.nil?
+          end
+
+          def incr
+            redis.incr(key)
+          end
+
+          def decr
+            redis.decr(key)
+          end
+
+          def key
+            Key.new(source_object, options).to_s
+          end
+
+          def redis
+            Counter::Cache::Redis.new
+          end
+        end
+      end
+    end
+  end
+end