kiba-common 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7823ab2b0363a8fd2a2dd69bd2c70fd75db837ab4a583464e46a330f3c489cbf
-  data.tar.gz: 2e61b3b7aaacfb930bd62f3a5714a86b511f35d4de8ccda71dbab3bc15b747eb
+  metadata.gz: f653d17ff9010ff236b2b77be61db1f3e42f6e2dd4708d39d20eb20e042b9c41
+  data.tar.gz: d441ae590b81d1a3eaa713517263d45c50da5d3cf402621774ee8488adcde5b3
 SHA512:
-  metadata.gz: cdd431a4c090e7e59aea5dfc4ed3320f5643afeeaa729969a960bb8cb9ee35a1a0f77788ee9e1036f386f8cce064ae946330dc0592bce35a9388358bf6dcb39e
-  data.tar.gz: 93900ad025f97f0463f1acaf95bf003ac94cf0a0d49230c4b49c9d77efe23b0dd86e329f92593c970b777e19e98fe563f54028934495d533c3cef453fc33bc4d
+  metadata.gz: f96da2fed54240556aafcb2877c8fd1a23c8c062c92d06cfc4ce4219d64f4131955775e64bd1c98985aca39d92b035645d8139edfead76603ea60daeff516836
+  data.tar.gz: 1fd250ae471dc68cc2d8322434d4d6f75ee661791f1e552604651d808b817b0874ffa788b0c8e70508f61ea90b49626ebe240db6807ac1f4961bf57e95a95719

data/.travis.yml

@@ -1,11 +1,15 @@
 language: ruby
-before_install:
-  # https://stackoverflow.com/a/47972768
-  - gem update --system
-  - gem update bundler
 rvm:
-  - ruby-head
-  - 2.5.0
-  - 2.4.3
-  - 2.3.6
-  - jruby-9.1.15.0
+  # see https://www.ruby-lang.org/en/downloads/branches/
+  # NOTE: temporarily disabled due to failures to be investigated - see #26
+  # - ruby-head
+  - 2.7
+  - 2.6
+  - 2.5
+  - 2.4
+  # NOTE: EOL since 2019-03-31
+  - 2.3
+  # see https://www.jruby.org/download
+  - jruby-9.1
+  - jruby-9.2
+  - truffleruby

data/Changes.md

@@ -1,6 +1,12 @@
 HEAD
 ----
 
+1.0.0
+-----
+
+- Kiba ETL v3 compatibility
+- New: Kiba::Common::Destinations::Lambda lets you write block-form destinations (handy for one-off scripts).
+
 0.9.0
 -----
 

data/README.md

@@ -148,6 +148,14 @@ source Kiba::Common::Sources::CSV, filename: 'input.csv',
   csv_options: { headers: true, header_converters: :symbol }
 ```
 
+Note that the emitted rows are instances of [`CSV::Row`](http://ruby-doc.org/stdlib-2.5.3/libdoc/csv/rdoc/CSV/Row.html), part `Array` and part `Hash`, which retain order of fields and allow duplicates (unlike a regular `Hash`).
+
+If the rest of your pipeline expects `Hash` rows (like for instance `Kiba::Common::Destinations::CSV`), you'll want to transform the rows to `Hash` instances yourself using [`to_hash`](http://ruby-doc.org/stdlib-2.5.3/libdoc/csv/rdoc/CSV/Row.html#method-i-to_hash). This will "collapse the row into a simple Hash. Be warned that this discards field order and clobbers duplicate fields."
+
+```ruby
+transform { |r| r.to_hash }
+```
+
 #### Handling multiple input CSV files
 
 You can process multiple files by chaining the various components available in Kiba Common (see `test/test_integration#test_multiple_csv_inputs` for an actual demo):
@@ -217,6 +225,30 @@ destination Kiba::Common::Destinations::CSV,
   headers: [:field, :other_field]
 ```
 
+### Kiba::Common::Destinations::Lambda
+
+At times, it can be convenient to use a block form for a destination (pretty much like Kiba's built-in "block transform"), especially for one-off scripts.
+
+The Lambda destination is there for that purpose.
+
+Example use:
+
+```ruby
+require 'kiba-common/destinations/lambda'
+
+destination Kiba::Common::Destinations::Lambda,
+  # called at destination instantiation time (once)
+  on_init: -> { ... },
+  # called for each row
+  on_write: -> (row) { ... },
+  # called after all the rows have been written
+  on_close: -> { ... }
+```
+
+Each "callback" (e.g. `on_init`) is optional.
+
+The callback code can refer to scope variables or instance variables you may have declared above.
+
 ### Kiba::Common::DSLExtensions::Logger
 
 A simple logging facility.

data/kiba-common.gemspec

@@ -12,8 +12,12 @@ Gem::Specification.new do |gem|
   gem.name          = 'kiba-common'
   gem.require_paths = ['lib']
   gem.version       = Kiba::Common::VERSION
+  gem.metadata      = {
+    'source_code_uri'   => 'https://github.com/thbar/kiba-common',
+    'documentation_uri' => 'https://github.com/thbar/kiba-common/blob/master/README.md',
+  }
 
-  gem.add_dependency 'kiba', '>= 1.0.0', '< 3'
+  gem.add_dependency 'kiba', '>= 1.0.0', '< 4'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'minitest'
   gem.add_development_dependency 'awesome_print'

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

@@ -0,0 +1,23 @@
+module Kiba
+  module Common
+    module Destinations
+      class Lambda
+        attr_reader :on_write, :on_close
+        
+        def initialize(on_init: nil, on_write: nil, on_close: nil)
+          @on_write = on_write
+          @on_close = on_close
+          on_init&.call
+        end
+
+        def write(row)
+          on_write&.call(row)
+        end
+
+        def close
+          on_close&.call
+        end
+      end
+    end
+  end
+end

data/lib/kiba-common/version.rb

@@ -1,5 +1,5 @@
 module Kiba
   module Common
-    VERSION = '0.9.0'
+    VERSION = '1.0.0'
   end
 end

data/test/test_integration.rb

@@ -25,7 +25,7 @@ class TestIntegration < Minitest::Test
         config :kiba, runner: Kiba::StreamingRunner
 
         # create one row per input file
-        source Kiba::Common::Sources::Enumerable, -> { Dir[File.join(dir, '*.csv')] }
+        source Kiba::Common::Sources::Enumerable, -> { Dir[File.join(dir, '*.csv')].sort }
 
         # out of that row, create configuration for a CSV source
         transform do |r|

data/test/test_lambda_destination.rb

@@ -0,0 +1,22 @@
+require_relative 'helper'
+require 'kiba'
+require 'kiba-common/destinations/lambda'
+
+class TestLambdaDestination < MiniTest::Test
+  def test_lambda
+    accumulator = []
+    on_init_called = false
+    on_close_called = false
+    job = Kiba.parse do
+      source Kiba::Common::Sources::Enumerable, ['one', 'two']
+      destination Kiba::Common::Destinations::Lambda,
+        on_init: -> { on_init_called = true },
+        on_write: -> (r) { accumulator << r },
+        on_close: -> { on_close_called = true }
+    end
+    Kiba.run(job)
+    assert_equal ['one', 'two'], accumulator
+    assert_equal true, on_init_called
+    assert_equal true, on_close_called
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kiba-common
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Thibaut Barrère
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-05 00:00:00.000000000 Z
+date: 2020-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kiba
@@ -19,7 +19,7 @@ dependencies:
         version: 1.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 1.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -102,6 +102,7 @@ files:
 - Rakefile
 - kiba-common.gemspec
 - lib/kiba-common/destinations/csv.rb
+- lib/kiba-common/destinations/lambda.rb
 - lib/kiba-common/dsl_extensions/logger.rb
 - lib/kiba-common/dsl_extensions/show_me.rb
 - lib/kiba-common/sources/csv.rb
@@ -117,13 +118,16 @@ files:
 - test/test_enumerable_exploder_transform.rb
 - test/test_enumerable_source.rb
 - test/test_integration.rb
+- test/test_lambda_destination.rb
 - test/test_logger.rb
 - test/test_show_me.rb
 - test/test_source_transform_adapter.rb
 homepage: https://github.com/thbar/kiba-common
 licenses:
 - LGPL-3.0
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/thbar/kiba-common
+  documentation_uri: https://github.com/thbar/kiba-common/blob/master/README.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -139,8 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Commonly used helpers for Kiba ETL
@@ -153,6 +156,7 @@ test_files:
 - test/test_enumerable_exploder_transform.rb
 - test/test_enumerable_source.rb
 - test/test_integration.rb
+- test/test_lambda_destination.rb
 - test/test_logger.rb
 - test/test_show_me.rb
 - test/test_source_transform_adapter.rb