enum_csv 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5adcc47fbd7b34a09baac9c8ac6c54f86c316ba1
+  data.tar.gz: 47d03538cf37af19be66993d618526b6bc03dddb
+SHA512:
+  metadata.gz: 532750b7c690dd1960462a18ddb610915cc70effa99c46719e1ffc4108503b3715e9f4ec26f62ff591765bda336a7f22add9438e6f43ef367659cf9319aadacd
+  data.tar.gz: e72e5b42e72913a3840f297f4a6684f26424e77aaff93136bc2174aaf37d3a110e8d87066130e410cd47e131f8fc23a1ba6b5a81b76b892d2be7774f77fa3bee

data/CHANGELOG

@@ -0,0 +1,3 @@
+=== 1.0.0 (2013-12-18)
+
+* Initial Public Release

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2013 Jeremy Evans
+
+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 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/README.rdoc

@@ -0,0 +1,46 @@
+= EnumCSV
+
+EnumCSV exposes a single method, csv, for easily creating CSV
+output/files from enumerable objects.  It is a super simple wrapper
+class for ruby's csv library.
+
+= Installation
+
+  sudo gem install enum_csv
+
+= Source Code
+
+Source code is available on GitHub at https://github.com/jeremyevans/enum_csv
+
+= Examples
+
+The default behavior just expects an enumerable of arrays (such as an array of
+arrays), and returns a string containing the CSV output:
+
+  EnumCSV.csv([[1, 2]]) => "1,2\n"
+
+You can use the :headers option to set custom headers:
+
+  EnumCSV.csv([[1, 2], [3,"4,5"]], :headers=>['A', 'B']) => "A,B\n1,2\n3,\"4,5\"\n"
+
+The :file option can be used to output to a file:
+
+  EnumCSV.csv([[1, 2]], :file=>'foo.csv') => nil # output written to foo.csv
+
+If a block is passed to the method, all items in the enumerable are yielded to
+the block, and the block should return an array with the data to use in the CSV
+output:
+
+  EnumCSV.csv([{:a=>1, :b=>2}, {:a=>3, b=>4}]){|line| [l[:b], l[:a] + 10]} => "2,11\n4,13\n"
+
+= Ruby 1.8 Usage
+
+On Ruby 1.8, you need to install the fastercsv gem to use this library.
+
+= License
+
+MIT
+
+= Author
+
+Jeremy Evans <code@jeremyevans.net>

data/Rakefile

@@ -0,0 +1,69 @@
+require "rake"
+require "rake/clean"
+
+CLEAN.include ["enum_csv-*.gem", "rdoc", "coverage"]
+
+desc "Build enum_csv gem"
+task :package=>[:clean] do |p|
+  sh %{#{FileUtils::RUBY} -S gem build enum_csv.gemspec}
+end
+
+### Specs
+
+begin
+  begin
+    # RSpec 1
+    require "spec/rake/spectask"
+    spec_class = Spec::Rake::SpecTask
+    spec_files_meth = :spec_files=
+  rescue LoadError
+    # RSpec 2
+    require "rspec/core/rake_task"
+    spec_class = RSpec::Core::RakeTask
+    spec_files_meth = :pattern=
+  end
+
+  spec = lambda do |name, files, d|
+    lib_dir = File.join(File.dirname(File.expand_path(__FILE__)), 'lib')
+    ENV['RUBYLIB'] ? (ENV['RUBYLIB'] += ":#{lib_dir}") : (ENV['RUBYLIB'] = lib_dir)
+    desc d
+    spec_class.new(name) do |t|
+      t.send(spec_files_meth, files)
+    end
+  end
+
+  task :default => [:spec]
+  spec.call("spec", Dir["spec/*_spec.rb"], "Run specs")
+rescue LoadError
+  task :default do
+    puts "Must install rspec >=2.0 to run the default task (which runs specs)"
+  end
+end
+
+### RDoc
+
+RDOC_DEFAULT_OPTS = ["--quiet", "--line-numbers", "--inline-source", '--title', 'EnumCSV: Create CSV from Enumerables']
+
+begin
+  gem 'rdoc', '= 3.12.2'
+  gem 'hanna-nouveau'
+  RDOC_DEFAULT_OPTS.concat(['-f', 'hanna'])
+rescue Gem::LoadError
+end
+
+rdoc_task_class = begin
+  require "rdoc/task"
+  RDoc::Task
+rescue LoadError
+  require "rake/rdoctask"
+  Rake::RDocTask
+end
+
+RDOC_OPTS = RDOC_DEFAULT_OPTS + ['--main', 'README.rdoc']
+
+rdoc_task_class.new do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.options += RDOC_OPTS
+  rdoc.rdoc_files.add %w"README.rdoc CHANGELOG MIT-LICENSE lib/**/*.rb"
+end
+

data/lib/enum_csv.rb

@@ -0,0 +1,44 @@
+# EnumCSV exposes a single method, csv, for easily creating CSV
+# output/files from enumerable objects.
+module EnumCSV
+  if RUBY_VERSION >= '1.9'
+    require 'csv'
+  else
+    require 'fastercsv'
+    # Use FasterCSV on ruby 1.8
+    CSV = ::FasterCSV
+  end
+
+  # Create CSV from the given Enumerable object. If a block is given,
+  # each item in the enumerable is yielded to the block, and the block
+  # should return an array of of items to use for the CSV line.
+  #
+  # Options:
+  # :headers :: Should be an array of headers to use as the first
+  #             line of the CSV output.
+  # :file :: Output to the given file and return nil instead of
+  #          returning a string with the CSV output.
+  # all other options :: Passed to CSV.open or CSV.generate
+  def csv(enum, opts={})
+    if opts[:headers].is_a?(Array) && !opts.has_key?(:write_headers)
+      opts = opts.merge(:write_headers=>true)
+    end
+
+    csv_proc = proc do |csv|
+      enum.each do |line|
+        line = yield(line) if block_given?
+        csv << line
+      end
+    end
+
+    if opts[:file]
+      opts = opts.dup
+      file = opts.delete(:file)
+      CSV.open(file, 'wb', opts, &csv_proc)
+      nil
+    else
+      CSV.generate(opts, &csv_proc)
+    end
+  end
+  module_function :csv
+end

data/spec/enum_csv_spec.rb

@@ -0,0 +1,43 @@
+require File.join(File.dirname(File.expand_path(__FILE__)), '../lib/enum_csv')
+
+describe "EnumCSV.csv" do
+  TEST_FILE = File.join(File.dirname(File.expand_path(__FILE__)), 'test.csv')
+  after(:all) do
+    File.delete(TEST_FILE)
+  end
+
+  it "should return string of CSV data for enumerable" do
+    EnumCSV.csv([[1, 2]]).should == "1,2\n"
+    EnumCSV.csv([[1, 2], [3, 4]]).should == "1,2\n3,4\n"
+    EnumCSV.csv([[1, '2,3'], [3, 4]]).should == "1,\"2,3\"\n3,4\n"
+    EnumCSV.csv([[1, nil], [3, 4]]).should == "1,\n3,4\n"
+  end
+
+  it "should support :headers option for a headers string" do
+    EnumCSV.csv([[1, 2]], :headers=>['a', 'b']).should == "a,b\n1,2\n"
+    EnumCSV.csv([[1, 2], [3, 4]], :headers=>['a', 'b']).should == "a,b\n1,2\n3,4\n"
+    EnumCSV.csv([[1, '2,3'], [3, 4]], :headers=>['a,b', 'c']).should == "\"a,b\",c\n1,\"2,3\"\n3,4\n"
+    EnumCSV.csv([[1, nil], [3, 4]], :headers=>['a', nil]).should == "a,\n1,\n3,4\n"
+  end
+
+  it "should support :file option for writing to a file" do
+    EnumCSV.csv([[1, 2]], :file=>TEST_FILE).should be_nil
+    File.read(TEST_FILE).should == "1,2\n"
+    EnumCSV.csv([[1, 2]], :file=>TEST_FILE, :headers=>['a', 'b'])
+    File.read(TEST_FILE).should == "a,b\n1,2\n"
+  end
+
+  it "should support other csv options" do
+    EnumCSV.csv([[1, 2]], :row_sep=>'|').should == "1,2|"
+    EnumCSV.csv([[1, 2], [3, 4]], :col_sep=>'^').should == "1^2\n3^4\n"
+  end
+
+  it "should yield elements to the block if given" do
+    EnumCSV.csv([[1, 2]]){|l| l.map{|i| i*2}}.should == "2,4\n"
+    EnumCSV.csv([[1, 2]], :headers=>['a', 'b']){|l| l.map{|i| i*2}}.should == "a,b\n2,4\n"
+  end
+
+  it "should be callable as a method if including the module" do
+    Class.new{include EnumCSV}.new.send(:csv, [[1, 2]]).should == "1,2\n"
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: enum_csv
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jeremy Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-18 00:00:00.000000000 Z
+dependencies: []
+description: |
+  EnumCSV exposes a single method, csv, for easily creating CSV
+  output/files from enumerable objects.
+email: code@jeremyevans.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- CHANGELOG
+- MIT-LICENSE
+files:
+- MIT-LICENSE
+- CHANGELOG
+- README.rdoc
+- Rakefile
+- spec/enum_csv_spec.rb
+- lib/enum_csv.rb
+homepage: http://gihub.com/jeremyevans/enum_csv
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --quiet
+- --line-numbers
+- --inline-source
+- --title
+- 'EnumCSV: Create CSV from Enumerables'
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Create CSV from Enumerables
+test_files: []