sub_string 1.1 → 1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be037dc9ea050057d431c3c5802fd2f68bed5cfa9784608b7838c8edff615240
-  data.tar.gz: b69983867ce0acd0bd43f13897c9440a6933970f42b8bd94640074960d21895e
+  metadata.gz: 4a09c6fbaa026b755be6a24a94173f329d29f05695abc7de8ebc135b0cfa8c59
+  data.tar.gz: 10e9d237218dbe2fe26c987f87617547b85b4469b80692846416ef6f8cae1081
 SHA512:
-  metadata.gz: 7531ec47934fcfdde76d82dcc3bd171d5550d3be4fa9df127a31e1d8e142932a39e7730829c1bf81183749b3b7b3c2aed37f403452654273f02c3198e14b8c35
-  data.tar.gz: fa87ab5c861b9e5c5436e32a4f329a0957d3d80e20ba04871f9bf21c886b17e9edbeaf9f4698bf5195314110b4912ad6c1ec419cd4750f7c6771892e15cd5a97
+  metadata.gz: 53d20271499902491470468848a19129be4ff3e61be0687e1c7d4783c9eacd729b80344505f859f030e5da803e9bceb2c13954a01cdaa22704758d5d3c0be889
+  data.tar.gz: 99b0f5db08ba2aa094beee4bd96b6910dd80bda57079470bd1f15ee947efa3b8fca836b85a5158c7a517f63fad21fd69406470de51e9d826af7e3753ebfb6040

data/ChangeLog

@@ -1,3 +1,8 @@
+-----
+(Version: 1.2)
+2019-11-12  Masa Sakano
+  * Allows the defaults for 2nd, 3rd parameters in initialization. Defined function SubString().
+
 -----
 (Version: 1.1)
 2019-11-09  Masa Sakano

data/README.en.rdoc

@@ -27,14 +27,16 @@ 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*.
 
-  SubString.new( source, index1, index2, attr: arbitrary_object )
+  SubString.new( source, pos=0, size=nil, 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.
-Note that only the information this instance needs for *source* is
-+source.object_id+ or equivalent, which is really negligible in size. 
-In other words, this class does not create the copy of sub-Object from
-the original source object as the Ruby default +String#[ i, j ]+ does.
+of information, plus user-supplied instance-specific additional
+information +attr+, (plus a hash value, strictly speaking), and hence uses negligible internal memory space on its own,
+unlike the Ruby default +String#[ i, j ]+ .
+
+Note that the default of +pos+ is 0, and negative values are allowed
+for it just like +String#[ -2, 1 ]+ .   If the size is unspecified,
+the maximum possible size for +source+ counted from +pos+ is used.
 
 Then, whenever it is referred to, it reconstructs the original
 sub-String object:
@@ -54,7 +56,8 @@ As an example, the child class {SubString}[http://rubygems.org/gems/sub_string]
 works as:
 
   src = "abcdef"
-  ss = SubString.new(src, -4, 3)  # => Similar to "abcdef"[-4,3]
+  ss = SubString(src, -4, 3, attr: (5..6)) # => Short form of SubString.new()
+               # => Similar to "abcdef"[-4,3]
   print ss     # => "cde" (STDOUT)
   ss+'3p'      # => "cde3p"
   ss.upcase    # => "CDE"
@@ -62,6 +65,7 @@ works as:
   ss.is_a?(String)  # => true
   "xy_"+ss     # => "xy_cde"
   "cde" == ss  # => true
+  ss.attr      # => (5..6)  # user-specified instance-specific additional information
 
 Internally the instance holds the source object.  Therefore, as long
 as the instance is alive, the source object is never garbage-collected (GC).
@@ -172,20 +176,22 @@ Or, alternatively, download them and put the library files in one of your Ruby l
 
 == Developer's note
 
-The master of this README file is found in
-{RubyGems/sub_object}[https://rubygems.org/gems/sub_object]
+The master of this README file as well as the entire package is found in
+{RubyGems/sub_string}[https://rubygems.org/gems/sub_string]
 
-ChangeLog is found in {Github}[https://github.com/masasakano/sub_string/blob/master/ChangeLog]
+The source code is maintained also in
+{Github}[https://github.com/masasakano/sub_string] with no intuitive
+interface for annotation but with easily-browsable {ChangeLog}[https://github.com/masasakano/sub_string/blob/master/ChangeLog]
 
 === Tests
 
-Ruby codes under the directory <tt>test/</tt> are the test scripts.
+The Ruby codes under the directory <tt>test/</tt> are the test scripts.
 You can run them from the top directory as <tt>ruby test/test_****.rb</tt>
 or simply run <tt>make test</tt>.
 
 == Known bugs and Todo items
 
-* This class ignores any optional (keyword) parameters for the methods.  It is due to the fact Ruby {BasicObject#method_missing}[https://ruby-doc.org/core-2.6.5/BasicObject.html#method-i-method_missing] does not take them into account as of Ruby-2.6.5.  It may change in future versions of Ruby. As far as the Ruby built-in methods of String are concerned, it does not matter because none of them uses one.  However, if String uses such user-defined methods, it may encounter a trouble.
+* This class ignores any optional (keyword) parameters for the methods of the original String class.  It is due to the fact Ruby {BasicObject#method_missing}[https://ruby-doc.org/core-2.6.5/BasicObject.html#method-i-method_missing] does not take them into account as of Ruby-2.6.5.  It may change in future versions of Ruby. As far as the Ruby built-in methods of String are concerned, it does not matter because none of them uses one.  However, if String has methods of this kind defined by a user or in external library, it may encounter a trouble.
 
 
 == Copyright

data/lib/sub_string.rb

@@ -15,8 +15,32 @@ require 'sub_object'  # Gem: {SubObject}[http://rubygems.org/gems/sub_object]
 #
 class SubString < SubObject
   # Symbol of the method that projects to (returns) the original-like instance;
-  # e.g., :to_str for String. The value should be overwritten in the child class of SubObject.
+  # e.g., :to_str for String. The value should be overwritten in the child class of {SubObject}, namely this class {SubString} in this case.
   TO_SOURCE_METHOD = :to_str
   alias_method TO_SOURCE_METHOD, :to_source
+
+  # Returns a new instance of SubString equivalent to source[ pos, size ]
+  #
+  # Difference from the original SubObject is the defaults are set for
+  # the second and third parameters.
+  #
+  # If the third parameter is nil, it is set as the maximum size possible
+  # counted from pos (the starting position)
+  #
+  # @param source [String]
+  # @param pos [Integer] Starting character index position.
+  # @param size [Integer, nil] Size of the substring to make.
+  # @param attr: [Object] user-specified arbitrary object
+  def initialize(source, pos=0, size=nil, attr: nil)
+    size ||= ((pos >= 0) ? source.size - pos : -pos)
+    super source, pos, size, attr: attr
+  end
+end
+
+# Function version of {SubString#initialize}
+#
+# @param (see SubString#initialize)
+def SubString(*rest, **kwd)
+  SubString.new(*rest, **kwd)
 end
 

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.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.version = "1.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.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-09}.sub(/.*/){|c| (Date.parse(c) == Date.today) ? c : raise("ERROR: s.date=(#{c}) is not today!")}
+  s.date = %q{2019-11-12}.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.
@@ -38,7 +38,8 @@ Gem::Specification.new do |s|
   s.files.reject! { |fn| File.symlink? fn }
 
   s.add_runtime_dependency 'sub_object', '>= 1.1'
-  # s.add_development_dependency "bourne", [">= 0"]  # '~> 2.0' to mean for only 2.0.x
+
+  s.add_development_dependency "plain_text", [">= 0.6"]
   s.homepage = "https://www.wisebabel.com"
   s.rdoc_options = ["--charset=UTF-8"]  # "-e UTF-8" is now Default...
 

data/test/test_sub_string.rb

@@ -117,12 +117,32 @@ class TestUnitSubString < MiniTest::Test
     assert_equal hs, obj.attr
     obj.attr[:try] = 89
     assert_equal 89, obj.attr[:try]
+
+    # Tests of default
+    str = 'abcdefghijklm'*20
+    obj = SubString.new str
+    assert_equal str.size, obj.size
+    assert_equal str.size, obj.subsize
+    assert_equal str, obj
+
+    obj = SubString.new str, attr: 6
+    assert_equal  6, obj.attr
+
+    obj = SubString.new str, 1
+    assert_equal str.size, obj.size+1
+    assert_equal str.size, obj.subsize+1
+    assert_equal str[1..-1], obj
+
+    obj = SubString.new str, -2
+    assert_equal 2, obj.size
+    assert_equal 2, obj.subsize
+    assert_equal str[-2..-1], obj
   end
 
-  # As in README.en.rdoc
+  # As in README.en.rdoc (also tests of SubString() as opposed to SubString.new)
   def test_sub_string03
     src = "abcdef"
-    ss = SubString.new(src, -4, 3)  # => Similar to "abcdef"[-4,3]
+    ss = SubString(src, -4, 3, attr: (5..6))  # => Similar to "abcdef"[-4,3]
     assert_operator "cde", '==', ss
     assert_equal "cde",    ss.to_s
     assert_equal "cde3p",  ss+'3p'
@@ -130,6 +150,7 @@ class TestUnitSubString < MiniTest::Test
     assert_equal "Qde",    ss.sub(/^./, 'Q')
     assert                 ss.is_a?(String)
     assert_equal "xy_cde", "xy_"+ss
+    assert_equal (5..6),   ss.attr
   end
 end # class TestUnitSubString < MiniTest::Test
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sub_string
 version: !ruby/object:Gem::Version
-  version: '1.1'
+  version: '1.2'
 platform: ruby
 authors:
 - Masa Sakano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-09 00:00:00.000000000 Z
+date: 2019-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sub_object
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: plain_text
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
 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.