retained 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73e354c2a489016a3d1c873e021d8f1b58a18dd2
-  data.tar.gz: 84dc43a781952b4a5b6d97584e1fff0d7ff77665
+  metadata.gz: ca84fa50ba4a030bab29edbe18ff45345aff78f7
+  data.tar.gz: ae826caf63c1b345aad1c1938320d3e410416393
 SHA512:
-  metadata.gz: 2939b0bf01bfd76a12106ad70b87c57885b9a80d27b6cac0e7ae28fabebc02efec4e8fba4dab704421c68104f7280d06a147c89dc64106868a535bc237fdf75c
-  data.tar.gz: de8476c725c0db2dfeb7335309a42e3524ddf857a1ec43efd6e7f573160f357adca06edb3636c0ac3f83539bffadcac91c4c2d614e631243196a945bc2e6279c
+  metadata.gz: ae5a327d375d7b3770ca897dfb76771842ef9fa39be8ee7915c920f57f2cb2b538800cba211f6c0fd5742c8babf7193b30ab27565dc064e1d93aab1c12304f34
+  data.tar.gz: ae0cffa2a5020e55a21878889b546ed733f3f3d0bf144a87658a7e6ade076a935227404db67c961a111595dabc294d690e1d5ba6b0a3903b224be8f9961694e2

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.3.0
+
+  * BREAKING CHANGE:  Removed dependency on redis-bitops, which
+  while conserving space resulted in significant degradation of
+  performance due to the additional overhead of tracking chunks
+  and additional bit operations.
+
 # 0.2.3
 
   * Updated to latest redis-bitops, which includes multiple fixes

data/Gemfile

@@ -1,7 +1,6 @@
 source 'http://rubygems.org'
 
 gem 'redis', '~> 3.1.0'
-gem 'redis-bitops', github: 'msaffitz/redis-bitops', ref: '2ebd12b5044046db67e7958eda0701257b3eb3f9'
 gem 'activesupport'
 
 group :development do

data/Gemfile.lock

@@ -1,11 +1,3 @@
-GIT
-  remote: git://github.com/msaffitz/redis-bitops.git
-  revision: 2ebd12b5044046db67e7958eda0701257b3eb3f9
-  ref: 2ebd12b5044046db67e7958eda0701257b3eb3f9
-  specs:
-    redis-bitops (0.2.1)
-      redis
-
 GEM
   remote: http://rubygems.org/
   specs:
@@ -84,7 +76,6 @@ DEPENDENCIES
   minitest
   rdoc (~> 3.12)
   redis (~> 3.1.0)
-  redis-bitops!
   simplecov
   timecop (~> 0.7.1)
   yard (~> 0.7)

data/lib/retained/tracker.rb

@@ -1,5 +1,6 @@
-require 'redis/bitops'
+require 'redis'
 require 'active_support/core_ext/time/calculations'
+require 'securerandom'
 require 'retained/configuration'
 
 module Retained
@@ -18,29 +19,31 @@ module Retained
     # is provided.
     def retain(entity, group: 'default', period: Time.now)
       index = entity_index(entity, group)
-      bitmap = config.redis_connection.sparse_bitmap(key_period(group, period))
-      bitmap[index] = true
+      config.redis_connection.setbit key_period(group, period), index, 1
     end
 
     # Total active entities in the period, or now if no period,
     # is provided.
     def total_active(group: 'default', period: Time.now)
-      bitmap = config.redis_connection.sparse_bitmap(key_period(group, period))
-      bitmap.bitcount
+      config.redis_connection.bitcount key_period(group, period)
     end
 
     # Returns the total number of unique active entities between
     # the start and end periods (inclusive), or now if no stop
     # period is provided.
     def unique_active(group: 'default', start:, stop: Time.now)
-      bitmaps = []
+      keys = []
       start = period_start(group, start)
       while (start <= stop)
-        bitmaps << config.redis_connection.sparse_bitmap(key_period(group, start))
+        keys << key_period(group, start)
         start += seconds_in_reporting_interval(config.group(group).reporting_interval)
       end
-      return 0  if bitmaps.length == 0
-      bitmaps.inject { |uniques,bitmap| uniques | bitmap }.bitcount
+      return 0  if keys.length == 0
+
+      temp_bitmap do |key|
+        config.redis_connection.bitop 'OR', key, *keys
+        config.redis_connection.bitcount key
+      end
     end
 
     # Returns true if the entity was active in the given period,
@@ -51,9 +54,7 @@ module Retained
       group = groups if group == [] || !group
 
       group.to_a.each do |g|
-        bitmap = config.redis_connection.sparse_bitmap(key_period(g, period))
-        index = entity_index(entity, g)
-        return bitmap[index] if bitmap[index]
+        return true if config.redis_connection.getbit(key_period(g, period), entity_index(entity, g)) == 1
       end
       false
     end
@@ -88,6 +89,15 @@ LUA
     end
 
     private
+    def temp_bitmap
+      temp_key = "#{config.prefix}:temp:#{SecureRandom.hex}"
+      begin
+        yield temp_key
+      ensure
+        config.redis_connection.del temp_key
+      end
+    end
+
     # Returns the time (UTC) that the period starts at for the given group
     def period_start(group, period)
       period.utc.send("beginning_of_#{config.group(group).reporting_interval}")

data/lib/retained/version.rb

@@ -1,8 +1,8 @@
 module Retained
   module Version
     MAJOR = 0
-    MINOR = 2
-    PATCH = 3
+    MINOR = 3
+    PATCH = 0
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')

data/retained.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: retained 0.2.3 ruby lib
+# stub: retained 0.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "retained"
-  s.version = "0.2.3"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Mike Saffitz"]
-  s.date = "2014-11-16"
+  s.date = "2015-01-23"
   s.description = "\n    Easy tracking of activity and retention at scale in daily, hourly, or minute intervals\n    using sparse Redis bitmaps.\n  "
   s.email = "m@saffitz.com"
   s.extra_rdoc_files = [
@@ -48,7 +48,6 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<redis>, ["~> 3.1.0"])
-      s.add_runtime_dependency(%q<redis-bitops>, [">= 0"])
       s.add_runtime_dependency(%q<activesupport>, [">= 0"])
       s.add_development_dependency(%q<minitest>, [">= 0"])
       s.add_development_dependency(%q<yard>, ["~> 0.7"])
@@ -59,7 +58,6 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<timecop>, ["~> 0.7.1"])
     else
       s.add_dependency(%q<redis>, ["~> 3.1.0"])
-      s.add_dependency(%q<redis-bitops>, [">= 0"])
       s.add_dependency(%q<activesupport>, [">= 0"])
       s.add_dependency(%q<minitest>, [">= 0"])
       s.add_dependency(%q<yard>, ["~> 0.7"])
@@ -71,7 +69,6 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<redis>, ["~> 3.1.0"])
-    s.add_dependency(%q<redis-bitops>, [">= 0"])
     s.add_dependency(%q<activesupport>, [">= 0"])
     s.add_dependency(%q<minitest>, [">= 0"])
     s.add_dependency(%q<yard>, ["~> 0.7"])

data/test/tracker_spec.rb

@@ -15,10 +15,10 @@ describe Retained::Tracker do
 
   it 'retain tracks using the default group in the current period' do
     Timecop.freeze(Time.new(2014, 8, 29, 9, 03, 35)) do
-     tracker.retain('entity_a')
+      tracker.retain('entity_a')
       prefix = tracker.config.prefix
       group  = tracker.config.default_group
-      tracker.config.redis_connection.sparse_bitmap("#{prefix}:#{group}:1409328000")[0]
+      tracker.active?('entity_a').must_equal true
     end
   end
 
@@ -27,7 +27,7 @@ describe Retained::Tracker do
     tracker.retain('entity_a', group: 'group_a', period: period)
 
     prefix = tracker.config.prefix
-    tracker.config.redis_connection.sparse_bitmap("#{prefix}:group_a:1409356800")[0]
+    tracker.active?('entity_a', period: period).must_equal true
   end
 
   it 'retains using the "default" group' do
@@ -40,7 +40,7 @@ describe Retained::Tracker do
       tracker.retain('entity_a', group: 'group_a')
 
       prefix = tracker.config.prefix
-      tracker.config.redis_connection.sparse_bitmap("#{prefix}:group_a:1409328000")[0]
+      tracker.active?('entity_a', group: 'group_a', period: Time.now).must_equal true
     end
   end
 
@@ -162,4 +162,32 @@ describe Retained::Tracker do
     tracker.key_period('minute', Time.new(2014, 8, 30, 10, 35, 47, 5*3600)).must_equal 'retained:minute:1409376900'
     tracker.key_period('day', Time.new(2014, 8, 30, 10, 35, 47, -2*3600)).must_equal 'retained:day:1409356800'
   end
+
+  it 'temp_bitmap cleans up the temporary bitmap' do
+    tmp_key = nil
+    tracker.send(:temp_bitmap) do |key|
+      tmp_key = key
+      tracker.config.redis_connection.setbit key, 0, 1
+    end
+    tracker.config.redis_connection.exists(tmp_key).must_equal false
+  end
+
+  it 'temp_bitmap cleans up the temporary bitmap with exception raised' do
+    tmp_key = nil
+    begin
+      tracker.send(:temp_bitmap) do |key|
+        tmp_key = key
+        tracker.config.redis_connection.setbit key, 0, 1
+        raise 'exception'
+      end
+    rescue
+    end
+    tracker.config.redis_connection.exists(tmp_key).must_equal false
+  end
+
+  it 'temp_bitmap returns the value' do
+    tracker.send(:temp_bitmap) do |key|
+      4
+    end.must_equal 4
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: retained
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Mike Saffitz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-16 00:00:00.000000000 Z
+date: 2015-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.0
-- !ruby/object:Gem::Dependency
-  name: redis-bitops
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement