total_in 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58ddedbe4d914ccb31dafda36de258488e2ad768
+  data.tar.gz: 1d9deb3b756e9c5f974c231d6992688c8b1f321d
+SHA512:
+  metadata.gz: a4ed13121596580de19c2dc78abbd7ac60e4543986bb8132fdf0891a30335ed20600a7204b5c2f76dbeae0486a8970aff8c42a6e30853905879bccfadc4ec7b9
+  data.tar.gz: 57ac3813d93ac77374a1de9e7b48d2ec4a94b1e98a28cf37b417fcb87e8f98b7e34e84e8b43184e36120a34345a65949477b8cdc2d6ef5d6f0017208a8bb5a48

data/.gitignore

@@ -0,0 +1,20 @@
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+bin/
+tmp
+bin

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.1.4

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+- 2.1.5
+- 2.0.0-p598
+script: rspec spec
+addons:
+  code_climate:
+    repo_token:
+      secure: "MVPl+PV2Ewts0sumoKdjJxIX2A1jPJ80wXrFEEbeJMX3f3ST3PQtj2/XTRU4BBq1N2KzJL6ZUffpI9yKqSVsEHPhZan/ngixj5Z4pEEd59dWSJoC7ZxCWAq32qdoq2IAD2fRA7uvs34wo/D0BukTHqAFJXCfbpcoxskH/uzkLP8="

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gem "codeclimate-test-reporter", group: :test, require: nil
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Joel Junström
+
+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,21 @@
+# Total-IN file parser
+
+[![Code Climate](https://codeclimate.com/github/Oktavilla/total-in-ruby/badges/gpa.svg)](https://codeclimate.com/github/Oktavilla/total-in-ruby)
+[![Test Coverage](https://codeclimate.com/github/Oktavilla/total-in-ruby/badges/coverage.svg)](https://codeclimate.com/github/Oktavilla/total-in-ruby)
+
+
+## Usage
+
+```ruby
+require "total_in"
+
+result = TotalIn.parse total_in_file_contents
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/oktavilla/total-in-ruby/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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/total_in/attribute_methods.rb

@@ -0,0 +1,62 @@
+module AttributeMethods
+  def self.included base
+    base.send :include, InstanceMethods
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def attribute name
+      register_attribute name
+      define_attribute_reader name
+      define_attribute_writer name
+    end
+
+    def register_attribute name
+      self.attribute_names.push name
+    end
+
+    def attribute_names
+      @attribute_names ||= []
+    end
+
+    def define_attribute_reader name
+      define_method name do
+        read_attribute name
+      end
+    end
+
+    def define_attribute_writer name
+      define_method "#{name}=" do |value|
+        write_attribute name, value
+      end
+    end
+  end
+
+  module InstanceMethods
+    def initialize attrs = {}
+      self.assign_attributes attrs
+    end
+
+    def assign_attributes attrs
+      attrs.each do |name, value|
+        write_attribute name, value
+      end
+    end
+
+    def attributes
+      @attributes ||= {}
+    end
+
+    def read_attribute name
+      attributes[name]
+    end
+
+    def write_attribute name, value
+      attributes[name] = value if attribute_names.include?(name)
+    end
+
+    def attribute_names
+      self.class.attribute_names
+    end
+  end
+end

data/lib/total_in/contexts.rb

@@ -0,0 +1,54 @@
+module TotalIn
+  class Contexts
+    def initialize containers = nil
+      Array(containers).compact.each do |container|
+        add container
+      end
+    end
+
+    def result
+      contexts.first
+    end
+
+    def current
+      contexts.last
+    end
+
+    def add container
+      contexts.push container
+    end
+
+    def move_up
+      contexts.pop
+    end
+
+    def move_to container_class
+      until current.is_a?(container_class)
+        move_up
+      end if contexts.any?
+    end
+
+    def move_to_or_add_to_parent container_class, parent_container_class
+      return self if current.is_a?(container_class)
+
+      until current.kind_of?(parent_container_class)
+        move_up
+      end
+
+      entity = container_class.new
+
+      setter_name = StringHelpers.underscore container_class.name.split("::").last
+      current.public_send "#{setter_name}=", entity
+
+      add entity
+
+      self
+    end
+
+    private
+
+    def contexts
+      @contexts ||= []
+    end
+  end
+end

data/lib/total_in/document.rb

@@ -0,0 +1,114 @@
+require "total_in/string_helpers"
+require "total_in/attribute_methods"
+
+module TotalIn
+  class Document
+    include AttributeMethods
+    attribute :id
+    attribute :created_at
+    attribute :delivery_number
+    attribute :file_type
+    attribute :name
+    attribute :number_of_lines
+
+    def accounts
+      @accounts ||= []
+    end
+
+    class Account
+      include AttributeMethods
+      attribute :account_number
+      attribute :currency
+      attribute :date
+      attribute :number_of_transactions
+      attribute :amount
+      attribute :statement_reference
+
+      def payments
+        @payments ||= []
+      end
+
+      def deductions
+        @deductions ||= []
+      end
+    end
+
+    class Transaction
+      include AttributeMethods
+      def reference_numbers
+        @reference_numbers ||= []
+      end
+
+      attr_accessor :sender
+      attr_accessor :sender_account
+      attr_accessor :international
+
+      def message
+        messages.join "\n" if messages.any?
+      end
+
+      def messages
+        @messages ||= []
+      end
+
+      def add_message message
+        messages.push message
+      end
+
+      def international?
+        !!self.international
+      end
+    end
+
+    class Payment < Transaction
+      attribute :amount
+      attribute :serial_number
+      attribute :receiving_bankgiro_number
+    end
+
+    class Deduction < Transaction
+      attribute :amount
+      attribute :serial_number
+      attribute :receiving_bankgiro_number
+      attribute :code
+    end
+
+    class Sender
+      include AttributeMethods
+      attribute :name
+      attribute :address
+      attribute :postal_code
+      attribute :city
+      attribute :country_code
+
+      def self.add_to_contexts contexts
+        contexts.move_to_or_add_to_parent self, Transaction
+      end
+    end
+
+    class SenderAccount
+      include AttributeMethods
+      attribute :name
+      attribute :address
+      attribute :postal_code
+      attribute :city
+      attribute :country_code
+      attribute :account_number
+      attribute :origin_code
+      attribute :company_organization_number
+
+      def self.add_to_contexts contexts
+        contexts.move_to_or_add_to_parent self, Transaction
+      end
+    end
+
+    class International
+      include AttributeMethods
+      attribute :cost
+      attribute :cost_currency
+      attribute :amount
+      attribute :amount_currency
+      attribute :exchange_rate
+    end
+  end
+end

data/lib/total_in/line_handlers.rb

@@ -0,0 +1,35 @@
+require "total_in/line_parsers"
+require "total_in/line_processors"
+
+module TotalIn
+  module LineHandlers
+    Handler = Struct.new :parser, :processor do
+      def handle line, contexts
+        line_parser = self.parser.new(line)
+
+        processor.call line_parser, contexts
+      end
+    end
+
+    def self.all
+      {
+        "00" => Handler.new(LineParsers::DocumentStart, LineProcessors::DocumentStart),
+        "99" => Handler.new(LineParsers::DocumentEnd, LineProcessors::DocumentEnd),
+        "10" => Handler.new(LineParsers::AccountStart, LineProcessors::AccountStart),
+        "90" => Handler.new(LineParsers::AccountEnd, LineProcessors::AccountEnd),
+        "20" => Handler.new(LineParsers::PaymentStart, LineProcessors::PaymentStart),
+        "25" => Handler.new(LineParsers::DeductionStart, LineProcessors::DeductionStart),
+        "30" => Handler.new(LineParsers::ReferenceNumbers, LineProcessors::ReferenceNumbers),
+        "40" => Handler.new(LineParsers::Messages, LineProcessors::Messages),
+        "50" => Handler.new(LineParsers::Names, LineProcessors::Names.new(Document::Sender)),
+        "51" => Handler.new(LineParsers::Addresses, LineProcessors::Addresses.new(Document::Sender)),
+        "52" => Handler.new(LineParsers::Locality, LineProcessors::Locality.new(Document::Sender)),
+        "60" => Handler.new(LineParsers::SenderAccount, LineProcessors::SenderAccount),
+        "61" => Handler.new(LineParsers::Names, LineProcessors::Names.new(Document::SenderAccount)),
+        "62" => Handler.new(LineParsers::Addresses, LineProcessors::Addresses.new(Document::SenderAccount)),
+        "63" => Handler.new(LineParsers::Locality, LineProcessors::Locality.new(Document::SenderAccount)),
+        "70" => Handler.new(LineParsers::International, LineProcessors::International)
+      }
+    end
+  end
+end

data/lib/total_in/line_parser.rb

@@ -0,0 +1,42 @@
+require "total_in/typecaster"
+
+module TotalIn
+  class LineParser
+    attr_reader :line
+    def initialize line
+      @line = line
+    end
+
+    def attributes
+      self.class.field_names.each_with_object({}) do |field, attrs|
+        attrs[field] = self.public_send(field)
+      end
+    end
+
+    def self.field name, range, type = :string
+      self.field_names.push name
+
+      define_method name do
+        if range.is_a?(Array)
+          range.map { |r| value_at_position(r, type) }.compact
+        else
+          value_at_position range, type
+        end
+      end
+    end
+
+    private
+
+    def self.field_names
+      @field_names ||= []
+    end
+
+    def value_at_position range, type
+      typecast line[range].strip, type
+    end
+
+    def typecast value, type
+      Typecaster.cast value, type
+    end
+  end
+end

data/lib/total_in/line_parsers.rb

@@ -0,0 +1,80 @@
+require "total_in/line_parser"
+
+module TotalIn
+  module LineParsers
+    class DocumentStart < LineParser
+      field :id, 2..13
+      field :created_at, 14..33, :time
+      field :delivery_number, 34..35, :integer
+      field :file_type, 36..38
+      field :name, 39..48
+    end
+
+    class DocumentEnd < LineParser
+      field :number_of_lines, 2..16, :integer
+    end
+
+    class AccountStart < LineParser
+      field :account_number, 2..37
+      field :currency, 38..40
+      field :date, 41..48, :date
+    end
+
+    class AccountEnd < LineParser
+      field :number_of_transactions, 2..9, :integer
+      field :amount, 10..26, :integer
+      field :statement_reference, 27..37
+    end
+
+    class PaymentStart < LineParser
+      field :reference_number, 2..36
+      field :amount, 37..51, :integer
+      field :serial_number, 52..68, :integer
+      field :receiving_bankgiro_number, 69..76
+    end
+
+    class DeductionStart < LineParser
+      field :reference_number, 2..36
+      field :amount, 37..51, :integer
+      field :serial_number, 52..68, :integer
+      field :code, 69..69, :integer
+      field :receiving_bankgiro_number, 70..77
+    end
+
+    class Values < LineParser
+      field :values, [2..36, 37..71]
+    end
+
+    class ReferenceNumbers < Values
+    end
+
+    class Messages < Values
+    end
+
+    class Names < Values
+    end
+
+    class Addresses < Values
+    end
+
+    class Locality < LineParser
+      field :postal_code, 2..10
+      field :city, 11..45
+      field :country_code, 46..47
+    end
+
+    class SenderAccount < LineParser
+      field :account_number, 2..37
+      field :origin_code, 38..38, :integer
+      field :company_organization_number, 39..58
+    end
+
+    class International < LineParser
+      field :cost, 2..16, :integer
+      field :cost_currency, 17..19
+      field :amount, 38..52, :integer
+      field :amount_currency, 53..55
+      field :exchange_rate, 56..67, :integer
+    end
+  end
+end

data/lib/total_in/line_processors.rb

@@ -0,0 +1,138 @@
+require "total_in/document"
+
+module TotalIn
+  module LineProcessors
+    DocumentStart = ->(line, contexts) {
+      document = Document.new line.attributes
+
+      contexts.add document
+
+      contexts
+    }
+
+    DocumentEnd = ->(line, contexts) {
+      contexts.move_to Document
+
+      contexts.current.number_of_lines = line.number_of_lines
+
+      contexts
+    }
+
+    AccountStart = ->(line, contexts) {
+      contexts.move_to Document
+
+      account = Document::Account.new line.attributes
+
+      contexts.current.accounts << account
+      contexts.add account
+
+      contexts
+    }
+
+    AccountEnd = ->(line, contexts) {
+      contexts.move_to Document::Account
+
+      contexts.current.assign_attributes line.attributes
+
+      contexts
+    }
+
+    PaymentStart = ->(line, contexts) {
+      contexts.move_to Document::Account
+
+      payment = Document::Payment.new line.attributes
+      payment.reference_numbers << line.reference_number if line.reference_number
+
+      contexts.current.payments << payment
+
+      contexts.add payment
+
+      contexts
+    }
+
+    DeductionStart = ->(line, contexts) {
+      contexts.move_to Document::Account
+
+      deduction = Document::Deduction.new line.attributes
+      deduction.reference_numbers << line.reference_number if line.reference_number
+
+      contexts.current.deductions << deduction
+      contexts.add deduction
+
+      contexts
+    }
+
+    ReferenceNumbers = ->(line, contexts) {
+      contexts.current.reference_numbers.concat line.values
+
+      contexts
+    }
+
+    Messages = ->(line, contexts) {
+      line.values.each do |message|
+        contexts.current.add_message message
+      end
+
+      contexts
+    }
+
+    class WithTargetClass
+      def initialize target_class
+        @target_class = target_class
+      end
+
+      attr_reader :target_class
+    end
+
+    class Names < WithTargetClass
+      def call line, contexts
+        contexts = target_class.add_to_contexts contexts
+
+        contexts.current.name = line.values.join " "
+
+        contexts
+      end
+    end
+
+
+    class Addresses < WithTargetClass
+      def call line, contexts
+        contexts = target_class.add_to_contexts contexts
+
+        contexts.current.address = line.values.join " "
+
+        contexts
+      end
+    end
+
+    class Locality < WithTargetClass
+      def call line, contexts
+        contexts = target_class.add_to_contexts contexts
+
+        contexts.current.assign_attributes line.attributes
+
+        contexts
+      end
+    end
+
+    SenderAccount = ->(line, contexts) {
+      contexts = Document::SenderAccount.add_to_contexts contexts
+
+      contexts.current.assign_attributes line.attributes
+
+      contexts
+    }
+
+    International = ->(line, contexts) {
+      until contexts.current.kind_of?(Document::Transaction)
+        contexts.move_up
+      end
+
+      international = Document::International.new line.attributes
+
+      contexts.current.international = international
+
+      contexts
+    }
+  end
+end

data/lib/total_in/parser.rb

@@ -0,0 +1,48 @@
+require "total_in/line_handlers"
+require "total_in/contexts"
+
+module TotalIn
+  class Parser
+    attr_reader :text
+
+    def initialize text
+      @text = text
+    end
+
+    def result
+      contexts = parse_lines text.each_line.to_a, Contexts.new
+
+      contexts.result
+    end
+
+    private
+
+    def parse_lines lines, contexts
+      if line = lines.shift
+        parse_lines lines, parse_line(line, contexts)
+      else
+        contexts
+      end
+    end
+
+    def parse_line line, contexts
+      handler = handler_for_line line
+
+      handler.handle line, contexts
+    end
+
+    def handler_for_line line
+      self.class.handlers.fetch line[0..1]
+    end
+
+    def self.handlers
+      @handlers ||= {}
+    end
+
+    def self.register_handlers handlers
+      @handlers = handlers
+    end
+
+    register_handlers LineHandlers.all
+  end
+end

data/lib/total_in/string_helpers.rb

@@ -0,0 +1,10 @@
+module TotalIn
+  module StringHelpers
+    def self.underscore word
+      word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+      word.tr!("-", "_")
+      word.downcase
+    end
+  end
+end