textrepo 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d26af6dd86e8b79c9e50300f8c31102bf79d5c751e175740a7225c2ca4a9b33
-  data.tar.gz: 8d398c0848c0a4b06d2a775f3cb6bf1f49489be7f5ba5d8cf7eab2aad068b5c7
+  metadata.gz: c2806e2488be378495f29ed25dd9d04937d50706a5d7772b5d93fd4d242a675d
+  data.tar.gz: a031757c1eb5fa5ec644b7c6674d030f93aebf07c93ad061ea96711532ab8b79
 SHA512:
-  metadata.gz: ef79855cd99ebc3baea4368c00cdc4d439478cfc9733d45eee1e7a08ca005bf0dc15824cb57b46326c982e724acc762b25b722c112f19ae4f67349d575fffdcb
-  data.tar.gz: 4af657999971e6d3cef41dc5d3ef7ea1017a536b772372d38e79ffb91196c239585a0c932fe10e42f9d7ccbfee8fa477ec31bd97afa9cd4e1c31f0c894772110
+  metadata.gz: bcf5e7162744e0d0ba1e0e1745c37b7718749d3aae2ac83c6c8af8f9c032d8b85af38abbbf61d3f19ec49e640060362bcc55085bb7e930868294068314f5da21
+  data.tar.gz: d2074f1b5a09a8741e8172d51d90c31f7c17552473d834e866cb3f7f1d43d2f2633a7daa2aa50a12d2a17202aa58f43466c151793a9368eb7b3fb39977a0379b

data/.gitignore

@@ -1,8 +1,56 @@
-/.bundle/
-/.yardoc
-/_yardoc/
+*.gem
+*.rbc
+/.config
 /coverage/
-/doc/
+/InstalledFiles
 /pkg/
 /spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
 /tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    textrepo (0.4.1)
+    textrepo (0.4.2)
 
 GEM
   remote: https://rubygems.org/

data/Rakefile

@@ -35,3 +35,12 @@ end
 task :clobber => :clean_sandbox
 CLOBBER << 'test/fixtures/notes'
 CLOBBER << 'test/fixtures/test_repo'
+
+require "rdoc/task"
+
+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

@@ -1,26 +1,46 @@
 require 'fileutils'
 
 module Textrepo
-  # A concrete repository which uses the default file system as a storage.
+  ##
+  # 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
-    attr_reader :path, :extname
+    ##
+    # 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'
 
-    # `conf` must be a Hash object.  It must hold the follwoing
-    # values:
+    ##
+    # Creates a new repository object.  The argument, `conf` must be a
+    # Hash object.  It should hold the follwoing values:
     #
-    # - :repository_type (:file_system)
-    # - :repository_name => basename of the root path for the repository
-    # - :repository_base => the parent directory path for the repository
-    # - :default_extname => extname for a file stored into in the repository
+    # - MANDATORY:
+    #   - :repository_type => `:file_system`
+    #   - :repository_base => the parent directory path for the repository
+    # - 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
     #
     # 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`
     # were not defined in `conf`.
+    #
     def initialize(conf)
       super
       base = conf[:repository_base]
@@ -30,12 +50,13 @@ module Textrepo
       @extname = conf[:default_extname] || FAVORITE_EXTNAME
     end
 
-    #
-    # repository operations
-    #
-
+    ##
     # 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)
@@ -45,8 +66,13 @@ module Textrepo
       timestamp
     end
 
+    ##
     # 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)
@@ -57,8 +83,13 @@ module Textrepo
       content
     end
 
+    ##
     # 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)
@@ -75,7 +106,12 @@ module Textrepo
       new_stamp
     end
 
+    ##
     # Deletes the file in the repository.
+    #
+    # :call-seq:
+    #     delete(Timestamp) => Array
+    #
     def delete(timestamp)
       abs = abspath(timestamp)
       raise MissingTimestampError, timestamp unless FileTest.exist?(abs)
@@ -86,7 +122,12 @@ module Textrepo
       content
     end
 
+    ##
     # Finds entries of text those timestamp matches the specified pattern.
+    #
+    # :call-seq:
+    #     entries(String = nil) => Array
+    #
     def entries(stamp_pattern = nil)
       results = []
 
@@ -117,12 +158,24 @@ module Textrepo
       results
     end
 
+    # :stopdoc:
     private
     def abspath(timestamp)
-      filename = timestamp.to_pathname + ".#{@extname}"
+      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)
+    end
+
     def write_text(abs, text)
       FileUtils.mkdir_p(File.dirname(abs))
       File.open(abs, 'w') { |f|

data/lib/textrepo/timestamp.rb

@@ -1,11 +1,17 @@
 module Textrepo
+  ##
+  # Timstamp is generated from a Time object.  It converts a time to
+  # string in the obvious format, such "20201023122400".
+  #
   class Timestamp
     include Comparable
 
     attr_reader :time, :suffix
 
-    # time: a Time instance
-    # suffix: an Integer instance
+    ##
+    # :call-seq:
+    #   new(Time, Integer = nil)
+    #
     def initialize(time, suffix = nil)
       @time = time
       @suffix = suffix
@@ -20,26 +26,29 @@ module Textrepo
       result == 0 ? (sfx <=> osfx) : result
     end
 
+    ##
+    # 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"
+    # ```
+    #
     def to_s
       s = @time.strftime("%Y%m%d%H%M%S")
       s += "_#{"%03u" % @suffix}" unless @suffix.nil? || @suffix == 0
       s
     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 to_pathname
-      @time.strftime("%Y/%m/") + self.to_s
-    end
-
     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"
+      # ```
+      #
       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]}
@@ -51,13 +60,6 @@ module Textrepo
         Timestamp.new(Time.new(year, mon, day, hour, min, sec), sfx)
       end
 
-      #                      (-2)
-      #  0       8           |(-1)
-      #  V       V           VV
-      # "2020/12/20201230123456" => "2020-12-30 12:34:56"
-      def parse_pathname(pathname)
-        parse_s(pathname[8..-1])
-      end
     end
   end
 end

data/lib/textrepo/version.rb

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

data/textrepo.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["mnbi@users.noreply.github.com"]
 
   spec.summary       = %q{A repository to store text with timestamp.}
-  spec.description   = %q{Textrepo is a repository to store text with timestamp.  It can manage text with the attached timestamp (read/update/delte).}
+  spec.description   = %q{Textrepo is a repository to store text with timestamp.  It can manage text with the attached timestamp (create/read/update/delete).}
   spec.homepage      = "https://github.com/mnbi/textrepo"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: textrepo
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - mnbi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-15 00:00:00.000000000 Z
+date: 2020-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.1'
 description: Textrepo is a repository to store text with timestamp.  It can manage
-  text with the attached timestamp (read/update/delte).
+  text with the attached timestamp (create/read/update/delete).
 email:
 - mnbi@users.noreply.github.com
 executables: []