minuteman 1.0.3 → 2.0.0.pre

data/lib/minuteman/bit_operations/plain.rb

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

data/lib/minuteman/bit_operations/result.rb

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

data/lib/minuteman/bit_operations/with_data.rb

@@ -1,56 +0,0 @@
-require "minuteman/keys_methods"
-require "minuteman/bit_operations/data"
-
-# Public: Minuteman core classs
-#
-class Minuteman
-  module BitOperations
-    # Public: The class to handle operations with datasets
-    #
-    #   type:       The operation type
-    #   data:       The data to be permuted
-    #   source_key: The original key to do the operation
-    #
-    class WithData < Struct.new(:type, :data, :source_key)
-      extend Forwardable
-      include KeysMethods
-
-      def_delegators :Minuteman, :redis, :safe
-
-      def call
-        key = destination_key("data-#{type}", normalized_data)
-
-        if !safe { redis.exists(key) }
-          intersected_data.each { |id| safe { redis.setbit(key, id, 1) } }
-        end
-
-        Data.new(key, intersected_data)
-      end
-
-      private
-
-      # Private: Normalized data
-      #
-      def normalized_data
-        Array(data)
-      end
-
-      # Private: Defines command to get executed based on the type
-      #
-      def command
-        case type
-        when "AND"    then :select
-        when "MINUS"  then :reject
-        end
-      end
-
-      # Private: The intersected data depending on the command executed
-      #
-      def intersected_data
-        normalized_data.send(command) do |id|
-          Minuteman.redis.getbit(source_key, id) == 1
-        end
-      end
-    end
-  end
-end

data/lib/minuteman/keys_methods.rb

@@ -1,23 +0,0 @@
-# Public: Minuteman core classs
-#
-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/lib/minuteman/time_events.rb

@@ -1,18 +0,0 @@
-require "minuteman/time_spans"
-
-# Public: Minuteman core classs
-#
-class Minuteman
-  module TimeEvents
-    # Public: Helper to get all the time trackers ready
-    #
-    #   event_name - The event to be tracked
-    #   date       - A given Time object
-    #
-    def self.start(time_spans, event_name, time)
-      time_spans.map do |t|
-        t.new(event_name, time)
-      end
-    end
-  end
-end

data/lib/minuteman/time_span.rb

@@ -1,36 +0,0 @@
-require "minuteman/bit_operations"
-
-# Public: Minuteman core classs
-#
-class Minuteman
-  # Public: The timespan class. All the time span classes inherit from this one
-  #
-  class TimeSpan
-    include BitOperations
-
-    attr_reader :key
-
-    DATE_FORMAT = "%s-%02d-%02d"
-    TIME_FORMAT = "%02d:%02d"
-
-    # Public: Initializes the base TimeSpan class
-    #
-    #   event_name - The event to be tracked
-    #   date       - A given Time object
-    #
-    def initialize(event_name, date)
-      @key = build_key(event_name, time_format(date))
-    end
-
-    private
-
-    # Private: The redis key that's going to be used
-    #
-    #   event_name - The event to be tracked
-    #   date       - A given Time object
-    #
-    def build_key(event_name, date)
-      [Minuteman::PREFIX, event_name, date.join("-")].join("_")
-    end
-  end
-end

data/lib/minuteman/time_spans.rb

@@ -1,7 +0,0 @@
-require "minuteman/time_span"
-require "minuteman/time_spans/year"
-require "minuteman/time_spans/month"
-require "minuteman/time_spans/week"
-require "minuteman/time_spans/day"
-require "minuteman/time_spans/hour"
-require "minuteman/time_spans/minute"

data/lib/minuteman/time_spans/day.rb

@@ -1,17 +0,0 @@
-# Public: Minuteman core classs
-#
-class Minuteman
-  # Public: Day TimeSpan class
-  #
-  class Day < TimeSpan
-    private
-
-    # Private: The format that's going the be used for the date part of the key
-    #
-    #   date       - A given Time object
-    #
-    def time_format(date)
-      [DATE_FORMAT % [date.year, date.month, date.day]]
-    end
-  end
-end

