gm_x12 1.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 47076ff1898b45a34dc997327a1872f7715c475573c46c83c99f03d7be597c76
+  data.tar.gz: ea6b5e6fbf9f3534e050d9438ca32940cbfe4d057bb7e5cab862429c3cb0766d
+SHA512:
+  metadata.gz: b465214a3983ddb1670a7c916fcfd41f3807a74d6faf031e2d374d273c4be32cd5616e751e703bc182671b1dd7b4026e6e9a018b39fa7ebbd290b6acf46986ff
+  data.tar.gz: 5aeddcc6e2be79f9d24954338caf43ac10637c5ea75a0f18f78c01e48439b63df3e84d50de711c0516c83d0a1a113141d78166145aa9a39f2b221dbe70e1c643

data/.gitignore

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

data/.project

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>x12</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+	</buildSpec>
+	<natures>
+		<nature>com.aptana.projects.webnature</nature>
+		<nature>com.aptana.ruby.core.rubynature</nature>
+	</natures>
+</projectDescription>

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in x12.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 P&D Technology Solutions, LLC
+
+MIT License
+
+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,100 @@
+# X12
+
+Current version has been upgraded to run under ruby version >= 1.9.1
+
+Changes welcome, especially new document types or better tests.
+
+# License
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+## Installation
+
+If running Ubuntu, you may need to install libxml2-dev
+
+Add this line to your application's Gemfile:
+
+    gem 'pd_x12'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pd_x12
+
+
+ 
+## Documentation
+### Wiki Page: https://github.com/GoodmeasuresLLC/x12/wiki
+
+## Major deficiencies
+
+    Validation is not implemented.
+    Field types are ignored.
+    No access methods for composites’ fields.
+    Segments can't repeat by repeating the declaration.
+
+# Acknowledgments
+
+The authors of the project were inspired by the following works:
+
+    * The Perl X12 parser by Prasad Poruporuthan, search.cpan.org/~prasad/X12-0.09/lib/X12/Parser.pm
+    * The Ruby port of the above by Chris Parker, rubyforge.org/projects/x12-parser/
+    * This project originated from App Design's X12 parser.  
+	* Project was forked by Sean Walberg, creating version 1.2.0 in April 2012.
+	* Project was forked by Marty Petersen in November 2012, creating pd_x12.
+    * Project was forked by GoodMeasures, Jun 2021, trying to make it work for large eligibility files, and work for Ruby 2.7.1. In particular, work for a file of about 9000 members from Wellcare.
+
+
+# Change Log
+21/07/10
+* tl;dr - Made this gem actually useful.
+* 834 Definition file was fixed - it was only processing one transaction, and had
+  multiple syntax errors/missing elements. At least, it now works for the client file I have
+* client file was ~9000 records. At the rate of processing when I forked the gem, it would have taken about a month to process a monthly file
+* performance fix - use string compare before using a regex, as 90% of the segment parses fail as the gem backs its way up.
+* because the gem uses tail recursion, it failed after about ~4000 eligibility records. Converted that code to using iteration instead
+* because the gem parses everything into memory, it consumes about 5GB before finishing. Added a callback feature for each record, so that you can process each record and then discard the memory.
+
+11/2/15 - release 1.5.3, 1.5.2
+* Updated 837p.xml Loop 20102AB to include REF segments
+* fixed misspelling
+
+4/16/15 - release 1.5.1
+* Added inpsect method to loop class to resolve infinite loop due to changes with inspect and to_s methods in ruby 2.0.0
+* Thank you to Wylan for troubleshooting and providing the fix 
+
+11/8/14 - release 1.5.0
+* converted from ReXML to LibXML for speed improvement on XML parsing 
+
+9/14/13 - release 1.4.7
+* Added 276 / 277 transaction messages 
+* Fixed issue with 835.xml file
+
+4/15/13 - release 1.4.5
+* Factories now enforce minimum sizes - wbajzek contributed
+* 270Interchange.xml updated ST segment's field list - wbajzek contributed
+* Test updated for minimum size - wbajzek contributed
+
+3/22/13 - releases 1.4.1 - 1.4.3
+* Fix errors in the 835.xml file
+
+3/11/13 - release 1.4.0
+* Added X12 definitions for 271 transaction
+* Renamed the gem to be all lower case so Rails and other frameworks autoload the project as a gem
+* Added an each method to segments to simplify looping through repeating segments
+

data/Rakefile

@@ -0,0 +1,26 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'
+
+desc 'Test the plugin'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/t*.rb'
+  t.verbose = true
+end
+
+desc 'Generate RDoc docs'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Versapay'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+task :default => :test

data/example/factory.rb

@@ -0,0 +1,92 @@
+#--
+#     This file is part of the X12Parser library that provides tools to
+#     manipulate X12 messages using Ruby native syntax.
+#
+#     http://x12parser.rubyforge.org 
+#     
+#     Copyright (C) 2008 APP Design, Inc.
+#
+#     This library is free software; you can redistribute it and/or
+#     modify it under the terms of the GNU Lesser General Public
+#     License as published by the Free Software Foundation; either
+#     version 2.1 of the License, or (at your option) any later version.
+#
+#     This library is distributed in the hope that it will be useful,
+#     but WITHOUT ANY WARRANTY; without even the implied warranty of
+#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#     Lesser General Public License for more details.
+#
+#     You should have received a copy of the GNU Lesser General Public
+#     License along with this library; if not, write to the Free Software
+#     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+#++
+#
+require 'x12'
+
+# Read message definition and create an actual parser
+# by compiling .d12 file
+parser = X12::Parser.new('misc/997single.xml')
+
+# Make a new 997 message 
+r = parser.factory('997')
+
+#
+# Set various fields as desired
+#
+
+# Set fields directly
+r.ST.TransactionSetIdentifierCode = 997
+r.ST.TransactionSetControlNumber  = '2878'
+
+# Set fields inside a segment (AK1 in this case)
+r.AK1 { |ak1|
+  ak1.FunctionalIdentifierCode = 'HS'
+  ak1.GroupControlNumber       = 293328532
+}
+
+# Set fields deeply inside a segment inside 
+# nested loops (L1000/L1010/AK4 in this case)
+r.L1000.L1010.AK4.DataElementSyntaxErrorCode = 55
+r.L1000.AK2.TransactionSetIdentifierCode     = 270
+
+# Set nested loops
+r.L1000.L1010 {|l|
+  l.AK3 {|s|
+    s.SegmentIdCode      = 'NM1'
+    s.LoopIdentifierCode = 'L1000D'
+  }
+  l.AK4 {|s|
+    s.CopyOfBadDataElement = 'Bad element'
+  }
+}
+
+# Add loop repeats
+r.L1000.repeat {|l1000|
+  (0..1).each {|loop_repeat| # Two repeats of the loop L1010
+    l1000.L1010.repeat {|l1010|
+      l1010.AK3 {|s|
+        s.SegmentIdCode                   = 'DMG'
+        s.SegmentPositionInTransactionSet = 0
+        s.LoopIdentifierCode              = 'L1010'
+        s.SegmentSyntaxErrorCode          = 22
+      } if loop_repeat == 0 # AK3 only in the first repeat of L1010
+      (0..1).each {|ak4_repeat| # Two repeats of the segment AK4
+        l1010.AK4.repeat {|s|
+          s.PositionInSegment          = loop_repeat
+          s.DataElementSyntaxErrorCode = ak4_repeat
+        } # s
+      } # ak4_repeat
+    } # l1010
+  } # loop_repeat
+
+  l1000.AK5{|a|
+    a.TransactionSetAcknowledgmentCode = 666
+    a.TransactionSetSyntaxErrorCode4   = 999
+  } # a
+} # l1000
+
+# Print the message as a string -> ST*997*2878~AK1*HS*293328532~
+# AK2*270*~AK3*NM1**L1000D~AK4***55*Bad element~AK5*~AK3*DMG*0*
+# L1010*22~AK4*0**0~AK4*0**1~AK4*1**0~AK4*1**1~AK5*666****999~
+# AK9****~SE**~
+puts r.render

data/example/parse.rb

@@ -0,0 +1,57 @@
+#--
+#     This file is part of the X12Parser library that provides tools to
+#     manipulate X12 messages using Ruby native syntax.
+#
+#     http://x12parser.rubyforge.org 
+#     
+#     Copyright (C) 2008 APP Design, Inc.
+#
+#     This library is free software; you can redistribute it and/or
+#     modify it under the terms of the GNU Lesser General Public
+#     License as published by the Free Software Foundation; either
+#     version 2.1 of the License, or (at your option) any later version.
+#
+#     This library is distributed in the hope that it will be useful,
+#     but WITHOUT ANY WARRANTY; without even the implied warranty of
+#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#     Lesser General Public License for more details.
+#
+#     You should have received a copy of the GNU Lesser General Public
+#     License along with this library; if not, write to the Free Software
+#     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+#++
+#
+require 'x12'
+
+# Read message definition and create an actual parser
+# by compiling .d12 file
+parser = X12::Parser.new('misc/997single.xml')
+
+# Define a test message to parse
+m997='ST*997*2878~AK1*HS*293328532~AK2*270*307272179~'\
+'AK3*NM1*8*L1010_0*8~AK4*0:0*66*1~AK4*0:1*66*1~AK4*0:2*'\
+'66*1~AK3*NM1*8*L1010_1*8~AK4*1:0*66*1~AK4*1:1*66*1~AK3*'\
+'NM1*8*L1010_2*8~AK4*2:0*66*1~AK5*R*5~AK9*R*1*1*0~SE*8*2878~'
+
+# Parse the message
+r = parser.parse('997', m997)
+r.show
+
+# Access components of the message as desired
+
+# Whole ST segment: -> ST*997*2878~
+puts r.ST
+
+# One filed, Group Control Number of AK1 -> 293328532
+puts r.AK1.GroupControlNumber
+
+# Individual loop, namely, third L1010 subloop of
+# L1000 loop: -> AK3*NM1*8*L1010_2*8~AK4*2:0*66*1~
+puts r.L1000.L1010[2]
+
+# First encounter of Data Element Reference Number of the 
+# first L1010 sub-loop of L1000 loop -> 66
+puts r.L1000.L1010.AK4.DataElementReferenceNumber
+
+# Number of L1010 sub-loops in L1000 loop -> 3
+puts r.L1000.L1010.size

data/init.rb

@@ -0,0 +1 @@
+require 'x12'

data/lib/x12.rb

@@ -0,0 +1,48 @@
+#--
+#     This file is part of the X12Parser library that provides tools to
+#     manipulate X12 messages using Ruby native syntax.
+#
+#     http://x12parser.rubyforge.org 
+#     
+#     Copyright (C) 2008 APP Design, Inc.
+#
+#     This library is free software; you can redistribute it and/or
+#     modify it under the terms of the GNU Lesser General Public
+#     License as published by the Free Software Foundation; either
+#     version 2.1 of the License, or (at your option) any later version.
+#
+#     This library is distributed in the hope that it will be useful,
+#     but WITHOUT ANY WARRANTY; without even the implied warranty of
+#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#     Lesser General Public License for more details.
+#
+#     You should have received a copy of the GNU Lesser General Public
+#     License along with this library; if not, write to the Free Software
+#     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+#++
+#
+# $Id: X12.rb 91 2009-05-13 22:11:10Z ikk $
+#
+# Package implementing direct manipulation of X12 structures using Ruby syntax.
+
+require "libxml"
+require 'pp'
+
+require "x12/version"
+require 'x12/base'
+require 'x12/empty'
+require 'x12/field'
+require 'x12/composite'
+require 'x12/segment'
+require 'x12/table'
+require 'x12/loop'
+require 'x12/xmldefinitions'
+require 'x12/parser'
+
+module X12
+  include LibXML
+  
+  EMPTY = Empty.new()
+  TEST_REPEAT = 100
+  
+end

data/lib/x12/base.rb

@@ -0,0 +1,226 @@
+#--
+#     This file is part of the X12Parser library that provides tools to
+#     manipulate X12 messages using Ruby native syntax.
+#
+#     http://x12parser.rubyforge.org 
+#     
+#     Copyright (C) 2008 APP Design, Inc.
+#
+#     This library is free software; you can redistribute it and/or
+#     modify it under the terms of the GNU Lesser General Public
+#     License as published by the Free Software Foundation; either
+#     version 2.1 of the License, or (at your option) any later version.
+#
+#     This library is distributed in the hope that it will be useful,
+#     but WITHOUT ANY WARRANTY; without even the implied warranty of
+#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#     Lesser General Public License for more details.
+#
+#     You should have received a copy of the GNU Lesser General Public
+#     License along with this library; if not, write to the Free Software
+#     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+#++
+#
+module X12
+
+  #
+  # Base class for Segment, Composite, and Loop. Contains setable
+  # segment_separator, field_separator, and composite_separator fields.
+  #
+  
+  class Base
+
+    attr_reader   :name, :repeats
+    attr_accessor :segment_separator, :field_separator, :composite_separator, :next_repeat, :parsed_str, :nodes
+    
+
+    # Creates a new base element with a given name, array of sub-elements, and array of repeats if any.
+    def initialize(name, arr, repeats = nil)
+      @nodes = arr
+      @name = name
+      @repeats = repeats
+      @next_repeat = nil        # Next repeat of the same element, if any
+      @parsed_str = nil
+
+      @segment_separator   = '~'
+      @field_separator     = '*'
+      @composite_separator = ':'
+      #puts "Created #{name} #{object_id} #{self.class}  "
+    end
+
+    # Formats a printable string containing the base element's content
+    def inspect
+      "#{self.class.to_s.sub(/^.*::/, '')} (#{name}) #{repeats} #{super.inspect[1..-2]} =<#{parsed_str}, #{next_repeat.inspect}> ".gsub(/\\*\"/, '"')
+    end
+
+    # Prints a tree-like representation of the element
+    def show(ind = '')
+      count = 0
+      self.to_a.each{|i|
+        #puts "#{ind}#{i.name} #{i.object_id} #{i.super.object_id} [#{count}]: #{i.parsed_str} #{i.super.class}"
+        puts "#{ind}#{i.name} [#{count}]: #{i.to_s.sub(/^(.{30})(.*?)(.{30})$/, '\1...\3')}"
+        # Force parsing a segment
+        if i.kind_of?(X12::Segment) && i.nodes[0]
+          i.find_field(i.nodes[0].name)
+        end
+        i.nodes.each{|j|
+          case 
+          when j.kind_of?(X12::Base)  then j.show(ind+'  ')
+          when j.kind_of?(X12::Field) then puts "#{ind+'  '}#{j.name} -> '#{j.to_s}'"
+          end
+        } 
+        count += 1
+      }
+    end
+
+    # Try to parse the current element one more time if required. Returns the rest of the string
+    # or the same string if no more repeats are found or required.
+    def do_repeats(s, yield_loop_name, block)
+      repeat_count = 1
+      current_element = self
+      while(self.repeats.end > repeat_count)
+        possible_repeat = current_element.dup
+        repeat_count+=1
+        p_s = possible_repeat.parse_helper(s, yield_loop_name, block)
+        if p_s
+          s = p_s
+          if yield_loop_name && yield_loop_name == name
+            block.call(possible_repeat)
+          else
+            current_element.next_repeat = possible_repeat
+          end
+          current_element = possible_repeat
+        else
+          break
+        end # if parsed
+      end # more repeats
+      s
+    end # do_repeats
+
+    def parse(str, yield_loop_name, block)
+      s = parse_helper(str, yield_loop_name, block)
+      s = do_repeats(s, yield_loop_name, block) if(s)
+      s
+    end
+
+    # Empty out the current element
+    def set_empty!
+      @next_repeat = nil
+      @parsed_str = nil
+      self
+    end
+
+    # Make a deep copy of the element
+    def dup
+      n = clone
+      n.set_empty!
+      n.nodes = n.nodes.dup
+      n.nodes.each_index{|i|
+        n.nodes[i] = n.nodes[i].dup
+        n.nodes[i].set_empty!
+      }
+      #puts "Duped #{self.class} #{self.name} #{self.object_id} #{super.object_id} -> #{n.name} #{n.super.object_id} #{n.object_id} "
+      n
+    end # dup
+
+    # Recursively find a sub-element, which also has to be of type Base.
+    def find(e)
+      #puts "Finding [#{e}] in #{self.class} #{name}"
+      case self
+        when X12::Loop
+        # Breadth first
+        res = nodes.find{|i| e==i.name }
+        return res if res
+        # Depth now
+        nodes.each{|i| 
+          res = i.find(e) if i.kind_of?(X12::Loop)
+          return res unless res.nil? or EMPTY==res # otherwise keep looping
+        }
+        when X12::Segment
+        return find_field(e).to_s
+      end # case
+      return EMPTY
+    end
+    
+    # Present self and all repeats as an array with self being #0
+    def to_a
+      res = [self]
+      nr = self.next_repeat
+      while nr do
+        res << nr
+        nr = nr.next_repeat
+      end
+      res
+    end
+
+    # Returns a parsed string representation of the element
+    def to_s
+      @parsed_str || ''
+    end
+
+    # The main method implementing Ruby-like access methods for nested elements
+    def method_missing(meth, *args, &block)
+      str = meth.id2name
+      str = str[1..str.length] if str =~ /^_\d+$/ # to avoid pure number names like 270, 997, etc.
+      #puts "Missing #{str}"
+      if str =~ /=$/
+        # Assignment
+        str.chop!
+        #puts str
+        case self
+        when X12::Segment
+          res = find_field(str)
+          throw Exception.new("No field '#{str}' in segment '#{self.name}'") if EMPTY == res
+          res.content = args[0].to_s
+          #puts res.inspect
+        else
+          throw Exception.new("Illegal assignment to #{meth} of #{self.class}")
+        end # case
+      else
+        # Retrieval
+        res = find(str)
+        yield res if block_given?
+        res
+      end # if assignment
+    end
+    
+    # The main method implementing Ruby-like access methods for repeating elements
+    def [](*args)
+      #puts "squares #{args.inspect}"
+      return self.to_a[args[0]] || EMPTY
+    end
+
+    # Yields to accompanying block passing self as a parameter.
+    def with(&block)
+      if block_given?
+        yield self 
+      else
+        throw Exception.new("Method 'with' requires a block.")
+      end
+    end
+    
+    # Returns number of repeats
+    def size
+      return self.to_a.size
+    end
+
+    # Check if any of the fields has been set yet
+    def has_content?
+      self.nodes.find{|i| i.has_content?}
+    end
+
+
+    # Adds a repeat to a segment or loop. Returns a new segment/loop or self if empty.
+    def repeat
+      res = if self.has_content? # Do not repeat an empty segment
+              last_repeat = self.to_a[-1]
+              last_repeat.next_repeat = last_repeat.dup
+            else
+              self
+            end
+      yield res if block_given?
+      res
+    end
+
+  end # Base
+end