kiba-legacy-cli 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5573d5c6273b56e3d4a507f1d3af1f1234903930beaf984bb7bf721967c3189f
+  data.tar.gz: 602cb933f8019fd0ffd9eb062012942c9cf1d72287c147cd7e4a6e885c4f4b11
+SHA512:
+  metadata.gz: 5a2ece118cbbaaa743e6b32251a943269b9c958cc0cbd63c9677be33961f8eaa5fc9d68fcd6ee4e83f5a7d1d612558f9a29f43902f19097838dd591ff0e3380e
+  data.tar.gz: 698c66820d75e88156236a14959daf439c6e50f30791b8b78db8331d23d24727ca2626ef9b0c8132a503de0a523221a2fb79500978faf9f407d7eea6b2266558

data/.gitignore

@@ -0,0 +1,57 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+matrix:
+  include:
+    # see https://www.ruby-lang.org/en/downloads/branches/
+    - rvm: ruby-head
+    - rvm: 2.7
+    - rvm: 2.6
+    - rvm: 2.5
+    - rvm: 2.4
+    # NOTE: EOL since 2019-03-31
+    - rvm: 2.3
+    # see https://www.jruby.org/download
+    - rvm: jruby-9.1
+    - rvm: jruby-9.2
+    - rvm: truffleruby
+jdk:
+  - openjdk8

data/Changes.md

@@ -0,0 +1,4 @@
+1.0.0
+-----
+
+- First version

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+# TODO: remove this, once Kiba v3 is published, in favor of a gemspec declaration.
+gem 'kiba', git: 'https://github.com/thbar/kiba.git', branch: 'deprecate-kiba-command-line'

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,5 @@
+This gem provides a `bin/kiba-legacy-cli` command, which mimics the `bin/kiba` (removed in Kiba ETL v3), as described here: 
+
+https://github.com/thbar/kiba/issues/74
+
+`kiba-legacy-cli` is here to temporarily provide backward compatibility for people using the CLI.

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/bin/kiba-legacy-cli

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/kiba-legacy-cli/cli'
+
+Kiba::Legacy::CLI.run(ARGV)

data/kiba-legacy-cli.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/kiba-legacy-cli/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Thibaut Barrère']
+  gem.email         = ['thibaut.barrere@gmail.com']
+  gem.description   = gem.summary = 'Legacy CLI command for Kiba ETL'
+  gem.homepage      = 'https://github.com/thbar/kiba-legacy-cli'
+  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-legacy-cli'
+  gem.require_paths = ['lib']
+  gem.version       = Kiba::Legacy::CLI::VERSION
+  gem.executables   = ['kiba-legacy-cli']
+  gem.metadata      = {
+    'source_code_uri'   => 'https://github.com/thbar/kiba-legacy-cli',
+    'documentation_uri' => 'https://github.com/thbar/kiba-legacy-cli/blob/master/README.md',
+  }
+
+  gem.add_dependency 'kiba', '~> 3.0'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'minitest', '~> 5.9'
+  gem.add_development_dependency 'minitest-focus'
+end

data/lib/kiba-legacy-cli/cli.rb

@@ -0,0 +1,21 @@
+require 'kiba'
+require_relative 'legacy_parser'
+
+module Kiba
+  module Legacy
+    module CLI
+      module_function
+
+      def run(args)
+        unless args.size == 1
+          puts 'Syntax: kiba-legacy-cli your-script.etl'
+          exit(-1)
+        end
+        filename = args[0]
+        script_content = IO.read(filename)
+        job_definition = Kiba::LegacyParser.parse(script_content, filename)
+        Kiba.run(job_definition)
+      end
+    end
+  end
+end

data/lib/kiba-legacy-cli/legacy_parser.rb

@@ -0,0 +1,23 @@
+# NOTE: using the "Kiba::Parser" declaration, as I discovered,
+# provides increased isolation to the declared ETL script, compared
+# to 2 nested modules.
+# Before that, a user creating entities named Control, Context
+# or DSLExtensions would see a conflict with Kiba own classes,
+# as by default instance_eval will resolve references by adding
+# the module containing the parser class (initially "Kiba").
+# Now, the classes appear to be further hidden from the user,
+# as Kiba::Parser is its own module.
+# This allows the user to create a Parser, Context, Control class
+# without it being interpreted as reopening Kiba::Parser, Kiba::Context,
+# etc.
+# See test in test_cli.rb (test_namespace_conflict)
+module Kiba::LegacyParser
+  module_function
+
+  def parse(source_as_string = nil, source_file = nil, &source_as_block)
+    control = Kiba::Control.new
+    context = Kiba::Context.new(control)
+    context.instance_eval(*[source_as_string, source_file].compact)
+    control
+  end
+end

data/lib/kiba-legacy-cli/version.rb

@@ -0,0 +1,7 @@
+module Kiba
+  module Legacy
+    module CLI
+      VERSION = '1.0.0'
+    end
+  end
+end

data/test/fixtures/bogus.etl

@@ -0,0 +1,2 @@
+# this should fail because we have an unknown class
+source UnknownThing

data/test/fixtures/namespace_conflict.etl

@@ -0,0 +1,9 @@
+fail "Context should not be visible without Kiba namespace" if defined?(Context)
+fail "Control should not be visible without Kiba namespace" if defined?(Control)
+fail "Parser should not be visible without Kiba namespace" if defined?(Parser)
+fail "Config should not be visible without Kiba namespace" if defined?(DSLExtensions::Config)
+
+# verify Kiba config (namespaced under Kiba::DSLExtensions::Config)
+# isn't causing troubles to implementers using a top-level DSLExtensions module
+require_relative 'some_extension'
+extend DSLExtensions::SomeExtension

data/test/fixtures/some_extension.rb

@@ -0,0 +1,4 @@
+module DSLExtensions
+  module SomeExtension
+  end
+end

data/test/fixtures/valid.etl

@@ -0,0 +1 @@
+# this does nothing

data/test/helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'minitest/focus'

data/test/test_cli.rb

@@ -0,0 +1,26 @@
+require_relative 'helper'
+require 'kiba-legacy-cli/cli'
+
+class TestCli < Minitest::Test
+  def fixture(file)
+    File.join(File.dirname(__FILE__), 'fixtures', file)
+  end
+
+
+  def test_cli_launches
+    Kiba::Legacy::CLI.run([fixture('valid.etl')])
+  end
+
+  def test_cli_reports_filename_and_lineno
+    exception = assert_raises(NameError) do
+      Kiba::Legacy::CLI.run([fixture('bogus.etl')])
+    end
+
+    assert_match(/uninitialized constant(.*)UnknownThing/, exception.message)
+    assert_includes exception.backtrace.to_s, 'test/fixtures/bogus.etl:2:in'
+  end
+
+  def test_namespace_conflict
+    Kiba::Legacy::CLI.run([fixture('namespace_conflict.etl')])
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: kiba-legacy-cli
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Thibaut Barrère
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kiba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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: '5.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  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: Legacy CLI command for Kiba ETL
+email:
+- thibaut.barrere@gmail.com
+executables:
+- kiba-legacy-cli
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Changes.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/kiba-legacy-cli
+- kiba-legacy-cli.gemspec
+- lib/kiba-legacy-cli/cli.rb
+- lib/kiba-legacy-cli/legacy_parser.rb
+- lib/kiba-legacy-cli/version.rb
+- test/fixtures/bogus.etl
+- test/fixtures/namespace_conflict.etl
+- test/fixtures/some_extension.rb
+- test/fixtures/valid.etl
+- test/helper.rb
+- test/test_cli.rb
+homepage: https://github.com/thbar/kiba-legacy-cli
+licenses:
+- LGPL-3.0
+metadata:
+  source_code_uri: https://github.com/thbar/kiba-legacy-cli
+  documentation_uri: https://github.com/thbar/kiba-legacy-cli/blob/master/README.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Legacy CLI command for Kiba ETL
+test_files:
+- test/fixtures/bogus.etl
+- test/fixtures/namespace_conflict.etl
+- test/fixtures/some_extension.rb
+- test/fixtures/valid.etl
+- test/helper.rb
+- test/test_cli.rb