pivot_table 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8b35be064e1f9bfb58e308e4b702c61e5b1621f
-  data.tar.gz: f02b0339418df01e332c6cd2743e1fcd137ec6fa
+  metadata.gz: 2684137254bb56ddbe7d1f32a2d505494170d38c
+  data.tar.gz: 1d3d224b88c1df7c8980196e463ff6788f42cddd
 SHA512:
-  metadata.gz: 3b1630a683b93dd84c7e7687e2c52e49a43272dc81256654ebd51033cc4b0eff8b17669f43ee866e8ab7f3fc1a874e90ddd42e938e84ed0330fa7167a55eb963
-  data.tar.gz: 18bb1571676d2a33a4ba1ac48fe7780ffa1a02015ac1479f4057862478eb9f6837656a3dfa80838cf64bb131a73c84bbff6091a057a536743e9f8380e4ef9a86
+  metadata.gz: e57ccdddfff53cff46227a1cce75f9640376cd08feff730a773e44f1316937609a0c9e2a5a217d804a7ca18db291901e7c6a3c736c469e4ed6acb70a618118d1
+  data.tar.gz: 315f28559f9ccf3d9f1addfcb5fa5e4ba58125c950a42c5c0b9cdeca575d62cae7a6341fa56790c1151ba64ddaa6a34adcf67de077e743400a9663f018867df0

data/.gitignore

@@ -3,3 +3,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+tmp

data/README.md

@@ -1,5 +1,4 @@
-# Pivot Table  [![Build Status](https://secure.travis-ci.org/edjames/pivot_table.png)](http://travis-ci.org/edjames/pivot_table) [![Code Climate](https://codeclimate.com/github/edjames/pivot_table.png)](https://codeclimate.com/github/edjames/pivot_table)
-
+# Pivot Table  [![Build Status](https://secure.travis-ci.org/edjames/pivot_table.png)](http://travis-ci.org/edjames/pivot_table) [![Code Climate](https://codeclimate.com/github/edjames/pivot_table.png)](https://codeclimate.com/github/edjames/pivot_table) [![Dependency Status](https://gemnasium.com/edjames/pivot_table.png)](https://gemnasium.com/edjames/pivot_table)
 
 A handy tool for transforming a dataset into a spreadsheet-style pivot table.
 
@@ -103,15 +102,35 @@ If you want to get the totals for rows, columns, or the entire grid, you can pas
     g.rows[1].total
     g.grand_total
 
+#### Configuration Options
+
+You can also provide additional configuration options when instantiating your Grid. Options are provided as a hash e.g.
+
+    grid = PivotTable::Grid.new(:sort => true) do |g|
+      g.source_data  = data
+      g.column_name  = :quarter
+      g.row_name     = :city
+      g.value_name   = :sales
+    end
+
+Here are the available configuration options:
+
+###### 1. Sort
+
+**Usage:** `:sort => false`
+
+**Default:** `true`
+
+This option will automatically sort your data alphabetically based on your column and row headers. If you disable sorting your original data ordering will be preserved.
+
 
 ### Ruby Support
-----------------
 
 * 1.9.3
 * 2.0.0
+* 2.1.0
 
-Contributing to PivotTable
----------------------
+### Contributing to PivotTable
 
 If you want to contribute:
 
@@ -123,7 +142,6 @@ If you want to contribute:
 * 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
 
-Copyright (c) 2013 Ed James. See LICENSE for details.
+Copyright (c) 2014 Ed James. See LICENSE for details.

data/lib/pivot_table.rb

@@ -1,10 +1,11 @@
 $: << File.dirname(__FILE__)
 
-require "pivot_table/grid"
-require "pivot_table/cell_collection"
-require "pivot_table/column"
-require "pivot_table/row"
+require 'pivot_table/configuration'
+require 'pivot_table/grid'
+require 'pivot_table/cell_collection'
+require 'pivot_table/column'
+require 'pivot_table/row'
 
 module PivotTable
-  VERSION = "0.1.4"
+  VERSION = '0.2.0'
 end

data/lib/pivot_table/configuration.rb

@@ -0,0 +1,13 @@
+module PivotTable
+  class Configuration
+
+    def initialize(opts = {})
+      @opts = opts
+    end
+
+    def method_missing(method_name, *arguments, &block)
+      @opts[method_name]
+    end
+
+  end
+end

data/lib/pivot_table/grid.rb

@@ -2,10 +2,15 @@ module PivotTable
   class Grid
 
     attr_accessor :source_data, :row_name, :column_name, :value_name
-    attr_reader :columns, :rows, :data_grid
+    attr_reader :columns, :rows, :data_grid, :configuration
 
-    def initialize(&block)
+    DEFAULT_OPTIONS = {
+      :sort => true
+    }
+
+    def initialize(opts = {}, &block)
       yield(self) if block_given?
+      @configuration = Configuration.new(DEFAULT_OPTIONS.merge(opts))
     end
 
     def build
@@ -80,7 +85,8 @@ module PivotTable
     private
 
     def headers(method)
-      @source_data.collect { |c| c.send method }.uniq.sort
+      hdrs = @source_data.collect { |c| c.send method }.uniq
+      configuration.sort ? hdrs.sort : hdrs
     end
 
   end

data/pivot_table.gemspec

@@ -23,5 +23,5 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "rspec", "~> 2.14"
   s.add_development_dependency "growl", "~> 1.0"
-  s.add_development_dependency "guard-rspec", "~> 4.0"
+  s.add_development_dependency "guard-rspec", "~> 4.2"
 end

data/spec/pivot_table/configuration_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+module PivotTable
+  describe Configuration do
+
+    subject { described_class.new opts }
+
+    let(:opts) { { :sort => true, :other_setting => 'on' } }
+
+    its(:sort) { should be_true }
+    its(:other_setting) { should == 'on' }
+
+    context 'when setting does not exist' do
+      its(:i_do_not_exist) { should be_nil }
+    end
+
+  end
+end

data/spec/pivot_table/grid_spec.rb

@@ -2,41 +2,8 @@ require 'spec_helper'
 
 module PivotTable
   describe Grid do
-    def build_object(id, row, column)
-      OpenStruct.new id: id, row_name: row, column_name: column
-    end
-
-    let(:d1) { build_object(1, 'r1', 'c1') }
-    let(:d2) { build_object(2, 'r1', 'c2') }
-    let(:d3) { build_object(3, 'r1', 'c3') }
-    let(:d4) { build_object(4, 'r2', 'c1') }
-    let(:d5) { build_object(5, 'r2', 'c2') }
-    let(:d6) { build_object(6, 'r2', 'c3') }
-
-    let(:data) { [d1, d2, d3, d4, d5, d6] }
-
-    let(:column_headers) { %w(c1 c2 c3) }
-    let(:row_headers) { %w(r1 r2) }
-    let(:row_0) { [d1, d2, d3] }
-    let(:row_1) { [d4, d5, d6] }
-    let(:column_0) { [d1, d4] }
-    let(:column_1) { [d2, d5] }
-    let(:column_2) { [d3, d6] }
-    let(:column_totals) { [d1.id + d4.id, d2.id + d5.id, d3.id + d6.id] }
-    let(:row_totals) { [d1.id + d2.id + d3.id, d4.id + d5.id + d6.id] }
-    let(:grand_total) { d1.id + d2.id + d3.id + d4.id + d5.id + d6.id }
-
-    let(:instance) do
-      Grid.new do |g|
-        g.source_data = data
-        g.row_name    = :row_name
-        g.column_name = :column_name
-        g.value_name  = :id
-      end
-    end
 
     context 'accessors' do
