redis_counters 1.3.0

data/spec/support/unique_values_lists/expirable.rb

@@ -0,0 +1,162 @@
+# coding: utf-8
+shared_examples_for 'unique_values_lists/expirable' do
+  let(:redis) { MockRedis.new }
+  let(:counter) { described_class.new(redis, options) }
+
+  after do
+    Timecop.return
+  end
+
+  context 'when auto expire enabled' do
+    context 'when expire given in counter options' do
+      let(:options) { {
+        :counter_name   => :test_counter,
+        :value_keys     => [:value],
+        :partition_keys => [:part],
+        :expire         => 10.seconds
+      } }
+
+      before do
+        counter.add(:value => 1, :part => :part1)
+        counter.add(:value => 2, :part => :part2)
+        counter.add(:value => 3, :part => :part1, :expire => :never)
+        counter.add(:value => 4, :part => :part1, :expire => 20.seconds)
+      end
+
+      context 'before time has expired' do
+        before { Timecop.freeze(5.seconds.since) }
+
+        it { expect(counter.has_value?(:value => 1)).to be_true }
+        it { expect(counter.has_value?(:value => 2)).to be_true }
+        it { expect(counter.has_value?(:value => 3)).to be_true }
+        it { expect(counter.has_value?(:value => 4)).to be_true }
+
+        it { expect(counter.partitions).to include('part' => 'part1') }
+        it { expect(counter.partitions).to include('part' => 'part2') }
+
+        it { expect(counter.data).to include('value' => '1') }
+        it { expect(counter.data).to include('value' => '2') }
+        it { expect(counter.data).to include('value' => '3') }
+        it { expect(counter.data).to include('value' => '4') }
+      end
+
+      context 'after time has expired' do
+        before { Timecop.freeze(10.seconds.since) }
+
+        it { expect(counter.has_value?(:value => 1)).to be_false }
+        it { expect(counter.has_value?(:value => 2)).to be_false }
+        it { expect(counter.has_value?(:value => 3)).to be_true }
+
+        it { expect(counter.partitions).to include('part' => 'part1') }
+        it { expect(counter.partitions).to_not include('part' => 'part2') }
+
+        it { expect(counter.data).to_not include('value' => '1') }
+        it { expect(counter.data).to_not include('value' => '2') }
+        it { expect(counter.data).to include('value' => '3') }
+        it { expect(counter.data).to include('value' => '4') }
+      end
+    end
+
+    context 'when expire not given in counter options' do
+      let(:options) { {
+        :counter_name   => :test_counter,
+        :value_keys     => [:value],
+        :partition_keys => [:part]
+      } }
+
+      before do
+        counter.add(:value => 1, :part => :part1, :expire => 10.seconds)
+        counter.add(:value => 2, :part => :part2, :expire => 10.seconds)
+        counter.add(:value => 3, :part => :part1)
+        counter.add(:value => 4, :part => :part1, :expire => 20.seconds)
+      end
+
+      context 'before time has expired' do
+        before { Timecop.freeze(5.seconds.since) }
+
+        it { expect(counter.has_value?(:value => 1)).to be_true }
+        it { expect(counter.has_value?(:value => 2)).to be_true }
+        it { expect(counter.has_value?(:value => 3)).to be_true }
+        it { expect(counter.has_value?(:value => 4)).to be_true }
+
+        it { expect(counter.partitions).to include('part' => 'part1') }
+        it { expect(counter.partitions).to include('part' => 'part2') }
+
+        it { expect(counter.data).to include('value' => '1') }
+        it { expect(counter.data).to include('value' => '2') }
+        it { expect(counter.data).to include('value' => '3') }
+        it { expect(counter.data).to include('value' => '4') }
+      end
+
+      context 'after time has expired' do
+        before { Timecop.freeze(10.seconds.since) }
+
+        it { expect(counter.has_value?(:value => 1)).to be_false }
+        it { expect(counter.has_value?(:value => 2)).to be_false }
+        it { expect(counter.has_value?(:value => 3)).to be_true }
+        it { expect(counter.has_value?(:value => 4)).to be_true }
+
+        it { expect(counter.partitions).to include('part' => 'part1') }
+        it { expect(counter.partitions).to_not include('part' => 'part2') }
+
+        it { expect(counter.data).to_not include('value' => '1') }
+        it { expect(counter.data).to_not include('value' => '2') }
+        it { expect(counter.data).to include('value' => '3') }
+        it { expect(counter.data).to include('value' => '4') }
+      end
+    end
+  end
+
+  context 'when auto expire disabled' do
+    context 'when expire given in counter options' do
+      let(:options) { {
+        :counter_name   => :test_counter,
+        :value_keys     => [:value],
+        :partition_keys => [:part],
+        :expire         => 10.seconds,
+        :clean_expired  => false
+      } }
+
+      before do
+        counter.add(:value => 1, :part => :part1)
+        counter.add(:value => 2, :part => :part2)
+        counter.add(:value => 3, :part => :part1, :expire => :never)
+        counter.add(:value => 4, :part => :part1, :expire => 20.seconds)
+
+        Timecop.freeze(10.seconds.since)
+      end
+
+      context 'after time has expired' do
+        it { expect(counter.has_value?(:value => 1)).to be_true }
+        it { expect(counter.has_value?(:value => 2)).to be_true }
+        it { expect(counter.has_value?(:value => 3)).to be_true }
+        it { expect(counter.has_value?(:value => 4)).to be_true }
+
+        it { expect(counter.partitions).to include('part' => 'part1') }
+        it { expect(counter.partitions).to include('part' => 'part2') }
+
+        it { expect(counter.data).to include('value' => '1') }
+        it { expect(counter.data).to include('value' => '2') }
+        it { expect(counter.data).to include('value' => '3') }
+        it { expect(counter.data).to include('value' => '4') }
+      end
+
+      context 'when clean_expired call' do
+        before { counter.clean_expired }
+
+        it { expect(counter.has_value?(:value => 1)).to be_false }
+        it { expect(counter.has_value?(:value => 2)).to be_false }
+        it { expect(counter.has_value?(:value => 3)).to be_true }
+        it { expect(counter.has_value?(:value => 4)).to be_true }
+
+        it { expect(counter.partitions).to include('part' => 'part1') }
+        it { expect(counter.partitions).to_not include('part' => 'part2') }
+
+        it { expect(counter.data).to_not include('value' => '1') }
+        it { expect(counter.data).to_not include('value' => '2') }
+        it { expect(counter.data).to include('value' => '3') }
+        it { expect(counter.data).to include('value' => '4') }
+      end
+    end
+  end
+end

data/spec/support/unique_values_lists/set.rb

@@ -0,0 +1,119 @@
+# coding: utf-8
+shared_examples_for 'unique_values_lists/set' do
+  let(:redis) { MockRedis.new }
+  let(:values) { rand(10) + 1 }
+
+  let(:counter) { described_class.new(redis, options) }
+
+  context '#add' do
+    context 'when cluster and partition keys given' do
+      let(:options) { {
+        :counter_name   => :test_counter,
+        :value_keys     => [:param0, :param1],
+        :cluster_keys   => [:param2],
+        :partition_keys => [:param3, :param4]
+      } }
+
+      before do
+        values.times { counter.add(:param0 => 1, :param1 => 2, :param2 => :cluster1, :param3 => :part1, :param4 => :part2) }
+        values.times { counter.add(:param0 => 2, :param1 => 1, :param2 => :cluster1, :param3 => :part1, :param4 => :part2) }
+        values.times { counter.add(:param0 => 3, :param1 => 2, :param2 => :cluster1, :param3 => :part2, :param4 => :part2) }
+        values.times { counter.add(:param0 => 4, :param1 => 5, :param2 => :cluster2, :param3 => :part1, :param4 => :part2) }
+      end
+
+      it { expect(redis.keys('*')).to have(5).key }
+
+      it { expect(redis.exists("test_counter:cluster1:part1:part2")).to be_true }
+      it { expect(redis.exists("test_counter:cluster1:part2:part2")).to be_true }
+      it { expect(redis.exists("test_counter:cluster2:part1:part2")).to be_true }
+
+      it { expect(redis.smembers("test_counter:cluster1:part1:part2")).to have(2).keys }
+      it { expect(redis.smembers("test_counter:cluster1:part2:part2")).to have(1).keys }
+      it { expect(redis.smembers("test_counter:cluster2:part1:part2")).to have(1).keys }
+
+      it { expect(redis.smembers("test_counter:cluster1:part1:part2")).to include '1:2' }
+      it { expect(redis.smembers("test_counter:cluster1:part1:part2")).to include '2:1' }
+      it { expect(redis.smembers("test_counter:cluster1:part2:part2")).to include '3:2' }
+      it { expect(redis.smembers("test_counter:cluster2:part1:part2")).to include '4:5' }
+    end
+
+    context 'when cluster and partition keys no given' do
+      let(:options) { {
+        :counter_name => :test_counter,
+        :value_keys   => [:param0, :param1]
+      } }
+
+      before do
+        values.times { counter.add(:param0 => 1, :param1 => 2) }
+        values.times { counter.add(:param0 => 1, :param1 => 2) }
+        values.times { counter.add(:param0 => 2, :param1 => 1) }
+        values.times { counter.add(:param0 => 3, :param1 => 2) }
+      end
+
+      it { expect(redis.keys('*')).to have(1).key }
+
+      it { expect(redis.exists("test_counter")).to be_true }
+      it { expect(redis.smembers("test_counter")).to have(3).keys }
+
+      it { expect(redis.smembers("test_counter")).to include '1:2' }
+      it { expect(redis.smembers("test_counter")).to include '2:1' }
+      it { expect(redis.smembers("test_counter")).to include '3:2' }
+    end
+
+    context 'when no cluster keys given, but partition keys given' do
+      let(:options) { {
+        :counter_name   => :test_counter,
+        :value_keys     => [:param0, :param1],
+        :partition_keys => [:param3, :param4]
+      } }
+
+      before do
+        values.times { counter.add(:param0 => 1, :param1 => 2, :param3 => :part1, :param4 => :part2) }
+        values.times { counter.add(:param0 => 2, :param1 => 1, :param3 => :part1, :param4 => :part2) }
+        values.times { counter.add(:param0 => 3, :param1 => 2, :param3 => :part2, :param4 => :part2) }
+        values.times { counter.add(:param0 => 4, :param1 => 5, :param3 => :part1, :param4 => :part2) }
+      end
+
+      it { expect(redis.keys('*')).to have(3).key }
+
+      it { expect(redis.exists("test_counter:part1:part2")).to be_true }
+      it { expect(redis.exists("test_counter:part2:part2")).to be_true }
+
+      it { expect(redis.smembers("test_counter:part1:part2")).to have(3).keys }
+      it { expect(redis.smembers("test_counter:part2:part2")).to have(1).keys }
+
+      it { expect(redis.smembers("test_counter:part1:part2")).to include '1:2' }
+      it { expect(redis.smembers("test_counter:part1:part2")).to include '2:1' }
+      it { expect(redis.smembers("test_counter:part2:part2")).to include '3:2' }
+      it { expect(redis.smembers("test_counter:part1:part2")).to include '4:5' }
+    end
+
+    context 'when cluster keys given, but partition keys not given' do
+      let(:options) { {
+        :counter_name  => :test_counter,
+        :value_keys    => [:param0, :param1],
+        :cluster_keys  => [:param2]
+      } }
+
+      before do
+        values.times { counter.add(:param0 => 1, :param1 => 2, :param2 => :cluster1) }
+        values.times { counter.add(:param0 => 2, :param1 => 1, :param2 => :cluster1) }
+        values.times { counter.add(:param0 => 3, :param1 => 2, :param2 => :cluster1) }
+        values.times { counter.add(:param0 => 4, :param1 => 5, :param2 => :cluster2) }
+      end
+
+      it { expect(redis.keys('*')).to have(2).key }
+
+      it { expect(redis.exists("test_counter:cluster1")).to be_true }
+      it { expect(redis.exists("test_counter:cluster2")).to be_true }
+
+      it { expect(redis.smembers("test_counter:cluster1")).to have(3).keys }
+      it { expect(redis.smembers("test_counter:cluster2")).to have(1).keys }
+
+      it { expect(redis.smembers("test_counter:cluster1")).to include '1:2' }
+      it { expect(redis.smembers("test_counter:cluster1")).to include '2:1' }
+      it { expect(redis.smembers("test_counter:cluster1")).to include '3:2' }
+      it { expect(redis.smembers("test_counter:cluster2")).to include '4:5' }
+    end
+  end
+end

data/tasks/audit.rake

@@ -0,0 +1,6 @@
+# coding: utf-8
+
+desc 'Audit current gemset'
+task :audit do
+  spawn 'bundle exec bundle-audit'
+end

data/tasks/cane.rake

@@ -0,0 +1,12 @@
+# coding: utf-8
+
+require 'cane/rake_task'
+
+desc 'Run cane to check quality metrics'
+Cane::RakeTask.new(:quality) do |cane|
+  cane.abc_max = 15
+  cane.abc_glob = cane.style_glob = cane.doc_glob = '*/{lib,bin}/**/*.rb'
+  cane.style_measure = 120
+  cane.parallel = false
+  cane.no_doc = true
+end

data/tasks/changelog.rake

@@ -0,0 +1,7 @@
+desc 'Generate CHANGELOG.md'
+task :changelog do
+  require 'apress/changelogger'
+  Apress::ChangeLogger.new.log_changes
+  spawn 'git add CHANGELOG.md'
+  spawn 'git commit -m "Update CHANGELOG.md"'
+end

data/tasks/coverage.rake

@@ -0,0 +1,21 @@
+# coding: utf-8
+
+MINIMUM_COVERAGE = 85
+
+desc "Check if test coverage is equal or greater than %.2f%%" % MINIMUM_COVERAGE
+task :coverage => :spec do
+  require 'simplecov'
+  require 'simplecov/exit_codes'
+
+  covered_percent = SimpleCov.result.covered_percent.round(2)
+  if covered_percent < MINIMUM_COVERAGE
+    $stderr.puts "Coverage (%.2f%%) is below the expected minimum coverage (%.2f%%)." % \
+                     [covered_percent, MINIMUM_COVERAGE]
+
+    exit(SimpleCov::ExitCodes::MINIMUM_COVERAGE)
+  end
+end
+
+task :clean do
+  FileUtils.rm_rf 'coverage'
+end

data/tasks/support.rb

@@ -0,0 +1,24 @@
+# coding: utf-8
+# Helpers for root Rakefile
+
+require 'pty'
+
+ROOT = File.expand_path(File.join('..', '..'), __FILE__)
+
+# run +cmd+ in subprocess, redirect its stdout to parent's stdout
+def spawn(cmd)
+  puts ">> #{cmd}"
+
+  cmd += ' 2>&1'
+  PTY.spawn cmd do |r, w, pid|
+    begin
+      r.sync
+      r.each_char { |chr| STDOUT.write(chr) }
+    rescue Errno::EIO => e
+      # simply ignoring this
+    ensure
+      ::Process.wait pid
+    end
+  end
+  abort "#{cmd} failed" unless $? && $?.exitstatus == 0
+end

metadata

@@ -0,0 +1,242 @@
+--- !ruby/object:Gem::Specification
+name: redis_counters
+version: !ruby/object:Gem::Version
+  version: 1.3.0
+platform: ruby
+authors:
+- Artem Napolskih
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  name: activesupport
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  name: bundler
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  name: rake
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  name: rspec
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  name: mock_redis
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  name: timecop
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :development
+  name: codeclimate-test-reporter
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  name: simplecov
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  name: cane
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  name: bundler-audit
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  name: apress-changelogger
+description: 
+email:
+- napolskih@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- Makefile
+- README.md
+- Rakefile
+- lib/redis_counters.rb
+- lib/redis_counters/base_counter.rb
+- lib/redis_counters/bucket.rb
+- lib/redis_counters/cluster.rb
+- lib/redis_counters/clusterize_and_partitionize.rb
+- lib/redis_counters/hash_counter.rb
+- lib/redis_counters/partition.rb
+- lib/redis_counters/unique_hash_counter.rb
+- lib/redis_counters/unique_values_lists/base.rb
+- lib/redis_counters/unique_values_lists/blocking.rb
+- lib/redis_counters/unique_values_lists/expirable.rb
+- lib/redis_counters/unique_values_lists/non_blocking.rb
+- lib/redis_counters/version.rb
+- redis_counters.gemspec
+- spec/redis_counters/base_spec.rb
+- spec/redis_counters/hash_counter_spec.rb
+- spec/redis_counters/unique_hash_counter_spec.rb
+- spec/redis_counters/unique_values_lists/blocking_spec.rb
+- spec/redis_counters/unique_values_lists/expirable_spec.rb
+- spec/redis_counters/unique_values_lists/non_blicking_spec.rb
+- spec/spec_helper.rb
+- spec/support/unique_values_lists/common.rb
+- spec/support/unique_values_lists/expirable.rb
+- spec/support/unique_values_lists/set.rb
+- tasks/audit.rake
+- tasks/cane.rake
+- tasks/changelog.rake
+- tasks/coverage.rake
+- tasks/support.rb
+homepage: https://github.com/abak-press/redis_counters
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: Redis Counters
+test_files:
+- spec/redis_counters/base_spec.rb
+- spec/redis_counters/hash_counter_spec.rb
+- spec/redis_counters/unique_hash_counter_spec.rb
+- spec/redis_counters/unique_values_lists/blocking_spec.rb
+- spec/redis_counters/unique_values_lists/expirable_spec.rb
+- spec/redis_counters/unique_values_lists/non_blicking_spec.rb
+- spec/spec_helper.rb
+- spec/support/unique_values_lists/common.rb
+- spec/support/unique_values_lists/expirable.rb
+- spec/support/unique_values_lists/set.rb