rbnotes 0.2.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3b44e20631a0216391b389aee7faca4ecebe31502bbff92606c938023a98240
-  data.tar.gz: 4a39041ad77631da13be01ebde0745edd38f22f52b5c9ad2ae1a002053739c1b
+  metadata.gz: '09f402dd55c244533d8f8ba3518df3d13cde1c5952efad94598f210a43a88c11'
+  data.tar.gz: a824e8e2e33c1c1e67d2ff27ab22618d83aa7138a889db20d43f40491f6e1c82
 SHA512:
-  metadata.gz: e98fabf28f56131caf2ec40c1111aa74a0819d923937cd033eeed6921c5ce43102657e8c3d787a8b9718b3057e7505921d2f7d316a327a041e80dcc2bce4b2ae
-  data.tar.gz: 672cd941dd68c545056c752a714bc29df9a9de5b14ce00b8c6568562df619e796c7cea77b376380bb3c32c06d680f834552c3c6367033bf2ab02b7460c4e1b0f
+  metadata.gz: e52be521f1d1502ca2d36fd6853203436e15c3f830e17ff509529b0b7f08a2fad26a264714d81732603e6f6dabe69c2d40bebdb400b306f4fba1218c86c2ac52
+  data.tar.gz: c555b3b74717d45d18a6d63959356ff411457b2f3b47819ca53ecca38fc6de03a9e5d5839e622e5b65d3513c40dfe487b2649206697d075400c1121a61ea99d4

data/CHANGELOG.md

@@ -7,6 +7,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 ## [Unreleased]
 Nothing to record here.
 
+## [0.4.1] - 2020-11-04
+### Added
+- Add a feature to accept a timestamp in `add` command. (#34)
+
+## [0.4.0] - 2020-11-03
+### Added
+- Add a new command `search` to perform full text search. (#33)
+
+## [0.3.1] - 2020-10-30
+### Added
+- Add feature to specify configuration file in the command line. (#21)
+
+## [0.3.0] - 2020-10-29
+### Added
+- Add feature to read argument from the standard input. (#27)
+
+## [0.2.2] - 2020-10-27
+### Added
+- Add feature to accept a timestamp pattern in `list` command. (#22)
+
 ## [0.2.1] - 2020-10-25
 ### Added
 - Add feature to load the configuration from an external file.

data/Gemfile

@@ -6,4 +6,4 @@ gemspec
 gem "rake", "~> 13.0"
 gem "minitest", "~> 5.0"
 
-gem 'textrepo', "~> 0.4"
+gem 'textrepo', "~> 0.5"

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    rbnotes (0.2.1)
-      textrepo (~> 0.4)
+    rbnotes (0.4.1)
+      textrepo (~> 0.5)
       unicode-display_width (~> 1.7)
 
 GEM
@@ -10,7 +10,7 @@ GEM
   specs:
     minitest (5.14.2)
     rake (13.0.1)
-    textrepo (0.4.2)
+    textrepo (0.5.3)
     unicode-display_width (1.7.0)
 
 PLATFORMS
@@ -20,7 +20,7 @@ DEPENDENCIES
   minitest (~> 5.0)
   rake (~> 13.0)
   rbnotes!
-  textrepo (~> 0.4)
+  textrepo (~> 0.5)
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -4,18 +4,25 @@
 
 Rbnotes is a simple utility to write a note in the single repository.
 
+This document provides the basic information to use rbnotes.
+You may find more useful information in [Wiki pages](https://github.com/mnbi/rbnotes/wiki).
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'rbnotes, github: 'mnbi/rbnotes, branch: 'main'
+gem 'rbnotes'
 ```
 
 And then execute:
 
     $ bundle install
 
+Or install it yourself as:
+
+    $ gem install rbnotes
+
 ## Usage
 
 General syntax is:
@@ -24,12 +31,19 @@ General syntax is:
 rbnotes [global_opts] [command] [command_opts] [args]
 ```
 
+### Global options
+
+- "-c CONF_FILE", "--conf"
+  - specifies a configuration file
+
 ### Commands
 
 - import
   - imports existing files
 - list
   - lists notes in the repository with their timestamps and subject
+- search
+  - search a word (or words) in the repository
 - show
   - shows the content of a note
 - add
@@ -53,6 +67,8 @@ Searches the configuration file in the following order:
 
 None of them is found, then the default configuration is used.
 
+The global option "-c CONF_FILE" will override the location.
+
 #### Content
 
 The format of the configuration file must be written in YAML.
@@ -71,14 +87,16 @@ A real example:
 
 ``` yaml
 ---
-:run_mode: :development
+:run_mode: :production
 :repository_type: :file_system
 :repository_name: "notes"
 :repository_base: "~"
-:pager: "bat"
+:pager: "bat -l md"
 :editor: "/usr/local/bin/emacsclient"
 ```
 
+The content is identical to `conf/config.yml`.
+
 #### Variables
 
 ##### :run-mode (mandatory)
@@ -120,13 +138,50 @@ the `:repository_name` value.  It would be:
 
 > :repository_base/:repository_name
 
-The value must be an absolute path.  The short-hand notation of the
-home directory ("~") is usable.
+The value is recommended to be an absolute path in the production
+time, since relative path will be expanded with the current working
+directory.  However, in the development and testing time, the relative
+path may be useful.  See `conf/config_deve.yml` or
+`conf/config_test.yml`.
+
+The short-hand notation of the home directory ("~") is usable.
 
 ##### Miscellaneous variables (optional)
 
 - :pager : specify a pager program
 - :editor : specify a editor program
+- :searcher: specify a program to perform search
+- :searcher_options: specify options to pass to the searcher program
+
+Be careful to set `:searcher` and `:searcher_options`. The searcher
+program must be expected to behave equivalent to `grep` with `-inRE`.
+At least, its output must be the same format and it must runs
+recursively to a directory.
+
+If your favorite searcher is one of the followings, see the default
+options which `textrepo` sets for those searchers.  In most cases, you
+don't have to set `:searcher_options` for them.
+
+| searcher | default options in `textrepo`                      |
+|:---------|:---------------------------------------------------|
+| `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"]` |
+
+Those searcher names are used in macOS (with Homebrew).  Any other OS
+might use different names.
+
+- `grep` and `egrep` -> BSD grep (macOS default)
+- `ggrep` and `gegrep` -> GNU grep
+- `rg` -> ripgrep
+
+If the name is different, `:searcher_options` should be set with the
+same value.  For example, if you system use the name `gnugrep` as GNU
+grep, and you want to use it as the searcher (that is, set `gnugrep`
+to `:searcher`), you should set `:searcher_options` value with `["-i",
+"-n", "-R", "-E"]`.
 
 ##### Default values for mandatory variables
 

data/conf/config.yml

@@ -0,0 +1,7 @@
+---
+:run_mode: :production
+:repository_type: :file_system
+:repository_name: "notes"
+:repository_base: "~"
+:pager: "bat -l md"
+:editor: "/usr/local/bin/emacsclient"

data/conf/config_deve.yml

@@ -0,0 +1,7 @@
+---
+:run_mode: :development
+:repository_type: :file_system
+:repository_name: "notes"
+:repository_base: "tmp"
+:pager: "bat -l md"
+:editor: "/usr/local/bin/emacsclient"

data/conf/config_test.yml

@@ -0,0 +1,5 @@
+---
+:run_mode: :test
+:repository_type: :file_system
+:repository_name: "notes"
+:repository_base: "test/sandbox"

data/exe/rbnotes

@@ -4,20 +4,46 @@ require "rbnotes"
 
 include Rbnotes
 
-DEBUG = true
-
 class App
+  def initialize
+    @gopts = {}
+  end
+
+  def options
+    @gopts
+  end
+
+  def parse_global_options(args)
+    while args.size > 0
+      arg = args.shift
+      case arg
+      when "-c", "--conf"
+        file = args.shift
+        raise ArgumentError, args.unshift(arg) if file.nil?
+        file = File.expand_path(file)
+        raise ArgumentError, "no such file: %s" % file unless FileTest.exist?(file) 
+        @gopts[:conf_file] = file
+      else
+        args.unshift(arg)
+        break
+      end
+    end
+  end
+
   def run(args)
     cmd = args.shift
-    Commands.load(cmd).execute(args, Rbnotes.conf)
+    Commands.load(cmd).execute(args, Rbnotes.conf(@gopts[:conf_file]))
   end
 end
 
 app = App.new
 begin
+  app.parse_global_options(ARGV)
   app.run(ARGV)
 rescue MissingArgumentError, MissingTimestampError,
-       NoEditorError, ProgramAbortError => e
+       NoEditorError, ProgramAbortError,
+       Textrepo::InvalidTimestampStringError,
+       ArgumentError => e
   puts e.message
   exit 1
 end

data/lib/rbnotes/commands.rb

@@ -2,16 +2,20 @@ module Rbnotes
   ##
   # This module defines all command classes of rbnotes.  Each command
   # class must be derived from Rbnotes::Commands::Command class.
+
   module Commands
     ##
     # The base class for a command class.
+
     class Command
+
       ##
       # :call-seq:
-      #   Array, Hash -> nil
+      #   execute(Array, Hash) -> nil
+      #
       #   - Array: arguments for each command
       #   - Hash : rbnotes configuration
-      #
+
       def execute(args, conf)
         Builtins::DEFAULT_CMD.new.execute(args, conf)
       end
@@ -28,20 +32,55 @@ module Rbnotes
       class Help < Command
         def execute(_, _)
           puts <<USAGE
-usage: rbnotes [command] [args]
+usage:
+    rbnotes [-c|--conf CONF_FILE] [command] [args]
+
+option:
+    -c, --conf [CONF_FILE] : specifiy the configuration file
+
+    CONF_FILE must be written in YAML.  To know about details of the
+    configuration file, see README.md or Wiki page.
 
 command:
-    import FILE     : import a FILE into the repository
-    list NUM        : list NUM notes
-    show STAMP      : show the note specified with STAMP
-    delete STAMP    : delete the note specified with STAMP
-
-    conf            : print the current configuraitons
-    repo            : print the repository path
-    stamp  TIME_STR : convert TIME_STR into a timestamp
-    time   STAMP    : convert STAMP into a time string
-    version         : print version
-    help            : show help
+    add            : create a new note
+    import FILE    : import a FILE into the repository
+
+    list [STAMP_PATTERN] : list notes those timestamp matches PATTERN
+    search PATTERN [STAMP_PATTERN] : search PATTERN
+
+    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"
+
+    PATTERN is a word (or words) to search, it may also be a regular
+    expression.
+
+    show   [STAMP] : show the note specified with STAMP
+    update [STAMP] : edit the note with external editor
+    delete [STAMP] : delete the note specified with STAMP
+
+    STAMP must be a sequence of digits to represent year, date and
+    time (and suffix), such "20201030160200" or "20201030160200_012".
+
+    show/update/delete reads its argument from the standard input when
+    no argument was passed in the command line.
+
+    version        : print version
+    help           : show help
+
+command for development:
+    conf           : print the current configuraitons
+    repo           : print the repository path
+    stamp TIME_STR : convert TIME_STR into a timestamp
+    time  STAMP    : convert STAMP into a time string
+
+For more information, see Wiki page.
+    - https://github.com/mnbi/rbnotes/wiki
+
 USAGE
         end
       end
@@ -62,9 +101,9 @@ USAGE
 
           puts case type
                when :file_system
-                 "#{base}/#{name}"
+                 File.expand_path(name, base)
                else
-                 "#{base}/#{name}"
+                 File.join(base, name)
                end
         end
       end
@@ -111,15 +150,16 @@ USAGE
     # :startdoc:
 
     class << self
+
       ##
       # Loads a class to perfom the command, then returns an instance
       # of the class.
       #
       # :call-seq:
-      #   "import" -> an object of Rbnotes::Commnads::Import
-      #   "list"   -> an object of Rbnotes::Commands::List
-      #   "show"   -> an object of Rbnotes::Commands::Show
-      #
+      #   load("import") -> Rbnotes::Commnads::Import
+      #   load("list")   -> Rbnotes::Commands::List
+      #   load("show")   -> Rbnotes::Commands::Show
+
       def load(cmd_name)
         cmd_name ||= DEFAULT_CMD_NAME
         klass_name =  cmd_name.capitalize

data/lib/rbnotes/commands/add.rb

@@ -1,9 +1,20 @@
 module Rbnotes::Commands
+
   ##
-  # Adds a new note to the repository.  A new timestamp is generated
-  # at the execution time, then it is attached to the note.  If the
-  # timestamp has already existed in the repository, the command
-  # fails.
+  # Adds a new note to the repository.  If no options, a new timestamp
+  # is generated at the execution time, then it is attached to the
+  # note.  If the timestamp has already existed in the repository, the
+  # command fails.
+  #
+  # Accepts an option with `-t STAMP_PATTERN` (or `--timestamp`), a
+  # timestamp is generated according to `STAMP_PATTERN`.
+  #
+  # STAMP_PATTERN could be one of followings:
+  #
+  #   "20201104172230_078" : full qualified timestamp string
+  #   "20201104172230"     : full qualified timestamp string (no suffix)
+  #   "202011041722"       : year, date and time (omit second part)
+  #   "11041722"           : date and time (omit year and second part)
   #
   # This command starts the external editor program to prepare text to
   # store.  The editor program will be searched in the following order:
@@ -14,23 +25,37 @@ module Rbnotes::Commands
   # 4. "vi"
   #
   # If none of the above editor is available, the command fails.
-  #
+
   class Add < Command
     include ::Rbnotes::Utils
 
     def execute(args, conf)
-      newstamp = Textrepo::Timestamp.new(Time.now)
+      @opts = {}
+      while args.size > 0
+        arg = args.shift
+        case arg
+        when "-t", "--timestamp"
+          stamp_str = args.shift
+          raise ArgumentError, "missing timestamp: %s" % args.unshift(arg) if stamp_str.nil?
+          stamp_str = complement_timestamp_pattern(stamp_str)
+          @opts[:timestamp] = Textrepo::Timestamp.parse_s(stamp_str)
+        else
+          args.unshift(arg)
+        end
+      end
+
+      stamp = @opts[:timestamp] || Textrepo::Timestamp.new(Time.now)
 
       candidates = [conf[:editor], ENV["EDITOR"], "nano", "vi"].compact
       editor = find_program(candidates)
       raise Rbnotes::NoEditorError, candidates if editor.nil?
 
-      tmpfile = run_with_tmpfile(editor, newstamp.to_s)
+      tmpfile = run_with_tmpfile(editor, stamp.to_s)
       text = File.readlines(tmpfile)
 
       repo = Textrepo.init(conf)
       begin
-        repo.create(newstamp, text)
+        repo.create(stamp, text)
       rescue Textrepo::DuplicateTimestampError => e
         puts e.message
         puts "Just wait a second, then retry."
@@ -39,11 +64,28 @@ module Rbnotes::Commands
       rescue StandardError => e
         puts e.message
       else
-        puts "Add a note [%s]" % newstamp.to_s
+        puts "Add a note [%s]" % stamp.to_s
       ensure
         # Don't forget to remove the temporary file.
         File.delete(tmpfile)
       end
     end
+
+    # :stopdoc:
+    private
+    def complement_timestamp_pattern(pattern)
+      stamp_str = nil
+      case pattern.to_s.size
+      when "yyyymoddhhmiss_lll".size, "yyyymoddhhmiss".size
+        stamp_str = pattern.dup
+      when "yyyymoddhhmi".size  # omit sec part
+        stamp_str = "#{pattern}00"
+      when "moddhhmi".size      # omit year and sec part
+        stamp_str = "#{Time.now.year}#{pattern}00"
+      else
+        raise Textrepo::InvalidTimestampStringError, pattern
+      end
+      stamp_str
+    end
   end
 end

data/lib/rbnotes/commands/delete.rb

@@ -14,21 +14,17 @@
 module Rbnotes
   class Commands::Delete < Commands::Command
     def execute(args, conf)
-      stamp_str = args.shift
-      unless stamp_str.nil?
-        repo = Textrepo.init(conf)
-        begin
-          stamp = Textrepo::Timestamp.parse_s(stamp_str)
-          repo.delete(stamp)
-        rescue Textrepo::MissingTimestampError => e
-          puts e.message
-        rescue StandardError => e
-          puts e.message
-        else
-          puts "Delete [%s]" % stamp.to_s
-        end
+      stamp = Rbnotes::Utils.read_timestamp(args)
+
+      repo = Textrepo.init(conf)
+      begin
+        repo.delete(stamp)
+      rescue Textrepo::MissingTimestampError => e
+        puts e.message
+      rescue StandardError => e
+        puts e.message
       else
-        super
+        puts "Delete [%s]" % stamp.to_s
       end
     end
   end

data/lib/rbnotes/commands/import.rb

@@ -29,7 +29,7 @@ module Rbnotes
               puts "The note [%s] in the repository exactly matches" \
                    " the specified file." % stamp
               puts "It seems there is no need to import the file [%s]." % file
-              exit              # normal end
+              break
             else
               puts "The text in the repository does not match the" \
                    " specified file."
@@ -40,8 +40,8 @@ module Rbnotes
             end
           rescue Textrepo::EmptyTextError => _
             puts "... aborted."
-            puts "The specified file is empyt."
-            exit 1              # error
+            puts "The specified file is empty."
+            break
           end
         end
         if count > 999

data/lib/rbnotes/commands/list.rb

@@ -2,42 +2,79 @@ require "unicode/display_width"
 require "io/console/size"
 
 module Rbnotes
+  ##
+  # Defines `list` command for `rbnotes`.  See the document of execute
+  # method to know about the behavior of this command.
+
   class Commands::List < Commands::Command
+
+    ##
+    # Shows the list of notes in the repository.  The only argument is
+    # optional.  If it passed, it must be an timestamp pattern.  A
+    # timestamp is an instance of Textrepo::Timestamp class.  A
+    # timestamp pattern is a string which would match several
+    # Timestamp objects.
+    #
+    # Here is
+    # several examples of timestamp patterns.
+    #
+    #   "20201027093600_012": a complete string to represent a timestamp
+    #   - this pattern would match exactly one Timestamp object
+    #
+    #   "20201027": specifies year and date
+    #   - all Timestamps those have the same year and date would match
+    #
+    #   "202011": specifies year and month
+    #   - all Timestamps those have the same year and month would match
+    #
+    #   "2020": specifies year only
+    #   - all Timestamps those have the same year would match
+    #
+    #   "1027": specifies date only
+    #   - all Timestamps those have the same date would match, even if
+    #     they have the different year.
+    #
+    # :call-seq:
+    #     execute(Array, Rbnotes::Conf or Hash) -> nil
+
     def execute(args, conf)
-      @row, @column = IO.console_size
-      max = (args.shift || @row - 3).to_i
+      pattern = args.shift      # `nil` is acceptable
 
       @repo = Textrepo.init(conf)
-      notes = @repo.entries.sort{|a, b| b <=> a}
-      notes[0, max].each { |timestamp_str|
-        puts make_headline(timestamp_str)
+      # newer stamp shoud be above
+      stamps = @repo.entries(pattern).sort{|a, b| b <=> a}
+      stamps.each { |timestamp|
+        puts make_headline(timestamp)
       }
     end
 
+    # :stopdoc:
+
     private
     TIMESTAMP_STR_MAX_WIDTH = "yyyymoddhhmiss_sfx".size
+
+    ##
     # Makes a headline with the timestamp and subject of the notes, it
     # looks like as follows:
     #
-    # |<------------------ console column size --------------------->|
-    # +-- timestamp ---+  +--- subject (the 1st line of each note) --+
-    # |                |  |                                          |
-    # 20101010001000_123: # I love Macintosh.                        [EOL]
-    # 20100909090909_999: # This is very very long long loooong subje[EOL]
-    #                   ++
-    #                    ^--- delimiter (2 characters)
+    #   |<------------------ console column size ------------------->|
+    #   +-- timestamp ---+  +-  subject (the 1st line of each note) -+
+    #   |                |  |                                        |
+    #   20101010001000_123: I love Macintosh.                        [EOL]
+    #   20100909090909_999: This is very very long long loooong subje[EOL]
+    #                     ++
+    #                      ^--- delimiter (2 characters)
     #
     # The subject part will truncate when it is long.
-    def make_headline(timestamp_str)
 
+    def make_headline(timestamp)
+      _, column = IO.console_size
       delimiter = ": "
-      subject_width = @column - TIMESTAMP_STR_MAX_WIDTH - delimiter.size - 1
+      subject_width = column - TIMESTAMP_STR_MAX_WIDTH - delimiter.size - 1
 
-      subject = @repo.read(Textrepo::Timestamp.parse_s(timestamp_str))[0]
-      prefix = '# '
-      subject = prefix + subject.lstrip if subject[0, 2] != prefix
+      subject = remove_heading_markup(@repo.read(timestamp)[0])
 
-      ts_part = "#{timestamp_str}    "[0..(TIMESTAMP_STR_MAX_WIDTH - 1)] 
+      ts_part = "#{timestamp.to_s}    "[0..(TIMESTAMP_STR_MAX_WIDTH - 1)] 
       sj_part = truncate_str(subject, subject_width)
 
       ts_part + delimiter + sj_part
@@ -53,5 +90,11 @@ module Rbnotes
       }
       result
     end
+
+    def remove_heading_markup(str)
+      str.sub(/^#+ +/, '')
+    end
+
+    # :startdoc:
   end
 end

data/lib/rbnotes/commands/search.rb

@@ -0,0 +1,44 @@
+module Rbnotes
+
+  ##
+  # 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 Commands::Search < Commands::Command
+    def execute(args, conf)
+      pattern = args.shift
+      raise MissingArgumentError, args if pattern.nil?
+
+      timestamp_pattern = args.shift # `nil` is acceptable
+
+      repo = Textrepo.init(conf)
+      begin
+        result = repo.search(pattern, timestamp_pattern)
+      rescue Textrepo::InvalidSearchResultError => e
+        puts e.message
+      else
+        result.each { |stamp, num, match|
+          puts "#{stamp}:#{num}:#{match}"
+        }
+      end
+    end
+  end
+end

data/lib/rbnotes/commands/show.rb

@@ -1,24 +1,20 @@
 module Rbnotes
   class Commands::Show < Commands::Command
     def execute(args, conf)
-      stamp_str = args.shift
-      unless stamp_str.nil?
-        repo = Textrepo.init(conf)
-        stamp = Textrepo::Timestamp.parse_s(stamp_str)
-        content = repo.read(stamp)
+      stamp = Rbnotes::Utils.read_timestamp(args)
 
-        pager = conf[:pager]
-        unless pager.nil?
-          require 'open3'
-          Open3.pipeline_w(pager) { |stdin|
-            stdin.puts content
-            stdin.close
-          }
-        else
-          puts content
-        end
+      repo = Textrepo.init(conf)
+      content = repo.read(stamp)
+
+      pager = conf[:pager]
+      unless pager.nil?
+        require 'open3'
+        Open3.pipeline_w(pager) { |stdin|
+          stdin.puts content
+          stdin.close
+        }
       else
-        super
+        puts content
       end
     end
   end

data/lib/rbnotes/commands/update.rb

@@ -19,7 +19,7 @@ module Rbnotes::Commands
   # as add command.
   #
   # If none of editors is available, the command fails.
-  #
+
   class Update < Command
     include ::Rbnotes::Utils
 
@@ -30,19 +30,10 @@ module Rbnotes::Commands
     #
     # :call-seq:
     #     "20201020112233" -> "20201021123400"
-    #
-    def execute(args, conf)
-      raise Rbnotes::MissingArgumentError, args if args.size < 1
-
-      target_stamp = nil
-      begin
-        target_stamp = Textrepo::Timestamp.parse_s(args.shift)
-      rescue ArgumentError => e
-        raise Rbnotes::MissingArgumentError, args
-      end
 
+    def execute(args, conf)
+      target_stamp = Rbnotes::Utils.read_timestamp(args)
       editor = find_editor(conf[:editor])
-
       repo = Textrepo.init(conf)
 
       text = nil
@@ -53,7 +44,7 @@ module Rbnotes::Commands
       end
 
       tmpfile = run_with_tmpfile(editor, target_stamp.to_s, text)
-      text = File.readlines(tmpfile)
+      text = File.readlines(tmpfile, :chomp => true)
 
       unless text.empty?
         newstamp = nil
@@ -62,7 +53,7 @@ module Rbnotes::Commands
         rescue StandardError => e
           puts e.message
         else
-          puts "Update the note [%s -> %s]" % [target_stamp, newstamp]
+          puts "Update the note [%s -> %s]" % [target_stamp, newstamp] unless target_stamp == newstamp
         ensure
           # Don't forget to remove the temporary file.
           File.delete(tmpfile)

data/lib/rbnotes/error.rb

@@ -1,10 +1,11 @@
 module Rbnotes
   ##
   # A base class for each error class of rbnotes.
-  #
+
   class Error < StandardError; end
 
   # :stopdoc:
+
   module ErrMsg
     MISSING_ARGUMENT  = "missing argument: %s"
     MISSING_TIMESTAMP = "missing timestamp: %s"
@@ -16,7 +17,7 @@ module Rbnotes
 
   ##
   # An error raised if an essential argument was missing.
-  #
+
   class MissingArgumentError < Error
     def initialize(args)
       super(ErrMsg::MISSING_ARGUMENT % args.to_s)
@@ -26,7 +27,7 @@ module Rbnotes
   ##
   # An error raised if a given timestamp was not found in the
   # repository.
-  #
+
   class MissingTimestampError < Error
     def initialize(timestamp)
       super(ErrMsg::MISSING_TIMESTAMP % timestamp)
@@ -36,7 +37,7 @@ module Rbnotes
   ##
   # An error raised if no external editor is available to edit a note,
   # even "nano" or "vi".
-  #
+
   class NoEditorError < Error
     def initialize(names)
       super(ErrMsg::NO_EDITOR % names.to_s)
@@ -46,6 +47,7 @@ module Rbnotes
   ##
   # An error raised when a external program such an editor was aborted
   # during its execution.
+
   class ProgramAbortError < Error
     def initialize(cmdline)
       super(ErrMsg::PROGRAM_ABORT % cmdline.join(" "))

data/lib/rbnotes/utils.rb

@@ -86,6 +86,41 @@ module Rbnotes
     end
     module_function :run_with_tmpfile
 
+    ##
+    # Generates a Textrepo::Timestamp object from a String which comes
+    # from the command line arguments.  When no argument is given,
+    # then reads from STDIN.
+    #
+    # :call-seq:
+    #   read_timestamp(args) -> String
+
+    def read_timestamp(args)
+      str = args.shift || read_arg($stdin)
+      Textrepo::Timestamp.parse_s(str)
+    end
+    module_function :read_timestamp
+
+    ##
+    # Reads an argument from the IO object.  Typically, it is intended
+    # to be used with STDIN.
+    #
+    # :call-seq:
+    #   read_arg(IO) -> String
+
+    def read_arg(io)
+      # assumes the reading line looks like:
+      #
+      #     foo bar baz ...
+      #
+      # then, only the first string is interested
+      begin
+        io.gets.split(":")[0].rstrip
+      rescue NoMethodError => _
+        nil
+      end
+    end
+    module_function :read_arg
+
     # :stopdoc:
 
     private

data/lib/rbnotes/version.rb

@@ -1,4 +1,4 @@
 module Rbnotes
-  VERSION = "0.2.1"
-  RELEASE = '2020-10-25'
+  VERSION = "0.4.1"
+  RELEASE = "2020-11-04"
 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.4"
+  spec.add_dependency "textrepo", "~> 0.5"
   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.2.1
+  version: 0.4.1
 platform: ruby
 authors:
 - mnbi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-25 00:00:00.000000000 Z
+date: 2020-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: textrepo
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: unicode-display_width
   requirement: !ruby/object:Gem::Requirement
@@ -56,6 +56,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- conf/config.yml
+- conf/config_deve.yml
+- conf/config_test.yml
 - exe/rbnotes
 - lib/rbnotes.rb
 - lib/rbnotes/commands.rb
@@ -63,6 +66,7 @@ files:
 - lib/rbnotes/commands/delete.rb
 - lib/rbnotes/commands/import.rb
 - lib/rbnotes/commands/list.rb
+- lib/rbnotes/commands/search.rb
 - lib/rbnotes/commands/show.rb
 - lib/rbnotes/commands/update.rb
 - lib/rbnotes/conf.rb