data/lib/minuteman/time_spans/hour.rb

@@ -1,19 +0,0 @@
-# Public: Minuteman core classs
-#
-class Minuteman
-  # Public: Hour TimeSpan class
-  #
-  class Hour < TimeSpan
-    private
-
-    # Private: The format that's going the be used for the date part of the key
-    #
-    #   date       - A given Time object
-    #
-    def time_format(date)
-      full_date = DATE_FORMAT % [date.year, date.month, date.day]
-      time = TIME_FORMAT % [date.hour, 0]
-      [full_date + " " + time]
-    end
-  end
-end

data/lib/minuteman/time_spans/minute.rb

@@ -1,19 +0,0 @@
-# Public: Minuteman core classs
-#
-class Minuteman
-  # Public: Minute TimeSpan class
-  #
-  class Minute < TimeSpan
-    private
-
-    # Private: The format that's going the be used for the date part of the key
-    #
-    #   date       - A given Time object
-    #
-    def time_format(date)
-      full_date = DATE_FORMAT % [date.year, date.month, date.day]
-      time = TIME_FORMAT % [date.hour, date.min]
-      [full_date + " " + time]
-    end
-  end
-end

data/lib/minuteman/time_spans/month.rb

@@ -1,17 +0,0 @@
-# Public: Minuteman core classs
-#
-class Minuteman
-  # Public: Month TimeSpan class
-  #
-  class Month < TimeSpan
-    private
-
-    # Private: The format that's going the be used for the date part of the key
-    #
-    #   date       - A given Time object
-    #
-    def time_format(date)
-      [date.year, "%02d" % date.month]
-    end
-  end
-end

data/lib/minuteman/time_spans/week.rb

@@ -1,18 +0,0 @@
-# Public: Minuteman core classs
-#
-class Minuteman
-  # Public: Month TimeSpan class
-  #
-  class Week < TimeSpan
-    private
-
-    # Private: The format that's going the be used for the date part of the key
-    #
-    #   date       - A given Time object
-    #
-    def time_format(date)
-      week = date.strftime("%W")
-      [date.year, "W" + week]
-    end
-  end
-end

data/lib/minuteman/time_spans/year.rb

@@ -1,17 +0,0 @@
-# Public: Minuteman core classs
-#
-class Minuteman
-  # Public: Year TimeSpan class
-  #
-  class Year < TimeSpan
-    private
-
-    # Private: The format that's going the be used for the date part of the key
-    #
-    #   date       - A given Time object
-    #
-    def time_format(date)
-      [date.year]
-    end
-  end
-end

data/test/bench/minuteman_bench.rb

@@ -1,37 +0,0 @@
-require_relative "../test_helper"
-require "minitest/benchmark"
-
-describe Minuteman do
-  before do
-    today     = Time.now.utc
-    last_week = today - (3600 * 24 * 7)
-
-    @analytics = Minuteman.new
-    @analytics.track("login", 12)
-    @analytics.track("login", [2, 42])
-    @analytics.track("login:successful", 567, last_week)
-
-    @week_events       = @analytics.week("login")
-    @last_week_events  = @analytics.week("login", last_week)
-    @last_week_events2 = @analytics.month("login:successful", last_week)
-  end
-
-  bench_performance_constant("AND")   { @week_events & @last_week_events }
-  bench_performance_constant("OR")    { @week_events | @last_week_events }
-  bench_performance_constant("XOR")   { @week_events ^ @last_week_events }
-  bench_performance_constant("NOT")   { ~@week_events }
-  bench_performance_constant("MINUS") { @week_events - @last_week_events }
-
-  bench_performance_constant "complex operations" do
-    @week_events & (@last_week_events ^ @last_week_events2)
-  end
-
-  bench_performance_constant "intersections using cache" do
-    5.times { @week_events & [2, 12, 43] }
-  end
-
-  bench_performance_constant "intersections not using cache" do
-    @analytics.options[:cache] = false
-    5.times { @week_events & [2, 12, 43] }
-  end
-end

