textrepo 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9af29cfb5945798beea4d787abc9ec472607841d6daea7dc8e62bf62a3ecc4b2
-  data.tar.gz: 31f97fb8586b206b95f85feaaf653aa0e75a08379677e2019e067c5df03f0b3d
+  metadata.gz: 7415dcbc8ec9483a33c0027432a60473fd0b77ad67369b25b88fb0f399edd788
+  data.tar.gz: 9467336f5d93ec578d5693005a4737f4eef55aeb11e4c0a4ec12f197e81de240
 SHA512:
-  metadata.gz: 934d63e39badb3ffa660b26e363a1caba78bd3dd906c8c7b24c79374659780def778e7f00b6902a1f80950055d885a954561a74b2301253a086195f48d05a79e
-  data.tar.gz: d25676f649ba6308403f3a8e4e4d2f1d851b9d6026ebe8ee5668d7a8d37a4edc8135f13ead288a963afc81571cc1b0378499630c314334f5b3c223bf8e7dc3f4
+  metadata.gz: f989032a0f1db66aeb1392cf9b05fd89306152d1b76907953c90ec14839d7a34465a017a2be8017536270b9a071cd3027497305978fdf59681d3547c8a68a5e5
+  data.tar.gz: cfb126c03ce9720dd2f2e90453a5d2baf33160c7786a8a1d9b5ef02b2c4a4e2531de5744d255efd7979a39e87c9e93287de3397533404143b51be1eb8bb23a58

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/file_system_repository.rb

@@ -47,6 +47,9 @@ module Textrepo
     # 
     # Default values are set when `repository_name` and `default_extname`
     # were not defined in `conf`.
+    #
+    # :call-seq:
+    #     new(Rbnotes::Conf or Hash) -> FileSystemRepository
 
     def initialize(conf)
       super
@@ -60,9 +63,9 @@ module Textrepo
     ##
     # Creates a file into the repository, which contains the specified
     # text and is associated to the timestamp.
-
+    #
     # :call-seq:
-    #     create(Timestamp, Array) => Timestamp
+    #     create(Timestamp, Array) -> Timestamp
 
     def create(timestamp, text)
       abs = abspath(timestamp)
@@ -76,9 +79,9 @@ module Textrepo
     ##
     # Reads the file content in the repository.  Then, returns its
     # content.
-
+    #
     # :call-seq:
-    #     read(Timestamp) => Array
+    #     read(Timestamp) -> Array
 
     def read(timestamp)
       abs = abspath(timestamp)
@@ -93,9 +96,9 @@ module Textrepo
     ##
     # Updates the file content in the repository.  A new timestamp
     # will be attached to the text.
-
+    #
     # :call-seq:
-    #     update(Timestamp, Array) => Timestamp
+    #     update(Timestamp, Array) -> Timestamp
 
     def update(timestamp, text)
       raise EmptyTextError if text.empty?
@@ -115,9 +118,9 @@ module Textrepo
 
     ##
     # Deletes the file in the repository.
-
+    #
     # :call-seq:
-    #     delete(Timestamp) => Array
+    #     delete(Timestamp) -> Array
 
     def delete(timestamp)
       abs = abspath(timestamp)
@@ -131,9 +134,9 @@ 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 = []
@@ -142,7 +145,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)
@@ -168,7 +171,7 @@ module Textrepo
     ##
     # Check the existence of text which is associated with the given
     # timestamp.
-
+    #
     # :call-seq:
     #     exist?(Timestamp) -> true or false
 
@@ -205,7 +208,7 @@ module Textrepo
 
     def find_entries(stamp_pattern)
       Dir.glob("#{@path}/**/#{stamp_pattern}*.#{@extname}").map { |e|
-        timestamp_str(e)
+        Timestamp.parse_s(timestamp_str(e))
       }
     end
 

data/lib/textrepo/repository.rb

@@ -27,7 +27,7 @@ module Textrepo
     ##
     # Stores text data into the repository with the specified timestamp.
     # Returns the timestamp.
-
+    #
     # :call-seq:
     #     create(Timestamp, Array) -> Timestamp
 
@@ -36,7 +36,7 @@ module Textrepo
     ##
     # Reads text data from the repository, which is associated to the
     # timestamp.  Returns an array which contains the text.
-
+    #
     # :call-seq:
     #     read(Timestamp) -> Array
 
@@ -45,7 +45,7 @@ module Textrepo
     ##
     # Updates the content with text in the repository, which is
     # associated to the timestamp.  Returns the timestamp.
-
+    #
     # :call-seq:
     #     update(Timestamp, Array) -> Timestamp
 
@@ -54,7 +54,7 @@ module Textrepo
     ##
     # 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
 
@@ -63,8 +63,8 @@ module Textrepo
     ##
     # Finds all entries of text those have timestamps which mathes the
     # specified pattern of timestamp.  Returns an array which contains
-    # timestamps.  If none of text was found, an empty array would be
-    # returned.
+    # instances of Timestamp.  If none of text was found, an empty
+    # array would be returned.
     #
     #  A pattern must be one of the following:
     #
@@ -78,9 +78,9 @@ 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
+    #     entries(String) -> Array of Timestamp instances
 
     def entries(stamp_pattern = nil); []; end
 

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,18 +65,28 @@ 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"
+
       def split_stamp(stamp_str)
         #    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".
+      #
+      # :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)

data/lib/textrepo/version.rb

@@ -1,3 +1,3 @@
 module Textrepo
-  VERSION = '0.4.3'
+  VERSION = '0.4.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: textrepo
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - mnbi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-26 00:00:00.000000000 Z
+date: 2020-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler