csv_shaper 0.1.1 → 0.2.0

data/README.md

@@ -11,8 +11,8 @@ Annotated source: http://paulspringett.github.com/csv_shaper/
 ### Example Usage
 
 ```ruby
-csv_string = CsvShaper::Shaper.encode do |csv|
-  csv.headers :name, :age, :gender, :pet_names
+csv_string = CsvShaper.encode do |csv|
+  csv.header :name, :age, :gender, :pet_names
   
   csv.rows @users do |csv, user|
     csv.cells :name, :age, :gender
@@ -219,6 +219,22 @@ def index
 end
 ```
 
+### CSV configuration
+
+To configure how the CSV output is formatted you can define a configure block, like so:
+
+```ruby
+CsvShaper.configure do |config|
+  config.col_sep = "\t"
+  config.write_headers = false
+end
+```
+
+Inside the block you can pass any of the standard library [CSV DEFAULT_OPTIONS](http://ruby-doc.org/stdlib-1.9.2/libdoc/csv/rdoc/CSV.html#DEFAULT_OPTIONS), as well as a `write_headers` option (default: `true`).
+Setting this to `false` will exclude the headers from the final CSV output.
+
+If you're using Rails you can put this in an initializer.
+
 ### Contributing
 
 1. Fork it

data/lib/csv_shaper/config.rb

@@ -0,0 +1,53 @@
+require 'csv'
+
+module CsvShaper
+  # Config
+  # Configure the standard CSV default options
+  # as well the option to output the header row
+  class Config
+    attr_reader :options
+
+    def initialize
+      @options = {}
+      yield self if block_given?
+    end
+
+    # Public: set options where the method name
+    # matches a key
+    def method_missing(meth, value)
+      meth = sanitize_setter_method(meth)
+
+      if defaults.key?(meth)
+        @options[meth] = value
+      else
+        super
+      end
+    end
+
+    def respond_to?(meth)
+      meth = sanitize_setter_method(meth)
+      defaults.key?(meth)
+    end
+
+    private
+
+    # Internal: removes the equals from the end of the
+    # method name
+    #
+    # `meth` - Symbol of the method of sanitize
+    #
+    # Returns a Symbol
+    def sanitize_setter_method(meth)
+      meth = meth.to_s.gsub('=', '')
+      meth.to_sym
+    end
+
+    # Internal: default CSV options, plus a write headers
+    # option, to pass to #to_csv
+    #
+    # Returns a Hash
+    def defaults
+      @defaults ||= CSV::DEFAULT_OPTIONS.dup.merge(write_headers: true)
+    end
+  end
+end

data/lib/csv_shaper/encoder.rb

@@ -27,11 +27,15 @@ module CsvShaper
       end
 
       table = CSV::Table.new(rows)
-      table.to_csv
+      table.to_csv(options)
     end
     
     private
-    
+
+    def options
+      CsvShaper::Shaper.config && CsvShaper::Shaper.config.options || {}
+    end
+
     # Internal: make use of `CSV#values_at` to pad out the
     # cells into the correct columns for the headers
     #

data/lib/csv_shaper/row.rb

@@ -57,13 +57,23 @@ module CsvShaper
     # `value` - data to assign to the cell (default: nil)
     #
     # Returns an Array of the Row's cells
-    def cell(column, value = nil)
-      column = column.to_sym
+    def cell(*args)
+      if args.empty?
+        raise ArgumentError, 'no args passed to #cell, you must pass at least a column name'
+      end
+      
+      column = args.first.to_sym
       
-      if @model && value.nil?
-        @cells[column] = @model.send(column)
+      if args.size == 2
+        @cells[column] = args.last
+      elsif args.size == 1
+        if @model && @model.respond_to?(column)
+          @cells[column] = @model.send(column)
+        else
+          raise ArgumentError, "##{column} is not a method on #{@model.class.to_s}, call `csv.cell #{column}, value` instead"
+        end
       else
-        @cells[column] = value
+        raise ArgumentError, 'you can pass a column or a column with a value to #cell'
       end
       
       @cells

data/lib/csv_shaper/shaper.rb

@@ -4,6 +4,10 @@ module CsvShaper
   class Shaper
     attr_reader :header, :rows
     
+    class << self
+      attr_accessor :config
+    end
+    
     def initialize
       @rows = []
       yield self if block_given?
@@ -72,5 +76,11 @@ module CsvShaper
     def to_csv
       Encoder.new(@header, @rows).to_csv
     end
+
+    # Public: Create an instance of the config and cache it
+    # for reference by the Encoder later
+    def self.configure(&block)
+       @config ||= CsvShaper::Config.new(&block)
+     end
   end
 end

data/lib/csv_shaper/version.rb

@@ -1,3 +1,3 @@
 module CsvShaper
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/csv_shaper.rb

@@ -5,10 +5,20 @@ require 'csv_shaper/version'
 require 'csv_shaper/header'
 require 'csv_shaper/row'
 require 'csv_shaper/encoder'
+require 'csv_shaper/config'
 require 'csv_shaper/shaper'
 
 module CsvShaper
   class MissingHeadersError < StandardError; end
+
+  # Shortcut the encode method
+  def self.encode(&block)
+    CsvShaper::Shaper.encode(&block)
+  end
+
+  def self.configure(&block)
+    CsvShaper::Shaper.configure(&block)
+  end
 end
 
 require "csv_shaper_template" if defined?(ActionView::Template)

data/spec/config_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe CsvShaper::Config do
+  let(:config) {
+    CsvShaper::Config.new do |c|
+      c.write_headers = false
+      c.col_sep = "\t"
+    end
+  }
+  
+  it "should assign options to config" do
+    config.options.should eq({ write_headers: false, col_sep: "\t" })
+  end
+  
+  it "should exclude the headers if specified" do
+    CsvShaper::Shaper.config = config
+    
+    shaper = CsvShaper::Shaper.new do |csv|
+      csv.headers :name, :age, :gender
+      
+      csv.row do |csv|
+        csv.cell :name, 'Paul'
+        csv.cell :age, '27'
+        csv.cell :gender, 'Male'
+      end
+    end
+    
+    shaper.to_csv.should eq "Paul\t27\tMale\n"
+  end
+end

data/spec/csv_shaper_spec.rb

@@ -16,4 +16,13 @@ describe CsvShaper::Shaper do
     csv = CsvShaper::Shaper.new
     csv.should respond_to(:to_csv)
   end
+
+  it "should provide a shortcut to the encode method" do
+    CsvShaper.should respond_to(:encode)
+
+    CsvShaper.encode do |csv|
+      csv.headers :foo
+      csv.should be_instance_of(CsvShaper::Shaper)
+    end
+  end
 end

data/spec/encoder_spec.rb

@@ -4,6 +4,12 @@ require 'fixtures/user'
 describe CsvShaper::Encoder do
   let(:user) { User.new(name: 'Paul', age: 27, gender: 'Male') }
   
+  let(:config) {
+    CsvShaper::Config.new do |c|
+      c.write_headers = true
+    end
+  }
+  
   it "should raise an exception if the headers are missing" do
     expect {
       CsvShaper::Encoder.new(nil)
@@ -30,6 +36,7 @@ describe CsvShaper::Encoder do
   }
   
   it "should encode a Shaper instance to a CSV string" do
+    CsvShaper::Shaper.config = config
     encoder = CsvShaper::Encoder.new(csv.header, csv.rows)
     encoder.to_csv.should eq("Full name,Sex,Age\nPaul,Male,27\nBob,Male,31\nJane,Female,23\n,,81\n")
   end

data/spec/row_spec.rb

@@ -22,4 +22,37 @@ describe CsvShaper::Row do
       csv.should be_kind_of(CsvShaper::Row)
     }
   end
+  
+  describe "cells" do
+    it "should send parse an attribute of the model" do
+      row = CsvShaper::Row.new(user, :gender)
+      row.cell :name
+      row.cells.should eq({ name: 'Paul', gender: 'Male' })
+    end
+    
+    it "should send assign an unrelated value" do
+      row = CsvShaper::Row.new(user, :gender)
+      row.cell :foo, 'bar'
+      row.cells.should eq({ foo: 'bar', gender: 'Male' })
+    end
+    
+    it "ignore nil values passed" do
+      row = CsvShaper::Row.new(user, :gender)
+      row.cell :foo, nil
+      row.cells.should eq({ foo: nil, gender: 'Male' })
+    end
+    
+    it "should not send column to model if two args are passed" do
+      row = CsvShaper::Row.new(user, :gender)
+      row.cell :name, 'Another name'
+      row.cells.should eq({ name: 'Another name', gender: 'Male' })
+    end
+    
+    it "should raise an exception of the model does not respond to column, and no value is passed" do
+      row = CsvShaper::Row.new(user, :gender)
+      expect {
+        row.cell :foo
+      }.to raise_error(ArgumentError)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csv_shaper
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-11 00:00:00.000000000 Z
+date: 2012-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2232251900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,15 +21,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 3.0.0
+  version_requirements: *2232251900
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2232251240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -37,15 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *2232251240
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &2232250580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -53,12 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *2232250580
 description: ! "\n    Creating CSV files in Ruby is painful! CSV Shaper makes life
   easier! It's\n    ideal for converting database backed models with attrbiutes into
   CSV output.\n    It can be used without Rails, but works great with ActiveRecord
@@ -78,12 +63,14 @@ files:
 - Rakefile
 - csv_shaper.gemspec
 - lib/csv_shaper.rb
+- lib/csv_shaper/config.rb
 - lib/csv_shaper/encoder.rb
 - lib/csv_shaper/header.rb
 - lib/csv_shaper/row.rb
 - lib/csv_shaper/shaper.rb
 - lib/csv_shaper/version.rb
 - lib/csv_shaper_template.rb
+- spec/config_spec.rb
 - spec/csv_shaper_spec.rb
 - spec/encoder_spec.rb
 - spec/fixtures/user.rb
@@ -110,14 +97,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: Beautiful DSL for creating CSV output in Ruby & Rails
 test_files:
+- spec/config_spec.rb
 - spec/csv_shaper_spec.rb
 - spec/encoder_spec.rb
 - spec/fixtures/user.rb
 - spec/header_spec.rb
 - spec/row_spec.rb
 - spec/spec_helper.rb
+has_rdoc: