nacha 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 477c410ef1a0443262759b86291032260ad0e6f125421ab58894110895a9d087
-  data.tar.gz: f6b132e7c97d5f38688ca32f7c893f83775cc74bc42dbc4d1b13c158d55485c2
+  metadata.gz: 782ae8de3e488c9404aab641bf27e71da0b9bc6d391d235dbec10fc8d750c27a
+  data.tar.gz: 76e485087bcdd967c437912b1318bd79f21e50c1e9ed6eb3dbd73ea3233b86ec
 SHA512:
-  metadata.gz: 4566aa3cd1a369abbf6f80274914a730fd987f84ab06daa6a0fb7916221ea9ca1510ba254cea24d39c701ffa57937df867e687fa5cb31f904924948400ea5eae
-  data.tar.gz: ddc39965a93e0b14b2a9517736af0c1b5dd8c7620fd2fbf4dce2a914342ccd979bb66799bc278446d795a16f9b34720e89b69f9192d6e8a794c2570f90c2a812
+  metadata.gz: 799751bb17453a1f28e7e0b362e7a06eb017445d5928c06e7130c15c6d7b6a6a427e2b96ecb05567fafc60107400c82e39e0c81799158f2d942af6839ba470b7
+  data.tar.gz: adf86d5aa5302590c53c0333e3ea7a32c5e0e3ed255da5bf8812d0d2e853173e31b8cf12a7ba1602b9c0420f1aa52eedd9c54f7698f90ba11f0a399bd787bb42

data/CHANGELOG.md

@@ -0,0 +1,81 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.6] - 2025-06-20
+
+- Better code coverage
+
+- fixed an issue with jruby running tests
+
+- Bump version to 0.1.6
+
+
+## [0.1.5] - 2025-06-18
+
+### Fixed
+- Actual reporting of field errors now in the output html.
+- Change Nacha::Record::BatchControl#reserved to optional
+- Change Nacha::Record::BatchHeader#settlement_date_julian to optional
+- bump version to 0.1.5
+
+## [0.1.4] - 2025-06-14
+
+### Added
+- Store the original input line on parsed records for easier debugging.
+
+### Changed
+- Group metadata into a nested `metadata` object in `to_h` output for better organization.
+
+### Fixed
+- Resolved a module loading issue.
+
+## [0.1.3] - 2025-06-14
+
+### Added
+- Introduced SimpleCov for tracking code coverage.
+- Added comprehensive tests for `Nacha::Record::Filler`.
+
+### Changed
+- Improved parsing with stricter matching for numeric fields and better handling of records not 94 bytes long.
+- Enhanced HTML output with better class handling.
+- Refactored `Nacha::Numeric` for better clarity and added more tests.
+
+### Fixed
+- Improved error parsing and reporting.
+- Corrected memoization for `Nacha::Record.matcher`.
+
+## [0.1.2] - 2025-06-04
+
+### Added
+- Introduced a command-line interface (CLI) using Thor.
+- The CLI includes a `parse` command to process ACH files and output a summary to the console or generate an HTML representation.
+
+## [0.1.1] - 2025-05-31
+
+### Fixed
+- Corrected an issue with `Nacha::AchDate` parsing on JRuby.
+- Fixed gem file loading in Rails environments.
+- Replaced deprecated `BigDecimal.new` with `BigDecimal()`.
+
+### Removed
+- Removed `pry` as a dependency.
+
+## [0.1.0] - 2017-03-06
+
+### Added
+- Initial release of the Nacha gem.
+- Core functionality to define NACHA record types and their fields.
+- Parser for processing NACHA files from strings.
+- Ability to generate NACHA-formatted strings from record objects (`to_ach`).
+- Ability to convert records to JSON (`to_json`) and Hashes (`to_h`).
+- Initial implementation of field and record validations.
+- Extensive test suite using RSpec and later FactoryBot.
+
+### Changed
+- Major architectural refactoring to define records in pure Ruby classes (`nacha_field`) instead of external YAML files.

data/exe/nacha

@@ -36,10 +36,12 @@ module Nacha
 
     private
 
-    def output_html(file_path, ach_file)
+    def output_html(file_path, ach_records)
       puts html_preamble
       puts "<h1>Successfully parsed #{file_path}</h1>\n"
-      display_child(0, ach_file.first) # Display the first record
+      ach_records.each do |record|
+        display_child(0, record)
+      end
       puts html_postamble
     end
 
@@ -55,17 +57,12 @@ module Nacha
       # Attempt to call a summary or to_s method if it exists,
       # otherwise inspect the record.
       return unless record
-      level_indent = '  ' * level.to_i
-      puts "<html>"
       puts record.to_html
       if record.respond_to?(:children) && record.children.any?
-        if record.children.any?
-          record.children.each_with_index do |child_record, child_index|
-            display_child(level + 1, child_record)
-          end
+        record.children.each do |child_record|
+          display_child(level + 1, child_record)
         end
       end
-      puts "</html>"
     end
   end
 end

data/lib/nacha/aba_number.rb

@@ -9,6 +9,7 @@ class Nacha::AbaNumber
   include HasErrors
 
   def initialize(routing_number)
+    @errors = []
     self.routing_number = routing_number
   end
 
@@ -23,7 +24,8 @@ class Nacha::AbaNumber
 
   def routing_number=(val)
     @valid = nil
-    @routing_number = val.strip
+    @errors&.clear
+    @routing_number = val.to_s.strip
   end
 
   def add_check_digit
@@ -35,15 +37,25 @@ class Nacha::AbaNumber
   end
 
   def valid?
-    @valid ||= valid_routing_number_length? && valid_check_digit?
+    @valid ||= if valid_routing_number_length?
+               if @routing_number.length == 9
+                 valid_check_digit?
+               else # 8 digits is valid
+                 true
+               end
+             else
+               false
+             end
   end
 
   def valid_routing_number_length?
-    if @routing_number.length != 9
-      add_error("Routing number must be 9 digits long, but was #{@routing_number.length} digits long.")
-      false
-    else
+    actual_length = @routing_number.length
+
+    if [9, 10].include?(actual_length)
       true
+    else
+      add_error("Routing number must be 8 or 9 digits long, but was #{actual_length} digits long.")
+      false
     end
   end
 

data/lib/nacha/ach_date.rb

@@ -36,7 +36,7 @@ class Nacha::AchDate < Date
     # This works because `Date.new` is designed to be effectively `allocate.initialize`.
     super(year, month, day)
 
-  rescue ArgumentError => e
+  rescue TypeError, ArgumentError => e
     # Catch errors that might arise from strptime or invalid date components
     raise ArgumentError, "Invalid date format for Nacha::AchDate: #{args.inspect}. Original error: #{e.message}"
   end

data/lib/nacha/field.rb

@@ -25,6 +25,8 @@ class Nacha::Field
     @fill_character = ' '
     @json_output = [:to_s]
     @output_conversion = [:to_s]
+    @validated = false
+    @data_assigned = false
     opts.each do |k, v|
       setter = "#{k}="
       if respond_to?(setter)
@@ -38,8 +40,6 @@ class Nacha::Field
   def contents=(val)
     @contents = val
     case @contents
-    when /\AC(.*)\z/ # Constant
-      @data = Regexp.last_match(1)
     when /\$.*¢*/
       @data_type = Nacha::Numeric
       @justification = :rjust
@@ -71,10 +71,15 @@ class Nacha::Field
       @justification = :ljust
       @output_conversion = [:to_s]
       @fill_character = ' '
+    when /\AC(.*)\z/ # Constant
+      @data = Regexp.last_match(1)
     end
   end
 
   def data=(val)
+    @validated = false
+    @data_assigned = true
+    @errors = []
     @data = @data_type.new(val)
     @input_data = val
   rescue StandardError => e
@@ -96,10 +101,44 @@ class Nacha::Field
     @inclusion == 'O'
   end
 
+  def validate
+    return if @validated
+
+    add_error("'inclusion' must be present for a field definition.") unless @inclusion
+    add_error("'position' must be present for a field definition.") unless @position
+    add_error("'contents' must be present for a field definition.") unless @contents
+
+    if @data_assigned && (mandatory? || required?) && (@input_data.nil? || @input_data.to_s.strip.empty?)
+      add_error("'#{human_name}' is a required field and cannot be blank.")
+    end
+
+    # Type-specific validations
+    if @data_type == Nacha::Numeric && @input_data.to_s.strip.match(/\D/)
+      add_error("Invalid characters in numeric field '#{human_name}'. Got '#{@input_data}'.")
+    end
+
+    # If data object has its own validation, run it.
+    if @validator && @data.is_a?(@data_type)
+      # The call to the validator might populate errors on the data object.
+      is_valid = @data.send(@validator)
+
+      # Collect any errors from the data object.
+      if @data.respond_to?(:errors) && @data.errors && @data.errors.any?
+        @data.errors.each { |e| add_error(e) }
+      end
+
+      # If it's not valid and we haven't collected any specific errors, add a generic one.
+      if !is_valid && errors.empty?
+        add_error("'#{human_name}' is invalid. Got '#{@input_data}'.")
+      end
+    end
+
+    @validated = true
+  end
+
   def valid?
-    @valid = inclusion && contents && position
-    @valid &&= @data.send(@validator) if @validator && @data
-    @valid
+    validate
+    errors.empty?
   end
 
   def add_error(err_string)
@@ -138,7 +177,7 @@ class Nacha::Field
   end
 
   def to_html
-    tooltip_text = "<span class=\"tooltiptext\" >#{human_name}</span>"
+    tooltip_text = "<span class=\"tooltiptext\" >#{human_name} #{errors.join(' ')}</span>"
     field_classes = ["nacha-field tooltip"]
     field_classes += ['mandatory'] if mandatory?
     field_classes += ['required'] if required?

data/lib/nacha/numeric.rb

@@ -5,14 +5,12 @@ class Nacha::Numeric
   end
 
   def to_i
-    if @value
-      if @value.is_a?(String) && @value.match(/\A *\z/)
-        @value # blank strings should return as blank
-      else
-        @value.to_i
-      end
+    return 0 if @value.nil?
+
+    if @value.is_a?(String) && @value.match(/\A *\z/)
+      @value # blank strings should return as blank
     else
-      self
+      @value.to_i
     end
   end
 

data/lib/nacha/parser_context.rb

@@ -11,7 +11,7 @@ class Nacha::ParserContext
   attr_accessor :previous_record
   attr_reader :validated
 
-  def initialize (opts = {})
+  def initialize(opts = {})
     @file_name = opts[:file_name] || ''
     @line_number = opts[:line_number] || 0
     @line_length = opts[:line_length] || 0

data/lib/nacha/record/adv_file_control.rb

@@ -16,9 +16,9 @@ module Nacha
       nacha_field :total_credit_entry_dollar_amount_in_file, inclusion: 'M', contents: '$$$$$$$$$$¢¢', position: 52..71
       nacha_field :reserved, inclusion: 'M', contents: 'C', position: 72..94
 
-      def initialize
-        create_fields_from_definition
-      end
+#      def initialize
+#        create_fields_from_definition
+#      end
     end
   end
 end

data/lib/nacha/record/base.rb

@@ -10,12 +10,13 @@ module Nacha
       include Validations::FieldValidations
 
       attr_accessor :children, :parent, :fields
-      attr_reader :name, :validations, :errors
+      attr_reader :name, :validations, :errors, :original_input_line
       attr_accessor :line_number
 
       def initialize(opts = {})
         @children = []
         @errors = []
+        @original_input_line = nil
         create_fields_from_definition
         opts.each do |k, v|
           setter = "#{k}="
@@ -113,8 +114,14 @@ module Nacha
           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
+      end # end class methods
+
+      def original_input_line=(line)
+        @original_input_line = line.dup if line.is_a?(String)
       end
 
       def create_fields_from_definition
@@ -133,7 +140,13 @@ module Nacha
       end
 
       def to_h
-        { nacha_record_type: record_type }.merge(
+        { nacha_record_type: record_type,
+          metadata: {
+            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)
@@ -172,8 +185,12 @@ module Nacha
       end
 
       def validate
-        failing_checks = self.class.definition.keys.map do |field|
-          next true unless self.class.validations[field]
+        # Run field-level validations first
+        @fields.values.each(&: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)
@@ -182,22 +199,13 @@ module Nacha
             self.class.send(validation_method, field_data)
           end
           # rubocop:enable GitlabSecurity/PublicSend
-        end.flatten
+        end
       end
 
       # look for invalid fields, if none, then return true
       def valid?
-        # statuses = self.class.definition.keys.map do |field_sym|
-        #   # rubocop:disable GitlabSecurity/PublicSend
-        #   field = send(field_sym)
-        #   # rubocop:enable GitlabSecurity/PublicSend
-        #   next true unless field.mandatory?
-
-        #   ## TODO: levels of validity with 'R' and 'O' fields
-        #   field.valid?
-        # end
-        statuses = validate
-        (statuses.detect { |valid| valid == false } != false)
+        validate
+        errors.empty?
       end
 
       # Checks if the current transaction code represents a debit transaction.

data/lib/nacha/record/batch_control.rb

@@ -16,7 +16,7 @@ module Nacha
       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: 'M', contents: 'C      ', position: 74..79
+      nacha_field :reserved, inclusion: 'O', contents: 'C      ', position: 74..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

data/lib/nacha/record/batch_header.rb

@@ -17,7 +17,7 @@ module Nacha
       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: 'M', contents: 'Numeric', position: 76..78
+      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

data/lib/nacha/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Nacha
-  VERSION = '0.1.4'
+  VERSION = '0.1.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nacha
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - David H. Wilkins
@@ -220,6 +220,7 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt