norma43_parser 1.0.1 → 2.0.0

data/lib/norma43/line_parsers/additional_currency.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Norma43
+  module LineParsers
+    class AdditionalCurrency < LineParser
+      field :data_code, 2..3, :integer
+      field :currency_code, 4..6, :integer
+      field :amount, 7..20, :integer
+      field :free, 21..79
+    end
+  end
+end

data/lib/norma43/line_parsers/additional_item.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Norma43
+  module LineParsers
+    class AdditionalItem < LineParser
+      field :data_code, 2..3, :integer
+      field :item_1, 4..41
+      field :item_2, 42..79
+    end
+  end
+end

data/lib/norma43/line_parsers/document_end.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Norma43
+  module LineParsers
+    class DocumentEnd < LineParser
+      field :record_number, 20..25, :integer
+    end
+  end
+end

data/lib/norma43/line_parsers/document_start.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Norma43
+  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
+  end
+end

data/lib/norma43/line_parsers/file_format_validator.rb

@@ -1,19 +1,22 @@
-require "norma43/line_parsers/line_parser"
+# frozen_string_literal: true
+
 module Norma43
-  class FileFormatValidator < LineParser
-    field :record_type, 0..1, :raw
-    field :file_type, 36..38
+  module LineParsers
+    class FileFormatValidator < LineParser
+      field :record_type, 0..1, :raw
+      field :file_type, 36..38
 
-    def has_document?; file_type=="00" end
+      def has_document?; file_type == "00" end
 
-    def valid?
-      errors.empty?
-    end
+      def valid?
+        errors.empty?
+      end
 
-    def errors
-      errors = []
-      %w(11 00).include? record_type or errors << "Must start with 00 (was ”#{record_type}”)"
-      errors
+      def errors
+        errors = []
+        %w(11 00).include?(record_type) || errors << ("Must start with 00 (was ”#{record_type}”)")
+        errors
+      end
     end
   end
 end

data/lib/norma43/line_parsers/line_parser.rb

@@ -1,42 +1,43 @@
-require "norma43/utils/typecaster"
+# frozen_string_literal: true
 
 module Norma43
-  class LineParser
-    attr_reader :line
-    def initialize line
-      @line = line
-    end
+  module LineParsers
+    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)
+      def attributes
+        self.class.field_names.each_with_object({}) do |field, attrs|
+          attrs[field] = self.public_send(field)
+        end
       end
-    end
 
-    def self.field name, range, type = :string
-      self.field_names.push name
+      def self.field(name, range, type = :string)
+        self.field_names.push name
 
-      define_method name do
-        if range.is_a?(Array) # let multivalued attribute
-          range.map { |r| value_at_position(r, type) }.compact
-        else
-          value_at_position range, type
+        define_method name do
+          if range.is_a?(Array) # let multivalued attribute
+            range.map { |r| value_at_position(r, type) }.compact
+          else
+            value_at_position range, type
+          end
         end
       end
-    end
-
-    private
 
-    def self.field_names
-      @field_names ||= []
-    end
+      private
+        def self.field_names
+          @field_names ||= []
+        end
 
-    def value_at_position range, type
-      typecast line[range].to_s.strip, type
-    end
+        def value_at_position(range, type)
+          typecast line[range].to_s.strip, type
+        end
 
-    def typecast value, type
-      Typecaster.cast value, type
+        def typecast(value, type)
+          Norma43::Utils::Typecaster.cast value, type
+        end
     end
   end
 end

data/lib/norma43/line_parsers/transaction.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Norma43
+  module LineParsers
+    class Transaction < LineParser
+      field :origin_branch_code, 6..9, :integer
+      field :transaction_date, 10..15, :date
+      field :value_date, 16..21, :date
+      field :shared_item, 22..23, :integer
+      field :own_item, 24..26, :integer
+      field :amount_code, 27, :integer
+      field :amount, 28..41, :integer
+      field :document_number, 42..51, :integer
+      field :reference_1, 52..63, :integer
+      field :reference_2, 64..79
+    end
+  end
+end

data/lib/norma43/line_processors.rb

@@ -1,4 +1,5 @@
-require "norma43/models"
+# frozen_string_literal: true
+
 module Norma43
   module LineProcessors
     DocumentStart = ->(line, contexts) {
@@ -55,6 +56,5 @@ module Norma43
       contexts.current.additional_currency = additional_currency
       contexts
     }
-
   end
 end

data/lib/norma43/models.rb

