eddy 0.5.1 → 0.6.0

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

@@ -1,116 +1,118 @@
 module Eddy
-  module Element
-    # Base class for EDI Data Element types.
-    class Base
+  module Models
+    module Element
+      # Base class for EDI Data Element types.
+      class Base
 
-      # Positive number under 1688, or I01-I64
-      # @return [String]
-      attr_reader :id
-      # @return [String]
-      attr_reader :name
-      # @return [String]
-      attr_reader :description
-      # One of: AN, B, DT, ID, N, R, or TM
-      # @return [String]
-      attr_reader :type
-      # Minimum length for a valid value
-      # @return [Integer]
-      attr_reader :min
-      # Maximum length for a valid value
-      # @return [Integer]
-      attr_reader :max
-      # String used to identify a data element within a Segment.
-      # @return [String]
-      attr_accessor :ref
+        # Positive number under 1688, or I01-I64
+        # @return [String]
+        attr_reader :id
+        # @return [String]
+        attr_reader :name
+        # @return [String]
+        attr_reader :description
+        # One of: AN, B, DT, ID, N, R, or TM
+        # @return [String]
+        attr_reader :type
+        # Minimum length for a valid value
+        # @return [Integer]
+        attr_reader :min
+        # Maximum length for a valid value
+        # @return [Integer]
+        attr_reader :max
+        # String used to identify a data element within a Segment.
+        # @return [String]
+        attr_accessor :ref
 
-      # # @return [void]
-      # def initialize(**kwargs)
+        # # @return [void]
+        # def initialize(**kwargs)
 
-      # end
+        # end
 
-      # @note Classes inheriting from `Eddy::Element::Base` must define the method `value`.
-      # @return [void]
-      def value(*)
-        raise NotImplementedError, "Classes inheriting from `Eddy::Element::Base` must define a `value` method."
-      end
-
-      # @note Classes inheriting from `Eddy::Element::Base` must define the method `value=`.
-      # @return [void]
-      def value=(*)
-        raise NotImplementedError, "Classes inheriting from `Eddy::Element::Base` must define a `value=` method."
-      end
+        # @note Classes inheriting from `Eddy::Models::Element::Base` must define the method `value`.
+        # @return [void]
+        def value(*)
+          raise NotImplementedError, "Classes inheriting from `Eddy::Models::Element::Base` must define a `value` method."
+        end
 
-      # Indicates whether the value must be present in its segment.
-      #
-      # | code  | description |  official  |
-      # | ----- | ----------- | ---------- |
-      # | **M** | Mandatory   | yes        |
-      # | **O** | Optional    | yes        |
-      # | **C** | Conditional | yes        |
-      # | F     | Floating    | deprecated |
-      # | R     | Required    | no         |
-      # | S     | Situational | no         |
-      # | A     | Advised     | no         |
-      # | N     | Not Advised | no         |
-      # | N     | Not Used    | no         |
-      # | X     | Not Used    | no         |
-      # | X     | Conditional | no         |
-      #
-      # See:
-      #
-      # - [The Data Segment - EDIdEv](https://secure.edidev.net/edidev-ca/help/Using/Using_EDI/Using_AscX12/DataStructures/DataSegment/DataSegment.htm)
-      # - [Required vs Mandatory in Code Descriptions - X12 RFI](http://www.x12.org/rfis/Required%20vs%20Mandatory%20in%20Code%20Descriptions.pdf)
-      #
-      # @return [String]
-      def req
-        return @req
-      end
+        # @note Classes inheriting from `Eddy::Models::Element::Base` must define the method `value=`.
+        # @return [void]
+        def value=(*)
+          raise NotImplementedError, "Classes inheriting from `Eddy::Models::Element::Base` must define a `value=` method."
+        end
 
-      # (see #req)
-      #
-      # @param req [String, nil]
-      # @return [void]
-      def req=(req)
-        if req.nil?
-          @req = "O"
-          return
+        # Indicates whether the value must be present in its segment.
+        #
+        # | code  | description |  official  |
+        # | ----- | ----------- | ---------- |
+        # | **M** | Mandatory   | yes        |
+        # | **O** | Optional    | yes        |
+        # | **C** | Conditional | yes        |
+        # | F     | Floating    | deprecated |
+        # | R     | Required    | no         |
+        # | S     | Situational | no         |
+        # | A     | Advised     | no         |
+        # | N     | Not Advised | no         |
+        # | N     | Not Used    | no         |
+        # | X     | Not Used    | no         |
+        # | X     | Conditional | no         |
+        #
+        # See:
+        #
+        # - [The Data Segment - EDIdEv](https://secure.edidev.net/edidev-ca/help/Using/Using_EDI/Using_AscX12/DataStructures/DataSegment/DataSegment.htm)
+        # - [Required vs Mandatory in Code Descriptions - X12 RFI](http://www.x12.org/rfis/Required%20vs%20Mandatory%20in%20Code%20Descriptions.pdf)
+        #
+        # @return [String]
+        def req
+          return @req
         end
