kiba-common 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f653d17ff9010ff236b2b77be61db1f3e42f6e2dd4708d39d20eb20e042b9c41
-  data.tar.gz: d441ae590b81d1a3eaa713517263d45c50da5d3cf402621774ee8488adcde5b3
+  metadata.gz: 636c082d2dbe3688c83549cf4f915c0b9463fbeb41aff8694369cd9c663778e0
+  data.tar.gz: aa732416381545e039c227bc99a4cf49592338157f0094fc2083828d492d630a
 SHA512:
-  metadata.gz: f96da2fed54240556aafcb2877c8fd1a23c8c062c92d06cfc4ce4219d64f4131955775e64bd1c98985aca39d92b035645d8139edfead76603ea60daeff516836
-  data.tar.gz: 1fd250ae471dc68cc2d8322434d4d6f75ee661791f1e552604651d808b817b0874ffa788b0c8e70508f61ea90b49626ebe240db6807ac1f4961bf57e95a95719
+  metadata.gz: eac14c3a878f2f4bd70b93dfe33391abaec9cbad3d00917d3dc8d11024a9d7ed5300468145648ba3443d2fe1387ff31a12314d3f1f50debdb2335293a377006d
+  data.tar.gz: 2da4e3f3f2444bcecad2f1bb13b975f3a3551a3c568da1b27729dd7cd98ac6a880587a0284d204440c3b177082771e4a5a122abc6f361fa38869a1f5a2739643

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: thbar

data/.travis.yml

@@ -1,8 +1,7 @@
 language: ruby
 rvm:
   # see https://www.ruby-lang.org/en/downloads/branches/
-  # NOTE: temporarily disabled due to failures to be investigated - see #26
-  # - ruby-head
+  - ruby-head
   - 2.7
   - 2.6
   - 2.5
@@ -13,3 +12,6 @@ rvm:
   - jruby-9.1
   - jruby-9.2
   - truffleruby
+# Freezing the JDK to provide some consistency between CI builds only.
+jdk:
+  - openjdk8

data/Changes.md

@@ -1,6 +1,28 @@
-HEAD
+1.1.0
 ----
 
+- Support for Ruby 2.7+ (affects CSV source and destination)
+- Breaking: `show_me!` is now compatible with both `awesome_print` and its modern replacement `amazing_print`. You will have to `require` the one you want to use in your code from now on.
+- Breaking: `SourceTransformAdapter` has been removed due to complexities with Ruby 2.7+ keyword arguments. The suggested replacement is to use `Enumerator` and `EnumerableExploder` like this:
+
+```ruby
+# before
+transform SourceTransformAdapter
+
+# after
+transform do |klass, args|
+  Enumerator.new do |y|
+    # NOTE: you may have to use double-splat (**) here instead
+    # if you provide keyword arguments, or other variants
+    klass.new(*args).each do |r|
+      y << r
+    end
+  end
+end
+
+transform Kiba::Common::Transforms::EnumerableExploder
+```
+
 1.0.0
 -----
 

data/README.md

@@ -277,7 +277,7 @@ logger = Logger.new(xxx)
 
 ### Kiba::Common::DSLExtensions::ShowMe
 
-A way to color-dump rows on the screen, useful during development when you are inspecting the data (requires the `awesome_print` gem).
+A way to color-dump rows on the screen, useful during development when you are inspecting the data (requires either the `amazing_print` or the `awesome_print` gem).
 
 Usage:
 

data/kiba-common.gemspec

@@ -20,6 +20,6 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'kiba', '>= 1.0.0', '< 4'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'minitest'
-  gem.add_development_dependency 'awesome_print'
+  gem.add_development_dependency 'amazing_print'
   gem.add_development_dependency 'minitest-focus'
 end

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

@@ -13,7 +13,7 @@ module Kiba
         end
         
         def write(row)
-          @csv ||= ::CSV.open(filename, 'wb', csv_options)
+          @csv ||= ::CSV.open(filename, 'wb', **csv_options)
           @headers ||= row.keys
           @headers_written ||= (csv << headers ; true)
           csv << row.fetch_values(*@headers)

data/lib/kiba-common/dsl_extensions/show_me.rb

@@ -1,5 +1,3 @@
-require 'awesome_print'
-
 module Kiba
   module Common
     module DSLExtensions

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

@@ -12,7 +12,7 @@ module Kiba
         end
 
         def each
-          ::CSV.foreach(filename, csv_options) do |row|
+          ::CSV.foreach(filename, **csv_options) do |row|
             yield row
           end
         end

data/lib/kiba-common/version.rb

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

data/test/support/test_hash_configured_object.rb

@@ -0,0 +1,9 @@
+class TestHashConfiguredObject
+  def initialize(config)
+    @config = config
+  end
+  
+  def each
+    yield(@config)
+  end
+end

data/test/support/test_keyword_proxy_source.rb

@@ -0,0 +1,13 @@
+class TestKeywordProxySource
+  def initialize(mandatory:, optional: nil)
+    @mandatory = mandatory
+    @optional = optional
+  end
+  
+  def each
+    yield({
+      mandatory: @mandatory,
+      optional: @optional
+    })
+  end
+end

data/test/test_csv_source.rb

@@ -18,10 +18,10 @@ class TestCSVSource < MiniTest::Test
     FileUtils.rm(TEST_FILENAME) if File.exist?(TEST_FILENAME)
   end
 
-  def run_job(*args)
+  def run_job(args)
     rows = []
     job = Kiba.parse do
