nacha 0.1.10 → 0.1.14

data/lib/nacha/record/base.rb

@@ -4,42 +4,47 @@ require 'json'
 require 'nacha/field'
 require 'nacha/record/validations/field_validations'
 
+# :reek:TooManyInstanceVariables, :reek:TooManyMethods
 module Nacha
   module Record
+    # Base class for all Nacha records.
     class Base
       include Validations::FieldValidations
 
-      attr_accessor :children, :parent, :fields
-      attr_reader :name, :validations, :errors, :original_input_line
-      attr_accessor :line_number
+      attr_reader :children, :name, :validations, :original_input_line, :fields
+      # :reek:Attribute
+      attr_accessor :parent, :line_number
 
+      # :reek:ManualDispatch
       def initialize(opts = {})
         @children = []
+        @parent = nil
         @errors = []
         @original_input_line = nil
+        @line_number = nil
+        @dirty = false
+        @fields = {}
         create_fields_from_definition
-        opts.each do |k, v|
-          setter = "#{k}="
-          next unless respond_to? setter
-
+        opts.each do |key, value|
+          setter = "#{key}="
           # rubocop:disable GitlabSecurity/PublicSend
-          send(setter, v) unless v.nil?
+          public_send(setter, value) if value && respond_to?(setter)
           # rubocop:enable GitlabSecurity/PublicSend
         end
       end
 
       class << self
+        # :reek:LongParameterList, :reek:ManualDispatch
         def nacha_field(name, inclusion:, contents:, position:)
           Nacha.add_ach_record_type(self)
           definition[name] = { inclusion: inclusion,
                                contents: contents,
                                position: position,
-                               name: name}
-          validation_method = "valid_#{name}".to_sym
+                               name: name }
+          validation_method = :"valid_#{name}"
           return unless respond_to?(validation_method)
 
-          validations[name] ||= []
-          validations[name] << validation_method
+          (validations[name] ||= []) << validation_method
         end
 
         def definition
@@ -51,72 +56,54 @@ module Nacha
         end
 
         def unpack_str
-          @unpack_str ||= definition.values.collect do |d|
-            Nacha::Field.unpack_str(d)
+          @unpack_str ||= definition.values
+                            .sort { |a, b| a[:position].first <=> b[:position].first }
+                            .collect do |field_def|
+            Nacha::Field.unpack_str(field_def)
           end.join.freeze
         end
 
-        def old_matcher
-          @matcher ||=
-            Regexp.new('\A' + definition.values.collect do |d|
-                         if d[:contents] =~ /\AC(.+)\z/ || d['contents'] =~ /\AC(.+)\z/
-                           Regexp.last_match(1)
-                         else
-                           '.' * (d[:position] || d['position']).size
-                         end
-                       end.join + '\z')
-        end
-
-        # A more strict matcher that accounts for numeric and date fields
-        # and allows for spaces in those fields, but not alphabetic characters
-        # Also matches strings that might not be long enough.
-        #
-        # Processes the definition in reverse order to allow later fields to be
-        # skipped if they are not present in the input string.
+        # :reek:TooManyStatements
+        # rubocop:disable Layout/BlockAlignment,
+        # rubocop:disable Style/StringConcatenation:
         def matcher
