csv_report_generator 0.4.0

data/Manifest

@@ -0,0 +1,8 @@
+README.rdoc
+Rakefile
+example/example.rb
+lib/csv_report_generator.rb
+lib/csv_report_generator/csv_report_generator.rb
+test/test_helper.rb
+test/unit/csv_report_generator_test.rb
+Manifest

data/README.rdoc

@@ -0,0 +1,104 @@
+= CSVReportGenerator
+
+== Description
+
+Allows for simple csv generation of reports where you need to transform data
+
+== Installation
+
+    sudo gem install csv_report_generator
+
+== Requirements
+
+    fastercsv
+
+== Usage
+
+    headers = [{ :name => "Full Name" }, { :zip => "Zip Code" }, { :gender => "Gender" }, { :widget_count => "Widgets" }, { :comment => "Comments" }]
+    rows    = [ { :name => 'joe blow', :zip => 12345, :gender => 0, :widget_count => 3, :comment => "This, has a comma" },
+                { :name => 'jane doe', :zip => 56789, :gender => 1, :widget_count => 2, :comment => "\"This\" has quotes" },
+                { :name => 'jane doe', :zip => 56789, :gender => 1, :widget_count => 2, :comment => "Hello there" },
+                { :name => nil, :zip => nil, :gender => nil, :widget_count => 7, :comment => nil } ]
+
+    report = CSVReportGenerator.new(rows, headers, :includes_total => true) do |csv|
+      csv.row_transformer { |row|
+        row[:name].upcase!
+        row[:gender] = (row[:gender].to_i == 0 ? "Male" : "Female")
+        row[:comment] = row[:comment].tr "A-Za-z", "N-ZA-Mn-za-m" #rot13
+        row
+      }
+
+      csv.total_transformer { |row|
+       row[:name] = "TOTAL"
+       row
+      }
+    end
+
+    puts "with headers"
+    puts "============================"
+    puts report.as_csv
+
+    puts
+    puts "without headers"
+    puts "============================"
+    report.headers = nil
+    puts report.as_csv
+
+    report = CSVReportGenerator.new(rows, headers, :include_totals => true)
+
+    puts
+    puts "no transformations"
+    puts "============================"
+    puts report.as_csv
+    
+    
+    output:
+    
+    with headers
+    ============================
+    Full Name,Zip Code,Gender,Widgets,Comments
+    JOE BLOW,12345,Male,3,"Guvf, unf n pbzzn"
+    JANE DOE,56789,Female,2,"""Guvf"" unf dhbgrf"
+    JANE DOE,56789,Female,2,Uryyb gurer
+    TOTAL,,,7,
+
+    without headers
+    ============================
+    Male,3,12345,"This, has a comma",JOE BLOW
+    Male,2,56789,"""This"" has quotes",JANE DOE
+    Male,2,56789,Hello there,JANE DOE
+    ,7,,,TOTAL
+
+    no transformations
+    ============================
+    Full Name,Zip Code,Gender,Widgets,Comments
+    JOE BLOW,12345,Male,3,"This, has a comma"
+    JANE DOE,56789,Male,2,"""This"" has quotes"
+    JANE DOE,56789,Male,2,Hello there
+    TOTAL,,,7,
+    
+    
+== License
+
+Copyright (c) 2010
+
+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/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('csv_report_generator', '0.4.0') do |p|
+  p.description              = "Makes generating CSV report easier"
+  p.url                      = "http://github.com/ckhall/CSV-Report-Generator"
+  p.author                   = "Chris Hall"
+  p.email                    = "christopher.k.hall@gmail.com"
+  p.ignore_pattern           = "pkg/*", "doc/*", "coverage/*"
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/csv_report_generator.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{csv_report_generator}
+  s.version = "0.4.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Hall"]
+  s.date = %q{2010-06-08}
+  s.description = %q{Makes generating CSV report easier}
+  s.email = %q{christopher.k.hall@gmail.com}
+  s.extra_rdoc_files = ["README.rdoc", "lib/csv_report_generator.rb", "lib/csv_report_generator/csv_report_generator.rb"]
+  s.files = ["README.rdoc", "Rakefile", "example/example.rb", "lib/csv_report_generator.rb", "lib/csv_report_generator/csv_report_generator.rb", "test/test_helper.rb", "test/unit/csv_report_generator_test.rb", "Manifest", "csv_report_generator.gemspec"]
+  s.homepage = %q{http://github.com/ckhall/CSV-Report-Generator}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Csv_report_generator", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{csv_report_generator}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Makes generating CSV report easier}
+  s.test_files = ["test/test_helper.rb", "test/unit/csv_report_generator_test.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
+    else
+    end
+  else
+  end
+end

data/example/example.rb

@@ -0,0 +1,39 @@
+require 'rubygems'
+require File.join(File.dirname(__FILE__), '../lib/csv_report_generator')
+
+headers = [{ :name => "Full Name" }, { :zip => "Zip Code" }, { :gender => "Gender" }, { :widget_count => "Widgets" }, { :comment => "Comments" }]
+rows    = [ { :name => 'joe blow', :zip => 12345, :gender => 0, :widget_count => 3, :comment => "This, has a comma" },
+            { :name => 'jane doe', :zip => 56789, :gender => 1, :widget_count => 2, :comment => "\"This\" has quotes" },
+            { :name => 'jane doe', :zip => 56789, :gender => 1, :widget_count => 2, :comment => "Hello there" },
+            { :name => nil, :zip => nil, :gender => nil, :widget_count => 7, :comment => nil } ]
+
+report = CSVReportGenerator.new(rows, headers, :includes_total => true) do |csv|
+  csv.row_transformer { |row|
+    row[:name].upcase!
+    row[:gender] = (row[:gender].to_i == 0 ? "Male" : "Female")
+    row[:comment] = row[:comment].tr "A-Za-z", "N-ZA-Mn-za-m" #rot13
+    row
+  }
+  
+  csv.total_transformer { |row|
+   row[:name] = "TOTAL"
+   row
+  }
+end
+
+puts "with headers"
+puts "============================"
+puts report.as_csv
+
+puts
+puts "without headers"
+puts "============================"
+report.headers = nil
+puts report.as_csv
+
+report = CSVReportGenerator.new(rows, headers, :include_totals => true)
+
+puts
+puts "no transformations"
+puts "============================"
+puts report.as_csv

data/lib/csv_report_generator/csv_report_generator.rb

@@ -0,0 +1,63 @@
+class CSVReportGenerator
+  
+  DEFAULT_ROW_TRANSFORMER = proc { |r| r }.freeze
+  DEFAULT_TOTAL_TRANSFORMER = proc { |r| r }.freeze
+  
+  attr_writer :headers
+  attr_writer :rows
+  
+  def row_transformer(&block)
+    @row_transformer = block
+  end
+  
+  def total_transformer(&block)
+    @total_transformer = block
+  end
+  
+  def transform(row, block)
+    block.call(row)
+  end
+  
+  def initialize(rows, headers = nil, opts = {})
+    @headers = headers
+    @rows = rows
+    @includes_total = opts[:includes_total] || false
+    
+    if block_given?
+      yield(self)
+    else
+      # setup default transformers
+      @row_transformer = DEFAULT_ROW_TRANSFORMER
+      @total_transformer = DEFAULT_TOTAL_TRANSFORMER
+    end
+  end
+  
+  def as_csv
+    FasterCSV.generate do |csv|
+      unless @headers.nil?
+        csv << @headers.map { |h| h.values.first }
+      end
+
+      # transform if passed block, otherwise leave as is
+      # don't mess with original row data in case we want
+      # to redefine 
+      rows = @rows.collect do |row|
+        if(@includes_total && @rows.last == row)
+          self.transform(row, @total_transformer)
+        else
+          self.transform(row, @row_transformer)
+        end
+      end
+      
+      # need to do it this way so headers and data are in sync
+      unless @headers.nil?
+        rows.map { |r| @headers.map { |h| h.keys.first }.map { |h| r.send(:[], h.to_sym) } }.each { |row| csv << row }
+      else
+        unless rows.empty?
+          cols = rows[0].keys
+          rows.map { |r| cols.map { |c| r.send(:[], c.to_sym) } }.each { |row| csv << row }
+        end
+      end
+    end
+  end
+end

data/lib/csv_report_generator.rb

@@ -0,0 +1,4 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'fastercsv'
+require 'csv_report_generator/csv_report_generator'

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+# http://sneaq.net/textmate-wtf
+$:.reject! { |e| e.include? 'TextMate' }
+
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+require File.dirname(__FILE__) + '/../lib/csv_report_generator'

data/test/unit/csv_report_generator_test.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.join(File.dirname(__FILE__), %w(.. test_helper)))
+
+class CSVReportGeneratorTest < Test::Unit::TestCase
+
+  context "An instance of the CSVReportGenerator class" do
+
+    should "flunk" do
+      flunk "Please provide some tests"
+    end
+    
+  end
+
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: csv_report_generator
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
+platform: ruby
+authors: 
+- Chris Hall
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-08 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Makes generating CSV report easier
+email: christopher.k.hall@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/csv_report_generator.rb
+- lib/csv_report_generator/csv_report_generator.rb
+files: 
+- README.rdoc
+- Rakefile
+- example/example.rb
+- lib/csv_report_generator.rb
+- lib/csv_report_generator/csv_report_generator.rb
+- test/test_helper.rb
+- test/unit/csv_report_generator_test.rb
+- Manifest
+- csv_report_generator.gemspec
+has_rdoc: true
+homepage: http://github.com/ckhall/CSV-Report-Generator
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Csv_report_generator
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: csv_report_generator
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Makes generating CSV report easier
+test_files: 
+- test/test_helper.rb
+- test/unit/csv_report_generator_test.rb