-      source Kiba::Common::Sources::CSV, *args
+      source Kiba::Common::Sources::CSV, **args
       destination TestArrayDestination, rows
     end
     Kiba.run(job)

data/test/test_integration.rb

@@ -1,7 +1,6 @@
 require_relative 'helper'
 require 'kiba'
 require_relative 'support/test_array_destination'
-require 'kiba-common/transforms/source_transform_adapter'
 require 'kiba-common/sources/csv'
 require 'kiba-common/destinations/csv'
 
@@ -36,9 +35,15 @@ class TestIntegration < Minitest::Test
           ]
         end
 
-        # instantiate & yield CSV rows for each configuration
-        transform Kiba::Common::Transforms::SourceTransformAdapter
-
+        transform do |klass, args|
+          Enumerator.new do |y|
+            klass.new(**args).each do |r|
+              y << r
+            end
+          end
+        end
+        transform Kiba::Common::Transforms::EnumerableExploder
+ 
         destination TestArrayDestination, rows
       end
       Kiba.run(job)

data/test/test_show_me.rb

@@ -1,5 +1,6 @@
 require_relative 'helper'
 require 'kiba'
+require 'amazing_print'
 require 'kiba-common/dsl_extensions/show_me'
 
 class TestShowMe < Minitest::Test

data/test/test_source_transform_adapter.rb

@@ -1,6 +1,11 @@
 require_relative 'helper'
-require 'kiba-common/transforms/source_transform_adapter'
+require_relative 'support/test_keyword_proxy_source'
+require_relative 'support/test_hash_configured_object'
 
+# NOTE: the SourceTransformAdapter has been removed,
+# but I'm keeping these tests, patched to instead use
+# Enumerator, as a way to verify that the alternative
+# I provided in the change log still works.
 class TestSourceTransformAdapter < Minitest::Test
   include Kiba::Common::Sources
   include Kiba::DSLExtensions
@@ -15,10 +20,69 @@ class TestSourceTransformAdapter < Minitest::Test
         [ Enumerable, (1..10) ],
         [ Enumerable, (11..20) ]
       ]
-      transform Kiba::Common::Transforms::SourceTransformAdapter
+
+      transform do |klass, args|
+        Enumerator.new do |y|
+          klass.new(args).each do |r|
+            y << r
+          end
+        end
+      end
+      transform Kiba::Common::Transforms::EnumerableExploder
+
       destination TestArrayDestination, rows
     end
     Kiba.run(job)
     assert_equal (1..20).to_a, rows
   end
-end
+  
+  def test_instantiation_keyword_arguments
+    rows = []
+    job = Kiba.parse do
+      source Enumerable, [
+        # Test against a class that expects explicit keyword arguments
+        [ TestKeywordProxySource, {mandatory: "some value"} ]
+      ]
+
+      transform do |klass, args|
+        Enumerator.new do |y|
+          klass.new(**args).each do |r|
+            y << r
+          end
+        end
+      end
+      transform Kiba::Common::Transforms::EnumerableExploder
+
+      destination TestArrayDestination, rows
+    end
+    Kiba.run(job)
+    assert_equal([
+      {mandatory: "some value", optional: nil}
+    ], rows)
+  end
+  
+  def test_hash_configured_object
+    rows = []
+    job = Kiba.parse do
+      source Enumerable, [
+        # Test against a class that takes a single Hash argument
+        [ TestHashConfiguredObject, {mandatory: "some value"} ]
+      ]
+
+      transform do |klass, args|
+        Enumerator.new do |y|
+          klass.new(**args).each do |r|
+            y << r
+          end
+        end
+      end
+      transform Kiba::Common::Transforms::EnumerableExploder
+
+      destination TestArrayDestination, rows
+    end
+    Kiba.run(job)
+    assert_equal([
+      {mandatory: "some value"}
+    ], rows)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kiba-common
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Thibaut Barrère
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-18 00:00:00.000000000 Z
+date: 2020-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kiba
@@ -59,7 +59,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: amazing_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -93,6 +93,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".gitignore"
 - ".travis.yml"
 - Changes.md
@@ -108,11 +109,12 @@ files:
 - lib/kiba-common/sources/csv.rb
 - lib/kiba-common/sources/enumerable.rb
 - lib/kiba-common/transforms/enumerable_exploder.rb
-- lib/kiba-common/transforms/source_transform_adapter.rb
 - lib/kiba-common/version.rb
 - test/helper.rb
 - test/support/assert_called.rb
 - test/support/test_array_destination.rb
+- test/support/test_hash_configured_object.rb
+- test/support/test_keyword_proxy_source.rb
 - test/test_csv_destination.rb
 - test/test_csv_source.rb
 - test/test_enumerable_exploder_transform.rb
@@ -128,7 +130,7 @@ licenses:
 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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -143,14 +145,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Commonly used helpers for Kiba ETL
 test_files:
 - test/helper.rb
 - test/support/assert_called.rb
 - test/support/test_array_destination.rb
+- test/support/test_hash_configured_object.rb
+- test/support/test_keyword_proxy_source.rb
 - test/test_csv_destination.rb
 - test/test_csv_source.rb
 - test/test_enumerable_exploder_transform.rb

data/lib/kiba-common/transforms/source_transform_adapter.rb

@@ -1,14 +0,0 @@
-module Kiba
-  module Common
-    module Transforms
-      class SourceTransformAdapter
-        def process(args)
-          args.shift.new(*args).each do |row|
-            yield(row)
-          end
-          nil
-        end
-      end
-    end
-  end
-end