plain_text 0.3 → 0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e93dc475c0c5f66817fbe63e6824f1ec9d1a36c487126548eec0dead4dfde3f4
-  data.tar.gz: e7e64d6aa8dd28ea282cd11f0bfc7d0a55476735ec9b6e7db7a638a48e0457d8
+  metadata.gz: e0bbafc2df85dc7fab4a71b03126805e7f2e9916ae0e3fee91e31d9584e5a6ee
+  data.tar.gz: b385be9df6ce8d8c1081a8c5a233daaa60659ccc25c44722c4a333d8cb81a8c0
 SHA512:
-  metadata.gz: e877ab86109aaf3078990ae1ac55f534026ae8ff941f22af38e39d6655356ed9b5a1f69d4d1f7cfc05efcf812e29efe185dba94e97db88c5383d49eb6b487579
-  data.tar.gz: c2cbd7f86fd1779ab0cd18136a44680f58fce87f3c9c8068e8ef7a5c049ed40d47f2a0614f169902780a9a362a0a6bf46fee7f626ef74cf94fb2425266bac1a1
+  metadata.gz: c3fb2676c18ad0f3e637fc4bac35af7b7fba6d664c852265cd59485d0909dd4e6739c8a4dc12257016472ef31ac8719ed85be061abfe9955a4adf5fcb8b16d29
+  data.tar.gz: dfa034f4130c02aa7ba12817da0395b78f5d6dfcfd349a80966a20e8aa98652ec4c2d2b8c4762b65d25dbfbe39244c2375663085b2189077a04a732300ca6dc7

data/ChangeLog

@@ -1,3 +1,8 @@
+-----
+(Version: 0.4)
+2019-10-29  Masa Sakano
+  * Changed the names in PlainText::Part.(map|each)_boundaries_* to boundary, and similarly parts to part
+
 -----
 (Version: 0.3)
 2019-10-27  Masa Sakano

data/README.en.rdoc

@@ -29,7 +29,7 @@ which is the heart to describe the logical structure of documents.
 It is basically a container class and indeed a sub-class of Array. It
 can contain either of another {PlainText::Part} or more basic
 components of either of {PlainText::Part::Paragraph} and
-{PlainText::Part::Boundary}, both of which are sub-classes of String. 
+{PlainText::Part::Boundary}, both of which are sub-classes of String.
 
 An example instance looks like this:
 
@@ -63,7 +63,7 @@ where the name of subclasses (or constants) here arbitrary, except for
 {PlainText::Part::Paragraph::Empty} and
 {PlainText::Part::Boundary::Empty}, which are pre-defined. Users can
 define their own subclasses to help organize the logical structure at
-their will. 
+their will.
 
 Basically, at every layer, every {PlainText::Part} or
 {PlainText::Part::Paragraph} is sandwiched by
@@ -75,7 +75,7 @@ String instance any time.
 === PlainText::ParseRule - Class to describe the rule of how to parse
 
 {PlainText::ParseRule} is the class to describe how to parse initially
-String, and subsequently {PlainText::Part}, which is basically an Array. 
+String, and subsequently {PlainText::Part}, which is basically an Array.
 {PlainText::ParseRule} is a container class and holds a set of ordered
 rules, each of which is either Proc or Regexp as a more simple rule.
 A rule, Proc, is defined by a user and is designed to receive either

data/lib/plain_text/parse_rule.rb

@@ -280,7 +280,7 @@ module PlainText
     # Set (or reset) a human-readable name for {#rules} at a specified index
     #
     # @param name [NilClass, #to_s] nil to reset or a human-readable name, usually either String or Symbol
-    # @param index [Integer] Index for {#rules}. A negative index is allowed.
+    # @param index_rules [Integer] Index for {#rules}. A negative index is allowed.
     # @return [Integer] Non-negative index where name is set; i.e., if index=-1 is specified for {#rules} with a size of 3, the returned value is 2 (the last index of it).
     def set_name_at(name, index_rules)
       index = PlainText::Util.positive_array_index_checked(index_rules, @rules, accept_too_big: false, varname: 'rules')

data/lib/plain_text/part.rb

@@ -160,10 +160,10 @@ module PlainText
     # The indices provided in this method are for the main Array,
     # and hence different from {#boundaries}.each_with_index
     #
-    # @param (see #map_boundaries_with_index)
+    # @param (see #map_boundary_with_index)
     # @return as self
-    def each_boundaries_with_index(**kwd, &bl)
-      map_boundaries_core(map: false, with_index: true, **kwd, &bl)
+    def each_boundary_with_index(**kwd, &bl)
+      map_boundary_core(map: false, with_index: true, **kwd, &bl)
     end
 
     # each method for parts only, providing also the index (always an even number) to the block.
@@ -176,10 +176,10 @@ module PlainText
     # The indices provided in this method are for the main Array,
     # and hence different from {#parts}.each_with_index
     #
-    # @param (see #map_parts_with_index)
+    # @param (see #map_part_with_index)
     # @return as self
-    def each_parts_with_index(**kwd, &bl)
-      map_parts_core(map: false, with_index: false, **kwd, &bl)
+    def each_part_with_index(**kwd, &bl)
+      map_part_core(map: false, with_index: false, **kwd, &bl)
     end
 
     # The first significant (=non-empty) element.
@@ -248,16 +248,16 @@ module PlainText
     # @option recursive: [Boolean] if true (Default), map is performed recursively.
     # @return as self
     # @see #initialize for the other options (:compact and :compacter)
-    def map_boundaries(**kwd, &bl)
-      map_boundaries_core(with_index: false, **kwd, &bl)
+    def map_boundary(**kwd, &bl)
+      map_boundary_core(with_index: false, **kwd, &bl)
     end
 
     # map method for boundaries only, providing also the index (always an odd number) to the block, returning a copied self.
     #
-    # @param (see #map_boundaries)
+    # @param (see #map_boundary)
     # @return as self
-    def map_boundaries_with_index(**kwd, &bl)
-      map_boundaries_core(with_index: true, **kwd, &bl)
+    def map_boundary_with_index(**kwd, &bl)
+      map_boundary_core(with_index: true, **kwd, &bl)
     end
 
     # map method for parts only, returning a copied self.
@@ -271,16 +271,16 @@ module PlainText
     # @option recursive: [Boolean] if true (Default), map is performed recursively.
     # @return as self
     # @see #initialize for the other options (:compact and :compacter)
-    def map_parts(**kwd, &bl)
-      map_parts_core(with_index: false, **kwd, &bl)
+    def map_part(**kwd, &bl)
+      map_part_core(with_index: false, **kwd, &bl)
     end
 
     # map method for parts only, providing also the index (always an even number) to the block, returning a copied self.
     #
-    # @param (see #map_parts)
+    # @param (see #map_part)
     # @return as self
-    def map_parts_with_index(**kwd, &bl)
-      map_parts_core(with_index: false, **kwd, &bl)
+    def map_part_with_index(**kwd, &bl)
+      map_part_core(with_index: false, **kwd, &bl)
     end
 
     # Normalize the content, making sure it has an even number of elements
@@ -387,7 +387,7 @@ module PlainText
     def squash_boundary_at!(index)
       (i_pos = get_valid_ipos_for_boundary(index)) || return
       prt = self[i_pos-1]
-      m = :emptify_last_boundaries!
+      m = :emptify_last_boundary!
       self[i_pos] << prt.public_send(m) if prt.class.method_defined? m
       self[i_pos]
     end
@@ -397,7 +397,7 @@ module PlainText
     #
     # @return [self]
     def squash_boundaryies!
-      each_boundaries_with_index do |ec, i|
+      each_boundary_with_index do |ec, i|
         squash_boundary_at!(i)
       end
       self
@@ -628,7 +628,7 @@ module PlainText
       ret = super
 
       # The result may not be in an even number anymore.  Correct it.
-      push Boundary.new("") if size.odd?
+      Boundary.insert_original_b4_part(size, "") if size.odd?
 
       # Original method may fill some part of the array with String or even nil.  
       normalize!
@@ -772,7 +772,7 @@ module PlainText
     # Emptifies all the Boundaries immediately before the index and squashes it to the one at it.
     #
     # @return [Boundary] all the descendants' last Boundaries merged.
-    def emptify_last_boundaries!
+    def emptify_last_boundary!
       return Boundary::Empty.dup if size == 0
       ret = ""
       ret << prt.public_send(__method__) if prt.class.method_defined? __method__
@@ -780,7 +780,7 @@ module PlainText
       self[-1] = Boundary::Empty.dup
       ret
     end
-    private :emptify_last_boundaries!
+    private :emptify_last_boundary!
 
 
     # Returns a positive Integer index guaranteed to be 1 or greater and smaller than the size.
@@ -795,13 +795,13 @@ module PlainText
     private :get_valid_ipos_for_boundary
 
 
-    # Core routine for {#map_boundaries} and similar.
+    # Core routine for {#map_boundary} and similar.
     #
     # @option map opts: [Boolean] if true (Default), map is performed. Else just each.
     # @option with_index: [Boolean] if true (Default: false), yield with also index
     # @option recursive: [Boolean] if true (Default), map is performed recursively.
     # @return as self if map: is true, else void
-    def map_boundaries_core(map: true, with_index: false, recursive: true, **kwd, &bl)
+    def map_boundary_core(map: true, with_index: false, recursive: true, **kwd, &bl)
       ind = -1
       arnew = map{ |ec|
         ind += 1
@@ -815,16 +815,16 @@ module PlainText
       }
       self.class.new arnew, recursive: recursive, **kwd if map
     end
-    private :map_boundaries_core
+    private :map_boundary_core
 
-    # Core routine for {#map_parts}
+    # Core routine for {#map_part}
     #
     # @option map: [Boolean] if true (Default), map is performed. Else just each.
     # @option with_index: [Boolean] if true (Default: false), yield with also index
     # @option recursive: [Boolean] if true (Default), map is performed recursively.
     # @return as self
     # @see #initialize for the other options (:compact and :compacter)
-    def map_parts_core(map: true, with_index: false, recursive: true, **kwd, &bl)
+    def map_part_core(map: true, with_index: false, recursive: true, **kwd, &bl)
       ind = -1
       new_parts = parts.map{ |ec|
         ind += 1
@@ -836,7 +836,7 @@ module PlainText
       }
       self.class.new new_parts, boundaries, recursive: recursive, **kwd if map
     end
-    private :map_parts_core
+    private :map_part_core
 
     # Core routine for {#normalize!} and {#normalize}
     #

data/lib/plain_text.rb

@@ -303,7 +303,7 @@ module PlainText
     # Boundary
     case boundary_style
     when String
-      prt.each_boundaries_with_index{|ec, i| ((i == prt.size - 1) && ec.empty?) ? ec : ec.replace(boundary_style)}
+      prt.each_boundary_with_index{|ec, i| ((i == prt.size - 1) && ec.empty?) ? ec : ec.replace(boundary_style)}
     when :truncate,  :t
       prt.boundaries.each{|ec| ec.gsub!(/[[:blank:]]+/m, ""); ec.gsub!(/\n+{3,}/m, "\n\n")}
     when :truncate2, :t2
@@ -502,7 +502,7 @@ module PlainText
     prt.parts.each do |e_pa|
       # Each line treated as a Paragraph, and [[:space:]]+ between them as a Boundary.
       # Then, to work on anything within a line except for line-head/tail is easy.
-      prt_para = Part.parse(e_pa, rule: ParseRule::RuleEachLineStrip).map_parts { |e_li|
+      prt_para = Part.parse(e_pa, rule: ParseRule::RuleEachLineStrip).map_part { |e_li|
         case sps_style
         when :truncate, :t
           e_li.gsub(/[[:blank:]]{2,}/m, " ")
@@ -513,7 +513,7 @@ module PlainText
         else
           raise ArgumentError
         end
-      } # map_parts
+      } # map_part
       e_pa.replace prt_para.join
     end
   end

data/plain_text.gemspec

@@ -5,7 +5,7 @@ require 'date'
 
 Gem::Specification.new do |s|
   s.name = %q{plain_text}.sub(/.*/){|c| (c == File.basename(Dir.pwd)) ? c : raise("ERROR: s.name=(#{c}) in gemspec seems wrong!")}
-  s.version = "0.3"
+  s.version = "0.4"
   # s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   %w(countchar textclean head.rb tail.rb).each do |f|
     path = s.bindir+'/'+f
@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   end
   s.bindir = 'bin'
   s.authors = ["Masa Sakano"]
-  s.date = %q{2019-10-27}.sub(/.*/){|c| (Date.parse(c) == Date.today) ? c : raise("ERROR: s.date=(#{c}) is not today!")}
+  s.date = %q{2019-10-29}.sub(/.*/){|c| (Date.parse(c) == Date.today) ? c : raise("ERROR: s.date=(#{c}) is not today!")}
   s.summary = %q{Module to handle Plain-Text}
   s.description = %q{This module provides utility functions and methods to handle plain text, classes Part/Paragraph/Boundary to represent the logical structure of a document and ParseRule to describe the rules to parse plain text to produce a Part-type Ruby instance.}
   # s.email = %q{abc@example.com}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plain_text
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '0.4'
 platform: ruby
 authors:
 - Masa Sakano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-27 00:00:00.000000000 Z
+date: 2019-10-29 00:00:00.000000000 Z
 dependencies: []
 description: This module provides utility functions and methods to handle plain text,
   classes Part/Paragraph/Boundary to represent the logical structure of a document