eddy 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54eb94b693f0ba6522fb7acdaddd77d3f84c82519f53f8cef07b1f7d67ebf556
-  data.tar.gz: 8baff248f6b4dfc3a52a62592540539998619d7244a6c5675ade29f60ff20eae
+  metadata.gz: 24f85e2d1206326cc6a732032561eadf89c12c948ea2adfa1c83381cbff2a347
+  data.tar.gz: 371950e447ceb6b39f75240410e649ad3271e821f2e949ffed583846388b3070
 SHA512:
-  metadata.gz: 870298adcb6cab4c53100d6094edb4a1a028048fcf0cfbe49cc2977aca8412df192bca48edf15bf6a30efb0141d3cd45ea939151466e66dfed1a83647bee1b86
-  data.tar.gz: 60822c6c92d13a0fc96c3d33894417ed70e85cbc908302518dbe567ca6c22ee20b4b07ea3c28cea70323f4fc7565d9c089f64b7bf2baf9133ac24f747b5f7454
+  metadata.gz: 3133afb573c915663da4214f431c97a692bd339fc101f142d3d313b84a7995c8947ddc4d5f992498b8885510dea003d1354cf02d360e9e92137747bb65ac0035
+  data.tar.gz: f4d9957a4cf3eca9606e762f99e01a76116d3611e5f021d5046be2d789e238689dd9ff1a9ac9de1d078f507377037039c8980625b063d55fdd5492d0f68a31ba

data/CHANGELOG.md

@@ -13,6 +13,16 @@ 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.5.1 (2020-01-06)
+
+### Changed
+
+- Rename variable `loop_id` to `id`.
+
+### Fixed
+
+- Fix YARD issues.
+
 ## 0.5.0 (2020-01-05)
 
 ### Changed

data/Gemfile.lock

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

data/README.md

@@ -10,7 +10,7 @@
 [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.5.0
+[docs]: https://www.rubydoc.info/gems/eddy/0.5.1
 
 ## Installation
 

data/lib/eddy/build/loop_builder.rb

@@ -35,7 +35,7 @@ module Eddy
         return Ginny::Class.create({
           classify_name: false,
           parent: "Eddy::Loop::Base",
-          name: self.summary.loop_id,
+          name: self.summary.id,
           description: summary.doc_comment(header: true),
           body: <<~STR.strip,
             # @param store [Eddy::Data::Store]
@@ -62,7 +62,7 @@ module Eddy
           when Eddy::Schema::SegmentSummary
             comps << "  Eddy::Segments::#{comp.id.upcase},"
           when Eddy::Schema::LoopSummary
-            comps << "  Eddy::TransactionSets::#{t_set_id}::Loops::#{comp.loop_id.upcase},"
+            comps << "  Eddy::TransactionSets::#{t_set_id}::Loops::#{comp.id.upcase},"
           end
         end
         return comps.join("\n  ")
@@ -78,7 +78,7 @@ module Eddy
           when Eddy::Schema::SegmentSummary
             yield_params << "#   @yieldparam [Eddy::Segments::#{comp.id.upcase}] #{comp.id.downcase}"
           when Eddy::Schema::LoopSummary
-            yield_params << "#   @yieldparam [Eddy::TransactionSets::#{t_set_id}::Loops::#{comp.loop_id.upcase}] l_#{comp.loop_id.downcase}"
+            yield_params << "#   @yieldparam [Eddy::TransactionSets::#{t_set_id}::Loops::#{comp.id.upcase}] l_#{comp.id.downcase}"
           end
         end
         return <<~YARD.strip

data/lib/eddy/build/transaction_set_builder.rb

@@ -110,9 +110,9 @@ module Eddy
             decs << "@#{comp.id.downcase} = Eddy::Segments::#{comp.id.upcase}.new(store)\n"
           when Eddy::Schema::LoopSummary
             if comp.repeat == 1
-              decs << "@#{comp.loop_id.downcase} = Eddy::Segments::#{comp.loop_id.upcase}.new(store)\n"
+              decs << "@#{comp.id.downcase} = Eddy::Segments::#{comp.id.upcase}.new(store)\n"
             else
-              decs << "@l_#{comp.loop_id.downcase} = Eddy::TransactionSets::#{self.summary.normalized_name}::Loops::#{comp.loop_id.upcase}.new(store)\n"
+              decs << "@l_#{comp.id.downcase} = Eddy::TransactionSets::#{self.summary.normalized_name}::Loops::#{comp.id.upcase}.new(store)\n"
             end
           end
         end
@@ -129,9 +129,9 @@ module Eddy
             super_call << "  @#{comp.id.downcase},\n"
           when Eddy::Schema::LoopSummary
             if comp.repeat == 1
-              super_call << "  @#{comp.loop_id.downcase},\n"
+              super_call << "  @#{comp.id.downcase},\n"
             else
-              super_call << "  @l_#{comp.loop_id.downcase},\n"
+              super_call << "  @l_#{comp.id.downcase},\n"
             end
           end
         end
@@ -149,7 +149,7 @@ module Eddy
             Eddy::Build::TransactionSetBuilder.segment_accessor(comp.id)
           when Eddy::Schema::LoopSummary
             if comp.repeat == 1
-              Eddy::Build::TransactionSetBuilder.segment_accessor(comp.loop_id)
+              Eddy::Build::TransactionSetBuilder.segment_accessor(comp.id)
             else
               Eddy::Build::TransactionSetBuilder.loop_accessor(comp, self.summary.normalized_name)
             end
@@ -179,8 +179,8 @@ module Eddy
       # @param t_set_name [String]
       # @return [String]
       def self.loop_accessor(summary, t_set_name)
-        upper = summary.loop_id.upcase
-        lower = summary.loop_id.downcase
+        upper = summary.id.upcase
+        lower = summary.id.downcase
         return <<~RB.strip
           # (see Eddy::TransactionSets::#{t_set_name}::Loops::#{upper})
           #
@@ -207,7 +207,7 @@ module Eddy
           when Eddy::Schema::SegmentSummary
             comps << "# @yieldparam [Eddy::Segments::#{comp.id.upcase}] #{comp.id.downcase}"
           when Eddy::Schema::LoopSummary
-            comps << "# @yieldparam [Eddy::TransactionSets::#{t_set_name}::Loops::#{comp.loop_id.upcase}] l_#{comp.loop_id.downcase}"
+            comps << "# @yieldparam [Eddy::TransactionSets::#{t_set_name}::Loops::#{comp.id.upcase}] l_#{comp.id.downcase}"
           end
         end
         return comps.join("\n")

data/lib/eddy/data/store.rb

@@ -20,7 +20,7 @@ module Eddy
       # @return [String] ("~")
       attr_accessor :segment_separator
       # Data Element Separator
-      # @return [String] ("*")
+      # @return [String] ("\*")
       attr_accessor :element_separator
       # QUESTION: is this the same as `component_separator`?
       #
@@ -68,23 +68,17 @@ module Eddy
         self.version_release_industry_id_code = "004010"
       end
 
-      # (see Eddy::Data.new_interchange_control_number)
-      #
       # @return [Integer]
       def interchange_control_number()
         return Eddy::Data.new_interchange_control_number()
       end
 
-      # (see Eddy::Data.new_transaction_set_control_number)
-      #
       # @param transaction_set_id [String]
       # @return [Integer]
       def transaction_set_control_number(transaction_set_id)
         return Eddy::Data.new_transaction_set_control_number(transaction_set_id)
       end
 
-      # (see Eddy::Data.new_interchange_control_number)
-      #
       # @param functional_group [String]
       # @return [Integer]
       def functional_group_control_number(functional_group)

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

@@ -9,8 +9,9 @@ module Eddy
     class Base
 
       # (Name) A unique string used to identify the Loop within its Transaction Set.
+      # This is not EDI standardized, any name will do.
       # @return [String]
-      attr_reader :loop_id
+      attr_reader :id
       # Number of times a particular Loop may be repeated.
       # @return [Integer]
       attr_reader :repeat

data/lib/eddy/parse.rb

@@ -12,13 +12,13 @@ module Eddy
       # @return [String] ("~")
       attr_accessor :segment_separator
       # Data Element Separator
-      # @return [String] ("*")
+      # @return [String] ("\*")
       attr_accessor :element_separator
 
       # @param doc [String] EDI document.
       # @param component_separator [String] (">")
       # @param segment_separator [String] ("~")
-      # @param element_separator [String] ("*")
+      # @param element_separator [String] ("\*")
       # @return [void]
       def initialize(doc, component_separator: ">", segment_separator: "~", element_separator: "*")
         self.document = doc

data/lib/eddy/schema/loop_summary.rb

@@ -5,7 +5,7 @@ module Eddy
 
       # A unique string used to identify the Loop within its Transaction Set.
       # @return [String]
-      attr_accessor :loop_id
+      attr_accessor :id
       # Number of times a particular Loop may be repeated.
       # @return [Integer]
       attr_accessor :repeat
@@ -31,7 +31,7 @@ module Eddy
       # @return [self]
       def self.create(params = {})
         l = LoopSummary.new
-        l.loop_id = params[:loop_id]
+        l.id = params[:loop_id]
         l.repeat = params[:repeat]
         l.notes = params[:notes]
         l.level = params[:level]
@@ -70,7 +70,7 @@ module Eddy
         self.components.each do |comp|
           case comp
           when Eddy::Schema::SegmentSummary then comps << "  - #{comp.id.upcase}\n"
-          when Eddy::Schema::LoopSummary    then comps << "  - #{comp.loop_id.upcase} (loop)\n"
+          when Eddy::Schema::LoopSummary    then comps << "  - #{comp.id.upcase} (loop)\n"
           end
         end
         parts = []

data/lib/eddy/schema/transaction_set_summary.rb

@@ -88,7 +88,7 @@ module Eddy
       #
       # @return [Array<Eddy::Schema::SegmentSummary, Eddy::Schema::LoopSummary>]
       def unique_loops()
-        return self.all_components.select { |c| c.is_a?(Eddy::Schema::LoopSummary) }.uniq(&:loop_id)
+        return self.all_components.select { |c| c.is_a?(Eddy::Schema::LoopSummary) }.uniq(&:id)
       end
 
     end

data/lib/eddy/util/trim.rb

@@ -5,7 +5,7 @@ module Eddy
     # 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 element_separator [String] ("\*")
     # @param segment_separator [String] ("~")
     # @return [String]
     def self.trim_delims_from_interchange(itch, element_separator: "*", segment_separator: "~")
@@ -17,7 +17,7 @@ module Eddy
     # 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] ("*")
+    # @param separator [String] ("\*")
     # @return [String]
     def self.trim_delims_from_segment(segment, separator: "*")
       e_sep = Regexp.escape(separator)

data/lib/eddy/version.rb

@@ -1,3 +1,3 @@
 module Eddy
-  VERSION = "0.5.0".freeze
+  VERSION = "0.5.1".freeze
 end

data/tasks/misc/clean.rake

@@ -0,0 +1,20 @@
+require "eddy"
+require "fileutils"
+
+namespace :misc do
+  desc "Clean up temporary folders in project root"
+  task :clean do
+    dirs = [
+      "build",
+      "coverage",
+      "doc",
+      "tmp",
+      ".yardoc",
+    ].each do |dir|
+      path = File.join(Eddy::Util.root_dir, dir)
+      if File.exist?(path)
+        FileUtils.rm_r(dir)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eddy
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Clay Dunston
@@ -1542,6 +1542,7 @@ files:
 - lib/eddy/util/trim.rb
 - lib/eddy/version.rb
 - tasks/build.rake
+- tasks/misc/clean.rake
 - tasks/misc/gemspec.rake
 - tasks/misc/missing_lists.rake
 - tasks/misc/yaml2json.rake
@@ -1553,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.5.0
+  documentation_uri: https://www.rubydoc.info/gems/eddy/0.5.1
   yard.run: yri
 post_install_message: 
 rdoc_options: []