-        raise ArgumentError, req.to_s unless req.is_a?(String)
-        case req.upcase
-        when "M", "R" then @req = "M"
-        when "O"      then @req = "O"
-        when "C", "X" then @req = "C"
-        when "F" then raise Eddy::Errors::Error, "Req value 'F' not supported"
-        else raise Eddy::Errors::Error, "Invalid argument for `req=`: #{req}"
+
+        # (see #req)
+        #
+        # @param req [String, nil]
+        # @return [void]
+        def req=(req)
+          if req.nil?
+            @req = "O"
+            return
+          end
+          raise ArgumentError, req.to_s unless req.is_a?(String)
+          case req.upcase
+          when "M", "R" then @req = "M"
+          when "O"      then @req = "O"
+          when "C", "X" then @req = "C"
+          when "F" then raise Eddy::Errors::Error, "Req value 'F' not supported"
+          else raise Eddy::Errors::Error, "Invalid argument for `req=`: #{req}"
+          end
         end
-      end
 
-      # Generate a description to use as a doc comment for an element.
-      #
-      # @param header [Boolean] (true)
-      # @return [Hash]
-      def doc_comment(header: true)
-        if header
-          return <<~END.strip
-            ### Element Summary:
+        # Generate a description to use as a doc comment for an element.
+        #
+        # @param header [Boolean] (true)
+        # @return [Hash]
+        def doc_comment(header: true)
+          if header
+            return <<~END.strip
+              ### Element Summary:
 
-            - Id: #{self.id}
-            - Name: #{self.name}
-            - Type: #{self.type}
-            - Min/Max: #{self.min}/#{self.max}
-            - Description: #{self.description}
-          END
-        else
-          return <<~END.strip
-            - Id: #{self.id}
-            - Name: #{self.name}
-            - Type: #{self.type}
-            - Min/Max: #{self.min}/#{self.max}
-            - Description: #{self.description}
-          END
+              - Id: #{self.id}
+              - Name: #{self.name}
+              - Type: #{self.type}
+              - Min/Max: #{self.min}/#{self.max}
+              - Description: #{self.description}
+            END
+          else
+            return <<~END.strip
+              - Id: #{self.id}
+              - Name: #{self.name}
+              - Type: #{self.type}
+              - Min/Max: #{self.min}/#{self.max}
+              - Description: #{self.description}
+            END
+          end
         end
-      end
 
+      end
     end
   end
 end

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

@@ -1,6 +1,8 @@
 module Eddy
-  module Element
-    # - [References to Component Data Elements - X12 RFI](http://www.x12.org/rfis/References%20to%20Component%20Data%20Elements.pdf)
-    class Composite; end
+  module Models
+    module Element
+      # - [References to Component Data Elements - X12 RFI](http://www.x12.org/rfis/References%20to%20Component%20Data%20Elements.pdf)
+      class Composite; end
+    end
   end
 end

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

@@ -1,100 +1,102 @@
 require "time"
 
 module Eddy
-  module Element
-    # Date in `YYMMDD` or `CCYYMMDD` format based on EDI version being used (DLMS Baseline is 004010)
-    #
-    # Values for this type are generated from a *UTC* formatted [Time][time] object.
-    #
-    # [time]: https://ruby-doc.org/stdlib-2.6.5/libdoc/time/rdoc/Time.html
-    class DT < Base
+  module Models
+    module Element
+      # Date in `YYMMDD` or `CCYYMMDD` format based on EDI version being used (DLMS Baseline is 004010)
+      #
+      # Values for this type are generated from a *UTC* formatted [Time][time] object.
+      #
+      # [time]: https://ruby-doc.org/stdlib-2.6.5/libdoc/time/rdoc/Time.html
+      class DT < Base
 
-      # Format for the date. Valid values: `:yymmdd` or `:ccyymmdd`
-      # @return [Symbol<:yymmdd, :ccyymmdd>]
-      attr_reader :fmt
+        # Format for the date. Valid values: `:yymmdd` or `:ccyymmdd`
+        # @return [Symbol<:yymmdd, :ccyymmdd>]
+        attr_reader :fmt
 
-      # @param min [Integer] (nil)
-      # @param max [Integer] (nil)
-      # @param req [String] (nil)
-      # @param ref [String] (nil)
-      # @param val [Time] (nil) A *UTC* formatted Time object.
-      # @param fmt [Symbol] (nil) Format for the date. Valid values: `:yymmdd` or `:ccyymmdd`.
-      # @return [void]
-      def initialize(
-        min: nil,
-        max: nil,
-        req: nil,
-        ref: nil,
-        val: nil,
-        fmt: nil
-      )
-        @type = "DT"
-        @min = min
-        @max = max
-        self.req = req
-        self.ref = ref
-        if fmt.nil?
-          raise ArgumentError, "DT elements require either a `fmt` value, or `min` and `max` values." if min.nil? || max.nil?
-          @fmt = determine_format()
-        else
-          self.fmt = fmt
+        # @param min [Integer] (nil)
+        # @param max [Integer] (nil)
+        # @param req [String] (nil)
+        # @param ref [String] (nil)
+        # @param val [Time] (nil) A *UTC* formatted Time object.
+        # @param fmt [Symbol] (nil) Format for the date. Valid values: `:yymmdd` or `:ccyymmdd`.
+        # @return [void]
+        def initialize(
+          min: nil,
+          max: nil,
+          req: nil,
+          ref: nil,
+          val: nil,
+          fmt: nil
+        )
+          @type = "DT"
+          @min = min
+          @max = max
+          self.req = req
+          self.ref = ref
+          if fmt.nil?
+            raise ArgumentError, "DT elements require either a `fmt` value, or `min` and `max` values." if min.nil? || max.nil?
+            @fmt = determine_format()
+          else
+            self.fmt = fmt
+          end
+          self.value = val
         end
-        self.value = val
-      end
 
-      # @raise [Eddy::Errors::ElementNilValueError] If the element is required and no value has been set.
-      # @return [String]
-      def value()
-        if @val.nil?
-          case self.req
-          when "M"      then raise Eddy::Errors::ElementNilValueError.new(element: self)
-          when "O", "C" then return ""
-          else raise Eddy::Errors::Error, "Invalid req value: #{self.req}"
+        # @raise [Eddy::Errors::ElementNilValueError] If the element is required and no value has been set.
+        # @return [String]
+        def value()
+          if @val.nil?
+            case self.req
+            when "M"      then raise Eddy::Errors::ElementNilValueError.new(element: self)
+            when "O", "C" then return ""
+            else raise Eddy::Errors::Error, "Invalid req value: #{self.req}"
+            end
+          end
+          case self.fmt
+          when :yymmdd then return Eddy::Util::Time.yymmdd(@val)
+          when :ccyymmdd then return Eddy::Util::Time.ccyymmdd(@val)
+          else raise Eddy::Errors::Error "invalid fmt value for DT object"
           end
         end
-        case self.fmt
-        when :yymmdd then return Eddy::Util::Time.yymmdd(@val)
-        when :ccyymmdd then return Eddy::Util::Time.ccyymmdd(@val)
-        else raise Eddy::Errors::Error "invalid fmt value for DT object"
-        end
-      end
 
-      # @raise [ElementValidationError] Unless passed a *UTC* formatted `Time` object.
-      # @param arg [Time] A *UTC* formatted [Time](https://ruby-doc.org/stdlib-2.6.5/libdoc/time/rdoc/Time.html) object.
-      # @return [void]
-      def value=(arg)
-        if arg.nil?
+        # @raise [ElementValidationError] Unless passed a *UTC* formatted `Time` object.
+        # @param arg [Time] A *UTC* formatted [Time](https://ruby-doc.org/stdlib-2.6.5/libdoc/time/rdoc/Time.html) object.
+        # @return [void]
+        def value=(arg)
+          if arg.nil?
+            @val = arg
+            return
+          end
+          raise Eddy::Errors::TypeValidationError.new(element: self, arg: arg) unless arg.is_a?(Time)
+          raise Eddy::Errors::ElementValidationError.new("Argument passed is not in UTC format", element: self) unless arg.utc?()
           @val = arg
-          return
         end
-        raise Eddy::Errors::TypeValidationError.new(element: self, arg: arg) unless arg.is_a?(Time)
-        raise Eddy::Errors::ElementValidationError.new("Argument passed is not in UTC format", element: self) unless arg.utc?()
-        @val = arg
-      end
 
