kiba-common 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9a78f79fe5c727bce8d34e47d627ab90989373a
-  data.tar.gz: 1e5c2928148dbd5a4179f4e28fc4a575d3c0f586
+  metadata.gz: ae21d45df8c55e0afa30187fc42eaad9ee4dade7
+  data.tar.gz: bc3abd7f9003f1fccbe946a65103aa4fceb0e733
 SHA512:
-  metadata.gz: 2073edaeeea322fc85fbf0909c439d53465669b1b0a1de99bff42d73d6673fb3a43f11080da344da3dc00d6cf39f14292adfbe073873762a96a7a890b9b73a2e
-  data.tar.gz: bf8d5816f1d0801a848fa0991e37b219dc0d1601a375aa8cdbf843c835a9ac7481ecbef6dd7f49557c582add51a13e081965eb5f5cc9e5c50e7a487a4ef7a285
+  metadata.gz: a38adada1e8f470dc7475d69db51c7502e72c3891a82380f669af3222ebcb199da0b49dd9f8056b6d50c1cf210846befd848b5b1ae7ee70f388cddb5f5b582b8
+  data.tar.gz: 66183f174f044a72c139ecf5d2a3c324faee62d81acb85daf6d02e2079faf944154020ab961442f0e6787bbd37b95175ab3b6426aa0d01b74c92f81538dc8494

data/.travis.yml

@@ -2,10 +2,6 @@ language: ruby
 before_install:
   - gem update bundler
 rvm:
-  - 2.4.0
-  - 2.3.4
-  - 2.2
-  - 2.1
-  - 2.0
-  - jruby-1.7
-  - jruby-9
+  - 2.4.3
+  - 2.3.6
+  - jruby-9.1.15.0

data/Changes.md

@@ -1,6 +1,12 @@
 HEAD
 ----
 
+0.0.3
+-----
+
+- Breaking: Kiba::Common requires Ruby 2.3+ from now on.
+- New: Kiba::Common::Destinations:CSV allows to write ruby hashes to a CSV file.
+
 0.0.2
 ----
 

data/README.md

@@ -12,7 +12,43 @@ gem 'kiba-common'
 
 Then see below for each module usage & require clause.
 
-## Available extensions
+## Supported Ruby versions
+
+`kiba-common` currently supports Ruby 2.3+ and JRuby (with its default 1.9 syntax). See [test matrix](https://travis-ci.org/thbar/kiba-common).
+
+## Available components
+
+### Kiba::Common::Destinations::CSV
+
+A way to dump `Hash` rows as CSV.
+
+All rows are expected to have the exact same set of keys as the first row.
+
+The headers will be the first row keys, unless you pass an array of keys via `headers`.
+
+All keys are mandatory (although they can have a nil value).
+
+Use the `csv_options` keyword to control the output format like you would do when using [Ruby CSV class](http://ruby-doc.org/stdlib-2.4.0/libdoc/csv/rdoc/CSV.html#method-c-new).
+
+Usage:
+
+```ruby
+require 'kiba-common/destinations/csv'
+
+# by default, the headers will be picked from the first row:
+destination Kiba::Common::Destinations::CSV,
+  filename: 'output.csv'
+
+# if you need a different separator:
+destination Kiba::Common::Destinations::CSV,
+  filename: 'output.csv',
+  csv_options: { col_sep: ';' }
+  
+# to enforce a specific set of headers:
+destination Kiba::Common::Destinations::CSV,
+  filename: 'output.csv',
+  headers: [:field, :other_field]
+```
 
 ### Kiba::Common::DSLExtensions::Logger
 

data/lib/kiba-common/destinations/csv.rb

@@ -0,0 +1,28 @@
+require 'csv'
+
+module Kiba
+  module Common
+    module Destinations
+      class CSV
+        attr_reader :filename, :csv_options, :csv, :headers
+        
+        def initialize(filename:, csv_options: nil, headers: nil)
+          @filename = filename
+          @csv_options = csv_options
+          @headers = headers
+        end
+        
+        def write(row)
+          @csv ||= ::CSV.open(filename, 'wb', csv_options)
+          @headers ||= row.keys
+          @headers_written ||= (csv << headers ; true)
+          csv << row.fetch_values(*@headers)
+        end
+        
+        def close
+          csv&.close
+        end
+      end
+    end
+  end
+end

data/lib/kiba-common/version.rb

@@ -1,5 +1,5 @@
 module Kiba
   module Common
-    VERSION = '0.0.2'
+    VERSION = '0.0.3'
   end
 end

data/test/test_csv_destination.rb

@@ -0,0 +1,48 @@
+require_relative 'helper'
+require 'kiba'
+require 'kiba-common/destinations/csv'
+
+class TestCSVDestination < Minitest::Test
+  TEST_FILENAME = 'output.csv'
+    
+  def teardown
+    File.delete(TEST_FILENAME) if File.exist?(TEST_FILENAME)
+  end
+
+  def run_etl(csv_options: nil, headers: nil)
+    job = Kiba.parse do
+      source TestEnumerableSource, [
+        {name: "world", age: 999}
+      ]
+      destination Kiba::Common::Destinations::CSV,
+        filename: TEST_FILENAME,
+        csv_options: csv_options,
+        headers: headers
+    end
+
+    Kiba.run(job)
+    
+    IO.read(TEST_FILENAME)
+  end
+  
+  def test_classic
+    assert_equal <<~CSV, run_etl
+      name,age
+      world,999
+    CSV
+  end
+  
+  def test_csv_options
+    assert_equal <<~CSV, run_etl(csv_options: {col_sep: ';'})
+      name;age
+      world;999
+    CSV
+  end
+  
+  def test_headers_provided
+    assert_equal <<~CSV, run_etl(headers: [:age])
+      age
+      999
+    CSV
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kiba-common
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Thibaut Barrère
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-20 00:00:00.000000000 Z
+date: 2017-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kiba
@@ -81,12 +81,14 @@ files:
 - README.md
 - Rakefile
 - kiba-common.gemspec
+- lib/kiba-common/destinations/csv.rb
 - lib/kiba-common/dsl_extensions/logger.rb
 - lib/kiba-common/dsl_extensions/show_me.rb
 - lib/kiba-common/version.rb
 - test/helper.rb
 - test/support/assert_called.rb
 - test/support/test_enumerable_source.rb
+- test/test_csv_destination.rb
 - test/test_logger.rb
 - test/test_show_me.rb
 homepage: https://github.com/thbar/kiba-common
@@ -117,5 +119,6 @@ test_files:
 - test/helper.rb
 - test/support/assert_called.rb
 - test/support/test_enumerable_source.rb
+- test/test_csv_destination.rb
 - test/test_logger.rb
 - test/test_show_me.rb