retained 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da114b8e5259d29aa525e3cb168870de2ce80c33
-  data.tar.gz: 4e1961abef8c3090e496f6061ef6281a51895a3c
+  metadata.gz: d409f92d84ef7a75a997c20b70000222ad4387e1
+  data.tar.gz: f95025b82eb6e7176f73e715ed1806ad2ee84440
 SHA512:
-  metadata.gz: 68339dda5d5f9a276f2d72c08f1e90459a2214ed046ae316695b13f92b5ba2af4fae5fa9886d83d28c83e667da46bdec84d53906a2112b93454b7f050ac69b33
-  data.tar.gz: 0e0e8ea4876a3e9f3db18bc0e86213cb16fa186130652c1ab9fc48f39a9858e4b07498af107456074d2a26ecc3db6621fbff274546f19f3a923c96f9314a59e2
+  metadata.gz: 1b5191df944823da917a418e5f6606a39362bb2458a1c13b9ad2ddb769a833249f1022e9c80f2415b0afe69c2fb6f09a8acbc49d3857f9fdb7cf3ba7b85b2b4a
+  data.tar.gz: 207bca86cfea330de4315d5bf4ff2b1d2c8311547a3b2adad6da58e26a9e19902f3bfd00ed797ee6dc1fee8f591a2ceac4ab7f047aa717577e25998da0976fa6

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.3.2
+
+  * Remove redis gem dependency version
+  * Added total_retained and retention methods for directly
+  calculating retention between to period ranges.
+
 # 0.3.1
 
   * Update redis gem dependency to ~3.2

data/Gemfile

@@ -1,6 +1,6 @@
 source 'http://rubygems.org'
 
-gem 'redis', '~> 3.2'
+gem 'redis'
 gem 'activesupport'
 
 group :development do

data/Gemfile.lock

@@ -75,7 +75,10 @@ DEPENDENCIES
   jeweler (~> 2.0.1)
   minitest
   rdoc (~> 3.12)
-  redis (~> 3.2)
+  redis
   simplecov
   timecop (~> 0.7.1)
   yard (~> 0.7)
+
+BUNDLED WITH
+   1.10.5

data/lib/retained/tracker.rb

@@ -32,12 +32,7 @@ module Retained
     # the start and end periods (inclusive), or now if no stop
     # period is provided.
     def unique_active(group: 'default', start:, stop: Time.now)
-      keys = []
-      start = period_start(group, start)
-      while (start <= stop)
-        keys << key_period(group, start)
-        start += seconds_in_reporting_interval(config.group(group).reporting_interval)
-      end
+      keys = period_range_keys(group, start, stop)
       return 0  if keys.length == 0
 
       temp_bitmap do |key|
@@ -46,6 +41,46 @@ module Retained
       end
     end
 
+    # Returns the total number of unique active entities retained between
+    # an initial and a final period range.  Each period range consists
+    # of a start period and an end period (inclusive).  The final period
+    # range's starting period must be after the inital period range's ending
+    # period.
+    def total_retained(group: 'default', initial_start:, initial_stop:,
+                                         final_start:  , final_stop:)
+      #raise ArgumentError, "final_start must be after initial_stop"  if final_start <= initial_stop
+      initial_keys = period_range_keys(group, initial_start, initial_stop)
+      final_keys   = period_range_keys(group, final_start,    final_stop)
+
+      return 0  if initial_keys == 0 || final_keys == 0
+
+      temp_bitmap do |key|
+        temp_bitmap do |initial_key|
+          config.redis_connection.bitop 'OR', initial_key, *initial_keys
+          temp_bitmap do |final_key|
+            config.redis_connection.bitop 'OR', final_key, *final_keys
+            config.redis_connection.bitop 'AND', key, initial_key, final_key
+            config.redis_connection.bitcount key
+          end
+        end
+      end
+    end
+
+    # Returns the percent retained (as a float) retained between
+    # an initial and a final period range.  Each period range consists
+    # of a start period and an end period (inclusive).  The final period
+    # range's starting period must be after the inital period range's ending
+    # period.  If there are no entities in the initial period, Float::NAN is returned.
+    def retention(group: 'default', initial_start:, initial_stop:,
+                                    final_start:  , final_stop:)
+      initial_count = unique_active(group: group, start: initial_start, stop: initial_stop)
+      retained = total_retained(group: group, initial_start: initial_start,
+                                              initial_stop:  initial_stop,
+                                              final_start: final_start,
+                                              final_stop: final_stop)
+      return retained / initial_count.to_f
+    end
+
     # Returns true if the entity was active in the given period,
     # or now if no period is provided.  If a group or an array of groups
     # is provided activity will only be considered based on those groups.
@@ -89,8 +124,18 @@ LUA
     end
 
     private
-    def temp_bitmap
-      temp_key = "#{config.prefix}:temp:#{SecureRandom.hex}"
+    def period_range_keys(group, start, stop)
+      keys = []
+      start = period_start(group, start)
+      while (start <= stop)
+        keys << key_period(group, start)
+        start += seconds_in_reporting_interval(config.group(group).reporting_interval)
+      end
+      keys
+    end
+
+    def temp_bitmap(temp_key=SecureRandom.hex)
+      temp_key = "#{config.prefix}:temp:#{temp_key}"
       begin
         yield temp_key
       ensure

data/lib/retained/version.rb

@@ -2,7 +2,7 @@ module Retained
   module Version
     MAJOR = 0
     MINOR = 3
-    PATCH = 1
+    PATCH = 2
     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.3.1 ruby lib
+# stub: retained 0.3.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "retained"
-  s.version = "0.3.1"
+  s.version = "0.3.2"
 
   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 = "2015-03-29"
+  s.date = "2015-07-02"
   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 = [
@@ -40,14 +40,14 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/msaffitz/retained"
   s.licenses = ["MIT"]
-  s.rubygems_version = "2.4.6"
+  s.rubygems_version = "2.2.3"
   s.summary = "Activity & Retention Tracking at Scale"
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<redis>, ["~> 3.2"])
+      s.add_runtime_dependency(%q<redis>, [">= 0"])
       s.add_runtime_dependency(%q<activesupport>, [">= 0"])
       s.add_development_dependency(%q<minitest>, [">= 0"])
       s.add_development_dependency(%q<yard>, ["~> 0.7"])
@@ -57,7 +57,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<simplecov>, [">= 0"])
       s.add_development_dependency(%q<timecop>, ["~> 0.7.1"])
     else
-      s.add_dependency(%q<redis>, ["~> 3.2"])
+      s.add_dependency(%q<redis>, [">= 0"])
       s.add_dependency(%q<activesupport>, [">= 0"])
       s.add_dependency(%q<minitest>, [">= 0"])
       s.add_dependency(%q<yard>, ["~> 0.7"])
@@ -68,7 +68,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<timecop>, ["~> 0.7.1"])
     end
   else
-    s.add_dependency(%q<redis>, ["~> 3.2"])
+    s.add_dependency(%q<redis>, [">= 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

@@ -119,6 +119,86 @@ describe Retained::Tracker do
     end
   end
 
+  describe "total_retained" do
+    before(:each) do
+      tracker.configure do |config|
+        config.group('hour') { |g| g.reporting_interval = :hour }
+        config.group('minute') { |g| g.reporting_interval = :minute }
+        config.group('day') { |g| g.reporting_interval = :day}
+      end
+    end
+
+    it 'properly tracks retention when the reporting_interval is day' do
+      Timecop.freeze do
+        # Initial Period
+        [1,2].each { |e| tracker.retain(e, group: 'day', period: Time.now - 4*SECONDS_PER_DAY)}
+        [3,4].each { |e| tracker.retain(e, group: 'day', period: Time.now - 3*SECONDS_PER_DAY)}
+
+        # Final Period
+        tracker.retain(2, group: 'day', period: Time.now)
+        tracker.retain(3, group: 'day', period: Time.now - 2*SECONDS_PER_DAY)
+
+        tracker.total_retained(group: 'day', initial_start: Time.now - 4*SECONDS_PER_DAY, initial_stop: Time.now - 3*SECONDS_PER_DAY,
+                                             final_start:   Time.now - 2*SECONDS_PER_DAY, final_stop:   Time.now                     ).must_equal 2
+        tracker.total_retained(group: 'day', initial_start: Time.now - 4*SECONDS_PER_DAY, initial_stop: Time.now - 3*SECONDS_PER_DAY,
+                                             final_start:   Time.now                    , final_stop:   Time.now                     ).must_equal 1
+      end
+    end
+
+    it 'properly tracks retention when the reporting_interval is hour' do
+      Timecop.freeze do
+        # Initial Period
+        [1,2].each { |e| tracker.retain(e, group: 'hour', period: Time.now - 4*SECONDS_PER_HOUR)}
+        [3,4].each { |e| tracker.retain(e, group: 'hour', period: Time.now - 3*SECONDS_PER_HOUR)}
+
+        # Final Period
+        tracker.retain(2, group: 'hour', period: Time.now)
+        tracker.retain(3, group: 'hour', period: Time.now - 2*SECONDS_PER_HOUR)
+
+        tracker.total_retained(group: 'hour', initial_start: Time.now - 4*SECONDS_PER_HOUR, initial_stop: Time.now - 3*SECONDS_PER_HOUR,
+                                              final_start:   Time.now - 2*SECONDS_PER_HOUR, final_stop:   Time.now                      ).must_equal 2
+        tracker.total_retained(group: 'hour', initial_start: Time.now - 4*SECONDS_PER_HOUR, initial_stop: Time.now - 3*SECONDS_PER_HOUR,
+                                              final_start:   Time.now                     , final_stop:   Time.now                      ).must_equal 1
+      end
+    end
+
+    it 'properly tracks retention when the reporting_interval is minute' do
+      Timecop.freeze do
+        # Initial Period
+        [1,2].each { |e| tracker.retain(e, group: 'minute', period: Time.now - 4*60)}
+        [3,4].each { |e| tracker.retain(e, group: 'minute', period: Time.now - 3*60)}
+
+        # Final Period
+        tracker.retain(2, group: 'minute', period: Time.now)
+        tracker.retain(3, group: 'minute', period: Time.now - 2*60)
+
+        tracker.total_retained(group: 'minute', initial_start: Time.now - 4*60, initial_stop: Time.now - 3*60,
+                                                final_start:   Time.now - 2*60, final_stop:   Time.now        ).must_equal 2
+        tracker.total_retained(group: 'minute', initial_start: Time.now - 4*60, initial_stop: Time.now - 3*60,
+                                                final_start:   Time.now       , final_stop:    Time.now       ).must_equal 1
+      end
+    end
+  end
+
+  it 'retention properly returns retention percent' do
+    Timecop.freeze do
+      # Initial Period
+      [1,2].each { |e| tracker.retain(e, group: 'minute', period: Time.now - 4*SECONDS_PER_DAY)}
+      [3,4].each { |e| tracker.retain(e, group: 'minute', period: Time.now - 3*SECONDS_PER_DAY)}
+
+      # Final Period
+      tracker.retain(2, group: 'minute', period: Time.now)
+      tracker.retain(3, group: 'minute', period: Time.now - 2*SECONDS_PER_DAY)
+
+      tracker.retention(group: 'minute', initial_start: Time.now - 4*SECONDS_PER_DAY, initial_stop: Time.now - 3*SECONDS_PER_DAY,
+                                         final_start:   Time.now - 2*SECONDS_PER_DAY, final_stop:   Time.now                     ).must_equal 0.5
+
+      tracker.retention(group: 'minute', initial_start: Time.now - 4*SECONDS_PER_DAY, initial_stop: Time.now - 3*SECONDS_PER_DAY,
+                                         final_start:   Time.now                    , final_stop:   Time.now                     ).must_equal 0.25
+    end
+  end
+
+
   describe 'active?' do
     it 'returns true when the entity is active' do
       Timecop.freeze do

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: retained
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Mike Saffitz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-29 00:00:00.000000000 Z
+date: 2015-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -183,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: Activity & Retention Tracking at Scale