time_trap 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba64909a7782c28a1ba2e3d5b8178b9e791c8c08
-  data.tar.gz: e8d8b0d99b514679c6e4c5753003cfc13d84033b
+  metadata.gz: c2b8dc2516b7ae270ce33ab45bb0b872b50324c9
+  data.tar.gz: 01a073d6a79ff73dc07e5df36ec00bf1d30a3e89
 SHA512:
-  metadata.gz: 8e1f2c2d0c862cbb3c7940fade75461ea9adf1973f5be8b817f5d215ad4e2d40c9389e444f8cd6551c335d9140944c36c55b9405cb4ed7509d59fc13a098ea9b
-  data.tar.gz: 62695e704347a159b523a8f74cafc0533e970f6ce77b9dfb2a0ac202cfee052922598ca18669402a2fccbe289a1d8fb2e340447e00fffd5eff4d0cb645084fc7
+  metadata.gz: 0f7a025cdfd2ad20c5c3fbd12ec3a76285fabd2fbf5c8167ced233f542756d08f15af3ee03254e4086c10690d787d973355b312c1eb314e1db20793b02430a34
+  data.tar.gz: b08617429e10da832b339eea6bb62e072d96f7164a187d825af5860205d3a118cd72764b9facd8a61822deccf3f24d4d99420a843bdb5b3b9c15d817e795c316

data/lib/timetrap.rb

@@ -18,9 +18,9 @@ class TimeTrap
   end
 
   # @param [Object] value key to retrieve. 
-  # @return [Array] array of time instances the value was added
+  # @return [Hash] key = value, value = array of time entries.  nil if missing
   def get(value)
-    ret = @tt[value].nil? ? nil : @tt[value].queue
+    ret = @tt[value].nil? ? nil : {value => @tt[value].queue}
     return ret
   end
 
@@ -45,11 +45,16 @@ class TimeTrap
     @tt.sort_by(&block)
   end
 
-  # @param [Fixnum] rank number of entries to return
-  # @return [Array] array of keys sorted by number of instances
+  # @param [Fixnum] number of entries to return
+  # @return [TimeTrap] TimeTrap consting of top values
   def top(rank) 
-    ret = @tt.sort_by {|k,v| -v.count}.map{|k,v| k}
-    return ret[0..rank - 1]
+    ret = TimeTrap.new
+    @tt.sort_by {|k,v| -v.count}.map{|k,v| 
+      ret.set(k, v)
+      rank -= 1
+      break if rank <= 0
+    }
+    return ret
   end
 
   # @param [Fixnum] secs number of seconds before current time for window
@@ -75,10 +80,17 @@ class TimeTrap
   # @param [FixNum] end_sec end of time frame
   # @return [Hash] key = value added to TimeTrap, value = count of instances in the window
   def window(start_sec, end_sec) 
-    ret = {}
-    @tt.each {|k,v| ret[k] = v.window(start_sec, end_sec).count if v.window(start_sec, end_sec).count > 0}
+    ret = TimeTrap.new
+    @tt.each {|k,v| ret.set(k, v.window(start_sec, end_sec)) if v.window(start_sec, end_sec).count > 0}
     return ret
   end
+
+  # allows direct set access to internal hash
+  # @param [Object] key value being tracked
+  # 
+  def set(key, value)
+    @tt[key] = value
+  end
 end
 
 require 'timetrap/deque'

data/spec/timetrap_spec.rb

@@ -4,6 +4,12 @@ describe TimeTrap do
   let(:ttrap) { TimeTrap.new }
 
   context "#add" do
+    it "returns the time_added in seconds since epoch" do
+      t = Time.now.to_i
+      expect(ttrap.add("test_1")).to be_a(Fixnum) 
+      expect(ttrap.add("test_1")).to eq(t)
+    end
+    
     it "allows values to be added" do
       ttrap.add("test_1")
       expect(ttrap.count).to eq(1)
@@ -12,32 +18,48 @@ describe TimeTrap do
     it "allows values to be added with a timestamp" do
       t = Time.now.to_i - 1000
       ttrap.add("test_1", t)
-      expect(ttrap.get("test_1")).to match_array([t])
+      expect(ttrap.get("test_1")["test_1"]).to match_array([t])
     end
   end
 
   context "#get" do
+    it "returns a hash" do
+      ttrap.add("test_1")
+      expect(ttrap.get("test_1")).to be_a(Hash)
+    end
+
     it "allows retrieval of values" do
       t = Time.now.to_i
       ttrap.add("test_1", t)
-      expect(ttrap.get("test_1")).to match_array([t])
+      expect(ttrap.get("test_1")["test_1"]).to match_array([t])
     end
-
+                                      
     it "returns nil for keys that haven't been added" do
       expect(ttrap.get("test_1")).to be_nil
     end
   end
 
   context "#count" do
+    it "returns a Fixnum" do
+      ttrap.add("test_1")
+      expect(ttrap.count).to be_a(Fixnum)
+    end
+
     it "keeps count of objects added" do
       time = ttrap.add("test_1")
       expect(ttrap.count).to eq(1)
-      expect(ttrap.get("test_1").first).to eq(time)
-      expect(ttrap.get("test_1").last).to eq(time)
+      expect(ttrap.get("test_1")["test_1"].first).to eq(time)
+      expect(ttrap.get("test_1")["test_1"].last).to eq(time)
     end
   end
 
   context "#has_key?" do
+    it "returns a bool" do
+      ttrap.add("test_1")
+      expect(ttrap.has_key?("test_1")).to be_a(TrueClass)
+      expect(ttrap.has_key?("test_2")).to be_a(FalseClass)
+    end
+    
     it "checks on added keys" do
       ttrap.add("test_1")
       expect(ttrap.has_key?("test_1")).to eq(true)
@@ -49,6 +71,11 @@ describe TimeTrap do
   end
 
   context "#keys" do
+    it "returns an array" do
+      ttrap.add("test_1")
+      expect(ttrap.keys).to be_an(Array)
+    end
+
     it "returns array of added keys" do
       ttrap.add("test_1")
       ttrap.add("test_2")
@@ -57,6 +84,10 @@ describe TimeTrap do
   end
 
   context "#each" do
+    it "is an enumerator" do
+      expect(ttrap.each).to be_an(Enumerator)
+    end
+
     it "allows block code to be run on each key" do
       (1..3).each {|i| ttrap.add("test_#{i}")}
       cnt = 0
@@ -66,6 +97,10 @@ describe TimeTrap do
   end
     
   context "#delete_if" do
+    it "is an enumerator" do
+      expect(ttrap.each).to be_an(Enumerator)
+    end
+
     it "allows block code to be run on each key" do
       (1..3).each {|i| ttrap.add("test_#{i}")}
       ttrap.delete_if {|key, val| key == "test_1"}
@@ -74,6 +109,10 @@ describe TimeTrap do
   end
     
   context "#sort_by" do
+    it "is an enumerator" do
+      expect(ttrap.each).to be_an(Enumerator)
+    end
+
     it "allows access to keys sorted by output of block code" do
       (0..0).each {|i| ttrap.add("1")}
       (0..1).each {|i| ttrap.add("2")}
@@ -86,30 +125,46 @@ describe TimeTrap do
   end
 
   context "#top" do
+    it "returns a TimeTrap" do
+      ttrap.add("test_1")
+      expect(ttrap.top(1)).to be_a(TimeTrap)
+    end
+
     it "gives you the top values sorted by code block" do
       (0..0).each {|i| ttrap.add("1")}
       (0..1).each {|i| ttrap.add("2")}
       (0..2).each {|i| ttrap.add("3")}
-      arr = ttrap.top(1)
-      expect(arr).to match_array(["3"]) 
+      expect(ttrap.top(1).count).to eq(1)
+      expect(ttrap.top(1).get("3")["3"].count).to eq(3)
     end
   end
 
   context "#window" do
+    it "returns a TimeTrap" do
+      t = Time.now.to_i
+      (0..9).each {|i| ttrap.add(i)}
+      expect(ttrap.window(t - 60, t)).to be_a(TimeTrap)
+    end
+
     it "allows retrieves of key counts over a window of time" do
       t = Time.now.to_i
       (0..9).each {|i| ttrap.add(i)}
-      expect(ttrap.window(t - 60, t).size).to eq(10)
+      expect(ttrap.window(t - 60, t).count).to eq(10)
     end
 
     it "allows retrieves of key counts ignoring expired ones" do
       t = Time.now.to_i
       (0..9).each{|i| ttrap.add(i, t - 61)}
-      expect(ttrap.window(t - 60, t).size).to eq(0)
+      expect(ttrap.window(t - 60, t).count).to eq(0)
     end
   end
 
   context "#last" do
+    it "returns a TimeTrap" do
+      ttrap.add("test_1")
+      expect(ttrap.last(60)).to be_a(TimeTrap)
+    end
+
     it "gives last day's worth of data" do
       t = Time.now.to_i
       (0..9).each{|i| ttrap.add(i, t - 60*60*24 - 1)}

data/time_trap.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "time_trap"
-  spec.version       = "0.1.0"
+  spec.version       = "0.2.0"
   spec.authors       = ["Pat Farrell"]
   spec.email         = ["mr.patfarrell@gmail.com"]
   spec.summary       = %q{TimeTrap impelents a moving window data structure for keeping track of top-k things}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: time_trap
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Pat Farrell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-27 00:00:00.000000000 Z
+date: 2014-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler