eddy 0.1.0 → 0.3.0

data/lib/eddy/util/normalize.rb

@@ -0,0 +1,51 @@
+module Eddy
+  module Util
+    # @!group Normalize
+
+    # Given an Element Id (positive number under 1688, or I01-I64), returns a string sutable for use as a Ruby class name.
+    #
+    # @param id [String]
+    # @return [String]
+    def self.normalize_id(id)
+      name_regex = /\A(?<prefix>[iI]{1})?(?<numbers>\d+)\Z/
+      res = ""
+      if matches = id.match(name_regex)
+        if matches[:prefix]
+          res << "I"
+        else
+          res << "E"
+        end
+        res << matches[:numbers]
+      else
+        raise Eddy::Errors::BuildError, "invalid element id"
+      end
+    end
+
+    # Convert a string to [*PascalCase*](http://wiki.c2.com/?PascalCase), or *UpperCamelCase*
+    # Remove dashes, slashes, underscores, spaces, periods, and parens from a string then titleize it.
+    #
+    # @param name [String]
+    # @return [String]
+    def self.normalize_name(name)
+      return name.gsub(/\s*\(.*\)|[']/, "")
+                 .gsub(%r{[.,_\-/]}, " ")
+                 .split(" ")
+                 .map(&:capitalize)
+                 .join("")
+    end
+
+    # Convert a string to [*snake_case*](https://en.wikipedia.org/wiki/Snake_case)
+    #
+    # @param name [String]
+    # @return [String]
+    def self.snake_case(name)
+      return name.gsub(/\s*\(.*\)|['.]/, "")
+                 .gsub(%r{[,_\-/]}, " ")
+                 .split(" ")
+                 .map(&:downcase)
+                 .join("_")
+    end
+
+    # @!endgroup Normalize
+  end
+end

data/lib/eddy/util/paths.rb

@@ -0,0 +1,19 @@
+module Eddy
+  module Util
+    # @!group Paths
+
+    # Directory where the gem is located.
+    # @return [String]
+    def self.root_dir
+      return File.expand_path("../../../..", __FILE__)
+    end
+
+    # Directory containing EDI data & definitions.
+    # @return [String]
+    def self.data_dir
+      return File.join(self.root_dir, "data")
+    end
+
+    # @!endgroup Paths
+  end
+end

data/lib/eddy/util/read.rb

@@ -0,0 +1,38 @@
+require "csv"
+require "json"
+require "yaml"
+
+module Eddy
+  module Util
+
+    # Read a TSV file and return its contents as an array of hashes.
+    #
+    # @param filepath [String] Path to the TSV file.
+    # @return [Array<Hash{Symbol => String}>]
+    def self.parse_tsv(filepath)
+      return CSV.read(
+        filepath,
+        col_sep: "\t",
+        headers: true,
+        quote_char: "\x00",
+        header_converters: :symbol,
+      ).map(&:to_hash)
+    end
+
+    # Read data in from either a JSON or YAML file.
+    #
+    # @param path [String] Path to the file.
+    # @param symbolize [Boolean] (true)
+    # @return [Hash{Symbol => Object}]
+    def self.read_json_or_yaml(path, symbolize: true)
+      path = File.expand_path(path)
+      data = case File.extname(path).downcase
+             when /\.ya?ml/ then YAML.safe_load(File.read(path), symbolize_names: symbolize)
+             when ".json"   then JSON.parse(File.read(path), symbolize_names: symbolize)
+             else raise Eddy::Errors::Error
+             end
+      return data
+    end
+
+  end
+end

data/lib/eddy/util/time.rb

@@ -0,0 +1,56 @@
+module Eddy
+  module Util
+    # Functions for formatting [Time](https://ruby-doc.org/stdlib-2.6.5/libdoc/time/rdoc/Time.html) objects.
+    module Time
+
+      # @!group DT
+
+      # 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
+
+      # @!endgroup DT
+
+      # @!group TM
+
+      # @param time [Time] A *UTC* formatted `Time` object.
+      # @return [String]
+      def self.hhmm(time = Time.now.utc)
+        return time.strftime("%H%M")
+      end
+
+      # @param time [Time] A *UTC* formatted `Time` object.
+      # @return [String]
+      def self.hhmmss(time = Time.now.utc)
+        return time.strftime("%H%M%S")
+      end
+
+      # @param time [Time] A *UTC* formatted `Time` object.
+      # @return [String]
+      def self.hhmmssd(time = Time.now.utc)
+        return time.strftime("%H%M%S%1N")
+      end
+
+      # @param time [Time] A *UTC* formatted `Time` object.
+      # @return [String]
+      def self.hhmmssdd(time = Time.now.utc)
+        return time.strftime("%H%M%S%2N")
+      end
+
+      # @!endgroup TM
+
+    end
+  end
+end

data/lib/eddy/util/timestamp.rb

@@ -0,0 +1,12 @@
+require "time"
+
+module Eddy
+  module Util
+
+    # @return [String]
+    def self.timestamp
+      return ::Time.now.strftime("%m-%d-%Y-%H-%M-%S")
+    end
+
+  end
+end

data/lib/eddy/util/trim.rb

@@ -0,0 +1,29 @@
+module Eddy
+  module Util
+    # @!group Normalize
+
+    # See: [Trailing delimiters and 999 response - X12 RFI](http://www.x12.org/rfis/Trailing%20delimiters%20and%20999%20response.pdf)
+    #
+    # @param itch [String] String containing an EDI Interchange.
+    # @param element_separator [String] ("*")
+    # @param segment_separator [String] ("~")
+    # @return [String]
+    def self.trim_delims_from_interchange(itch, element_separator: "*", segment_separator: "~")
+      e_sep = Regexp.escape(element_separator)
+      s_sep = Regexp.escape(segment_separator)
+      return itch.gsub(/#{e_sep}+(?=#{s_sep})/, "")
+    end
+
+    # See: [Trailing delimiters and 999 response - X12 RFI](http://www.x12.org/rfis/Trailing%20delimiters%20and%20999%20response.pdf)
+    #
+    # @param segment [String] String containing an EDI segment.
+    # @param separator [String] ("*")
+    # @return [String]
+    def self.trim_delims_from_segment(segment, separator: "*")
+      e_sep = Regexp.escape(separator)
+      return segment.gsub(/#{e_sep}+(?=$)/, "")
+    end
+
+    # @!endgroup Normalize
+  end
+end

data/lib/eddy/version.rb

@@ -1,3 +1,3 @@
 module Eddy
-  VERSION = "0.1.0".freeze
+  VERSION = "0.3.0".freeze
 end

data/lib/eddy/write/functional_group.rb

@@ -0,0 +1,33 @@
+module Eddy
+  # A group of `Eddy::TransactionSet::Base` classes.
+  class FunctionalGroup
+
+    # @return [Eddy::Data::Store] Data store for the Interchange and all encompassed components.
+    attr_accessor :store
+    # Class for making new Transaction Sets.
+    # @return [Eddy::TransactionSet]
+    attr_accessor :transaction_set
+    # An array of Transaction Set instances
+    # @return [Array<Eddy::TransactionSet>]
+    attr_accessor :transaction_sets
+
+    # @param store [Eddy::Data::Store]
+    # @param transaction_set [Eddy::TransactionSet]
+    # @return [void]
+    def initialize(store, transaction_set)
+      self.store = store
+      self.transaction_set = transaction_set
+      self.transaction_sets = []
+    end
+
+    # @return [String]
+    def render()
+      number_of_included_functional_groups = self.store.number_of_included_functional_groups
+      gs = Eddy::Segments::GS.new(store, number_of_included_functional_groups, self.transaction_set)
+      ge = Eddy::Segments::GE.new(store, number_of_included_functional_groups, self.transaction_set)
+      segments = [gs, self.transaction_sets, ge].flatten
+      return segments.join(self.store.segment_separator) + segment_separator
+    end
+
+  end
+end

data/lib/eddy/write/interchange.rb

@@ -0,0 +1,28 @@
+module Eddy
+  # Top level EDI interchange.
+  class Interchange
+    # @return [Eddy::Data::Store] Data store for the Interchange.
+    attr_accessor :store
+    # @return [Array<Eddy::Write::FunctionalGroup>]
+    attr_accessor :functional_groups
+
+    # @return [void]
+    def initialize()
+      self.store = Eddy::Data::Store.new()
+      self.functional_groups = []
+    end
+
+    # @param _transaction_sets [Array<Eddy::TransactionSet>]
+    # @return [Eddy::Interchange]
+    def self.create(_transaction_sets)
+      itch = Eddy::Interchange.new()
+      return itch
+    end
+
+    # @return [String]
+    def render()
+      raise NotImplementedError
+    end
+
+  end
+end

data/lib/eddy/write/simple_interchange.rb

@@ -0,0 +1,57 @@
+module Eddy
+  # An EDI interchange with one Transaction Set.
+  class SimpleInterchange
+    # @return [Eddy::Data::Store] Data store for the Interchange and all encompassed components.
+    attr_accessor :store
+    # @return [Eddy::TransactionSet]
+    attr_accessor :transaction_set
+    # @return [Array]
+    attr_accessor :components
+
+    # Initialize an interchange with one Functional Group containing one Transaction Set.
+    #
+    # @param transaction_set [Eddy::TransactionSet]
+    # @param store [Eddy::Data::Store] (Eddy::Data::Store.new)
+    # @return [void]
+    def initialize(transaction_set, store: Eddy::Data::Store.new())
+      self.components = []
+      self.transaction_set = transaction_set
+      self.store = store
+      self.store.number_of_transaction_sets_included  = 1
+      self.store.number_of_included_functional_groups = 1
+    end
+
+    # @yieldparam [Eddy::Segments::ISA] isa
+    # @yieldparam [Eddy::Segments::IEA] iea
+    # @yieldparam [Eddy::Segments::GS] gs
+    # @yieldparam [Eddy::Segments::GE] ge
+    # @return [String]
+    def render()
+      itch_ctrl_num = Eddy::Data.new_interchange_control_number()
+      isa = Eddy::Segments::ISA.new(store, itch_ctrl_num)
+      iea = Eddy::Segments::IEA.new(store, itch_ctrl_num)
+      number_of_included_functional_groups = self.store.number_of_included_functional_groups
+      gs = Eddy::Segments::GS.new(store, number_of_included_functional_groups, self.transaction_set)
+      ge = Eddy::Segments::GE.new(store, number_of_included_functional_groups)
+      yield(isa, iea, gs, ge) if block_given?
+      self.components.prepend(gs)
+      self.components.prepend(isa)
+      self.components.append(ge)
+      self.components.append(iea)
+      segments = self.components.map(&:render).flatten().join(store.segment_separator) + store.segment_separator
+      return segments
+    end
+
+    # @raise [ArgumentError] Unless `transaction_set` is a subclass of {Eddy::TransactionSet}
+    # @param transaction_set [Eddy::TransactionSet]
+    # @return [void]
+    def verify_transaction_set(transaction_set)
+      raise ArgumentError unless transaction_set < Eddy::TransactionSet
+      raise ArgumentError unless transaction_set <= Eddy::TransactionSet
+      raise ArgumentError unless transaction_set.ancestors.include?(Eddy::TransactionSet)
+      raise ArgumentError unless transaction_set.superclass == Eddy::TransactionSet
+      return nil
+    end
+
+  end
+end

data/lib/generators/eddy/initializer/initializer_generator.rb

@@ -0,0 +1,17 @@
+require "rails/generators"
+
+module Eddy
+  module Generators
+    # Generate an initializer file for Eddy.
+    class InitializersGenerator < Rails::Generators::Base
+      desc "This generator creates an initializer file at config/initializers/eddy.rb for Eddy"
+      source_root File.expand_path("templates", __dir__)
+
+      # @return [void]
+      def copy_initializer
+        template "eddy.rb.erb", "config/initializers/eddy.rb"
+      end
+
+    end
+  end
+end

data/lib/generators/eddy/initializer/templates/eddy.rb.erb

@@ -0,0 +1,6 @@
+Eddy.configure do |config|
+  config.env = Rails.env
+  config.persistence_method = :memory
+  config.tmp_dir = Rails.root.join('tmp')
+  config.tmp_dir = Rails.root.join('tmp', 'build')
+end

data/lib/generators/eddy/migration/migration_generator.rb

@@ -0,0 +1,53 @@
+require "rails/generators"
+require "rails/generators/active_record"
+
+module Eddy
+  module Generators
+    # Generate migrations to set up database tables for use by Eddy.
+    #
+    # See:
+    #
+    # - [Rails Guides - Generators](https://edgeguides.rubyonrails.org/generators.html)
+    # - [`Rails::Generators::Migration`](https://api.rubyonrails.org/classes/Rails/Generators/Migration.html)
+    # - [StackOverflow Question](https://stackoverflow.com/questions/53212961/how-to-make-a-custom-generator-which-also-generates-a-migration-in-rails)
+    # - ["index: true" in Rails migrations does not work as you'd expect](https://makandracards.com/makandra/32353-psa-index-true-in-rails-migrations-does-not-work-as-you-d-expect)
+    class MigrationGenerator < Rails::Generators::Base
+
+      include Rails::Generators::Migration
+      desc "This generator creates a migration file in db/migrate that will set up database tables for use by Eddy"
+      source_root File.expand_path("templates", __dir__)
+
+      # @return [void]
+      def generate_migration
+        migration_template(
+          "migration.rb.erb",
+          "db/migrate/#{self.migration_file_name()}",
+          migration_version: self.migration_version(),
+        )
+      end
+
+      # @return [String]
+      def migration_file_name()
+        return "create_eddy_tables.rb"
+        # return "#{self.timestamp()}_create_eddy_tables.rb"
+      end
+
+      # @return [String]
+      def timestamp()
+        return Time.now.utc.strftime("%Y%m%d%H%M%S")
+      end
+
+      # @return [String]
+      def migration_version()
+        return "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+      end
+
+      # for generating a timestamp when using `create_migration`
+      # Sole from - https://github.com/thoughtbot/clearance/blob/master/lib/generators/clearance/install/install_generator.rb#L116
+      def self.next_migration_number(dir)
+        ActiveRecord::Generators::Base.next_migration_number(dir)
+      end
+
+    end
+  end
+end

data/lib/generators/eddy/migration/templates/migration.rb.erb

@@ -0,0 +1,35 @@
+class EddyCreateTables < ActiveRecord::Migration<%= migration_version %>
+
+  def self.up
+    create_table :eddy_interchange_control_numbers do |t|
+      t.integer :control_number, null: false
+      t.boolean :received
+      t.boolean :sent
+      t.timestamps null: false
+    end
+    create_table :eddy_functional_group_control_numbers do |t|
+      t.integer :control_number,   null: false
+      t.string  :functional_group, null: false
+      t.boolean :received
+      t.boolean :sent
+      t.timestamps null: false
+    end
+    create_table :eddy_transaction_set_control_numbers do |t|
+      t.integer :control_number,  null: false
+      t.string  :transaction_set, null: false
+      t.boolean :received
+      t.boolean :sent
+      t.timestamps null: false
+    end
+    add_index :eddy_interchange_control_numbers,      :control_number, unique: true
+    add_index :eddy_functional_group_control_numbers, :control_number, unique: true
+    add_index :eddy_transaction_set_control_numbers,  :control_number, unique: true
+  end
+
+  def self.down
+    drop_table :eddy_interchange_control_numbers
+    drop_table :eddy_functional_group_control_numbers
+    drop_table :eddy_transaction_set_control_numbers
+  end
+
+end