-          return @matcher if @matcher
-
-          output_started = false
-          skipped_output = false
-          @matcher ||=
-            Regexp.new('\A' + definition.values.reverse.collect do |d|
-                         if d[:contents] =~ /\AC(.+)\z/
+          @matcher ||= begin
+            output_started = false
+            skipped_output = false
+            Regexp.new('\A' + definition.values
+                                .sort { |a,b| a[:position].first <=> b[:position].first }.reverse.collect do |field|
+                         contents = field[:contents]
+                         position = field[:position]
+                         size = position.size
+                         if contents =~ /\AC(.+)\z/
                            last_match = Regexp.last_match(1)
-                           if last_match =~ /\A  *\z/
+                           if last_match.match?(/  */) && !output_started
                              skipped_output = true
                              ''
                            else
                              output_started = true
                              last_match
                            end
-                         elsif d[:contents] =~ /\ANumeric\z/
+                         elsif contents.match?(/\ANumeric\z/) || contents.match?(/\AYYMMDD\z/)
                            output_started = true
-                           '[0-9 ]' + "{#{(d[:position] || d['position']).size}}"
-                         elsif d[:contents] =~ /\AYYMMDD\z/
-                           if output_started
-                             '[0-9 ]' + "{#{(d[:position] || d['position']).size}}"
-                           else
-                             skipped_output = true
-                             ''
-                           end
+                           "[0-9 ]{#{size}}"
+                         elsif output_started
+                           ".{#{size}}"
                          else
-                           if output_started
-                             '.' + "{#{(d[:position] || d['position']).size}}"
-                           else
-                             skipped_output = true
-                             ''
-                           end
+                           skipped_output = true
+                           ''
                          end
                        end.reverse.join + (skipped_output ? '.*' : '') + '\z')
+          end
         end
-
+        # rubocop:enable Layout/BlockAlignment,
+        # rubocop:enable Style/StringConcatenation:
 
         def parse(ach_str)
-          rec = new
+          rec = new(original_input_line: ach_str)
           ach_str.unpack(unpack_str).zip(rec.fields.values) do |input_data, field|
             field.data = input_data
           end
-          rec.original_input_line = ach_str
           rec.validate
           rec
         end
@@ -124,14 +111,35 @@ module Nacha
         def record_type
           Nacha.record_name(self)
         end
-      end # end class methods
 
+        # :reek:ManualDispatch, :reek:TooManyStatements
+        def to_h
+          fields = definition.transform_values do |field_def|
+            {
+              inclusion: field_def[:inclusion],
+              contents: field_def[:contents],
+              position: field_def[:position].to_s
+            }
+          end
+
+          fields[:child_record_types] = child_record_types.to_a
+          fields[:child_record_types] ||= []
+          fields[:klass] = name.to_s
+
+          { record_type.to_sym => fields }
+        end
+
+        def to_json(*_args)
+          JSON.pretty_generate(to_h)
+        end
+      end
+
+      # :reek:FeatureEnvy
       def original_input_line=(line)
         @original_input_line = line.dup if line.is_a?(String)
       end
 
       def create_fields_from_definition
-        @fields ||= {}
         definition.each_pair do |field_name, field_def|
           @fields[field_name.to_sym] = Nacha::Field.new(field_def)
         end
@@ -152,11 +160,10 @@ module Nacha
             errors: errors,
             line_number: @line_number,
             original_input_line: original_input_line
-          }
-        }.merge(
-          @fields.keys.map do |key|
-            [key, @fields[key].to_json_output]
-          end.to_h)
+          } }.merge(
+            @fields.keys.to_h do |key|
+              [key, @fields[key].to_json_output]
+            end)
       end
 
       def to_json(*_args)
@@ -169,17 +176,18 @@ module Nacha
         end.join
       end
 
-      def to_html(opts = {})
+      def to_html(_opts = {})
         record_error_class = nil
 
-        field_html = @fields.keys.collect do |key|
-          record_error_class ||= 'error' if @fields[key].errors.any?
-          @fields[key].to_html
+        field_html = @fields.values.collect do |field|
+          record_error_class ||= 'error' if field.errors.any?
+          field.to_html
         end.join
-        "<div class=\"nacha-record tooltip #{record_type} #{record_error_class}\">" +
-          "<span class=\"nacha-field\" data-name=\"record-number\">#{"%05d" % [line_number]}&nbsp;|&nbsp</span>" +
-          field_html +
-          "<span class=\"record-type\" data-name=\"record-type\">#{human_name}</span>" +
+        "<div class=\"nacha-record tooltip #{record_type} #{record_error_class}\">" \
+          "<span class=\"nacha-record-number\" data-name=\"record-number\">#{format('%05d',
+            line_number)}&nbsp;|&nbsp</span>" \
+          "#{field_html}" \
+          "<span class=\"record-type\" data-name=\"record-type\">#{human_name}</span>" \
           "</div>"
       end
 
@@ -193,19 +201,10 @@ module Nacha
 
       def validate
         # Run field-level validations first
-        @fields.values.each(&:validate)
-
+        @fields.each_value(&:validate)
         # Then run record-level validations that might depend on multiple fields
