eddy 0.8.2 → 0.9.2

data/lib/eddy/build/transaction_set_builder.rb

@@ -58,7 +58,7 @@ module Eddy
       def build_loops()
         FileUtils.mkdir_p(File.join(self.folder, "loops"))
         self.summary.unique_loops.each do |looop|
-          File.open(File.join(self.folder, "loops", "#{looop.normalized_name}.rb"), "a") do |f|
+          File.open(File.join(self.folder, "loops", "#{looop.class_name}.rb"), "a") do |f|
             f.write(Eddy::Build::Loop.render(looop, self.normalized_name) + "\n")
           end
         end

data/lib/eddy/config.rb

@@ -41,25 +41,4 @@ module Eddy
     end
 
   end
-
-  # Configuration for Eddy
-  #
-  # @return [Eddy::Config]
-  def self.config()
-    @config ||= Config.new
-  end
-
-  # Modify Eddy's current config
-  #
-  # @example
-  #   Eddy.configure do |config|
-  #     config.persistence_method = :file
-  #   end
-  #
-  # @yieldparam [Eddy::Config] config current Eddy config
-  # @return [void]
-  def self.configure()
-    yield self.config
-  end
-
 end

data/lib/eddy/data.rb

@@ -3,36 +3,8 @@ require "eddy/data/persistence/base"
 require "eddy/data/persistence/memory"
 
 module Eddy
-
-  # Persistent data used by Eddy.
-  #
-  # @return [Eddy::Data::Persistence::Base]
-  def self.data
-    return @data if defined?(@data) && !@data.nil?
-    case Eddy.config.persistence_method
-    when :memory then @data = Eddy::Data::Persistence::Memory.new()
-    when :file   then raise NotImplementedError
-    when :active_record
-      if defined?(Rails) && defined?(Eddy::Rails)
-        @data = Eddy::Data::Persistence::ActiveRecord.new()
-      else
-        raise Eddy::Errors::Error, "ActiveRecord persistence method can currently only be used with Ruby on Rails"
-      end
-    else raise Eddy::Errors::Error, "Unsupported persistence method: #{Eddy.config.persistence_method}"
-    end
-    return @data
-  end
-
-  # Set `@data` to `nil` so that a new persistence_method can be set up.
-  #
-  # @return [void]
-  def self.clear_data()
-    @data = nil
-  end
-
   # Code for storing & generating data used by Eddy when generating EDI documents.
   module Data
-
     # Return a new, unique number.
     #
     # @return [Integer]
@@ -53,17 +25,5 @@ module Eddy
       Eddy.data.add_transaction_set_control_number(transaction_set_id, new_ctrl_num)
       return new_ctrl_num
     end
-
-    # Return a new, unique number.
-    #
-    # @param functional_group [String]
-    # @return [Integer]
-    def self.new_functional_group_control_number(functional_group)
-      existing = Eddy.data.functional_group_control_numbers(functional_group)
-      new_ctrl_num = Eddy::Util.new_number(existing)
-      Eddy.data.add_functional_group_control_number(functional_group, new_ctrl_num)
-      return new_ctrl_num
-    end
-
   end
 end

data/lib/eddy/data/persistence/base.rb

@@ -4,14 +4,15 @@ module Eddy
       # Base class for data persistence wrappers.
       class Base
 
-        # @return [Array<Integer>]
-        def interchange_control_numbers()
+        # Clear persisted data.
+        #
+        # @return [void]
+        def reset()
           raise NotImplementedError
         end
 
-        # @param _functional_group [String]
         # @return [Array<Integer>]
-        def functional_group_control_numbers(_functional_group)
+        def interchange_control_numbers()
           raise NotImplementedError
         end
 
@@ -27,13 +28,6 @@ module Eddy
           raise NotImplementedError
         end
 
-        # @param _functional_group [String]
-        # @param _new_ctrl_num [Integer]
-        # @return [Array<Integer>]
-        def add_functional_group_control_number(_functional_group, _new_ctrl_num)
-          raise NotImplementedError
-        end
-
         # @param _transaction_set_id [String]
         # @param _new_ctrl_num [Integer]
         # @return [Array<Integer>]

data/lib/eddy/data/persistence/memory.rb

@@ -8,23 +8,23 @@ module Eddy
         def initialize()
           @data = {
             interchange_control_numbers: [],
-            functional_group_control_numbers: {},
             transaction_set_control_numbers: {},
           }
         end
 
-        # @return [Array<Integer>]
-        def interchange_control_numbers()
-          return @data[:interchange_control_numbers]
+        # Clear persisted data.
+        #
+        # @return [void]
+        def reset()
+          @data = {
+            interchange_control_numbers: [],
+            transaction_set_control_numbers: {},
+          }
         end
 
-        # @param functional_group [String]
         # @return [Array<Integer>]
-        def functional_group_control_numbers(functional_group)
-          unless @data[:functional_group_control_numbers].key?(functional_group)
-            @data[:functional_group_control_numbers][functional_group] = []
-          end
-          return @data[:functional_group_control_numbers][functional_group]
+        def interchange_control_numbers()
+          return @data[:interchange_control_numbers]
         end
 
         # @param transaction_set_id [String]
@@ -37,26 +37,18 @@ module Eddy
         end
 
         # @param new_ctrl_num [Integer]
-        # @return [void]
+        # @return [Array<Integer>]
         def add_interchange_control_number(new_ctrl_num)
           self.interchange_control_numbers.append(new_ctrl_num)
-          return nil
-        end
-
-        # @param functional_group [String]
-        # @param new_ctrl_num [Integer]
-        # @return [void]
-        def add_functional_group_control_number(functional_group, new_ctrl_num)
-          self.functional_group_control_numbers(functional_group).append(new_ctrl_num)
-          return nil
+          return self.interchange_control_numbers()
         end
 
         # @param transaction_set_id [String]
         # @param new_ctrl_num [Integer]
-        # @return [void]
+        # @return [Array<Integer>]
         def add_transaction_set_control_number(transaction_set_id, new_ctrl_num)
           self.transaction_set_control_numbers(transaction_set_id).append(new_ctrl_num)
-          return nil
+          return self.transaction_set_control_numbers(transaction_set_id)
         end
 
       end

data/lib/eddy/errors.rb

@@ -4,6 +4,18 @@ module Eddy
     # Exceptions raised by Eddy inherit from Error.
     class Error < StandardError; end
 
+    # Exception raised when an issue occurs while generating code.
+    class BuildError < Error; end
+
+    # Exception raised from a `render` method.
+    class RenderError < Error; end
+
+    # Exception raised when a definition file can't be found.
+    class MissingDefinitionError < Error; end
+
+    # Exception raised when a definition file can't be found.
+    class ParseError < Error; end
+
     # @!group Element Validation Errors
 
     # Exception raised by descendents of {Eddy::Models::Element::Base}.
@@ -99,15 +111,7 @@ module Eddy
       end
     end
 
-    # @!endgroup Element Validation Errors
+    # @!endgroup
 
-    # Exception raised when an issue occurs while generating code.
-    class BuildError < Error; end
-
-    # Exception raised from a `render` method.
-    class RenderError < Error; end
-
-    # Exception raised when a definition file can't be found.
-    class MissingDefinitionError < Error; end
   end
 end

data/lib/eddy/models/element/composite.rb

@@ -2,6 +2,8 @@ module Eddy
   module Models
     module Element
       # - [References to Component Data Elements - X12 RFI](http://www.x12.org/rfis/References%20to%20Component%20Data%20Elements.pdf)
+      # - [What’s the Repetition Separator Character in 5010 X12?](http://www.rdpcrystal.com/whats-the-repetition-separator-character-in-5010-x12/)
+      # - [Delimiters in data fields (RFI 1815)](http://rfi.x12.org/Request/Details/1815?stateViewModel=WPC.RFI.Models.ViewModels.RequestViewModel)
       class Composite; end
     end
   end

data/lib/eddy/models/element/id.rb

@@ -1,7 +1,7 @@
 module Eddy
   module Models
     module Element
-      # Identifier (works with a code list specified by the dictionary).
+      # Identifier. Works with a code list specified by the dictionary.
       class ID < Base
 
         # @param min [Integer]

data/lib/eddy/models/element/r.rb

@@ -70,6 +70,7 @@ module Eddy
           when Integer
             return val.to_s.slice(0..max)
           when Float
+            # FIXME: This isn't correct.
             return val.to_s.slice(0..(max + 1))
           when Complex
             # TODO: Handle case

data/lib/eddy/models/functional_group.rb

@@ -16,17 +16,18 @@ module Eddy
       attr_accessor :transaction_sets
 
       # @param store [Eddy::Data::Store]
+      # @param control_number [Integer]
       # @param transaction_sets [Eddy::Models::TransactionSet]
       # @return [void]
-      def initialize(store, *transaction_sets)
+      def initialize(store, control_number, *transaction_sets)
         self.store = store
+        self.control_number = control_number
         transaction_sets.flatten!
         self.transaction_sets = transaction_sets || []
         if self.transaction_sets.length == 0
           raise ArgumentError, "At least one transaction set is required to create a functional group"
         end
         @id = self.transaction_sets.first.functional_group
-        self.control_number = Eddy::Data.new_functional_group_control_number(@id)
       end
 
       # @return [Array<#render>]

data/lib/eddy/models/interchange.rb

@@ -34,7 +34,7 @@ module Eddy
         isa = Eddy::Segments::ISA.new(self.store, self.control_number)
         iea = Eddy::Segments::IEA.new(self.store, self.control_number, f_groups.length)
         yield(isa, iea) if block_given?
-        return [isa, f_groups, iea].flatten.map(&:render).join(sep) + sep
+        return ([isa, f_groups, iea].flatten.map(&:render).join(sep) + sep).rstrip()
       end
 
       # @return [Array<Eddy::Models::FunctionalGroup>]
@@ -44,7 +44,11 @@ module Eddy
           sorted_sets[ts.functional_group] ||= []
           sorted_sets[ts.functional_group] << ts
         end
-        return sorted_sets.map { |_, value| Eddy::Models::FunctionalGroup.new(self.store, *value) }
+        i = 0
+        return sorted_sets.map do |_, value|
+          i += 1
+          Eddy::Models::FunctionalGroup.new(self.store, i, *value)
+        end
       end
 
       private

data/lib/eddy/models/transaction_set.rb

@@ -82,7 +82,7 @@ module Eddy
       # @return [String]
       def render(s_sep = self.store.segment_separator)
         add_envelope()
-        return self.all_components.map { |s| s.render(self.store.element_separator) }.compact.join(s_sep)
+        return self.all_components.map { |s| s.render(self.store.element_separator) }.compact.join(s_sep).rstrip()
       end
 
       # Return the count of Segments in the Transaction Set where `skip` is false,

data/lib/eddy/parse.rb

@@ -1,58 +1,6 @@
-module Eddy
-  module Parse
-    # Wrapper around an interchange file or string.
-    class Interchange
-
-      # Raw content of the interchange.
-      # @return [String]
-      attr_accessor :document
-      # Component Element Separator
-      # @return [String] (">")
-      attr_accessor :component_separator
-      # @return [String] ("~")
-      attr_accessor :segment_separator
-      # Data Element Separator
-      # @return [String] ("\*")
-      attr_accessor :element_separator
-
-      # @param doc [String] EDI document.
-      # @param component_separator [String] (">")
-      # @param segment_separator [String] ("~")
-      # @param element_separator [String] ("\*")
-      # @return [void]
-      def initialize(doc, component_separator: ">", segment_separator: "~", element_separator: "*")
-        self.document = doc
-        self.component_separator = component_separator
-        self.segment_separator = segment_separator
-        self.element_separator = element_separator
-      end
-
-      # @param path [String]
-      # @return [self]
-      def self.from_file(path, **kwargs)
-        return self.new(File.read(path), **kwargs)
-      end
+require "eddy/parse/interchange"
 
-      # @return [Array<Hash>]
-      def parse()
-        doc = self.document.gsub(/\n/, "")
-        segments = doc.split(self.segment_separator)
-        segments.map { |seg| self.parse_segment(seg) }
-      end
-
-      # @param seg [String]
-      # @return [Hash]
-      def parse_segment(seg)
-        name, *elements = seg.split(self.element_separator)
-        res = { name: name, elements: {} }
-        elements.each_with_index do |value, index|
-          next if value == ""
-          key = sprintf("%s%02d", name, index + 1)
-          res[:elements][key] = value
-        end
-        return res
-      end
-
-    end
-  end
+module Eddy
+  # Code for reading EDI documents.
+  module Parse; end
 end

data/lib/eddy/parse/interchange.rb

@@ -0,0 +1,58 @@
+module Eddy
+  module Parse
+    # Wrapper around an interchange file or string.
+    class Interchange
+
+      # Raw content of the interchange.
+      # @return [String]
+      attr_accessor :document
+      # Component Element Separator
+      # @return [String] (">")
+      attr_accessor :component_separator
+      # @return [String] ("~")
+      attr_accessor :segment_separator
+      # Data Element Separator
+      # @return [String] ("\*")
+      attr_accessor :element_separator
+
+      # @param doc [String] EDI document.
+      # @param component_separator [String] (">")
+      # @param segment_separator [String] ("~")
+      # @param element_separator [String] ("\*")
+      # @return [void]
+      def initialize(doc, component_separator: ">", segment_separator: "~", element_separator: "*")
+        self.document = doc
+        self.component_separator = component_separator
+        self.segment_separator = segment_separator
+        self.element_separator = element_separator
+      end
+
+      # @param path [String]
+      # @return [self]
+      def self.from_file(path, **kwargs)
+        return self.new(File.read(path), **kwargs)
+      end
+
+      # @return [Array<Hash>]
+      def parse()
+        doc = self.document.gsub(/\n/, "")
+        segments = doc.split(self.segment_separator)
+        segments.map { |seg| self.parse_segment(seg) }
+      end
+
+      # @param seg [String]
+      # @return [Hash]
+      def parse_segment(seg)
+        name, *elements = seg.split(self.element_separator)
+        res = { name: name, elements: {} }
+        elements.each_with_index do |value, index|
+          next if value == ""
+          key = sprintf("%s%02d", name, index + 1)
+          res[:elements][key] = value
+        end
+        return res
+      end
+
+    end
+  end
+end

data/lib/eddy/summary/loop.rb

@@ -108,7 +108,7 @@ module Eddy
         end
       end
 
-      # Return `id` with the prefixes `"l_"` or `"hl_" removed.
+      # Return `id` with the prefixes `l_` or `"hl_"` removed.
       #
       # @return [String]
       def class_name()

data/lib/eddy/summary/segment.rb

@@ -113,7 +113,8 @@ module Eddy
 
       # Helper function to simplify conditional logic in {Eddy::Build}.
       #
-      # @see {Eddy::Summary::Loop#treat_as_segment?}
+      # See `Eddy::Summary::Loop#treat_as_segment?`
+      #
       # @return [Boolean] (true) Always returns true.
       def build_as_segment?()
         return true