RubyGems - X12 - Versions diffs - 0.0.5 → 0.1.0 - Mend

X12 0.0.5 → 0.1.0

Files changed (60) hide show

data/CHANGELOG +6 -1
data/Rakefile +14 -3
data/example/parse.rb +1 -0
data/lib/X12.rb +2 -2
data/lib/X12/Base.rb +5 -1
data/lib/X12/Field.rb +18 -14
data/lib/X12/Loop.rb +10 -6
data/lib/X12/Parser.rb +31 -5
data/lib/X12/Segment.rb +15 -2
data/misc/997.d12 +8 -775
data/misc/IEA.d12 +10 -0
data/misc/ISA.d12 +24 -0
data/misc/SE.d12 +12 -0
data/misc/ST.d12 +7 -0
data/misc/Tbl143.d12 +302 -0
data/misc/Tbl479.d12 +238 -0
data/misc/Tbl715.d12 +11 -0
data/misc/Tbl716.d12 +27 -0
data/misc/Tbl717.d12 +10 -0
data/misc/Tbl718.d12 +29 -0
data/misc/Tbl720.d12 +12 -0
data/misc/Tbl723.d12 +14 -0
data/misc/TblI01.d12 +11 -0
data/misc/TblI03.d12 +6 -0
data/misc/TblI05.d12 +42 -0
data/misc/TblI10.d12 +5 -0
data/misc/TblI11.d12 +18 -0
data/misc/TblI13.d12 +6 -0
data/misc/TblI14.d12 +7 -0
data/test/tc_factory_997.rb +6 -6
data/test/tc_parse_997.rb +4 -4
metadata +23 -37
data/doc/classes/X12.html +0 -174
data/doc/classes/X12/Base.html +0 -677
data/doc/classes/X12/Composite.html +0 -156
data/doc/classes/X12/Empty.html +0 -186
data/doc/classes/X12/Field.html +0 -339
data/doc/classes/X12/Loop.html +0 -202
data/doc/classes/X12/Parser.html +0 -306
data/doc/classes/X12/Segment.html +0 -277
data/doc/classes/X12/Table.html +0 -198
data/doc/created.rid +0 -1
data/doc/files/CHANGELOG.html +0 -108
data/doc/files/README.html +0 -474
data/doc/files/TODO.html +0 -95
data/doc/files/lib/X12/Base_rb.html +0 -83
data/doc/files/lib/X12/Composite_rb.html +0 -83
data/doc/files/lib/X12/Empty_rb.html +0 -83
data/doc/files/lib/X12/Field_rb.html +0 -83
data/doc/files/lib/X12/Loop_rb.html +0 -83
data/doc/files/lib/X12/Parser_rb.html +0 -83
data/doc/files/lib/X12/Segment_rb.html +0 -83
data/doc/files/lib/X12/Table_rb.html +0 -83
data/doc/files/lib/X12_rb.html +0 -100
data/doc/fr_class_index.html +0 -35
data/doc/fr_file_index.html +0 -38
data/doc/fr_method_index.html +0 -62
data/doc/index.html +0 -27
data/doc/rdoc-style.css +0 -208
data/test/ts_x12.rb +0 -27

data/doc/created.rid DELETED

	@@ -1 +0,0 @@
1	- Thu, 13 Nov 2008 13:53:19 -0600

data/doc/files/CHANGELOG.html DELETED

@@ -1,108 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
-     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-  <title>File: CHANGELOG</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
-  <script type="text/javascript">
-  // <![CDATA[
-  function popupCode( url ) {
-    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
-  }
-  function toggleCode( id ) {
-    if ( document.getElementById )
-      elem = document.getElementById( id );
-    else if ( document.all )
-      elem = eval( "document.all." + id );
-    else
-      return false;
-    elemStyle = elem.style;
-    if ( elemStyle.display != "block" ) {
-      elemStyle.display = "block"
-    } else {
-      elemStyle.display = "none"
-    }
-    return true;
-  }
-  // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  // ]]>
-  </script>
-</head>
-<body>
-  <!-- banner header -->
-  <div id="bodyContent">
-  <div id="contextContent">
-    <div id="description">
-      <h1>CHANGELOG</h1>
-<p>
-$Id: CHANGELOG 35 2008-11-13 18:33:44Z ikk $
-</p>
-<h2>11/15/08 - Release 0.0.5, first public one</h2>
-<ul>
-<li>Added comments.
-</li>
-<li>Added examples.
-</li>
-<li>Wrote README
-</li>
-</ul>
-<h2>4/10/08 - Release 0.0.1</h2>
-<ul>
-<li>Internal release for testing
-</li>
-</ul>
-    </div>
-   </div>
-  </div>
-    <!-- if includes -->
-    <div id="section">
-    <!-- if method_list -->
-  </div>
-</body>
-</html>

data/doc/files/README.html DELETED

@@ -1,474 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
-     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-  <title>File: README</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
-  <script type="text/javascript">
-  // <![CDATA[
-  function popupCode( url ) {
-    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
-  }
-  function toggleCode( id ) {
-    if ( document.getElementById )
-      elem = document.getElementById( id );
-    else if ( document.all )
-      elem = eval( "document.all." + id );
-    else
-      return false;
-    elemStyle = elem.style;
-    if ( elemStyle.display != "block" ) {
-      elemStyle.display = "block"
-    } else {
-      elemStyle.display = "none"
-    }
-    return true;
-  }
-  // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  // ]]>
-  </script>
-</head>
-<body>
-  <!-- banner header -->
-  <div id="bodyContent">
-  <div id="contextContent">
-    <div id="description">
-      <h1>X12Parser - a library to manipulate <a href="../classes/X12.html">X12</a> structures using native Ruby syntax</h1>
-<p>
-$Id: README 40 2008-11-13 19:51:31Z ikk $
-</p>
-<p>
-<b>WARNING</b> <tt>The project is in development. Contributors are
-welcome.</tt>
-</p>
-<p>
-Project home is at <a
-href="http://rubyforge.org/projects/x12parser">rubyforge.org/projects/x12parser</a>/.
-Please note, this is a different project from <a
-href="http://rubyforge.org/projects/x12-parser/">Chris Parker's port</a> of
-<a
-href="http://search.cpan.org/~prasad/X12-0.09/lib/X12/Parser.pm">X12::Parser
-Perl module</a>.
-</p>
-<h2>The goal</h2>
-<p>
-The idea is to access <a href="../classes/X12.html">X12</a> messages
-directly from Ruby, i.e., using a syntax like
-</p>
-<pre>
-  message.L1000.L1010[1].AK4.DataElementReferenceNumber
-</pre>
-<p>
-This syntax can be used to get and set any field of an <a
-href="../classes/X12.html">X12</a> message and it makes <a
-href="../classes/X12.html">X12</a> parsing much more straightforward and
-self-documenting.
-</p>
-<h2>The problem</h2>
-<p>
-<a href="../classes/X12.html">X12</a> is a set of &quot;standards&quot;
-possessing all the elegance of an elephant designed by committee, and quite
-literally so, see <a href="http://www.x12.org">www.x12.org</a>. <a
-href="../classes/X12.html">X12</a> defines rough syntax for specifying text
-messages, but each of more than 300 specifications defines its own message
-structure. While messages themselves are easy to parse with a simple
-tokenizer, their semantics is heavily dependent on the domain. For example,
-this is <a href="../classes/X12.html">X12</a>/997 message conveying
-&quot;Functional Acknowledgment&quot;:
-</p>
-<pre>
-  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~
-</pre>
-<p>
-I.e., <a href="../classes/X12.html">X12</a> defines an alphabet and
-somewhat of a dictionary - not a grammar or semantics for each particular
-data interchange conversation. Because of many entrenched implementations
-and government mandates, the <a href="../classes/X12.html">X12</a> is not
-going to die anytime soon, unfortunately.
-</p>
-<p>
-The message above can be easily represented in Ruby as a nested array:
-</p>
-<pre>
- m = [
-      ['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'],
-     ]
-</pre>
-<p>
-but it will not help any since, say, segment &#8216;AK4&#8217; is
-ambiguously defined and its meaning not at all obvious until the
-message&#8216;s structure is interpreted and correct &#8216;AK4&#8217;
-segment is found.
-</p>
-<h2>The solution</h2>
-<h3>Message structure</h3>
-<p>
-Each participant in EDI has to know the structure of the data coming across
-the wire - <a href="../classes/X12.html">X12</a> or no <a
-href="../classes/X12.html">X12</a>. The <a
-href="../classes/X12.html">X12</a> structures are defined in so-called
-Implementation Guides - thick books with all the data pieces spelled out.
-There is no other choice, but to invent a computer-readable definition
-language that will codify these books. For example, the <a
-href="../classes/X12.html">X12</a>/997 message can be defined as
-</p>
-<pre>
-  loop 997 1:1
-  {
-    segment ST  1:1
-    segment AK1 1:1
-    loop L1000 0:999999
-    {
-      segment AK2 0:1
-      loop L1010 0:999999
-      {
-        segment AK3 0:1
-        segment AK4 0:99
-      } # L1010
-      segment AK5 1:1
-    } # L1000
-    segment AK9 1:1
-    segment SE  1:1
-  } # 997
-</pre>
-<p>
-Namely, the 997 is a &#8216;loop&#8217; containing segments ST (only one -
-&#8216;1:1&#8217;), AK1 (also only one), another loop L1000 (zero or many
-repeats), segments AK9 and SE. The loop L1000 can contain a segment AK2
-(optional - &#8216;0:1&#8217;) and another loop L1010 (zero or many), and
-so on.
-</p>
-<p>
-The segments&#8217; structure can be further defined as, for example,
-</p>
-<pre>
-  segment AK2 {
-    TransactionSetIdentifierCode  S R 3-3 Tbl143
-    TransactionSetControlNumber   S R 4-9
-  } # AK2
-</pre>
-<p>
-wihch defines a segment AK2 as having to fields:
-TransactionSetIdentifierCode and TransactionSetControlNumber. The field
-TransactionSetIdentifierCode is defined as having a type of string
-(&#8216;S&#8217;), begin required (&#8216;R&#8217;), having length of
-minimum 3 and maximum 3 characters (&#8216;3-3&#8217;), and being validated
-against a table Tbl143. The validation table is defined as
-</p>
-<pre>
-  table Tbl143 {
-    100 Insurance Plan Description
-    101 Name and Address Lists
-    ...
-    997 Functional Acknowledgment
-    998 Set Cancellation
-  } # Tbl143
-</pre>
-<p>
-where required values are first tokens on each line, i.e., 100, 101,
-&#8230;, 997, 998.
-</p>
-<p>
-This message is fully flashed out in an example &#8216;misc/997.d12&#8217;
-file, copied from the ASC X12N 276/277 (004010X093) &quot;Health Care Claim
-Status Request and Response&quot; National Electronic Data Interchange
-Transaction Set Implementation Guide.
-</p>
-<p>
-Now expressions like
-</p>
-<pre>
-  message.L1000.L1010[1].AK4.DataElementReferenceNumber
-</pre>
-<p>
-start making sense of sorts, overall <a
-href="../classes/X12.html">X12</a>&#8216;s idiocy notwithstanding -
-it&#8216;s a field called &#8216;DataElementReferenceNumber&#8217; of a
-first of possibly many segments &#8216;AK4&#8217; found in the second
-repeat of the loop &#8216;L1010&#8217; inside the enclosing loop
-&#8216;L1000&#8217;. The meaning of the value &#8216;66&#8217; found in
-this field is still in the eye of the beholder, but, at least its location
-is clearly identified in the message.
-</p>
-<h3><a href="../classes/X12.html">X12</a> Structure Definition Language (d12)</h3>
-<p>
-The syntax of the <a href="../classes/X12.html">X12</a> structure
-definition language should be apparent from the &#8216;997.d12&#8217; file
-enclosed with the package. The strict definition is formalized in
-&#8216;lib/X12/x12syntax.treetop&#8217; file.
-</p>
-<h3>Parsing</h3>
-<p>
-Here is how to parse an <a href="../classes/X12.html">X12</a>/997 message
-(the source is in example/parse.rb):
-</p>
-<pre>
-  require 'x12'
-  # Read message definition and create an actual parser
-  # by compiling .d12 file
-  parser = X12::Parser.new('misc/997.d12')
-  # 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)
-  # Access components of the message as desired
-  # Whole ST segment: -&gt; ST*997*2878~
-  puts r.ST
-  # One filed, Group Control Number of AK1 -&gt; 293328532
-  puts r.AK1.GroupControlNumber
-  # Individual loop, namely, third L1010 sub-loop of
-  # L1000 loop: -&gt; 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 -&gt; 66
-  puts r.L1000.L1010.AK4.DataElementReferenceNumber
-  # Number of L1010 sub-loops in L1000 loop -&gt; 3
-  puts r.L1000.L1010.size
-</pre>
-<h3>Generating</h3>
-<p>
-Here is how to perform a reverse operation and generate a well-formed 997
-message (the source is in example/factory.rb):
-</p>
-<pre>
-  require 'x12'
-  # Read message definition and create an actual parser
-  # by compiling .d12 file
-  parser = X12::Parser.new('misc/997.d12')
-  # 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 -&gt; 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
-</pre>
-<h2>Download</h2>
-<p>
-The latest <a href="../classes/X12.html">X12</a> library version can be
-downloaded from <a
-href="http://rubyforge.org/frs/?group_id=7297">rubyforge.org/frs/?group_id=7297</a>
-</p>
-<h2>Installation</h2>
-<p>
-You can install <a href="../classes/X12.html">X12</a> library with the
-following command.
-</p>
-<pre>
-  % gem install X12
-</pre>
-<p>
-If you install directly from the <a href="../classes/X12.html">X12</a>*.gem
-file, it requires these packages to be installed first:
-</p>
-<ul>
-<li><a href="http://rubyforge.org/projects/treetop/">Treetop</a>
-</li>
-<li><a href="http://rubyforge.org/projects/polyglot/">Polyglot</a>
-</li>
-</ul>
-<h2>License</h2>
-<p>
-<a href="../classes/X12.html">X12</a> library is released under the Lesser
-GPL license, see <a
-href="http://www.gnu.org/licenses/lgpl.txt">www.gnu.org/licenses/lgpl.txt</a>
-</p>
-<h2>Major deficiencies</h2>
-<ul>
-<li>Validation is not implemented.
-</li>
-<li>Field types and sizes are ignored.
-</li>
-<li>No access methods for composites&#8217; fields.
-</li>
-</ul>
-<h2>Wish list</h2>
-<ul>
-<li>.d12 files should have an &#8216;include&#8217; facility, so data
-definitions can be reused for different messages.
-</li>
-<li>It would be nice to codify all popular <a
-href="../classes/X12.html">X12</a> messages in .d12 format.
-</li>
-</ul>
-<h2>Support</h2>
-<p>
-Please use the following:
-</p>
-<ul>
-<li>forums on Rubyforge for general discussions, <a
-href="http://rubyforge.org/forum/?group_id=7297">rubyforge.org/forum/?group_id=7297</a>
-</li>
-<li>trackers to submit bugs or feature requests, <a
-href="http://rubyforge.org/tracker/?group_id=7297">rubyforge.org/tracker/?group_id=7297</a>
-</li>
-<li>to contact the author, send mail to prelude rubyforge org
-</li>
-</ul>
-<h2>Acknowledgments</h2>
-<p>
-The authors of the project were inspired by the following works:
-</p>
-<ol>
-<li>The Perl <a href="../classes/X12.html">X12</a> parser by Prasad
-Poruporuthan, <a
-href="http://search.cpan.org/~prasad/X12-0.09/lib/X12/Parser.pm">search.cpan.org/~prasad/X12-0.09/lib/X12/Parser.pm</a>
-</li>
-<li>The Ruby port of the above by Chris Parker, <a
-href="http://rubyforge.org/projects/x12-parser">rubyforge.org/projects/x12-parser</a>/
-</li>
-<li>Treetop Ruby parser, <a
-href="http://treetop.rubyforge.org">treetop.rubyforge.org</a>
-</li>
-</ol>
-    </div>
-   </div>
-  </div>
-    <!-- if includes -->
-    <div id="section">
-    <!-- if method_list -->
-  </div>
-</body>
-</html>