pivot_table 0.0.3

data/.gitignore

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

data/.rspec

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

data/.rvmrc

@@ -0,0 +1,21 @@
+ruby_version="1.9.2"
+gemset_name="pivot"
+
+ok="\033[10;32m"
+warn="\033[1;31m"
+reset="\033[0m"
+
+if rvm list strings | grep -q "${ruby_version}" ; then
+  rvm use ${ruby_version}
+
+  if rvm gemset list | grep -q "${gemset_name}" ; then
+    echo -e "${ok}Using the ${gemset_name} gemset${reset}"
+    rvm gemset use ${gemset_name}
+  else
+    echo -e "${ok}The ${gemset_name} gemset does not exist, using global gemset${reset}"
+  fi
+
+else
+  echo -e "${warn}You do not have the required Ruby installed: ${ruby_version}${reset}"
+
+fi

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+Changelog
+=========
+
+0.0.3
+-----
+
+Renamed gem to pivot_table
+
+0.0.2
+-----
+
+Major refactoring to allow unbalanced dataset to be pivoted.
+
+0.0.1
+-----
+
+Initial release.

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in pivot.gemspec
+gemspec
+
+group :development, :test do
+  gem 'autotest'
+  gem 'autotest-growl'
+  gem 'autotest-notification'
+  gem 'bundler'
+  gem 'launchy'
+  gem 'rcov'
+  gem 'rspec'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ed James
+
+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,95 @@
+Pivot Table
+===========
+
+A handy tool for transforming a dataset into a spreadsheet-style pivot table.
+
+Why make this?
+--------------
+
+One of the most powerful and underrated features of spreadhseet packages is their ability to create pivot tables. I'm often asked
+to replicate this functionality in a web application...
+
+Installation
+------------
+
+Couldn't be easier...
+
+    gem install pivot_table
+
+There are no dependencies and pivot will work on any version of Ruby.
+
+Usage
+-----
+
+At the very least, you will need to provide four things to create a pivot table...
+
+* a dataset (this doesn't necessarily have to be an ActiveRecord dataset, but it should at least behave like ActiveRecord e.g. OpenStruct)
+* the method to be used as column names
+* the method to be used as row names
+* the method to be used as the pivot
+
+Let's say you have a dataset that looks like this (I'll use OpenStruct, but this could easily be ActiveRecord, or even a custom object):
+
+    my_data = []
+    my_data << OpenStruct.new(:city => 'London',   :quarter => 'Q1', :sales => 100)
+    my_data << OpenStruct.new(:city => 'London',   :quarter => 'Q2', :sales => 200)
+    my_data << OpenStruct.new(:city => 'London',   :quarter => 'Q3', :sales => 300)
+    my_data << OpenStruct.new(:city => 'London',   :quarter => 'Q4', :sales => 400)
+    my_data << OpenStruct.new(:city => 'New York', :quarter => 'Q1', :sales => 10)
+    my_data << OpenStruct.new(:city => 'New York', :quarter => 'Q2', :sales => 20)
+    my_data << OpenStruct.new(:city => 'New York', :quarter => 'Q3', :sales => 30)
+    my_data << OpenStruct.new(:city => 'New York', :quarter => 'Q4', :sales => 40)
+
+You can then generate a pivot table like so...
+
+    p = PivotTable::Table.new do |p|
+      p.data     = my_data
+      p.column   = :quarter
+      p.row      = :city
+      p.pivot_on = :sales
+    end
+    p.generate
+
+...which will give you a hash that looks like this...
+
+    {
+      :headers => ['', 'Q1', 'Q2', 'Q3', 'Q4', 'Total'],
+      :rows => [
+        ['London',  100, 200, 300, 400, 1000],
+        ['New York', 10,  20,  30,  40, 100]
+      ],
+      :totals => ['Total', 110, 220, 330, 440, 1100]
+    }
+
+...which makes it easy-peasy to print a pivot table that looks like this...
+
+               Q1    Q2    Q3    Q4   Total
+    London    100   200   300   400    1000
+    New York   10    20    30    40     100
+    Total     110   220   330   440    1100
+
+Ah, that's better.
+
+Still to come
+-------------
+
+PivotTable is still in the very early stages of development. As my personal needs for evolve, I'll update the gem with new functionality accordingly.
+Feel free to fork and/or suggest new features.
+
+Contributing to PivotTable
+---------------------
+
+If you want to contribute:
+
+* Check out the latest master to make sure the feature hasn’t been implemented or the bug hasn’t been fixed yet
+* Check out the issue tracker to make sure someone already hasn’t requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don’t break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history.
+
+Copyright
+---------
+
+Copyright (c) 2011 Ed James. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+Bundler::GemHelper.install_tasks

data/lib/pivot_table.rb

@@ -0,0 +1,6 @@
+$: << File.dirname(__FILE__)
+require "pivot_table/table"
+
+module PivotTable
+  VERSION = "0.0.3"
+end

data/lib/pivot_table/table.rb

@@ -0,0 +1,73 @@
+module PivotTable
+  class Table
+
+    attr_accessor :data, :column, :row, :pivot_on
+
+    def initialize(&block)
+      yield(self) if block_given?
+    end
+
+    def column_headers
+      @data.collect { |c| c.send @column }.uniq.sort
+    end
+
+    def row_headers
+      @data.collect { |r| r.send @row }.uniq.sort
+    end
+
+    def initialize_grid(rows, columns, default_value = 0)
+      @grid = []
+      rows.times do
+        @grid << columns.times.inject([]) { |col| col << default_value }
+      end
+      @grid
+    end
+
+    def matching_data(row_header, column_header)
+      data.select { |item| item.send(@row) == row_header && item.send(@column) == column_header }
+    end
+
+    def populate_grid
+      row_headers.each_with_index do |row_header, row_index|
+        column_headers.each_with_index do |column_header, column_index|
+          collected                      = matching_data row_header, column_header
+          total                          = collected.inject(0) { |sum, item| sum += item.send(@pivot_on) }
+          @grid[row_index][column_index] += total
+        end
+      end
+      @grid
+    end
+
+    def row_sum row
+      row.inject(0) { |sum, value| sum += value }
+    end
+
+    def calculate_row_totals
+      @grid.each { |row| row << row_sum(row) }
+    end
+
+    def add_row_headers
+      @grid.each_with_index do |row, index|
+        row.unshift row_headers[index]
+      end
+    end
+
+    def calculate_column_totals data
+      numeric_data = data.dup
+      numeric_data.transpose.map { |row| row_sum row }
+    end
+
+    def generate
+      initialize_grid row_headers.size, column_headers.size, 0
+      populate_grid
+      calculate_row_totals
+      totals = calculate_column_totals @grid
+
+      {
+          :headers => ['', column_headers, 'Total'].flatten,
+          :rows    => add_row_headers,
+          :totals  => ['Total', totals].flatten
+      }
+    end
+  end
+end

data/pivot_table.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/pivot_table', __FILE__)
+require 'base64'
+
+Gem::Specification.new do |s|
+  s.name        = "pivot_table"
+  s.version     = PivotTable::VERSION
+  s.authors     = ["Ed James"]
+  s.email       = Base64.decode64("ZWQuamFtZXMuZW1haWxAZ21haWwuY29t\n")
+  s.homepage    = "https://github.com/edjames/pivot_table"
+  s.summary     = "pivot_table-#{s.version}"
+  s.description = "Transform an ActiveRecord-ish data set into pivot table"
+
+  s.platform    = Gem::Platform::RUBY
+  
+  s.rubyforge_project = "pivot_table"
+  s.rubygems_version = ">= 1.6.1"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/pivot_table/table_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+
+module PivotTable
+  describe Table do
+    context 'accessors' do
+      subject { Table.new }
+      it { should respond_to :data }
+      it { should respond_to :column }
+      it { should respond_to :row }
+      it { should respond_to :pivot_on }
+    end
+
+    context 'instantiate using explicit block form' do
+      subject do
+        Table.new do |i|
+          i.data     = :data
+          i.column   = :column
+          i.row      = :row
+          i.pivot_on = :pivot_on
+        end
+      end
+
+      specify { subject.data.should == :data }
+      specify { subject.column.should == :column }
+      specify { subject.row.should == :row }
+      specify { subject.pivot_on.should == :pivot_on }
+    end
+
+    before do
+      @data = []
+      @data << OpenStruct.new(:city => 'London', :quarter => 'Q1', :sales => 100)
+      @data << OpenStruct.new(:city => 'London', :quarter => 'Q2', :sales => 200)
+      @data << OpenStruct.new(:city => 'London', :quarter => 'Q3', :sales => 300)
+      @data << OpenStruct.new(:city => 'London', :quarter => 'Q4', :sales => 400)
+      @data << OpenStruct.new(:city => 'Cape Town', :quarter => 'Q1', :sales => 5)
+      @data << OpenStruct.new(:city => 'Cape Town', :quarter => 'Q1', :sales => 15)
+      @data << OpenStruct.new(:city => 'Cape Town', :quarter => 'Q1', :sales => 30)
+      @data << OpenStruct.new(:city => 'New York', :quarter => 'Q1', :sales => 10)
+      @data << OpenStruct.new(:city => 'New York', :quarter => 'Q2', :sales => 20)
+      @data << OpenStruct.new(:city => 'New York', :quarter => 'Q3', :sales => 30)
+      @data << OpenStruct.new(:city => 'New York', :quarter => 'Q4', :sales => 10)
+      @data << OpenStruct.new(:city => 'New York', :quarter => 'Q4', :sales => 30)
+      @instance = Table.new do |i|
+        i.data     = @data
+        i.column   = :quarter
+        i.row      = :city
+        i.pivot_on = :sales
+      end
+    end
+
+    subject { @instance }
+
+    context 'column headers' do
+      subject { @instance.column_headers }
+      it { should == ['Q1', 'Q2', 'Q3', 'Q4'] }
+    end
+
+    context 'row headers' do
+      subject { @instance.row_headers }
+      it { should == ['Cape Town', 'London', 'New York'] }
+    end
+
+    context 'initializing the grid' do
+      before do
+        @expected_result = [
+            [0, 0, 0],
+            [0, 0, 0]
+        ]
+      end
+      subject { @instance.initialize_grid 2, 3, 0 }
+      it { should == @expected_result }
+    end
+
+    context 'matching data' do
+      context 'single matching data item' do
+        subject { @instance.matching_data 'London', 'Q1' }
+        specify { subject.size.should == 1 }
+        specify { subject.first.should == @data.first }
+      end
+
+      context 'multiple matching data items' do
+        subject { @instance.matching_data 'Cape Town', 'Q1' }
+        specify { subject.size.should == 3 }
+        specify { subject[0].should == @data[4] }
+        specify { subject[1].should == @data[5] }
+        specify { subject[2].should == @data[6] }
+      end
+    end
+
+    context 'aggregating the data in the grid' do
+      before do
+        @instance.initialize_grid 3, 4, 0
+        @expected_result = [
+            [50, 0, 0, 0],
+            [100, 200, 300, 400],
+            [10, 20, 30, 40]
+        ]
+      end
+      subject { @instance.populate_grid }
+      it { should == @expected_result }
+    end
+
+    context 'generate' do
+      before do
+        @expected_result = {
+            :headers => ['', 'Q1', 'Q2', 'Q3', 'Q4', 'Total'],
+            :rows    => [
+                ['Cape Town', 50, 0, 0, 0, 50],
+                ['London', 100, 200, 300, 400, 1000],
+                ['New York', 10, 20, 30, 40, 100]
+            ],
+            :totals  => ['Total', 160, 220, 330, 440, 1150]
+        }
+      end
+      subject { @instance.generate }
+      it { should == @expected_result }
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rubygems'
+require 'rspec'
+require 'pivot_table'
+require 'ostruct'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: pivot_table
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Ed James
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-29 00:00:00.000000000Z
+dependencies: []
+description: Transform an ActiveRecord-ish data set into pivot table
+email: ed.james.email@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/pivot_table.rb
+- lib/pivot_table/table.rb
+- pivot_table.gemspec
+- spec/pivot_table/table_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/edjames/pivot_table
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: pivot_table
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: pivot_table-0.0.3
+test_files: []