nacha 0.1.7 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8375798ff41c91e7a14ae4ebbf1442f7ceaf83ae7f61c81b1b88c87fd2ca4760
-  data.tar.gz: b35fa722059c4eab240896141868eb27cd2b17c5c17539b5281a5d2a71ccfb07
+  metadata.gz: 6d8625f3af750aa7ba6e526909ad823f6020b761ab740616e82650f856585a13
+  data.tar.gz: 459d7359527c582eddf7d46770b2527896d465db86be48a1f6a994bc8d15471d
 SHA512:
-  metadata.gz: f5bd9637030e63e90ca54b3203a09341badba050d4b9351063e2ea6c2da743ecbf33539280e1b7fc03b44a93bfa90fb644ace1cd895a98ee473e7925ca0b0454
-  data.tar.gz: 49b0621426a2609b6f65b4385f159cd053cfd9e7dc6e294850b1bcf7b1c7c723f771d2487e494a9dee0c704c4d572e35f5441c8391ddf2b78460d4c7f2a55b77
+  metadata.gz: fb31a6b021d3a7b7752f079651bfc5d2f78d5623883ab91201e76853273c3002c1d4a0423d971d5c75a2c38b03faee3e31d64d7cf82cb28f632c4c4174a6526b
+  data.tar.gz: 2aaf5af05547d0e0f10afb1f2a310e70b69e11c359979df5d238389c7800ab3f76ff163a5f35275162809f44b923603c2ed69658c96fe11e7f86eb8cbdf204cf

data/.rubocop.yml

@@ -3,7 +3,7 @@ inherit_gem:
     - rubocop-default.yml
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 3.2
   Exclude:
     - 'tmp/**/*'
     - 'bin/**/*'

data/CHANGELOG.md

@@ -7,6 +7,38 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.10] - 2025-07-01
+
+- Added ability to get a list of possible record types and
+  the ability parse just 1 record
+
+- Fixed a bug where AdvFileControl did not have the FileControlRecordType
+  included
+
+## [0.1.9] - 2025-06-25
+
+- Fixed AdvFileHeaer definition to include constant `ADV FILE` mentioned in the
+  NACHA documentation
+
+- Added automatic debugger gem selection based on ruby version (ruby or jruby)
+
+- Fixed Nacha.ach_record_types to have the correct list of record types by moving
+  the Nacha.add_ach_record_type(...) call above a possible return
+
+- Added contentEditable to the generate HTML
+
+- Added AdvFileHeader as one of the first records that should be found
+
+- Removed a bunch of versions from nacha.gemspec
+
+## [0.1.8] - 2025-06-24
+
+- Now parses filler records correctly (fixed definition)
+
+- Add support for `ack_entry_detail` record type
+
+- Tweaked the child record types for file_control and file_header
+
 ## [0.1.7] - 2025-06-23
 
 - Better parsing.  Nacha::Record::FileControl had issues parsing if the reserved

data/README.md

@@ -60,7 +60,7 @@ API may change at any time.   Pull requests welcomed
 
 ```
 nacha parse ach_file.ach > ach_file.html`
