kiba 2.0.0.rc1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca18859887a38d8eee1afa9ae170ad8fc2a8b63f
-  data.tar.gz: d27a6985d90a1ab73315b4f859bca2e105ba66a7
+  metadata.gz: f048352971676a1a1a3f29e1e2e13b7784a10022
+  data.tar.gz: 04dbac7b41da880e759356186fbf813beff621d6
 SHA512:
-  metadata.gz: dc66fedc5922ee6b63a4cfdd647e71592af3ae8d2851600008a5af0c165252583c1fdf15b064ff691cf19b6ebe004edcf1062fb0091c45f7b2c7e3a5e7e5bc27
-  data.tar.gz: d02d8e6293dbfa6ca2b0372ff36ab3548ef3608ce5554f44ee82a04f1d0a17cbb86838de5745721260a357943c11429012bbd3dbccd59abff08f5b29226f2454
+  metadata.gz: 0bbba96a440dba7fc7a41e2c55a2bd063bf1a8ad71c17c9a8ab9832be5aaa1c07b459c2db340b2adc489cb329f0e91c807fa73ca3442a66cc4c8fc62627627e3
+  data.tar.gz: 79ddd85e029eb1185610a7f2c59b8a39b093bb9ab318d2aae3cdd55e9493e62b724273e126f6681c8aa823e005a6f20ee4cfc07eec834e0671eb412d71978b12

data/Changes.md

@@ -1,5 +1,5 @@
-2.0.0.rc1 (unreleased)
-----------------------
+2.0.0.rc1
+---------
 
 - New (opt-in) StreamingRunner allows class transforms to generate more than one row. See [#44](https://github.com/thbar/kiba/pull/44) for rationale & how to activate.
 - Potentially breaking change if you were using the internal class `Kiba::Parser` directly: ETL jobs parsing has been modified to improve the isolation between the evaluation scope and the Kiba classes. See [#46](https://github.com/thbar/kiba/pull/46) for more information.

data/README.md

@@ -9,9 +9,42 @@ Learn more on the [Wiki](https://github.com/thbar/kiba/wiki), on my [blog](http:
 [![Gem Version](https://badge.fury.io/rb/kiba.svg)](http://badge.fury.io/rb/kiba)
 [![Build Status](https://travis-ci.org/thbar/kiba.svg?branch=master)](https://travis-ci.org/thbar/kiba) [![Build status](https://ci.appveyor.com/api/projects/status/v05jcyhpp1mueq9i?svg=true)](https://ci.appveyor.com/project/thbar/kiba) [![Code Climate](https://codeclimate.com/github/thbar/kiba/badges/gpa.svg)](https://codeclimate.com/github/thbar/kiba) [![Dependency Status](https://gemnasium.com/thbar/kiba.svg)](https://gemnasium.com/thbar/kiba)
 
-## Note on upcoming Kiba 2.0.0
+## Kiba 2.0.0.rc1
 
-Kiba 2.0.0 (available on `master`) includes an improved engine called the `StreamingRunner`, which allows transforms to generate more than one output row for each input row. See [#44](https://github.com/thbar/kiba/pull/44) for documentation on benefits & how to activate.
+Kiba 2.0.0.rc1 (available via `gem install kiba --prerelease`) is available for testing.
+
+### New StreamingRunner engine
+
+Kiba 2 introduces a new, opt-in engine called the `StreamingRunner`, which allows to generate an arbitrary number of rows inside transforms. This drastically improves the reusability & composability of Kiba components (see [#44](https://github.com/thbar/kiba/pull/44) for some background).
+
+To use the `StreamingRunner`, use the following code:
+
+```ruby
+# activate the new Kiba internal config system
+extend Kiba::DSLExtensions::Config
+# opt-in for the new engine
+config :kiba, runner: Kiba::StreamingRunner
+
+# write transform class able to yield an arbitrary number of rows
+class MyYieldingTransform
+  def process(row)
+    yield {key: 1}
+    yield {key: 2}
+    {key: 3}
+  end
+end
+```
+
+The improved runner is compatible with Ruby 2.0+.
+
+### Compatibility with Kiba 1
+
+Kiba 2 is expected to be compatible with existing Kiba scripts as long as you did not use internal API.
+
+Internal changes include:
+
+* An opt-in, Elixir's mix-inspired `config` system, currently only used to select the runner you want at job declaration time
+* A stronger isolation in the `Parser`, to reduces the chances that ETL scripts could conflict with Kiba internal classes
 
 ## Getting Started
 

data/lib/kiba/version.rb

@@ -1,3 +1,3 @@
 module Kiba
-  VERSION = '2.0.0.rc1'
+  VERSION = '2.0.0'
 end

data/test/support/test_duplicate_row_transform.rb

@@ -0,0 +1,9 @@
+class TestDuplicateRowTranform
+  def process(row)
+    2.times do
+      # NOTE: it's a good idea to carefully avoid data reuse between rows
+      yield({item: row.fetch(:item).dup})
+    end
+    nil
+  end
+end

data/test/test_streaming_runner.rb

@@ -2,6 +2,8 @@ require_relative 'helper'
 require_relative 'support/test_enumerable_source'
 require_relative 'support/test_array_destination'
 require_relative 'support/test_yielding_transform'
+require_relative 'support/test_duplicate_row_transform'
+
 require_relative 'common/runner'
 
 class TestStreamingRunner < Kiba::Test
@@ -16,8 +18,15 @@ class TestStreamingRunner < Kiba::Test
 
       config :kiba, runner: Kiba::StreamingRunner
 
+      # provide a single row as the input
       source TestEnumerableSource, [input_row]
+
+      # explode tags in one row each
       transform TestYieldingTransform
+
+      # generate two rows out of each exploded tags row
+      transform TestDuplicateRowTranform
+
       destination TestArrayDestination, destination_array
     end
     
@@ -25,8 +34,15 @@ class TestStreamingRunner < Kiba::Test
   
     assert_equal [
       {item: 'one'},
+      {item: 'one'},
+
+      {item: 'two'},
       {item: 'two'},
+
       {item: 'three'},
+      {item: 'three'},
+
+      {item: 'classic-return-value'},
       {item: 'classic-return-value'}
     ], destination_array
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kiba
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc1
+  version: 2.0.0
 platform: ruby
 authors:
 - Thibaut Barrère
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-27 00:00:00.000000000 Z
+date: 2018-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -104,6 +104,7 @@ files:
 - test/support/test_array_destination.rb
 - test/support/test_csv_destination.rb
 - test/support/test_csv_source.rb
+- test/support/test_duplicate_row_transform.rb
 - test/support/test_enumerable_source.rb
 - test/support/test_rename_field_transform.rb
 - test/support/test_source_that_reads_at_instantiation_time.rb
@@ -129,9 +130,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.14
@@ -149,6 +150,7 @@ test_files:
 - test/support/test_array_destination.rb
 - test/support/test_csv_destination.rb
 - test/support/test_csv_source.rb
+- test/support/test_duplicate_row_transform.rb
 - test/support/test_enumerable_source.rb
 - test/support/test_rename_field_transform.rb
 - test/support/test_source_that_reads_at_instantiation_time.rb