eddy 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e1f946cc33950bd7ce6217081bc781ab85ca871aa27822f98874c34f7ca0e2e
-  data.tar.gz: d96b61fe753cf8e71b08d86f42472acc222b8b9bb411cdc8c7989d9c44741e8e
+  metadata.gz: 1741275af8926c329cfb842bbcd9e878850d21957d00cd93596d378a7b443a68
+  data.tar.gz: 1c1d5492e1ac989708505890e9d3a2e4db8008b614b7e52bb7554ccbc99f3739
 SHA512:
-  metadata.gz: c9d121a09d76cb34b268d06e22340a5d4b3bd5ea471925f745d6981cea9a5ab306ac5d9e7fbc16579f2a9456a8ea3e1040949f0bb5ea37b83662ab2a0b6e0fe2
-  data.tar.gz: c0ca209fa9138995399545994a9b6294c26d1fd04681089f0be85753584f0b193d266d3207a149649e5afab4b927d7cd987c80153aa0555c94fc2462833dbbdd
+  metadata.gz: 56a2d2235e1eb3759400567ee7765e0ad647fc579abde3cc6a7a6ef15c5a3c4e2e497796084e5bea4170c7fc0a1bda79f29ac21024ecc6c39960d9656a54c199
+  data.tar.gz: 01274642ed73cd71bf525839f7521b93d848483935641b84e6165f05e6f64497fbef6fb414b19641cbf075d08be6f8c0a96828c34606b1e43ecb455d2c692cca

data/.rubocop.yml

@@ -1,5 +1,17 @@
 AllCops:
-  TargetRubyVersion: 2.3.0
+  TargetRubyVersion: 2.5.0
+
+Style/SingleLineMethods:
+  Exclude:
+    - 'test/**/*.rb'
+
+# Don't leave calls to pry lying around.
+Lint/Debugger:
+  Enabled: true
+
+# ==============================================================================
+# Documentation
+# ==============================================================================
 
 Style/Documentation:
   Enabled: true
@@ -11,13 +23,26 @@ Style/DocumentationMethod:
   Exclude:
     - 'test/**/*.rb'
 
-Style/SingleLineMethods:
+# ==============================================================================
+# Naming
+# ==============================================================================
+
+Naming/MethodParameterName:
+  AllowedNames:
+    - el
+    - id
+
+Naming/MethodName:
+  Enabled: true
   Exclude:
-    - 'test/**/*.rb'
+    - 'lib/definitions/**/*.rb'
+    - 'build/**/*.rb'
 
-# Don't leave calls to pry lying around.
-Lint/Debugger:
+Naming/ClassAndModuleCamelCase:
   Enabled: true
+  Exclude:
+    - 'lib/definitions/**/*.rb'
+    - 'build/**/*.rb'
 
 # ==============================================================================
 # Layout
@@ -39,7 +64,7 @@ Layout/EmptyLinesAroundBlockBody:
   Enabled: false
 
 # https://unix.stackexchange.com/a/18789
-Layout/TrailingBlankLines:
+Layout/TrailingEmptyLines:
   EnforcedStyle: final_newline
 
 # ==============================================================================
@@ -55,6 +80,9 @@ Style/FrozenStringLiteralComment:
 Naming/HeredocDelimiterNaming:
   Enabled: false
 
+Style/FormatString:
+  EnforcedStyle: sprintf
+
 # ==============================================================================
 # Numbers
 # ==============================================================================
@@ -65,11 +93,12 @@ Style/ZeroLengthPredicate:
 Style/NumericPredicate:
   Enabled: false
 
+# preferably `EnforcedStyle: snake_case`, but it varies.
 Naming/VariableNumber:
-  EnforcedStyle: snake_case
+  Enabled: false
 
 # ==============================================================================
-# Braces, Brackets, & Parens
+# Braces, Brackets, and Parentheses
 # ==============================================================================
 
 Style/DefWithParentheses:
@@ -89,22 +118,9 @@ Style/SymbolArray:
   EnforcedStyle: brackets
 
 # ==============================================================================
-# Unsorted
+# Trailing Commas
 # ==============================================================================
 
-# Default value (special_inside_parentheses) is ridiculous.
-# Look for yourself: https://www.rubydoc.info/gems/rubocop/0.69.0/RuboCop/Cop/Layout/IndentFirstHashElement
-Layout/IndentFirstHashElement:
-  EnforcedStyle: consistent
-
-# Default value (special_inside_parentheses) is ridiculous.
-# Look for yourself: https://www.rubydoc.info/gems/rubocop/0.69.0/RuboCop/Cop/Layout/IndentFirstArrayElement
-Layout/IndentFirstArrayElement:
-  EnforcedStyle: consistent
-
-Layout/AlignHash:
-  Enabled: false
-
 Style/TrailingCommaInArguments:
   EnforcedStyleForMultiline: comma
 
@@ -114,38 +130,85 @@ Style/TrailingCommaInArrayLiteral:
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: comma
 
-# Explicit, not redundant
-Style/RedundantReturn:
+# ==============================================================================
+# Fewer lines doesn't mean better code
+# ==============================================================================
+
+Metrics/ModuleLength:
   Enabled: false
 
-# Explicit, not redundant
-Style/RedundantSelf:
+Metrics/ClassLength:
   Enabled: false
 
-# `x&.y&.[](:argument)` isn't what I'd call "readable".
-# https://stackoverflow.com/questions/34794697/using-with-the-safe-navigation-operator-in-ruby
-Style/SafeNavigation:
+Metrics/MethodLength:
   Enabled: false
 
-# TODO: File issue to ignore enums when using `EnforcedStyle: assign_inside_condition`.
-Style/ConditionalAssignment:
+Metrics/BlockLength:
   Enabled: false
 
-Lint/HandleExceptions:
-  AllowComments: true
+# TODO: Look into adding an `EnforcedStyle` to not use guard clauses.
+Style/GuardClause:
+  Enabled: false
 
-Metrics/ModuleLength:
+# TODO: Look into adding an `EnforcedStyle` to not use if/unless modifiers.
+Style/IfUnlessModifier:
   Enabled: false
 
-Metrics/ClassLength:
+Style/Next:
   Enabled: false
 
-Metrics/MethodLength:
+# ==============================================================================
+# Explicit, not redundant
+# ==============================================================================
+
+Style/RedundantReturn:
   Enabled: false
 
-Metrics/BlockLength:
+Style/RedundantSelf:
   Enabled: false
 
+# ==============================================================================
+# Exceptions
+# ==============================================================================
+
+Lint/SuppressedException:
+  AllowComments: true
+
+Style/RaiseArgs:
+  EnforcedStyle: exploded
+
+# ==============================================================================
+# Unsorted
+# ==============================================================================
+
+# Default value (special_inside_parentheses) is ridiculous.
+# Look for yourself: https://www.rubydoc.info/gems/rubocop/0.69.0/RuboCop/Cop/Layout/IndentFirstHashElement
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+# Default value (special_inside_parentheses) is ridiculous.
+# Look for yourself: https://www.rubydoc.info/gems/rubocop/0.69.0/RuboCop/Cop/Layout/IndentFirstArrayElement
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/HashAlignment:
+  Enabled: false
+
+# `x&.y&.[](:argument)` isn't what I'd call "readable".
+# https://stackoverflow.com/questions/34794697/using-with-the-safe-navigation-operator-in-ruby
+Style/SafeNavigation:
+  Enabled: false
+
+Style/NegatedIf:
+  EnforcedStyle: postfix
+
+# TODO: File issue to ignore enums when using `EnforcedStyle: assign_inside_condition`.
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/TernaryParentheses:
+  EnforcedStyle: require_parentheses_when_complex
+
 Metrics/AbcSize:
   Enabled: false
 
@@ -157,3 +220,6 @@ Metrics/PerceivedComplexity:
 
 Style/CommentedKeyword:
   Enabled: False
+
+Lint/EmptyWhen:
+  Enabled: false

data/.solargraph.yml

@@ -5,6 +5,10 @@ exclude:
 - spec/**/*
 - test/**/*
 - vendor/**/*
+- build/**/*
+- data/**/*
+- tasks/**/*
+- tmp/**/*
 domains: []
 reporters:
 - typecheck

data/.vscode/settings.json

@@ -0,0 +1,17 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": [
+        "*.edi.json"
+      ],
+      "url": "./data/schema/transaction_set_summary.json"
+    }
+  ],
+  "yaml.schemas": {
+    "./data/schema/transaction_set_summary.json": "/*.edi.yml",
+    "./data/schema/segment_summary.json": "/*.segment.yml",
+    "./data/schema/loop_summary.json": "/*.loop.yml",
+    "http://json-schema.org/draft-07/schema": "/*.schema.yml",
+    "https://raw.githubusercontent.com/tcd/ginny/master/schema/class.schema.json": "/*.gin.yml",
+  }
+}

data/.yardopts

@@ -1,2 +1,2 @@
---charset utf-8
---markup markdown
+--charset=utf-8
+--markup=markdown

data/CHANGELOG.md

@@ -1 +1,51 @@
 # Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 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.
+
+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.3.0 (2020-01-04)
+
+### Added
+
+- Code for generating Transaction Set classes.
+- Code for writing the following transaction sets:
+    - 810
+    - 850
+    - 855
+    - 856
+
+### Changed
+
+- Improved messages from validation errors.
+- Improved YARD comments for all EDI classes.
+- Improved test coverage.
+
+## 0.2.0 (2019-12-26)
+
+### Added
+
+- Top level configuration (`Eddy.config`).
+- Very basic code for reading EDI documents.
+- Base code for writing EDI documents.
+    - Ruby classes modeling Data Elements, Segments, Transaction Sets, Functional Groups, & Interchanges.
+    - Loops are still WIP
+- Schemas for describing & defining EDI Transaction Sets, Segments, and Data Elements.
+    - JSON Schema files for validation using [davishmcclurg/json_schemer](https://github.com/davishmcclurg/json_schemer).
+    - Code for generating Ruby classes from JSON/YAML EDI definition files using [tcd/ginny](https://github.com/tcd/ginny).
+    - A simple CLI to streamline code generation (WIP).
+- [todo.txt](https://github.com/todotxt/todo.txt) file.
+- Rails generators for easy integration with Ruby on Rails projects.
+
+## 0.1.0 (2019-11-26)
+
+Initial release.

data/Gemfile.lock

@@ -1,15 +1,18 @@
 PATH
   remote: .
   specs:
-    eddy (0.1.0)
-      food_truck (~> 0.5.3)
+    eddy (0.3.0)
+      ginny (~> 0.6.3)
+      json_schemer (~> 0.2.8)
+      thor (~> 1.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ansi (1.5.0)
-    builder (3.2.3)
+    builder (3.2.4)
     coderay (1.1.2)
+    coolkit (0.2.2)
     coveralls (0.8.23)
       json (>= 1.8, < 3)
       simplecov (~> 0.16.1)
@@ -18,9 +21,18 @@ GEM
       tins (~> 1.6)
     docile (1.3.2)
     dry-inflector (0.2.0)
-    food_truck (0.5.3)
+    ecma-re-validator (0.2.0)
+      regexp_parser (~> 1.2)
+    ginny (0.6.3)
+      coolkit (~> 0.2.2)
       dry-inflector (~> 0.2.0)
-    json (2.2.0)
+    hana (1.3.5)
+    json (2.3.0)
+    json_schemer (0.2.8)
+      ecma-re-validator (~> 0.2)
+      hana (~> 1.3)
+      regexp_parser (~> 1.5)
+      uri_template (~> 0.7)
     method_source (0.9.2)
     minitest (5.13.0)
     minitest-focus (1.1.2)
@@ -34,6 +46,7 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     rake (10.5.0)
+    regexp_parser (1.6.0)
     ruby-progressbar (1.10.1)
     simplecov (0.16.1)
       docile (~> 1.1)
@@ -42,16 +55,17 @@ GEM
     simplecov-html (0.10.2)
     term-ansicolor (1.7.1)
       tins (~> 1.0)
-    thor (0.20.3)
+    thor (1.0.1)
     tins (1.22.2)
+    uri_template (0.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 2.0)
-  eddy!
   coveralls (~> 0.8.23)
+  eddy!
   minitest (~> 5.0)
   minitest-focus (~> 1.1)
   minitest-reporters (~> 1.4)

data/README.md

@@ -1,14 +1,16 @@
 # Eddy
 
+[![Gem](https://img.shields.io/gem/v/eddy)][rubygems]
 [![Build Status](https://travis-ci.org/tcd/eddy.svg?branch=master)][travis-ci]
 [![Coverage Status](https://coveralls.io/repos/github/tcd/eddy/badge.svg?branch=master)][coveralls]
 [![License](https://img.shields.io/github/license/tcd/eddy)][license]
 [![Documentation](http://img.shields.io/badge/docs-rubydoc.info-blue.svg)][docs]
 
+[rubygems]: https://rubygems.org/gems/eddy
 [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.1.0
+[docs]: https://www.rubydoc.info/gems/eddy/0.3.0
 
 ## Installation
 
@@ -24,12 +26,23 @@ And then execute:
 bundle
 ```
 
-Or install it yourself as:
+### With Rails
+
+Once installed, run
 
 ```sh
-gem install eddy
+rails g eddy:install eddy:migration
+rails db:migrate
 ```
 
+## Validation
+
+- Ensures mandatory elements have assigned an value.
+- Ensures values passed to `ID` elements are included in the associated code list.
+- Accepts `Time#utc` objects for `DT` and `TM` elements.
+- Makes sure element values aren't set above `max` length.
+- Pads strings and numbers to ensure `min` length is met.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/tcd/eddy.
@@ -38,6 +51,22 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/tcd/ed
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
+## Dependencies
+
+- [tcd/ginny](https://github.com/tcd/ginny)
+    - [tcd/coolkit](https://github.com/tcd/coolkit)
+    - [dry-rb/dry-inflector](https://github.com/dry-rb/dry-inflector)
+- [davishmcclurg/json_schemer](https://github.com/davishmcclurg/json_schemer)
+    - [gjtorikian/ecma-re-validator](https://github.com/gjtorikian/ecma-re-validator)
+        - [ammar/regexp_parser](https://github.com/ammar/regexp_parser)
+    - [tenderlove/hana](https://github.com/tenderlove/hana)
+    - [hannesg/uri_template](https://github.com/hannesg/uri_template)
+    - [ammar/regexp_parser](https://github.com/ammar/regexp_parser)
+- [erikhuda/thor](https://github.com/erikhuda/thor)
+- [piotrmurach/pastel](https://github.com/piotrmurach/pastel)
+    - [piotrmurach/equatable](https://github.com/piotrmurach/equatable)
+    - [piotrmurach/tty-color](https://github.com/piotrmurach/tty-color)
+
 ## Alternatives (in Ruby)
 
 - [irobayna/stupidedi](https://github.com/irobayna/stupidedi) - Ruby API for parsing and generating ASC X12 EDI transactions