eddy 0.1.0

data/lib/eddy/build/segments.rb

@@ -0,0 +1,25 @@
+module Eddy
+  module Build
+
+    segment_file = File.join(Eddy.data_dir, "004010", "segments.tsv")
+    segment_data = Eddy.parse_tsv(segment_file)
+
+    headers = [
+      "Ref",
+      "Id",
+      "ElementName",
+      "Description",
+      "Req",
+      "Type",
+      "Min",
+      "Max",
+      "Usage",
+      "Default",
+    ].join("\t")
+
+    segment_data.each do |segment|
+      File.open("tmp/segments/#{segment[:id]}.tsv", "a") { |f| f.write(headers) }
+    end
+
+  end
+end

data/lib/eddy/definitions/manual/elements/109.dt.pickup_date.rb

@@ -0,0 +1,20 @@
+module Eddy
+  module Elements
+    # - Id: 109
+    # - Name: Pick-up Date
+    # - Type: DT (CCYYMMDD)
+    # - Min/Max: 8/8
+    # - Description: Date the carrier picks up the shipment from the shipper or supplier expressed in format CCYYMMDD
+    class PickupDate < Eddy::Element::DT
+      # @return [void]
+      def initialize()
+        @id = "109"
+        @name = "Pick-up Date"
+        @type = "DT"
+        self.min = 8
+        self.max = 8
+        super(:ccyymmdd)
+      end
+    end
+  end
+end

data/lib/eddy/definitions/manual/elements/111.tm.pickup_time.rb

@@ -0,0 +1,20 @@
+module Eddy
+  module Elements
+    # - Id: 111
+    # - Name: Pick-up Time
+    # - Type: TM (HHMM)
+    # - Min/Max: 4/4
+    # - Description: Time (HHMM) that the carrier is to pick up the shipment.
+    class PickupTime < Eddy::Element::TM
+      # @return [void]
+      def initialize()
+        @id = "111"
+        @name = "Pick-up Time"
+        @type = "TM"
+        self.min = 4
+        self.max = 4
+        super(:hhmm)
+      end
+    end
+  end
+end

data/lib/eddy/definitions/manual/elements/112.an.pier_name.rb

@@ -0,0 +1,19 @@
+module Eddy
+  module Elements
+    # - Id: 112
+    # - Name: Pier Name
+    # - Type: AN
+    # - Min/Max: 2/14
+    # - Description: Free-form name of the pier.
+    class PierName < Eddy::Element::AN
+      # @return [void]
+      def initialize()
+        @id = "112"
+        @name = "Pier Name"
+        @type = "AN"
+        self.min = 2
+        self.max = 14
+      end
+    end
+  end
+end

data/lib/eddy/definitions/manual/elements/785.b.binary_data.rb

@@ -0,0 +1,19 @@
+module Eddy
+  module Elements
+    # - Id: 785
+    # - Name: Binary Data
+    # - Type: B
+    # - Min/Max: 1/?
+    # - Description: A string of octets which can assume any binary pattern from hexadecimal 00 to FF
+    class BinaryData < Eddy::Element::B
+      # @return [void]
+      def initialize()
+        self.id = "785"
+        self.name = "Binary Data"
+        self.type = "B"
+        self.min = 1
+        self.max = 10_000_000_000_000_000
+      end
+    end
+  end
+end

data/lib/eddy/definitions/manual/elements/81.r.weight.rb

@@ -0,0 +1,19 @@
+module Eddy
+  module Elements
+    # - Id: 81
+    # - Name: Weight
+    # - Type: R
+    # - Min/Max: 1/10
+    # - Description: Numeric value of weight
+    class Weight < Eddy::Element::R
+      # @return [void]
+      def initialize()
+        @id = "81"
+        @name = "Weight"
+        @type = "R"
+        self.min = 1
+        self.max = 10
+      end
+    end
+  end
+end

data/lib/eddy/definitions/manual/elements/86.n0.total_equipment.rb

@@ -0,0 +1,20 @@
+module Eddy
+  module Elements
+    # - Id: 86
+    # - Name: Total Equipment
+    # - Type: N0
+    # - Min/Max: 1/3
+    # - Description: Total pieces of equipment
+    class TotalEquipment < Eddy::Element::N
+      # @return [void]
+      def initialize()
+        @id = "86"
+        @name = "Total Equipment"
+        @type = "N0"
+        self.min = 1
+        self.max = 3
+        self.decimal_points = 0
+      end
+    end
+  end
+end

data/lib/eddy/definitions/manual/elements/I02.authorization_information.rb

@@ -0,0 +1,20 @@
+module Eddy
+  module Elements
+    # - Id: I02
+    # - Name: Authorization Information
+    # - Type: AN
+    # - Min/Max: 10/10
+    # - Description: Information used for additional identification or authorization of the interchange sender or the data in the interchange; the type of information is set by the Authorization Information Qualifier (I01)
+    class AuthorizationInformation < Eddy::Element::AN
+      # @return [void]
+      def initialize()
+        @id = "I02"
+        @name = "AuthorizationInformation"
+        @type = "AN"
+        self.min = 10
+        self.max = 10
+        self.value = (" " * 10) # "          "
+      end
+    end
+  end
+end

data/lib/eddy/definitions/manual/elements/I04.security_information.rb

@@ -0,0 +1,20 @@
+module Eddy
+  module Elements
+    # - Id: I04
+    # - Name: Security Information
+    # - Type: AN
+    # - Min/Max: 10/10
+    # - Description: This is used for identifying the security information about the interchange sender or the data in the interchange; the type of information is set by the Security Information Qualifier (I03)
+    class SecurityInformation < Eddy::Element::AN
+      # @return [void]
+      def initialize()
+        @id = "I04"
+        @name = "SecurityInformation"
+        @type = "AN"
+        self.min = 10
+        self.max = 10
+        self.value = (" " * 10) # "          "
+      end
+    end
+  end
+end

data/lib/eddy/definitions/manual/elements/I08.interchange_date.rb

@@ -0,0 +1,20 @@
+module Eddy
+  module Elements
+    # - Id: I08
+    # - Name: Interchange Date
+    # - Type: DT (YYMMDD)
+    # - Min/Max: 6/6
+    # - Description: Date of the interchange
+    class InterchangeDate < Eddy::Element::DT
+      # @return [void]
+      def initialize()
+        @id = "I08"
+        @name = "Interchange Date"
+        @type = "DT"
+        self.min = 6
+        self.max = 6
+        super(:yymmdd, Time.now.utc)
+      end
+    end
+  end
+end

data/lib/eddy/definitions/manual/elements/I09.interchange_time.rb

@@ -0,0 +1,20 @@
+module Eddy
+  module Elements
+    # - Id: I09
+    # - Name: Interchange Time
+    # - Type: TM (HHMM)
+    # - Min/Max: 4/4
+    # - Description: Time of the interchange
+    class InterchangeTime < Eddy::Element::TM
+      # @return [void]
+      def initialize()
+        @id = "I09"
+        @name = "Interchange Time"
+        @type = "TM"
+        self.min = 4
+        self.max = 4
+        super(:hhmm, Time.now.utc)
+      end
+    end
+  end
+end

data/lib/eddy/definitions/manual/elements/I15.component_element_separator.rb

@@ -0,0 +1,32 @@
+module Eddy
+  module Elements
+    # - Id: I15
+    # - Name: Component Element Separator
+    # - Type: N/A (Type is not applicable)
+    # - Min/Max: 1/1
+    # - Description:
+    #   - The component element separator is a delimiter and not a data element;
+    #   - this field provides the delimiter used to separate component data elements within a composite data structure;
+    #   - this value must be different than the data element separator and the segment terminator
+    class ComponentElementSeparator
+      # @return [void]
+      def initialize()
+        @id = "I15"
+        @name = "Component Element Separator"
+        @type = "AN"
+        self.min = 1
+        self.max = 1
+      end
+
+      # @return [String]
+      def value()
+        return ">"
+      end
+
+      # @return [void]
+      def value=(_arg)
+        # FIXME: Need to implement this...
+      end
+    end
+  end
+end

data/lib/eddy/definitions/manual/segments/n1.rb

@@ -0,0 +1,14 @@
+module Eddy
+  module Segments
+    # Id: N1
+    # Description: Party Identification
+    class N1 < Eddy::Segment
+      # @return [void]
+      def initialize()
+        self.id = "N1"
+        self.description = "Party Identification"
+        self.elements = []
+      end
+    end
+  end
+end

data/lib/eddy/element.rb

@@ -0,0 +1,14 @@
+module Eddy
+  # Base types for EDI Data Elements.
+  module Element; end
+end
+
+require "eddy/element/base"
+
+require "eddy/element/an"
+require "eddy/element/b"
+require "eddy/element/dt"
+require "eddy/element/id"
+require "eddy/element/n"
+require "eddy/element/r"
+require "eddy/element/tm"

data/lib/eddy/element/an.rb

@@ -0,0 +1,36 @@
+module Eddy
+  module Element
+    # Alphanumeric string including special characters
+    class AN < Base
+      # @param min [Integer]
+      # @param max [Integer]
+      # @param val [String]
+      # @return [void]
+      def initialize(min, max, val = nil)
+        self.min = min
+        self.max = max
+        self.value = val
+      end
+
+      # @return [String]
+      def value()
+        # raise Eddy::ElementNilValueError if @value.nil?
+        return @value
+      end
+
+      # @param arg [String]
+      # @raise [Eddy::ElementValidationError]
+      # @return [void]
+      def value=(arg)
+        if arg.nil?
+          @value = arg
+          return
+        end
+        raise Eddy::ElementValidationError, "value needs to be a string" unless arg.is_a?(String)
+        raise Eddy::ElementValidationError, "value can't be shorter than #{self.min}" if arg.length < self.min
+        raise Eddy::ElementValidationError, "value can't be longer than #{self.max}" if arg.length > self.max
+        @value = arg
+      end
+    end
+  end
+end

data/lib/eddy/element/b.rb

@@ -0,0 +1,9 @@
+module Eddy
+  module Element
+    # Binary Data (example: 010101101)
+    class B < Base
+      # @return [String<Binary>]
+      attr_accessor :value
+    end
+  end
+end

data/lib/eddy/element/base.rb

@@ -0,0 +1,37 @@
+module Eddy
+  # Base types for EDI Data Elements.
+  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
+      # One of: AN, B, DT, ID, N, R, or TM
+      # @return [String]
+      attr_reader :type
+      # Minimum length for a valid value.
+      # @return [Integer]
+      attr_accessor :min
+      # Maximum length for a valid value.
+      # @return [Integer]
+      attr_accessor :max
+
+      # Inheriting classes need to define a getter for `value`.
+      # @return [void]
+      def value()
+        raise NotImplementedError
+      end
+
+      # Inheriting classes need to define a setter for `value`.
+      # @param _arg [Object] Whatever is to be assigned to `value`
+      # @return [void]
+      def value=(_arg)
+        raise NotImplementedError
+      end
+    end
+
+  end
+end

data/lib/eddy/element/dt.rb

@@ -0,0 +1,89 @@
+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
+
+      ACCEPTED_FORMATS = [:yymmdd, :ccyymmdd].freeze
+
+      # A *UTC* formatted [Time](https://ruby-doc.org/stdlib-2.6.5/libdoc/time/rdoc/Time.html) object.
+      # @return [Time]
+      attr_reader :date
+      # Format for the date. Valid values: `:yymmdd` or `:ccyymmdd`
+      # @return [Symbol<:yymmdd, :ccyymmdd>]
+      attr_reader :fmt
+
+      # @param fmt [Symbol] Format for the date. Valid values: `:yymmdd` or `:ccyymmdd`
+      # @param date [Time] A *UTC* formatted Time object.
+      # @raise [ArgumentError] If an invalid format argument is passed.
+      # @return [void]
+      def initialize(fmt, date = nil)
+        fmt = fmt.to_sym.downcase
+        raise ArgumentError unless ACCEPTED_FORMATS.include?(fmt)
+        @fmt = fmt
+        self.value = date
+      end
+
+      # @raise [ElementNilValueError] if `date` is `nil`
+      # @return [String]
+      def value()
+        # raise Eddy::ElementNilValueError if self.date.nil?
+        case self.fmt
+        when :yymmdd
+          return DT.yymmdd(self.date)
+        when :ccyymmdd
+          return DT.ccyymmdd(self.date)
+        else
+          raise Eddy::Error "invalid fmt value for DT object"
+        end
+      end
+
+      # @param date [Time] A *UTC* formatted `Time` object.
+      # @raise [ElementValidationError] Unless passed a *UTC* formatted `Time` object.
+      # @return [void]
+      def value=(date)
+        if date.nil?
+          @date = date
+          return
+        end
+        raise Eddy::ElementValidationError unless date.is_a?(Time)
+        raise Eddy::ElementValidationError "argument is not in UTC format" unless date.utc?()
+        @date = date
+      end
+
+      # @return [Symbol]
+      def determine_format
+        case self.max
+        when 6
+          return :yymmdd
+        when 8
+          return :ccyymmdd
+        else
+          raise Eddy::Error, "unable to determine format for dt element"
+        end
+      end
+
+      # Generates an timestamp in `CCYYMMDD` format.
+      #
+      # @param date [Time] A *UTC* formatted `Time` object.
+      # @return [String]
+      def self.ccyymmdd(date = Time.now.utc)
+        return date.strftime("%Y%m%d")
+      end
+
+      # Generates an timestamp in `YYMMDD` format.
+      #
+      # @param date [Time] A *UTC* formatted `Time` object.
+      # @return [String]
+      def self.yymmdd(date = Time.now.utc)
+        return date.strftime("%y%m%d")
+      end
+
+    end
+  end
+end