time_trap 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9361576b04ddf585f8d821923da1e6ea6f5f72a4
-  data.tar.gz: 66c919c5dee91255159444cd84a36f763f1974ee
+  metadata.gz: d30223f65f22ddaf031ee3b26a82f4ae4dc575a4
+  data.tar.gz: 6211bb8bcceb931d380cdf3baf4421ed921bc4da
 SHA512:
-  metadata.gz: 2a4d5b58a2a1d820877ceb73565b5ffd68936aadb683c81bec8410c6f16b93c884deae21562ee0c18dd900a64fda10313e60eddf247b9f1d9fb7cf32147a9084
-  data.tar.gz: 995f619ce1d64aa20e17859a5859d1f9b66e2cfd0f6e78d74ee0c5c2d1f96499a1ec18c86f814aea13dccec31627360ef2c911491b8c4a82d163e0aa048aac01
+  metadata.gz: 69686f11676f70fd77ab8ae7ec0fac6f4785f50b50773867d3ef2f2f0b4ce4015da44c7d42d87304eff0ed0e3f7a6499b29628ddaf259a2d885ad4a3b5d1e116
+  data.tar.gz: 832d5fb56b1685ed60b13ae06f92e22c654d51c65996f374ad9fbf1c28f0478feeb10eeedbfbd5aa07fd985957f9862d0297363d2ebd1ac466ebda54a706c169

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/README.md

@@ -1,33 +1,17 @@
-# Timetrap
+# TimeTrap
 
-Timetrap impelents a moving window data structure for keeping track of top-k things
+TimeTrap impelents a moving window data structure for keeping track of top-k things
 as they are created (eg. tweets, exceptions in a log file, or :Q
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-    gem 'time_trap'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install time_trap
+|||
+|---|---|
+|bundler|gem 'time_trap'|
+|raw gem|gem install time_trap|
 
 ## Usage
 
     tt = TimeTrap.new
     tt.add("benedict")
     tt.add("cumberbatch")
-
-
-## Contributing
-
-1. Fork it ( http://github.com/<my-github-username>/timetrap/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request

data/lib/timetrap/deque.rb

@@ -1,3 +1,5 @@
+# Deque is an inplementation of a [double ended queue] (https://en.wikipedia.org/wiki/Double-ended_queue)
+# currently implemented using an array
 class Deque
   attr_accessor :queue
 
@@ -5,27 +7,35 @@ class Deque
     @queue = []
   end
 
+  # @return [Object] return earliest object added
   def first
     return @queue.last
   end
 
+  # @return [Object] return most recent object added
   def last
     return @queue.first
   end
-
+  
+  # @param [FixNum] time time value to pushed into queue
   def push(time=Time.now.to_i)
     @queue << time
     return time
   end
 
+  # @return [FixNum] return most recent time added
   def pop
     return @queue.shift
   end
 
+  # @return [FixNum] return count of objects in queue
   def count
     return @queue.size
   end
 
+  # @param [FixNum] start_time beginning of time range for window
+  # @param [FixNum] end_time end of time range for window
+  # @return [Array] returns array of time entries contained in window
   def window(start_time, end_time)
     ret = @queue.select {|data_time| data_time >= start_time && data_time <= end_time }
     return ret

data/lib/timetrap.rb

@@ -1,8 +1,84 @@
-require "timetrap/timetrap"
-require "timetrap/version"
-require "timetrap/deque"
 
+# TimeTrap is a data structure that allows stores instances of keys added over time.
+# At its core, TimeTrap is a hash where keys are data instances tracked and values are 
+# arrays of time(s) when teh data instance occurred.
 
-module Timetrap
-  # Your code goes here...
+class TimeTrap
+  include Enumerable
+
+  def initialize
+    @tt = {}
+  end
+
+  # Add an instance of value to timetrap. time defaults to seconds since
+  # epoch unless you provide a value.
+  def add(value, time=Time.now.to_i)
+    @tt[value] ||= Deque.new
+    return @tt[value].push(time)
+  end
+
+  # @param [Object] value key to retrieve. 
+  # @return [Array] array of time instances the value was added
+  def get(value)
+    ret = @tt[value].nil? ? nil : @tt[value].queue
+    return ret
+  end
+
+  # @return [Array] array of values that have been added
+  def keys
+    return @tt.keys
+  end
+
+  # allows block code to be run on each entry in TimeTrap
+  def each(&block)
+    @tt.each(&block)
+  end
+
+  # removes k/v from TimeTrap if block code evaluates to true
+  # @return [TimeTrap] TimeTrap instance with deleted entries removed
+  def delete_if(&block)
+    @tt.delete_if(&block)
+  end
+  
+  # @return [Array] of values sorted by argued block code
+  def sort_by(&block)
+    @tt.sort_by(&block)
+  end
+
+  # @param [Fixnum] rank number of entries to return
+  # @return [Array] array of keys sorted by number of instances
+  def top(rank) 
+    ret = @tt.sort_by {|k,v| -v.count}.map{|k,v| k}
+    return ret[0..rank - 1]
+  end
+
+  # @param [Fixnum] secs number of seconds before current time for window
+  # @return [Hash] returns hash of values in window key=added data, value = count 
+  # of occurences in last argued secondswindow 
+  def last(secs)
+    t = Time.now.to_i
+    return window(t - secs, t)
+  end 
+
+  # @param [Object] key key to look up in TimeTrap
+  # @return [bool] obvious??
+  def has_key?(key)
+    return @tt.has_key?(key)
+  end
+
+  # @return count of distinct keys which have been added
+  def count
+    return @tt.count
+  end
+
+  # @param [FixNum] start_sec beginning on time frame
+  # @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}
+    return ret
+  end
 end
+
+require 'timetrap/deque'

data/spec/{timetrap/timetrap_spec.rb → timetrap_spec.rb}

@@ -16,6 +16,18 @@ describe TimeTrap do
     end
   end
 
+  context "#get" do
+    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])
+    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 "keeps count of objects added" do
       time = ttrap.add("test_1")

