estratto 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f4425ecb691c561000266f1717d1bcab1aa9c198
+  data.tar.gz: f3526413190af262cf089112ae34682f1465894b
+SHA512:
+  metadata.gz: fd3154c347e94acd858b7a92e88817d00f3e55618ac8191786a5b5606212fb519f9180e071dcffec9e776d15c8bb88dedbe709a3fcedd514098d74ae96718ce6
+  data.tar.gz: be0cdd97b6a300d68bd30c6b4090c20c2274c2b4a160ca7d925c49c32a30704c144cf6de82e88aa8cd0f2a068cc22b83c71f4ab84e5282daffd11728f5f903c7

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in estratto.gemspec
+gemspec
+
+group :test do
+  gem 'coveralls', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    estratto (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    coveralls (0.8.22)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    json (2.1.0)
+    method_source (0.8.2)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-nav (0.2.4)
+      pry (>= 0.9.10, < 0.11.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    slop (3.6.0)
+    term-ansicolor (1.7.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    tins (1.20.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  coveralls
+  estratto!
+  pry-nav
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 TODO: Write your name
+
+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,41 @@
+# Estratto
+
+[![Build Status](https://travis-ci.com/Rynaro/estratto.svg?branch=master)](https://travis-ci.com/Rynaro/estratto)
+[![Coverage Status](https://coveralls.io/repos/github/Rynaro/estratto/badge.svg?branch=master)](https://coveralls.io/github/Rynaro/estratto?branch=master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/46532b90e850401fce72/maintainability)](https://codeclimate.com/github/Rynaro/estratto/maintainability)
+
+### TODO: Write a super README
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'estratto'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install estratto
+
+## Usage
+
+TODO: Comming soon
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Rynaro/estratto.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "estratto"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/estratto.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "estratto/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "estratto"
+  spec.version       = Estratto::VERSION
+  spec.authors       = ["Henrique A. Lavezzo"]
+  spec.email         = ["me@hlavezzo.run"]
+
+  spec.summary       = %q{Parsing fixed width files made easy}
+  spec.homepage      = "https://github.com/Rynaro/estratto"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry-nav"
+end

data/lib/estratto/data/base.rb

@@ -0,0 +1,19 @@
+module Estratto
+  module Data
+    class TypeCoercionNotFound < StandardError; end
+
+    class Base
+      attr_reader :data, :formats
+
+      def initialize(data, formats = {})
+        @data = data
+        @formats = formats
+      end
+
+      def coerce
+        raise TypeCoercionNotFound
+      end
+
+    end
+  end
+end

data/lib/estratto/data/coercer.rb

@@ -0,0 +1,31 @@
+require_relative 'integer'
+require_relative 'float'
+require_relative 'datetime'
+require_relative 'date'
+require_relative 'string'
+
+module Estratto
+  module Data
+    class InvalidCoercionType < StandardError; end
+
+    class Coercer
+      attr_reader :data, :type, :formats
+
+      def initialize(data:, type: 'String', formats: {})
+        @data = data
+        @type = type
+        @formats = formats
+      end
+
+      def build
+        target_coercer.coerce
+      end
+
+      def target_coercer
+        Object.const_get("Estratto::Data::#{type}").new(data, formats)
+      rescue NameError
+        raise InvalidCoercionType
+      end
+    end
+  end
+end

data/lib/estratto/data/date.rb

@@ -0,0 +1,11 @@
+require_relative 'base'
+
+module Estratto
+  module Data
+    class Date < DateTime
+      def coerce
+        super.to_date
+      end
+    end
+  end
+end

data/lib/estratto/data/datetime.rb

@@ -0,0 +1,22 @@
+require_relative 'base'
+
+module Estratto
+  module Data
+    class DateTime < Base
+
+      def coerce
+        parse_datetime_from
+      end
+
+      private
+
+      def parse_datetime_from
+        ::DateTime.strptime(data, datetime_format)
+      end
+
+      def datetime_format
+        formats.dig('format') || '%Y-%m-%d'
+      end
+    end
+  end
+end

data/lib/estratto/data/float.rb

@@ -0,0 +1,41 @@
+require_relative 'base'
+
+module Estratto
+  module Data
+    class Float < Base
+
+      def coerce
+        if expected_comma
+          from_comma_data
+        elsif custom_precision
+          from_precision_data
+        else
+          data.to_f
+        end
+      end
+
+      private
+
+      def expected_comma
+        formats.dig('comma_format') || false
+      end
+
+      def custom_precision
+        formats.has_key?('precision')
+      end
+
+      def from_comma_data
+        data.gsub('.', '').gsub(',', '.').to_f
+      end
+
+      def from_precision_data
+        data.to_f / (10**precision)
+      end
+
+      def precision
+        formats['precision'].to_i || 2
+      end
+
+    end
+  end
+end

data/lib/estratto/data/integer.rb

@@ -0,0 +1,12 @@
+require_relative 'base'
+
+module Estratto
+  module Data
+    class Integer < Base
+
+      def coerce
+        data.to_i
+      end
+    end
+  end
+end

data/lib/estratto/data/string.rb

@@ -0,0 +1,26 @@
+require_relative 'base'
+
+module Estratto
+  module Data
+    class String < Base
+
+      def coerce
+        if strip_value?
+          stripped_data
+        else
+          data
+        end
+      end
+
+      private
+
+      def strip_value?
+        formats.dig('strip') || false
+      end
+
+      def stripped_data
+        data.strip
+      end
+    end
+  end
+end

data/lib/estratto/document.rb

@@ -0,0 +1,13 @@
+require_relative 'layout/factory'
+require_relative 'parser'
+
+module Estratto
+  class Document
+    class << self
+      def process(layout:,file:)
+        layout_fabricated = Layout::Factory.fabricate(layout)
+        Parser.new(file, layout_fabricated).perform
+      end
+    end
+  end
+end

data/lib/estratto/helpers/range.rb

@@ -0,0 +1,9 @@
+module Estratto
+  module Helpers
+    class Range
+      def self.for(string)
+        ::Range.new(*string.split('..').map(&:to_i))
+      end
+    end
+  end
+end

data/lib/estratto/layout/base.rb

@@ -0,0 +1,14 @@
+module Estratto
+  module Layout
+    class Base
+      extend Forwardable
+
+      attr_reader :reader
+      def_delegators :@reader, :layout, :registers
+
+      def initialize(reader)
+        @reader = reader
+      end
+    end
+  end
+end

data/lib/estratto/layout/factory.rb

@@ -0,0 +1,19 @@
+require_relative 'reader'
+require_relative 'multi_register'
+
+module Estratto
+  module Layout
+    class LayoutUndefinedError < StandardError; end
+    class Factory
+
+      def self.fabricate(layout_path)
+        reader = Reader.new(layout_path)
+        if reader.multiregister?
+          MultiRegister.new(reader)
+        else
+          raise LayoutUndefinedError
+        end
+      end
+    end
+  end
+end

data/lib/estratto/layout/multi_register.rb

@@ -0,0 +1,26 @@
+require_relative 'base'
+require_relative '../helpers/range'
+
+module Estratto
+  module Layout
+    class LayoutNotFoundForPrefix < StandardError; end
+
+    class MultiRegister < Base
+
+      def prefix_range
+        Estratto::Helpers::Range.for(layout['prefix'])
+      end
+
+      def register_fields_for(prefix)
+        find_register(prefix)&.dig('fields')
+      end
+
+      private
+
+      def find_register(prefix)
+        registers.find { |register| register['register'] == prefix }
+      end
+
+    end
+  end
+end

data/lib/estratto/layout/reader.rb

@@ -0,0 +1,30 @@
+require 'yaml'
+
+module Estratto
+  module Layout
+    class Reader
+      attr_reader :file
+
+      def initialize(file)
+        @file = file
+      end
+
+      def template
+        @template ||= YAML.load_file(file)
+      end
+
+      def layout
+        template['layout']
+      end
+
+      def registers
+        @registers ||= layout['registers']
+      end
+
+      def multiregister?
+        layout.dig('multi-register') || false
+      end
+
+    end
+  end
+end

data/lib/estratto/parser.rb

@@ -0,0 +1,25 @@
+require_relative 'register'
+
+module Estratto
+  class Parser
+    attr_reader :file_path, :layout
+
+    def initialize(file_path, layout)
+      @file_path = file_path
+      @layout = layout
+    end
+
+    def perform
+      @data ||= raw_data.map do |line|
+        register_layout = layout.register_fields_for(line[layout.prefix_range])
+        next if register_layout.nil?
+        Register.new(line, register_layout).refine
+      end.compact
+    end
+
+    def raw_data
+      @raw_data ||= File.open(file_path, 'r')
+    end
+
+  end
+end

data/lib/estratto/register.rb

@@ -0,0 +1,31 @@
+require_relative 'data/coercer'
+require_relative 'helpers/range'
+
+module Estratto
+  class Register
+    attr_reader :line, :register_layout
+
+    def initialize(line, register_layout)
+      @line = line
+      @register_layout = register_layout
+    end
+
+    def refine
+      register_layout.map do |layout|
+        {
+          layout['name'].to_sym => coerced_data(layout['range'], layout['type'], layout['formats'])
+        }
+      end.inject(&:merge)
+    end
+
+    private
+
+    def coerced_data(range, type, formats)
+      Estratto::Data::Coercer.new(
+        data: line[Estratto::Helpers::Range.for(range)],
+        type: type,
+        formats: formats || {}
+      ).build
+    end
+  end
+end

data/lib/estratto/version.rb

@@ -0,0 +1,3 @@
+module Estratto
+  VERSION = "1.0.0"
+end

data/lib/estratto.rb

@@ -0,0 +1,5 @@
+require "estratto/version"
+require "estratto/document"
+
+module Estratto
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: estratto
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Henrique A. Lavezzo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-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.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  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: 
+email:
+- me@hlavezzo.run
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- estratto.gemspec
+- lib/estratto.rb
+- lib/estratto/data/base.rb
+- lib/estratto/data/coercer.rb
+- lib/estratto/data/date.rb
+- lib/estratto/data/datetime.rb
+- lib/estratto/data/float.rb
+- lib/estratto/data/integer.rb
+- lib/estratto/data/string.rb
+- lib/estratto/document.rb
+- lib/estratto/helpers/range.rb
+- lib/estratto/layout/base.rb
+- lib/estratto/layout/factory.rb
+- lib/estratto/layout/multi_register.rb
+- lib/estratto/layout/reader.rb
+- lib/estratto/parser.rb
+- lib/estratto/register.rb
+- lib/estratto/version.rb
+homepage: https://github.com/Rynaro/estratto
+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.8
+signing_key: 
+specification_version: 4
+summary: Parsing fixed width files made easy
+test_files: []