time_trap 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: decaa1492bb3108915fc2d0d23de83bc1bd4b3fd
+  data.tar.gz: f0c33bec056e1164c9dae75a52aa980b3aa93090
+SHA512:
+  metadata.gz: c0aa92b03f7c0715bec78922c79176b49cd35e3e0d228cf06740f035142f66ef7222335ac42eaf58be5ac6f8def6051f3a105baf5748ab4a161e2b65c9ab2244
+  data.tar.gz: 98518edd71bcb487521d4e31a1f813a963322dc845718bd8dc92fa2c52031a7cd1a24126de7e8daf4eed24edbee6be22c6449da600e0d780dc4d77d6bdc6ed11

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor
+coverage

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in time_trap.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Pat Farrell
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# Timetrap
+
+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 'timetrap'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install timetrap
+
+## Usage
+
+## 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/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "yard"
+
+  YARD::Rake::YardocTask.new do |t|
+    #t.files   = ['lib/**/*.rb']   # optional
+    #t.options = ['--any', '--extra', '--opts'] # optional
+  end

data/lib/timetrap/deque.rb

@@ -0,0 +1,35 @@
+class Deque
+  attr_accessor :queue
+
+  def initialize
+    @queue = []
+  end
+
+  def first
+    return @queue.last
+  end
+
+  def last
+    return @queue.first
+  end
+
+  def push(time=Time.now.to_i)
+    @queue << time
+    return time
+  end
+
+  def pop
+    return @queue.shift
+  end
+
+  def count
+    return @queue.size
+  end
+
+  def window(start_time, end_time)
+    ret = @queue.select {|data_time| data_time >= start_time && data_time <= end_time }
+    return ret
+  end
+
+end
+

data/lib/timetrap/timetrap.rb

@@ -0,0 +1,51 @@
+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_x(rank) 
+    ret = @tt.sort_by {|k,v| -v.count}.map{|k,v| k}
+    return ret[0..rank - 1]
+  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

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

data/lib/timetrap.rb

@@ -0,0 +1,8 @@
+require "timetrap/timetrap"
+require "timetrap/version"
+require "timetrap/deque"
+
+
+module Timetrap
+  # Your code goes here...
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/vendor/"
+end
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+  require './lib/timetrap'
+  require 'byebug'
+end

data/spec/timetrap/deque_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+
+describe Deque do
+
+  let(:deque) { Deque.new }
+  context "#initialize" do
+    it "has zero count" do
+      expect(deque.count).to  eq(0)
+    end
+  end
+
+  context "#count" do
+    it "has correct count" do
+      (1..100).each {|i| deque.push }
+      expect(deque.count).to eq(100)
+    end
+
+    it "gets incremented" do
+      deque.push
+      expect(deque.count).to eq(1)
+    end
+
+    it "gets decremented" do
+      deque.push
+      deque.pop
+      expect(deque.count).to eq(0)
+    end
+
+    it "stays positive" do
+      (1..100).each {|i| deque.pop }
+      expect(deque.count).to eq(0)
+    end
+  end
+    
+  context "#push" do
+    it "can push to new deque" do
+      deque.push
+      expect(deque.count).to eq(1)
+    end
+  end
+
+  context "#pop" do
+    it "doesn't blow up popping null" do
+      deque.pop
+    end
+
+    it "keeps things FIFO order" do
+    end
+  end
+
+  context "#first" do
+    it "lets you peek at the first element" do
+      (1..3).each {|i| deque.push }
+      deque.push(12345)
+      expect(deque.first).to eq(12345)
+    end
+  end
+
+  context "#last" do
+    it "lets you peek at the last element" do
+      deque.push(12345)
+      (1..3).each {|i| deque.push }
+      expect(deque.last).to eq(12345)
+    end
+  end
+
+  context "#window" do
+    it "returns windowed counts" do
+      t = Time.now.to_i
+      arr = []
+      arr << deque.push(t-1)
+      arr << deque.push(t)
+      expect(deque.window(t - 120, t - 60 )).to eq([])
+      expect(deque.window(t - 60, t)).to match_array(arr)
+    end
+  end
+end

data/spec/timetrap/timetrap_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+describe TimeTrap do
+  let(:ttrap) { TimeTrap.new }
+
+  context "#add" do
+    it "allows values to be added" do
+      ttrap.add("test_1")
+      expect(ttrap.count).to eq(1)
+    end
+
+    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])
+    end
+  end
+
+  context "#count" do
+    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)
+    end
+  end
+
+  context "#has_key?" do
+    it "checks on added keys" do
+      ttrap.add("test_1")
+      expect(ttrap.has_key?("test_1")).to eq(true)
+    end
+
+    it "checks on missing keys" do
+      expect(ttrap.has_key?("test_1")).to eq(false)
+    end
+  end
+
+  context "#keys" do
+    it "returns array of added keys" do
+      ttrap.add("test_1")
+      ttrap.add("test_2")
+      expect(ttrap.keys).to match_array(["test_1", "test_2"])
+    end
+  end
+
+  context "#each" do
+    it "allows block code to be run on each key" do
+      (1..3).each {|i| ttrap.add("test_#{i}")}
+      cnt = 0
+      ttrap.each {|key, val| cnt += 1}
+      expect(cnt).to eq(3)
+    end
+  end
+    
+  context "#delete_if" do
+    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"}
+      expect(ttrap.keys.count).to eq(2)
+    end
+  end
+    
+  context "#sort_by" do
+    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")}
+      (0..2).each {|i| ttrap.add("3")}
+      arr = ttrap.sort_by{|k,v| -v.count}
+      expect(arr[0][0]).to eq("3")
+      expect(arr[1][0]).to eq("2")
+      expect(arr[2][0]).to eq("1")
+    end
+  end
+
+  context "#top_x" do
+    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_x(1)
+      expect(arr).to match_array(["3"]) 
+    end
+  end
+
+  context "#window" do
+    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)
+    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)
+    end
+  end
+end

data/time_trap.gemspec

@@ -0,0 +1,28 @@
+# 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.authors       = ["Pat Farrell"]
+  spec.email         = ["pfarrell@ulive.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      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+
+  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"
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: time_trap
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Pat Farrell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+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:
+- pfarrell@ulive.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- 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
+- time_trap.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: "\"exposes a data structure suitable for capturing and inspecting moving
+  windows of data\""
+test_files:
+- spec/spec_helper.rb
+- spec/timetrap/deque_spec.rb
+- spec/timetrap/timetrap_spec.rb
+has_rdoc: