rbnotes 0.4.0 → 0.4.5

data/lib/rbnotes/commands/search.rb

@@ -1,30 +1,33 @@
-# :markup: markdown
-
-##
-# Searches a given pattern in notes those have timestamps match a
-# given timestamp pattern.  The first argument is a pattern to search.
-# It is a String object represents a portion of text or it may a
-# String represents a regular expression.  The second argument is
-# optional and it is a timestamp pattern to specify the search target.
-#
-# A pattern for search is mandatory.  If no pattern, raises
-# Rbnotes::MissingArgumentError.
-#
-# Example of PATTERN:
-#     ""rbnotes" (a word)
-#     "macOS Big Sur" (a few words)
-#     "2[0-9]{3}(0[1-9]|1[0-2])(0[1-9]|[12][0-9]|3[01])" (a regular expression)
-#
-# A timestamp pattern is optional.  If no timestamp pattern, all notes
-# in the repository would be target of search.
-#
-# See the document of `Rbnotes::Commands::List#execute` to know about
-# a timestamp pattern.
-
-# :stopdoc: 
-
-module Rbnotes
-  class Commands::Search < Commands::Command
+module Rbnotes::Commands
+
+  ##
+  # Searches a given pattern in notes those have timestamps match a
+  # given timestamp pattern.  The first argument is a pattern to search.
+  # It is a String object represents a portion of text or it may a
+  # String represents a regular expression.  The second argument is
+  # optional and it is a timestamp pattern to specify the search target.
+  #
+  # A pattern for search is mandatory.  If no pattern, raises
+  # Rbnotes::MissingArgumentError.
+  #
+  # Example of PATTERN for search:
+  #
+  #   "rbnotes" (a word)
+  #   "macOS Big Sur" (a few words)
+  #   "2[0-9]{3}(0[1-9]|1[0-2])(0[1-9]|[12][0-9]|3[01])" (a regular expression)
+  #
+  # A timestamp pattern is optional.  If no timestamp pattern, all notes
+  # in the repository would be target of search.
+  #
+  # See the document of `Rbnotes::Commands::List#execute` to know about
+  # a timestamp pattern.
+
+  class Search < Command
+
+    def description             # :nodoc:
+      "Search a given pattern in notes"
+    end
+
     def execute(args, conf)
       pattern = args.shift
       raise MissingArgumentError, args if pattern.nil?
@@ -42,5 +45,23 @@ module Rbnotes
         }
       end
     end
+
+    def help                    # :nodoc:
+      puts <<HELP
+usage:
+    #{Rbnotes::NAME} search PATTERN [STAMP_PATTERN]
+
+PATTERN is a word (or words) to search, it may also be a regular
+expression.
+
+STAMP_PATTERN must be:
+
+    (a) full qualified timestamp (with suffix): "20201030160200"
+    (b) year and date part: "20201030"
+    (c) year and month part: "202010"
+    (d) year part only: "2020"
+    (e) date part only: "1030"
+HELP
+    end
   end
 end

data/lib/rbnotes/commands/show.rb

@@ -1,5 +1,23 @@
-module Rbnotes
-  class Commands::Show < Commands::Command
+module Rbnotes::Commands
+
+  ##
+  # Shows the content of the note specified by the argument.  The
+  # argument must be a string which can be converted into
+  # Textrepo::Timestamp object.
+  #
+  # A string for Timestamp must be:
+  #
+  #     "20201106112600"     : year, date, time and sec
+  #     "20201106112600_012" : with suffix
+  #
+  # If no argument is passed, reads the standard input for an argument.
+
+  class Show < Command
+
+    def description             # :nodoc:
+      "Show the content of a note"
+    end
+
     def execute(args, conf)
       stamp = Rbnotes::Utils.read_timestamp(args)
 
@@ -17,5 +35,18 @@ module Rbnotes
         puts content
       end
     end
+
+    def help                    # :nodoc:
+      puts <<HELP
+usage:
+    #{Rbnotes::NAME} show [TIMESTAMP]
+
+Show the content of given note.  TIMESTAMP must be a fully qualified
+one, such "20201016165130" or "20201016165130_012" if it has a suffix.
+
+The command try to read its argument from the standard input when no
+argument was passed in the command line.
+HELP
+    end
   end
 end

data/lib/rbnotes/commands/update.rb

@@ -1,37 +1,49 @@
 module Rbnotes::Commands
+
   ##
   # Updates the content of the note associated with given timestamp.
-  # Actual modification is done interactively by the external editor.
+  #
+  # Reads its argument from the standard input when no argument was
+  # passed in the command line.
+  #
   # The timestamp associated with the note will be updated to new one,
   # which is generated while the command exection.
   #
-  # A timestamp string must be specified as the only argument.  It
-  # must exactly match to the one of the target note in the
-  # repository.  When the given timestamp was not found, the command
-  # fails.
-  #
-  # Timestamp which is associated to the target note will be newly
-  # generated with the command execution time.  That is, the timestamp
-  # before the command exection will be obsolete.
+  # When "-k" (or "--keep") option is specified, the timestamp will
+  # remain unchanged.
   #
-  # This command starts the external editor program to edit the
-  # content of the note.  The editor program will be searched as same
-  # as add command.
+  # Actual modification is done interactively by the external editor.
   #
-  # If none of editors is available, the command fails.
+  # The editor program will be searched as same as add command.  If
+  # none of editors is available, the execution fails.
 
   class Update < Command
     include ::Rbnotes::Utils
 
+    def description             # :nodoc:
+      "Update the content of a note"
+    end
+
     ##
     # The 1st and only one argument is the timestamp to speficy the
-    # note to update.  Returns the new timestamp which is associated
-    # to the note updated.
+    # note to update.
     #
     # :call-seq:
     #     "20201020112233" -> "20201021123400"
 
     def execute(args, conf)
+      @opts = {}
+      while args.size > 0
+        arg = args.shift
+        case arg
+        when "-k", "--keep"
+          @opts[:keep_timestamp] = true
+        else
+          args.unshift(arg)
+          break
+        end
+      end
+
       target_stamp = Rbnotes::Utils.read_timestamp(args)
       editor = find_editor(conf[:editor])
       repo = Textrepo.init(conf)
@@ -47,13 +59,18 @@ module Rbnotes::Commands
       text = File.readlines(tmpfile, :chomp => true)
 
       unless text.empty?
+        keep = @opts[:keep_timestamp] || false
         newstamp = nil
         begin
-          newstamp = repo.update(target_stamp, text)
+          newstamp = repo.update(target_stamp, text, keep)
         rescue StandardError => e
           puts e.message
         else
-          puts "Update the note [%s -> %s]" % [target_stamp, newstamp] unless target_stamp == newstamp
+          if keep
+            puts "Update the note content, the timestamp unchanged [%s]" % newstamp
+          else
+            puts "Update the note [%s -> %s]" % [target_stamp, newstamp] unless target_stamp == newstamp
+          end
         ensure
           # Don't forget to remove the temporary file.
           File.delete(tmpfile)
@@ -62,5 +79,27 @@ module Rbnotes::Commands
         puts "Nothing is updated, since the specified content is empty."
       end
     end
+
+    def help                    # :nodoc:
+      puts <<HELP
+usage:
+    #{Rbnotes::NAME} update [TIMESTAMP]
+
+Updates the content of the note associated with given timestamp.
+
+Reads its argument from the standard input when no argument was passed
+in the command line.
+
+The timestamp associated with the note will be updated to new one,
+which is generated while the command exection.
+
+When "-k" (or "--keep") option is specified, the timestamp will remain
+unchanged.
+
+Actual modification is done interactively by the external editor.  The
+editor program will be searched as same as add command.  If none of
+editors is available, the execution fails.
+HELP
+    end
   end
 end

data/lib/rbnotes/version.rb

@@ -1,4 +1,4 @@
 module Rbnotes
-  VERSION = "0.4.0"
-  RELEASE = "2020-11-03"
+  VERSION = "0.4.5"
+  RELEASE = "2020-11-12"
 end

data/rbnotes.gemspec

@@ -25,6 +25,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "textrepo", "~> 0.5"
+  spec.add_dependency "textrepo", "~> 0.5.4"
   spec.add_dependency "unicode-display_width", "~> 1.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbnotes
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.5
 platform: ruby
 authors:
 - mnbi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-03 00:00:00.000000000 Z
+date: 2020-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: textrepo
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.5.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.5.4
 - !ruby/object:Gem::Dependency
   name: unicode-display_width
   requirement: !ruby/object:Gem::Requirement
@@ -64,6 +64,8 @@ files:
 - lib/rbnotes/commands.rb
 - lib/rbnotes/commands/add.rb
 - lib/rbnotes/commands/delete.rb
+- lib/rbnotes/commands/export.rb
+- lib/rbnotes/commands/help.rb
 - lib/rbnotes/commands/import.rb
 - lib/rbnotes/commands/list.rb
 - lib/rbnotes/commands/search.rb