-      subject { Grid.new }
       it { should respond_to :source_data }
       it { should respond_to :row_name }
       it { should respond_to :column_name }
@@ -45,85 +12,83 @@ module PivotTable
       it { should respond_to :grand_total }
     end
 
-    describe 'build' do
-      subject { instance.build }
-      its(:class) { should == Grid }
-    end
-
-    describe 'columns' do
-      let(:build_result) { instance.build }
-      specify { build_result.columns.length.should == 3 }
-
-      context 'column headers' do
-        subject { build_result.column_headers }
-        it { should == column_headers }
-      end
-
-      context '1st column' do
-        subject { build_result.columns[0] }
-        its(:header) { should == column_headers[0] }
-        its(:data) { should == column_0 }
-        its(:total) { should == column_totals[0] }
-      end
+    let(:d1) { build_data_object(1, 'r1', 'c1') }
+    let(:d2) { build_data_object(2, 'r1', 'c2') }
+    let(:d3) { build_data_object(3, 'r1', 'c3') }
+    let(:d4) { build_data_object(4, 'r2', 'c1') }
+    let(:d5) { build_data_object(5, 'r2', 'c2') }
+    let(:d6) { build_data_object(6, 'r2', 'c3') }
 
-      context '2nd column' do
-        subject { build_result.columns[1] }
-        its(:header) { should == column_headers[1] }
-        its(:data) { should == column_1 }
-        its(:total) { should == column_totals[1] }
-      end
+    let(:sorted_data) { [d1, d2, d3, d4, d5, d6] }
+    let(:unsorted_data) { [d6, d4, d5, d3, d2, d1] }
 
-      context '3rd column' do
-        subject { build_result.columns[2] }
-        its(:header) { should == column_headers[2] }
-        its(:data) { should == column_2 }
-        its(:total) { should == column_totals[2] }
+    let(:instance) do
+      described_class.new(config) do |g|
+        g.source_data = data
+        g.row_name    = :row_name
+        g.column_name = :column_name
+        g.value_name  = :id
       end
     end
 
-    describe 'rows' do
-      let(:build_result) { instance.build }
-      specify { build_result.rows.length.should == 2 }
-
-      context 'row headers' do
-        subject { build_result.row_headers }
-        it { should == row_headers }
-      end
-
-      context '1st row' do
-        subject { build_result.rows[0] }
-        its(:header) { should == row_headers[0] }
-        its(:data) { should == row_0 }
-        its(:total) { should == row_totals[0] }
-      end
-
-      context '2nd row' do
-        subject { build_result.rows[1] }
-        its(:header) { should == row_headers[1] }
-        its(:data) { should == row_1 }
-        its(:total) { should == row_totals[1] }
-      end
+    context 'when data is already sorted' do
+      let(:config) { {} }
+      let(:data) { sorted_data }
+
+      let(:column_headers) { %w(c1 c2 c3) }
+      let(:row_headers) { %w(r1 r2) }
+      let(:row_0) { [d1, d2, d3] }
+      let(:row_1) { [d4, d5, d6] }
+      let(:column_0) { [d1, d4] }
+      let(:column_1) { [d2, d5] }
+      let(:column_2) { [d3, d6] }
+      let(:column_totals) { [d1.id + d4.id, d2.id + d5.id, d3.id + d6.id] }
+      let(:row_totals) { [d1.id + d2.id + d3.id, d4.id + d5.id + d6.id] }
+      let(:grand_total) { d1.id + d2.id + d3.id + d4.id + d5.id + d6.id }
+
+      it_behaves_like 'a collection of columns'
+      it_behaves_like 'a collection of rows'
+      it_behaves_like 'a data grid'
     end
 
