haecksler 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7fac756e6245151603f1454fb9384c64cbe57ed0
+  data.tar.gz: 3429e573e1d61c725bdc051273ca7337e166eb9e
+SHA512:
+  metadata.gz: 3a4acbbd1ae9b6ac447d0fa18675617e84392f64a2b6d0b9f24d6499fe6b5d4376d236b59de1af87094c1aab05d48203f673172525ee56d3f48952418d407e47
+  data.tar.gz: 8afb2a948a53866943cccb6f201d6850ae947f43d4584903af9f4c8c86b73c6aba57f64d9251a0a62033965972cddef6990e10399e88c34ea439ddef2d34a0fb

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.0.0
+  - jruby-head

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in haecksler.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Frank Falkenberg
+
+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,51 @@
+# Haecksler
+
+[![Code Climate](https://codeclimate.com/github/falti/haecksler.png)](https://codeclimate.com/github/falti/haecksler)
+[![Build Status](https://travis-ci.org/falti/haecksler.svg?branch=master)](https://travis-ci.org/falti/haecksler)
+[![Dependency Status](https://gemnasium.com/falti/haecksler.svg)](https://gemnasium.com/falti/haecksler)
+
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'haecksler'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install haecksler
+
+## Usage
+
+```ruby
+file = File.open(File.expand_path("../complete.txt",__FILE__))
+
+result = Haecksler.chop(file) do |h|
+
+  h.header_trap {|header| header =~/^FILE/ }
+  h.header "HName", 4
+  h.header "HExtra", 6
+
+  h.column "Id", 2, :integer
+  h.column "Name", 10
+  h.column "Date", 8, :date
+
+  h.footer_trap {|footer| footer =~/^END/ }
+  h.footer "FFooter", 3
+  h.footer "FDate", 8, :date
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/haecksler/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/haecksler.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'haecksler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "haecksler"
+  spec.version       = Haecksler::VERSION
+  spec.authors       = ["Frank Falkenberg"]
+  spec.email         = ["faltibrain@gmail.com"]
+  spec.summary       = %q{Library to parse fixed-length files}
+  spec.description   = %q{Haecksler is the German word for a wood chipper}
+  spec.homepage      = "https://github.com/falti/haecksler"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", '~> 2.14'
+end

data/lib/haecksler.rb

@@ -0,0 +1,5 @@
+require "haecksler/version"
+require "haecksler/column"
+require "haecksler/row"
+require "haecksler/sheet"
+require "haecksler/dsl"

data/lib/haecksler/column.rb

@@ -0,0 +1,70 @@
+require 'delegate'
+require 'date'
+
+module Haecksler
+
+  class TypeError
+    attr_reader :value, :type
+
+    def initialize(value, column)
+      @value = value
+      @type = column.type
+    end
+
+    def to_s
+      "Could not parse '#{value}' to '#{type}"
+    end
+
+  end
+
+  class ParsedColumn < SimpleDelegator
+    attr_accessor :value
+  end
+
+  class Column
+    attr_reader :name, :size, :type, :date_format
+
+    DEFAULT_OPTIONS={type: :string, date_format: nil}
+
+    def initialize(options = {type: :string})
+      options = DEFAULT_OPTIONS.merge(options)
+      @name = options[:name]
+      @size = options[:size]
+      @type = options[:type]
+      @date_format = options[:date_format]
+    end
+
+    def parse(string_value)
+      parsed = ParsedColumn.new(self)
+
+      parsed.value = begin
+        case type
+        when :string
+          String(string_value).rstrip
+        when :integer
+          Integer(string_value)
+        when :float
+          Float(string_value)
+        when :date
+          if date_format.nil?
+            Date.parse(string_value)
+          else
+            Date.strptime(string_value, date_format)
+          end
+        when :datetime
+          if date_format.nil?
+            DateTime.parse(string_value)
+          else
+            DateTime.strptime(string_value, date_format)
+          end
+        else
+          nil
+        end
+      rescue
+        TypeError.new(string_value, self)
+      end
+
+      parsed
+    end
+  end
+end

data/lib/haecksler/dsl.rb

@@ -0,0 +1,62 @@
+module Haecksler
+
+  def self.chop(input)
+    dsl = Dsl.new.chop(input)
+    yield dsl
+    dsl.parse!
+  end
+
+  class Dsl
+
+    def chop(input)
+      @input = input
+      @row = Row.new
+      @header_check = proc { false }
+      @header = false
+      @footer_check = proc { false }
+      @footer = false
+      self
+    end
+
+    def column(name, size, type=:string, date_format=nil)
+      @row << _column(name, size, type, date_format)
+    end
+
+    def header_trap(&proc)
+      @header_check = proc
+    end
+
+    def footer_trap(&proc)
+      @footer_check = proc
+    end
+
+    def header(name, size, type=:string, date_format=nil)
+      @header ||= HeaderRow.new
+      @header << _column(name, size, type, date_format)
+    end
+
+    def footer(name, size, type=:string, date_format=nil)
+      @footer ||= FooterRow.new
+      @footer << _column(name, size, type, date_format)
+    end
+
+    def parse!
+      Sheet.new(@input, {
+        row: @row,
+        header_check: @header_check,
+        header: @header,
+        footer_check: @footer_check,
+        footer: @footer}
+      )
+    end
+
+    private
+    def _column(name, size, type, date_format)
+      Column.new({name: name, size: size, type: type, date_format: date_format})
+    end
+
+
+
+  end
+
+end

data/lib/haecksler/row.rb

@@ -0,0 +1,62 @@
+module Haecksler
+
+  class Row
+    attr_reader :columns
+
+    def initialize(columns = [])
+      @columns = columns
+    end
+
+    def <<(column)
+      @columns << column
+    end
+
+    def [](key)
+      begin
+        @columns.find{|c| c.name == key }.value
+      rescue
+        nil
+      end
+    end
+
+    def parse(input)
+
+      indizes = columns.map(&:size).reduce([0]) do |memo,item|
+        memo << (memo.last.to_i + item)
+        memo
+      end
+
+      slices = input.split(//).each_with_index.slice_before { | element | indizes.include? element[1] }
+
+      parsed_columns = slices.map {|slice| slice.map{|i| i[0]}.join("")}.zip(columns).map do |text, column|
+        column.parse(text)
+      end
+
+      @columns = parsed_columns
+
+      self
+
+    end
+
+    def header?
+      false
+    end
+
+    def footer?
+      false
+    end
+  end
+
+  class HeaderRow < Row
+    def header?
+      true
+    end
+  end
+
+  class FooterRow < Row
+    def footer?
+      true
+    end
+  end
+
+end

data/lib/haecksler/sheet.rb

@@ -0,0 +1,32 @@
+module Haecksler
+  class Sheet
+    include Enumerable
+
+    attr_reader :row
+
+    DEFAULT_OPTIONS={ header: false, footer: false, header_check: proc{ false }, footer_check: proc{ false } }
+
+    def initialize(input, options={})
+      options = DEFAULT_OPTIONS.merge(options)
+      @header = options[:header]
+      @footer = options[:footer]
+      @row    = options[:row]
+      @input  = input
+      @header_check = options[:header_check]
+      @footer_check = options[:footer_check]
+    end
+
+    def each
+      @input.lazy.each do |input|
+        if @header_check.call(input)
+          yield @header.parse(input.chomp)
+        elsif @footer_check.call(input)
+          yield @footer.parse(input.chomp)
+        else
+          yield @row.parse(input.chomp)
+        end
+      end
+    end
+
+  end
+end

data/lib/haecksler/version.rb

@@ -0,0 +1,3 @@
+module Haecksler
+  VERSION = "0.0.1"
+end

data/spec/column_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+module Haecksler
+  describe Column do
+    describe "a string column" do
+      subject do
+        Column.new(name: "First Name", size: 10, type: :string )
+      end
+      it "should require all options to be set" do
+        expect(subject).to be_a Column
+      end
+
+      it "should parse a string column" do
+        parsed = subject.parse("Frank")
+        expect(parsed).to be_a ParsedColumn
+        expect(parsed.name).to eq("First Name")
+        expect(parsed.value).to eq "Frank"
+      end
+
+      it "should trim trailing whitespace" do
+        expect(subject.parse("Frank     ").value).to eq "Frank"
+      end
+
+      it "should keep leading whitespace" do
+        expect(subject.parse(" Frank    ").value).to eq " Frank"
+      end
+
+    end
+
+    describe "Integer column" do
+
+      subject do
+        Column.new(name: "I1", size: 2, type: :integer)
+      end
+
+      it "should handle integer column" do
+        expect(subject.parse("2 ").value).to eq 2
+        expect(subject.parse(" 2").value).to eq 2
+        expect(subject.parse("02").value).to eq 2
+      end
+
+      it "should yield a TypeError for wrong type column" do
+        expect(subject.parse("x ").value).to be_a TypeError
+      end
+
+    end
+
+    describe "Float column" do
+      subject do
+        Column.new(name: "I1", size: 3, type: :float)
+      end
+      it "should handle double column" do
+        expect(subject.parse("2  ").value).to eq 2.0
+        expect(subject.parse("2.0").value).to eq 2.0
+        expect(subject.parse("02").value).to eq 2.0
+      end
+
+      it "should yield a TypeError for wrong type column" do
+        expect(subject.parse("x  ").value).to be_a TypeError
+      end
+    end
+
+    describe "Date column" do
+      subject do
+        Column.new(name: "I1", size: 8, type: :date)
+      end
+
+      it "should handle date column" do
+        expect(subject.parse("20130304").value).to eq Date.new(2013,3,4)
+      end
+
+      it "should respect date format" do
+        c = Column.new(name:"I2", size: 10, type: :date, date_format: '%d.%m.%Y')
+        expect(c.parse("03.12.2008").value).to eq Date.new(2008,12,3)
+      end
+    end
+
+    describe "DateTime column" do
+      subject do
+        Column.new(name: "I1", size: 8, type: :datetime)
+      end
+
+      it "should handle date column" do
+        expect(subject.parse("20130304").value).to eq DateTime.new(2013,3,4)
+      end
+
+    end
+
+  end
+end

data/spec/complete.txt

@@ -0,0 +1,4 @@
+FILESample
+01Fränk     20080305
+02Sam       20091205
+END20140910

data/spec/dsl_spec.rb

@@ -0,0 +1,87 @@
+require "spec_helper"
+
+module Haecksler
+
+  describe Haecksler do
+
+    before(:each) do
+      @data = [
+        "01Frank     20080305",
+        "02Sam       20091205"
+      ]
+    end
+
+    it "should work without header/footer" do
+
+      result = Haecksler.chop(@data) do |h|
+        h.column "Id", 2, :integer
+        h.column "Name", 10
+        h.column "Date", 8, :date
+      end
+
+      expect(result.first["Name"]).to eq "Frank"
+    end
+
+    it "should work with header" do
+
+      @data.unshift("HEADER01")
+      result = Haecksler.chop(@data) do |h|
+        h.header_trap {|header| header =~/^HEADER/ }
+        h.header "HName", 6
+        h.header "SomeNumber", 2, :integer
+        h.column "Id", 2, :integer
+        h.column "Name", 10
+        h.column "Date", 8, :date
+      end
+      header = result.first
+
+      expect(header["HName"]).to eq "HEADER"
+      expect(header["SomeNumber"]).to eq 1
+    end
+
+    it "should work with footer" do
+      @data << "FOOTER02"
+      result = Haecksler.chop(@data) do |h|
+        h.footer_trap {|footer| footer =~/^FOOTER/ }
+        h.footer "footer", 6
+        h.footer "SomeNumber", 2, :integer
+        h.column "Id", 2, :integer
+        h.column "Name", 10
+        h.column "Date", 8, :date
+      end
+
+      footer = result.to_a.last
+      expect(footer["footer"]).to eq "FOOTER"
+      expect(footer["SomeNumber"]).to eq 2
+    end
+
+    it "should work on full sample" do
+      file = File.open(File.expand_path("../complete.txt",__FILE__))
+
+      result = Haecksler.chop(file) do |h|
+
+        h.header_trap {|header| header =~/^FILE/ }
+        h.header "HName", 4
+        h.header "HExtra", 6
+
+        h.column "Id", 2, :integer
+        h.column "Name", 10
+        h.column "Date", 8, :date
+
+        h.footer_trap {|footer| footer =~/^END/ }
+        h.footer "FFooter", 3
+        h.footer "FDate", 8, :date
+      end.to_a
+
+
+      expect(result[0]).to be_a HeaderRow
+      expect(result[1]).to be_a Row
+      expect(result[2]).to be_a Row
+      expect(result[3]).to be_a FooterRow
+
+
+    end
+
+
+  end
+end

data/spec/row_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+module Haecksler
+  describe Row do
+    it "should initialize with empty columns" do
+      expect(subject.columns).to have(0).things
+    end
+
+    it "should not be header or footer" do
+      expect(subject).not_to be_header
+      expect(subject).not_to be_footer
+    end
+
+    it "should receive more columns" do
+      subject << Column.new(name: "Name", size: 10)
+      expect(subject.columns).to have(1).thing
+      subject << Column.new(name: "Id", size: 2)
+    end
+
+    it "should parse a row" do
+      subject << Column.new(name: "Name", size: 10)
+      subject << Column.new(name: "Id",   size: 2)
+
+      parsed_result = subject.parse("Frank     AB")
+
+      expect(parsed_result.columns).to have(2).things
+
+      expect(parsed_result.columns.first.value).to eq "Frank"
+      expect(parsed_result.columns.last.value).to eq "AB"
+    end
+
+    it "should parse a row with UTF" do
+      subject << Column.new(name: "Name", size: 10)
+      subject << Column.new(name: "Id",   size: 2)
+
+      parsed_result = subject.parse("Fränk     €B")
+
+      expect(parsed_result.columns).to have(2).things
+
+      expect(parsed_result.columns.first.value).to eq "Fränk"
+      expect(parsed_result.columns.last.value).to eq "€B"
+
+    end
+
+    it "should have Hash like access" do
+      subject << Column.new(name: "Name", size: 3)
+      parsed_result = subject.parse("ABC")
+      expect(parsed_result["Name"]).to eq("ABC")
+    end
+
+    it "should return nil for unknown key" do
+      subject << Column.new(name: "Name", size: 3)
+      parsed_result = subject.parse("ABC")
+      expect(parsed_result["Unknown"]).to be_nil
+    end
+
+  end
+
+  describe HeaderRow do
+    it "should behave as header" do
+      expect(subject).to be_header
+      expect(subject).not_to be_footer
+    end
+  end
+
+  describe FooterRow do
+    it "should behave as footer" do
+      expect(subject).not_to be_header
+      expect(subject).to be_footer
+    end
+  end
+end

data/spec/sheet_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+module Haecksler
+  describe Sheet do
+    before(:each) do
+      @data = [
+        "01Frank     20080305",
+        "02Sam       20091205"
+      ]
+      @row = Row.new
+      @row << Column.new(name: "Id", size: 2, type: :integer)
+      @row << Column.new(name: "Name", size: 10)
+      @row << Column.new(name: "Date", size: 8, type: :date)
+    end
+
+    it "should parse some array" do
+      expect(Sheet.new(@data, row: @row)).to have(2).things
+    end
+
+    it "should parse with header" do
+      @data = ["HEADER1"] + @data
+      header_row = Row.new
+      header_row << Column.new(name: "f1", size: 6)
+      header_row << Column.new(name: "f2", size: 1, type: :integer)
+
+      s = Sheet.new(@data, row: @row, header: header_row, header_check: proc{|line| line =~ /^HEADER/ })
+
+      expect(s).to be_an Enumerable
+      expect(s).to have(3).things
+    end
+
+    describe "with a File" do
+
+      it "should process file without header" do
+
+        File.open(File.expand_path("../simple.txt",__FILE__)) do |f|
+          s = Sheet.new(f, row: @row)
+          expect(s).to be_an Enumerable
+          first = s.first
+          expect(first).not_to be_nil
+          expect(first["Name"]).to eq "Frank"
+          f.rewind
+          expect(s).to have(2).things
+
+
+        end
+      end
+
+    end
+  end
+end

data/spec/simple.txt

@@ -0,0 +1,2 @@
+01Frank     20080305
+02Sam       20091205

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'haecksler'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: haecksler
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Frank Falkenberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: Haecksler is the German word for a wood chipper
+email:
+- faltibrain@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- haecksler.gemspec
+- lib/haecksler.rb
+- lib/haecksler/column.rb
+- lib/haecksler/dsl.rb
+- lib/haecksler/row.rb
+- lib/haecksler/sheet.rb
+- lib/haecksler/version.rb
+- spec/column_spec.rb
+- spec/complete.txt
+- spec/dsl_spec.rb
+- spec/row_spec.rb
+- spec/sheet_spec.rb
+- spec/simple.txt
+- spec/spec_helper.rb
+homepage: https://github.com/falti/haecksler
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Library to parse fixed-length files
+test_files:
+- spec/column_spec.rb
+- spec/complete.txt
+- spec/dsl_spec.rb
+- spec/row_spec.rb
+- spec/sheet_spec.rb
+- spec/simple.txt
+- spec/spec_helper.rb