tcd_x12 1.6.2 → 1.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1cdb7392e9ddcc71af854524311fc27294a1ef51415f0a1491494dfde395048
-  data.tar.gz: 28cd1f96294140ed9a2a2f5fd5009e5baab5db110cc67070ce2a5d715123bb21
+  metadata.gz: f7b6f52dcf0d6a34ee6992f9d310e8e9e6376ebe8e834d033467994b815d709d
+  data.tar.gz: c8cdc729f70ec8b5dd9014a37b09f8b80f25060f9c5fbde20cd2feb1cd7f3ec4
 SHA512:
-  metadata.gz: 90ef90253cefad0d0e4002776e903db839fddcc7ec17f305f8bb986373895d07c4716b0a828d7143c3330e9541c1d1984dd3cc0dc7b13efacdd5a5384af9520c
-  data.tar.gz: c703ed73f8b137f61f1f64b76ef96bf3ba468e751e103a549ccb95746dec3390f051f389df8b27488d4f7fae76880da435137478f522e4cac765d42c597fcbc4
+  metadata.gz: b961effa4a173323f3871df5a77f5c41a9174a658d30b2effbe5b2b97d7e43e7ec7bd8ef811c20762909cfd0b355ec213a0b19613d4d74baaaaac715a45ecccd
+  data.tar.gz: e249eb024b282bff8fd8c82ca18524decb81d3064fcad02ba439abe95b27da15900123b3b6e9523396d9062a6dcaa6b2b77f95e3337ea43dad4f7beaa8cd3521

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  TargetRubyVersion: 2.6.0
+
+Style/Documentation:
+  Enabled: true
+  Exclude:
+    - 'test/**/*.rb'
+
+Style/DocumentationMethod:
+  Enabled: true
+  Exclude:
+    - 'test/**/*.rb'
+
+# Don't leave calls to pry lying around.
+Lint/Debugger:
+  Enabled: true
+
+Metrics/LineLength:
+  Max: 150
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/FormatString:
+  EnforcedStyle: sprintf
+
+Style/CommentedKeyword:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Change Log
 
+11/26/19 - release 1.6.3
+* Update 855.xml
+
 10/25/19 - release 1.6.2
 * Fix invalid yard doc comments
 

data/README.md

@@ -1,8 +1,15 @@
 # X12
 
+[![Gem](https://img.shields.io/gem/v/tcd_x12)][gem]
 ![Ruby Version](https://img.shields.io/badge/Ruby->=1.9.1-red.svg)
-[![Gem Version](https://badge.fury.io/rb/tcd_x12.svg)](https://badge.fury.io/rb/tcd_x12)
-![GitHub](https://img.shields.io/github/license/tcd/x12)
+[![Inline docs](http://inch-ci.org/github/tcd/x12.svg?branch=master)][inch-ci]
+[![License](https://img.shields.io/github/license/tcd/x12)][license]
+[![Documentation](http://img.shields.io/badge/docs-rubydoc.info-blue.svg)][docs]
+
+[gem]: https://rubygems.org/gems/tcd_x12
+[inch-ci]: http://inch-ci.org/github/tcd/x12
+[license]: https://github.com/tcd/x12/blob/master/LICENSE
+[docs]: https://www.rubydoc.info/gems/tcd_x12/1.6.2
 
 Changes welcome, especially new document types or better tests.
 

data/Rakefile

@@ -11,4 +11,13 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = true
 end
 
-task :default => :test
+# desc 'Test the plugin, and run benchmarks'
+# Rake::TestTask.new(:benchmark) do |t|
+#   ENV['BENCH'] = 'true'
+#   t.libs << 'lib'
+#   t.libs << 'test'
+#   t.test_files = FileList['test/**/*_test.rb']
+#   t.verbose = true
+# end
+
+task(default: :test)

data/lib/x12/base.rb

@@ -1,13 +1,16 @@
 module X12
 
-  # Base class for Segment, Composite, and Loop.
+  # 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
+    attr_accessor :segment_separator, :field_separator, :composite_separator
+    attr_accessor :next_repeat, :parsed_str, :nodes
 
     # Creates a new base element with a given name, array of sub-elements, and array of repeats if any.
+    #
+    # @return [void]
     def initialize(name, arr, repeats = nil)
       @nodes = arr
       @name = name
@@ -23,12 +26,15 @@ module X12
     end
 
     # Formats a printable string containing the base element's content.
+    #
     # @return [String]
     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.
+    #
+    # @return [void]
     def show(ind = '')
       count = 0
       self.to_a.each{|i|
@@ -48,8 +54,8 @@ module X12
       }
     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.
+    # 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)
       if self.repeats.end > 1
         possible_repeat = self.dup
@@ -63,6 +69,8 @@ module X12
     end
 
     # Empty out the current element.
+    #
+    # @return [void]
     def set_empty!
       @next_repeat = nil
       @parsed_str = nil
@@ -170,7 +178,8 @@ module X12
       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.
+    # 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]

data/lib/x12/parser.rb

@@ -20,8 +20,11 @@ module X12
     ].freeze
 
     # Creates a parser out of a definition.
+    #
+    # @param file_name [String]
+    # @return [void]
     def initialize(file_name)
-      save_definition = @x12_definition
+      save_definition = @x12_definition if defined? @x12_definition
 
       # Deal with Microsoft devices
       # get the current working directory

data/lib/x12/segment.rb

@@ -2,8 +2,13 @@ module X12
 
   # Implements a segment containing fields or composites
   class Segment < Base
+    attr_accessor :fields
+
     # Parses this segment out of a string, puts the match into value,
     # returns the rest of the string - nil if cannot parse.
+    #
+    # @param str [String]
+    # @return [nil]
     def parse(str)
       s = str
       # puts "Parsing segment #{name} from #{s} with regexp [#{regexp.source}]"
@@ -38,7 +43,7 @@ module X12
 
     # Returns a regexp that matches this particular segment.
     def regexp
-      unless @regexp
+      unless defined? @regexp
         if self.nodes.find { |i| i.type =~ /^".+"$/ }
           # It's a very special regexp if there are constant fields
           re_str = self.nodes.inject("^#{name}#{Regexp.escape(field_separator)}") { |s, i|
@@ -68,7 +73,7 @@ module X12
       # puts field_num
 
       # Parse the segment if not parsed already
-      unless @fields
+      unless defined? @fields
         @fields = self.to_s.chop.split(Regexp.new(Regexp.escape(field_separator)))
         self.nodes.each_index { |i| self.nodes[i].content = @fields[i + 1] }
       end

data/lib/x12/table.rb

@@ -2,9 +2,11 @@ module X12
 
   # This just a named hash to store validation tables.
   class Table < Hash
+    # @return [String]
     attr_reader :name
 
     # Create a new table with given name and hash content.
+    # @return [void]
     def initialize(name, name_values)
       @name = name
       self.merge!(name_values)

data/lib/x12/version.rb

@@ -1,3 +1,3 @@
 module X12
-  VERSION = '1.6.2'.freeze
+  VERSION = '1.6.3'.freeze
 end

data/lib/x12/xmldefinitions.rb

@@ -99,7 +99,7 @@ module X12
     end
 
     def parse_table(e)
-      name, min, max, type, required, validation = parse_attributes(e)
+      name, _min, _max, _type, _required, _validation = parse_attributes(e)
 
       content = e.find('Entry').inject({}) { |t, entry|
         t[entry.attributes['name']] = entry.attributes['value']
@@ -109,7 +109,7 @@ module X12
     end
 
     def parse_segment(e)
-      name, min, max, type, required, validation = parse_attributes(e)
+      name, min, max, _type, _required, _validation = parse_attributes(e)
 
       fields = e.find('Field').inject([]) { |f, field|
         f << parse_field(field)
@@ -118,7 +118,7 @@ module X12
     end
 
     def parse_composite(e)
-      name, min, max, type, required, validation = parse_attributes(e)
+      name, _min, _max, _type, _required, _validation = parse_attributes(e)
 
       fields = e.find('Field').inject([]) { |f, field|
         f << parse_field(field)
@@ -127,7 +127,7 @@ module X12
     end
 
     def parse_loop(e)
-      name, min, max, type, required, validation = parse_attributes(e)
+      name, min, max, _type, _required, _validation = parse_attributes(e)
 
       components = e.find('*').to_a.inject([]) { |r, element|
         r << case element.name

data/misc/850.xml

@@ -1,5 +1,4 @@
-
-<!-- 
+<!--
   (c) 2019 Clay Dunston
   The code in this file is licensed under the MIT license.
 -->

data/misc/855.xml

@@ -0,0 +1,47 @@
+<!--
+  (c) 2019 Clay Dunston
+  The code in this file is licensed under the MIT license.
+-->
+
+<!--
+  This is an example of a message definition spread among several
+  files: main loop is here, all other definitions, i.e., segments,
+  composites, validation tables live in separate files.
+-->
+
+<Definition>
+  <Loop name="855" comment="">
+    <Segment name="ISA" max="1" required="y" />
+    <Segment name="GS" max="1" required="y" />
+
+    <Segment name="ST" max="1" required="y">
+      <Field name="TransactionSetIdentifierCode" const="855" min="3" max="3" comment="Code uniquely identifying a Transaction Set" />
+      <Field name="TransactionSetControlNumber" min="4" max="9" comment="Identifying control number that must be unique within the transaction set functional group assigned by the originator for a transaction set" />
+    </Segment>
+    <Segment name="BAK" max="1" required="y" />
+
+    <Loop name="L1000" max="200">
+      <Segment name="N1" max="1" required="n" />
+      <Segment name="N3" max="2" required="n" />
+      <Segment name="N4" min="1" required="n" />
+    </Loop>
+
+    <Loop name="L1010" max="100000">
+      <Segment name="PO1" max="1" required="y" />
+      <Loop name="L1020" min="1">
+        <Segment name="PID" max="1" required="n" />
+      </Loop>
+      <Loop name="L1030" max="104">
+        <Segment name="ACK" max="1" required="y" />
+      </Loop>
+    </Loop>
+
+    <Loop name="L1040" max="1">
+      <Segment name="CTT" max="1" required="y" />
+    </Loop>
+
+    <Segment name="SE" max="1" required="y" />
+
+    <Segment name="GE" max="1" required="y" />
+    <Segment name="IEA" max="1" required="y" />
+</Definition>

data/x12.gemspec

@@ -11,8 +11,14 @@ Gem::Specification.new do |gem|
   gem.summary       = 'A gem to handle parsing and generation of ANSI X12 documents'
   gem.homepage      = 'https://github.com/tcd/x12'
   gem.licenses      = 'GPL-2.0-or-later'
-  gem.metadata['homepage_uri'] = gem.homepage
-  gem.metadata['source_code_uri'] = 'https://github.com/tcd/x12'
+
+  gem.metadata = {
+    'homepage_uri' => gem.homepage,
+    'source_code_uri' => gem.homepage,
+    'documentation_uri' => "https://www.rubydoc.info/gems/tcd_x12/#{gem.version}",
+    'changelog_uri' => 'https://github.com/tcd/tcd_x12/blob/master/CHANGELOG.md',
+    'yard.run' => 'yri' # use "yard" to build full HTML docs.
+  }
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -22,6 +28,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_dependency 'libxml-ruby', '~> 3.1'
+
   gem.add_development_dependency 'minitest', '~> 5.0'
   gem.add_development_dependency 'rake', '~> 10.0'
   gem.add_development_dependency 'simplecov'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tcd_x12
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.6.3
 platform: ruby
 authors:
 - Marty Petersen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-25 00:00:00.000000000 Z
+date: 2019-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libxml-ruby
@@ -78,6 +78,7 @@ extra_rdoc_files: []
 files:
 - ".editorconfig"
 - ".gitignore"
+- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -106,6 +107,7 @@ files:
 - misc/837p.xml
 - misc/850.xml
 - misc/850dsd.xml
+- misc/855.xml
 - misc/997.xml
 - misc/997single.xml
 - misc/999.xml
@@ -1927,6 +1929,9 @@ licenses:
 metadata:
   homepage_uri: https://github.com/tcd/x12
   source_code_uri: https://github.com/tcd/x12
+  documentation_uri: https://www.rubydoc.info/gems/tcd_x12/1.6.3
+  changelog_uri: https://github.com/tcd/tcd_x12/blob/master/CHANGELOG.md
+  yard.run: yri
 post_install_message: 
 rdoc_options: []
 require_paths: