csv_generator 0.5.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7ca333b9d9a9cdd6246dd186c3665cd016859f1
-  data.tar.gz: eb87e512cd89d733dcd4af3137050a1973137afa
+  metadata.gz: f4bf22d03d73abd1b9737b87bcd572787074b735
+  data.tar.gz: 5b82ac622da0097ffe017c94c79577b2bf2afadc
 SHA512:
-  metadata.gz: bd81198e0248578d24a566d1861281bf8a2313094b4f7133bcf4e879c50687524fa85d26a53aebfa4e4a3eacb1418536003ffff3086c0a3138be4af838ebf13b
-  data.tar.gz: 9fa44baa803d84359f7aeb55a64f8b0f1e7d7a9335657d0c792d50706e336de8047bba8d9bd35634d4467b3b6c56ce01f9ef9f052eb17230fa753d0a22a5b311
+  metadata.gz: bf79ca4aa156080e265d18b8b5c5d62a76655257cac4758a14fded720b59c6cce8c8f854328628ac8befe6040d19e2999e432836e02ab7b63725cd55e5a7c1ea
+  data.tar.gz: ad1a06305ca8dd6493a9ecf3f73cbb93b44c4016a5496d6cc6aa880457478165fafdb1d250fd1cca6a6e3250d0883b0ee6359386b03aa61bb57fade426906e8e

data/README.md

@@ -2,9 +2,46 @@
 
 [![Build Status](https://semaphoreapp.com/api/v1/projects/ad79168d-d8c1-45c5-9a25-6e8354304f83/300861/badge.png)](https://semaphoreapp.com/cesare/csv_generator)
 
-Just a CSV generator :)
+Just a CSV generator :)  
 It ensures string fields quoted.
 
+## What is the difference from standard CSV library?
+
+Standard CSV also can quote values with `force_quotes` option, like this:
+
+```ruby
+CSV.open(filename, 'w', force_quotes: true) do |csv|
+  csv << ['0123', 987]
+end
+```
+
+This example above quotes ALL values (including the numeric value 987).  
+It generates
+
+```
+"0123","987"
+```
+
+Note that the numeric value 987 is also quoted.
+In most cases, this behavior is sufficient.
+
+However, sometimes it would be useful if you can distinguish string values and numeric values with quotation, in following manner:
+
+* if a value is quoted, it is a string
+* if not, it is a number
+
+CsvGenerator follows these rules.  
+You can generate:
+
+```
+"0123",987
+```
+
+As you see, numeric value 987 is not quoted.
+
+Some CSV-readable application might interpret "0123" as a string, 987 as a number.
+Is such a case, CsvGenerator will be useful.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -23,14 +60,82 @@ Or install it yourself as:
 
 ## Usage
 
+Basic usage is something like this:
+
 ```ruby
-CsvGenerator.generate('example.csv') do |csv|
+CsvGenerator.open('example.csv') do |csv|
   csv << ['0123', 456, 'this is a string']
 end
 # writes to example.csv:
 # "0123",456,"this is a string"
 ```
 
+If you have multiple rows,
+
+```ruby
+rows = [
+  ['0123', 456, 'this is a string'],
+  ['1234', 987, 'this is the second row']
+]
+
+CsvGenerator.open('example.csv') do |csv|
+  rows.each do |row|
+    csv << row
+  end
+end
+# writes to example.csv:
+# "0123",456,"this is a string"
+# "1234",987,"this is the second row"
+```
+
+Or using `CsvGenerator#generate`,
+
+```ruby
+rows = [
+  ['0123', 456, 'this is a string'],
+  ['1234', 987, 'this is the second row']
+]
+
+CsvGenerator.open('example.csv').generate(rows)
+# writes to example.csv:
+# "0123",456,"this is a string"
+# "1234",987,"this is the second row"
+```
+
+Data source of a row does not have to be an array.
+If you have objects (such as ActiveRecord instances),
+
+```ruby
+class User
+  attr_reader :name, :score
+end
+
+users = [
+  User.new(name: 'test1', score: 123),
+  User.new(name: 'test2', socre: 987)
+]
+
+CsvGenerator.open('example.csv') do |csv|
+  csv.generate(users) do |user|
+    [user.name, user.score]
+  end
+end
+# writes to example.csv:
+# "test1",123
+# "test2",987
+```
+
+If you need a string instead of a file, use StringIO like this:
+
+```ruby
+io = StringIO.new
+CsvGenerator.new(io) do |csv|
+  csv << ['test', 123]
+end
+
+io.string # => "test",123
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/cesare/csv_generator/fork )

data/csv_generator.gemspec

@@ -13,6 +13,8 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/cesare/csv_generator'
   spec.license       = 'MIT'
 
+  spec.required_ruby_version = '>= 1.9.3'
+
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})

data/lib/csv_generator.rb

@@ -4,20 +4,16 @@ class CsvGenerator
   attr_reader :io
 
   class << self
-    def generate(path, options = {}, &block)
+    def open(path, options = {})
       mode = options[:mode] || 'w'
       permission = options[:permission] || 0644
 
       File.open(path, mode, permission) do |io|
-        with io, options, &block
-      end
-    end
-
-    def with(io, options = {})
-      generator = new(io, options)
+        generator = new(io, options)
+        yield generator
 
-      yield generator if block_given?
-      generator
+        generator
+      end
     end
   end
 
@@ -26,6 +22,16 @@ class CsvGenerator
     @options = options
   end
 
+  def generate(enumerable)
+    enumerable.each do |row_instance|
+      if block_given?
+        self << (yield row_instance)
+      else
+        self << row_instance
+      end
+    end
+  end
+
   def <<(row_values)
     io.write row_generator.generate(row_values)
   end

data/lib/csv_generator/version.rb

@@ -1,3 +1,3 @@
 class CsvGenerator
-  VERSION = '0.5.2'
+  VERSION = '1.0.0'
 end

data/spec/csv_generator_spec.rb

@@ -1,12 +1,12 @@
 require 'fakefs/spec_helpers'
 
 describe CsvGenerator do
-  describe '.generate' do
+  describe '.open' do
     context 'given only a file name' do
       include FakeFS::SpecHelpers
 
       specify do
-        CsvGenerator.generate('test.csv') do |csv|
+        CsvGenerator.open('test.csv') do |csv|
           csv << ['test', 123]
         end
 
@@ -22,7 +22,7 @@ describe CsvGenerator do
           file.write(%("existing line",987\r\n))
         end
 
-        CsvGenerator.generate('test.csv') do |csv|
+        CsvGenerator.open('test.csv') do |csv|
           csv << ['test', 123]
         end
 
@@ -38,7 +38,7 @@ describe CsvGenerator do
           file.write(%("existing line",987\r\n))
         end
 
-        CsvGenerator.generate('test.csv', mode: 'a') do |csv|
+        CsvGenerator.open('test.csv', mode: 'a') do |csv|
           csv << ['test', 123]
         end
 
@@ -47,6 +47,32 @@ describe CsvGenerator do
     end
   end
 
+  describe '#generate' do
+    let(:io) { StringIO.new }
+    let(:csv) { CsvGenerator.new(io) }
+
+    context 'without block' do
+      specify do
+        csv.generate([['test1', 123], ['test2', 987]])
+
+        expect(io.string).to eq %("test1",123\r\n"test2",987\r\n)
+      end
+    end
+
+    context 'with block' do
+      let(:struct) { Struct.new(:name, :score) }
+      let(:rows) { [struct.new('test1', 123), struct.new('test2', 987)] }
+
+      specify do
+        csv.generate(rows) do |s|
+          [s.name, s.score]
+        end
+
+        expect(io.string).to eq %("test1",123\r\n"test2",987\r\n)
+      end
+    end
+  end
+
   describe '#<<' do
     let(:io) { StringIO.new }
     let(:csv) { CsvGenerator.new(io) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csv_generator
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 1.0.0
 platform: ruby
 authors:
 - SAWADA Tadashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-04 00:00:00.000000000 Z
+date: 2014-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -127,7 +127,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="