data/test/test_helper.rb

@@ -1,9 +0,0 @@
-$:.unshift File.dirname(__FILE__) + '/../lib'
-
-require "bundler/setup"
-require "minitest/spec"
-require "minitest/pride"
-require "minitest/given"
-require "minitest/autorun"
-require "minuteman"
-require "redis-namespace"

data/test/unit/minuteman_test.rb

@@ -1,225 +0,0 @@
-require_relative "../test_helper"
-
-describe Minuteman do
-  Given(:analytics)   { Minuteman.new }
-
-  after { analytics.reset_all }
-
-  context "configuration" do
-    Then { analytics.redis }
-    Then { analytics.options[:cache] == true }
-
-    context "switching options" do
-      Given(:minuteman) { Minuteman.new }
-
-      When { minuteman.options[:cache] = false }
-      Then { minuteman.options[:cache] == false }
-    end
-
-    context "changing time spans" do
-      Given(:time_spans) { %w[year month day hour] }
-      Given(:minuteman) { Minuteman.new(time_spans: time_spans) }
-
-      When { minuteman.track("login", 12) }
-
-      Then { minuteman.respond_to?(:year) }
-      Then { minuteman.respond_to?(:month) }
-      Then { minuteman.respond_to?(:day) }
-      Then { minuteman.respond_to?(:hour) }
-
-      Then { !minuteman.respond_to?(:minute) }
-      Then { !minuteman.respond_to?(:week) }
-
-      Then { minuteman.redis.keys.size == 4 }
-      Then { minuteman.options[:time_spans] == time_spans }
-    end
-
-    context "fail silently" do
-      Given(:minuteman) { Minuteman.new(silent: true, redis: { port: 1234 }) }
-      When(:result) { minuteman.track("test", 1) }
-      Then { result == nil }
-    end
-
-    context "fail loudly" do
-      Given(:minuteman) { Minuteman.new(redis: { port: 1234 }) }
-      When(:result) { minuteman.track("test", 1) }
-      Then { result == Failure(Redis::CannotConnectError) }
-    end
-
-    context "changing Redis connection" do
-      Given(:redis) { Redis.new }
-      Then { Minuteman.redis != redis }
-
-      context "return the correct connection" do
-        When(:minuteman) { Minuteman.new(redis: redis) }
-
-        Then { minuteman.redis == redis }
-      end
-
-      context "switching the connection" do
-        Given(:minuteman) { Minuteman.new }
-        When { minuteman.redis = redis }
-        Then { redis == Minuteman.redis }
-      end
-
-      context "using Redis::Namespace" do
-        Given(:namespace) { Redis::Namespace.new(:ns, redis: Redis.new) }
-        Given(:minuteman) { Minuteman.new(redis: namespace) }
-
-        Then { minuteman.redis == namespace }
-      end
-    end
-  end
-
-  context "event tracking" do
-    Given(:today)       { Time.now.utc }
-    Given(:last_month)  { today - (3600 * 24 * 30) }
-    Given(:last_week)   { today - (3600 * 24 * 7) }
-    Given(:last_minute) { today - 120 }
-
-    Given(:year_events) { analytics.year("login", today) }
-    Given(:week_events) { analytics.week("login", today) }
-    Given(:month_events) { analytics.month("login", today) }
-    Given(:day_events) { analytics.day("login", today) }
-    Given(:hour_events) { analytics.hour("login", today) }
-    Given(:minute_events) { analytics.minute("login", today) }
-    Given(:last_week_events) { analytics.week("login", last_week) }
-    Given(:last_minute_events) { analytics.minute("login", last_minute) }
-    Given(:last_month_events) { analytics.month("login:successful", last_month) }
-
-    before do
-      analytics.track("login", 12)
-      analytics.track("login", [2, 42])
-      analytics.track("login", 2, last_week)
-      analytics.track("login:successful", 567, last_month)
-    end
-
-    Then { analytics.events.size == 2 }
-    Then { year_events.length == 3 }
-    Then { week_events.length == 3 }
-    Then { last_week_events.length == 1 }
-    Then { last_month_events.length == 1 }
-
-    context "reseting" do
-      before { analytics.reset_all }
-      Then { analytics.events.size == 0 }
-
-      context "bit operations" do
-        before { week_events & last_week_events }
-
-        When { analytics.reset_operations_cache }
-        Then { analytics.operations.size == 0 }
-      end
-    end
-
-    context "on a given time" do
-      Then { year_events.length == 3 }
-      Then { week_events.length == 3 }
-
-      Then { week_events.include?(12, 2, 1) == [true, true, false] }
-      Then { year_events.include?(12) }
-      Then { month_events.include?(12) }
-      Then { day_events.include?(12) }
-      Then { hour_events.include?(12) }
-      Then { minute_events.include?(12) }
-
-      Then { last_week_events.include?(2) }
-      Then { !month_events.include?(5) }
-      Then { !last_minute_events.include?(12) }
-      Then { last_month_events.include?(567) }
-    end
-
-    context "listing events" do
-      Then { analytics.events.size == 2 }
-      Then { analytics.events.sort == ["login", "login:successful"] }
-    end
-
-    context "composing" do
-      context "using AND" do
-        Given(:and_operation) { week_events & last_week_events }
-
-        Then { week_events.include?(2) }
-        Then { week_events.include?(12) }
-
-        Then { last_week_events.include?(2) }
-        Then { !last_week_events.include?(12) }
-
-        Then { !and_operation.include?(12) }
-        Then { and_operation.include?(2) }
-        Then { and_operation.length == 1 }
-      end
-
-      context "using OR" do
-        Given(:or_operation) { week_events | last_week_events }
-
-        Then { week_events.include?(2) }
-        Then { last_week_events.include?(2) }
-        Then { !last_week_events.include?(12) }
-
-        Then { or_operation.include?(12) }
-        Then { or_operation.include?(2) }
-        Then { or_operation.length == 3 }
-      end
-
-      context "using NOT" do
-        Given(:not_operation) { ~week_events }
-
-        Then { week_events.include?(2) }
-        Then { week_events.include?(12) }
-
-        Then { !not_operation.include?(12) }
-        Then { !not_operation.include?(2) }
-      end
-
-      context "using OR alias (+)" do
-        Given(:or_operation) { week_events + last_week_events }
-
-        Then { week_events.include?(2) }
-        Then { last_week_events.include?(2) }
-        Then { !last_week_events.include?(12) }
-
-        Then { or_operation.include?(12) }
-        Then { or_operation.include?(2) }
-        Then { or_operation.length == 3 }
-      end
-
-      context "using MINUS" do
-        Given(:substract_operation) { year_events - week_events }
-
-        Then { week_events.include?(2) }
-        Then { year_events.include?(2) }
-        Then { !substract_operation.include?(2) }
-      end
-    end
-
-    context "composing multiple operations" do
-      Given(:multi_operation) { week_events & last_week_events | year_events }
-      Then { multi_operation.is_a?(Minuteman::BitOperations::Result) }
-    end
-
-    context "composing against arrays" do
-      context "using AND returns the intersection" do
-        Given(:ids) { week_events & [2, 12, 43] }
-
-        Then { ids.is_a?(Minuteman::BitOperations::Data) }
-        Then { ids == [2, 12] }
-      end
-
-      context "using MINUS returns the difference" do
-        Given(:ids) { week_events - [2, 12, 43] }
-
-        Then { ids.is_a?(Minuteman::BitOperations::Data) }
-        Then { ids == [43] }
-      end
-
-      context "returns an object that behaves like Array" do
-        Given(:ids) { week_events & [2, 12, 43] }
-
-        Then { ids.each.is_a?(Enumerator) }
-        Then { ids.map.is_a?(Enumerator) }
-        Then { ids.size == 2 }
-      end
-
-    end
-  end
-end