@@ -1,9 +1,10 @@
-require "norma43/utils/string_helpers"
-require 'virtus'
+# frozen_string_literal: true
+
+require "virtus"
 
 module Norma43
   module Models
-    #forward declarations
+    # forward declarations
     class Account; end
     class Transaction; end
     class AdditionalItem; end
@@ -62,7 +63,7 @@ module Norma43
       attribute :reference_2
       attribute :additional_items, Array[AdditionalItem]
       attribute :additional_currency, AdditionalCurrency
-      def debit?; self.amount_code==DEBIT_CODE end
+      def debit?; self.amount_code == DEBIT_CODE end
     end
 
     class AdditionalItem

data/lib/norma43/parser.rb

@@ -1,25 +1,23 @@
-require "norma43/line_parsers/file_format_validator"
-require "norma43/line_handlers"
-require "norma43/utils/contexts"
+# frozen_string_literal: true
 
 module Norma43
-  class InvalidFileFormatError < ArgumentError; end;
+  class InvalidFileFormatError < ArgumentError; end
 
   class Parser
     attr_reader :file
 
     # Parser.new accepts a File instance or a String
     # A InvalidFileFormatError will be raised if file isn't in the Norma43 format
-    def initialize file
+    def initialize(file)
       @file = file
       validator = validate_file_format
       @contexts = if validator.has_document?
-        Contexts.new
+        Norma43::Utils::Contexts.new
       else
         # in theory Norma43 says that files should start with DocumentStart but
         # practically doesn't happen, so that we create one artificially
         # to avoid corner cases in the processors
-        Contexts.new().tap { |ctx| ctx.add Models::Document.new }
+        Norma43::Utils::Contexts.new().tap { |ctx| ctx.add Models::Document.new }
       end
     end
 
@@ -28,52 +26,50 @@ module Norma43
     end
 
     protected
-
-    def lines
-      @lines ||= file.each_line
-    end
+      def lines
+        @lines ||= file.each_line
+      end
 
     private
+      def validate_file_format
+        validator = Norma43::LineParsers::FileFormatValidator.new first_line
+        raise InvalidFileFormatError.new(validator.errors.join(", ")) unless validator.valid?
+        validator
+      end
 
-    def validate_file_format
-      validator = FileFormatValidator.new first_line
-      raise InvalidFileFormatError.new(validator.errors.join(", ")) unless validator.valid?
-      validator
-    end
-
-    def parse_lines contexts
-      parse_lines parse_line(self.lines.next, contexts)
+      def parse_lines(contexts)
+        parse_lines parse_line(self.lines.next, contexts)
 
-    rescue StopIteration# because lines is an enumerator raises StopIteration on end
-      self.lines.rewind # Ensure we do not bomb out when calling result multiple times
-      contexts
-    end
+      rescue StopIteration # because lines is an enumerator raises StopIteration on end
+        self.lines.rewind # Ensure we do not bomb out when calling result multiple times
+        contexts
+      end
 
-    # Look up a matching handler for the line and process it
-    # The process method on a handler always returns a Contexts object
-    def parse_line line, contexts
-      line = line.encode Encoding::UTF_8 if encode_lines?
+      # Look up a matching handler for the line and process it
+      # The process method on a handler always returns a Contexts object
+      def parse_line(line, contexts)
+        line = line.encode Encoding::UTF_8 if encode_lines?
 
-      handler = handler_for_line line
+        handler = handler_for_line line
 
-      handler.process line, contexts
-    end
+        handler.process line, contexts
+      end
 
-    def handler_for_line line
-      LineHandlers.mapping.fetch line[0..1]
-    end
+      def handler_for_line(line)
+        LineHandlers.mapping.fetch line[0..1]
+      end
 
-    def encode_lines?
-      first_line.encoding != Encoding::UTF_8
-    end
+      def encode_lines?
+        first_line.encoding != Encoding::UTF_8
+      end
 
-    def first_line
-      @first_line ||= begin
-        line = self.lines.peek
-        self.lines.rewind # peek seems to move the pointer when file is an actual File object
+      def first_line
+        @first_line ||= begin
+          line = self.lines.peek
+          self.lines.rewind # peek seems to move the pointer when file is an actual File object
 
-        line
+          line
+        end
       end
-    end
   end
 end

data/lib/norma43/utils/contexts.rb

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

data/lib/norma43/utils/string_helpers.rb

@@ -1,10 +1,14 @@
+# frozen_string_literal: true
+
 module Norma43
-  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
+  module Utils
+    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
 end