sub_object 1.0.2 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14346f60c61e9934272e9530515e99e0956658831291d1982a7941f507e30190
-  data.tar.gz: 20eb48e09c3b0287e88f81dc3921f436809dd391a3637eccf47f8c6f1a60d875
+  metadata.gz: 82f0b7dfe21acc55f95a85ede284e7726a2d20b8167933a64f2d19326a603881
+  data.tar.gz: f38d6e5d31d7c2db961bde8324d94f567f50f00ba07deb8c31df45a24cb08471
 SHA512:
-  metadata.gz: ecc193b15d20eaee183536ee892a02150e1e079622b1b8576cd1d3d6aa13c90ba88906348c46ceecdca8f4195274848e1c7c9877f6aa06edacbd2e8cf902c44f
-  data.tar.gz: fd77c5894e90aedda767e588419133840b2628d96faedfdac981eaf444c4ef14ec9964bb87ec6c1316f4e880d3a600534fbec9d76d4039feda77ee47e8485407
+  metadata.gz: 0a0af4d1e49ee3f2eeb91a7394c92e797a2911b08a29d5c515e245bc3568aeb7db507e2ac2893894fda41662b8ed9d75a25ab369967368f265664eecc274984d
+  data.tar.gz: c25e3f02f129a10efc1ae05127cf513f4cb627d4941c0f408cded27b1eade3efd0543dd9c05da09f4cb20e73f30907965303f32732ee4237ade69200114e8053

data/ChangeLog

@@ -1,3 +1,8 @@
+-----
+(Version: 1.1)
+2019-11-09  Masa Sakano
+  * Added attr getter/setter and initializer.
+
 -----
 (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,15 +3,16 @@
 
 == Summary
 
-This class {SubObject} is the parent class for
+This class {SubObject}[http://rubygems.org/gems/sub_object] is the parent class for
 {SubString}[http://rubygems.org/gems/sub_string] and alike.
 This class expresses Ruby sub-Object (like Sub-String),
-which are obtained with the +self[i, j]+ method,
+which are obtained with the +self[ i, j ]+ method,
 but taking up negligible memory space, as its instance internally holds
 the (likely positional, though arbitrary) information +(i, j)+ only.  This class provides the base
 interface so the instance behaves exactly like the original
 class (String for SubString, for example) as duck-typing, except
-destructive modification, which is prohibited.
+destructive modification, which is prohibited.  Also, as a bonus, an
+arbitrary object can be associated with instances of this class with {SubObject#attr}.
 
 If the original object (which an instance of this class refers to) is ever destructively modified in a way it changes
 its hash value, warning will be issued whenever this instance is accessed.
@@ -30,7 +31,7 @@ SubString class) to suit your child class.
   TO_SOURCE_METHOD = :to_str
   alias_method TO_SOURCE_METHOD, :to_source
 
-== Cencept
+== Concept
 
 This class takes three parameters in the initialization: *source*, *pos*
 (position), and *size*.  *source* is the original object, and
@@ -80,10 +81,10 @@ Therefore, whenever a destructive method is applied, this class tries
 to raise NoMethodError exception.  The routine to identify the
 destructive method relies thoroughly on the method name.
 The methods ending with "!" are regarded as destructive.
-Other standard distructive method names are defined in the constant {SubObject::DESTRUCTIVE_METHODS}.
+Other standard destructive method names are defined in the constant {SubObject::DESTRUCTIVE_METHODS}.
 Each child class may add entries or modify it.
 
-Note that if a (likely user-defined) desturctive method passes the check,
+Note that if a (likely user-defined) destructive method passes the check,
 the result is most likely to be different from intended.  It certainly
 never alters this instance destructively (unless +[]+ method of the
 source object returns self, which is against the Ruby convention), and
@@ -108,7 +109,7 @@ according to the length of the sub-String.  Consider an example:
 
 The variable +sub+ uses up about the same memory of +src+.
 If a great number of +sub+ is created and held alive, the total memory
-used by the process can become quicly multifold, even by orders of magnitude.
+used by the process can become quickly multifold, even by orders of magnitude.
 
 This is where this class comes in handy.  For example, a parsing
 program applied to a huge text document with a complex grammar may
@@ -117,9 +118,12 @@ of String, it can save some valuable memory.
 
 That is precisely why
 {SubString}[http://rubygems.org/gems/sub_string],
-which is a child class of this class and for String, is registered as an official Gem.
+which is a child class of this class and for String, is registered as a separate official Gem.
 (In practice, this class is a generalised version of *SubString*,
-which Ruby allows as a flexible programming language!)
+which Ruby allows, being a flexible programming language!)
+
+Note this class also offers a function to associate an arbitrary
+object with it with the setter and getter methods of {SubObject#attr=} and {SubObject#attr}.
 
 == Description
 
@@ -127,12 +131,18 @@ which Ruby allows as a flexible programming language!)
 
 Initialize as follows:
 
-  SubObject.new( source, index1, index2 )
+  SubObject.new( source, index1, index2, attr: your_object )
 
 Usually, +index1+ is the starting index and +index2+ is the size,
 though how they should be recognized depends on the definition of the method
 +[i,j]+ of +source+.
 
++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 {SubObject#attr=}.
+To store an arbitrary number of pieces of information, a Hash instance
+would be convenient.
+
 === Constant
 
 {SubObject::DESTRUCTIVE_METHODS}::  This public constant is the array holding the list of the names (as String) of the methods that should be recognized as destructive (other than those ending with "!").
@@ -141,27 +151,27 @@ though how they should be recognized depends on the definition of the method
 The class variable +TO_SOURCE_METHOD+ is meant to be set by each
 child class (and child classes only).  For example, if it is the subclass for String, it should
 be +:to_str+.  Specifically, the registered method must respond to
-+source[i,j]+. Nott that in this class (parent class), it is **left unset**, but the (private) method of the
++source[i,j]+. Note that in this class (parent class), it is **left unset**, but the (private) method of the
 same name +to_original_method+ returns +:itself+ instead.
 
 *WARNING*: Do not set this class variable in this class, as it could result in unexpected behaviours if
-a child class and the parent class are used simultaneously.
+a child class and this class (parent) are used simultaneously.
 
 
 === Class-global settings and class methods
 
 When this class is accessed after any alteration of the original
-source object has been detected, it may issue warning (as the insntace does not make sense any more).
+source object has been detected, it may issue warning (as the instance does not make sense any more).
 The warning is suppressed when the Ruby global variable +$VERBOSE+ is
 nil (it is false in Ruby default).  Or, if the following setting is
-made (internaly, it sets/reads a class instance variable) and set non-nil,
+made (internally, it sets/reads a class instance variable) and set non-nil,
 its value precedes +$VERBOSE+:
 
   SubObject.verbose       # => getter
   SubObject.verbose=true  # => setter
 
 where SubObject should be replaced with the name of your child class that inherits {SubObject}.
-If this value is true or false, such a warning is issued or suppresed,
+If this value is true or false, such a warning is issued or suppressed,
 respectively, regardless of the value of the global variable +$VERBOSE+.
 
 
@@ -174,6 +184,8 @@ The following is the instance methods of {SubObject} unique to this class.
 +#subsize()+::  Returns the third argument given in initialization (usually meaning the size of the sub-"source").  Usually this is equivalent to the method +#size+; this method is introduced in case the class of the +source+ somehow does not have the +#size+ method.
 +#pos_size()+::  Returns the two-component array of +[pos, subsize]+
 +#to_source()+::  Returns the instance as close as the original +source+ (the class of it, etc).
++#attr=()+::  Setter of the user-defined instance variable.
++#attr()+::  Getter of the user-defined instance variable.  The default is nil.
 
 In addition, {#inspect}[SubObject#inspect] is redefined.
 
@@ -201,7 +213,7 @@ Internally, almost any method that the instance receives, except for those speci
 the following order:
 
 1. {#method_missing}[SubObject#method_missing] (almost any methods except those defined in Object should be processed here)
-   1. +super+ if destuctive (usually NoMethodError, because Object class does not have "destructive" methods, though you may argue +taint+ etc is "destructive")
+   1. +super+ if destructive (usually NoMethodError, because Object class does not have "destructive" methods, though you may argue +taint+ etc is "destructive")
    2. Else, +send+ to {#to_source}[SubObject#to_source]
 2. {#to_source}[SubObject#to_source]
    1. check whether the original {#source}[SubObject#source] has been altered and issues a warning if the conditions are met.

data/lib/sub_object.rb

@@ -81,16 +81,17 @@ class SubObject
   # Starting (character) position
   attr_reader :pos
 
-  # Size of SubObject.  Identical with #size
-  # attr_reader :isize
+  # Setter/Getter of the attribute. nil in default.
+  attr_accessor :attr
 
   # Returns a new instance of SubObject equivalent to source[ pos, size ]
   #
   # @param source [String]
   # @param pos [Integer]
   # @param size [Integer]
-  def initialize(source, pos, size)
+  def initialize(source, pos, size, attr: nil)
     @source, @pos, @isize = source, pos, size
+    @attr = attr
 
     # Sanity check
     begin

data/sub_object.gemspec

@@ -5,7 +5,7 @@ require 'date'
 
 Gem::Specification.new do |s|
   s.name = 'sub_object'.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_object).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{Parent class for memory-efficient sub-Something}
   s.description = %q{Class SubObject that is the parent class for Ruby SubString and SubArray classes and alike, providing the base interface. This and child classes use negligible memory space, as their instance holds the positional information only.  It behaves exactly like the source object (duck-typing), except destructive modification is prohibited.  If the original source object is destructively altered, the corresponding instance can detect it and issue warning.}
   # s.email = %q{abc@example.com}

data/test/test_sub_object.rb

@@ -101,6 +101,7 @@ class TestUnitSubObject < MiniTest::Test
     assert_equal MyC.new(myo.x+2+3), obj.to_source
     assert_equal "SubObject", obj.class.name
     assert_equal "6", obj.to_s
+    assert_nil   obj.attr
     assert            myo.respond_to?(:to_s)
     assert            obj.respond_to?(:to_s)
     assert            myo.respond_to?(:plus1)
@@ -173,6 +174,16 @@ class TestUnitSubObject < MiniTest::Test
       }
     }
     exclu.join
+
+    # Tests of attr
+    myo = MyC.new(1)
+    obj = SubObject.new myo, 2, 3, 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
 
   def test_sub_array01
@@ -184,6 +195,7 @@ class TestUnitSubObject < MiniTest::Test
     assert_equal   2,           obj.subsize
     assert_equal [-3, 2],       obj.pos_size
     assert_equal ary[-3, 2],    obj.to_source
+    assert_nil   obj.attr
     assert_equal :to_ary, SubObject::SubArray::TO_SOURCE_METHOD
     assert_equal :itself, SubObject::TO_SOURCE_METHOD
     assert_raises(TypeError){ SubObject::SubArray.new ary, -3, :a }
@@ -205,6 +217,16 @@ class TestUnitSubObject < MiniTest::Test
     refute            obj.respond_to?(:naiyo)
     assert_raises(NoMethodError){ obj.push 5 }
     assert_raises(NoMethodError){ obj.keep_if{} }
+
+    # Tests of attr
+    ary = [?a, ?b]
+    obj = SubObject::SubArray.new ary, -2, 1, 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
 
 end # class TestUnitSubObject < MiniTest::Test

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sub_object
 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: []
 description: Class SubObject that is the parent class for Ruby SubString and SubArray
   classes and alike, providing the base interface. This and child classes use negligible