downsampler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69b6e23fcf7ca6d7cfd13deef886f10f0659b6e2
+  data.tar.gz: 292a7affaa256255e3cdf01b64cd9db90e4b84bb
+SHA512:
+  metadata.gz: 4aaff0f40310b3051f959d6bc405d4456f6b63106ef825ca1daa457bb7c4a23b23918531938cefbb665e24f910cf8becafd83f3551c4b05c68fc710338e75c41
+  data.tar.gz: 7f7fcb4619c21b50db7b1bc830b6f95302bfc9f3fcf22480b683c60ae126e58a10c796782a701a1d4e640fee8f41d4e4537c360426d7aad156800ad0f3c7056b

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.ruby-version
+/bin

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Owen Mockler
+
+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,76 @@
+# Downsampler
+
+This gem is for downsampling and "bucketing" time based data. Great for passing data to [chartkick](https://github.com/ankane/chartkick)
+```ruby
+<%= line_chart User.downsample_by(60, :created_at).counts %> # 1 minute buckets
+```
+Implemented without any dependencies so you don't need activesupport or activerecord.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'downsampler'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install downsampler
+
+## Usage
+
+```ruby
+DataPoint = Struct.new(:time, :value)
+data_points = (1..9).map { |i| DataPoint.new(Time.now + i*20, i)}
+
+downsampled = data_points.downsample_by(1.minute, &:time)
+#{
+# 2014-08-18 15:01:00 -0400=>
+#  [#<struct DataPoint time=2014-08-18 15:03:40 -0400, value=1>,
+#   #<struct DataPoint time=2014-08-18 15:03:20 -0400, value=2>,
+#   #<struct DataPoint time=2014-08-18 15:03:00 -0400, value=3>],
+# 2014-08-18 15:02:00 -0400=>
+#  [#<struct DataPoint time=2014-08-18 15:02:40 -0400, value=4>,
+#   #<struct DataPoint time=2014-08-18 15:02:20 -0400, value=5>,
+#   #<struct DataPoint time=2014-08-18 15:02:00 -0400, value=6>],
+# 2014-08-18 15:03:00 -0400=>
+#  [#<struct DataPoint time=2014-08-18 15:01:40 -0400, value=7>,
+#   #<struct DataPoint time=2014-08-18 15:01:20 -0400, value=8>,
+#   #<struct DataPoint time=2014-08-18 15:01:00 -0400, value=9>]
+#}
+
+downsampled.sum &:value
+#{
+# 2014-08-18 15:01:00 -0400=> 6,
+# 2014-08-18 15:02:00 -0400=> 15,
+# 2014-08-18 15:03:00 -0400=> 24
+#}
+
+downsampled.mean { |point| point.value }
+#{
+# 2014-08-18 15:01:00 -0400=> 2,
+# 2014-08-18 15:02:00 -0400=> 5,
+# 2014-08-18 15:03:00 -0400=> 8
+#}
+
+downsampled.counts
+#{
+# 2014-08-18 15:01:00 -0400=> 3,
+# 2014-08-18 15:02:00 -0400=> 3,
+# 2014-08-18 15:03:00 -0400=> 3
+#}
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/omockler/downsampler/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'nested']
+end
+
+task :default => :spec

data/downsampler.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'downsampler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "downsampler"
+  spec.version       = Downsampler::VERSION
+  spec.authors       = ["Owen Mockler"]
+  spec.email         = ["omockler@gmail.com"]
+  spec.summary       = %q{Downsample and group temporal data sets in ruby.}
+  spec.description   = %q{Downsample and group temporal data sets in ruby. Great for preparing time data for display in a chart.}
+  spec.homepage      = "https://github.com/omockler/downsampler"
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-nc", "~> 0.1"
+end

data/lib/downsampler.rb

@@ -0,0 +1,9 @@
+require "downsampler/version"
+require "downsampler/time_extensions"
+require "downsampler/enumerable_extensions"
+require "downsampler/downsampled_hash"
+require "downsampler/base"
+
+module Downsampler
+  
+end

data/lib/downsampler/base.rb

@@ -0,0 +1,11 @@
+module Enumerable
+  def downsample_by secs, &block
+    downsampled_hash = group_by do |value|
+      time = yield value
+      time = Time.parse(time) unless time.is_a?(Time)
+      time = time.dup.extend(Downsampler::TimeExt)
+      time.floor(secs)
+    end
+    Downsampler::DownsampledHash.new(downsampled_hash)
+  end
+end

data/lib/downsampler/downsampled_hash.rb

@@ -0,0 +1,27 @@
+module Downsampler
+  class DownsampledHash < DelegateClass(Hash)
+    
+    def mean &block
+      inject({}) do |initial, (key, value)|
+        result = value.dup.extend(EnumerableExt).mean(&block) if value.is_a?(Array)
+        initial[key] = result
+        initial
+      end
+    end
+
+    def sum &block
+      inject({}) do |initial, (key, value)|
+        result = value.dup.extend(EnumerableExt).sum(&block) if value.is_a?(Array)
+        initial[key] = result
+        initial
+      end
+    end
+
+    def counts
+      inject({}) do |initial, (key, value)|
+        initial[key] = values.count
+        initial
+      end
+    end
+  end
+end

data/lib/downsampler/enumerable_extensions.rb

@@ -0,0 +1,14 @@
+module Downsampler
+  module EnumerableExt
+    def sum &block
+      inject(0.0) do |result, el|
+        el = yield(el) if block_given?
+        result + el.to_f
+      end
+    end
+
+    def mean &block
+      sum(&block) / size
+    end
+  end
+end

data/lib/downsampler/time_extensions.rb

@@ -0,0 +1,7 @@
+module Downsampler
+  module TimeExt
+    def floor(seconds = 60)
+      Time.at((self.to_f / seconds).floor * seconds)
+    end
+  end
+end

data/lib/downsampler/version.rb

@@ -0,0 +1,3 @@
+module Downsampler
+  VERSION = "0.1.0"
+end

data/spec/downsampler_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Downsampler do
+  let(:data) { generate_enumerable }
+  let(:downsampled_data) { data.downsample_by(60, &:time) }    
+
+  it "should add downsample_by method" do
+    expect([]).to respond_to :downsample_by
+  end
+
+  describe ".downsample_by" do
+    
+    it "should return a downsampled hash" do
+      expect(downsampled_data).to be_a(Downsampler::DownsampledHash)
+    end
+
+    it "should generate the correct group keys" do
+      sorted_keys = downsampled_data.keys.sort
+      first_time = sorted_keys.first
+      generated_keys = sorted_keys.size.times.map do |i|
+        first_time + i*60
+      end
+      expect(generated_keys == sorted_keys).to be true
+    end
+
+    it "should create 3 groups for the 9 datapoints" do
+      expect(downsampled_data.count).to eq(3)
+    end
+
+    it "should disribute the groups correctly" do
+      downsampled_data.each_pair do |key, values|
+        expect(
+          (values.first.time + 60) > values.last.time
+        ).to be true
+      end
+    end
+
+  end
+
+  describe ".sum" do
+    let(:first_key) { downsampled_data.keys.first }
+    let(:summed) { downsampled_data.sum(&:value) }
+    
+    it "should correctly sum each group" do
+      #first group should have the values [1,2,3]
+      expect(summed[first_key]).to eq 6
+    end
+
+    it "should leak sum method to original array" do
+      summed
+      expect(downsampled_data[first_key]).not_to respond_to :sum
+    end
+  end
+
+  describe ".mean" do
+    let(:first_key) { downsampled_data.keys.first }
+    let(:meaned) { downsampled_data.mean(&:value) }
+    
+    it "should correctly average each group" do
+      expect(meaned[first_key]).to eq 2
+    end
+
+    it "should not leak mean method to original array" do
+      meaned
+      expect(downsampled_data[first_key]).not_to respond_to :mean
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'pry'
+require 'downsampler'
+
+DataPoint = Struct.new :name, :time, :value
+
+def generate_enumerable
+  time = Time.at((Time.now.to_f / 60).floor * 60) # Emulate Time.floor
+  
+  (1..9).map do |i|
+    DataPoint.new("Point #{i}", (time - i*20), i)
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: downsampler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Owen Mockler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Downsample and group temporal data sets in ruby. Great for preparing
+  time data for display in a chart.
+email:
+- omockler@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- downsampler.gemspec
+- lib/downsampler.rb
+- lib/downsampler/base.rb
+- lib/downsampler/downsampled_hash.rb
+- lib/downsampler/enumerable_extensions.rb
+- lib/downsampler/time_extensions.rb
+- lib/downsampler/version.rb
+- spec/downsampler_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/omockler/downsampler
+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: Downsample and group temporal data sets in ruby.
+test_files:
+- spec/downsampler_spec.rb
+- spec/spec_helper.rb
+has_rdoc: