eddy 0.5.1 → 0.6.0

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 :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 = new()
         l.id = params[:loop_id]
-        l.repeat = params[:repeat]
+        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.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]
@@ -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(&: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/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/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/version.rb

@@ -1,3 +1,3 @@
 module Eddy
-  VERSION = "0.5.1".freeze
+  VERSION = "0.6.0".freeze
 end

data/lib/eddy.rb

@@ -6,17 +6,11 @@ require "eddy/errors"
 require "eddy/util"
 require "eddy/config"
 require "eddy/data"
-
-Dir.glob(File.join(__dir__, "eddy", "schema", "*.rb")).sort.each { |file| require file }
-
+require "eddy/summary"
 require "eddy/models"
 require "eddy/parse"
 require "eddy/build"
 
-# Dir.glob(File.join(__dir__, "definitions", "elements", "manual", "**", "*.rb")).sort.each         { |file| require file }
-# Dir.glob(File.join(__dir__, "definitions", "segments", "manual", "**", "*.rb")).sort.each         { |file| require file }
-# Dir.glob(File.join(__dir__, "definitions", "transaction_sets", "manual", "**", "*.rb")).sort.each { |file| require file }
-
 Dir.glob(File.join(__dir__, "definitions", "elements", "**", "*.rb")).sort.each         { |file| require file }
 Dir.glob(File.join(__dir__, "definitions", "segments", "**", "*.rb")).sort.each         { |file| require file }
 Dir.glob(File.join(__dir__, "definitions", "transaction_sets", "**", "*.rb")).sort.each { |file| require file }

data/todo.txt

@@ -4,14 +4,12 @@ x 2019-12-20 Write code to build all segments.
 x 2020-01-02 2019-12-20 Figure out how to deal with loops.
 x 2020-01-03 2019-12-20 Finish TransactionSetBuilder.
 x 2020-01-05 2019-12-20 Reset `Eddy.data` when `Eddy.config.persistence_method` changes.
+x 2019-12-20 Add a DB persistence_method. (see eddy-rails)
+x 2020-01-07 2019-12-28 If a loop can only repeat once, dont treat it as a loop.
 
-2019-12-28 If a loop can only repeat once, dont treat it as a loop.
-2019-12-20 Add a DB persistence_method.
-2019-12-20 Check for conflicts in Rails generators.
-2019-12-20 Write a Rails model generator.
 2019-12-27 Generate "ref map" files.
 2019-12-30 Logging
 2019-12-30 JSON schema validation errors.
 2020-01-02 Ensure loops dont go over repeat limit.
 2020-01-02 Implement `Segment.max_use` & `Segment.min_use`.
-2020-01-05 Move `Build` to `eddy-build`
+2020-01-05 Move `Build` to `eddy-build`?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eddy
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Clay Dunston
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-06 00:00:00.000000000 Z
+date: 2020-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -1483,20 +1483,34 @@ files:
 - lib/definitions/segments/manual/hl.rb
 - lib/definitions/segments/manual/n2.rb
 - lib/definitions/transaction_sets/manual/810/810.rb
-- lib/definitions/transaction_sets/manual/810/loops.rb
+- lib/definitions/transaction_sets/manual/810/loops/it1.rb
+- lib/definitions/transaction_sets/manual/810/loops/n1.rb
+- lib/definitions/transaction_sets/manual/810/loops/pid.rb
+- lib/definitions/transaction_sets/manual/810/loops/sac.rb
 - lib/definitions/transaction_sets/manual/850/850.rb
-- lib/definitions/transaction_sets/manual/850/loops.rb
+- lib/definitions/transaction_sets/manual/850/loops/n1.rb
+- lib/definitions/transaction_sets/manual/850/loops/po1.rb
 - lib/definitions/transaction_sets/manual/855/855.rb
-- lib/definitions/transaction_sets/manual/855/loops.rb
+- lib/definitions/transaction_sets/manual/855/loops/ack.rb
+- lib/definitions/transaction_sets/manual/855/loops/n1.rb
+- lib/definitions/transaction_sets/manual/855/loops/pid.rb
+- lib/definitions/transaction_sets/manual/855/loops/po1.rb
 - lib/definitions/transaction_sets/manual/856/856.rb
-- lib/definitions/transaction_sets/manual/856/loops.rb
+- lib/definitions/transaction_sets/manual/856/loops/hl_item.rb
+- lib/definitions/transaction_sets/manual/856/loops/hl_order.rb
+- lib/definitions/transaction_sets/manual/856/loops/hl_shipment.rb
+- lib/definitions/transaction_sets/manual/856/loops/hl_tare.rb
+- lib/definitions/transaction_sets/manual/856/loops/n1.rb
+- lib/definitions/transaction_sets/manual/856/loops/sln.rb
 - lib/eddy.rb
 - lib/eddy/build.rb
 - lib/eddy/build/elements/element.rb
 - lib/eddy/build/elements/elements.rb
 - lib/eddy/build/elements/id.rb
 - lib/eddy/build/elements/n.rb
-- lib/eddy/build/loop_builder.rb
+- lib/eddy/build/loop/base.rb
+- lib/eddy/build/loop/render.rb
+- lib/eddy/build/loop/repeat.rb
 - lib/eddy/build/segment_builder.rb
 - lib/eddy/build/transaction_set_builder.rb
 - lib/eddy/cli.rb
@@ -1525,11 +1539,12 @@ files:
 - lib/eddy/models/segment.rb
 - lib/eddy/models/transaction_set.rb
 - lib/eddy/parse.rb
-- lib/eddy/schema/element_summary.rb
-- lib/eddy/schema/loop_summary.rb
-- lib/eddy/schema/segment_summary.rb
-- lib/eddy/schema/transaction_set_summary.rb
-- lib/eddy/schema/validate.rb
+- lib/eddy/summary.rb
+- lib/eddy/summary/element.rb
+- lib/eddy/summary/loop.rb
+- lib/eddy/summary/segment.rb
+- lib/eddy/summary/transaction_set.rb
+- lib/eddy/summary/validate.rb
 - lib/eddy/util.rb
 - lib/eddy/util/clean_folder.rb
 - lib/eddy/util/edi_data.rb
@@ -1554,7 +1569,7 @@ metadata:
   homepage_uri: https://github.com/tcd/eddy
   source_code_uri: https://github.com/tcd/eddy
   changelog_uri: https://github.com/tcd/eddy/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/eddy/0.5.1
+  documentation_uri: https://www.rubydoc.info/gems/eddy/0.6.0
   yard.run: yri
 post_install_message: 
 rdoc_options: []

data/lib/definitions/transaction_sets/manual/810/loops.rb

@@ -1,109 +0,0 @@
-module Eddy
-  module TransactionSets
-    # Namespace for Transaction Set 810 and its loops.
-    module TS810
-      module Loops
-
-        # ### Loop Summary:
-        #
-        # - Repeat: 200
-        # - Components:
-        #   - N1
-        #   - N3
-        #   - N4
-        class N1 < Eddy::Loop::Base
-          # @param store [Eddy::Data::Store]
-          # @return [void]
-          def initialize(store)
-            super(store)
-            @repeat = 200
-            @components = [
-              Eddy::Segments::N1,
-              Eddy::Segments::N3,
-              Eddy::Segments::N4,
-            ]
-          end
-
-          # @!method add_iteration(&block)
-          #   @yieldparam [Eddy::Segments::N1] n1
-          #   @yieldparam [Eddy::Segments::N3] n3
-          #   @yieldparam [Eddy::Segments::N4] n4
-          #   @return [void]
-        end
-
-        # ### Loop Summary:
-        #
-        # - Repeat: 200,000
-        # - Components:
-        #   - IT1
-        #   - CTP
-        #   - PID (Loop)
-        #   - SAC (loop)
-        class IT1 < Eddy::Loop::Base
-          # @param store [Eddy::Data::Store]
-          # @return [void]
-          def initialize(store)
-            super(store)
-            @repeat = 200_000
-            @components = [
-              Eddy::Segments::IT1,
-              Eddy::Segments::CTP,
-              Eddy::TransactionSets::TS810::Loops::PID,
-              Eddy::TransactionSets::TS810::Loops::SAC,
-            ]
-          end
-
-          # @!method add_iteration(&block)
-          #   @yieldparam [Eddy::Segments::IT1] it1
-          #   @yieldparam [Eddy::Segments::CTP] ctp
-          #   @yieldparam [Eddy::TransactionSets::TS850::Loops::PID] l_pid
-          #   @yieldparam [Eddy::TransactionSets::TS850::Loops::SAC] l_sac
-          #   @return [void]
-        end
-
-        # ### Loop Summary:
-        #
-        # - Repeat: 1,000
-        # - Components:
-        #   - PID
-        class PID < Eddy::Loop::Base
-          # @param store [Eddy::Data::Store]
-          # @return [void]
-          def initialize(store)
-            super(store)
-            @repeat = 1_000
-            @components = [
-              Eddy::Segments::PID,
-            ]
-          end
-
-          # @!method add_iteration(&block)
-          #   @yieldparam [Eddy::Segments::PID] pid
-          #   @return [void]
-        end
-
-        # ### Loop Summary:
-        #
-        # - Repeat: 25
-        # - Components:
-        #   - SAC
-        class SAC < Eddy::Loop::Base
-          # @param store [Eddy::Data::Store]
-          # @return [void]
-          def initialize(store)
-            super(store)
-            @repeat = 25
-            @components = [
-              Eddy::Segments::SAC,
-            ]
-          end
-
-          # @!method add_iteration(&block)
-          #   @yieldparam [Eddy::Segments::SAC] sac
-          #   @return [void]
-        end
-
-      end
-    end
-  end
-end

data/lib/definitions/transaction_sets/manual/850/loops.rb

@@ -1,58 +0,0 @@
-module Eddy
-  module TransactionSets
-    # Namespace for Transaction Set 850 and its loops.
-    module TS850
-      module Loops
-
-        # ### Loop Summary:
-        #
-        # - Repeat: 200
-        # - Components:
-        #   - N1
-        #   - N3
-        #   - N4
-        class N1 < Eddy::Loop::Base
-          # @param store [Eddy::Data::Store]
-          # @return [void]
-          def initialize(store)
-            super(store)
-            @repeat= 200
-            @components = [
-              Eddy::Segments::N1,
-              Eddy::Segments::N3,
-              Eddy::Segments::N4,
-            ]
-          end
-
-          # @!method add_iteration(&block)
-          #   @yieldparam [Eddy::Segments::N1] n1
-          #   @yieldparam [Eddy::Segments::N3] n3
-          #   @yieldparam [Eddy::Segments::N4] n4
-          #   @return [void]
-        end
-
-        # ### Loop Summary:
-        #
-        # - Repeat: 100,000
-        # - Components:
-        #   - PO1
-        class PO1 < Eddy::Loop::Base
-          # @param store [Eddy::Data::Store]
-          # @return [void]
-          def initialize(store)
-            super(store)
-            @repeat = 100_000
-            @components = [
-              Eddy::Segments::PO1,
-            ]
-          end
-
-          # @!method add_iteration(&block)
-          #   @yieldparam [Eddy::Segments::PO1] po1
-          #   @return [void]
-        end
-
-      end
-    end
-  end
-end