pg_histogram 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f1fd000101bac4dc9af44882ab5dd641b3062430
+  data.tar.gz: dc532f7711f65c11aa57706edb3ac6a17124f2e1
+SHA512:
+  metadata.gz: dd6ef99ccd68ce5bf02bcf75c79a76bc95b61b91c0a44417cc4283ccd659b71af989b80f3e225bfd1b720695c79df0cbb8f00b045134a2bf01e91d7348af3c18
+  data.tar.gz: 096ae0c70711f89ca3a3f9d9a5dc0c7f4585a14248504244859a49e24f6e2ff2edb34017d4f21f4e1853e70d644eb793caa346b0a3a03e8f2875d1120e0e9b33

data/.gitignore

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

data/.ruby-version

@@ -0,0 +1 @@
+2.1.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 David Roberts
+
+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,52 @@
+# PostgreSQL Histogram (for ActiveRecord)
+
+This gem allows for you to efficiently create a histogram from large data sets in your Rails applications.
+
+It uses PostgreSQL's [width_bucket](http://www.postgresql.org/docs/9.3/static/functions-math.html) function to handle the majority of the processing in the database, and only requires 3 database queries.
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pg_histogram'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pg_histogram
+
+## Usage
+
+Create a Histogram object using the following three parameters:
+
+1. ActiveRecord query to use
+2. Name of column to count frequency of
+3. Bucket size (OPTIONAL - default is 0.5)
+
+<!-- -->
+    histogram = PgHistogram::Histogram.new(Widget.all, 'price', 0.5)
+
+
+Call the results method to retrieve a Hash of bucket minimums and frequency counts
+
+    # create sample data
+    5.times do { Widget.create(price: 1.2) }
+    10.times do { Widget.create(price: 2.9 ) }
+
+    # get the results
+    @histogram_data = histogram.results
+     => {1.0=>5, 2.5=>10}
+
+
+The results can be used by your favorite charting libary, such as [Chartkick](https://github.com/ankane/chartkick), to plot the data.
+
+    <%= column_chart @histogram_data %>
+
+## Dependencies
+
+This gem has been tested with Ruby 2.1.3 and ActiveRecord 4.1.6. Please open an issue or PR if you experience issues with other versions.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rubygems'
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = !!ENV['VERBOSE_TESTS']
+  t.warning = !!ENV['WARNINGS']
+end

data/lib/pg_histogram/histogram.rb

@@ -0,0 +1,86 @@
+module PgHistogram
+  class Histogram
+    attr_reader :query, :column, :bucket_size
+
+    BUCKET_COL = 'bucket'
+    FREQUENCY_COL = 'frequency'
+    ROUND_METHODS_BY_DIRECTION = {
+      nil => :round,
+      down:  :floor,
+      up:    :ceil
+    }
+
+    # column_name name must be safe for SQL injection
+    def initialize(query, column_name, bucket_size = 0.5)
+      @query = query
+      @column = column_name.to_s
+      @bucket_size = bucket_size
+    end
+
+    # returns histogram as hash
+    # bucket minimum as a key
+    # frequency as value
+    def results
+      # error handling case
+      if max == min
+        { min => query.where("#{column} = ?", min).count }
+      else
+        labeled_histogram
+      end
+    end
+
+    def min
+      @min ||= round_to_increment(query.minimum(column), :down)
+    end
+
+    def max
+      @max ||= round_to_increment(query.maximum(column), :up)
+    end
+
+    private
+
+    def num_buckets
+      @buckets ||= ((max - min) / bucket_size).to_i
+    end
+
+    # returns the bucket label (minimum which can be in bucket) based on bucket #
+    def bucket_num_to_label(bucket_num)
+      min + bucket_size * (bucket_num - 1)
+    end
+
+    # rounds to the nearest bucket_size increment
+    # can optionally pass :up or :down to always round in one direction
+    def round_to_increment(num, direction = nil)
+      return 0 if num.nil?
+      round_method = ROUND_METHODS_BY_DIRECTION[direction]
+      denominator = 1 / bucket_size
+      (num * denominator).send(round_method) / denominator.to_f
+    end
+
+    # executes the query and converts bucket numbers to minimum step in bucket
+    def labeled_histogram
+      query_for_buckets.each_with_object({}) do |row, results|
+        results[bucket_num_to_label(row[BUCKET_COL].to_i)] = row[FREQUENCY_COL].to_i \
+          unless row[BUCKET_COL].nil?
+      end
+    end
+
+    def query_for_buckets
+      ActiveRecord::Base.connection.execute(
+        <<-SQL
+          SELECT width_bucket(#{column}, #{min}, #{max}, #{num_buckets}) as #{BUCKET_COL},
+            count(*) as #{FREQUENCY_COL}
+          FROM (#{subquery.to_sql}) as subq_results
+          GROUP BY #{BUCKET_COL}
+          ORDER BY #{BUCKET_COL}
+        SQL
+      )
+    end
+
+    # use passed AR query as a subquery to not interfere with group clause
+    def subquery
+      # override default order
+      query.select(column).order('1')
+    end
+  end
+end

data/lib/pg_histogram/version.rb

@@ -0,0 +1,3 @@
+module PgHistogram
+  VERSION = "0.1"
+end

data/lib/pg_histogram.rb

@@ -0,0 +1,5 @@
+require 'pg_histogram/version'
+require 'pg_histogram/histogram'
+
+module PgHistogram
+end

data/pg_histogram.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pg_histogram/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pg_histogram"
+  spec.version       = PgHistogram::VERSION
+  spec.authors       = ["David Roberts"]
+  spec.email         = ["david.roberts@elocal.com"]
+  spec.description   = %q{Creates a Histogram fron an ActiveRecord query}
+  spec.summary       = %q{Histograms using PostgreSQL and ActiveRecord}
+  spec.homepage      = "https://github.com/eLocal/pg_histogram"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "activerecord", "~> 4.0"
+  spec.add_dependency "pg", "~> 0.1"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/test/database.yml

@@ -0,0 +1,6 @@
+test:
+  adapter: postgresql
+  database: histogram_test
+  username: histogram
+  password: 5q3KwfCR
+  host: localhost

data/test/histogram_test.rb

@@ -0,0 +1,75 @@
+require_relative 'test_helper'
+
+class HistogramTest < Minitest::Test
+
+  def setup
+    Widget.delete_all
+    @hist = PgHistogram::Histogram.new(Widget.all, 'price', 0.5)
+  end
+
+  def test_with_1_result
+    Widget.create!(price: 2.00)
+    
+    assert_equal 2.0, @hist.min, 'Minimum is the single price'
+    assert_equal 2.0, @hist.max, 'Minimum is the single price'
+    assert_equal 1, @hist.results[2.0], 'Frequency of 2.0 bucket'
+  end
+
+  def test_ignores_nils_with_1_result
+    Widget.create!(price: 3.00)
+    Widget.create!(price: nil)
+
+    results = @hist.results
+    assert_equal 3.0, @hist.min, 'Minimum is the single price'
+    assert_equal 3.0, @hist.max, 'Minimum is the single price'
+    assert_equal 1, results.count, 'Histogram bucket count'
+    assert_equal 1, results[3.0], 'Frequency of 3.0 bucket'
+  end
+
+  def test_ignores_nils_with_multiple_results
+    Widget.create!(price: 3.00)
+    Widget.create!(price: 2.25)
+    Widget.create!(price: nil)
+
+    results = @hist.results
+    assert_equal 2.0, @hist.min, 'Minimum'
+    assert_equal 3.0, @hist.max, 'Maximum'
+    assert_equal 2, results.count, 'Histogram bucket count'
+    assert_equal 1, results[3.0], 'Frequency of 3.0 bucket'
+    assert_equal 1, results[2.0], 'Frequency of 2.0 bucket'
+  end
+
+  def test_with_many_results
+    # use a different bucket size
+    hist = PgHistogram::Histogram.new(Widget.all, 'price', 0.25)
+
+    10.times { Widget.create!(price: 3.0) }
+    8.times { Widget.create!(price: 5.76) }
+    min_price = Widget.create!(price: 0.98).price
+    max_price = Widget.create!(price: 6.0).price
+    results = hist.results
+
+    assert_equal 0.75, hist.min, 'Histogram minimum price'
+    assert_equal 6.0, hist.max, 'Histogram maximum price'
+    assert_equal 21, hist.send(:num_buckets), 'Histogram buckets'
+    assert_equal 4, results.size, 'Histogram buckets with results'
+    assert_equal 1, results[0.75], 'Frequency of 0.75 bucket'
+    assert_equal 10, results[3.0], 'Frequency of 3.0 bucket'
+    assert_equal 8, results[5.75], 'Frequency of 5.75 bucket'
+    assert_equal 1, results[6.0], 'Frequency of 6.0 bucket'
+  end
+
+  def test_rounding_to_bucket_size
+    hist = PgHistogram::Histogram.new(nil, nil, 0.25)
+
+    assert_equal 0.5, hist.send(:round_to_increment, 0.478), '0.478 rounded to 0.25 interval'
+    assert_equal 1.0, hist.send(:round_to_increment, 1.1), '1.1 rounded to 0.25 interval'
+    assert_equal 0.5, hist.send(:round_to_increment, 0.5), '0.5 rounded to 0.25 interval'
+    assert_equal 0.25, hist.send(:round_to_increment, 0.478, :down), '0.478 rounded down to 0.25 interval'
+    assert_equal 1.0, hist.send(:round_to_increment, 1.1, :down), '1.1 rounded down to 0.25 interval'
+    assert_equal 0.5, hist.send(:round_to_increment, 0.5, :down), '0.5 rounded down to 0.25 interval'
+    assert_equal 0.5, hist.send(:round_to_increment, 0.478, :up), '0.478 rounded up to 0.25 interval'
+    assert_equal 1.25, hist.send(:round_to_increment, 1.1, :up), '1.1 rounded up to 0.25 interval'
+    assert_equal 0.5, hist.send(:round_to_increment, 0.5, :up), '0.5 rounded up to 0.25 interval'
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,27 @@
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'logger'
+require 'active_record'
+require 'yaml'
+require 'pg_histogram'
+
+config = YAML.load(File.read('test/database.yml'))
+ActiveRecord::Base.establish_connection config['test']
+ActiveRecord::Base.logger = Logger.new 'tmp/test.log'
+ActiveRecord::Base.logger.level = Logger::DEBUG
+ActiveRecord::Migration.verbose = false
+
+
+# Set up the database that we require
+ActiveRecord::Schema.define do
+  create_table :widgets, force: true do |t|
+    t.float :price
+    t.timestamps
+  end
+end
+
+
+
+class Widget < ActiveRecord::Base
+end
+

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: pg_histogram
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- David Roberts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: Creates a Histogram fron an ActiveRecord query
+email:
+- david.roberts@elocal.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pg_histogram.rb
+- lib/pg_histogram/histogram.rb
+- lib/pg_histogram/version.rb
+- pg_histogram.gemspec
+- test/database.yml
+- test/histogram_test.rb
+- test/test_helper.rb
+homepage: https://github.com/eLocal/pg_histogram
+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: Histograms using PostgreSQL and ActiveRecord
+test_files:
+- test/database.yml
+- test/histogram_test.rb
+- test/test_helper.rb