eddy 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1741275af8926c329cfb842bbcd9e878850d21957d00cd93596d378a7b443a68
-  data.tar.gz: 1c1d5492e1ac989708505890e9d3a2e4db8008b614b7e52bb7554ccbc99f3739
+  metadata.gz: f42340c2240a26ad129493767545915bfa8d6405d79691841fada80cac9ac7ee
+  data.tar.gz: d60b37dc82e5a008e616ee98c902201df6d97808d4e215769e208a0de404bffb
 SHA512:
-  metadata.gz: 56a2d2235e1eb3759400567ee7765e0ad647fc579abde3cc6a7a6ef15c5a3c4e2e497796084e5bea4170c7fc0a1bda79f29ac21024ecc6c39960d9656a54c199
-  data.tar.gz: 01274642ed73cd71bf525839f7521b93d848483935641b84e6165f05e6f64497fbef6fb414b19641cbf075d08be6f8c0a96828c34606b1e43ecb455d2c692cca
+  metadata.gz: 5c6ac232571b5cd098770a25c20416cfa7ce4a65be98bf5b001666185010b0d84dbf9af160406bcd1e313c35eda2a463da92b413cceee1a9458f728ab0894e3d
+  data.tar.gz: f41c5e4c6bc496f0354e6046c1d9bec085037f529647d9ea04c4c81706c4bcd3412528413afb5166866894c19484279d098f9b35ebc6de13129a31217c7977f5

data/CHANGELOG.md

@@ -7,12 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## master (unreleased)
 
