textrepo 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2806e2488be378495f29ed25dd9d04937d50706a5d7772b5d93fd4d242a675d
-  data.tar.gz: a031757c1eb5fa5ec644b7c6674d030f93aebf07c93ad061ea96711532ab8b79
+  metadata.gz: 9af29cfb5945798beea4d787abc9ec472607841d6daea7dc8e62bf62a3ecc4b2
+  data.tar.gz: 31f97fb8586b206b95f85feaaf653aa0e75a08379677e2019e067c5df03f0b3d
 SHA512:
-  metadata.gz: bcf5e7162744e0d0ba1e0e1745c37b7718749d3aae2ac83c6c8af8f9c032d8b85af38abbbf61d3f19ec49e640060362bcc55085bb7e930868294068314f5da21
-  data.tar.gz: d2074f1b5a09a8741e8172d51d90c31f7c17552473d834e866cb3f7f1d43d2f2633a7daa2aa50a12d2a17202aa58f43466c151793a9368eb7b3fb39977a0379b
+  metadata.gz: 934d63e39badb3ffa660b26e363a1caba78bd3dd906c8c7b24c79374659780def778e7f00b6902a1f80950055d885a954561a74b2301253a086195f48d05a79e
+  data.tar.gz: d25676f649ba6308403f3a8e4e4d2f1d851b9d6026ebe8ee5668d7a8d37a4edc8135f13ead288a963afc81571cc1b0378499630c314334f5b3c223bf8e7dc3f4

data/.gitignore

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

data/lib/textrepo/file_system_repository.rb

@@ -1,27 +1,34 @@
 require 'fileutils'
 
 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
 
     ##
     # 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'
 
     ##
@@ -40,7 +47,7 @@ module Textrepo
     # 
     # Default values are set when `repository_name` and `default_extname`
     # were not defined in `conf`.
-    #
+
     def initialize(conf)
       super
       base = conf[:repository_base]
@@ -53,10 +60,10 @@ 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
-    #
+
     def create(timestamp, text)
       abs = abspath(timestamp)
       raise DuplicateTimestampError, timestamp if FileTest.exist?(abs)
@@ -69,10 +76,10 @@ module Textrepo
     ##
     # Reads the file content in the repository.  Then, returns its
     # content.
-    #
+
     # :call-seq:
     #     read(Timestamp) => Array
-    #
+
     def read(timestamp)
       abs = abspath(timestamp)
       raise MissingTimestampError, timestamp unless FileTest.exist?(abs)
@@ -86,10 +93,10 @@ module Textrepo
     ##
     # Updates the file content in the repository.  A new timestamp
     # will be attached to the text.
-    #
+
     # :call-seq:
     #     update(Timestamp, Array) => Timestamp
-    #
+
     def update(timestamp, text)
       raise EmptyTextError if text.empty?
       org_abs = abspath(timestamp)
@@ -108,10 +115,10 @@ module Textrepo
 
     ##
     # Deletes the file in the repository.
-    #
+
     # :call-seq:
     #     delete(Timestamp) => Array
-    #
+
     def delete(timestamp)
       abs = abspath(timestamp)
       raise MissingTimestampError, timestamp unless FileTest.exist?(abs)
@@ -124,10 +131,10 @@ module Textrepo
 
     ##
     # Finds entries of text those timestamp matches the specified pattern.
-    #
+
     # :call-seq:
     #     entries(String = nil) => Array
-    #
+
     def entries(stamp_pattern = nil)
       results = []
 
@@ -158,19 +165,28 @@ 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
+
     # :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,10 +203,6 @@ 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)

data/lib/textrepo/repository.rb

@@ -1,31 +1,72 @@
 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.
+
+    # :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:
+    # timestamps.  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 +78,31 @@ 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
+
     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
   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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: textrepo
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - mnbi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-23 00:00:00.000000000 Z
+date: 2020-10-26 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