minuteman 0.1.1 → 0.2.0.pre

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "jruby-19mode"
+  - "rbx-19mode"
+services:
+  - "redis-server"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    minuteman (0.1.1)
+    minuteman (0.2.0.pre)
       redis (~> 3.0.2)
 
 GEM

data/README.md

@@ -1,4 +1,5 @@
 # Minuteman
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/elcuervo/minuteman)
 
 _Wikipedia_: Minutemen were members of teams from Massachusetts that were well-prepared
 militia companies of select men from the American colonial partisan militia
@@ -67,7 +68,7 @@ analytics.mark("login:successful", user.id)
 analytics.mark("login:successful", other_user.id)
 
 # Mark in bulk
-analytics.mark("programming:love:ruby", User.where(favorite: "ruby").map(&:id))
+analytics.mark("programming:love:ruby", User.where(favorite: "ruby").pluck(:id))
 
 # Fetch events for a given time
 today_events = analytics.day("login:successful", Time.now.utc)
@@ -95,7 +96,7 @@ today_events.include?(admin.id)
 #=> false
 
 # Bulk check
-today_events.include?(User.all.map(&:id))
+today_events.include?(User.all.pluck(:id))
 #=> [true, true, false, false]
 ```
 
@@ -112,10 +113,27 @@ set1 | set2
 set1 ^ set2
 
 ~set1 \
-        ==> This are the same
+       |==> This are the same
 -set1 /
 ```
 
+### Intersecting with arrays
+
+Let's assume this scenario:
+
+You have a list of users and want to know which of them have been going throught
+some of the marks you made.
+
+```ruby
+paid = analytics.month("buy:complete")
+payed_from_miami = paid & User.find_all_by_state("MIA").map(&:id)
+payed_from_miami.size
+#=> 43
+payed_users_from_miami = payed_from_miami.map { |id| User.find(id) }
+```
+
+Currently the supported commands to interact with arrays are `&` and `-`
+
 ### Example
 
 ```ruby

data/lib/minuteman.rb

@@ -97,7 +97,7 @@ class Minuteman
   #
   def operations_cache_key_prefix
     [
-      PREFIX, Minuteman::BitOperations::BIT_OPERATION_PREFIX
+      PREFIX, Minuteman::KeysMethods::BIT_OPERATION_PREFIX
     ].join("_")
   end
 end

data/lib/minuteman/bit_operations.rb

@@ -1,13 +1,13 @@
+require "minuteman/bit_operations/operation"
+
 class Minuteman
   module BitOperations
-    BIT_OPERATION_PREFIX = "bitop"
-
     # Public: Checks for the existance of ids on a given set
     #
     #   ids - Array of ids
     #
     def include?(*ids)
-      result = ids.map { |id| redis.getbit(key, id) == 1 }
+      result = ids.map { |id| getbit(id) }
       result.size == 1 ? result.first : result
     end
 
@@ -26,14 +26,16 @@ class Minuteman
     # Public: Calculates the NOT of the current key
     #
     def -@
-      bit_operation("NOT", key)
+      operation("NOT", key)
     end
     alias :~@ :-@
 
     # Public: Calculates the substract of one set to another
     #
+    #   timespan: Another BitOperations enabled class
+    #
     def -(timespan)
-      self ^ (self & timespan)
+      operation("MINUS", timespan)
     end
 
     # Public: Calculates the XOR against another timespan
@@ -41,59 +43,43 @@ class Minuteman
     #   timespan: Another BitOperations enabled class
     #
     def ^(timespan)
-      bit_operation("XOR", [key, timespan.key])
+      operation("XOR", timespan)
     end
 
     # Public: Calculates the OR against another timespan
     #
-    #   timespan: Another BitOperations enabled class
+    #   timespan: Another BitOperations enabled class or an Array
     #
     def |(timespan)
-      bit_operation("OR", [key, timespan.key])
+      operation("OR", timespan)
     end
     alias :+ :|
 
     # Public: Calculates the AND against another timespan
     #
-    #   timespan: Another BitOperations enabled class
+    #   timespan: Another BitOperations enabled class or an Array
     #
     def &(timespan)
-      bit_operation("AND", [key, timespan.key])
+      operation("AND", timespan)
     end
 
     private
 
-    # Private: The destination key for the operation
-    #
-    #   type   - The bitwise operation
-    #   events - The events to permuted
-    #
-    def destination_key(type, events)
-      [
-        Minuteman::PREFIX,
-        BIT_OPERATION_PREFIX,
-        type,
-        events.join("-")
-      ].join("_")
+    # Private: Helper to access the value a given bit
+    #
+    #   id: The bit
+    #
+    def getbit(id)
+      redis.getbit(key, id) == 1
     end
 
-    # Private: Executes a bit operation
+    # Private: executes an operation between the current timespan and another
     #
-    #   type   - The bitwise operation
-    #   events - The events to permuted
+    #   type:     The operation type
+    #   timespan: The given timespan
     #
-    def bit_operation(type, events)
-      key = destination_key(type, Array(events))
-      redis.bitop(type, key, events)
-      BitOperation.new(redis, key)
+    def operation(type, timespan)
+      Operation.new(redis, type, self, timespan).call
     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
 end

data/lib/minuteman/bit_operations/data.rb

@@ -0,0 +1,32 @@
+require "minuteman/bit_operations"
+
+class Minuteman
+  module BitOperations
+    # Public: The conversion of an array to an operable class
+    #
+    #   redis   - The Redis connection
+    #   key     - The key where the result it's stored
+    #   data    - The original data of the intersection
+    #
+    class Data < Struct.new(:redis, :key, :data)
+      include BitOperations
+      include Enumerable
+
+      def to_ary
+        data
+      end
+
+      def size
+        data.size
+      end
+
+      def each(&block)
+        data.each(&block)
+      end
+
+      def ==(other)
+        other == data
+      end
+    end
+  end
+end

data/lib/minuteman/bit_operations/operation.rb

@@ -0,0 +1,44 @@
+require "minuteman/bit_operations/plain"
+require "minuteman/bit_operations/with_data"
+
+class Minuteman
+  module BitOperations
+    # Public: Handles the operations between two timespans
+    #
+    #   redis:      The Redis connection
+    #   type:       The operation type
+    #   timespan:   One of the timespans to be permuted
+    #   other:      The other timespan to be permuted
+    #
+    class Operation < Struct.new(:redis, :type, :timespan, :other)
+      def call
+        if type == "MINUS" && operable?
+          return timespan ^ (timespan & other)
+        end
+
+        klass.new(redis, type, other, timespan.key).call
+      end
+
+      private
+
+      # Private: returns the class to use for the operation
+      #
+      #   timespan: The given timespan
+      #
+      def klass
+        case true
+        when other.is_a?(Array) then WithData
+        when other.is_a?(String), operable? then Plain
+        end
+      end
+
+      # Private: Checks if a timespan is operable
+      #
+      #   timespan: The given timespan
+      #
+      def operable?
+        other.class.ancestors.include?(BitOperations)
+      end
+    end
+  end
+end

data/lib/minuteman/bit_operations/plain.rb

@@ -0,0 +1,29 @@
+require "minuteman/keys_methods"
+require "minuteman/bit_operations/result"
+
+class Minuteman
+  module BitOperations
+    # Public: The class to handle operations with others timespans
+    #
+    #   redis:      The Redis connection
+    #   type:       The operation type
+    #   timespan:   The timespan to be permuted
+    #   source_key: The original key to do the operation
+    #
+    class Plain < Struct.new(:redis, :type, :timespan, :source_key)
+      include KeysMethods
+
+      def call
+        events = if source_key == timespan
+                   Array(source_key)
+                 else
+                   [source_key, timespan.key]
+                 end
+
+        key = destination_key(type, events)
+        redis.bitop(type, key, events)
+        Result.new(redis, key)
+      end
+    end
+  end
+end

data/lib/minuteman/bit_operations/result.rb

@@ -0,0 +1,14 @@
+require "minuteman/bit_operations"
+
+class Minuteman
+  module BitOperations
+    # Public: The result of intersecting results
+    #
+    #   redis   - The Redis connection
+    #   key     - The key where the result it's stored
+    #
+    class Result < Struct.new(:redis, :key)
+      include BitOperations
+    end
+  end
+end

data/lib/minuteman/bit_operations/with_data.rb

@@ -0,0 +1,33 @@
+require "minuteman/keys_methods"
+require "minuteman/bit_operations/data"
+
+class Minuteman
+  module BitOperations
+    # Public: The class to handle operations with datasets
+    #
+    #   redis:      The Redis connection
+    #   type:       The operation type
+    #   data:       The data to be permuted
+    #   source_key: The original key to do the operation
+    #
+    class WithData < Struct.new(:redis, :type, :data, :source_key)
+      include KeysMethods
+
+      def call
+        normalized_data = Array(data)
+        key = destination_key("data-#{type}", normalized_data)
+        command = case type
+                  when "AND"    then :select
+                  when "MINUS"  then :reject
+                  end
+
+        intersected_data = normalized_data.send(command) do |id|
+          redis.getbit(source_key, id) == 1
+        end
+
+        intersected_data.each { |id| redis.setbit(key, id, 1) }
+        Data.new(redis, key, intersected_data)
+      end
+    end
+  end
+end

data/lib/minuteman/keys_methods.rb

@@ -0,0 +1,21 @@
+class Minuteman
+  module KeysMethods
+    BIT_OPERATION_PREFIX = "bitop"
+
+    private
+
+    # Private: The destination key for the operation
+    #
+    #   type   - The bitwise operation
+    #   events - The events to permuted
+    #
+    def destination_key(type, events)
+      [
+        Minuteman::PREFIX,
+        BIT_OPERATION_PREFIX,
+        type,
+        events.join("-")
+      ].join("_")
+    end
+  end
+end

data/minuteman.gemspec

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

data/test/unit/minuteman_test.rb

@@ -134,6 +134,28 @@ describe Minuteman do
   it "should accept multiple consecutive operations" do
     multi_operation = @week_events & @last_week_events | @year_events
 
-    assert_kind_of Minuteman::BitOperation, multi_operation
+    assert_kind_of Minuteman::BitOperations::Result, multi_operation
+  end
+
+  it "should return the ids that belong to a given set" do
+    ids = @week_events & [2, 12, 43]
+
+    assert_kind_of Minuteman::BitOperations::Data, ids
+    assert_equal [2, 12], ids
+  end
+
+  it "should return the ids that do not belong to the given set" do
+    ids = @week_events - [2, 12, 43]
+
+    assert_kind_of Minuteman::BitOperations::Data, ids
+    assert_equal [43], ids
+  end
+
+  it "a resulting set with data should behave like an array" do
+    ids = @week_events & [2, 12, 43]
+
+    assert_kind_of Enumerator, ids.each
+    assert_kind_of Enumerator, ids.map
+    assert_equal 2, ids.size
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: minuteman
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.2.0.pre
+  prerelease: 6
 platform: ruby
 authors:
 - elcuervo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-06 00:00:00.000000000 Z
+date: 2012-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -50,6 +50,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -57,6 +58,12 @@ files:
 - Rakefile
 - lib/minuteman.rb
 - lib/minuteman/bit_operations.rb
+- lib/minuteman/bit_operations/data.rb
+- lib/minuteman/bit_operations/operation.rb
+- lib/minuteman/bit_operations/plain.rb
+- lib/minuteman/bit_operations/result.rb
+- lib/minuteman/bit_operations/with_data.rb
+- lib/minuteman/keys_methods.rb
 - lib/minuteman/time_events.rb
 - lib/minuteman/time_span.rb
 - lib/minuteman/time_spans.rb
@@ -84,9 +91,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23