eddy 0.5.0 → 0.8.1

data/lib/eddy/parse.rb

@@ -12,13 +12,13 @@ module Eddy
       # @return [String] ("~")
       attr_accessor :segment_separator
       # Data Element Separator
-      # @return [String] ("*")
+      # @return [String] ("\*")
       attr_accessor :element_separator
 
       # @param doc [String] EDI document.
       # @param component_separator [String] (">")
       # @param segment_separator [String] ("~")
-      # @param element_separator [String] ("*")
+      # @param element_separator [String] ("\*")
       # @return [void]
       def initialize(doc, component_separator: ">", segment_separator: "~", element_separator: "*")
         self.document = doc

data/lib/eddy/summary.rb

@@ -0,0 +1,10 @@
+require "eddy/summary/validate"
+require "eddy/summary/element"
+require "eddy/summary/segment"
+require "eddy/summary/loop"
+require "eddy/summary/transaction_set"
+
+module Eddy
+  # Classes containing data for EDI component definitions.
+  module Summary; end
+end

data/lib/eddy/{schema/element_summary.rb → summary/element.rb}

@@ -1,7 +1,7 @@
 module Eddy
-  module Schema
+  module Summary
     # An individual EDI Data Element. Used in Companion Guides to define requirements for a Segment.
-    class ElementSummary
+    class Element
 
       # Indicates the order in which Elements should appear in their Segment.
       # @return [String]
@@ -37,7 +37,7 @@ module Eddy
       # @param params [Hash] ({})
       # @return [self]
       def self.create(params = {})
-        summary = new()
+        summary = self.new()
         summary.ref          = params[:ref]&.strip
         summary.id           = params[:id]&.strip
         summary.name         = params[:name]&.strip

data/lib/eddy/{schema/loop_summary.rb → summary/loop.rb}

@@ -1,14 +1,14 @@
 module Eddy
-  module Schema
+  module Summary
     # A repeated collection of Segments and/or other Loops. Used in Companion Guides.
-    class LoopSummary
+    class Loop
 
       # A unique string used to identify the Loop within its Transaction Set.
       # @return [String]
-      attr_accessor :loop_id
+      attr_accessor :id
       # Number of times a particular Loop may be repeated.
       # @return [Integer]
-      attr_accessor :repeat
+      attr_accessor :repeat_limit
       # *Syntax*, *Semantic*, or *Comment* notes on a Loop.
       # @return [String]
       attr_accessor :notes
@@ -19,7 +19,7 @@ module Eddy
       # @return [String]
       attr_accessor :req
       # The components that make up the Loop.
-      # @return [Array<Eddy::Schema::SegmentSummary, Eddy::Schema::LoopSummary>]
+      # @return [Array<Eddy::Summary::Segment, Eddy::Summary::Loop>]
       attr_accessor :components
 
       # @return [void]
@@ -30,9 +30,9 @@ module Eddy
       # @param params [Hash]
       # @return [self]
       def self.create(params = {})
-        l = LoopSummary.new
-        l.loop_id = params[:loop_id]
-        l.repeat = params[:repeat]
+        l = new()
+        l.id = params[:loop_id]
+        l.repeat_limit = params[:repeat]
         l.notes = params[:notes]
         l.level = params[:level]
         l.req = params[:req]
@@ -43,9 +43,9 @@ module Eddy
       # @param path [String] Path to a JSON or YAML file containing a valid Loop definition.
       # @return [self]
       def self.from_file(path)
-        raise Eddy::Errors::Error, "Invalid segment definition" unless Eddy::Schema.valid_loop_data?(path)
+        raise Eddy::Errors::Error, "Invalid segment definition" unless Eddy::Summary.valid_loop_data?(path)
         data = Eddy::Util.read_json_or_yaml(path)
-        return Eddy::Schema::LoopSummary.create(data)
+        return self.create(data)
       end
 
       # @param components [Array<Hash>]
@@ -54,9 +54,9 @@ module Eddy
         return if components.nil?
         components.each do |comp|
           if comp.key?(:loop_id)
-            self.components << Eddy::Schema::LoopSummary.create(comp)
+            self.components << Eddy::Summary::Loop.create(comp)
           else
-            self.components << Eddy::Schema::SegmentSummary.create(comp)
+            self.components << Eddy::Summary::Segment.create(comp)
           end
         end
       end
@@ -69,14 +69,14 @@ module Eddy
         comps = ""
         self.components.each do |comp|
           case comp
-          when Eddy::Schema::SegmentSummary then comps << "  - #{comp.id.upcase}\n"
-          when Eddy::Schema::LoopSummary    then comps << "  - #{comp.loop_id.upcase} (loop)\n"
+          when Eddy::Summary::Segment then comps << "  - #{comp.id.upcase}\n"
+          when Eddy::Summary::Loop    then comps << "  - #{comp.id.upcase} (loop)\n"
           end
         end
         parts = []
         parts << "### Loop Summary:\n" if header
         parts << <<~YARD.strip
-          - Repeat: #{self.repeat}
+          - Repeat: #{self.repeat_limit}
           - Components:
           #{comps}
         YARD
@@ -85,17 +85,54 @@ module Eddy
 
       # Return all components in a single, flattened array.
       #
-      # @return [Array<Eddy::Schema::SegmentSummary, Eddy::Schema::LoopSummary>]
+      # @return [Array<Eddy::Summary::Segment, Eddy::Summary::Loop>]
       def all_components()
         return self.components.map do |comp|
           case comp
-          when Eddy::Schema::LoopSummary    then [comp, comp.all_components()]
-          when Eddy::Schema::SegmentSummary then comp
+          when Eddy::Summary::Loop    then [comp, comp.all_components()]
+          when Eddy::Summary::Segment then comp
           else raise Eddy::Errors::Error
           end
         end.flatten
       end
 
+      # Return `id` with `"l_"` slapped on the front if it wasn't already there.
+      # Meant to be used for instance variable names.
+      #
+      # @return [String]
+      def var_name()
+        if self.id.start_with?(/\Ah?l_/i)
+          return self.id.downcase
+        else
+          return "l_#{self.id.downcase}"
+        end
+      end
+
+      # Return `id` with the prefixes `"l_"` or `"hl_" removed.
+      #
+      # @return [String]
+      def class_name()
+        return self.id.downcase.gsub(/\Ah?l_/i, "")
+      end
+
+      # Returns `true` if the loop is a Hierarchical Loop.
+      # Meant to be used for class or module names.
+      #
+      # @return [Boolean]
+      def hierarchical?()
+        return self.id =~ /\Ahl_/i
+      end
+
+      # Returns `true` the loop should be treated as a segment when Generating ruby code.
+      # (For use in {Eddy::Build})
+      #
+      # @return [Boolean]
+      def build_as_segment?()
+        return false if self.hierarchical?
+        return false if self.repeat_limit > 1
+        return true
+      end
+
     end
   end
 end

data/lib/eddy/{schema/segment_summary.rb → summary/segment.rb}

@@ -1,7 +1,7 @@
 module Eddy
-  module Schema
+  module Summary
     # A collection of Data Elements. Used in Companion Guides to define a Transaction Set.
-    class SegmentSummary
+    class Segment
 
       # Indicates the order in which Segments should appear in their Level of the Transaction Set.
       # @return [String]
@@ -34,7 +34,7 @@ module Eddy
       # @return [String]
       attr_accessor :level
       # Number of Data Elements included in the Segment.
-      # @return [Array<Eddy::Schema::ElementSummary>]
+      # @return [Array<Eddy::Summary::Element>]
       attr_accessor :elements
 
       # @return [void]
@@ -63,9 +63,9 @@ module Eddy
       # @param path [String] Path to a JSON or YAML file containing a valid Segment definition.
       # @return [self]
       def self.from_file(path)
-        raise Eddy::Errors::Error, "Invalid segment definition" unless Eddy::Schema.valid_segment_data?(path)
+        raise Eddy::Errors::Error, "Invalid segment definition" unless Eddy::Summary.valid_segment_data?(path)
         data = Eddy::Util.read_json_or_yaml(path)
-        return Eddy::Schema::SegmentSummary.create(data)
+        return Eddy::Summary::Segment.create(data)
       end
 
       # @param id [String]
@@ -73,10 +73,10 @@ module Eddy
       def self.default_for_id(id)
         id.downcase!
         if ["ge", "gs", "iea", "isa", "se", "st"].include?(id)
-          path = File.join(Eddy::Util.data_dir, "004010", "segments", "envelope", "#{id}.segment.yml")
+          path = File.join(Eddy::Util.data_dir, "segments", "envelope", "#{id}.segment.yml")
           return self.from_file(path)
         end
-        path = File.join(Eddy::Util.data_dir, "004010", "segments", "#{id}.segment.yml")
+        path = File.join(Eddy::Util.data_dir, "segments", "#{id}.segment.yml")
         raise Eddy::Errors::Error, "No segment found with id #{id}" unless File.file?(path)
         return self.from_file(path)
       end
@@ -89,7 +89,7 @@ module Eddy
       def process_elements(elements)
         return if elements.nil?
         elements.each do |el|
-          default_el = Eddy::Schema::ElementSummary.default_for_id(el[:id])
+          default_el = Eddy::Summary::Element.default_for_id(el[:id])
           default_el.ref = el[:ref]
           default_el.req = el[:req] || nil
           self.elements << default_el
@@ -111,6 +111,14 @@ module Eddy
         return parts.compact.join("\n")
       end
 
+      # Helper function to simplify conditional logic in {Eddy::Build}.
+      #
+      # @see {Eddy::Summary::Loop#treat_as_segment?}
+      # @return [Boolean] (true) Always returns true.
+      def build_as_segment?()
+        return true
+      end
+
     end
   end
 end

data/lib/eddy/{schema/transaction_set_summary.rb → summary/transaction_set.rb}

@@ -1,7 +1,8 @@
 module Eddy
-  module Schema
+  module Summary
     # An outline of all required components for an EDI transaction set implementation.
-    class TransactionSetSummary
+    class TransactionSet
+
       # A short code identifying the Transaction Set.
       # @return [Integer]
       attr_accessor :id
@@ -12,7 +13,7 @@ module Eddy
       # @return [String]
       attr_accessor :functional_group
       # The components that make up the Transaction Set.
-      # @return [Array<Eddy::Schema::SegmentSummary, Eddy::Schema::LoopSummary>]
+      # @return [Array<Eddy::Summary::Segment, Eddy::Summary::Loop>]
       attr_accessor :components
 
       # @return [void]
@@ -23,7 +24,7 @@ module Eddy
       # @param params [Hash]
       # @return [self]
       def self.create(params = {})
-        summary = TransactionSetSummary.new()
+        summary = new()
         summary.id = params[:id]
         summary.name = params[:name]
         summary.functional_group = params[:functional_group]
@@ -34,9 +35,9 @@ module Eddy
       # @param path [String] Path to a JSON or YAML file containing a valid Segment definition.
       # @return [self]
       def self.from_file(path)
-        raise Eddy::Errors::Error, "Invalid transaction set definition" unless Eddy::Schema.valid_transaction_set_data?(path)
+        raise Eddy::Errors::Error, "Invalid transaction set definition" unless Eddy::Summary.valid_transaction_set_data?(path)
         data = Eddy::Util.read_json_or_yaml(path)
-        return Eddy::Schema::TransactionSetSummary.create(data)
+        return Eddy::Summary::TransactionSet.create(data)
       end
 
       # @param components [Array<Hash>]
@@ -44,9 +45,9 @@ module Eddy
       def process_components(components)
         components.each do |comp|
           if comp.key?(:loop_id)
-            self.components << Eddy::Schema::LoopSummary.create(comp)
+            self.components << Eddy::Summary::Loop.create(comp)
           else
-            self.components << Eddy::Schema::SegmentSummary.create(comp)
+            self.components << Eddy::Summary::Segment.create(comp)
           end
         end
       end
@@ -73,12 +74,12 @@ module Eddy
 
       # Return all components in a single, flattened array.
       #
-      # @return [Array<Eddy::Schema::SegmentSummary, Eddy::Schema::LoopSummary>]
+      # @return [Array<Eddy::Summary::Segment, Eddy::Summary::Loop>]
       def all_components()
         return self.components.map do |comp|
           case comp
-          when Eddy::Schema::LoopSummary    then [comp, comp.all_components()]
-          when Eddy::Schema::SegmentSummary then comp
+          when Eddy::Summary::Loop    then [comp, comp.all_components()]
+          when Eddy::Summary::Segment then comp
           else raise Eddy::Errors::Error
           end
         end.flatten
@@ -86,9 +87,9 @@ module Eddy
 
       # Return one of each kind of loop in the Transaction Set.
       #
-      # @return [Array<Eddy::Schema::SegmentSummary, Eddy::Schema::LoopSummary>]
+      # @return [Array<Eddy::Summary::Loop>]
       def unique_loops()
-        return self.all_components.select { |c| c.is_a?(Eddy::Schema::LoopSummary) }.uniq(&:loop_id)
+        return self.all_components.select { |c| c.is_a?(Eddy::Summary::Loop) }.uniq(&:id)
       end
 
     end

data/lib/eddy/{schema → summary}/validate.rb

@@ -2,7 +2,7 @@ require "pathname"
 require "json_schemer"
 
 module Eddy
-  module Schema
+  module Summary
 
     # Check a Segment definition file against Eddy's JSON schema.
     #

data/lib/eddy/util.rb

@@ -1,8 +1,3 @@
-module Eddy
-  # Assorted helper functions.
-  module Util; end
-end
-
 require "eddy/util/new_number"
 require "eddy/util/normalize"
 require "eddy/util/trim"
@@ -14,3 +9,8 @@ require "eddy/util/time"
 require "eddy/util/paths"
 
 require "eddy/util/edi_data"
+
+module Eddy
+  # Assorted helper functions.
+  module Util; end
+end

data/lib/eddy/util/clean_folder.rb

@@ -2,10 +2,13 @@ module Eddy
   module Util
     # Delete all files from a folder; returns number of deleted files.
     #
+    # Fails if the folder contains any symlinks.
+    #
     # @param path [String] Path to the folder.
     # @return [Integer]
     def self.clean_folder(path)
       dir = File.expand_path(path)
+      return 0 unless Dir.exist?(dir)
       children = Dir.entries(dir).select { |f| File.file?(File.join(dir, f)) }
       deleted = File.unlink(*children)
       return deleted

data/lib/eddy/util/edi_data.rb

@@ -2,7 +2,7 @@ module Eddy
   module Util
     # @!group EDI Data
 
-    # Return raw data from `data/004010/elements.tsv`.
+    # Return raw data from `data/elements.tsv`.
     #
     #
     # @example Example return value
@@ -15,7 +15,7 @@ module Eddy
     #
     # @return [Array<Hash>]
     def self.raw_element_data()
-      return Eddy::Util.parse_tsv(File.join(Eddy::Util.data_dir, "004010", "elements.tsv"))
+      return Eddy::Util.parse_tsv(File.join(Eddy::Util.data_dir, "elements.tsv"))
     end
 
     # Returns a hash where the keys are Element ids and the values are unprocessed Element names.
@@ -36,7 +36,7 @@ module Eddy
     #
     # @return [Hash<String, String>]
     def self.element_ids()
-      file = File.join(Eddy::Util.data_dir, "004010", "elements-short.tsv")
+      file = File.join(Eddy::Util.data_dir, "elements-short.tsv")
       data = {}
       CSV.foreach(file, { col_sep: "\t", quote_char: "\x00", headers: false }) do |row|
         next if row ==  ["id", "name"]
@@ -61,7 +61,7 @@ module Eddy
     #
     # @return [Hash<String, String>]
     def self.segment_ids()
-      file = File.join(Eddy::Util.data_dir, "004010", "segments.tsv")
+      file = File.join(Eddy::Util.data_dir, "segments.tsv")
       data = {}
       CSV.foreach(file, { col_sep: "\t", quote_char: "\x00" }) do |row|
         next if row ==  ["id", "name"]
@@ -120,18 +120,18 @@ module Eddy
       return files.map { |f| File.basename(f).sub(/\..*/, "").upcase }
     end
 
-    # List Segment definition files in `data/004010/segments`.
+    # List Segment definition files in `data/segments`.
     #
     # @example Example return value
     #   [
-    #     "~/.rbenv/versions/2.6.5/lib/gems/eddy-0.0.0/data/004010/segments/ack.segment.yml",
-    #     "~/.rbenv/versions/2.6.5/lib/gems/eddy-0.0.0/data/004010/segments/bak.segment.yml",
+    #     "~/.rbenv/versions/2.6.5/lib/gems/eddy-0.0.0/data/segments/ack.segment.yml",
+    #     "~/.rbenv/versions/2.6.5/lib/gems/eddy-0.0.0/data/segments/bak.segment.yml",
     #     ...,
     #   ]
     #
     # @return [Array<String>]
     def self.list_segment_definitions()
-      dir = File.join(Eddy::Util.data_dir, "004010", "segments")
+      dir = File.join(Eddy::Util.data_dir, "segments")
       files = Dir.entries(dir).select { |f| File.file?(File.join(dir, f)) }
       return files.map { |f| File.join(dir, f) }.sort
     end

data/lib/eddy/util/trim.rb

@@ -5,7 +5,7 @@ module Eddy
     # See: [Trailing delimiters and 999 response - X12 RFI](http://www.x12.org/rfis/Trailing%20delimiters%20and%20999%20response.pdf)
     #
     # @param itch [String] String containing an EDI Interchange.
-    # @param element_separator [String] ("*")
+    # @param element_separator [String] ("\*")
     # @param segment_separator [String] ("~")
     # @return [String]
     def self.trim_delims_from_interchange(itch, element_separator: "*", segment_separator: "~")
@@ -17,7 +17,7 @@ module Eddy
     # See: [Trailing delimiters and 999 response - X12 RFI](http://www.x12.org/rfis/Trailing%20delimiters%20and%20999%20response.pdf)
     #
     # @param segment [String] String containing an EDI segment.
-    # @param separator [String] ("*")
+    # @param separator [String] ("\*")
     # @return [String]
     def self.trim_delims_from_segment(segment, separator: "*")
       e_sep = Regexp.escape(separator)