eddy 0.1.0 → 0.3.0

data/lib/eddy/element/id.rb

@@ -1,40 +0,0 @@
-module Eddy
-  module Element
-
-    # Identifier (works with a code list specified by the dictionary).
-    class ID < Element::Base
-      # @return [Array<String>]
-      def code_list
-        raise NotImplementedError, "Each ID element must define its own code_list"
-      end
-
-      # @param min [Integer]
-      # @param max [Integer]
-      # @return [void]
-      def initialize(min, max)
-        self.min = min
-        self.max = max
-      end
-
-      # @return [String]
-      def value()
-        # raise Eddy::ElementNilValueError if @value.nil?
-        return @value
-      end
-
-      # @param arg [String]
-      # return [void]
-      def value=(arg)
-        if arg.nil?
-          @value = arg
-          return
-        end
-        raise Eddy::ElementValidationError, "value not present in code list" unless self.code_list().include?(arg)
-        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/n.rb

@@ -1,43 +0,0 @@
-module Eddy
-  module Element
-    # Numeric (implies the number of decimal points, e.g., N2 would be two decimal positions)
-    class N < Base
-      # Number of decimal points.
-      # @return [Integer]
-      attr_accessor :decimal_points
-
-      # @param min [Integer]
-      # @param max [Integer]
-      # @param decimal_points [Integer]
-      # @param val [Integer,nil] (nil)
-      # @return [void]
-      def initialize(min, max, decimal_points, val = nil)
-        self.min = min
-        self.max = max
-        self.decimal_points = decimal_points
-        self.value = val
-      end
-
-      # @return [String]
-      def value
-        # raise Eddy::ElementNilValueError if @value.nil?
-        return @value.to_s
-      end
-
-      # @param arg [Integer]
-      # @raise [Eddy::ElementValidationError]
-      # @return [void]
-      def value=(arg)
-        if arg.nil?
-          @value = arg
-          return
-        end
-        raise Eddy::ElementValidationError, "value needs to be an integer" unless arg.is_a?(Integer)
-        raise Eddy::ElementValidationError, "value can't be shorter than #{self.min}" if arg.to_s.length < self.min
-        raise Eddy::ElementValidationError, "value can't be longer than #{self.max}" if arg.to_s.length > self.max
-        @value = arg
-      end
-
-    end
-  end
-end

data/lib/eddy/element/r.rb

@@ -1,47 +0,0 @@
-module Eddy
-  module Element
-    # Decimal Numeric (decimal points must be transmitted if used).
-    class R < Base
-
-      # @param min [Integer]
-      # @param max [Integer]
-      # @param val [Integer]
-      # @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 process(@value)
-      end
-
-      # @param arg [Float]
-      # @raise [ArgumentError] Unless passed a Float value.
-      # @return [void]
-      def value=(arg)
-        if arg.nil?
-          @value = arg
-          return
-        end
-        raise Eddy::ElementValidationError, "value needs to be a float" unless arg.is_a?(Float)
-        raise Eddy::ElementValidationError, "value can't be shorter than #{self.min}" if process(arg).length < self.min
-        raise Eddy::ElementValidationError, "value can't be longer than #{self.max}" if process(arg).length > self.max
-        @value = arg
-      end
-
-      # Stringify a float value and trim to the element's `max` attribute.
-      # TODO: Use `printf` here.
-      #
-      # @param float [Float]
-      # @return [String]
-      def process(float)
-        return float.to_s.slice(0..(self.max + 1))
-      end
-
-    end
-  end
-end

data/lib/eddy/element/tm.rb

@@ -1,108 +0,0 @@
-require "time"
-
-module Eddy
-  module Element
-    # Time in `HHMMSSDD` format.
-    # Time expressed in 24-hour clock time as follows:
-    # `HHMM`, or `HHMMSS`, or `HHMMSSD`, or `HHMMSSDD`, where H = hours (00-23), M = minutes (00-59), S = integer seconds (00-59) and DD = decimal seconds;
-    # decimal seconds are expressed as follows: D = tenths (0-9) and DD = hundredths (00-99)
-    #
-    # 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 TM < Base
-
-      # @return [Array<Symbol>]
-      ACCEPTED_FORMATS = [:hhmm, :hhmmss, :hhmmssd, :hhmmssdd].freeze
-
-      # A [time](https://ruby-doc.org/stdlib-2.6.5/libdoc/time/rdoc/Time.html) object in `UTC` format.
-      # @return [Time]
-      attr_reader :time
-      # Format for the date. Valid values: `:hhmm`, `:hhmmss`, `:hhmmssd`, and `:hhmmssdd`
-      # @return [Symbol<:hhmm, :hhmmss, :hhmmssd, :hhmmssdd>]
-      attr_reader :fmt
-
-      # @param fmt [Symbol] Format for the date. Valid values: `:hhmm`, `:hhmmss`, `:hhmmssd`, and `:hhmmssdd`
-      # @param time [Time] A *UTC* formatted Time object.
-      # @raise [ArgumentError] If an invalid format argument is passed.
-      # @return [void]
-      def initialize(fmt, time = nil)
-        fmt = fmt.to_sym.downcase
-        raise ArgumentError unless ACCEPTED_FORMATS.include?(fmt)
-        @fmt = fmt
-        self.value = time
-      end
-
-      # @param time [Time] A *UTC* formatted `Time` object.
-      # @raise [ElementValidationError] Unless passed a *UTC* formatted Time object.
-      # @return [void]
-      def value=(time)
-        if time.nil?
-          @time = time
-          return
-        end
-        raise Eddy::ElementValidationError unless time.is_a?(Time)
-        raise Eddy::ElementValidationError "argument is not in UTC format" unless time.utc?()
-        @time = time
-      end
-
-      # @raise [ElementNilValueError] if `time` is `nil`
-      # @return [String]
-      def value()
-        raise Eddy::ElementNilValueError if self.time.nil?
-        case self.fmt
-        when :hhmm
-          return TM.hhmm(self.time)
-        when :hhmmss
-          return TM.hhmmss(self.time)
-        when :hhmmssd
-          return TM.hhmmssd(self.time)
-        when :hhmmssdd
-          return TM.hhmmssdd(self.time)
-        else
-          raise Eddy::Error "invalid fmt value for TM object"
-        end
-      end
-
-      # @return [Symbol]
-      def determine_format
-        case self.max
-        when 4
-          return :hhmm
-        when 6
-          return :hhmmss
-        when 7
-          return :hhmmssd
-        when 8
-          return :hhmmssdd
-        else
-          raise Eddy::Error, "unable to determine format for tm element"
-        end
-      end
-
-      # @param time [Time] A *UTC* formatted `Time` object.
-      # @return [String]
-      def self.hhmm(time = Time.now.utc)
-        return time.strftime("%m%d")
-      end
-
-      # @param time [Time] A *UTC* formatted `Time` object.
-      # @return [String]
-      def self.hhmmss(time = Time.now.utc)
-        return time.strftime("%m%d%S")
-      end
-
-      # @param time [Time] A *UTC* formatted `Time` object.
-      # @return [String]
-      def self.hhmmssd(time = Time.now.utc)
-        return time.strftime("%m%d%S%1N")
-      end
-
-      # @param time [Time] A *UTC* formatted `Time` object.
-      # @return [String]
-      def self.hhmmssdd(time = Time.now.utc)
-        return time.strftime("%m%d%S%2N")
-      end
-    end
-  end
-end

data/lib/eddy/error.rb

@@ -1,14 +0,0 @@
-module Eddy
-  # Exceptions raised by Eddy inherit from Error.
-  # @abstract
-  class Error < StandardError; end
-
-  # Exception raised when an invalid argument is passed to the `value=` method of an {Element} class.
-  class ElementValidationError < Error; end
-
-  # Exception raised when `value` has been called before `value=` and no default value is set.
-  class ElementNilValueError < Error; end
-
-  # Exception raised when a class inherits from {Element} and doesn't set all instance attributes properly.
-  class ElementNilAttributeError < Error; end
-end

data/lib/eddy/helpers.rb

@@ -1,31 +0,0 @@
-require "csv"
-
-module Eddy
-
-  # Read a TSV file and return its contents as an array of hashes.
-  #
-  # @param filepath [String] Path to the TSV file.
-  # @return [Array<Hash>]
-  def self.parse_tsv(filepath)
-    return CSV.read(
-      filepath,
-      col_sep: "\t",
-      headers: true,
-      quote_char: nil,
-      header_converters: :symbol,
-    ).map(&:to_hash)
-  end
-
-  # Directory where the gem is located.
-  # @return [String]
-  def self.root_dir
-    return File.expand_path("../../..", __FILE__)
-  end
-
-  # Directory for writing out files.
-  # @return [String]
-  def self.data_dir
-    return File.join(self.root_dir, "data")
-  end
-
-end

data/lib/eddy/segment.rb

@@ -1,12 +0,0 @@
-module Eddy
-  class Segment
-    # An alphanumeric code unique to each Segment type.
-    # @return [String]
-    attr_reader :id
-    # Short name of the Segment. Should probably be called `name`...
-    # @return [String]
-    attr_reader :description
-    # @return [Array<Element>]
-    attr_accessor :elements
-  end
-end

data/lib/eddy/transaction_set.rb

@@ -1,35 +0,0 @@
-module Eddy
-  # Interchange / Document / Envelope / Group / File
-  class TransactionSet
-    # @return [Integer]
-    attr_accessor :code
-    # @return [String]
-    attr_accessor :functional_group
-    # @return [String]
-    attr_accessor :description
-    # @return [Array<Segment>]
-    attr_accessor :segments
-    # Time value for use by DT/TM Elements.
-    # @return [Time]
-    attr_accessor :time
-    # Component Element Separator
-    # (defaults to `">"`)
-    # @return [String]
-    attr_accessor :component_separator
-    # (defaults to `"~"`)
-    # @return [String]
-    attr_accessor :segment_separator
-    # Data Element Separator
-    # (defaults to `"*"`)
-    # @return [String]
-    attr_accessor :element_separator
-
-    # @return [void]
-    def initialize()
-      self.time = Time.now().utc()
-      self.component_separator = ">"
-      self.segment_separator = "~"
-      self.element_separator = "*"
-    end
-  end
-end