textrepo 0.4.2 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2806e2488be378495f29ed25dd9d04937d50706a5d7772b5d93fd4d242a675d
-  data.tar.gz: a031757c1eb5fa5ec644b7c6674d030f93aebf07c93ad061ea96711532ab8b79
+  metadata.gz: b504229bd3ea2416e0a85cb8903fe0903b6f045a8a2549857a2b1b296f35e32a
+  data.tar.gz: baaf7776505e0c430d9c540d88e78847eebc406612b5f9c2cb11ba20c5f3371d
 SHA512:
-  metadata.gz: bcf5e7162744e0d0ba1e0e1745c37b7718749d3aae2ac83c6c8af8f9c032d8b85af38abbbf61d3f19ec49e640060362bcc55085bb7e930868294068314f5da21
-  data.tar.gz: d2074f1b5a09a8741e8172d51d90c31f7c17552473d834e866cb3f7f1d43d2f2633a7daa2aa50a12d2a17202aa58f43466c151793a9368eb7b3fb39977a0379b
+  metadata.gz: cb90a5d324536e0c2ba8f87c93923ba19bae2c835f31445f9d0f3701110f37598f44a638b496ac992dab30ea03f82643591ea807623a93bd0afdfa52505595ac
+  data.tar.gz: 1affcd1ff8cce4b3374610791ba733d5d5c8fd1d8b90adb5030725752c84c0f671d4ee9b6ca7f4539ebc2171baf1d2c92b9eb530dc84eed14d477df98729154e

data/.gitignore

@@ -1,3 +1,4 @@
+Gemfile.lock
 *.gem
 *.rbc
 /.config

data/CHANGELOG.md

@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 ## [Unreleased]
 Nothing to record here.
 
+## [0.5.1] - 2020-11-02
+### Changed
+- Fix issue #28.
+  - Modify `Repository#update` to do nothing when the given text is
+    identical to the one in the repository.
+
+## [0.5.0] - 2020-11-01
+### Added
+- Add a new API `Repository#search`.
+- Add a new API `Repository#exist?`. (0.4.3)
+
 ## [0.4.0] - 2020-10-14
 ### Added
 - Released to rubygems.org.

data/Rakefile

@@ -42,5 +42,4 @@ RDoc::Task.new do |rdoc|
   rdoc.generator = "ri"
   rdoc.rdoc_dir = "doc"
   rdoc.rdoc_files.include("lib/**/*.rb")
-  rdoc.markup = "markdown"
 end

data/lib/textrepo/error.rb

@@ -1,12 +1,39 @@
 module Textrepo
+
+  ##
+  # Following errors might occur in repository operations:
+  #   +---------------------------------+-----------------------+
+  #   | operation (args)                | error type            |
+  #   +---------------------------------+-----------------------+
+  #   | create (timestamp, text)        | Duplicate timestamp   |
+  #   |                                 | Empty text            |
+  #   +---------------------------------+-----------------------+
+  #   | read   (timestamp)              | Missing timestamp     |
+  #   +---------------------------------+-----------------------+
+  #   | update (timestamp, text)        | Mssing timestamp      |
+  #   |                                 | Empty text            |
+  #   +---------------------------------+-----------------------+
+  #   | delete (timestamp)              | Missing timestamp     |
+  #   +---------------------------------+-----------------------+
+  #   | search (pattern, stamp_pattern) | Invalid search result |
+  #   +---------------------------------+-----------------------+
+
   class Error < StandardError; end
 
+  # :stopdoc:
   module ErrMsg
     UNKNOWN_REPO_TYPE   = 'unknown type for repository: %s'
     DUPLICATE_TIMESTAMP = 'duplicate timestamp: %s'
     EMPTY_TEXT          = 'empty text'
     MISSING_TIMESTAMP   = 'missing timestamp: %s'
+    INVALID_TIMESTAMP_STRING = "invalid string as timestamp: %s"
+    INVALID_SEARCH_RESULT = "invalid result by searcher: %s"
   end
+  # :startdoc:
+
+  ##
+  # An error raised if unknown type was specified as the repository
+  # type.
 
   class UnknownRepoTypeError < Error
     def initialize(type)
@@ -14,20 +41,9 @@ module Textrepo
     end
   end
 
-  # Following errors might occur in repository operations:
-  # +--------------------------+---------------------+
-  # | operation (args)         | error type          |
-  # +--------------------------+---------------------+
-  # | create (timestamp, text) | Duplicate timestamp |
-  # |                          | Empty text          |
-  # +--------------------------+---------------------+
-  # | read   (timestamp)       | Missing timestamp   |
-  # +--------------------------+---------------------+
-  # | update (timestamp, text) | Mssing timestamp    |
-  # |                          | Empty text          |
-  # +--------------------------+---------------------+
-  # | delete (timestamp)       | Missing timestamp   |
-  # +--------------------------+---------------------+
+  ##
+  # An error raised if the specified timestamp has already exist in
+  # the repository.
 
   class DuplicateTimestampError < Error
     def initialize(timestamp)
@@ -35,16 +51,43 @@ module Textrepo
     end
   end
 
+  ##
+  # An error raised if the given text is empty.
+
   class EmptyTextError < Error
     def initialize
       super(ErrMsg::EMPTY_TEXT)
     end
   end
 
+  ##
+  # An error raised if the given timestamp has not exist in the
+  # repository.
+
   class MissingTimestampError < Error
     def initialize(timestamp)
       super(ErrMsg::MISSING_TIMESTAMP % timestamp)
     end
   end
 
+  ##
+  # An error raised if an argument is invalid to convert a
+  # Textrepo::Timestamp object.
+
+  class InvalidTimestampStringError < Error
+    def initialize(str)
+      super(ErrMsg::INVALID_TIMESTAMP_STRING % str)
+    end
+  end
+
+  ##
+  # An error raise if the search result is not suitable to use.
+  #
+
+  class InvalidSearchResultError < Error
+    def initialize(str)
+      super(ErrMsg::INVALID_SEARCH_RESULT % str)
+    end
+  end
+
 end

data/lib/textrepo/file_system_repository.rb

@@ -1,29 +1,52 @@
 require 'fileutils'
+require "open3"
 
 module Textrepo
+
   ##
   # A concrete class which implements Repository interfaces.  This
   # repository uses the default file system of the operating system as
   # a text storage.
+
   class FileSystemRepository < Repository
+
     ##
     # Repository root.
+
     attr_reader :path
 
     ##
     # Extension of notes sotres in the repository.
+
     attr_reader :extname
 
+    ##
+    # Searcher program name.
+
+    attr_reader :searcher
+
+    ##
+    # An array of options to pass to the searcher program.
+
+    attr_reader :searcher_options
+
     ##
     # Default name for the repository which uses when no name is
     # specified in the configuration settings.
+
     FAVORITE_REPOSITORY_NAME = 'notes'
 
     ##
     # Default extension of notes which uses when no extname is
     # specified in the configuration settings.
+
     FAVORITE_EXTNAME = 'md'
 
+    ##
+    # Default searcher program to search text in the repository.
+
+    FAVORITE_SEARCHER = 'grep'
+
     ##
     # Creates a new repository object.  The argument, `conf` must be a
     # Hash object.  It should hold the follwoing values:
@@ -34,13 +57,33 @@ module Textrepo
     # - OPTIONAL: (if not specified, default values are used)
     #   - :repository_name => basename of the root path for the repository
     #   - :default_extname => extname for a file stored into in the repository
+    #   - :searcher => a program to search like `grep`
+    #   - :searcher_options => an Array of option to pass to the searcher
     #
     # The root path of the repository looks like the following:
     # - conf[:repository_base]/conf[:repository_name]
     # 
-    # Default values are set when `repository_name` and `default_extname`
+    # Default values are set when `:repository_name` and `:default_extname`
     # were not defined in `conf`.
     #
+    # Be careful to set `:searcher_options`, it must be to specify the
+    # searcher behavior equivalent to `grep` with "-inR".  The default
+    # value for the searcher options is defined for BSD grep (default
+    # grep on macOS), GNU grep, and ripgrep (aka rg).  They are:
+    #
+    #   "grep"   => ["-i", "-n", "-R", "-E"]
+    #   "egrep"  => ["-i", "-n", "-R"]
+    #   "ggrep"  => ["-i", "-n", "-R", "-E"]
+    #   "gegrep" => ["-i", "-n", "-R"]
+    #   "rg"     => ["-S", "-n", "--no-heading", "--color", "never"]
+    #
+    # If use those 3 searchers, it is not recommended to set
+    # `:searcher_options`.  The default value works well in
+    # `textrepo`.
+    #
+    # :call-seq:
+    #     new(Hash or Hash like object) -> FileSystemRepository
+
     def initialize(conf)
       super
       base = conf[:repository_base]
@@ -48,6 +91,8 @@ module Textrepo
       @path = File.expand_path("#{name}", base)
       FileUtils.mkdir_p(@path)
       @extname = conf[:default_extname] || FAVORITE_EXTNAME
+      @searcher = find_searcher(conf[:searcher])
+      @searcher_options = conf[:searcher_options]
     end
 
     ##
@@ -55,8 +100,8 @@ module Textrepo
     # text and is associated to the timestamp.
     #
     # :call-seq:
-    #     create(Timestamp, Array) => Timestamp
-    #
+    #     create(Timestamp, Array) -> Timestamp
+
     def create(timestamp, text)
       abs = abspath(timestamp)
       raise DuplicateTimestampError, timestamp if FileTest.exist?(abs)
@@ -71,8 +116,8 @@ module Textrepo
     # content.
     #
     # :call-seq:
-    #     read(Timestamp) => Array
-    #
+    #     read(Timestamp) -> Array
+
     def read(timestamp)
       abs = abspath(timestamp)
       raise MissingTimestampError, timestamp unless FileTest.exist?(abs)
@@ -87,21 +132,25 @@ module Textrepo
     # Updates the file content in the repository.  A new timestamp
     # will be attached to the text.
     #
-    # :call-seq:
-    #     update(Timestamp, Array) => Timestamp
+    # See the documentation of Repository#update to know about errors
+    # and constraints of this method.
     #
+    # :call-seq:
+    #     update(Timestamp, Array) -> Timestamp
+
     def update(timestamp, text)
       raise EmptyTextError if text.empty?
-      org_abs = abspath(timestamp)
-      raise MissingTimestampError, timestamp unless FileTest.exist?(org_abs)
+      raise MissingTimestampError, timestamp unless exist?(timestamp)
+
+      # does nothing if given text is the same in the repository one
+      return timestamp if read(timestamp) == text
 
       # the text must be stored with the new timestamp
       new_stamp = Timestamp.new(Time.now)
-      new_abs = abspath(new_stamp)
-      write_text(new_abs, text)
+      write_text(abspath(new_stamp), text)
 
-      # delete the original file in the repository
-      FileUtils.remove_file(org_abs)
+      # delete the original text file in the repository
+      FileUtils.remove_file(abspath(timestamp))
 
       new_stamp
     end
@@ -110,8 +159,8 @@ module Textrepo
     # Deletes the file in the repository.
     #
     # :call-seq:
-    #     delete(Timestamp) => Array
-    #
+    #     delete(Timestamp) -> Array
+
     def delete(timestamp)
       abs = abspath(timestamp)
       raise MissingTimestampError, timestamp unless FileTest.exist?(abs)
@@ -126,8 +175,8 @@ module Textrepo
     # Finds entries of text those timestamp matches the specified pattern.
     #
     # :call-seq:
-    #     entries(String = nil) => Array
-    #
+    #     entries(String = nil) -> Array of Timestamp instances
+
     def entries(stamp_pattern = nil)
       results = []
 
@@ -135,7 +184,7 @@ module Textrepo
       when "yyyymoddhhmiss_lll".size
         stamp = Timestamp.parse_s(stamp_pattern)
         if exist?(stamp)
-          results << stamp.to_s
+          results << stamp
         end
       when 0, "yyyymoddhhmiss".size, "yyyymodd".size
         results += find_entries(stamp_pattern)
@@ -158,19 +207,49 @@ module Textrepo
       results
     end
 
+    ##
+    # Check the existence of text which is associated with the given
+    # timestamp.
+    #
+    # :call-seq:
+    #     exist?(Timestamp) -> true or false
+
+    def exist?(timestamp)
+      FileTest.exist?(abspath(timestamp))
+    end
+
+    ##
+    # Searches a pattern in all text.  The given pattern is a word to
+    # search or a regular expression.  The pattern would be passed to
+    # a searcher program as it passed.
+    #
+    # See the document for Textrepo::Repository#search to know about
+    # the search result.
+    #
+    # :call-seq:
+    #     search(String for pattern, String for Timestamp pattern) -> Array
+
+    def search(pattern, stamp_pattern = nil)
+      result = nil
+      if stamp_pattern.nil?
+        result = invoke_searcher_at_repo_root(@searcher, pattern)
+      else
+        result = invoke_searcher_for_entries(@searcher, pattern, entries(stamp_pattern))
+      end
+      construct_search_result(result)
+    end
+
     # :stopdoc:
+
     private
     def abspath(timestamp)
       filename = timestamp_to_pathname(timestamp) + ".#{@extname}"
       File.expand_path(filename, @path)
     end
 
-    ##
-    # ```
     #  %Y   %m %d %H %M %S  suffix        %Y/%m/  %Y%m%d%H%M%S %L
     # "2020-12-30 12:34:56  (0 | nil)" => "2020/12/20201230123456"
     # "2020-12-30 12:34:56  (7)"       => "2020/12/20201230123456_007"
-    # ```
     def timestamp_to_pathname(timestamp)
       yyyy, mo = Timestamp.split_stamp(timestamp.to_s)[0..1]
       File.join(yyyy, mo, timestamp.to_s)
@@ -187,15 +266,156 @@ module Textrepo
       File.basename(text_path).delete_suffix(".#{@extname}")
     end
 
-    def exist?(timestamp)
-      FileTest.exist?(abspath(timestamp))
-    end
-
     def find_entries(stamp_pattern)
       Dir.glob("#{@path}/**/#{stamp_pattern}*.#{@extname}").map { |e|
-        timestamp_str(e)
+        begin
+          Timestamp.parse_s(timestamp_str(e))
+        rescue InvalidTimestampStringError => _
+          # Just ignore the erroneous entry, since it is not a text in
+          # the repository.  It may be a garbage, or some kind of
+          # hidden stuff of the repository, ... etc.
+          nil
+        end
+      }.compact
+    end
+
+    ##
+    # The upper limit of files to search at one time.  The value has
+    # no reason to select.  It seems to me that not too much, not too
+    # little to handle in one process to search.
+
+    LIMIT_OF_FILES = 20
+
+    ##
+    # When no timestamp pattern was given, invoke the searcher with
+    # the repository root path as its argument and the recursive
+    # searching option.  The search could be done in only one process.
+
+    def invoke_searcher_at_repo_root(searcher, pattern)
+      o, s = Open3.capture2(searcher, *find_searcher_options(searcher),
+                            pattern, @path)
+      output = []
+      output += o.lines.map(&:chomp) if s.success? && (! o.empty?)
+      output
+    end
+
+    ##
+    # When a timestamp pattern was given, at first, list target files,
+    # then invoke the searcher for those files.  Since the number of
+    # target files may be so much, it seems to be dangerous to pass
+    # all of them to a single search process at one time.
+    #
+    # One more thing to mention, the searcher, like `grep`, does not
+    # add the filename at the beginning of the search result line, if
+    # the target is one file.  This behavior is not suitable in this
+    # purpose.  The code below adds the filename when the target is
+    # one file.
+
+    def invoke_searcher_for_entries(searcher, pattern, entries)
+      output = []
+
+      num_of_entries = entries.size
+      if num_of_entries == 1
+        # If the search taget is one file, the output needs special
+        # treatment.
+        file = abspath(entries[0])
+        o, s = Open3.capture2(searcher, *find_searcher_options(searcher),
+                              pattern, file)
+        if s.success? && (! o.empty)
+          output += o.lines.map { |line|
+            # add filename at the beginning of the search result line
+            [file, line.chomp].join(":")
+          }
+        end
+      elsif num_of_entries > LIMIT_OF_FILES
+        output += invoke_searcher_for_entries(searcher, pattern, entries[0..(LIMIT_OF_FILES - 1)])
+        output += invoke_searcher_for_entries(searcher, pattern, entries[LIMIT_OF_FILES..-1])
+      else
+        # When the number of target is less than the upper limit,
+        # invoke the searcher with all of target files as its
+        # arguments.
+        files = find_files(entries)
+        o, s = Open3.capture2(searcher, *find_searcher_options(searcher),
+                              pattern, *files)
+        if s.success? && (! o.empty)
+          output += o.lines.map(&:chomp)
+        end
+      end
+
+      output
+    end
+
+    SEARCHER_OPTS = {
+      # case insensitive, print line number, recursive search, work as egrep
+      "grep"   => ["-i", "-n", "-R", "-E"],
+      # case insensitive, print line number, recursive search
+      "egrep"  => ["-i", "-n", "-R"],
+      # case insensitive, print line number, recursive search, work as gegrep
+      "ggrep"  => ["-i", "-n", "-R", "-E"],
+      # case insensitive, print line number, recursive search
+      "gegrep" => ["-i", "-n", "-R"],
+      # smart case, print line number, no color
+      "rg"     => ["-S", "-n", "--no-heading", "--color", "never"],
+    }
+
+    def find_searcher_options(searcher)
+      @searcher_options || SEARCHER_OPTS[File.basename(searcher)] || ""
+    end
+
+    def find_files(timestamps)
+      timestamps.map{|stamp| abspath(stamp)}
+    end
+
+    ##
+    # The argument must be an Array contains the searcher output.
+    # Each item is constructed from 3 parts:
+    #   "<pathname>:<integer>:<text>"
+    #
+    # For example, it may looks like:
+    #
+    #   "/somewhere/2020/11/20201101044300.md:18:foo is foo"
+    #
+    # Or it may contains more ":" in the text part as:
+    #
+    #   "/somewhere/2020/11/20201101044500.md:119:apple:orange:grape"
+    #
+    # In the latter case, `split(":")` will split it too much.  That is,
+    # the result will be:
+    #
+    #  ["/somewhere/2020/11/20201101044500.md", "119", "apple", "orange", "grape"]
+    #
+    # Text part must be joined with ":".
+
+    def construct_search_result(output)
+      output.map { |line|
+        begin
+          pathname, num, *match_text = line.split(":")
+          [Timestamp.parse_s(timestamp_str(pathname)),
+           num.to_i,
+           match_text.join(":")]
+        rescue InvalidTimestampStringError, TypeError => _
+          raise InvalidSearchResultError, [@searcher, @searcher_options.join(" ")].join(" ")
+        end
+      }.compact
+    end
+
+    def find_searcher(program = nil)
+      candidates = [FAVORITE_SEARCHER]
+      candidates.unshift(program) unless program.nil? || candidates.include?(program)
+      search_paths = ENV["PATH"].split(":")
+      candidates.map { |prog|
+        find_in_paths(prog, search_paths)
+      }[0]
+    end
+
+    def find_in_paths(prog, paths)
+      paths.each { |p|
+        abspath = File.expand_path(prog, p)
+        return abspath if FileTest.exist?(abspath) && FileTest.executable?(abspath)
       }
+      nil
     end
+    # :startdoc:
 
   end
 end

data/lib/textrepo/repository.rb

@@ -1,31 +1,81 @@
 module Textrepo
   class Repository
-    attr_reader :type, :name
+
+    ##
+    # Repository type.  It specifies which concrete repository class
+    # will instantiated.  For example, the type `:file_system` specifies
+    # `FileSystemRepository`.
+
+    attr_reader :type
+
+    ##
+    # Repository name.  The usage of the value of `name` depends on a
+    # concrete repository class.  For example, `FileSystemRepository`
+    # uses it as a part of the repository path.
+
+    attr_reader :name
+
+    ##
+    # Create a new repository.  The argument must be an object which
+    # can be accessed like a Hash object.
 
     def initialize(conf)
       @type = conf[:repository_type]
       @name = conf[:repository_name]
     end
 
+    ##
     # Stores text data into the repository with the specified timestamp.
     # Returns the timestamp.
+    #
+    # :call-seq:
+    #     create(Timestamp, Array) -> Timestamp
+
     def create(timestamp, text); timestamp; end
 
+    ##
     # Reads text data from the repository, which is associated to the
     # timestamp.  Returns an array which contains the text.
+    #
+    # :call-seq:
+    #     read(Timestamp) -> Array
+
     def read(timestamp); []; end
 
-    # Updates the content with text in the repository, which is
-    # associated to the timestamp.  Returns the timestamp.
+    ##
+    # Updates the content with given text in the repository, which is
+    # associated to the given timestamp.  Returns the timestamp newly
+    # generated during the execution.
+    #
+    # If the given Timestamp is not existed as a Timestamp attached to
+    # text in the repository, raises MissingTimestampError.
+    #
+    # If the given text is empty, raises EmptyTextError.
+    #
+    # If the given text is identical to the text in the repository,
+    # does nothing.  Returns the given timestamp itself.
+    #
+    # :call-seq:
+    #     update(Timestamp, Array) -> Timestamp
+
     def update(timestamp, text); timestamp; end
 
+    ##
     # Deletes the content in the repository, which is associated to
     # the timestamp.  Returns an array which contains the deleted text.
+    #
+    # :call-seq:
+    #     delete(Timestamp) -> Array
+
     def delete(timestamp); []; end
 
+    ##
     # Finds all entries of text those have timestamps which mathes the
     # specified pattern of timestamp.  Returns an array which contains
-    # timestamps.  A pattern must be one of the following:
+    # instances of Timestamp.  If none of text was found, an empty
+    # array would be returned.
+    #
+    #  A pattern must be one of the following:
     #
     #     - yyyymoddhhmiss_lll : whole stamp
     #     - yyyymoddhhmiss     : omit millisecond part
@@ -37,17 +87,50 @@ module Textrepo
     # If `stamp_pattern` is omitted, the recent entries will be listed.
     # Then, how many entries are listed depends on the implementaiton
     # of the concrete repository class.
+    #
+    # :call-seq:
+    #     entries(String) -> Array of Timestamp instances
+
     def entries(stamp_pattern = nil); []; end
 
+    ##
+    # Check the existence of text which is associated with the given
+    # timestamp.
+    #
+    # :call-seq:
+    #     exist?(Timestamp) -> true or false
+
+    def exist?(timestamp); false; end
+
+    ##
+    # Searches a pattern (word or regular expression) in text those
+    # matches to a given timestamp pattern.  Returns an Array of
+    # search results.  If no match, returns an empty Array.
+    #
+    # See the document for Repository#entries about a timestamp
+    # pattern.  When nil is passed as a timestamp pattern, searching
+    # applies to all text in the repository.
+    #
+    # Each entry of the result Array is constructed from 3 items, (1)
+    # timestamp (Timestamp), (2) line number (Integer), (3) matched
+    # line (String).
+    #
+    # :call-seq:
+    #     search(String for pattern, String for Timestamp pattern) -> Array
+
+    def search(pattern, stamp_pattern = nil); []; end
+
   end
 
   require_relative 'file_system_repository'
 
+  ##
   # Returns an instance which derived from Textrepo::Repository class.
-  # `conf` must be a Hash object which has a value of
-  # `:repository_type` and `:repository_name` at least.  Some concrete
-  # class derived from Textrepo::Repository may require more key-value
-  # pairs in `conf`.
+  # `conf` must be an object which can be accessed like a Hash object.
+  # And it must also has a value of `:repository_type` and
+  # `:repository_name` at least.  Some concrete class derived from
+  # Textrepo::Repository may require more key-value pairs in `conf`.
+
   def init(conf)
     type = conf[:repository_type]
     klass_name = type.to_s.split(/_/).map(&:capitalize).join + "Repository"

data/lib/textrepo/timestamp.rb

@@ -1,23 +1,47 @@
 module Textrepo
   ##
-  # Timstamp is generated from a Time object.  It converts a time to
+  # Timestamp is generated from a Time object.  It converts a time to
   # string in the obvious format, such "20201023122400".
   #
+  # Since the obvious format contains only year, month, day, hour,
+  # minute, and second, the resolution of time is a second.  That is,
+  # two Time object those are different only in second will generates
+  # equal Timestamp objects.
+  #
+  # If a client program of Textrepo::Timestamp wants to distinguish
+  # those Time objects, an attribute `suffix` could be used.
+  #
+  # For example, the `suffix` will be converted into a 3 character
+  # string, such "012", "345", "678", ... etc.  So, millisecond part
+  # of a Time object will be suitable to pass as `suffix` when
+  # creating a Timestamp object.
+
   class Timestamp
     include Comparable
 
-    attr_reader :time, :suffix
+    ##
+    # Time object which generates the Timestamp object.
+
+    attr_reader :time
 
     ##
-    # :call-seq:
-    #   new(Time, Integer = nil)
+    # An integer specified in `new` method to create the Timestamp object.
+
+    attr_reader :suffix
+
+    ##
+    # Creates a Timestamp object from a Time object.  In addition, an
+    # Integer can be passed as a suffix use.
     #
+    # :call-seq:
+    #   new(Time, Integer = nil) -> Timestamp
+
     def initialize(time, suffix = nil)
       @time = time
       @suffix = suffix
     end
 
-    def <=>(other)
+    def <=>(other)              # :nodoc:
       result = (self.time <=> other.time)
 
       sfx = self.suffix || 0
@@ -29,12 +53,10 @@ module Textrepo
     ##
     # Generate an obvious time string.
     #
-    # ```
-    #  %Y   %m %d %H %M %S  suffix
-    # "2020-12-30 12:34:56  (0 | nil)" => "20201230123456"
-    # "2020-12-30 12:34:56  (7)"       => "20201230123456_007"
-    # ```
-    #
+    #    %Y   %m %d %H %M %S  suffix
+    #   "2020-12-30 12:34:56  (0 | nil)" -> "20201230123456"
+    #   "2020-12-30 12:34:56  (7)"       -> "20201230123456_007"
+
     def to_s
       s = @time.strftime("%Y%m%d%H%M%S")
       s += "_#{"%03u" % @suffix}" unless @suffix.nil? || @suffix == 0
@@ -43,21 +65,41 @@ module Textrepo
 
     class << self
       ##
-      # ```
-      #  yyyymoddhhmiss sfx      yyyy    mo    dd    hh    mi    ss    sfx
-      # "20201230123456"     => "2020", "12", "30", "12", "34", "56"
-      # "20201230123456_789" => "2020", "12", "30", "12", "34", "56", "789"
-      # ```
+      # Splits a string which represents a timestamp into components.
+      # Each component represents a part of constructs to instantiate
+      # a Time object.
       #
+      #    yyyymoddhhmiss sfx      yyyy    mo    dd    hh    mi    ss    sfx
+      #   "20201230123456"     -> "2020", "12", "30", "12", "34", "56"
+      #   "20201230123456_789" -> "2020", "12", "30", "12", "34", "56", "789"
+      #
+      # Raises InvalidTimestampStringError if nil was passed as an arguemnt.
+
       def split_stamp(stamp_str)
+        raise InvalidTimestampStringError, stamp_str if stamp_str.nil?
         #    yyyy  mo    dd    hh    mi      ss      sfx
         a = [0..3, 4..5, 6..7, 8..9, 10..11, 12..13, 15..17].map {|r| stamp_str[r]}
         a[-1].nil? ? a[0..-2] : a
       end
 
+      ##
+      # Generate a Timestamp object from a string which represents a
+      # timestamp, such "20201028163400".
+      #
+      # Raises InvalidTimestampStringError if cannot convert the
+      # argument into a Timestamp object.
+      #
+      # :call-seq:
+      #     parse_s("20201028163400") -> Timestamp
+      #     parse_s("20201028163529_034") -> Timestamp
+
       def parse_s(stamp_str)
-        year, mon, day, hour, min, sec , sfx = split_stamp(stamp_str).map(&:to_i)
-        Timestamp.new(Time.new(year, mon, day, hour, min, sec), sfx)
+        begin
+          ye, mo, da, ho, mi, se, sfx = split_stamp(stamp_str).map(&:to_i)
+          Timestamp.new(Time.new(ye, mo, da, ho, mi, se), sfx)
+        rescue InvalidTimestampStringError, ArgumentError => _
+          raise InvalidTimestampStringError, stamp_str
+        end
       end
 
     end

data/lib/textrepo/version.rb

@@ -1,3 +1,3 @@
 module Textrepo
-  VERSION = '0.4.2'
+  VERSION = '0.5.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: textrepo
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.1
 platform: ruby
 authors:
 - mnbi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-23 00:00:00.000000000 Z
+date: 2020-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -36,7 +36,6 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,22 +0,0 @@
-PATH
-  remote: .
-  specs:
-    textrepo (0.4.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    minitest (5.14.2)
-    rake (13.0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 2.1)
-  minitest (~> 5.0)
-  rake (~> 13.0)
-  textrepo!
-
-BUNDLED WITH
-   2.1.4