data/time_trap.gemspec

@@ -1,16 +1,15 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'timetrap/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "time_trap"
-  spec.version       = Timetrap::VERSION
+  spec.version       = "0.0.5"
   spec.authors       = ["Pat Farrell"]
   spec.email         = ["mr.patfarrell@gmail.com"]
   spec.summary       = %q{"exposes a data structure suitable for capturing and inspecting moving windows of data"}
   spec.description   = %q{"timetrap is a work in progress to create a simple data strucutre that allows for windowed inspection of counts added to a hash"}
-  spec.homepage      = "http://github.com/pfarrell/timetrap"
+  spec.homepage      = "https://rubygems.org/gems/time_trap"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -20,9 +19,10 @@ Gem::Specification.new do |spec|
 
 
   spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "yard"
-  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "rake", "~> 10.1"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "simplecov", "~> 0.8"
+  spec.add_development_dependency "yard", "~> 0.8"
+  spec.add_development_dependency "byebug", "~> 2.7"
+  spec.add_development_dependency "markdown", "~> 1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: time_trap
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Pat Farrell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-26 00:00:00.000000000 Z
+date: 2014-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,72 +28,86 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 description: "\"timetrap is a work in progress to create a simple data strucutre that
   allows for windowed inspection of counts added to a hash\""
 email:
@@ -104,19 +118,18 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".yardopts"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/timetrap.rb
 - lib/timetrap/deque.rb
-- lib/timetrap/timetrap.rb
-- lib/timetrap/version.rb
 - spec/spec_helper.rb
 - spec/timetrap/deque_spec.rb
-- spec/timetrap/timetrap_spec.rb
+- spec/timetrap_spec.rb
 - time_trap.gemspec
-homepage: http://github.com/pfarrell/timetrap
+homepage: https://rubygems.org/gems/time_trap
 licenses:
 - MIT
 metadata: {}
@@ -144,5 +157,5 @@ summary: "\"exposes a data structure suitable for capturing and inspecting movin
 test_files:
 - spec/spec_helper.rb
 - spec/timetrap/deque_spec.rb
-- spec/timetrap/timetrap_spec.rb
+- spec/timetrap_spec.rb
 has_rdoc: 

data/lib/timetrap/timetrap.rb

@@ -1,56 +0,0 @@
-class TimeTrap
-  include Enumerable
-
-  def initialize
-    @tt = {}
-  end
-
-  def add(value, time=Time.now.to_i)
-    @tt[value] ||= Deque.new
-    return @tt[value].push(time)
-  end
-
-  def get(value)
-    return @tt[value].queue
-  end
-
-  def keys
-    return @tt.keys
-  end
-
-  def each(&block)
-    @tt.each(&block)
-  end
-
-  def delete_if(&block)
-    @tt.delete_if(&block)
-  end
-
-  def sort_by(&block)
-    @tt.sort_by(&block)
-  end
-
-  def top(rank) 
-    ret = @tt.sort_by {|k,v| -v.count}.map{|k,v| k}
-    return ret[0..rank - 1]
-  end
-
-  def last(secs)
-    t = Time.now.to_i
-    return window(t - secs, t)
-  end 
-
-  def has_key?(key)
-    return @tt.has_key?(key)
-  end
-
-  def count
-    return @tt.count
-  end
-
-  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}
-    return ret
-  end
-end

data/lib/timetrap/version.rb

@@ -1,3 +0,0 @@
-module Timetrap
-  VERSION = "0.0.3"
-end