embulk-parser-fixed 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: de264839a5caf9e90ab09ac915ac9554d2407418
+  data.tar.gz: bf15e9204a7c44c0d97ab63613ddb6984670d751
+SHA512:
+  metadata.gz: e612d874078ca2409fa39503e45cf74d41f2dd183e9f8d69ca6b249de10a767c9f981afd18be651b9c3a2c4b58c064aa7ab0477ed678370cd9a55254d21f6322
+  data.tar.gz: aba8fd7dd76f21e303aabce2edc95b8b5b0ce2da256d7c366136ddca7e838c11b805ed5ae5a259f52119766bab73b54618652d60c06cada2b7b0b2e1f36d6e8d

data/.gitignore

@@ -0,0 +1,5 @@
+*~
+/pkg/
+/tmp/
+/.bundle/
+/Gemfile.lock

data/.ruby-version

@@ -0,0 +1 @@
+jruby-9.1.5.0

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - jruby-9.1.5.0
+jdk:
+  - oraclejdk8
+env:
+  global:
+    - JRUBY_OPTS="-Xcli.debug=true --debug"
+
+gemfile:
+  - gemfiles/embulk-latest
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+[![Build Status](https://travis-ci.org/kakoni/embulk-parser-fixed.svg?branch=master)](https://travis-ci.org/kakoni/embulk-parser-fixed)
+
+# Fixed width parser plugin for Embulk
+
+Fixed width parser. Useful for parsing fixed width format files.
+Can be used to transform `FirstSecond Third` line to `{key: "First", key2: "Second", key3: "Third"}`
+
+## Overview
+
+* **Plugin type**: parser
+* **Guess supported**: no
+
+## Configuration
+
+- **columns**: declares the list of columns, their types and positions as range in input. Values will be assigned to these in order.
+- **strip_whitespace**: Strip whitespace from parsed values. (bool, default: true)
+
+## Example
+
+```yaml
+in:
+  type: any file input plugin type
+  parser:
+    type: unpack
+    columns:
+    - {name: first, type: string, pos: 0..1}
+    - {name: second, type: string, pos: 3..7}
+    - {name: third, type: string, pos: 10..12}
+
+```
+
+## Install plugin
+
+```
+$ embulk gem install embulk-parser-fixed
+```

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+task default: :test
+
+desc "Run tests"
+task :test do
+  ruby("test/run-test.rb", "--use-color=yes")
+end

data/embulk-parser-fixed.gemspec

@@ -0,0 +1,21 @@
+
+Gem::Specification.new do |spec|
+  spec.name          = "embulk-parser-fixed"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Karri Niemel\u{e4}"]
+  spec.summary       = "Fixed width parser plugin for Embulk"
+  spec.description   = "Parses fixed width files read by other file input plugins."
+  spec.email         = ["kakoni@gmail.com"]
+  spec.licenses      = ["MIT"]
+  spec.homepage      = "https://github.com/kakoni/embulk-parser-fixed"
+
+  spec.files         = `git ls-files`.split("\n") + Dir["classpath/*.jar"]
+  spec.test_files    = spec.files.grep(%r{^(test|spec)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'embulk', ['>= 0.8.9']
+  spec.add_development_dependency 'bundler', ['>= 1.10.6']
+  spec.add_development_dependency 'rake', ['>= 10.0']
+  spec.add_development_dependency 'test-unit'
+  spec.add_development_dependency 'test-unit-rr'
+end

data/gemfiles/embulk-latest

@@ -0,0 +1,4 @@
+source 'https://rubygems.org/'
+gemspec :path => '../'
+
+gem "embulk", "~> 0.8.15"

data/lib/embulk/guess/unpack.rb

@@ -0,0 +1,63 @@
+module Embulk
+  module Guess
+
+    # TODO implement guess plugin to make this command work:
+    #      $ embulk guess -g "unpack" partial-config.yml
+    #
+    #      Depending on the file format the plugin uses, you can use choose
+    #      one of binary guess (GuessPlugin), text guess (TextGuessPlugin),
+    #      or line guess (LineGuessPlugin).
+
+    #require "embulk/parser/unpack.rb"
+
+    #class Unpack < GuessPlugin
+    #  Plugin.register_guess("unpack", self)
+    #
+    #  def guess(config, sample_buffer)
+    #    if sample_buffer[0,2] == GZIP_HEADER
+    #      guessed = {}
+    #      guessed["type"] = "unpack"
+    #      guessed["property1"] = "guessed-value"
+    #      return {"parser" => guessed}
+    #    else
+    #      return {}
+    #    end
+    #  end
+    #end
+
+    #class Unpack < TextGuessPlugin
+    #  Plugin.register_guess("unpack", self)
+    #
+    #  def guess_text(config, sample_text)
+    #    js = JSON.parse(sample_text) rescue nil
+    #    if js && js["mykeyword"] == "keyword"
+    #      guessed = {}
+    #      guessed["type"] = "unpack"
+    #      guessed["property1"] = "guessed-value"
+    #      return {"parser" => guessed}
+    #    else
+    #      return {}
+    #    end
+    #  end
+    #end
+
+    #class Unpack < LineGuessPlugin
+    #  Plugin.register_guess("unpack", self)
+    #
+    #  def guess_lines(config, sample_lines)
+    #    all_line_matched = sample_lines.all? do |line|
+    #      line =~ /mypattern/
+    #    end
+    #    if all_line_matched
+    #      guessed = {}
+    #      guessed["type"] = "unpack"
+    #      guessed["property1"] = "guessed-value"
+    #      return {"parser" => guessed}
+    #    else
+    #      return {}
+    #    end
+    #  end
+    #end
+
+  end
+end

data/lib/embulk/parser/fixed.rb

@@ -0,0 +1,58 @@
+module Embulk
+  module Parser
+
+    class Fixed < ParserPlugin
+      Plugin.register_parser("fixed", self)
+
+      def self.transaction(config, &control)
+        decoder_task = config.load_config(Java::LineDecoder::DecoderTask)
+
+        # configuration code:
+        task = {
+          "decoder" => DataSource.from_java(decoder_task.dump),
+          "schema" => config.param("columns", :array, default: []),
+          "strip_whitespace" => config.param("strip_whitespace", :bool, default: true)
+        }
+
+        columns = []
+        task["schema"].each do |column|
+          name = column["name"]
+          type = column["type"].to_sym
+          columns << Column.new(nil, name, type)
+        end
+
+        yield(task, columns)
+      end
+
+      def init
+        @decoder = task.param("decoder", :hash).load_task(Java::LineDecoder::DecoderTask)
+        @schema = @task["schema"]
+        @strip_whitespace = task["strip_whitespace"]
+      end
+
+
+      def run(file_input)
+        decoder = Java::LineDecoder.new(file_input.to_java, @decoder)
+        while decoder.nextFile
+          while line = decoder.poll
+            process_line(line)
+          end
+        end
+
+        page_builder.finish
+      end
+
+      private
+
+      def process_line(line)
+        values = @schema.map do |column|
+          range = Range.new(*column["pos"].split("..").map(&:to_i)) if column["pos"]
+          val = line.slice(range)
+          val.strip if @strip_whitespace
+        end
+        page_builder.add(values)
+      end
+
+    end
+  end
+end

data/test/capture_io.rb

@@ -0,0 +1,45 @@
+module CaptureIo
+  def capture(output = :out, &block)
+    _, out = swap_io(output, &block)
+    out
+  end
+
+  def silence(&block)
+    block_result = nil
+    swap_io(:out) do
+      block_result,_ = swap_io(:err, &block)
+    end
+    block_result
+  end
+
+  def swap_io(output = :out, &block)
+    java_import 'java.io.PrintStream'
+    java_import 'java.io.ByteArrayOutputStream'
+    java_import 'java.lang.System'
+
+    ruby_original_stream = output == :out ? $stdout.dup : $stderr.dup
+    java_original_stream = System.send(output) # :out or :err
+    ruby_buf = StringIO.new
+    java_buf = ByteArrayOutputStream.new
+
+    case output
+    when :out
+      $stdout = ruby_buf
+      System.setOut(PrintStream.new(java_buf))
+    when :err
+      $stderr = ruby_buf
+      System.setErr(PrintStream.new(java_buf))
+    end
+
+    [block.call, ruby_buf.string + java_buf.toString]
+  ensure
+    case output
+    when :out
+      $stdout = ruby_original_stream
+      System.setOut(java_original_stream)
+    when :err
+      $stderr = ruby_original_stream
+      System.setErr(java_original_stream)
+    end
+  end
+end

data/test/embulk/parser/test_fixed.rb

@@ -0,0 +1,52 @@
+require "prepare_embulk"
+require "embulk/parser/fixed"
+require "embulk/data_source"
+
+
+module Embulk
+  module Parser
+    class FixedTest < Test::Unit::TestCase
+
+      class TestProcessLine < self
+
+        def test_foo
+          mock(page_builder).add(["eka", "Toka", "Kolmas", "Neljas"])
+          line = "ekaTokaKolmas Neljas"
+          plugin.send(:process_line, line)
+        end
+
+        def plugin
+         @plugin ||= Fixed.new(DataSource[task], schema, page_builder)
+        end
+
+        def page_builder
+          @page_builder ||= Object.new
+        end
+
+        def task
+          {
+            "decoder" => {"Charset" => "UTF-8", "Newline" => "CRLF"},
+            "schema" => columns,
+            "strip_whitespace" => true,
+          }
+        end
+
+        def columns
+          [
+            {"name" => "foo", "type" => :string, "pos" => "0..2"},
+            {"name" => "bar", "type" => :string, "pos" => "3..6"},
+            {"name" => "baz", "type" => :string, "pos" => "7..12"},
+            {"name" => "qux", "type" => :string, "pos" => "14..19"},
+          ]
+        end
+
+        def schema
+          columns.map do |column|
+            Column.new(nil, column["name"], column["type"].to_sym)
+          end
+        end
+
+      end
+    end
+  end
+end

data/test/embulk_run_helper.rb

@@ -0,0 +1,19 @@
+require "capture_io"
+
+module EmbulkRunHelper
+  include CaptureIo
+
+  def embulk_guess(seed_path, dest_path)
+    silence do
+      embulk_exec(%W(guess -g query_string #{seed_path} -o #{dest_path}))
+    end
+  end
+
+  def embulk_run(yaml_path)
+    embulk_exec(%W(run #{yaml_path}))
+  end
+
+  def embulk_exec(cli_options = [])
+    Embulk.run(cli_options)
+  end
+end

data/test/prepare_embulk.rb

@@ -0,0 +1,5 @@
+require "embulk"
+
+Embulk.setup
+
+require "embulk/command/embulk_run"

data/test/run-test.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+base_dir = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+lib_dir = File.join(base_dir, "lib")
+test_dir = File.join(base_dir, "test")
+
+require "test-unit"
+require "test/unit/rr"
+
+$LOAD_PATH.unshift(lib_dir)
+$LOAD_PATH.unshift(test_dir)
+
+ENV["TEST_UNIT_MAX_DIFF_TARGET_STRING_SIZE"] ||= "5000"
+
+exit Test::Unit::AutoRunner.run(true, test_dir, ARGV + %w(--collector=dir))

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: embulk-parser-fixed
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Karri Niemelä
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.9
+  name: embulk
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.9
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.6
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.6
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: test-unit
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: test-unit-rr
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Parses fixed width files read by other file input plugins.
+email:
+- kakoni@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- embulk-parser-fixed.gemspec
+- gemfiles/embulk-latest
+- lib/embulk/guess/unpack.rb
+- lib/embulk/parser/fixed.rb
+- test/capture_io.rb
+- test/embulk/parser/test_fixed.rb
+- test/embulk_run_helper.rb
+- test/prepare_embulk.rb
+- test/run-test.rb
+homepage: https://github.com/kakoni/embulk-parser-fixed
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project:
+rubygems_version: 2.6.6
+signing_key:
+specification_version: 4
+summary: Fixed width parser plugin for Embulk
+test_files:
+- test/capture_io.rb
+- test/embulk/parser/test_fixed.rb
+- test/embulk_run_helper.rb
+- test/prepare_embulk.rb
+- test/run-test.rb