-    describe 'data grid' do
-      let(:build_result) { instance.build }
-
-      context 'preparing the grid' do
-        subject { build_result.prepare_grid }
-        it { should == [[nil, nil, nil], [nil, nil, nil]] }
-      end
-
-      context 'populating the grid' do
-        subject { build_result.data_grid }
-        it { should == [[d1, d2, d3], [d4, d5, d6]] }
-      end
+    context 'sorting unordered data' do
+      let(:config) { { :sort => true } }
+      let(:data) { unsorted_data }
+
+      let(:column_headers) { %w(c1 c2 c3) }
+      let(:row_headers) { %w(r1 r2) }
+      let(:row_0) { [d1, d2, d3] }
+      let(:row_1) { [d4, d5, d6] }
+      let(:column_0) { [d1, d4] }
+      let(:column_1) { [d2, d5] }
+      let(:column_2) { [d3, d6] }
+      let(:column_totals) { [d1.id + d4.id, d2.id + d5.id, d3.id + d6.id] }
+      let(:row_totals) { [d1.id + d2.id + d3.id, d4.id + d5.id + d6.id] }
+      let(:grand_total) { d1.id + d2.id + d3.id + d4.id + d5.id + d6.id }
+
+      it_behaves_like 'a collection of columns'
+      it_behaves_like 'a collection of rows'
+      it_behaves_like 'a data grid'
+    end
 
-      context 'totals' do
-        subject { build_result }
-        its(:column_totals) { should == column_totals }
-        its(:row_totals) { should == row_totals }
-        its(:grand_total) { should == grand_total }
-      end
+    context 'keep original data ordering' do
+      let(:config) { { :sort => false } }
+      let(:data) { unsorted_data }
+
+      let(:column_headers) { %w(c3 c1 c2) }
+      let(:row_headers) { %w(r2 r1) }
+      let(:row_0) { [d6, d4, d5] }
+      let(:row_1) { [d3, d1, d2] }
+      let(:column_0) { [d6, d3] }
+      let(:column_1) { [d4, d1] }
+      let(:column_2) { [d5, d2] }
+      let(:column_totals) { [d6.id + d3.id, d4.id + d1.id, d5.id + d2.id] }
+      let(:row_totals) { [d6.id + d4.id + d5.id, d3.id + d2.id + d1.id] }
+      let(:grand_total) { d1.id + d2.id + d3.id + d4.id + d5.id + d6.id }
+
+      it_behaves_like 'a collection of columns'
+      it_behaves_like 'a collection of rows'
+      it_behaves_like 'a data grid'
     end
   end
 end

data/spec/spec_helper.rb

@@ -11,4 +11,6 @@ Dir["./spec/support/**/*.rb"].each {|f| require f}
 
 RSpec.configure do |config|
 
+  config.include Helpers
+
 end

data/spec/support/helpers.rb

@@ -0,0 +1,7 @@
+module Helpers
+
+  def build_data_object(id, row, column)
+    OpenStruct.new id: id, row_name: row, column_name: column
+  end
+
+end

data/spec/support/{shared_examples.rb → shared_examples_for_a_cell_collection_.rb}

@@ -1,5 +1,4 @@
 shared_examples "a cell collection" do
-
   it { should respond_to :header }
   it { should respond_to :data }
   it { should respond_to :value_name }
@@ -16,5 +15,4 @@ shared_examples "a cell collection" do
     its(:data) { should == attrs[:data] }
     its(:value_name) { should == attrs[:value_name] }
   end
-
 end

data/spec/support/shared_examples_for_a_collection_of_columns.rb

@@ -0,0 +1,30 @@
+shared_examples 'a collection of columns' do
+  let(:build_result) { instance.build }
+  specify { build_result.columns.length.should == 3 }
+
+  context 'column headers' do
+    subject { build_result.column_headers }
+    it { should == column_headers }
+  end
+
+  context '1st column' do
+    subject { build_result.columns[0] }
+    its(:header) { should == column_headers[0] }
+    its(:data) { should == column_0 }
+    its(:total) { should == column_totals[0] }
+  end
+
+  context '2nd column' do
+    subject { build_result.columns[1] }
+    its(:header) { should == column_headers[1] }
+    its(:data) { should == column_1 }
+    its(:total) { should == column_totals[1] }
+  end
+
+  context '3rd column' do
+    subject { build_result.columns[2] }
+    its(:header) { should == column_headers[2] }
+    its(:data) { should == column_2 }
+    its(:total) { should == column_totals[2] }
+  end
+end