-      # @param fmt [Symbol]
-      # @return [void]
-      def fmt=(fmt)
-        return if fmt.nil?
-        fmt = fmt.to_sym.downcase
-        raise ArgumentError, "Invalid fmt for DT value: #{fmt}" unless accepted_formats.include?(fmt)
-        @fmt = fmt
-      end
+        # @param fmt [Symbol]
+        # @return [void]
+        def fmt=(fmt)
+          return if fmt.nil?
+          fmt = fmt.to_sym.downcase
+          raise ArgumentError, "Invalid fmt for DT value: #{fmt}" unless accepted_formats.include?(fmt)
+          @fmt = fmt
+        end
 
-      # @return [Array<Symbol>]
-      def accepted_formats()
-        return [:yymmdd, :ccyymmdd]
-      end
+        # @return [Array<Symbol>]
+        def accepted_formats()
+          return [:yymmdd, :ccyymmdd]
+        end
 
-      # @return [Symbol]
-      def determine_format()
-        case self.max
-        when 6 then return :yymmdd
-        when 8 then return :ccyymmdd
-        else raise Eddy::Errors::Error, "unable to determine format for dt element"
+        # @return [Symbol]
+        def determine_format()
+          case self.max
+          when 6 then return :yymmdd
+          when 8 then return :ccyymmdd
+          else raise Eddy::Errors::Error, "unable to determine format for dt element"
+          end
         end
-      end
 
+      end
     end
   end
 end

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

@@ -1,58 +1,60 @@
 module Eddy
-  module Element
-    # Identifier (works with a code list specified by the dictionary).
-    class ID < Base
+  module Models
+    module Element
+      # Identifier (works with a code list specified by the dictionary).
+      class ID < Base
 
-      # @param min [Integer]
-      # @param max [Integer]
-      # @param req [String] (nil)
-      # @param ref [String] (nil)
-      # @param val [String] (nil)
-      # @return [void]
-      def initialize(
-        min:,
-        max:,
-        req: nil,
-        ref: nil,
-        val: nil
-      )
-        @type = "ID"
-        @min = min
-        @max = max
-        self.req = req
-        self.ref = ref
-        self.value = val
-      end
+        # @param min [Integer]
+        # @param max [Integer]
+        # @param req [String] (nil)
+        # @param ref [String] (nil)
+        # @param val [String] (nil)
+        # @return [void]
+        def initialize(
+          min:,
+          max:,
+          req: nil,
+          ref: nil,
+          val: nil
+        )
+          @type = "ID"
+          @min = min
+          @max = max
+          self.req = req
+          self.ref = ref
+          self.value = val
+        end
 
-      # @raise [Eddy::Errors::ElementNilValueError] If the element is required and no value has been set.
-      # @return [String]
-      def value()
-        if @val.nil?
-          case self.req
-          when "M"      then raise Eddy::Errors::ElementNilValueError.new(element: self)
-          when "O", "C" then return ""
-          else raise Eddy::Errors::Error, "Invalid req value: #{self.req}"
+        # @raise [Eddy::Errors::ElementNilValueError] If the element is required and no value has been set.
+        # @return [String]
+        def value()
+          if @val.nil?
+            case self.req
+            when "M"      then raise Eddy::Errors::ElementNilValueError.new(element: self)
+            when "O", "C" then return ""
+            else raise Eddy::Errors::Error, "Invalid req value: #{self.req}"
+            end
           end
+          return @val
         end
-        return @val
-      end
 
-      # @param arg [String]
-      # return [void]
-      def value=(arg)
-        if arg.nil?
+        # @param arg [String]
+        # return [void]
+        def value=(arg)
+          if arg.nil?
+            @val = arg
+            return
+          end
+          raise Eddy::Errors::ElementValidationError.new("Value not present in code list: #{arg}", element: self) unless self.code_list().include?(arg)
           @val = arg
-          return
         end
-        raise Eddy::Errors::ElementValidationError.new("Value not present in code list: #{arg}", element: self) unless self.code_list().include?(arg)
-        @val = arg
-      end
 
-      # @return [Array<String>]
-      def code_list()
-        raise NotImplementedError, "Each ID element must define its own code_list"
-      end
+        # @return [Array<String>]
+        def code_list()
+          raise NotImplementedError, "Each ID element must define its own code_list"
+        end
 
+      end
     end
   end
 end