edir 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85b647a793b1d14bd9c0eaec8a204f86d1d31c3212f7897029dd3aa7b98ee81a
-  data.tar.gz: c76e2aefd32b24c4a9aa2a373734cba02458b6906857a32236d9c58c0ab5252e
+  metadata.gz: 2cebacb3d342e6e849b771d06dde5931bdce5b118d82be793a9830dd0d087bee
+  data.tar.gz: 117315ab268afe2d40b7016a907a831e068280d94c649fbacc56b0f679e9374f
 SHA512:
-  metadata.gz: d98a8d32a9600808cc50917b845db3560ed646d9cf4c0fbcc0c82d7c58c1ad8b55cf145321882819da0594bd8e474292afbf3602f4ac0233408947c2dc2121b7
-  data.tar.gz: 905294a847e34b560fd4fd3a9bfbde47455559af689b1d2d11f4b4f3a09848d48783b239731ca93d883ec8e9be7d35992142dfb2b0ca6e9dc03336f4032072ee
+  metadata.gz: faf065948fe8d41ccaafe5900480f9e576805335b4225d2eb026722f23c1728a89fa5e2b6b288b7453ef53c227a4cee72495f29d12e1dcdf91e56f0621d50258
+  data.tar.gz: 3844441935e8fa8e7d5567ac82ca242f392f7f378042901e6549bb3dfa408e40b412869b043816d341a11b53c21f8a804ccd97f2f1a01e4a5c79e5751f6aa217

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    edir (0.1.0)
+    edir (1.0.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,6 +1,6 @@
 # Edir
 
-This is a Gem for parsing files. Right now there's no configuration and offers essentially 1 feature: reading EDI and outputting it as formatted Ruby data.
+This is a Gem for parsing EDI files. Right now there's no configuration and offers essentially 1 feature: reading EDI and outputting it as formatted Ruby data or JSON.
 
 ## Installation
 
@@ -20,7 +20,7 @@ Or install it yourself as:
 
 ## Usage
 
-Right now there's not a lot to it. Use the parser like so:
+There's not a lot to it. Use the parser like so:
 
 ```ruby
 require 'edir'
@@ -30,7 +30,8 @@ edi_data = Edir::Parser.new.parse(edi_string)
 
 ### Example
 ```ruby
-Edir::Parser.new.parse(File.read('spec/fixtures/files/204_example_1.txt'))
+parsed = Edir::Parser.new.parse(File.read('spec/fixtures/files/204_example_1.txt'))
+parsed.to_h # or .to_json
 ```
 
 The lexer is implemented in pure ruby, so changes in `lexer.rb` are always current. However,

data/lib/edir/convert.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative "document"
+require_relative "interchange"
+require_relative "functional_group"
+require_relative "transaction_set"
+require_relative "segment"
+
+module Edir
+  # Converter methods for parsed EDI
+  module Convert
+    # For each transaction set start/end, create a unique transaction set object with
+    # the corrsponding segments.
+    # For each functional group start/end, create a unique functional group object with
+    # the corresponding transaction sets.
+    # For each interchange start/end, create a unique interchange object with the corresponding
+    # functional groups.
+    def convert_document(segments)
+      interchanges = partition_by_seg_types(segments: segments, seg_start: "ISA", seg_end: "IEA")
+      converted_interchanges = interchanges.map do |inter|
+        convert_interchange(inter)
+      end
+
+      Edir::Document.new(interchanges: converted_interchanges)
+    end
+
+    def convert_interchange(inter)
+      func_groups = partition_by_seg_types(segments: inter[1..-2], seg_start: "GS", seg_end: "GE")
+      converted_func_groups = func_groups.map do |func_group|
+        convert_functional_group(func_group)
+      end
+
+      Edir::Interchange.new(
+        header: inter.first,
+        footer: inter.last,
+        func_groups: converted_func_groups
+      )
+    end
+
+    def convert_functional_group(func_group)
+      transac_sets = partition_by_seg_types(segments: func_group[1..-2], seg_start: "ST", seg_end: "SE")
+      converted_transac_sets = transac_sets.map do |transac_set|
+        convert_transaction_set(transac_set)
+      end
+
+      Edir::FunctionalGroup.new(
+        header: func_group.first,
+        footer: func_group.last,
+        transac_sets: converted_transac_sets
+      )
+    end
+
+    def convert_transaction_set(transac_set)
+      Edir::TransactionSet.new(
+        header: transac_set.first,
+        footer: transac_set.last,
+        segments: transac_set[1..-2]
+      )
+    end
+
+    def partition_by_seg_types(segments:, seg_start:, seg_end:)
+      partitions = []
+      while segments.length.positive?
+        part_start = segments.find_index { |s| s.name == seg_start }
+        part_end = segments.find_index { |s| s.name == seg_end }
+        partitions << segments[part_start..part_end]
+        segments = segments[part_end + 1..]
+      end
+
+      partitions
+    end
+  end
+end

data/lib/edir/document.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Edir
+  # Data class for documents
+  class Document
+    attr_reader :interchanges
+
+    def initialize(interchanges:)
+      @interchanges = interchanges
+    end
+
+    def segments
+      @interchanges.map(&:segments).flatten
+    end
+
+    def elements
+      segments.map(&:elements)
+    end
+
+    def to_h
+      {
+        "interchanges" => @interchanges.map(&:to_h).flatten
+      }
+    end
+
+    def to_json(*)
+      to_h.to_json
+    end
+  end
+end

data/lib/edir/functional_group.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Edir
+  # Data class for functional groups
+  class FunctionalGroup
+    attr_reader :transac_sets
+
+    def initialize(header:, footer:, transac_sets:)
+      @header = header
+      @footer = footer
+      @transac_sets = transac_sets
+    end
+
+    def segments
+      [@header] + @transac_sets.map(&:segments) + [@footer]
+    end
+
+    def elements
+      segments.map(&:elements)
+    end
+
+    def to_h
+      @header.to_h.merge(
+        {
+          "transaction_sets" => @transac_sets.map(&:to_h).flatten
+        }
+      ).merge(@footer.to_h)
+    end
+  end
+end

data/lib/edir/interchange.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Edir
+  # Data class for interchanges
+  class Interchange
+    attr_reader :func_groups
+
+    def initialize(header:, footer:, func_groups:)
+      @header = header
+      @footer = footer
+      @func_groups = func_groups
+    end
+
+    def segments
+      [@header] + @func_groups.map(&:segments).flatten + [@footer]
+    end
+
+    def elements
+      segments.map(&:elements)
+    end
+
+    def to_h
+      @header.to_h.merge(
+        {
+          "functional_groups" => @func_groups.map(&:to_h).flatten
+        }
+      ).merge(@footer.to_h)
+    end
+  end
+end

data/lib/edir/parser.rb

@@ -7,87 +7,14 @@
 require 'racc/parser.rb'
 
 require_relative 'lexer'
-
-class Edir::Interchange
-  attr_reader :func_groups
-  def initialize(header:, footer:, func_groups:)
-    @header = header
-    @footer = footer
-    @func_groups = func_groups
-  end
-
-  def segments
-    [@header] + @func_groups.map(&:segments).flatten + [@footer]
-  end
-
-  def elements
-    segments.map(&:elements)
-  end
-end
-
-class Edir::FunctionalGroup
-  attr_reader :transac_sets
-
-  def initialize(header:, footer:, transac_sets:)
-    @header = header
-    @footer = footer
-    @transac_sets = transac_sets
-  end
-
-  def segments
-    [@header] + @transac_sets.map(&:segments) + [@footer]
-  end
-
-  def elements
-    segments.map(&:elements)
-  end
-end
-
-class Edir::TransactionSet
-  def initialize(header:, footer:, segments:)
-    @header = header
-    @footer = footer
-    @segments = segments
-  end
-
-  def segments
-    [@header] + @segments + [@footer]
-  end
-
-  def elements
-    segments.map(&:elements)
-  end
-end
-
-class Edir::Segment
-  attr_reader :elements
-  attr_reader :name
-  attr_reader :raw_data
-
-  def initialize(data)
-    @raw_data = data
-
-    @name = data.first
-    @elements = []
-    position = 0
-    @raw_data[1..].each do |element|
-      if element =~ /[*|]/
-        position += 1
-      else
-        @elements.push([element, position])
-      end
-    end
-  end
-
-  def get_element(position)
-    @elements.detect { |e| e[1] == position}
-  end
-end
+require_relative 'convert'
 
 module Edir
   class Parser < Racc::Parser
 
-module_eval(<<'...end parser.y/module_eval...', 'parser.y', 99)
+module_eval(<<'...end parser.y/module_eval...', 'parser.y', 24)
+include Edir::Convert
+
 def initialize(debug: false)
   @yydebug = debug
 end
@@ -106,69 +33,6 @@ end
 def next_token
   @q.shift
 end
-
-# For each transaction set start/end, create a unique transaction set object with
-# the corrsponding segments.
-# For each functional group start/end, create a unique functional group object with
-# the corresponding transaction sets.
-# For each interchange start/end, create a unique interchange object with the corresponding
-# functional groups.
-def convert_document(segments)
-  interchanges = partition_by_seg_types(segments: segments, seg_start: "ISA", seg_end: "IEA")
-  interchanges.map do |inter|
-    convert_interchange(inter) 
-  end
-end
-
-def convert_interchange(inter)
-  func_groups = partition_by_seg_types(segments: inter[1..-2], seg_start: "GS", seg_end: "GE")
-  converted_func_groups = func_groups.map do |func_group|
-    convert_functional_group(func_group) 
-  end
-
-  Edir::Interchange.new(
-    header: inter.first,
-    footer: inter.last,
-    func_groups: converted_func_groups
-  )
-end
-
-def convert_functional_group(func_group)
-  transac_sets = partition_by_seg_types(segments: func_group[1..-2], seg_start: "ST", seg_end: "SE")
-  converted_transac_sets = transac_sets.map do |transac_set|
-    convert_transaction_set(transac_set)    
-  end
-
-  Edir::FunctionalGroup.new(
-    header: func_group.first,
-    footer: func_group.last,
-    transac_sets: converted_transac_sets
-  )
-end
-
-def convert_transaction_set(transac_set)
-  Edir::TransactionSet.new(
-    header: transac_set.first,
-    footer: transac_set.last,
-    segments: transac_set[1..-2]
-  )
-end
-
-def partition_by_seg_types(segments:, seg_start:, seg_end:)
-  partitions = []
-  while segments.length > 0 do
-    part_start = segments.find_index do |segment|
-      segment.name == seg_start
-    end
-    part_end = segments.find_index do |segment|
-      segment.name == seg_end
-    end
-    partitions << segments[part_start..part_end]
-    segments = segments[part_end+1..]
-  end
-
-  partitions
-end
 ...end parser.y/module_eval...
 ##### State transition tables begin ###
 

data/lib/edir/parser.y

@@ -18,84 +18,11 @@ end
 
 ---- header
 require_relative 'lexer'
-
-class Edir::Interchange
-  attr_reader :func_groups
-  def initialize(header:, footer:, func_groups:)
-    @header = header
-    @footer = footer
-    @func_groups = func_groups
-  end
-
-  def segments
-    [@header] + @func_groups.map(&:segments).flatten + [@footer]
-  end
-
-  def elements
-    segments.map(&:elements)
-  end
-end
-
-class Edir::FunctionalGroup
-  attr_reader :transac_sets
-
-  def initialize(header:, footer:, transac_sets:)
-    @header = header
-    @footer = footer
-    @transac_sets = transac_sets
-  end
-
-  def segments
-    [@header] + @transac_sets.map(&:segments) + [@footer]
-  end
-
-  def elements
-    segments.map(&:elements)
-  end
-end
-
-class Edir::TransactionSet
-  def initialize(header:, footer:, segments:)
-    @header = header
-    @footer = footer
-    @segments = segments
-  end
-
-  def segments
-    [@header] + @segments + [@footer]
-  end
-
-  def elements
-    segments.map(&:elements)
-  end
-end
-
-class Edir::Segment
-  attr_reader :elements
-  attr_reader :name
-  attr_reader :raw_data
-
-  def initialize(data)
-    @raw_data = data
-
-    @name = data.first
-    @elements = []
-    position = 0
-    @raw_data[1..].each do |element|
-      if element =~ /[*|]/
-        position += 1
-      else
-        @elements.push([element, position])
-      end
-    end
-  end
-
-  def get_element(position)
-    @elements.detect { |e| e[1] == position}
-  end
-end
+require_relative 'convert'
 
 ---- inner
+include Edir::Convert
+
 def initialize(debug: false)
   @yydebug = debug
 end
@@ -114,66 +41,3 @@ end
 def next_token
   @q.shift
 end
-
-# For each transaction set start/end, create a unique transaction set object with
-# the corrsponding segments.
-# For each functional group start/end, create a unique functional group object with
-# the corresponding transaction sets.
-# For each interchange start/end, create a unique interchange object with the corresponding
-# functional groups.
-def convert_document(segments)
-  interchanges = partition_by_seg_types(segments: segments, seg_start: "ISA", seg_end: "IEA")
-  interchanges.map do |inter|
-    convert_interchange(inter) 
-  end
-end
-
-def convert_interchange(inter)
-  func_groups = partition_by_seg_types(segments: inter[1..-2], seg_start: "GS", seg_end: "GE")
-  converted_func_groups = func_groups.map do |func_group|
-    convert_functional_group(func_group) 
-  end
-
-  Edir::Interchange.new(
-    header: inter.first,
-    footer: inter.last,
-    func_groups: converted_func_groups
-  )
-end
-
-def convert_functional_group(func_group)
-  transac_sets = partition_by_seg_types(segments: func_group[1..-2], seg_start: "ST", seg_end: "SE")
-  converted_transac_sets = transac_sets.map do |transac_set|
-    convert_transaction_set(transac_set)    
-  end
-
-  Edir::FunctionalGroup.new(
-    header: func_group.first,
-    footer: func_group.last,
-    transac_sets: converted_transac_sets
-  )
-end
-
-def convert_transaction_set(transac_set)
-  Edir::TransactionSet.new(
-    header: transac_set.first,
-    footer: transac_set.last,
-    segments: transac_set[1..-2]
-  )
-end
-
-def partition_by_seg_types(segments:, seg_start:, seg_end:)
-  partitions = []
-  while segments.length > 0 do
-    part_start = segments.find_index do |segment|
-      segment.name == seg_start
-    end
-    part_end = segments.find_index do |segment|
-      segment.name == seg_end
-    end
-    partitions << segments[part_start..part_end]
-    segments = segments[part_end+1..]
-  end
-
-  partitions
-end

data/lib/edir/segment.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Edir
+  # Data class for segments
+  class Segment
+    attr_reader :elements, :name, :raw_data
+
+    def initialize(data)
+      @raw_data = data
+      @name = data.first
+      build_elements
+    end
+
+    def build_elements
+      @elements = []
+      position = 0
+      @raw_data[1..].each do |element|
+        if separator?(element)
+          position += 1
+        else
+          @elements.push([element, position])
+        end
+      end
+    end
+
+    def get_element(position)
+      @elements.detect { |e| e[1] == position }
+    end
+
+    def separator?(element)
+      element =~ /[*|]/
+    end
+
+    def to_h
+      {
+        @name => @elements.to_h { |e| ["e#{e.last.to_s.rjust(2, "0")}", e.first] }
+      }
+    end
+  end
+end

data/lib/edir/transaction_set.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Edir
+  # Data class for a transaction set
+  class TransactionSet
+    def initialize(header:, footer:, segments:)
+      @header = header
+      @footer = footer
+      @segments = segments
+    end
+
+    def segments
+      [@header] + @segments + [@footer]
+    end
+
+    def elements
+      segments.map(&:elements)
+    end
+
+    def to_h
+      segments.map(&:to_h)
+    end
+  end
+end

data/lib/edir/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Edir
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: edir
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Kaleb McKone
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-08 00:00:00.000000000 Z
+date: 2023-03-15 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -28,9 +28,15 @@ files:
 - bin/console
 - bin/setup
 - lib/edir.rb
+- lib/edir/convert.rb
+- lib/edir/document.rb
+- lib/edir/functional_group.rb
+- lib/edir/interchange.rb
 - lib/edir/lexer.rb
 - lib/edir/parser.rb
 - lib/edir/parser.y
+- lib/edir/segment.rb
+- lib/edir/transaction_set.rb
 - lib/edir/version.rb
 homepage: https://github.com/krmckone/edir
 licenses: