kiba-common 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 962942843b5373cf0f377bb776ab580edfcbe501
-  data.tar.gz: a0edc771a6ea86a13ee6bb8e2860df1aa636aa99
+  metadata.gz: 5153e0740d046e6d86b11e47d1cd36263be8a019
+  data.tar.gz: d9b397babdae819a175ec9aac6d01aae9c46ae4b
 SHA512:
-  metadata.gz: eef3e8b74aa52b60ca3cffac489744bd8d6495ddc73cf45dac2980ead1880ce261fbe294590dec09a31c31104f898268f90a3d170c1515daefe7ecedad12a877
-  data.tar.gz: 3c5d4ef13b423ef3eab9b1132d07c43ed394b2d7b92a5dd0ae87fced7d52c7a8e09dea20ff878f239d14acf6a3082f1e1a53b853f578ef520b73ac3fe5489d3e
+  metadata.gz: c149dd10f8544df9947954e567c3ded033b888825245ff992bdcff0cbf9a4510f933cf0d281b66dc4e35502cbac075bf2196c52a0633e7c69dad9771f0c06dee
+  data.tar.gz: 72a48a33d211f710dc63edeb5faa1513d22994b91e7948168462ea74692a3e4fee1f3d3b3566e8413561d5ee78e3535af3c88b6a52ec9620015d5bb4b5ed563c

data/.gitignore

@@ -0,0 +1,2 @@
+
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,11 @@
+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

data/Changes.md

@@ -0,0 +1,5 @@
+HEAD
+----
+
+- New: Kiba::Common::DSLExtensions::ShowMe (useful to color-print rows during development)
+- New: Kiba::Common::DSLExtensions::Logger (production logging)

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,5 @@
+Copyright (c) LoGeek SARL
+
+Kiba Common is an Open Source project licensed under the terms of
+the LGPLv3 license.  Please see <http://www.gnu.org/licenses/lgpl-3.0.html>
+for license text.

data/README.md

@@ -0,0 +1,64 @@
+Kiba Common is a companion gem to [Kiba](https://github.com/thbar/kiba) and [Kiba Pro](https://github.com/thbar/kiba/blob/master/Pro-Changes.md) in which I'll share commonly used helpers.
+
+Please consider it a work-in-progress for the time being.
+
+In particular, review the changes when updating, until a proper release is ready.
+
+[![Build Status](https://travis-ci.org/thbar/kiba-common.svg?branch=master)](https://travis-ci.org/thbar/kiba-common)
+
+## Usage
+
+**Do not try to use a gem version**. While the name has been [reserved](https://rubygems.org/gems/kiba-common), the gem is not yet published for real. Use git master directly.
+
+## Currently available
+
+### Kiba::Common::DSLExtensions::Logger
+
+A simple logging facility.
+
+Usage:
+
+```ruby
+require 'kiba-common/dsl_extensions/logger'
+extend Kiba::Common::DSLExtensions::Logger
+
+pre_process do
+  logger.info "pre_process is running!"
+end
+```
+
+By default the logger will output to `STDOUT`.
+
+You can customize that behaviour by setting the logger:
+
+```ruby
+require 'kiba-common/dsl_extensions/logger'
+extend Kiba::Common::DSLExtensions::Logger
+
+logger = Logger.new(xxx)
+```
+
+### Kiba::Common::DSLExtensions::ShowMe
+
+A way to color-dump rows on the screen, useful at development time while you are looking at the data (requires the `awesome_print` gem).
+
+Usage:
+
+```ruby
+require 'kiba-common/dsl_extensions/show_me'
+extend Kiba::Common::DSLExtensions::ShowMe
+
+source MySource
+transform MyTransform
+show_me! # will color-print the row at this step of the pipeline
+```
+
+## Contributing & Legal
+
+(agreement below borrowed from Sidekiq Legal)
+
+By submitting a Pull Request, you disavow any rights or claims to any changes submitted to the Kiba Common project and assign the copyright of those changes to LoGeek SARL.
+
+If you cannot or do not want to reassign those rights (your employment contract for your employer may not allow this), you should not submit a PR. Open an issue and someone else can do the work.
+
+This is a legal way of saying "If you submit a PR to us, that code becomes ours". 99.9% of the time that's what you intend anyways; we hope it doesn't scare you away from contributing.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/test_*.rb'
+end
+
+task default: :test

data/kiba-common.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/kiba-common/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Thibaut Barrère']
+  gem.email         = ['thibaut.barrere@gmail.com']
+  gem.description   = gem.summary = 'Commonly used helpers for Kiba ETL'
+  gem.homepage      = 'https://github.com/thbar/kiba-common'
+  gem.license       = 'LGPL-3.0'
+  gem.files         = `git ls-files | grep -Ev '^(examples)'`.split("\n")
+  gem.test_files    = `git ls-files -- test/*`.split("\n")
+  gem.name          = 'kiba-common'
+  gem.require_paths = ['lib']
+  gem.version       = Kiba::Common::VERSION
+
+  gem.add_dependency 'kiba', '~> 1.0.0'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'awesome_print'
+end

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

@@ -0,0 +1,18 @@
+require 'logger'
+
+module Kiba
+  module Common
+    module DSLExtensions
+      # Logging facility for Kiba
+      module Logger
+        def logger=(logger_instance)
+          @logger = logger_instance
+        end
+
+        def logger
+          @logger ||= self.logger = ::Logger.new(STDOUT)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require 'awesome_print'
+
+module Kiba
+  module Common
+    module DSLExtensions
+      # Color print your row.
+      module ShowMe
+        def show_me!
+          transform do |row|
+            # NOTE: invoking Kernel.ap for testing since
+            # ap itself is harder to mock (Kiba Context)
+            Kernel.ap(row)
+            row
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kiba-common/version.rb

@@ -0,0 +1,5 @@
+module Kiba
+  module Common
+    VERSION = '0.0.1'
+  end
+end

data/test/helper.rb

@@ -0,0 +1,5 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require_relative 'support/test_enumerable_source'
+require_relative 'support/assert_called'

data/test/support/assert_called.rb

@@ -0,0 +1,10 @@
+module AssertCalled
+  def assert_called(klass, method, args, return_value = nil)
+    mock = MiniTest::Mock.new
+    mock.expect(:call, return_value, args)
+    klass.stub(method, mock) do
+      yield
+    end
+    mock.verify
+  end
+end

data/test/support/test_enumerable_source.rb

@@ -0,0 +1,11 @@
+class TestEnumerableSource
+  def initialize(enumerable)
+    @enumerable = enumerable
+  end
+
+  def each
+    @enumerable.each do |row|
+      yield row
+    end
+  end
+end

data/test/test_logger.rb

@@ -0,0 +1,30 @@
+require_relative 'helper'
+require 'kiba'
+require 'kiba-common/dsl_extensions/logger'
+
+class TestLogger < Minitest::Test
+  def test_default_logger
+    actual_logger = nil
+    Kiba.parse do
+      extend Kiba::Common::DSLExtensions::Logger
+      actual_logger = logger
+    end
+    assert actual_logger.is_a?(Logger)
+  end
+
+  def test_set_logger
+    buffer = StringIO.new
+
+    job = Kiba.parse do
+      extend Kiba::Common::DSLExtensions::Logger
+      logger = Logger.new(buffer)
+
+      pre_process do
+        logger.info 'Logging from pre_process'
+      end
+    end
+    Kiba.run(job)
+
+    assert_includes buffer.string, 'Logging from pre_process'
+  end
+end

data/test/test_show_me.rb

@@ -0,0 +1,19 @@
+require_relative 'helper'
+require 'kiba'
+require 'kiba-common/dsl_extensions/show_me'
+
+class TestShowMe < Minitest::Test
+  include AssertCalled
+
+  def test_show_me
+    job = Kiba.parse do
+      extend Kiba::Common::DSLExtensions::ShowMe
+      source TestEnumerableSource, ['row']
+      show_me!
+    end
+    
+    assert_called(Kernel, :ap, ['row']) do
+      Kiba.run(job)
+    end
+  end
+end

metadata

@@ -1,23 +1,95 @@
 --- !ruby/object:Gem::Specification
 name: kiba-common
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Thibaut Barrère
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-11 00:00:00.000000000 Z
-dependencies: []
-description: Reserved spot for upcoming Kiba Common releases
+date: 2017-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kiba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Commonly used helpers for Kiba ETL
 email:
 - thibaut.barrere@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
-homepage: http://thbar.github.io/kiba-common/
+files:
+- ".gitignore"
+- ".travis.yml"
+- Changes.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- kiba-common.gemspec
+- 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_logger.rb
+- test/test_show_me.rb
+homepage: https://github.com/thbar/kiba-common
 licenses:
 - LGPL-3.0
 metadata: {}
@@ -37,8 +109,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
-summary: Reserved spot for upcoming Kiba Common releases
-test_files: []
+summary: Commonly used helpers for Kiba ETL
+test_files:
+- test/helper.rb
+- test/support/assert_called.rb
+- test/support/test_enumerable_source.rb
+- test/test_logger.rb
+- test/test_show_me.rb