-        self.class.definition.keys.each do |field|
-          next unless self.class.validations[field]
-
-          # rubocop:disable GitlabSecurity/PublicSend
-          field_data = send(field)
-
-          self.class.validations[field].map do |validation_method|
-            self.class.send(validation_method, field_data)
-          end
-          # rubocop:enable GitlabSecurity/PublicSend
+        self.class.definition.each_key do |field|
+          run_record_level_validations_for(field)
         end
       end
 
@@ -229,7 +228,8 @@ module Nacha
       #   # Assuming transaction_code is "201" and DEBIT_TRANSACTION_CODES includes "201"
       #   debit? #=> true
       #
-      #   # Assuming transaction_code is "100" and DEBIT_TRANSACTION_CODES does not include "100"
+      #   # Assuming transaction_code is "100" and DEBIT_TRANSACTION_CODES
+      #   # does not include "100"
       #   debit? #=> false
       #
       #   # Assuming transaction_code is nil
@@ -268,7 +268,8 @@ module Nacha
       #   # Assuming transaction_code is "101" and CREDIT_TRANSACTION_CODES includes "101"
       #   credit? #=> true
       #
-      #   # Assuming transaction_code is "200" and CREDIT_TRANSACTION_CODES does not include "200"
+      #   # Assuming transaction_code is "200" and CREDIT_TRANSACTION_CODES
+      #   # does not include "200"
       #   credit? #=> false
       #
       #   # Assuming transaction_code is nil
@@ -294,37 +295,54 @@ module Nacha
       end
 
       def errors
-        (@errors + @fields.values.map { |field| field.errors }).flatten
+        (@errors + @fields.values.map(&:errors)).flatten
       end
 
-
       def add_error(err_string)
         @errors << err_string
       end
 
-      def respond_to?(method_name, include_private = false)
-        field_name = method_name.to_s.gsub(/=$/, '').to_sym
+      # :reek:TooManyStatements
+      def method_missing(method_name, *args, &block)
+        method = method_name.to_s
+        field_name = method.gsub(/=$/, '').to_sym
+        field = @fields[field_name]
+        return super unless field
 
-        definition[field_name] || super
+        if method.end_with?('=')
+          assign_field_data(field, args)
+        else
+          field
+        end
       end
 
-      def method_missing(method_name, *args, &block)
+      def respond_to_missing?(method_name, *)
         field_name = method_name.to_s.gsub(/=$/, '').to_sym
-        is_assignment = (/[^=]*=$/o =~ method_name.to_s)
-        if @fields[field_name]
-          if is_assignment
-            # @fields[field_name].send(:data=,*args)
-            # rubocop:disable GitlabSecurity/PublicSend
-            @fields[field_name].public_send(:data=, *args)
-            # rubocop:enable GitlabSecurity/PublicSend
-            @dirty = true
-          else
-            # @fields[field_name].data
-            @fields[field_name]
-          end
-        else
-          super
+        definition[field_name] || super
+      end
+
+      private
+
+      def assign_field_data(field, args)
+        # rubocop:disable GitlabSecurity/PublicSend
+        field.public_send(:data=, *args)
+        # rubocop:enable GitlabSecurity/PublicSend
+        @dirty = true
+      end
+
+      # :reek:TooManyStatements
+      def run_record_level_validations_for(field)
+        klass = self.class
+        validations = klass.validations[field]
+        return unless validations
+
+        # rubocop:disable GitlabSecurity/PublicSend
+        field_data = send(field)
+
+        validations.each do |validation_method|
+          klass.send(validation_method, field_data)
         end
+        # rubocop:enable GitlabSecurity/PublicSend
       end
     end
   end

data/lib/nacha/record/batch_control.rb

@@ -1,23 +1,29 @@
 # coding: utf-8
 # frozen_string_literal: true
 
-require 'nacha/record/base.rb'
-require 'nacha/record/batch_control_record_type.rb'
+require 'nacha/record/base'
+require 'nacha/record/batch_control_record_type'
 
 module Nacha
   module Record
     class BatchControl < Nacha::Record::Base
       include BatchControlRecordType