-Versions 0.x.x (0.2.0, 0.3.0) exist to make it easier for me to test Eddy in other projects and figure out how best to move forward with development.
+Versions 0.x (0.2, 0.3, 0.4, ...) exist to make it easier for me to test Eddy in other projects and figure out how best to move forward with development.
 
 All code should be considered Work In Progress.
 
 While the API is still changing, enough code exists that EDI documents can currently be written with Eddy (though I wouldn't recommend use in production environments yet).
 
+## 0.4.0 (2020-01-05)
+
+### Added
+
+- Support `Eddy::Data::Persistence::ActiveRecord`.
+
+### Changed
+
+- Move generators to separate repo, [tcd/eddy-rails](https://github.com/tcd/eddy-rails).
+- Update `Eddy.data` when `Eddy.config.persistence_method` is changed.
+
 ## 0.3.0 (2020-01-04)
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    eddy (0.3.0)
+    eddy (0.4.0)
       ginny (~> 0.6.3)
       json_schemer (~> 0.2.8)
       thor (~> 1.0.1)

data/README.md

@@ -10,10 +10,12 @@
 [travis-ci]: https://travis-ci.org/tcd/eddy
 [coveralls]: https://coveralls.io/github/tcd/eddy?branch=master
 [license]: https://github.com/tcd/eddy/blob/master/LICENSE.txt
-[docs]: https://www.rubydoc.info/gems/eddy/0.3.0
+[docs]: https://www.rubydoc.info/gems/eddy/0.4.0
 
 ## Installation
 
+### Without Rails
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -28,12 +30,7 @@ bundle
 
 ### With Rails
 
-Once installed, run
-
-```sh
-rails g eddy:install eddy:migration
-rails db:migrate
-```
+Use [eddy-rails](https://github.com/tcd/eddy-rails).
 
 ## Validation
 

data/eddy.gemspec

@@ -6,13 +6,14 @@ Gem::Specification.new do |spec|
   spec.name          = "eddy"
   spec.version       = Eddy::VERSION
   spec.authors       = ["Clay Dunston"]
-  spec.required_ruby_version = ">= 2.5.0"
   spec.email         = ["dunstontc@gmail.com"]
   spec.summary       = "EDI toolkit"
   spec.description   = spec.summary
   spec.homepage      = "https://github.com/tcd/eddy"
   spec.license       = "MIT"
 
+  spec.required_ruby_version = ">= 2.5.0"
+
   spec.metadata = {
     "homepage_uri" => spec.homepage,
     "source_code_uri" => spec.homepage,

data/lib/eddy/config.rb

@@ -1,12 +1,9 @@
 module Eddy
-  # Configuration for Eddy
+  # Configuration for Eddy.
   class Config
 
     # @return [String<"test", "development", "production">] ("development")
     attr_accessor :env
-    # Method used by Eddy to persist data about EDI control numbers.
-    # @return [Symbol<:memory, :file>] (:memory)
-    attr_accessor :persistence_method
     # @return [String]
     attr_accessor :tmp_dir
     # @return [String]
@@ -26,6 +23,23 @@ module Eddy
       self.validate = true
     end
 
+    # Method used by Eddy to persist data about EDI control numbers.
+    # @return [Symbol<:memory, :file>] (:memory)
+    #
+    # @return [void]
+    def persistence_method()
+      return @persistence_method
+    end
+
+    # Method used by Eddy to persist data about EDI control numbers.
+    #
+    # @param method [Symbol]
+    # @return [void]
+    def persistence_method=(method)
+      Eddy.clear_data()
+      @persistence_method = method
+    end
+
   end
 
   # Configuration for Eddy

data/lib/eddy/data.rb

@@ -7,16 +7,29 @@ module Eddy
   # Persistent data used by Eddy.
   # @return [Eddy::Data::Persistence::Base]
   def self.data
-    return @data if defined? @data
+    return @data if defined?(@data) && !@data.nil?
     case Eddy.config.persistence_method
     when :memory then @data = Eddy::Data::Persistence::Memory.new()
     when :file   then raise NotImplementedError
-    when :db     then raise NotImplementedError
+    when :active_record
+      if defined?(Rails) && defined?(Eddy::Rails)
+        @data = Eddy::Data::Persistence::ActiveRecord.new()
+      else
+        raise Eddy::Errors::Error, "ActiveRecord persistence method can currently only be used with Ruby on Rails"
+      end
     else raise Eddy::Errors::Error, "Unsupported persistence method: #{Eddy.config.persistence_method}"
     end
     return @data
   end
 
+  # Set `@data` to `nil` so that a new persistence_method can be set up.
+  #
+  # @return [void]
+  def self.clear_data()
+    @data = nil
+  end
+
+  # Code for storing & generating data used by Eddy when generating EDI documents.
   module Data
 
     # @return [Integer]

data/lib/eddy/models/loop/repeat.rb

@@ -0,0 +1,42 @@
+module Eddy
+  module Loop
+    # Data form a single loop iteration.
+    class Repeat
+
+      # An array of Segments and/or other Loops.
+      # This is used as a template to populate `content`.
+      # @return [Array<Eddy::Segment, Eddy::Loop::Base>]
+      attr_reader :components
+      # @return [Eddy::Data::Store] Data passed down from a Transaction Set.
+      attr_reader :store
+
+      # All of a Loop's elements need to be declared in its constructor.
+      #
+      # @param store [Eddy::Data::Store]
+      # @param components [Array<Eddy::Loop, Eddy::Segment>]
+      # @return [void]
+      def initialize(store, *components)
+        @store = store
+        components.flatten!
+        @components = components || []
+      end
+
+      # Return all contained Segments in a single, flattened array.
+      #
+      # @return [Array<Eddy::Segment>]
+      def all_contents()
+        contents = self.content.flatten.map do |c|
+          if c.is_a?(Eddy::Loop::Base)
+            c.all_contents()
+          elsif c.is_a?(Eddy::Segment)
+            c
+          else
+            raise Eddy::Errors::RenderError
+          end
+        end
+        return contents.flatten
+      end
+
+    end
+  end
+end

data/lib/eddy/models.rb

@@ -0,0 +1,13 @@
+require "eddy/models/element"
+require "eddy/models/segment"
+require "eddy/models/loop/base"
+# require "eddy/models/loop/repeat"
+require "eddy/models/transaction_set"
+require "eddy/models/functional_group"
+require "eddy/models/interchange"
+require "eddy/models/simple_interchange"
+
+module Eddy
+  # Classes modeling EDI components.
+  module Models; end
+end

data/lib/eddy/version.rb

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

data/lib/eddy.rb

@@ -9,18 +9,9 @@ require "eddy/data"
 
 Dir.glob(File.join(__dir__, "eddy", "schema", "*.rb")).sort.each { |file| require file }
 
-require "eddy/models/element"
-require "eddy/models/segment"
-require "eddy/models/loop"
-require "eddy/models/transaction_set"
-
-require "eddy/write/interchange"
-require "eddy/write/simple_interchange"
-require "eddy/write/functional_group"
-
+require "eddy/models"
 require "eddy/parse"
-
-require "eddy/build/build"
+require "eddy/build"
 
 # Dir.glob(File.join(__dir__, "definitions", "elements", "manual", "**", "*.rb")).sort.each         { |file| require file }
 # Dir.glob(File.join(__dir__, "definitions", "segments", "manual", "**", "*.rb")).sort.each         { |file| require file }
@@ -30,4 +21,4 @@ Dir.glob(File.join(__dir__, "definitions", "elements", "**", "*.rb")).sort.each
 Dir.glob(File.join(__dir__, "definitions", "segments", "**", "*.rb")).sort.each         { |file| require file }
 Dir.glob(File.join(__dir__, "definitions", "transaction_sets", "**", "*.rb")).sort.each { |file| require file }
 
-require "eddy/cli/cli"
+require "eddy/cli"

data/todo.txt

@@ -3,10 +3,10 @@ x 2019-12-20 2019-12-20 Write code to check what element files already exist.
 x 2019-12-20 Write code to build all segments.
 x 2020-01-02 2019-12-20 Figure out how to deal with loops.
 x 2020-01-03 2019-12-20 Finish TransactionSetBuilder.
+x 2020-01-05 2019-12-20 Reset `Eddy.data` when `Eddy.config.persistence_method` changes.
 
 2019-12-28 If a loop can only repeat once, dont treat it as a loop.
 2019-12-20 Add a DB persistence_method.
-2019-12-20 Reset `Eddy.data` when `Eddy.config.persistence_method` changes.
 2019-12-20 Check for conflicts in Rails generators.
 2019-12-20 Write a Rails model generator.
 2019-12-27 Generate "ref map" files.
@@ -14,3 +14,4 @@ x 2020-01-03 2019-12-20 Finish TransactionSetBuilder.
 2019-12-30 JSON schema validation errors.
 2020-01-02 Ensure loops dont go over repeat limit.
 2020-01-02 Implement `Segment.max_use` & `Segment.min_use`.
+2020-01-05 Move `Build` to `eddy-build`

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eddy
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Clay Dunston
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-04 00:00:00.000000000 Z
+date: 2020-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -1491,7 +1491,7 @@ files:
 - lib/definitions/transaction_sets/manual/856/856.rb
 - lib/definitions/transaction_sets/manual/856/loops.rb
 - lib/eddy.rb
-- lib/eddy/build/build.rb
+- lib/eddy/build.rb
 - lib/eddy/build/elements/element.rb
 - lib/eddy/build/elements/elements.rb
 - lib/eddy/build/elements/id.rb
@@ -1499,15 +1499,15 @@ files:
 - lib/eddy/build/loop_builder.rb
 - lib/eddy/build/segment_builder.rb
 - lib/eddy/build/transaction_set_builder.rb
-- lib/eddy/cli/cli.rb
+- lib/eddy/cli.rb
 - lib/eddy/config.rb
 - lib/eddy/data.rb
-- lib/eddy/data/persistence/active_record.rb
 - lib/eddy/data/persistence/base.rb
 - lib/eddy/data/persistence/file.rb
 - lib/eddy/data/persistence/memory.rb
 - lib/eddy/data/store.rb
 - lib/eddy/errors.rb
+- lib/eddy/models.rb
 - lib/eddy/models/element.rb
 - lib/eddy/models/element/an.rb
 - lib/eddy/models/element/b.rb
@@ -1518,8 +1518,12 @@ files:
 - lib/eddy/models/element/n.rb
 - lib/eddy/models/element/r.rb
 - lib/eddy/models/element/tm.rb
-- lib/eddy/models/loop.rb
+- lib/eddy/models/functional_group.rb
+- lib/eddy/models/interchange.rb
+- lib/eddy/models/loop/base.rb
+- lib/eddy/models/loop/repeat.rb
 - lib/eddy/models/segment.rb
+- lib/eddy/models/simple_interchange.rb
 - lib/eddy/models/transaction_set.rb
 - lib/eddy/parse.rb
 - lib/eddy/schema/element_summary.rb
@@ -1538,13 +1542,6 @@ files:
 - lib/eddy/util/timestamp.rb
 - lib/eddy/util/trim.rb
 - lib/eddy/version.rb
-- lib/eddy/write/functional_group.rb
-- lib/eddy/write/interchange.rb
-- lib/eddy/write/simple_interchange.rb
-- lib/generators/eddy/initializer/initializer_generator.rb
-- lib/generators/eddy/initializer/templates/eddy.rb.erb
-- lib/generators/eddy/migration/migration_generator.rb
-- lib/generators/eddy/migration/templates/migration.rb.erb
 - tasks/build.rake
 - tasks/misc/gemspec.rake
 - tasks/misc/missing_lists.rake
@@ -1557,7 +1554,7 @@ metadata:
   homepage_uri: https://github.com/tcd/eddy
   source_code_uri: https://github.com/tcd/eddy
   changelog_uri: https://github.com/tcd/eddy/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/eddy/0.3.0
+  documentation_uri: https://www.rubydoc.info/gems/eddy/0.4.0
   yard.run: yri
 post_install_message: 
 rdoc_options: []

data/lib/eddy/data/persistence/active_record.rb

@@ -1,10 +0,0 @@
-module Eddy
-  module Data
-    module Persistence
-      # Persist data to a database using Active Record.
-      class ActiveRecord
-
-      end
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-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

@@ -1,6 +0,0 @@
-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

@@ -1,53 +0,0 @@
-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

@@ -1,35 +0,0 @@
-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