sub_string 1.0.2 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f24f4330db4751b15479abc163eeb99fa4eb124f51d2cfc6f1aa2c0b16f254e
-  data.tar.gz: 5830d4ec1033b1ba826d0d3dc1d0eaf6eb7b28570d1bdc2dc8989dda55f9aea2
+  metadata.gz: be037dc9ea050057d431c3c5802fd2f68bed5cfa9784608b7838c8edff615240
+  data.tar.gz: b69983867ce0acd0bd43f13897c9440a6933970f42b8bd94640074960d21895e
 SHA512:
-  metadata.gz: d6175f5ec4bf07a048cb8abc5a8924e2ae7f55a0af85fbc55f6b1e988f88d1af8c6bd73130b84bd1b4a8b6138a421a2784bf428ddef3e5ffe204fac453389c82
-  data.tar.gz: e4bb38538824eaecab3962d13144daae32db992122216d70dc0a6cd73a60bbf01f6f56a4f5f54e13a7f4aa54b25bb8f5c4a9155cdd5daefddcc5390c87522d12
+  metadata.gz: 7531ec47934fcfdde76d82dcc3bd171d5550d3be4fa9df127a31e1d8e142932a39e7730829c1bf81183749b3b7b3c2aed37f403452654273f02c3198e14b8c35
+  data.tar.gz: fa87ab5c861b9e5c5436e32a4f329a0957d3d80e20ba04871f9bf21c886b17e9edbeaf9f4698bf5195314110b4912ad6c1ec419cd4750f7c6771892e15cd5a97

data/ChangeLog

@@ -1,3 +1,8 @@
+-----
+(Version: 1.1)
+2019-11-09  Masa Sakano
+  * No changes in code but follows the update of the parent SubObject, which added attr getter/setter.
+
 -----
 (Version: 1.0.2)
 2019-11-07  Masa Sakano

data/Makefile

@@ -20,5 +20,5 @@ test:
 
 ## yard2md_afterclean in Gem plain_text https://rubygems.org/gems/plain_text
 doc:
-	yard doc; [[ -x ".github" && ( "README.en.rdoc" -nt ".github/README.md" ) ]] && ( ruby -r rdoc -e 'puts RDoc::Markup::ToMarkdown.new.convert ARGF.read' < README.en.rdoc | yard2md_afterclean > .github/README.md ; echo ".github/README.md is updated." ) || exit 0
+	yard doc; [[ -x ".github" && ( "README.en.rdoc" -nt ".github/README.md" ) ]] && ( ruby -r rdoc -e 'puts RDoc::Markup::ToMarkdown.new.convert ARGF.read' < README.en.rdoc | yard2md_afterclean > .github/README.md.$$ && ( mv -f .github/README.md.$$ .github/README.md && echo ".github/README.md is updated." ) || ( echo "ERROR: failed to create .github/README.md" >&2 ) ) || exit 0
 

data/README.en.rdoc

@@ -3,7 +3,8 @@
 
 == Summary
 
-Class {SubString} that expresses Ruby sub-String but taking up negligible memory space, as its instance holds the positional information only.  It behaves exactly like String (duck-typing), except destructive modification is prohibited.  If the original string is destructively modified, warning is issued.
+Class {SubString} that expresses Ruby sub-String but taking up negligible memory space, as its instance holds the positional information only.  It behaves exactly like String (duck-typing), except destructive modification is prohibited.  If the original string is destructively modified, warning is issued.  Also, as a bonus, an
+arbitrary object can be associated with instances of this class with +SubString#attr+.
 
 On the surface, this is a String version of the class MatchSkeleton
 {match_skeleton}[https://rubygems.org/gems/match_skeleton] (also in 
@@ -26,7 +27,7 @@ in {Github}[https://github.com/masasakano/sub_string]
 This class takes three parameters in the initialization: *source*, *pos*
 (starting positional character-index), and *size* (of the substring of the original String *source*.
 
-  SubObject.new( source, position, size )
+  SubString.new( source, index1, index2, attr: arbitrary_object )
 
 The constructed instance of this class keeps only these three pieces
 of information (plus a hash value, strictly speaking), and hence uses negligible internal memory space on its own.
@@ -43,6 +44,12 @@ sub-String object:
 and works exactly like *source*
 ({duck-typing}[https://en.wikipedia.org/wiki/Duck_typing]).
 
+Note +attr+ option is optional and to set an arbitrary object as an
+instance variable.  The default value is nil. It can be
+reset any time later with the setter method of +SubString#attr=+.
+To store an arbitrary number of pieces of information, a Hash instance
+would be convenient.
+
 As an example, the child class {SubString}[http://rubygems.org/gems/sub_string] (provided as a different Gem)
 works as:
 
@@ -61,13 +68,16 @@ as the instance is alive, the source object is never garbage-collected (GC).
 
 === Instance methods
 
-The following is the instance methods of {SubObject}[http://rubygems.org/gems/sub_object] unique to this class.
+The following is the instance methods of this class that do not exist in String.  All are
+inherited from the parent {SubObject}[http://rubygems.org/gems/sub_object] class.
 
 +#source()+::  Returns the first argument (+source+ String) given in initialization. The returned value is dup-ped and **frozen**.
 +#pos()+::  Returns the second argument (positional index) given in initialization.
 +#subsize()+::  Returns the third argument (size) given in initialization.  Equivalent to the method +#size+.
 +#pos_size()+::  Returns the two-component array of +[pos, subsize]+
 +#to_source()+::  Returns the instance projected with +to_src+
++#attr=()+::  Setter of the user-defined instance variable.
++#attr()+::  Getter of the user-defined instance variable.  The default is nil.
 
 In addition, +#inspect+ is redefined.
 
@@ -91,6 +101,11 @@ program applied to a huge text document with a complex grammar may
 hold a number of such String variables.  By using this class instead
 of String, it can save some valuable memory.
 
+Note this class also offers a function to associate an arbitrary
+object with it with the setter and getter methods of +SubString#attr=+ and +SubString#attr+
+(which are inherited methods from the parent class {SubObject}[http://rubygems.org/gems/sub_object]
+like the others).
+
 === Warning about destructive methods to this instance or worse, to the source
 
 If the source object has been destructively altered, such as with the
@@ -138,8 +153,8 @@ However if you want to suppress the warning message, set the Ruby
 global variable +$VERBOSE+ to nil.  Alternatively, you can control it with
 a class instance variable as
 
-  SubObject.verbose       # => getter
-  SubObject.verbose=true  # => setter
+  SubString.verbose       # => getter
+  SubString.verbose=true  # => setter
 
 If it is set either TRUE or FALSE, this verbosity level has a
 priority, regardless of the value of +$VERBOSE+.
@@ -149,7 +164,7 @@ In default it is nil and $VERBOSE is referred to.
 == Install
 
 This script requires {Ruby}[http://www.ruby-lang.org] Version 2.0
-or above.  And this library depends on {SubObject (sub_object)}[https://rubygems.org/gems/sub_object], which you can
+or above.  Also, all this library depends on {SubObject (sub_object)}[https://rubygems.org/gems/sub_object], which you can
 find in RubyGems.
 
 You can install the packages of both this library and SubObject with the usual Ruby gem command.

data/sub_string.gemspec

@@ -5,7 +5,7 @@ require 'date'
 
 Gem::Specification.new do |s|
   s.name = 'sub_string'.sub(/.*/){|c| (c == File.basename(Dir.pwd)) ? c : raise("ERROR: s.name=(#{c}) in gemspec seems wrong!")}
-  s.version = "1.0.2".sub(/.*/){|c| fs = Dir.glob('changelog{,.*}', File::FNM_CASEFOLD); raise('More than one ChangeLog exist!') if fs.size > 1; warn("WARNING: Version(s.version=#{c}) already exists in #{fs[0]} - ok?") if fs.size == 1 && !IO.readlines(fs[0]).grep(/^\(Version: #{Regexp.quote c}\)$/).empty? ; c }  # n.b., In macOS, changelog and ChangeLog are identical in default.
+  s.version = "1.1".sub(/.*/){|c| fs = Dir.glob('changelog{,.*}', File::FNM_CASEFOLD); raise('More than one ChangeLog exist!') if fs.size > 1; warn("WARNING: Version(s.version=#{c}) already exists in #{fs[0]} - ok?") if fs.size == 1 && !IO.readlines(fs[0]).grep(/^\(Version: #{Regexp.quote c}\)$/).empty? ; c }  # n.b., In macOS, changelog and ChangeLog are identical in default.
   # s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   # s.bindir = 'bin'
   # %w(sub_string).each do |f|
@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   #   File.executable?(path) ? s.executables << f : raise("ERROR: Executable (#{path}) is not executable!")
   # end
   s.authors = ["Masa Sakano"]
-  s.date = %q{2019-11-07}.sub(/.*/){|c| (Date.parse(c) == Date.today) ? c : raise("ERROR: s.date=(#{c}) is not today!")}
+  s.date = %q{2019-11-09}.sub(/.*/){|c| (Date.parse(c) == Date.today) ? c : raise("ERROR: s.date=(#{c}) is not today!")}
   s.summary = %q{Duck-typed String class with negligible memory use}
   s.description = <<-EOF
     Class SubString that expresses Ruby sub-String but taking up negligible memory space, as its instance holds the positional information only.  It behaves exactly like String (duck-typing), except destructive modification is prohibited.  If the original string is destructively altered, warning is issued.
@@ -37,7 +37,7 @@ Gem::Specification.new do |s|
   }
   s.files.reject! { |fn| File.symlink? fn }
 
-  s.add_runtime_dependency 'sub_object', '>= 1.0'
+  s.add_runtime_dependency 'sub_object', '>= 1.1'
   # s.add_development_dependency "bourne", [">= 0"]  # '~> 2.0' to mean for only 2.0.x
   s.homepage = "https://www.wisebabel.com"
   s.rdoc_options = ["--charset=UTF-8"]  # "-e UTF-8" is now Default...

data/test/test_sub_string.rb

@@ -106,6 +106,17 @@ class TestUnitSubString < MiniTest::Test
     assert_equal '..."'+"\n", err[-5..-1]
     assert_equal  60, (err.split(']')[-1].size-4)/10.0.round*10
     assert_equal 120, siz
+
+    # Tests of attr
+    assert_nil   obj.attr
+    str = 'abcdefghijklm'*20
+    obj = SubString.new str, 0, 120, attr: 5
+    assert_equal  5, obj.attr
+    hs = Hash[{ try: 67 }]
+    obj.attr = hs
+    assert_equal hs, obj.attr
+    obj.attr[:try] = 89
+    assert_equal 89, obj.attr[:try]
   end
 
   # As in README.en.rdoc

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sub_string
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: '1.1'
 platform: ruby
 authors:
 - Masa Sakano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-07 00:00:00.000000000 Z
+date: 2019-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sub_object
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
 description: "    Class SubString that expresses Ruby sub-String but taking up negligible
   memory space, as its instance holds the positional information only.  It behaves
   exactly like String (duck-typing), except destructive modification is prohibited.