sub_object 1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba4fda603b0841fbf226306a1858819a85a733f8c6863c86bcc7091aa3987dbc
-  data.tar.gz: b61a445e22d45c5a35f224e867f04b74ee6a03300fe8cbc705e4771f9cba3d79
+  metadata.gz: cba7eccff10ce8fb7481c89515c1a249457c6cb71bb221f8fea20f5f9de00c20
+  data.tar.gz: 708f9c6c8b60c4b846eed1e5c0c7f682885b311f129105c5c1ced09b850fbc5b
 SHA512:
-  metadata.gz: 0000c9fe5c0d2910ca8b70d63cdabd0e7cf20461c68df7209d75530475eea2ae5d2ccca9b21cfdc20ee48efabca069331d89d92a519e66533d4349adf23939c7
-  data.tar.gz: 701376479f084de002d3bf88adcbb9806ba2fa34a5ff989f3d5d50fffc153fce99e6b82c40a3afa6a56672c35138f23eaaa991026a2e74caedde76ec9b588608
+  metadata.gz: faf7f261efb2304b693a4b9868a4c1d828a2a7dff32630a27b70b387d77fba5c41a8b2e37ad6c3f094ee9f33146d2048c5f46cd6b8b5e691b33dc76af872a7dd
+  data.tar.gz: 735655afd567b92ba9400924aa0ee4ac1841429eceb97ea74cae4281bc1e8e8d23c7165e40efd028ac6c2150ed9f267637fa15a499bd4c0371723a774a3dd410

data/ChangeLog

@@ -0,0 +1,14 @@
+-----
+(Version: 1.0.1)
+2019-11-07  Masa Sakano
+  * Minor update in documentation.
+
+-----
+2019-11-05  Masa Sakano
+  * Correct .github/README.md as auto-conversion from rdoc to md badly failed for the sample code.
+
+-----
+(Version: 1.0)
+2019-11-05  Masa Sakano
+
+ * Initial but pretty much complete commit (Ver.1.0).

data/Makefile

@@ -18,6 +18,7 @@ clean:
 test:
 	rake 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 > .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 ; echo ".github/README.md is updated." ) || exit 0
 

data/README.en.rdoc

@@ -47,7 +47,7 @@ information it needs for the +source+ is basically +source.object_id+
 or equivalent, which is nothing in terms of memory use.
 In other words, this class does
 not create the copy of sub-Object from the original source object, as,
-for example, +String#[i,j]+ does.
+for example, +String#[ i, j ]+ does.
 
 As an example, the child class {SubString}[http://rubygems.org/gems/sub_string] (provided as a different Gem)
 works as:
@@ -97,7 +97,7 @@ perfectly possible; indeed it is defined as {SubObject::SubArray}.
 To be fair, I am afraid *SubArray* class does not have much practical
 value (apart from the demonstration of the concept!), because the only
 advantage of this class is to use the minimum memory, whereas the
-original sub-array as in +Array#[i,j]+ does not take much memory in
+original sub-array as in +Array#[ i, j ]+ does not take much memory in
 the first place, given Array is by definition just a container.
 
 By stark contrast, each sub-String in Ruby default takes up memory
@@ -226,6 +226,8 @@ An example of +SubObject+ with a test class +MyC+, which
 3. has the method +plus1+, which returns its instance variable plus 1,
 4. has the method +dest!+
 
+**Code sample**:
+
   class MyC
     def initialize(a); @x = a; end
     def [](a, b); MyC.new(a+b); end

data/sub_object.gemspec

@@ -4,8 +4,8 @@ require 'rake'
 require 'date'
 
 Gem::Specification.new do |s|
-  s.name = %q{sub_object}.sub(/.*/){|c| (c == File.basename(Dir.pwd)) ? c : raise("ERROR: s.name=(#{c}) in gemspec seems wrong!")}
-  s.version = "1.0"
+  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.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-05}.sub(/.*/){|c| (Date.parse(c) == Date.today) ? c : raise("ERROR: s.date=(#{c}) is not today!")}
+  s.date = %q{2019-11-07}.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}
@@ -47,6 +47,11 @@ Gem::Specification.new do |s|
   # s.requirements << 'libmagick, v6.0' # Simply, info to users.
   # s.rubygems_version = %q{1.3.5}      # This is always set automatically!!
 
+  ## cf. https://guides.rubygems.org/specification-reference/#metadata
   s.metadata["yard.run"] = "yri" # use "yard" to build full HTML docs.
+  s.metadata["changelog_uri"]     = "https://github.com/masasakano/#{s.name}/blob/master/ChangeLog"
+  # s.metadata["source_code_uri"]   = "https://github.com/masasakano/sub_object"
+  # s.metadata["documentation_uri"] = "https://www.example.info/gems/bestgemever/0.0.1"
+
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sub_object
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 1.0.1
 platform: ruby
 authors:
 - Masa Sakano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-05 00:00:00.000000000 Z
+date: 2019-11-07 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
@@ -23,6 +23,7 @@ extra_rdoc_files:
 - README.en.rdoc
 files:
 - ".gitignore"
+- ChangeLog
 - LICENSE.txt
 - Makefile
 - README.en.rdoc
@@ -36,6 +37,7 @@ licenses:
 - MIT
 metadata:
   yard.run: yri
+  changelog_uri: https://github.com/masasakano/sub_object/blob/master/ChangeLog
 post_install_message: 
 rdoc_options:
 - "--charset=UTF-8"