+
       nacha_field :record_type_code, inclusion: 'M', contents: 'C8', position: 1..1
       nacha_field :service_class_code, inclusion: 'M', contents: 'Numeric', position: 2..4
       nacha_field :entry_addenda_count, inclusion: 'M', contents: 'Numeric', position: 5..10
       nacha_field :entry_hash, inclusion: 'M', contents: 'Numeric', position: 11..20
-      nacha_field :total_debit_entry_dollar_amount, inclusion: 'M', contents: '$$$$$$$$$$¢¢', position: 21..32
-      nacha_field :total_credit_entry_dollar_amount, inclusion: 'M', contents: '$$$$$$$$$$¢¢', position: 33..44
-      nacha_field :company_identification, inclusion: 'R', contents: 'Alphameric', position: 45..54
-      nacha_field :message_authentication_code, inclusion: 'O', contents: 'Alphameric', position: 55..73
+      nacha_field :total_debit_entry_dollar_amount,
+        inclusion: 'M', contents: '$$$$$$$$$$¢¢', position: 21..32
+      nacha_field :total_credit_entry_dollar_amount,
+        inclusion: 'M', contents: '$$$$$$$$$$¢¢', position: 33..44
+      nacha_field :company_identification,
+        inclusion: 'R', contents: 'Alphameric', position: 45..54
+      nacha_field :message_authentication_code,
+        inclusion: 'O', contents: 'Alphameric', position: 55..73
       nacha_field :reserved, inclusion: 'O', contents: 'C      ', position: 74..79
-      nacha_field :originating_dfi_identification, inclusion: 'M', contents: 'TTTTAAAA', position: 80..87
+      nacha_field :originating_dfi_identification,
+        inclusion: 'M', contents: 'TTTTAAAA', position: 80..87
       nacha_field :batch_number, inclusion: 'M', contents: 'Numeric', position: 88..94
     end
   end

data/lib/nacha/record/batch_header.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'nacha/record/base.rb'
-require 'nacha/record/batch_header_record_type.rb'
+require 'nacha/record/base'
+require 'nacha/record/batch_header_record_type'
 
 module Nacha
   module Record
@@ -11,15 +11,24 @@ module Nacha
       nacha_field :record_type_code, inclusion: 'M', contents: 'C5', position: 1..1
       nacha_field :service_class_code, inclusion: 'M', contents: 'Numeric', position: 2..4
       nacha_field :company_name, inclusion: 'M', contents: 'Alphameric', position: 5..20
-      nacha_field :company_discretionary_data, inclusion: 'O', contents: 'Alphameric', position: 21..40
-      nacha_field :company_identification, inclusion: 'M', contents: 'Alphameric', position: 41..50
-      nacha_field :standard_entry_class_code, inclusion: 'M', contents: 'Alphameric', position: 51..53
-      nacha_field :company_entry_description, inclusion: 'M', contents: 'Alphameric', position: 54..63
-      nacha_field :company_descriptive_date, inclusion: 'O', contents: 'Alphameric', position: 64..69
-      nacha_field :effective_entry_date, inclusion: 'R', contents: 'YYMMDD', position: 70..75
-      nacha_field :settlement_date_julian, inclusion: 'O', contents: 'Numeric', position: 76..78
-      nacha_field :originator_status_code, inclusion: 'M', contents: 'Alphameric', position: 79..79
-      nacha_field :originating_dfi_identification, inclusion: 'M', contents: 'TTTTAAAA', position: 80..87
+      nacha_field :company_discretionary_data,
+        inclusion: 'O', contents: 'Alphameric', position: 21..40
+      nacha_field :company_identification,
+        inclusion: 'M', contents: 'Alphameric', position: 41..50
+      nacha_field :standard_entry_class_code,
+        inclusion: 'M', contents: 'Alphameric', position: 51..53
+      nacha_field :company_entry_description,
+        inclusion: 'M', contents: 'Alphameric', position: 54..63
+      nacha_field :company_descriptive_date,
+        inclusion: 'O', contents: 'Alphameric', position: 64..69
+      nacha_field :effective_entry_date,
+        inclusion: 'R', contents: 'YYMMDD', position: 70..75
+      nacha_field :settlement_date_julian,
+        inclusion: 'O', contents: 'Numeric', position: 76..78
+      nacha_field :originator_status_code,
+        inclusion: 'M', contents: 'Alphameric', position: 79..79
+      nacha_field :originating_dfi_identification,
+        inclusion: 'M', contents: 'TTTTAAAA', position: 80..87
       nacha_field :batch_number, inclusion: 'M', contents: 'Numeric', position: 88..94
     end
   end

data/lib/nacha/record/batch_header_record_type.rb

@@ -9,16 +9,17 @@ module Nacha
 
       module ClassMethods
         def child_record_types
-          []
+          [
+            'Nacha::Record::BatchControl'
+          ]
         end
       end
 
       def child_record_types
         sec = standard_entry_class_code.to_s.capitalize
         [
-          'Nacha::Record::' + sec + 'EntryDetail',
-          'Nacha::Record::BatchControl'
-        ]
+          "Nacha::Record::#{sec}EntryDetail"
+        ] + self.class.child_record_types
       end
     end
   end

data/lib/nacha/record/boc_entry_detail.rb

@@ -1,13 +1,14 @@
 # coding: utf-8
 # frozen_string_literal: true
 
-require 'nacha/record/base.rb'
-require 'nacha/record/detail_record_type.rb'
+require 'nacha/record/base'
+require 'nacha/record/detail_record_type'
 
 module Nacha
   module Record
     class BocEntryDetail < Nacha::Record::Base
       include DetailRecordType
+
       nacha_field :record_type_code, inclusion: 'M', contents: 'C6', position: 1..1
       nacha_field :transaction_code, inclusion: 'M', contents: 'Numeric', position: 2..3
       nacha_field :receiving_dfi_identification, inclusion: 'M', contents: 'TTTTAAAAC', position: 4..12

data/lib/nacha/record/ccd_addenda.rb

@@ -1,8 +1,8 @@
 # coding: utf-8
 # frozen_string_literal: true
 
-require 'nacha/record/base.rb'
-require 'nacha/record/addenda_record_type.rb'
+require 'nacha/record/base'
+require 'nacha/record/addenda_record_type'
 
 module Nacha
   module Record

data/lib/nacha/record/ccd_entry_detail.rb

@@ -1,13 +1,14 @@
 # coding: utf-8
 # frozen_string_literal: true
 
-require 'nacha/record/base.rb'
-require 'nacha/record/detail_record_type.rb'
+require 'nacha/record/base'
+require 'nacha/record/detail_record_type'
 
 module Nacha
   module Record
     class CcdEntryDetail < Nacha::Record::Base
       include DetailRecordType
+
       nacha_field :record_type_code, inclusion: 'M', contents: 'C6', position: 1..1
       nacha_field :transaction_code, inclusion: 'M', contents: 'Numeric', position: 2..3
       nacha_field :receiving_dfi_identification, inclusion: 'M', contents: 'TTTTAAAAC', position: 4..12

data/lib/nacha/record/cie_addenda.rb

@@ -1,8 +1,8 @@
 # coding: utf-8
 # frozen_string_literal: true
 
-require 'nacha/record/base.rb'
-require 'nacha/record/addenda_record_type.rb'
+require 'nacha/record/base'
+require 'nacha/record/addenda_record_type'
 
 module Nacha
   module Record

data/lib/nacha/record/cie_entry_detail.rb

@@ -1,20 +1,22 @@
 # coding: utf-8
 # frozen_string_literal: true
 
-require 'nacha/record/base.rb'
-require 'nacha/record/detail_record_type.rb'
+require 'nacha/record/base'
+require 'nacha/record/detail_record_type'
 
 module Nacha
   module Record
     class CieEntryDetail < Nacha::Record::Base
       include DetailRecordType
+
       nacha_field :record_type_code, inclusion: 'M', contents: 'C6', position: 1..1
       nacha_field :transaction_code, inclusion: 'M', contents: 'Numeric', position: 2..3
       nacha_field :receiving_dfi_identification, inclusion: 'M', contents: 'TTTTAAAAC', position: 4..12
       nacha_field :dfi_account_number, inclusion: 'R', contents: 'Alphameric', position: 13..29
       nacha_field :amount, inclusion: 'M', contents: '$$$$$$$$¢¢', position: 30..39
       nacha_field :individual_name, inclusion: 'R', contents: 'Alphameric', position: 40..54
-      nacha_field :individual_identification_number, inclusion: 'M', contents: 'Alphameric', position: 55..76
+      nacha_field :individual_identification_number, inclusion: 'M', contents: 'Alphameric',
+        position: 55..76
       nacha_field :discretionary_data, inclusion: 'O', contents: 'Alphameric', position: 77..78
       nacha_field :addenda_record_indicator, inclusion: 'M', contents: 'Numeric', position: 79..79
       nacha_field :trace_number, inclusion: 'M', contents: 'Numeric', position: 80..94

data/lib/nacha/record/ctx_addenda.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'nacha/record/base.rb'
-require 'nacha/record/addenda_record_type.rb'
+require 'nacha/record/base'
+require 'nacha/record/addenda_record_type'
 module Nacha
   module Record
     class CtxAddenda < Nacha::Record::Base

data/lib/nacha/record/ctx_corporate_entry_detail.rb

@@ -1,8 +1,8 @@
 # coding: utf-8
 # frozen_string_literal: true
 
-require 'nacha/record/base.rb'
-require 'nacha/record/detail_record_type.rb'
+require 'nacha/record/base'
+require 'nacha/record/detail_record_type'
 
 module Nacha
   module Record

data/lib/nacha/record/detail_record_type.rb

@@ -9,7 +9,10 @@ module Nacha
 
       module ClassMethods
         def child_record_types
-          []
+          [
+            "Nacha::Record::FirstIatAddenda"
+            # Among other ...
+          ]
         end
 
         def next_record_types

data/lib/nacha/record/dne_addenda.rb

@@ -1,8 +1,8 @@
 # coding: utf-8
 # frozen_string_literal: true
 
-require 'nacha/record/base.rb'
-require 'nacha/record/addenda_record_type.rb'
+require 'nacha/record/base'
+require 'nacha/record/addenda_record_type'
 
 module Nacha
   module Record

data/lib/nacha/record/dne_entry_detail.rb

@@ -1,20 +1,22 @@
 # coding: utf-8
 # frozen_string_literal: true
 
-require 'nacha/record/base.rb'
-require 'nacha/record/detail_record_type.rb'
+require 'nacha/record/base'
+require 'nacha/record/detail_record_type'
 
 module Nacha
   module Record
+    # Represents a Death Notification Entry (DNE) detail record.
     class DneEntryDetail < Nacha::Record::Base
       include DetailRecordType
 
       nacha_field :record_type_code, inclusion: 'M', contents: 'C6', position: 1..1
       nacha_field :transaction_code, inclusion: 'M', contents: 'Numeric', position: 2..3
       nacha_field :receiving_dfi_identification, inclusion: 'M', contents: 'TTTTAAAAC', position: 4..12
-      nacha_field :receiving_dfi_identification, inclusion: 'M', contents: 'Alphameric', position: 13..29
+      nacha_field :dfi_account_number, inclusion: 'M', contents: 'Alphameric', position: 13..29
       nacha_field :amount, inclusion: 'M', contents: '$$$$$$$$¢¢', position: 30..39
-      nacha_field :individual_identification_number, inclusion: 'O', contents: 'Alphameric', position: 40..54
+      nacha_field :individual_identification_number, inclusion: 'O', contents: 'Alphameric',
+        position: 40..54
       nacha_field :individual_name, inclusion: 'R', contents: 'Alphameric', position: 55..76
       nacha_field :discretionary_data, inclusion: 'O', contents: 'Alphameric', position: 77..78
       nacha_field :addenda_record_indicator, inclusion: 'M', contents: 'Numeric', position: 79..79

data/lib/nacha/record/enr_addenda.rb

@@ -1,11 +1,12 @@
 # coding: utf-8
 # frozen_string_literal: true
 
-require 'nacha/record/base.rb'
-require 'nacha/record/addenda_record_type.rb'
+require 'nacha/record/base'
+require 'nacha/record/addenda_record_type'
 
 module Nacha
   module Record
+    # Represents an Automated Enrollment Entry (ENR) addenda record.
     class EnrAddenda < Nacha::Record::Base
       include AddendaRecordType