histomatic 0.0.1.beta.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+tmp/*

data/.rspec

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

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$}) { "spec" }
+  watch(%r{^lib/(.+)\.rb$})     { "spec" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2011 Christopher Meiklejohn.
+
+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.markdown

@@ -0,0 +1,53 @@
+# Histomatic
+
+Quick n' dirty histograms for Rails.
+
+## Notice
+
+Currently in development, and only supports the mysql2 driver.
+
+## Usage
+
+Generate a histogram providing an input source, which is either an
+ActiveRecord class or instance of ActiveRelation, a column as a string,
+and groupings.  
+
+Currently the column must return a numeric.
+
+### Examples
+
+Provide a class:
+
+```ruby
+Histomatic.generate(
+  Purchase, 
+  'amount', 
+  [0, 10, 20]
+).to_hash # { 0 => 2, 10 => 0, 20 => 0 }
+```
+
+Provide an ActiveRelation:
+
+```ruby
+Histomatic.generate(
+  Purchase.where(:name => 'Chris'), 
+  'amount', 
+  [0, 10, 20]
+).to_hash # { 0 => 1, 10 => 0, 20 => 0 }
+```
+
+Provide a transformation as the column:
+
+```ruby
+Histomatic.generate(
+  Purchase.where(:name => 'Chris'), 
+  'datediff(current_date, purchases.created_at)', 
+  [0, 10, 20]
+).to_hash # { 0 => 0, 10 => 1, 20 => 0 }
+```
+
+## License
+
+Histomatic is Copyright © 2012 Christopher Meiklejohn.  Histomatic is
+free software, and may be redistributed under the terms specified in the
+LICENSE file.

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+
+require 'rubygems'
+require 'bundler'
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rdoc/task'
+require 'rake/clean'
+require 'rubygems/package_task'
+require 'rspec/core/rake_task'
+require 'rdoc'
+require 'yard'
+
+include Rake::DSL
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']
+  t.options = ['--no-private']
+end
+
+task :default => [:spec]

data/db/schema.rb

@@ -0,0 +1,11 @@
+# encoding: UTF-8
+
+ActiveRecord::Schema.define do 
+  self.verbose = false
+
+  create_table :purchases, :force => true do |t|
+    t.string :name
+    t.decimal :amount
+    t.timestamps
+  end
+end

data/histomatic.gemspec

@@ -0,0 +1,41 @@
+# encoding: UTF-8
+
+$:.push File.expand_path("../lib", __FILE__)
+require "histomatic/version"
+
+Gem::Specification.new do |s|
+  s.name        = "histomatic"
+  s.version     = Histomatic::VERSION
+  s.authors     = ["Christopher Meiklejohn"]
+  s.email       = ["christopher.meiklejohn@gmail.com"]
+  s.homepage    = "http://github.com/cmeiklejohn/histomatic"
+  s.summary     = %q{Quick 'n dirty histograms.}
+  s.description = %q{Quick 'n dirty histograms.}
+
+  s.rubyforge_project = "histomatic"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency('rails')
+
+  s.add_development_dependency('yard')
+  s.add_development_dependency('rdoc')
+  s.add_development_dependency('redcarpet')
+
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('rake')
+
+  s.add_development_dependency('bundler')
+  s.add_development_dependency('rspec') 
+  s.add_development_dependency('rspec-rails') 
+  s.add_development_dependency('guard')
+  s.add_development_dependency('guard-rspec') 
+  s.add_development_dependency('mysql2')
+  s.add_development_dependency('sqlite3')
+  s.add_development_dependency('factory_girl')
+  s.add_development_dependency('factory_girl_rails')
+  s.add_development_dependency('diesel') 
+end

data/lib/histomatic.rb

@@ -0,0 +1,128 @@
+# encoding: UTF-8
+
+require 'histomatic/version'
+
+# {{Histomatic}}: Quick 'n dirty histograms from {{ActiveRecord}} sources.
+#
+module Histomatic
+
+  class << self
+
+    # Generate a histogram from a particular {{ActiveRecord}} or
+    # {{ActiveRelation}} source.
+    #
+    # @param  [ActiveRelation]
+    # @param  [String] 
+    # @param  [Array<Float>]
+    # @return [Histogram]
+    #
+    def generate(source, column, bins) 
+      Histogram.new(source, column, bins)
+    end
+
+  end
+
+  class Histogram
+
+    attr_reader :source, :column, :bins
+
+    # Create a new {{Histogram}} instance.
+    #
+    def initialize(source, column, bins)
+      @source = source
+      @column = column 
+      @bins   = bins
+    end
+
+    # Return hash representation.
+    #
+    # @return [Hash]
+    #
+    def to_hash
+      serializable_hash
+    end
+
+    # Return json representation.
+    #
+    # @return [String]
+    #
+    def to_json
+      JSON.generate(to_hash)
+    end
+
+    # Return the result as a keys representing the lower inclusive bound
+    # of bin, with values pointing to the number of objects represented.
+    #
+    # @return [Hash]
+    #
+    def serializable_hash 
+      results.each.inject(empty_bins) do |histogram, result|
+        histogram[result] = histogram[result] ? histogram[result] + 1 : 1; histogram
+      end
+    end
+
+    # Return SQL for generating the source data for this histogram.
+    #
+    # @return  [String]
+    # @private 
+    #
+    def to_sql
+      source.select(bin_sql).to_sql
+    end
+    private :to_sql
+
+    # Return results.
+    #
+    # @return  [Mysql2::Results]
+    # @private
+    #
+    def results 
+      ActiveRecord::Base.connection.execute(to_sql).each.map(&:first)
+    end
+    private :results
+
+    # Convert bins to SQL conditions which can be used to generate the
+    # histogram.
+    #
+    # @return  [String]
+    # @private 
+    # @todo    Inefficient, however, compatible for clients that do not support subselects.
+    #
+    def bin_sql
+      selection = [
+        "CASE",
+        bins.each_cons(2).map do |bounds|
+          case_for(column, bounds.first, bounds.last)
+        end,
+        case_for(column, bins.last),
+        "END"
+      ].flatten.join(' ')
+    end
+    private :bin_sql
+
+    # Returns a case condition and implications for a particular set of
+    # bounds.
+    #
+    # @param   [String]
+    # @param   [Float]
+    # @param   [Float]
+    # @return  [String]
+    # @private 
+    #
+    def case_for(column, lower, upper = nil)
+      "WHEN #{column} >= #{lower} #{" AND #{column} < #{upper} " if upper} THEN #{lower}"
+    end
+
+    # Generate a hash of empty bins used during output.
+    #
+    # @return  [Hash]
+    # @private
+    #
+    def empty_bins
+      bins.inject({}) { |bins, bin| bins[bin] = 0; bins }
+    end
+    private :empty_bins
+
+  end
+
+end

data/lib/histomatic/version.rb

@@ -0,0 +1,3 @@
+module Histomatic
+  VERSION = "0.0.1.beta.1"
+end

data/spec/lib/histomatic_spec.rb

@@ -0,0 +1,66 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+class Purchase < ActiveRecord::Base; end
+
+module Histomatic
+  describe Histogram do 
+    let(:source) { Purchase } 
+    let(:column) { 'amount' } 
+    let(:bins)   { [0, 10, 20] } 
+
+    subject { Histogram.new(source, column, bins) } 
+
+    it 'initializes with a source, column and bins' do 
+      subject.source.should == source
+      subject.column.should == column
+      subject.bins.should == bins
+    end
+
+    context 'with a generated histogram' do 
+      let(:hash) { { 0 => 1, 1 => 2, 2 => 3 } }
+
+      before do 
+        subject.stub(:serializable_hash).and_return(hash)
+      end
+
+      it 'can return a hash' do 
+        subject.to_hash.should == hash
+      end
+
+      it 'can return json' do 
+        JSON.should_receive(:generate).with(hash)
+        subject.to_json
+      end
+    end
+
+    context 'given a few purchases' do 
+      let(:purchases) do 
+        10.times.map do |i|
+          Purchase.new(:amount => i.to_i * 10, :name => "#{i % 2 == 0 ? "Chris" : "Bob"}")
+        end
+      end
+
+      before do 
+        purchases.map { |purchase| purchase.save! }
+      end
+
+      it 'generates a histogram for the amount' do 
+        Histomatic.generate(Purchase, 'amount', [0, 10, 20]).
+          serializable_hash.should == { 0 => 1, 10 => 1, 20 => 8 }
+      end
+
+      it 'generates a histogram for the amount by user' do 
+        Histomatic.generate(Purchase.where(:name => 'Chris'), 'amount', [0, 10, 20]). 
+          serializable_hash.should == { 0 => 1, 10 => 0, 20 => 4 }
+      end
+
+      it 'generates a histogram for the day difference by user' do 
+        Histomatic.generate(Purchase.where(:name => 'Chris'), 
+                            'datediff(purchases.created_at, date_sub(current_date, interval 20 day))', [0, 10, 20]). 
+          serializable_hash.should == { 0 => 0, 10 => 0, 20 => 5 }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+# encoding: UTF-8
+
+ENV["RAILS_ENV"] ||= "test"
+
+PROJECT_ROOT = File.expand_path("../..", __FILE__)
+$LOAD_PATH << File.join(PROJECT_ROOT, "lib")
+
+require 'rails/all'
+require 'rails/test_help'
+Bundler.require
+
+require 'diesel/testing'
+require 'rspec/rails'
+
+require 'histomatic'
+
+Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => "mysql2",
+  :database => "histomatic",
+  :username => "histomatic",
+  :password => "histomatic"
+)
+
+ActiveRecord::Base.silence do
+  ActiveRecord::Migration.verbose = false
+
+  load(File.dirname(__FILE__) + '/../db/schema.rb')
+end
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = true
+  config.backtrace_clean_patterns << %r{gems/}
+end

metadata

@@ -0,0 +1,238 @@
+--- !ruby/object:Gem::Specification
+name: histomatic
+version: !ruby/object:Gem::Version
+  version: 0.0.1.beta.1
+  prerelease: 6
+platform: ruby
+authors:
+- Christopher Meiklejohn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &20707620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *20707620
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &20705980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20705980
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &20704460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20704460
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &20737720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20737720
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &20735820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20735820
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &20750800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20750800
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &20748620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20748620
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &20744140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20744140
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &20757300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20757300
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &20765880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20765880
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &21443240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *21443240
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: &21440240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *21440240
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &21449520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *21449520
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: &21447740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *21447740
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: &21472720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *21472720
+- !ruby/object:Gem::Dependency
+  name: diesel
+  requirement: &21482480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *21482480
+description: Quick 'n dirty histograms.
+email:
+- christopher.meiklejohn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE
+- README.markdown
+- Rakefile
+- db/schema.rb
+- histomatic.gemspec
+- lib/histomatic.rb
+- lib/histomatic/version.rb
+- spec/lib/histomatic_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/cmeiklejohn/histomatic
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4312745738876464787
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: histomatic
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Quick 'n dirty histograms.
+test_files: []
+has_rdoc: