table_fu 0.1.1

data/spec/table_fu_spec.rb

@@ -0,0 +1,221 @@
+require 'spec'
+require 'spec/spec_helper'
+require 'fastercsv'
+
+
+describe TableFu do
+
+  before :all do
+    csv = FasterCSV.parse(File.open('spec/assets/test.csv'))
+    @spreadsheet = TableFu.new(csv, :style => {'URL' => 'text-align: left;'})
+  end
+
+  it 'should give me back a Row object' do
+    @spreadsheet.rows.each do |r|
+      r.class.should eql TableFu::Row
+    end
+  end
+
+  it 'should give me back a column by it\'s header name' do
+    @spreadsheet.rows[0].column_for("State").to_s.should == "Alabama"
+  end
+  
+  it 'should sort rows' do
+    @spreadsheet.sorted_by = {'State' => {"order" => 'descending'}}
+    @spreadsheet.rows[0].column_for("State").to_s.should eql "Wyoming"
+    @spreadsheet.sorted_by = {'Party' => {"order" => 'descending'}}
+    @spreadsheet.rows[0].column_for("Party").to_s.should eql "Republican"
+    @spreadsheet.sorted_by = {'Representative' => {"order" => 'ascending', "format" => 'last_name'}}
+    @spreadsheet.rows[2].column_for("Representative").to_s.should eql "Jo Bonner"
+
+    
+    @spreadsheet.col_opts[:columns] = {'State', 'Party', 'Total Appropriations', 'URL'}
+    @spreadsheet.rows.each do |row|
+      row.columns.each do |column|
+        if column.column_name == 'URL'
+          column.style.should eql 'text-align: left;'
+          column.to_s.should eql ''
+          column.value.should be_nil
+        end
+        column.style.should_not be_nil
+      end
+    end
+    
+  end
+  
+  it 'should sort rows with numerals' do
+    @spreadsheet.sorted_by = {'Projects' => {"order" => 'ascending'}}
+    sorted = @spreadsheet.rows.map do |row|
+      row.column_for("Projects").value
+    end
+    sorted.should eql [4, 5, 10, 12, 20, 49, nil]
+  end
+  
+  it 'should be able to contain only the rows I want, after sorting' do
+    @spreadsheet.sorted_by = {'State' => {"order" => 'ascending'}}
+    @spreadsheet.only!(1..2)
+    @spreadsheet.rows[0].column_for('State').to_s.should eql 'Arizona'
+    @spreadsheet.rows[1].column_for('State').to_s.should eql 'California'
+    @spreadsheet.deleted_rows.length.should eql 5
+    @spreadsheet.rows.length.should eql 2
+  end
+end
+
+describe TableFu, 'with a complicated setup' do
+
+  before :all do
+    csv = FasterCSV.parse(File.open('spec/assets/test.csv'))
+    @spreadsheet = TableFu.new(csv)
+    @spreadsheet.col_opts[:formatting] = {'Total Appropriation' => :currency, 
+                                          "Representative" => :last_name_first_name}
+    @spreadsheet.col_opts[:style] = {'Leadership' => "text-align: left;", 'URL' => 'text-align: right;'}
+    @spreadsheet.col_opts[:invisible] = ['URL']
+    @spreadsheet.delete_rows! [8]
+    @spreadsheet.sorted_by = {'State' => {"order" => 'descending'}}
+    @spreadsheet.col_opts[:columns] = ['State', 'Leadership', 'Total Appropriation', 'Party', 'URL']
+  end
+
+  it 'Leadership column should be marked invisible' do
+    @spreadsheet.rows[0].column_for('URL').invisible?.should be_true
+    @spreadsheet.rows[0].column_for('State').invisible?.should be_false
+  end
+
+  it 'should give me back a Row object' do
+    @spreadsheet.rows.each do |r|
+      r.class.should eql TableFu::Row
+    end
+  end
+
+  it 'should give me back a 7 rows because it ignored row 476 and header' do
+    @spreadsheet.rows.size.should eql 7
+  end
+
+  it 'should give me back a column by it\'s header name' do
+    @spreadsheet.rows[3].column_for('State').to_s.should eql "Georgia"
+    @spreadsheet.rows[2].column_for('State').to_s.should eql "New Jersey"
+    @spreadsheet.rows[0].column_for('State').to_s.should eql "Wyoming"
+  end
+  
+  it 'should total a column' do
+    @spreadsheet.total_for("Total Appropriation").value.should eql 16640189309
+    @spreadsheet.total_for("Total Appropriation").to_s.should eql "$16,640,189,309"
+  end
+
+  it 'should format a column' do
+    @spreadsheet.rows[0].column_for("Total Appropriation").to_s.should eql "$138,526,141"
+    @spreadsheet.rows[0].column_for("Total Appropriation").value.should eql 138526141
+    @spreadsheet.rows[4].column_for("Representative").to_s.should eql "Nunes, Devin"
+  end
+  
+  it 'should format a header' do
+    @spreadsheet.headers[1].style.should eql 'text-align: left;'
+    @spreadsheet.headers[4].style.should eql 'text-align: right;'
+  end
+  
+  it 'should not care what kind of keys the hash has' do
+    @spreadsheet = TableFu.new(File.open('spec/assets/test.csv'))
+    @spreadsheet.col_opts["style"] = {'Leadership' => "text-align: left;", 'URL' => 'text-align: right;'}
+
+    @spreadsheet.rows[0].column_for('Leadership').style.should ==
+                          @spreadsheet.col_opts["style"]['Leadership']
+  end
+  
+
+
+end
+
+
+describe TableFu, "with faceting" do
+
+  before :all do
+    csv = FasterCSV.parse(File.open('spec/assets/test.csv'))
+    @spreadsheet = TableFu.new(csv)
+    @spreadsheet.col_opts[:style] = {'Projects' => 'text-align:left;'}
+    @spreadsheet.col_opts[:formatting] = {'Total Appropriation' => :currency}
+    @spreadsheet.delete_rows! [8]
+    @spreadsheet.sorted_by = {'State' => {:order => 'ascending'}}
+    @faceted_spreadsheets = @spreadsheet.faceted_by("Party", :total => ['Projects', 'Total Appropriation'])
+  end
+
+  it "should have 2 facets" do
+    @faceted_spreadsheets.size.should == 2
+  end
+
+  it "should total up the projects and expenses" do
+    @faceted_spreadsheets[1].total_for("Projects").value.should eql 63
+    @faceted_spreadsheets[0].total_for("Projects").value.should eql 32
+    @faceted_spreadsheets[1].total_for("State").value.should eql 3
+    @faceted_spreadsheets[1].total_for("Total Appropriation").value.should eql 175142465
+  end
+
+  it "should keep formatting on totals" do
+    @faceted_spreadsheets[1].total_for("Total Appropriation").to_s.should eql "$175,142,465"
+  end
+
+  it "should remember what facet it belongs to" do
+    @faceted_spreadsheets[1].faceted?.should be_true
+    @faceted_spreadsheets[0].faceted_on.should == 'Democrat'
+  end
+
+  it "should keep the formatting" do
+    
+    @faceted_spreadsheets[1].rows[1].column_for('Total Appropriation').to_s.should eql "$25,320,127"
+    @faceted_spreadsheets[1].rows[1].column_for('Projects').style.should eql "text-align:left;"
+  end
+
+
+end
+
+describe TableFu, 'with macro columns' do
+
+  class TableFu::Formatting
+   
+    class<<self
+
+      def append(first, second)
+        "#{first}#{second}"
+      end
+      
+    end
+    
+  end
+
+
+  before :all do
+    csv = FasterCSV.parse(File.open('spec/assets/test_macro.csv').read)
+    @spreadsheet = TableFu.new(csv)
+    @spreadsheet.col_opts[:style] = {'Projects' => 'text-align:left;'}
+    @spreadsheet.col_opts[:formatting] = {'Total Appropriation' => :currency,
+                                          'MacroColumn' => {'method' => 'append', 'arguments' => ['Projects','State']}}
+    @spreadsheet.sorted_by = {'State' => {:order => 'ascending'}}
+    @spreadsheet.col_opts[:columns] = ['State', 'Total Appropriation', 'MacroColumn']
+  end
+
+
+  it "should let us specify a macro for a column" do
+    @spreadsheet.rows[0].column_for('MacroColumn').to_s.should eql '10Alabama'
+  end
+
+end
+
+describe TableFu, 'with reordered columns' do
+
+  before :all do
+    csv = FasterCSV.parse(File.open('spec/assets/test.csv'))
+    @spreadsheet = TableFu.new(csv)
+    @spreadsheet.col_opts[:style] = {'Projects' => 'text-align:left;'}
+    @spreadsheet.col_opts[:formatting] = {'Total Appropriation' => :currency}
+    @spreadsheet.col_opts[:sorted_by] = {'State' => {:order => 'ascending'}}
+  end
+
+
+  it "should display columns in the correct order" do
+    @spreadsheet.col_opts[:columns] = ['State', 'Blah', 'Projects']
+    @spreadsheet.column_headers.size.should eql 7
+    @spreadsheet.columns.size.should eql 3
+    facets  = @spreadsheet.faceted_by('State')
+    @spreadsheet.rows[0].column_for('Blah').to_s.should eql ''
+    @spreadsheet.rows[0].column_for('Projects').to_s.should eql '10'
+  end
+
+end

data/table_fu.gemspec

@@ -0,0 +1,112 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{table_fu}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mark Percival", "Jeff Larson"]
+  s.date = %q{2010-03-10}
+  s.description = %q{A library for manipulating tables as arrays}
+  s.email = %q{jeff.larson@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README",
+     "Rakefile",
+     "VERSION.yml",
+     "doc/TableFu.html",
+     "doc/TableFu/Datum.html",
+     "doc/TableFu/Formatting.html",
+     "doc/TableFu/Header.html",
+     "doc/TableFu/Row.html",
+     "doc/_index.html",
+     "doc/class_list.html",
+     "doc/css/common.css",
+     "doc/css/full_list.css",
+     "doc/css/style.css",
+     "doc/file.README.html",
+     "doc/file_list.html",
+     "doc/frames.html",
+     "doc/index.html",
+     "doc/js/app.js",
+     "doc/js/full_list.js",
+     "doc/js/jquery.js",
+     "doc/method_list.html",
+     "doc/top-level-namespace.html",
+     "documentation/css/dawn.css",
+     "documentation/css/styles.css",
+     "documentation/images/proplogo.png",
+     "documentation/index.html.erb",
+     "examples/columns.rb",
+     "examples/columns_hidden.rb",
+     "examples/faceting.rb",
+     "examples/formatting_options.rb",
+     "examples/last_name.rb",
+     "examples/link.rb",
+     "examples/only.rb",
+     "examples/rails_helpers.rb",
+     "examples/sort_by_column.rb",
+     "examples/sort_by_number.rb",
+     "examples/totals.rb",
+     "examples/zap_joyce.rb",
+     "index.html",
+     "lib/table_fu.rb",
+     "lib/table_fu/formatting.rb",
+     "spec/assets/sample.csv",
+     "spec/assets/test.csv",
+     "spec/assets/test_macro.csv",
+     "spec/rcov.opts",
+     "spec/readme_example_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/table_fu_spec.rb",
+     "table_fu.gemspec"
+  ]
+  s.homepage = %q{http://github.com/propublica/table_fu}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{TableFu makes arrays act like spreadsheets}
+  s.test_files = [
+    "spec/readme_example_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/table_fu_spec.rb",
+     "examples/columns.rb",
+     "examples/columns_hidden.rb",
+     "examples/faceting.rb",
+     "examples/formatting_options.rb",
+     "examples/last_name.rb",
+     "examples/link.rb",
+     "examples/only.rb",
+     "examples/rails_helpers.rb",
+     "examples/sort_by_column.rb",
+     "examples/sort_by_number.rb",
+     "examples/totals.rb",
+     "examples/zap_joyce.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<fastercsv>, [">= 0"])
+      s.add_development_dependency(%q<spec>, [">= 0"])
+    else
+      s.add_dependency(%q<fastercsv>, [">= 0"])
+      s.add_dependency(%q<spec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<fastercsv>, [">= 0"])
+    s.add_dependency(%q<spec>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification 
+name: table_fu
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Mark Percival
+- Jeff Larson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-10 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: fastercsv
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: spec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A library for manipulating tables as arrays
+email: jeff.larson@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+files: 
+- .gitignore
+- LICENSE
+- README
+- Rakefile
+- VERSION.yml
+- doc/TableFu.html
+- doc/TableFu/Datum.html
+- doc/TableFu/Formatting.html
+- doc/TableFu/Header.html
+- doc/TableFu/Row.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
+- documentation/css/dawn.css
+- documentation/css/styles.css
+- documentation/images/proplogo.png
+- documentation/index.html.erb
+- examples/columns.rb
+- examples/columns_hidden.rb
+- examples/faceting.rb
+- examples/formatting_options.rb
+- examples/last_name.rb
+- examples/link.rb
+- examples/only.rb
+- examples/rails_helpers.rb
+- examples/sort_by_column.rb
+- examples/sort_by_number.rb
+- examples/totals.rb
+- examples/zap_joyce.rb
+- index.html
+- lib/table_fu.rb
+- lib/table_fu/formatting.rb
+- spec/assets/sample.csv
+- spec/assets/test.csv
+- spec/assets/test_macro.csv
+- spec/rcov.opts
+- spec/readme_example_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/table_fu_spec.rb
+- table_fu.gemspec
+has_rdoc: true
+homepage: http://github.com/propublica/table_fu
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: TableFu makes arrays act like spreadsheets
+test_files: 
+- spec/readme_example_spec.rb
+- spec/spec_helper.rb
+- spec/table_fu_spec.rb
+- examples/columns.rb
+- examples/columns_hidden.rb
+- examples/faceting.rb
+- examples/formatting_options.rb
+- examples/last_name.rb
+- examples/link.rb
+- examples/only.rb
+- examples/rails_helpers.rb
+- examples/sort_by_column.rb
+- examples/sort_by_number.rb
+- examples/totals.rb
+- examples/zap_joyce.rb