eddy 0.6.0 → 0.7.0

data/lib/definitions/segments/generated/n3.rb

@@ -13,9 +13,11 @@ module Eddy
         @id = "N3"
         @name = "Address Information"
         @n301 = Eddy::Elements::E166.new(ref: "N301", req: "M")
+        @n302 = Eddy::Elements::E166.new(ref: "N302", req: "O")
         super(
           store,
           @n301,
+          @n302,
         )
       end
 
@@ -32,7 +34,22 @@ module Eddy
       def N301=(arg)
         @n301.value = arg
       end
-      alias AddressInformation= N301=
+      alias AddressInformation1= N301=
+
+      # ### N302
+      #
+      # - Id: 166
+      # - Name: Address Information
+      # - Type: AN
+      # - Min/Max: 1/55
+      # - Description: Address information
+      #
+      # @param arg [String]
+      # @return [void]
+      def N302=(arg)
+        @n302.value = arg
+      end
+      alias AddressInformation2= N302=
 
     end
   end

data/lib/eddy/build/elements/elements.rb

@@ -7,7 +7,7 @@ module Eddy
   module Build
     module Elements
 
-      # Generate `Eddy::Element` classes for all data elements defined in `data/004010/elements.tsv`
+      # Generate `Eddy::Element` classes for all data elements defined in `data/elements.tsv`
       #
       # @param elements [Array<Eddy::Summary::Element>]
       # @return [void]
@@ -29,7 +29,7 @@ module Eddy
         return nil
       end
 
-      # Generate usable data from `data/004010/elements.tsv`.
+      # Generate usable data from `data/elements.tsv`.
       #
       # @return [Array<Eddy::Summary::Element>]
       def self.generate_element_data()

data/lib/eddy/build/elements/id.rb

@@ -26,7 +26,7 @@ module Eddy
       # @param id [String]
       # @return [String]
       def self.build_code_list(id)
-        file = File.join(Eddy::Util.data_dir, "004010", "code-lists", "#{id}.tsv")
+        file = File.join(Eddy::Util.data_dir, "code-lists", "#{id}.tsv")
         begin
           data = Eddy::Util.parse_tsv(file)
         rescue Errno::ENOENT

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

@@ -25,24 +25,15 @@ module Eddy
           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}"
-            end
-          end
-          return @val.ljust(self.min)
-        end
-
         # @raise [Eddy::Errors::ElementValidationError]
         # @param arg [String]
         # @return [void]
         def value=(arg)
-          if arg.nil?
+          if arg == :skip
+            @val = :skip
+            return
+          end
+          if arg.nil?()
             @val = arg
             return
           end
@@ -51,6 +42,27 @@ module Eddy
           @val = arg
         end
 
+        # @raise [Eddy::Errors::ElementNilValueError] If the element is required and no value has been set.
+        # @return [String]
+        def value()
+          return super()
+        end
+
+        # @return [String]
+        def process_value()
+          return self.class.process_value(@val, self.min, self.max)
+        end
+
+        # Left justify a string (`val`) to `min`.
+        #
+        # @param val [String] Original value.
+        # @param min [Integer] Minimum length for a valid value.
+        # @param _max [Integer] Maximum length for a valid value.
+        # @return [String]
+        def self.process_value(val, min, _max)
+          return val.ljust(min)
+        end
+
       end
     end
   end

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

@@ -30,22 +30,25 @@ module Eddy
           self.value = val
         end
 
+        # @param _arg [Object] Whatever is to be assigned to `value`
+        # @return [void]
+        def value=(_arg)
+          super()
+        end
+
         # @raise [Eddy::Errors::ElementNilValueError] If the element is required and no value has been set.
         # @return [String<Binary>]
         def value()
-          super()
-          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 super()
         end
 
-        # @param _arg [Object] Whatever is to be assigned to `value`
-        # @return [void]
-        def value=(_arg)
+        # @return [String]
+        def process_value()
+          return self.class.process_value()
+        end
+
+        # @return [String]
+        def self.process_value()
           super()
         end
 

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

@@ -2,6 +2,7 @@ module Eddy
   module Models
     module Element
       # Base class for EDI Data Element types.
+      # @abstract
       class Base
 
         # Positive number under 1688, or I01-I64
@@ -24,21 +25,47 @@ module Eddy
         # @return [String]
         attr_accessor :ref
 
-        # # @return [void]
-        # def initialize(**kwargs)
+        # @return [void]
+        def initialize()
+          @val = nil
+          @req = nil
+        end
 
-        # end
+        # @note Classes inheriting from `Eddy::Models::Element::Base` must override the method `#value=`.
+        # @return [void]
+        def value=(*)
+          raise NotImplementedError, "Classes inheriting from `Eddy::Models::Element::Base` must override the method `#value=`"
+        end
 
-        # @note Classes inheriting from `Eddy::Models::Element::Base` must define the method `value`.
+        # @note Classes inheriting from `Eddy::Models::Element::Base` must override the method `#value`.
+        # @return [Object]
+        def value()
+          if @val == :skip
+            return ""
+          elsif @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 self.process_value()
+        end
+
+        # Return a valid EDI string representation of `@value`.
+        #
+        # @note Classes inheriting from `Eddy::Models::Element::Base` must override the method `#process_value`.
         # @return [void]
-        def value(*)
-          raise NotImplementedError, "Classes inheriting from `Eddy::Models::Element::Base` must define a `value` method."
+        def process_value(*)
+          raise NotImplementedError, "Classes inheriting from `Eddy::Models::Element::Base` must override the method `#process_value`"
         end
 
-        # @note Classes inheriting from `Eddy::Models::Element::Base` must define the method `value=`.
+        # Return a valid EDI string representation of `@value`.
+        #
+        # @note Classes inheriting from `Eddy::Models::Element::Base` must override the class the method `process_value`.
         # @return [void]
-        def value=(*)
-          raise NotImplementedError, "Classes inheriting from `Eddy::Models::Element::Base` must define a `value=` method."
+        def self.process_value(*)
+          raise NotImplementedError, "Classes inheriting from `Eddy::Models::Element::Base` must override the class the method `process_value`"
         end
 
         # Indicates whether the value must be present in its segment.

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

@@ -43,28 +43,15 @@ module Eddy
           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}"
-            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?
+          if arg == :skip
+            @val = :skip
+            return
+          end
+          if arg.nil?()
             @val = arg
             return
           end
@@ -73,6 +60,28 @@ module Eddy
           @val = arg
         end
 
+        # @raise [Eddy::Errors::ElementNilValueError] If the element is required and no value has been set.
+        # @return [String]
+        def value()
+          return super()
+        end
+
+        # @return [String]
+        def process_value()
+          return self.class.process_value(@val, self.fmt)
+        end
+
+        # @param val [Time] A *UTC* formatted [Time](https://ruby-doc.org/stdlib-2.6.5/libdoc/time/rdoc/Time.html) object.
+        # @param fmt [Symbol]
+        # @return [String]
+        def self.process_value(val, fmt)
+          case 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
+
         # @param fmt [Symbol]
         # @return [void]
         def fmt=(fmt)

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

@@ -25,23 +25,14 @@ module Eddy
           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}"
-            end
-          end
-          return @val
-        end
-
         # @param arg [String]
         # return [void]
         def value=(arg)
-          if arg.nil?
+          if arg == :skip
+            @val = :skip
+            return
+          end
+          if arg.nil?()
             @val = arg
             return
           end
@@ -49,6 +40,23 @@ module Eddy
           @val = arg
         end
 
+        # @raise [Eddy::Errors::ElementNilValueError] If the element is required and no value has been set.
+        # @return [String]
+        def value()
+          return super()
+        end
+
+        # @return [String]
+        def process_value()
+          return self.class.process_value(@val)
+        end
+
+        # @param val [String] Original value.
+        # @return [String]
+        def self.process_value(val)
+          return val
+        end
+
         # @return [Array<String>]
         def code_list()
           raise NotImplementedError, "Each ID element must define its own code_list"

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

@@ -31,24 +31,15 @@ module Eddy
           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}"
-            end
-          end
-          return self.process_value()
-        end
-
         # @raise [Eddy::Errors::ElementValidationError]
         # @param arg [Numeric]
         # @return [void]
         def value=(arg)
-          if arg.nil?
+          if arg == :skip
+            @val = :skip
+            return
+          end
+          if arg.nil?()
             @val = nil
             return
           end
@@ -56,6 +47,12 @@ module Eddy
           @val = arg
         end
 
+        # @raise [Eddy::Errors::ElementNilValueError] If the element is required and no value has been set.
+        # @return [String]
+        def value()
+          return super()
+        end
+
         # @return [String]
         def process_value()
           return self.class.process_value(
@@ -82,7 +79,6 @@ module Eddy
             else
               return sprintf("%0#{min}d", val.round(2))
             end
-            # return sprintf("%0#{min}d", val)
           when Float
             return (val * (10.0**decimals)).round.to_s
           else

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

@@ -27,23 +27,15 @@ module Eddy
           self.value = val
         end
 
-        # @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 process(@val)
-        end
-
         # @param arg [Numeric]
         # @raise [ArgumentError] Unless passed a Numeric value.
         # @return [void]
         def value=(arg)
-          if arg.nil?
+          if arg == :skip
+            @val = :skip
+            return
+          end
+          if arg.nil?()
             @val = arg
             return
           end
@@ -51,7 +43,17 @@ module Eddy
           @val = arg
         end
 
-        # Stringify a float value and trim to the element's `max` attribute.
+        # @return [String]
+        def value()
+          return super()
+        end
+
+        # @return [String]
+        def process_value()
+          return self.class.process_value(@val, self.max)
+        end
+
+        # Stringify a numeric value and trim it to `max`.
         #
         # TODO: Use `sprintf` here?
         #
@@ -61,13 +63,14 @@ module Eddy
         # - [Numbers and Class Hierarchy in Ruby (Medium)](https://medium.com/rubyinside/numbers-and-class-hierarchy-in-ruby-8c93c4749316)
         #
         # @param val [Numeric]
+        # @param max [Integer]
         # @return [String]
-        def process(val)
+        def self.process_value(val, max)
           case val
           when Integer
-            return val.to_s.slice(0..self.max)
+            return val.to_s.slice(0..max)
           when Float
-            return val.to_s.slice(0..(self.max + 1))
+            return val.to_s.slice(0..(max + 1))
           when Complex
             # TODO: Handle case
             raise NotImplementedError

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

@@ -52,30 +52,15 @@ module Eddy
           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}"
-            end
-          end
-          case self.fmt
-          when :hhmm then return Eddy::Util::Time.hhmm(@val)
-          when :hhmmss then return Eddy::Util::Time.hhmmss(@val)
-          when :hhmmssd then return Eddy::Util::Time.hhmmssd(@val)
-          when :hhmmssdd then return Eddy::Util::Time.hhmmssdd(@val)
-          else raise Eddy::Errors::Error, "invalid fmt value for TM object"
-          end
-        end
-
         # @raise [ElementValidationError] Unless passed a *UTC* formatted Time object.
         # @param arg [Time] A *UTC* formatted `Time` object.
         # @return [void]
         def value=(arg)
-          if arg.nil?
+          if arg == :skip
+            @val = :skip
+            return
+          end
+          if arg.nil?()
             @val = arg
             return
           end
@@ -84,6 +69,30 @@ module Eddy
           @val = arg
         end
 
+        # @raise [Eddy::Errors::ElementNilValueError] If the element is required and no value has been set.
+        # @return [String]
+        def value()
+          return super()
+        end
+
+        # @return [String]
+        def process_value()
+          return self.class.process_value(@val, self.fmt)
+        end
+
+        # @param val [Time] A *UTC* formatted [Time](https://ruby-doc.org/stdlib-2.6.5/libdoc/time/rdoc/Time.html) object.
+        # @param fmt [Symbol]
+        # @return [String]
+        def self.process_value(val, fmt)
+          case fmt
+          when :hhmm then return Eddy::Util::Time.hhmm(val)
+          when :hhmmss then return Eddy::Util::Time.hhmmss(val)
+          when :hhmmssd then return Eddy::Util::Time.hhmmssd(val)
+          when :hhmmssdd then return Eddy::Util::Time.hhmmssdd(val)
+          else raise Eddy::Errors::Error, "invalid fmt value for TM object"
+          end
+        end
+
         # @param fmt [Symbol]
         # @return [void]
         def fmt=(fmt)

data/lib/eddy/models/interchange.rb

@@ -21,6 +21,8 @@ module Eddy
         return itch
       end
 
+      # @yieldparam [Eddy::Segments::ISA] isa
+      # @yieldparam [Eddy::Segments::IEA] iea
       # @return [String]
       def render()
         ctrl_num = Eddy::Data.new_interchange_control_number()

data/lib/eddy/summary/segment.rb

@@ -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

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