-
+```
 
 ## Discussion
 

data/exe/nacha

@@ -1,6 +1,5 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
-
 require 'thor'
 require 'nacha' # Assuming this loads the Nacha gem
 

data/lib/nacha/field.rb

@@ -108,7 +108,9 @@ class Nacha::Field
     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?)
+    if @data_assigned &&
+       (mandatory? || required?) &&
+       ((@input_data.nil? || @input_data.to_s.empty?) && @contents !~ /\AC(  *)\z/)
       add_error("'#{human_name}' is a required field and cannot be blank.")
     end
 
@@ -185,7 +187,7 @@ class Nacha::Field
     field_classes += ['error'] if errors.any?
 
     ach_string = to_ach.gsub(' ', ' ')
-    "<span data-field-name=\"#{@name}\" class=\"#{field_classes.join(' ')}\" data-name=\"#{@name}\">#{ach_string}" +
+    "<span data-field-name=\"#{@name}\" contentEditable=true class=\"#{field_classes.join(' ')}\" data-name=\"#{@name}\">#{ach_string}" +
       tooltip_text.to_s +
       "</span>"
   end

data/lib/nacha/parser.rb

@@ -3,25 +3,38 @@
 require 'nacha'
 require 'nacha/parser_context'
 
+# Nacha Parser - deal with figuring out what record type a line is
 class Nacha::Parser
-  DEFAULT_RECORD_TYPES = ['Nacha::Record::FileHeader',
-                         'Nacha::Record::Filler'].freeze
+  DEFAULT_RECORD_TYPES = ['Nacha::Record::AdvFileHeader',
+                          'Nacha::Record::FileHeader',
+                          'Nacha::Record::Filler'].freeze
 
   attr_reader :context
 
   def initialize
     @context = Nacha::ParserContext.new
-    reset!
   end
 
-  def reset!; end
-
   def parse_file(file)
     @context.parser_started_at = Time.now
     @context.file_name = file
     parse_string(file.read)
   end
 
+  def detect_possible_record_types(line)
+    Nacha.ach_record_types.map do |record_type|
+      record_type if record_type.matcher =~ line
+    end.compact
+  end
+
+  def parse_line(line)
+    record_types = detect_possible_record_types(line)
+
+    records = record_types.map do |record_type|
+
+    end
+  end
+
   def parse_string(str)
     line_num = -1
     records = []
@@ -39,11 +52,10 @@ class Nacha::Parser
   def process(line, line_num, previous = nil)
     @context.line_errors = []
     parent = previous
-    record = nil
 
     record_types = valid_record_types(parent)
     while record_types
-      record = parse_by_types(line, record_types)
+      record = parse_first_by_types(line, record_types)
       break if record || !parent
       record.validate if record
       parent = parent.parent
@@ -67,11 +79,21 @@ class Nacha::Parser
     child.parent = parent
   end
 
-  def parse_by_types(line, record_types)
+  def parse_first_by_types(line, record_types)
     record_types.detect do |rt|
-      record_type = Object.const_get(rt)
+      record_type = rt.is_a?(Class) ? rt : Object.const_get(rt)
+      record = nil
       record = record_type.parse(line) if record_type.matcher =~ line
       return record if record
     end
   end
+
+  def parse_all_by_types(line, record_types)
+    record_types.map do |rt|
+      record_type = rt.is_a?(Class) ? rt : Object.const_get(rt)
+      record = nil
+      record = record_type.parse(line) if record_type.matcher =~ line
+      record
+    end.compact
+  end
 end

data/lib/nacha/record/ack_entry_detail.rb

@@ -0,0 +1,23 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+require 'nacha/record/base.rb'
+require 'nacha/record/detail_record_type.rb'
+
+module Nacha
+  module Record
+    class AckEntryDetail < 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 :originl_entry_trace_number, inclusion: 'M', contents: 'Numeric', position: 40..54
+      nacha_field :receiving_company_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
+      nacha_field :trace_number, inclusion: 'M', contents: 'Numeric', position: 80..94
+    end
+  end
+end

data/lib/nacha/record/adv_batch_control.rb

@@ -6,6 +6,8 @@ require 'nacha/record/batch_control_record_type.rb'
 
 module Nacha
   module Record
+
+    # The AdvBatchControl record is used to control the batch of adv entry detail records.
     class AdvBatchControl < Nacha::Record::Base
       nacha_field :record_type_code, inclusion: 'M', contents: 'C8', position: 1..1
       nacha_field :service_class_code, inclusion: 'M', contents: 'Numeric', position: 2..4

data/lib/nacha/record/adv_file_control.rb

@@ -7,6 +7,7 @@ require 'nacha/record/file_control_record_type.rb'
 module Nacha
   module Record
     class AdvFileControl < Nacha::Record::Base
+      include FileControlRecordType
       nacha_field :record_type_code, inclusion: 'M', contents: 'C9', position: 1..1
       nacha_field :batch_count, inclusion: 'M', contents: 'Numeric', position: 2..7
       nacha_field :block_count, inclusion: 'M', contents: 'Numeric', position: 8..13
@@ -15,10 +16,6 @@ module Nacha
       nacha_field :total_debit_entry_dollar_amount_in_file, inclusion: 'M', contents: '$$$$$$$$$$¢¢', position: 32..51
       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
     end
   end
 end

data/lib/nacha/record/adv_file_header.rb

@@ -20,7 +20,7 @@ module Nacha
       nacha_field :format_code, inclusion: 'M', contents: 'C1', position: 40..40
       nacha_field :immediate_destination_name, inclusion: 'M', contents: 'Alphameric', position: 41..63
       nacha_field :immediate_origin_name, inclusion: 'M', contents: 'Alphameric', position: 64..86
-      nacha_field :reference_code, inclusion: 'M', contents: 'Alphameric', position: 87..94
+      nacha_field :reference_code, inclusion: 'M', contents: 'CADV FILE', position: 87..94
     end
   end
 end

data/lib/nacha/record/base.rb

@@ -30,6 +30,7 @@ module Nacha
 
       class << self
         def nacha_field(name, inclusion:, contents:, position:)
+          Nacha.add_ach_record_type(self)
           definition[name] = { inclusion: inclusion,
                                contents: contents,
                                position: position,
@@ -39,7 +40,6 @@ module Nacha
 
           validations[name] ||= []
           validations[name] << validation_method
-          Nacha.add_ach_record_type(self)
         end
 
         def definition
@@ -90,12 +90,8 @@ module Nacha
                              last_match
                            end
                          elsif d[:contents] =~ /\ANumeric\z/
-                           if output_started
-                             '[0-9 ]' + "{#{(d[:position] || d['position']).size}}"
-                           else
-                             skipped_output = true
-                             ''
-                           end
+                           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}}"
@@ -124,6 +120,10 @@ module Nacha
           rec.validate
           rec
         end
+
+        def record_type
+          Nacha.record_name(self)
+        end
       end # end class methods
 
       def original_input_line=(line)
@@ -138,7 +138,7 @@ module Nacha
       end
 
       def record_type
-        Nacha.record_name(self.class)
+        self.class.record_type
       end
 
       def human_name
@@ -148,6 +148,7 @@ module Nacha
       def to_h
         { nacha_record_type: record_type,
           metadata: {
+            klass: self.class.name,
             errors: errors,
             line_number: @line_number,
             original_input_line: original_input_line

data/lib/nacha/record/file_control_record_type.rb

@@ -9,7 +9,9 @@ module Nacha
 
       module ClassMethods
         def child_record_types
-          []
+          [
+            "Nacha::Record::Filler",
+          ]
         end
       end
 

data/lib/nacha/record/file_header.rb

@@ -5,9 +5,11 @@ require 'nacha/record/file_header_record_type.rb'
 
 module Nacha
   module Record
+
+    # The FileHeader record is the first record in a
+    # Nacha file and contains information about the file itself.
     class FileHeader < Nacha::Record::Base
       include FileHeaderRecordType
-
       nacha_field :record_type_code, inclusion: 'M', contents: 'C1', position: 1..1
       nacha_field :priority_code, inclusion: 'R', contents: 'Numeric', position: 2..3
       nacha_field :immediate_destination, inclusion: 'M', contents: 'bTTTTAAAAC', position: 4..13

data/lib/nacha/record/file_header_record_type.rb

@@ -12,7 +12,6 @@ module Nacha
           [
             'Nacha::Record::BatchHeader',
             'Nacha::Record::FileControl',
-            'Nacha::Record::Filler'
           ]
         end
       end

data/lib/nacha/record/filler.rb

@@ -9,8 +9,8 @@ module Nacha
     class Filler < Nacha::Record::Base
       include FillerRecordType
 
-      nacha_field :record_type_code, inclusion: 'M', contents: ('C' + ('9' * 93)), position: 1..1
-      nacha_field :filler, inclusion: 'M', contents: 'Numeric', position: 2..94
+      nacha_field :record_type_code, inclusion: 'M', contents: 'C9', position: 1..1
+      nacha_field :filler, inclusion: 'M', contents: ('C' + ('9' * 93)), position: 2..94
     end
   end
 end

data/lib/nacha/version.rb

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

data/lib/nacha.rb

@@ -1,5 +1,14 @@
 # frozen_string_literal: true
 
+# Uncomment to use debugger
+# if RUBY_ENGINE == 'ruby'
+#   require "byebug"
+# end
+#
+# if RUBY_ENGINE == 'jruby'
+#   require "pry-nav"
+# end
+
 require 'yaml'
 require 'nacha/version'
 require 'nacha/aba_number'
@@ -7,6 +16,10 @@ require 'nacha/ach_date'
 require 'nacha/field'
 require 'nacha/numeric'
 
+# Nacha is a Ruby gem for parsing, validating, and generating NACHA
+# (National Automated Clearing House Association) files.
+# It provides a structured way to work with ACH (Automated Clearing House) records,
+# including various entry detail, addenda, batch, and file control records.
 module Nacha
   STANDARD_ENTRY_CLASS_CODES = %w[ACK ADV ARC ATX BOC CCD PPD CIE
                                   COR CTX DNE ENR IAT POP POS SHR
@@ -20,17 +33,37 @@ module Nacha
                                 48 49 55 56 82 84 86 88].freeze
 
   TRANSACTION_CODES = (CREDIT_TRANSACTION_CODES + DEBIT_TRANSACTION_CODES).freeze
-  @@ach_record_types = []
 
-  def self.add_ach_record_type(klass)
-    @@ach_record_types << klass unless @@ach_record_types.include?(klass)
-  end
+  class << self
+    # Adds a new ACH record type class to the list of defined record types.
+    # This is used internally by the parser to determine which record classes
+    # are available for parsing a NACHA file.  As the `nacha_field` method is
+    # executed for each of the record types, these record types are added to
+    # the Nacha module's class variable `@@ach_record_types`.
+    #
+    # @param klass [Class, String] The record class or its name (as a String) to add.
+    # @return [void]
+    def add_ach_record_type(klass)
+      return unless klass
 
-  def self.ach_record_types
-    @@ach_record_types
-  end
+      klass = klass.to_s
+      @ach_record_types ||= []
+      @ach_record_types << klass unless @ach_record_types.include?(klass)
+    end
 
-  class << self
+    # Returns an array of all currently registered ACH record type class names.
+    #
+    # @return [Array<String>] An array of strings representing the names of ACH record classes.
+    def ach_record_types
+      @ach_record_types || []
+    end
+
+    # Parses a NACHA file or string into a structured object representation.
+    #
+    # @param object [String, File, IO] The input to parse, either a string containing
+    #   NACHA data or an IO object (e.g., a File) representing the NACHA file.
+    # @return [Nacha::Record::Base] The parsed NACHA file object, typically a FileHeader record
+    #   with nested batch and entry detail records.
     def parse(object)
       parser = Nacha::Parser.new
       if object.is_a?(String)
@@ -40,10 +73,21 @@ module Nacha
       end
     end
 
+    # Converts a given string into a underscored, lowercase record name.
+    # This is typically used to derive a human-readable or programmatic
+    # name from a class name or similar string.
+    #
+    # @param str [String] The string to convert.
+    # @return [String] The underscored and lowercased record name.
     def record_name(str)
       underscore(str.to_s).split('/').last
     end
 
+    # Converts a camel-cased string to its underscore equivalent.
+    # This method handles module namespaces (::) by converting them to slashes.
+    #
+    # @param str [String] The string to underscore.
+    # @return [String] The underscored string.
     def underscore(str)
       str.gsub(/::/, '/').
         gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
@@ -54,6 +98,18 @@ module Nacha
   end
 end
 
+# Load all record types from nacha/record/*.rb and nacha/record/**/*.rb
+# This will ensure that all record classes are loaded before the parser is used
+
+require 'nacha/record/base'
+require 'nacha/record/file_header_record_type'
+require 'nacha/record/file_control_record_type'
+require 'nacha/record/detail_record_type'
+
+# Ensure that the record types are loaded before the parser is used
+# This is necessary because the parser relies on the record types being defined
+# and available in the Nacha module.
+
 Gem.find_files('nacha/record/*.rb').reject{|f| f =~ /\/spec\//}.each do |file|
   require File.expand_path(file)
 end
@@ -62,5 +118,6 @@ Gem.find_files('nacha/record/**/*.rb').reject{|f| f =~ /\/spec\//}.each do |file
   require File.expand_path(file)
 end
 
-require 'nacha/parser'
+# Load the parser after the records have been defined
 
+require 'nacha/parser'

data/nacha.gemspec

@@ -23,15 +23,21 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.add_dependency 'bigdecimal'
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "bundler"
+  # Conditionally add byebug only for MRI Ruby
+  if RUBY_ENGINE == 'ruby'
+    spec.add_development_dependency "byebug"
+  end
+  if RUBY_ENGINE == 'jruby'
+    spec.add_development_dependency "pry-nav"
+  end
   spec.add_development_dependency "pry"
   spec.add_development_dependency "factory_bot"
   spec.add_development_dependency "gitlab-styles"
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-rspec"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
   spec.add_development_dependency "rubocop"
   spec.add_development_dependency 'rubocop-performance'
   spec.add_development_dependency 'rubocop-rspec'

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nacha
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.10
 platform: ruby
 authors:
 - David H. Wilkins
+autorequire:
 bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2025-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -27,16 +28,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -125,30 +126,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -238,6 +239,7 @@ files:
 - lib/nacha/numeric.rb
 - lib/nacha/parser.rb
 - lib/nacha/parser_context.rb
+- lib/nacha/record/ack_entry_detail.rb
 - lib/nacha/record/addenda_record_type.rb
 - lib/nacha/record/adv_batch_control.rb
 - lib/nacha/record/adv_entry_detail.rb
@@ -305,6 +307,7 @@ homepage: https://github.com/dwilkins/nacha
 licenses:
 - MIT
 metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -319,7 +322,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: Ruby parser for ACH files.
 test_files: []