array_to_csv 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1a14acec1c38d14bc166fcc2e3c885a00664747
-  data.tar.gz: fb3982fb10d8bec759d05fa61de02ed2a9bad320
+  metadata.gz: 6a35e265bf29320eaad3cc7455ba66882a062347
+  data.tar.gz: 07ccceb8f2ee1868f1de8c812a98b0b5d126799a
 SHA512:
-  metadata.gz: 54da663d1c117d226a8f616ef198a6e899f2bad3fa9e2f039482966f189286e90df7869077961db12e00f6b39f448e152cfeefda82c2709c618238d188163dbd
-  data.tar.gz: f781a7c56fc1bb835649113d704c1efe71e47c361bd692d0efb383047d94b94f0bc368df5af9092b5b04e2fac103879e7e4c16671ad2031e8cb4d56e018a5c27
+  metadata.gz: 10d9744daa78f20ab1c7c42a1777f69866339c773f4e7d08b73b361a69a97ae452f5533446c68c66cd4d839adfdd9774859a2ef889808d51a5f836ea2ad31f4e
+  data.tar.gz: 68bbacbd8721eb81b4b04c19867a682aa782c4cbf35e10da6fc3d018ceb3e69ac2f1a8b9d7615001381c9f387cbd91ce3ce78d962b53dde372f5e328cae716a2

data/README.md

@@ -0,0 +1,102 @@
+# array_to_csv
+
+Simple convenience library for converting an array of hashes to CSV
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'array_to_csv'
+```
+
+OR
+
+```ruby
+gem 'array_to_csv', :require => 'array_to_csv/core_ext'
+```
+
+if you want the to_csv method to be added to the Array class.
+
+Then execute:
+
+```sh
+$ bundle install
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install array_to_csv
+```
+
+## Example Usage
+
+### Using Array#to_csv (re-opening the Array class)
+
+If you require array_to_csv/core_ext,
+
+```ruby
+require 'array_to_csv/core_ext'
+```
+
+(or require it from within your Gemfile)
+you can call to_csv directly on an array.
+
+```ruby
+puts [
+  {:first_name => 'Rob', :last_name => 'Bobber'},
+  {:first_name => 'Bob', :age => 103}
+].to_csv
+```
+
+This outputs:
+
+    first_name,last_name,age
+    Rob,Bobber,
+    Rob,,103
+
+Which would look something like this in your favourite spreadsheet editor
+
+| first_name | last_name | age |
+|------------|-----------|-----|
+| Rob        | Bobber    |     |
+| Bob        |           | 103 |
+
+When no arguments are given to to_csv, the CSV data is returned as a string.
+
+You can pass in a file path, and the CSV data will be written directly to file,
+instead of being returned as a string.
+
+```ruby
+[
+  {:first_name => 'Rob', :last_name => 'Bobber'},
+  {:first_name => 'Bob', :age => 103}
+].to_csv("/tmp/people.csv")
+```
+
+You can also pass in a File object as the first argument, or any other
+IO/IO-like object (anything that implements #write(string) and #close).
+
+### Without reopening Array class
+
+If you don't want to being reopening core classes, you can convert an array to CSV
+like this:
+
+```ruby
+data = [
+  {:first_name => 'Rob', :last_name => 'Bobber'},
+  {:first_name => 'Bob', :age => 103}
+]
+puts ArrayToCsv.new(data).to_csv
+```
+
+Which produces the same output as above
+
+    first_name,last_name,age
+    Rob,Bobber,
+    Rob,,103
+
+The interface for ArrayToCsv#to_csv is the same as that for Array#to_csv.
+
+You can pass in a file path, File, or IO/IO-like object.

data/array_to_csv.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "array_to_csv"
-  spec.version       = "0.0.1"
+  spec.version       = "0.1.0"
   spec.authors       = ["Joel Plane"]
   spec.email         = ["joel.plane@gmail.com"]
   spec.description   = %q{Adds convenience method Array#to_csv for converting an array of hashes to CSV.}

data/lib/array_to_csv.rb

@@ -1,52 +1,41 @@
 class ArrayToCsv
 
-  def initialize array, csv_lib=choose_csv_lib
+  require 'array_to_csv/csv_writer'
+
+  def initialize array, csv_lib=nil
     @array = array
-    @csv = csv_lib
+    @csv_lib = csv_lib
   end
 
-  def to_csv
-    @csv.generate do |csv|
-      each_row do |row|
-        csv << row
-      end
+  # @return [String, nil]
+  def to_csv io_or_file_path=nil
+    case io_or_file_path
+      when nil
+        to_csv_string
+      when String
+        to_csv_file io_or_file_path
+      else
+        to_csv_io io_or_file_path
     end
   end
 
   private
 
-  def each_row
-    yield head
-    @array.each do |hash|
-      yield row_from_hash hash
-    end
-  end
-
-  def head
-    @head_from_array ||= [].tap do |keys|
-      seen_keys = {}
-      @array.each do |hash|
-        hash.keys.each do |key|
-          unless seen_keys[key]
-            seen_keys[key] = true
-            keys << key
-          end
-        end
-      end
-    end
+  # @return [String]
+  def to_csv_string
+    StringIO.new.tap do |string_io|
+      self.to_csv string_io
+    end.string
   end
 
-  def row_from_hash hash
-    hash.values_at(*head)
+  def to_csv_file file_path
+    file_io = File.open(file_path, 'w')
+    self.to_csv file_io
   end
 
-  # TODO: return FasterCSV in old ruby
-  def choose_csv_lib
-    if RUBY_VERSION =~ /^1\.8/
-      FasterCSV
-    else
-      CSV
-    end
+  # @return [nil]
+  def to_csv_io io
+    CsvWriter.new(@array, io, @csv_lib).write
   end
 
 end

data/lib/array_to_csv/core_ext.rb

@@ -1,9 +1,14 @@
 require 'array_to_csv'
+if RUBY_VERSION =~ /^1\.8/
+  require 'fastercsv'
+else
+  require 'csv'
+end
 
 class Array
 
-  def to_csv
-    ArrayToCsv.new(self).to_csv
+  def to_csv *args
+    ArrayToCsv.new(self).to_csv *args
   end
 
 end

data/lib/array_to_csv/csv_writer.rb

@@ -0,0 +1,53 @@
+class ArrayToCsv::CsvWriter
+
+  def initialize array, io, csv_lib
+    @array, @io = array, io
+    @csv = csv_lib || choose_csv_lib
+  end
+
+  def write
+    each_row do |row|
+      write_line row
+    end
+    @io.close
+    nil
+  end
+
+  def write_line row
+    @io.write @csv.generate_line row
+  end
+
+  def each_row
+    yield head
+    @array.each do |hash|
+      yield row_from_hash hash
+    end
+  end
+
+  def head
+    @head_from_array ||= [].tap do |keys|
+      seen_keys = {}
+      @array.each do |hash|
+        hash.keys.each do |key|
+          unless seen_keys[key]
+            seen_keys[key] = true
+            keys << key
+          end
+        end
+      end
+    end
+  end
+
+  def row_from_hash hash
+    hash.values_at(*head)
+  end
+
+  def choose_csv_lib
+    if RUBY_VERSION =~ /^1\.8/
+      FasterCSV
+    else
+      CSV
+    end
+  end
+
+end

data/spec/array_to_csv_spec.rb

@@ -41,4 +41,37 @@ describe ArrayToCsv do
 
   end
 
+  describe ".to_csv(io)" do
+
+    subject { ArrayToCsv.new([{:key1 => 'value1'}, {:key2 => 'value2'}]) }
+
+    it "should stream output to provided io object" do
+      io = double
+      expect(io).to receive(:write).with("key1,key2\n")
+      expect(io).to receive(:write).with("value1,\n")
+      expect(io).to receive(:write).with(",value2\n")
+      expect(io).to receive(:close)
+      subject.to_csv(io)
+    end
+
+    it "should return nil" do
+      io = double :write => nil, :close => nil
+      expect(subject.to_csv(io)).to be_nil
+    end
+
+  end
+
+  describe ".to_csv(file_path)" do
+
+    subject { ArrayToCsv.new([{:key1 => 'value1'}, {:key2 => 'value2'}]) }
+    let(:csv_output) { "key1,key2\nvalue1,\n,value2\n" }
+    let(:test_path) { "/tmp/array_to_csv_test_output.csv" }
+
+    it "should write CSV to file" do
+      subject.to_csv test_path
+      expect(File.read(test_path)).to eq(csv_output)
+    end
+
+  end
+
 end

data/spec/core_ext_spec.rb

@@ -16,4 +16,12 @@ describe "array_to_csv/core_ext" do
     expect(array.to_csv).to eq(ArrayToCsv.new(array).to_csv)
   end
 
+  it "should delegate with arguments" do
+    array = []
+    fake_io, inst = double, double
+    expect(ArrayToCsv).to receive(:new).and_return(inst)
+    expect(inst).to receive(:to_csv).with(fake_io)
+    array.to_csv fake_io
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: array_to_csv
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Joel Plane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-08 00:00:00.000000000 Z
+date: 2014-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -63,10 +63,12 @@ files:
 - .gitignore
 - Gemfile
 - LICENSE.txt
+- README.md
 - Rakefile
 - array_to_csv.gemspec
 - lib/array_to_csv.rb
 - lib/array_to_csv/core_ext.rb
+- lib/array_to_csv/csv_writer.rb
 - spec/array_to_csv_spec.rb
 - spec/core_ext_spec.rb
 - test_helper.rb