REX12 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6d86bbf6174fa893327c071e804c0cef6c302d3
-  data.tar.gz: ded8c3aee01aa03d18398351b16730bbf767bf77
+  metadata.gz: 74edc4cb8982b9426d2c97b67495eb2d0dda6b8f
+  data.tar.gz: dd6178322ddf0fe3642937607c595f55fac96aa7
 SHA512:
-  metadata.gz: 72ac15616a53573b24e72a3ed15cd6a799ea732a8735b24e94228eb7dc408b9d3740a967f8c4e62b5791be77f14a9f15bbdcb5819e2d2cc082ad3d2e59c79b10
-  data.tar.gz: a735784df455af350effe390ee843fd9c3639dd2ba5625a1faea88fb90ab9ff4dc4b849e565f158bc5faa46862ee4db6c013b8b73c387b59044a6595a66b8965
+  metadata.gz: 00f1778963481c83eeb234510718d4c6397fa22eeb1a0453186bf244b7c4efa0b4dbd84729e03b28c282dca12e2f841800ede8a72612df4a594bd1fae4f3a1bd
+  data.tar.gz: f6b4e7a3b970eecf9299b6060b9d6784241490e7260476e7783c1cc061b6fa1e099700404858c5f212d5b833d96c854e5ce0177bf59e93a949d2e7078e4f935e

data/.rspec

@@ -1,2 +1,3 @@
 --format documentation
 --color
+--require spec_helper

data/lib/REX12/version.rb

@@ -1,3 +1,3 @@
 module REX12
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/rex12/document.rb

@@ -4,26 +4,29 @@
 # but if you use the block form of the methods, then the subsequent ruby objects
 # are created within the block loops so they can be garbage collected
 module REX12; class Document
+
   # Parse the EDI document from file
   #
   # @return (see #parse)
-  def self.read path
+  def self.read path_or_io
     if block_given?
-      parse(IO.read(path)) {|s| yield s}
+      parse(file_text(path_or_io)) {|s| yield s}
       return nil
     else
-      return parse(IO.read(path))
+      return parse(file_text(path_or_io))
     end
   end
-  # Parse the EDI document from text
+
+  # Parse the EDI document from text or IO object
   #
-  # @return [Enumerator<REX12::Segment>,nil] all segments or nil for block form
+  # @return [Array<REX12::Segment>,nil] all segments or nil for block form
   def self.parse text
     validate_isa(text)
     element_separator = text[3]
     segment_terminator = determine_segment_terminator(text)
     sub_element_separator = text[104]
     r = []
+
     text.split(segment_terminator).each_with_index do |seg_text,pos|
       next if seg_text.length == 0
       seg = REX12::Segment.new(seg_text,element_separator,sub_element_separator,pos)
@@ -33,6 +36,7 @@ module REX12; class Document
         r << seg
       end
     end
+
     if block_given?
       return nil
     else
@@ -40,7 +44,52 @@ module REX12; class Document
     end
   end
 
+  # Parses the EDI document from text or IO object, returning or yielding every transaction from the 
+  # document.
+  #
+  # @return [Array<REX12::Transaction>,nil] all transactions or nil for block form
+  def self.each_transaction text
+    isa = nil
+    current_gs = nil
+    current_segments = []
+    transactions = []
+
+    parse(text) do |segment|
+      segment_type = segment.segment_type
+      case segment_type
+      when "ISA"
+        isa = segment
+      when "GS"
+        current_gs = segment
+      when "IEA", "GE"
+        # Do nothing, we don't care about the trailer segments
+      else
+        current_segments << segment
+
+        # If we found the transaction trailer, it means we can take all the current segments we have and process them
+        if segment_type == "SE"
+          transaction = REX12::Transaction.new(isa, current_gs, current_segments)
+
+          if block_given? 
+            yield transaction
+          else
+            transactions << transaction
+          end
+
+          current_gs = nil
+          current_segments = []
+        end
+      end
+    end
+
+    block_given? ? nil : transactions
+  end
+
   def self.determine_segment_terminator text
+    # Technically, allowing multi-character terminators is not valid EDI, but you 
+    # see it happen ALL the time with EDI that's been hand editted from a client (especially on Windows).
+    # It's a valid enough use-case that we're accounting for it.
+
     # no segement terminator, just CRLF
     return "\r\n" if text[105..106]=="\r\n"
     # no segement terminator, just CR or LF
@@ -50,15 +99,21 @@ module REX12; class Document
     # segment terminator with CRLF
     return text[105..107] if text[106..107]=="\r\n"
     return text[105..106] if ["\r","\n"].include?(text[106]) && text[107]=="G"
-    raise REX12::ParseError, "Cannot determine segment terminator, invalid ISA / GS."
+    raise REX12::ParseError, "Invalid ISA / GS segements. Could not determine segment terminator."
   end
   private_class_method :determine_segment_terminator
 
   def self.validate_isa text
     raise REX12::ParseError, "EDI file must be at least 191 characters to include a valid envelope." unless text.length > 191
     str = text[0..2]
-    raise REX12::ParseError, "First 3 characters must be ISA, they were #{str}" unless str=='ISA'
+    raise REX12::ParseError, "First 3 characters must be ISA. They were '#{str}'." unless str=='ISA'
     return
   end
   private_class_method :validate_isa
+
+  # Allow reading from an object that responds to #read or assume the given param is a string file path and read with IO
+  def self.file_text path_or_io
+    path_or_io.respond_to?(:read) ? path_or_io.read : IO.read(path_or_io)
+  end
+  private_class_method :file_text
 end; end

data/lib/rex12/transaction.rb

@@ -0,0 +1,20 @@
+# Represents a collection of all EDI elements between the ST/SE segments of a single EDI document transaction.
+# An EDI document may have multiple transactions in it.
+module REX12; class Transaction
+
+  # @return REX12::Segment - The ISA segment from the EDI document this transaction belongs to
+  attr_reader :isa_segment
+
+  # @return REX12::Segment - The GS segment from the EDI document this transaction belongs to
+  attr_reader :gs_segment
+
+  # @return Array<REX12::Segment> - All the segments that comprise this EDI Transaction
+  attr_reader :segments
+
+  def initialize(isa_segment, gs_segment, segments)
+    @isa_segment = isa_segment
+    @gs_segment = gs_segment
+    @segments = segments
+  end
+  
+end; end

data/lib/rex12.rb

@@ -3,6 +3,7 @@ require "rex12/parse_error"
 require "rex12/element"
 require "rex12/segment"
 require "rex12/document"
+require 'rex12/transaction'
 
 module REX12
   # Your code goes here...

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: REX12
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Brian Glick
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-19 00:00:00.000000000 Z
+date: 2017-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,6 +89,7 @@ files:
 - lib/rex12/element.rb
 - lib/rex12/parse_error.rb
 - lib/rex12/segment.rb
+- lib/rex12/transaction.rb
 - rex12.gemspec
 homepage: https://github.com/Vandegrift/rex12
 licenses: