sub_string 1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c328fe148dea22de40b0b91fcb890ecad51ec98b52579bd963ec3595a5c5d312
-  data.tar.gz: 2490b15f6bab5c743d02db40e5857acf9fd6b3b38b75fa7d155869e7dce957e3
+  metadata.gz: 8363082abbe2b91aa7a063ccdfc4719bdd06e5c476d64bf33b3e8a8bb5fa4590
+  data.tar.gz: 0ec710c61e5d727714f8fe9b19e8ea74da998678e727c124da9ba8e749c2f0c6
 SHA512:
-  metadata.gz: 573037a06377750a49a90d0ed95ca0ab59deb693eec7410b9a618352f334927e229a10a621e0c7a380f8deb4f201d5925b112871442b0fbb4d32ef86bc4dafb3
-  data.tar.gz: bab762511ada2c4e0c5b959c243605ad503d7e38f11ec1eebab0acbfa84eb95e6b3bbd9b9a3d0b6a609001521d455fde94489436dcbbfd0ebd31ea014adb1449
+  metadata.gz: faba092f12dd756167e205c0f864e3bc0d72f61f8754489c64ff8628021df1e0bd4d302df945d4fc33e47e574d3d533c19e9c6a13bbb9f2a883935344dee240e
+  data.tar.gz: 1c1cdf4451a452014b88210388277dee145960800f75f9bb14f41ac7c8648d5324a15f2fbae34d7e911bcb7e23fd3d9e2d9a50b42a67015ec33de26d00f2ea67

data/ChangeLog

@@ -0,0 +1,10 @@
+-----
+(Version: 1.0.1)
+2019-11-05  Masa Sakano
+  * Update README. Added ChangeLog
+
+-----
+(Version: 1.0)
+2019-11-05  Masa Sakano
+
+ * Initial but pretty much complete commit (Ver.1.0).

data/README.en.rdoc

@@ -5,6 +5,11 @@
 
 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.
 
+On the surface, this is a String version of the class MatchSkeleton
+{match_skeleton}[https://rubygems.org/gems/match_skeleton] (also in 
+{Github}[https://github.com/masasakano/match_skeleton]), which is an
+alternative and much memorly-lighter version of MatchData.
+
 For the detailed background concept (and algorithm), see the reference page of the
 generalized parent class, SubObject, either at the
 {Ruby Gems page}[http://rubygems.org/gems/sub_object]
@@ -28,7 +33,7 @@ of information (plus a hash value, strictly speaking), and hence uses negligible
 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.
+the original source object as the Ruby default +String#[ i, j ]+ does.
 
 Then, whenever it is referred to, it reconstructs the original
 sub-String object:
@@ -71,7 +76,7 @@ be applied to the instance of this class.
 
 === Potential use
 
-Each sub-String in Ruby like +String[i, j]+ or +String[i..j]+ takes up memory
+Each sub-String in Ruby like +String#[ i, j ]+ or +String#[ i..j ]+ takes up memory
 according to the length of the sub-String.  Consider an example:
 
   src = "Some very extremely lengthy string.... (snipped)".
@@ -144,10 +149,11 @@ 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.
+or above.  And this library depends on {SubObject (sub_object)}[https://rubygems.org/gems/sub_object], which you can
+find in RubyGems.
 
-You can install it from the usual Ruby gem command.
-Or, alternatively, download it and put the library file in one of your Ruby library search paths.
+You can install the packages of both this library and SubObject with the usual Ruby gem command.
+Or, alternatively, download them and put the library files in one of your Ruby library search paths.
 
 == Developer's note
 

data/sub_string.gemspec

@@ -4,8 +4,8 @@ require 'rake'
 require 'date'
 
 Gem::Specification.new do |s|
-  s.name = %q{sub_string}.sub(/.*/){|c| (c == File.basename(Dir.pwd)) ? c : raise("ERROR: s.name=(#{c}) in gemspec seems wrong!")}
-  s.version = "1.0"
+  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.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|
@@ -15,7 +15,9 @@ Gem::Specification.new do |s|
   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.summary = %q{Duck-typed String class with negligible memory use}
-  s.description = %q{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.}
+  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.
+  EOF
   # s.email = %q{abc@example.com}
   s.extra_rdoc_files = [
      #"LICENSE.txt",
@@ -36,9 +38,9 @@ Gem::Specification.new do |s|
   s.files.reject! { |fn| File.symlink? fn }
 
   s.add_runtime_dependency 'sub_object', '>= 1.0'
-  # s.add_development_dependency "bourne", [">= 0"]
-  s.homepage = %q{https://www.wisebabel.com}
-  s.rdoc_options = ["--charset=UTF-8"]
+  # 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...
 
   # s.require_paths = ["lib"]	# Default "lib"
   s.required_ruby_version = '>= 2.0'  # respond_to_missing?
@@ -47,6 +49,10 @@ 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/sub_string/blob/master/ChangeLog"
+  s.metadata["source_code_uri"]   = "https://github.com/masasakano/sub_string"
+  # s.metadata["documentation_uri"] = "https://www.example.info/gems/bestgemever/0.0.1"
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sub_string
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 1.0.1
 platform: ruby
 authors:
 - Masa Sakano
@@ -24,10 +24,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
-description: Class SubString that expresses Ruby sub-String but taking up negligible
+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.  If
-  the original string is destructively altered, warning is issued.
+  exactly like String (duck-typing), except destructive modification is prohibited.
+  \ If the original string is destructively altered, warning is issued.\n"
 email: 
 executables: []
 extensions: []
@@ -35,6 +35,7 @@ extra_rdoc_files:
 - README.en.rdoc
 files:
 - ".gitignore"
+- ChangeLog
 - LICENSE.txt
 - Makefile
 - README.en.rdoc
@@ -47,6 +48,8 @@ licenses:
 - MIT
 metadata:
   yard.run: yri
+  changelog_uri: https://github.com/masasakano/sub_string/blob/master/ChangeLog
+  source_code_uri: https://github.com/masasakano/sub_string
 post_install_message: 
 rdoc_options:
 - "--charset=UTF-8"