counter-cache 0.0.1

data/spec/lib/counter/cache/buffer_counter_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+RSpec.describe Counter::Cache::Counters::BufferCounter do
+  let(:options) { {} }
+  let(:source_object) { double }
+  let(:counter) { Counter::Cache::Counters::BufferCounter.new(source_object, options) }
+
+  describe "#update" do
+    it "calls update! on an instance of an updater" do
+      updater = double
+      expect(updater).to receive(:update!).with(:blah)
+      expect(Counter::Cache::Counters::BufferCounter::Updater).to receive(:new).with(source_object,
+                                                                            an_instance_of(Counter::Cache::OptionsParser),
+                                                                            "Counter::Cache::Counters::BufferCounter").and_return(updater)
+      counter.update(:blah)
+    end
+  end
+
+  describe "#save!" do
+    it "calls save! on an instance of a saver" do
+      saver = double
+      expect(saver).to receive(:save!)
+      expect(Counter::Cache::Counters::BufferCounter::Saver).to receive(:new).with(an_instance_of(Counter::Cache::OptionsParser)).and_return(saver)
+      counter.save!
+    end
+  end
+end

data/spec/lib/counter/cache/config_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+RSpec.describe Counter::Cache do
+  describe ".configure" do
+    let(:clazz) { Class.new }
+
+    it "sets counter class" do
+      Counter::Cache.configure do |config|
+        config.default_worker_adapter = clazz
+      end
+      expect(Counter::Cache.configuration.default_worker_adapter).to eq(clazz)
+    end
+
+    it "sets the redis connection" do
+      Counter::Cache.configure do |config|
+        config.redis_pool = clazz
+      end
+      expect(Counter::Cache.configuration.redis_pool).to eq(clazz)
+    end
+
+    describe "counting_data_store" do
+      it "sets counting_data_store" do
+        Counter::Cache.configure do |config|
+          config.counting_data_store = clazz
+        end
+        expect(Counter::Cache.configuration.counting_data_store).to eq(clazz)
+      end
+
+      it "defaults to redis with no option" do
+        expect(Counter::Cache.configuration.counting_data_store).to be_instance_of(Counter::Cache::Redis)
+      end
+    end
+
+
+  end
+end

data/spec/lib/counter/cache/options_parser_spec.rb

@@ -0,0 +1,176 @@
+require 'spec_helper'
+
+RSpec.describe Counter::Cache::OptionsParser do
+
+  subject(:parser) { Counter::Cache::OptionsParser.new options }
+  let(:options) { {} }
+
+  describe "#cached?" do
+    describe "if cache is nil" do
+      it "it should be true" do
+        expect(parser.cached?).to eq(true)
+      end
+    end
+
+    describe "if cache is false" do
+      let(:options) { { cache: false } }
+      it "it should be false" do
+        expect(parser.cached?).to eq(false)
+      end
+    end
+
+    describe "if cache is true" do
+      let(:options) { { cache: true } }
+      it "it should be false" do
+        expect(parser.cached?).to eq(true)
+      end
+    end
+  end
+
+  describe "#column" do
+    let(:options) { { column: "column_name" } }
+    it "returns option if set" do
+      expect(parser.column).to eq("column_name")
+    end
+  end
+
+  describe "#method" do
+    let(:options) { { method: "method" } }
+    it "returns option if set" do
+      expect(parser.method).to eq("method")
+    end
+  end
+
+  describe "#polymorphic" do
+    let(:options) { { polymorphic: true } }
+
+    it "returns option if set" do
+      expect(parser.polymorphic?).to eq(true)
+    end
+  end
+
+  describe "#if_value" do
+    let(:options) { { if: true } }
+
+    it "returns option if set" do
+      expect(parser.if_value).to eq(true)
+    end
+  end
+
+  describe "#recalculation?" do
+    describe "if cache is nil" do
+      it "it should be true" do
+        expect(parser.recalculation?).to eq(true)
+      end
+    end
+
+    describe "if cache is false" do
+      let(:options) { { recalculation: false } }
+      it "it should be false" do
+        expect(parser.recalculation?).to eq(false)
+      end
+    end
+
+    describe "if cache is true" do
+      let(:options) { { recalculation: true } }
+      it "it should be false" do
+        expect(parser.recalculation?).to eq(true)
+      end
+    end
+  end
+
+  describe "#recalculation_delay" do
+    describe "With a option" do
+      let(:options) { { recalculation_delay: 1245 } }
+      it "returns if option is set" do
+        expect(parser.recalculation_delay).to eq(1245)
+      end
+    end
+
+    describe "With no option" do
+      it "returns default if no option is set" do
+        Counter::Cache.configure do |config|
+          config.recalculation_delay = 897
+        end
+        expect(parser.recalculation_delay).to eq(897)
+      end
+    end
+  end
+
+  describe "#relation" do
+    let(:options) { { relation: "relation_name" } }
+    it "returns option if set" do
+      expect(parser.relation).to eq("relation_name")
+    end
+  end
+
+  describe "#relation_class_name" do
+    let(:options) { { relation_class_name: "relation_class_name" } }
+    it "returns option if set" do
+      expect(parser.relation_class_name).to eq("relation_class_name")
+    end
+  end
+
+  describe "#relation_id" do
+    let(:options) { { relation_id: 1 } }
+
+    it "returns option if set" do
+      expect(parser.relation_id).to eq(1)
+    end
+  end
+
+  describe "#source_object_class_name" do
+    let(:options) { { source_object_class_name: "class_name" } }
+    it "returns option if set" do
+      expect(parser.source_object_class_name).to eq("class_name")
+    end
+  end
+
+  describe "#wait" do
+    let(:source_object) { double("src_obj") }
+
+    describe "with a value" do
+      let(:options) { { wait: 1234 } }
+
+      it "returns option if set" do
+        expect(parser.wait(source_object)).to eq(1234)
+      end
+    end
+
+    describe "with a proc" do
+      let(:wait_double) { double("callee", call: 123456) }
+      let(:options) { { wait: wait_double } }
+
+      it "returns option if set" do
+        expect(parser.wait(source_object)).to eq(123456)
+      end
+    end
+  end
+
+
+  describe "#worker" do
+    describe "With a specified worker" do
+      let(:options) { { worker_adapter: "Fake" } }
+      it "returns worker on option" do
+        expect(parser.worker_adapter).to eq("Fake")
+      end
+    end
+
+    describe "With no options" do
+      let(:options) { {} }
+      let(:clazz) { Class.new }
+
+      before do
+        Counter::Cache.configure do |config|
+          config.default_worker_adapter = clazz
+        end
+      end
+
+      it "returns worker on option" do
+        expect(parser.worker_adapter).to eq(clazz)
+      end
+    end
+  end
+
+
+end

data/spec/lib/counter/cache/redis_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+RSpec.describe Counter::Cache::Redis do
+  let(:redis) { double }
+  let(:redis_pool) { double }
+
+  before do
+    Counter::Cache.configure do |c|
+      c.redis_pool = redis_pool
+    end
+
+    allow(redis_pool).to receive(:with).and_yield(redis)
+  end
+
+  let(:helper) { Counter::Cache::Redis.new }
+
+  describe '#decr' do
+    it 'calls decr on redis with the key' do
+      expect(redis).to receive(:decr).with("hello")
+      helper.decr("hello")
+    end
+  end
+
+  describe '#incr' do
+    it 'calls incr on redis with the key' do
+      expect(redis).to receive(:incr).with("hello")
+      helper.incr("hello")
+    end
+  end
+
+  describe '#del' do
+    it 'calls del on redis with the key' do
+      expect(redis).to receive(:del).with("hello")
+      helper.del("hello")
+    end
+  end
+
+  describe '#get' do
+    it 'calls get on redis with the key and returns the value' do
+      expect(redis).to receive(:get).with("hello").and_return(2)
+      expect(helper.get("hello")).to eq(2)
+    end
+  end
+end

data/spec/lib/counter/cache_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+RSpec.describe Counter::Cache do
+  describe '.included' do
+    let(:counter) { double(:counter) }
+    let(:clazz) { Class.new { include Counter::Cache } }
+
+    it 'listens to the after_create and after_destroy' do
+      expect(clazz).to receive(:after_create).with(an_instance_of(Counter::Cache::ActiveRecordUpdater)).once { true }
+      expect(clazz).to receive(:after_destroy).with(an_instance_of(Counter::Cache::ActiveRecordUpdater)).once { true }
+      clazz.counter_cache_on :counter => counter
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,93 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'counter/cache'
+
+RSpec.configure do |config|
+
+  config.before do
+    Counter::Cache.instance_variable_set(:@configuration, nil)
+  end
+
+  config.after do
+    Counter::Cache.instance_variable_set(:@configuration, nil)
+  end
+
+  config.raise_errors_for_deprecations!
+  config.disable_monkey_patching!
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+=end
+end

data/spec/support/models.rb

@@ -0,0 +1,87 @@
+require 'active_record'
+
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+
+class CreateModelsForTest < ActiveRecord::Migration
+  def self.up
+    create_table :users do |t|
+      t.string :name
+      t.integer :posts_count, :default => 0
+      t.integer :posts_ar_count, :default => 0
+      t.integer :followers_count, :default => 0
+      t.integer :users_i_follow_count, :default => 0
+      t.integer :bogus_followed_count, :default => 0
+    end
+
+    create_table :follows do |t|
+      t.integer :user_id
+      t.integer :followee_id
+      t.string :followee_type
+    end
+
+    create_table :posts do |t|
+      t.string :body
+      t.belongs_to :user
+    end
+  end
+
+  def self.down
+    drop_table(:users)
+    drop_table(:posts)
+    drop_table(:follows)
+  end
+end
+
+class User < ActiveRecord::Base
+  has_many :posts
+
+  def calculate_posts_count
+    posts.count
+  end
+
+  def calculate_bogus_follow_count
+    101
+  end
+
+end
+
+class Follow < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :followee, polymorphic: true
+
+  include Counter::Cache
+
+  counter_cache_on column: :followers_count,
+                   relation: :followee,
+                   polymorphic: true,
+                   recalculation: false
+
+  counter_cache_on column: :bogus_followed_count,
+                   relation: :followee,
+                   polymorphic: true,
+                   method: :calculate_bogus_follow_count,
+                   recalculation: true
+
+  counter_cache_on column: :users_i_follow_count,
+                   relation: :user,
+                   if: ->(follow) { follow.followee_type == "User" },
+                   recalculation: false
+end
+
+class Post < ActiveRecord::Base
+  belongs_to :user
+
+  include Counter::Cache
+
+  counter_cache_on column: :posts_count,
+                   relation: :user,
+                   relation_class_name: "User",
+                   method: :calculate_posts_count,
+                   recalculation: false
+
+  counter_cache_on column: :posts_ar_count,
+                   relation: :user,
+                   relation_class_name: "User",
+                   recalculation: false
+end