data/spec/support/shared_examples_for_a_collection_of_rows.rb

@@ -0,0 +1,23 @@
+shared_examples 'a collection of rows' do
+  let(:build_result) { instance.build }
+  specify { build_result.rows.length.should == 2 }
+
+  context 'row headers' do
+    subject { build_result.row_headers }
+    it { should == row_headers }
+  end
+
+  context '1st row' do
+    subject { build_result.rows[0] }
+    its(:header) { should == row_headers[0] }
+    its(:data) { should == row_0 }
+    its(:total) { should == row_totals[0] }
+  end
+
+  context '2nd row' do
+    subject { build_result.rows[1] }
+    its(:header) { should == row_headers[1] }
+    its(:data) { should == row_1 }
+    its(:total) { should == row_totals[1] }
+  end
+end

data/spec/support/shared_examples_for_a_data_grid.rb

@@ -0,0 +1,20 @@
+shared_examples 'a data grid' do
+  let(:build_result) { instance.build }
+
+  context 'preparing the grid' do
+    subject { build_result.prepare_grid }
+    it { should == [[nil, nil, nil], [nil, nil, nil]] }
+  end
+
+  context 'populating the grid' do
+    subject { build_result.data_grid }
+    it { should == [row_0, row_1] }
+  end
+
+  context 'totals' do
+    subject { build_result }
+    its(:column_totals) { should == column_totals }
+    its(:row_totals) { should == row_totals }
+    its(:grand_total) { should == grand_total }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pivot_table
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Ed James
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-30 00:00:00.000000000 Z
+date: 2014-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
 description: Transform an ActiveRecord-ish data set into a pivot table of objects
 email: ed.james.email@gmail.com
 executables: []
@@ -70,14 +70,20 @@ files:
 - lib/pivot_table.rb
 - lib/pivot_table/cell_collection.rb
 - lib/pivot_table/column.rb
+- lib/pivot_table/configuration.rb
 - lib/pivot_table/grid.rb
 - lib/pivot_table/row.rb
 - pivot_table.gemspec
 - spec/pivot_table/column_spec.rb
+- spec/pivot_table/configuration_spec.rb
 - spec/pivot_table/grid_spec.rb
 - spec/pivot_table/row_spec.rb
 - spec/spec_helper.rb
-- spec/support/shared_examples.rb
+- spec/support/helpers.rb
+- spec/support/shared_examples_for_a_cell_collection_.rb
+- spec/support/shared_examples_for_a_collection_of_columns.rb
+- spec/support/shared_examples_for_a_collection_of_rows.rb
+- spec/support/shared_examples_for_a_data_grid.rb
 homepage: https://github.com/edjames/pivot_table
 licenses: []
 metadata: {}
@@ -97,13 +103,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: pivot_table
-rubygems_version: 2.0.3
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
-summary: pivot_table-0.1.4
+summary: pivot_table-0.2.0
 test_files:
 - spec/pivot_table/column_spec.rb
+- spec/pivot_table/configuration_spec.rb
 - spec/pivot_table/grid_spec.rb
 - spec/pivot_table/row_spec.rb
 - spec/spec_helper.rb
-- spec/support/shared_examples.rb
+- spec/support/helpers.rb
+- spec/support/shared_examples_for_a_cell_collection_.rb
+- spec/support/shared_examples_for_a_collection_of_columns.rb
+- spec/support/shared_examples_for_a_collection_of_rows.rb
+- spec/support/shared_examples_for_a_data_grid.rb