minuteman 0.0.2 → 0.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    minuteman (0.0.2)
+    minuteman (0.1.0)
       redis (~> 3.0.2)
 
 GEM

data/README.md

@@ -101,7 +101,19 @@ today_events.include?(User.all.map(&:id))
 
 ## Bitwise operations
 
-You can intersect sets using AND(`&`), OR(`|`), NOT(`-`) and XOR(`^`).
+You can intersect sets using bitwise AND(`&`), OR(`|`), NOT(`-`) and XOR(`^`).
+Also you can use plus(`+`) and minus(`-`) operations.
+
+```ruby
+set1 + set2
+set1 - set2
+set1 & set2
+set1 | set2
+set1 ^ set2
+-set1
+```
+
+### Example
 
 ```ruby
 invited = analytics.month("email:invitation", Time.now.utc)
@@ -113,3 +125,13 @@ successful_buys_after_invitation.include?(user.id)
 # Clean up all the operations cache
 analytics.reset_operations_cache
 ```
+
+Also you can write more complex set operations
+
+```ruby
+invited = analytics.month("email:invitation")
+from_adsense = analytics.month("adsense:promo")
+successful_buys = analytics.month("buy:complete")
+
+conversion_rate = (invited | from_adsense) & successful_buys
+```

data/lib/minuteman/bit_operations.rb

@@ -29,6 +29,12 @@ class Minuteman
       bit_operation("NOT", key)
     end
 
+    # Public: Calculates the substract of one set to another
+    #
+    def -(timespan)
+      self ^ (self & timespan)
+    end
+
     # Public: Calculates the XOR against another timespan
     #
     #   timespan: Another BitOperations enabled class
@@ -44,6 +50,7 @@ class Minuteman
     def |(timespan)
       bit_operation("OR", [key, timespan.key])
     end
+    alias :+ :|
 
     # Public: Calculates the AND against another timespan
     #
@@ -76,11 +83,15 @@ class Minuteman
     #
     def bit_operation(type, events)
       key = destination_key(type, Array(events))
-      @redis.bitop(type, key, events)
-      BitOperation.new(@redis, key)
+      redis.bitop(type, key, events)
+      BitOperation.new(redis, key)
     end
   end
 
+  # Public: The result of intersecting results
+  #   redis   - The Redis connection
+  #   key     - The key where the result it's stored
+  #
   class BitOperation < Struct.new(:redis, :key)
     include BitOperations
   end

data/minuteman.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name              = "minuteman"
-  s.version           = "0.0.2"
+  s.version           = "0.1.0"
   s.summary           = "Bit Analytics"
   s.description       = "Fast and furious tracking system using Redis bitwise operations"
   s.authors           = ["elcuervo"]

data/test/unit/minuteman_test.rb

@@ -110,4 +110,30 @@ describe Minuteman do
     assert !not_operation.include?(2)
   end
 
+  it "should have an alias for the OR operator" do
+    or_operation = @week_events + @last_week_events
+
+    assert @week_events.include?(2)
+    assert @last_week_events.include?(2)
+    assert !@last_week_events.include?(12)
+
+    assert_equal 3, or_operation.length
+
+    assert or_operation.include?(12)
+    assert or_operation.include?(2)
+  end
+
+  it "should accept the substraction of a set" do
+    substract_operation = @year_events - @week_events
+
+    assert @week_events.include?(2)
+    assert @year_events.include?(2)
+    assert !substract_operation.include?(2)
+  end
+
+  it "should accept multiple consecutive operations" do
+    multi_operation = @week_events & @last_week_events | @year_events
+
+    assert_kind_of Minuteman::BitOperation, multi_operation
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minuteman
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-01 00:00:00.000000000 Z
+date: 2012-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis