rbnotes 0.4.14 → 0.4.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21771aaf2f868b68cafa9e3643540a8bae49a96ce3662038c49d3a5053b37b04
-  data.tar.gz: c91cd115792241d9f441efd93c56305c7b0c97dc02ece0f411ee73277f6bfd82
+  metadata.gz: 6b77835e83f5e0d1397d86e19cde13466b02cfb84d211d2521c7180f2e362861
+  data.tar.gz: 28821a8a8b53df64caf1c06baa83d61ffd63ae4a739199971e9d560111fc709f
 SHA512:
-  metadata.gz: 4bd54a316a4b8461ba93126cffbd2e154fc6231395b8ee7c792c2aeb941cc710ac4f2e4e5b75eb3d902cc5cccb32bd412bfc2b7418b2ab1d9d00173ced928360
-  data.tar.gz: 1a600b848a559c743789ac1a55f8fcc932da10a063b4d25e31c04d2af94d79c346368271d86a2565fb1d325659c8cf5acbb588a53ac27b227c990d5cce801889
+  metadata.gz: 1aad71bb657dd5c3fd9ec40b493fb3290df4e21a4b333bd8c7bb1cfe0368ae226eff1cee04615fc2f7a5cd7054593de20924d1722e88743d9faf686eb8959298
+  data.tar.gz: 3c4a1631efceb61c11f90cc3c97dcdeeb9a7b8dee3cc5cabb3b5071af9e97ce01296fefba830a346edfdf7fd28a3a6930793b1d09e185c3d0c2615bf73f18d32

data/CHANGELOG.md

@@ -5,10 +5,66 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](https://semver.org/).
 
 ## [Unreleased]
-- Nothing to record here.
+- (nothing to record here)
+
+## [0.4.19] - 2021-05-24
+### Added
+- Add an option to search in only the subject of each note. (#128)
+
+### Modified
+- Update copyright year in `LICENSE`. (#127)
+
+### Fixed
+- Fix #129: add description about the keyword, "all."
+
+## [0.4.18] - 2021-04-29
+### Added
+- Use ERB to generate the initial content of a new note from the
+  template file (`add`) (#125)
+
+### Fixed
+- Add info about template feature of `add`: (#124)
+  - update help text of `add`,
+  - update `README.md`.
+- Add description about `ugrep` to `README.md`. (#122)
+- Fix issue #118: help text of `list` is wrong.
+- Fix issue #119: a test for `Rbnotes::Utils` may fails.
+  - fix the test.
+
+## [0.4.17] - 2021-04-21
+### Added
+- Change for the `show` command to accept keywords. (#84)
+- Add `-r` option to the `show` command. (#110)
+  - which specifies to enable "raw" output mode.
+
+### Fixed
+- Update the help text for the `list` command. (#112, #113)
+- Remove trailing spaces. (#108)
+- Fix minor bugs:
+  - remove redundant use of an instance variable,
+  - change the behavior to exit when no notes found in the repo,
+    - `pick` and `show`
+  - change delimiter line size according to terminal column.
+    - `show`
+
+## [0.4.16] - 2021-04-17
+### Added
+- Add a new configuration setting to change the default behavior of
+  the `list` (and `pick`) command. (#109)
+
+## [0.4.15] - 2021-04-15
+### Added
+- Enable to use delimiters within a timestamp string. (#104)
+
+### Fixed
+- Fix issue #105: `list` ignores the 2nd arg when specified `-w`
+  option.
 
 ## [0.4.14] - 2021-04-10
+### Added
 - Add `-n` option to `show` command. (#102)
+
+### Fixed
 - Fix issue #100: modify to catch Textrepo::MissingTimestampError.
 
 ## [0.4.13] - 2021-03-30

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rbnotes (0.4.14)
+    rbnotes (0.4.19)
       textrepo (~> 0.5.8)
       unicode-display_width (~> 1.7)
 

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 mnbi
+Copyright (c) 2020, 2021 mnbi
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -149,6 +149,7 @@ The short-hand notation of the home directory ("~") is usable.
 
 ##### Miscellaneous variables (optional)
 
+- :template : specify a template file for `add` command
 - :pager : specify a pager program
 - :editor : specify a editor program
 - :searcher: specify a program to perform search
@@ -170,13 +171,15 @@ don't have to set `:searcher_options` for them.
 | `ggrep`  | `["-i", "-n", "-H", "-R", "-E"]`                   |
 | `gegrep` | `["-i", "-n", "-H", "-R"]`                         |
 | `rg`     | `["-S", "-n", "--no-heading", "--color", "never"]` |
+| `ugrep`  | `["-i", "-n", "-H", "-R", "--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
+- `ggrep` and `gegrep` -> [GNU grep](https://www.gnu.org/software/grep/)
+- `rg` -> [BurntSushi/ripgrep](https://github.com/BurntSushi/ripgrep)
+- `ugrep` -> [Genivia/ugrep](https://github.com/Genivia/ugrep)
 
 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
@@ -184,6 +187,48 @@ 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"]`.
 
+##### Template file for `add` command
+
+`Add` command always searches a template file in the default
+directory.  The default directory is,
+
+- `$XDG_CONIFG_HOME/rbnotes/templates` (if `$XDG_CONFIG_HOME` is defined)
+
+or
+
+- `$HOME/.config/rbnotes/templates`
+
+If a file which named as `default.md` is found in the above directory,
+it will use as a template file to generate the initial content of a
+new note.
+
+When a command line option or a setting of the configuration file is
+specified to use a template file, `add` command will read it instead
+of the default template file.
+
+Command line option of `add` to specify a template file is:
+
+``` shell
+> rbntoes add -f /somewhere/template.md
+```
+
+See the above section about the configuration file setting to specify
+a template file.
+
+Though a template file can be written any format of text (markdown,
+HTML, plain text, or ...), `add` command will process the content
+using ERB.  So, using ERB syntax, you can mix Ruby code in a template
+file.
+
+Here is a very simple and short example to use ERB syntax:
+
+``` markdown
+## <%= Time.now.strftime("%Y-%m-%d") %>
+```
+
+It just insert a date string like "2021-04-29" at the top of a new
+note which generates by `add` command.
+
 ##### Default values for mandatory variables
 
 All mandatory variables have their default values.  Here is the list

data/exe/rbnotes

@@ -21,7 +21,7 @@ class App
         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) 
+        raise ArgumentError, "no such file: %s" % file unless FileTest.exist?(file)
         @gopts[:conf_file] = file
       when "-v", "--version"
         args.clear

data/lib/rbnotes/commands.rb

@@ -192,7 +192,7 @@ string could be used as an argument of some rbnotes commands, such
     "2020-11-06"          -> "20201106000000"
     "20201106"            -> "20201106000000"
     "2020-11-06 16"       -> "20201106160000"
-    "2020-11-06 16:51"    -> "20201106165100" 
+    "2020-11-06 16:51"    -> "20201106165100"
 STAMP
         end
       end

data/lib/rbnotes/commands/add.rb

@@ -1,5 +1,7 @@
 module Rbnotes::Commands
 
+  require "erb"
+
   ##
   # 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
@@ -16,15 +18,39 @@ module Rbnotes::Commands
   #   "202011041722"       : year, date and time (omit second part)
   #   "11041722"           : date and time (omit year and second part)
   #
+  # Also accepts an option with `-f FILENAME` (or `--template-file`)
+  # to specify a template file which will be the initial content of a
+  # new note.
+  #
   # This command starts the external editor program to prepare text to
   # store.  The editor program will be searched in the following order:
   #
-  # 1. conf[:editor] (conf is the 1st arg of execute method)
-  # 2. ENV["EDITOR"]
-  # 3. "nano"
-  # 4. "vi"
+  #   1. conf[:editor] (conf is the 1st arg of execute method)
+  #   2. ENV["EDITOR"]
+  #   3. "nano"
+  #   4. "vi"
   #
   # If none of the above editor is available, the command fails.
+  #
+  # TEMPLATE FILE:
+  #
+  # This command search a file as its template which will be the initial
+  # conent of a new note when an option or a setting in the configuration
+  # file (`:template`) is specified a template file.
+  #
+  # Or, even if neither an option nor a setting about a template file is
+  # specified, it always searches the default directory to read a template
+  # file.  The directory is:
+  #
+  #   - $XDG_CONIFG_HOME/rbnotes/templates (if $XDG_CONFIG_HOME is defined)
+  # or
+  #   - $HOME/.config/rbnotes/templates
+  #
+  # If a file, `default.md` exists in the above directory, it will used as
+  # a template.
+  #
+  # A template file can be written in ERB syntax.  See ERB manual to know
+  # about how to mix ruby code and text content in ERB syntax.
 
   class Add < Command
 
@@ -34,22 +60,7 @@ module Rbnotes::Commands
 
     def execute(args, conf)
       @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)
-        when "-f", "--template-file"
-          template_path = args.shift
-          @opts[:template] = template_path
-        else
-          args.unshift(arg)
-          break
-        end
-      end
+      parse_opts(args)
 
       stamp = @opts[:timestamp] || Textrepo::Timestamp.new(Time.now)
 
@@ -93,16 +104,26 @@ usage:
 Add 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.
 
+OPTIONS:
+    -t, --timestamp STAMP_PATTERN
+    -f, --template-file FILENAME
+
 Accept an option with `-t STAMP_PATTERN` (or `--timestamp`), a
-timestamp is generated according to `STAMP_PATTERN`.
+timestamp of a new note is generated according to `STAMP_PATTERN`.
+
+Also accepts an option with `-f FILENAME` (or `--template-file`) to
+specify a template file which will be the initial content of a new
+note.  See below section more about a template file.
 
-STAMP_PATTERN could be one of followings:
+STAMP_PATTERN could be:
 
     "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)
 
+EDITOR:
+
 This command starts the external editor program to prepare text to
 store.  The editor program will be searched in the following order:
 
@@ -112,11 +133,55 @@ store.  The editor program will be searched in the following order:
     4. "vi"
 
 If none of the above editor is available, the execution fails.
+
+TEMPLATE FILE:
+
+This command search a file as its template which will be the initial
+conent of a new note when an option or a setting in the configuration
+file (`:template`) is specified a template file.
+
+Or, even if neither an option nor a setting about a template file is
+specified, it always searches the default directory to read a template
+file.  The directory is:
+
+- $XDG_CONIFG_HOME/rbnotes/templates (if $XDG_CONFIG_HOME is defined)
+
+or
+
+- $HOME/.config/rbnotes/templates
+
+If a file, `default.md` exists in the above directory, it will used as
+a template.
+
+A template file can be written in ERB syntax.  See ERB manual to know
+about how to mix ruby code and text content in ERB syntax.
+
 HELP
     end
 
     # :stopdoc:
+
     private
+
+    def parse_opts(args)
+      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)
+        when "-f", "--template-file"
+          template_path = args.shift
+          @opts[:template] = template_path
+        else
+          args.unshift(arg)
+          break
+        end
+      end
+    end
+
     def complement_timestamp_pattern(pattern)
       stamp_str = nil
       case pattern.to_s.size
@@ -138,10 +203,15 @@ HELP
 
       if template_path
         raise Rbnotes::NoTemplateFileError, template_path unless FileTest.exist?(template_path)
-        template = File.readlines(template_path, chomp: true)
       else
         template_path = default_template_file(conf)
-        template = File.readlines(template_path, chomp: true) if FileTest.exist?(template_path)
+        return nil unless FileTest.exist?(template_path)
+      end
+
+      erb_source = File.read(template_path)
+      if erb_source and !erb_source.empty?
+        erb = ERB.new(erb_source)
+        template = erb.result.split("\n")
       end
 
       template

data/lib/rbnotes/commands/commands.rb

@@ -12,18 +12,7 @@ module Rbnotes::Commands
 
     def execute(args, conf)
       @opts = {}
-      while args.size > 0
-        arg = args.shift
-        case arg.to_s
-        when ""                 # no options
-          break
-        when "-d", "--deve-commands"
-          @opts[:print_deve_commands] = true
-        else                    # invalid options or args
-          args.unshift(arg)
-          raise ArgumentError, "invalid option or argument: %s" % args.join(" ")
-        end
-      end
+      parse_opts(args)
 
       puts commands(@opts[:print_deve_commands]).join(" ")
     end
@@ -42,8 +31,24 @@ HELP
     end
 
     # :stopdoc:
+
     private
 
+    def parse_opts(args)
+      while args.size > 0
+        arg = args.shift
+        case arg.to_s
+        when ""                 # no options
+          break
+        when "-d", "--deve-commands"
+          @opts[:print_deve_commands] = true
+        else                    # invalid options or args
+          args.unshift(arg)
+          raise ArgumentError, "invalid option or argument: %s" % args.join(" ")
+        end
+      end
+    end
+
     ##
     # Enumerates all command names.
     #

data/lib/rbnotes/commands/import.rb

@@ -29,16 +29,7 @@ module Rbnotes::Commands
 
     def execute(args, conf)
       @opts = {}
-      while args.size > 0
-        arg = args.shift
-        case arg
-        when "-m", "--use-mtime"
-          @opts[:use_mtime] = true
-        else
-          args.unshift(arg)
-          break
-        end
-      end
+      parse_opts(args)
 
       file = args.shift
       unless file.nil?
@@ -116,5 +107,25 @@ If birthtime is not available on the system, use mtime (modification
 time).
 HELP
     end
+
+    # :stopdoc:
+
+    private
+
+    def parse_opts(args)
+      while args.size > 0
+        arg = args.shift
+        case arg
+        when "-m", "--use-mtime"
+          @opts[:use_mtime] = true
+        else
+          args.unshift(arg)
+          break
+        end
+      end
+    end
+
+    # :startdoc:
+
   end
 end

data/lib/rbnotes/commands/list.rb

@@ -10,13 +10,16 @@ module Rbnotes::Commands
       "List notes"
     end
 
+    DEFAULT_BEHAVIOR = "today"  # :nodoc:
+
     ##
     # Shows a list of notes in the repository.  Arguments are
     # optional.  If several args are passed, each of them must be a
     # timestamp pattern or a keyword.
     #
     # Any order of timestamp patterns and keywords mixture is
-    # acceptable.  The redundant patterns are just ignored.
+    # acceptable.  The redundant patterns or invalid patterns are just
+    # ignored.
     #
     # A timestamp pattern is a string which would match several
     # Timestamp objects.  A timestamp is an instance of
@@ -30,6 +33,7 @@ module Rbnotes::Commands
     #   - "last_week"  (or "lw")
     #   - "this_month" (or "tm")
     #   - "last_month" (or "lm")
+    #   - "all"
     #
     # Here is several examples of timestamp patterns.
     #
@@ -54,38 +58,31 @@ module Rbnotes::Commands
 
     def execute(args, conf)
       @opts = {}
-      while args.size > 0
-        arg = args.shift
-        case arg
-        when "-w", "--week"
-          @opts[:enum_week] = true
-        when "-v", "--verbose"
-          @opts[:verbose] = true
-        else
-          args.unshift(arg)
-          break
-        end
+      parse_opts(args)
+
+      if args.empty? and !@opts[:enum_week]
+        default_behavior = conf[:list_default] || DEFAULT_BEHAVIOR
+        args << default_behavior
       end
 
       utils = Rbnotes.utils
       patterns = utils.read_timestamp_patterns(args, enum_week: @opts[:enum_week])
 
-      @repo = Textrepo.init(conf)
-      notes = utils.find_notes(patterns, @repo)
+      repo = Textrepo.init(conf)
+      stamps = utils.find_notes(patterns, repo)
       output = []
       if @opts[:verbose]
-        collect_timestamps_by_date(notes).each { |date, timestamps|
+        collect_timestamps_by_date(stamps).each { |date, timestamps|
           output << "#{date} (#{timestamps.size})"
           timestamps.each { |timestamp|
             pad = "  "
             output << utils.make_headline(timestamp,
-                                                  @repo.read(timestamp), pad)
+                                          repo.read(timestamp), pad)
           }
         }
       else
-        notes.each { |timestamp|
-          output << utils.make_headline(timestamp,
-                                                @repo.read(timestamp))
+        stamps.each { |timestamp|
+          output << utils.make_headline(timestamp, repo.read(timestamp))
         }
       end
       puts output
@@ -94,13 +91,39 @@ module Rbnotes::Commands
     def help                    # :nodoc:
       puts <<HELP
 usage:
-    #{Rbnotes::NAME} list [-w|--week][STAMP_PATTERN|KEYWORD]
+    #{Rbnotes::NAME} list [OPTIONS] [STAMP_PATTERN|KEYWORD]
 
-Show a list of notes.  When no arguments, make a list with all notes
-in the repository.  When specified STAMP_PATTERN, only those match the
-pattern are listed.  Instead of STAMP_PATTERN, some KEYWORDs could be
+Show a list of notes.  When specified several STAMP_PATTERNs, only
+those match the pattern are listed.  Also, some KEYWORDs could be
 used.
 
+When no STAMP_PATTERN or KEYWORD was specified, the behavior of this
+command could be specified with a configuration setting,
+":list_default:".  The value must be one of valid keywords.  If no
+settings was also given, this command would behave like "today" was
+specified as the setting.
+
+OPTIONS:
+    -v, --verbose
+    -w, --week
+
+An option "--verbose" is acceptable.  It specifies to counts number of
+notes by each day, then put it with the date before notes.  It looks
+like as follows:
+
+    2021-04-19 (3)
+      20210419134222: Foo
+      20210419120235: Bar
+      20210419110057: Baz
+    2021-04-18 (1)
+      20210418125353: Hoge
+          :
+
+An option "--week" is also acceptable.  It specifies to enumerate all
+days of a week.  Typically, the option is used with a STAMP_PATTERN
+which specifies a date, such "20201117", then it enumerates all days
+of the week which contains "17th November 2020".
+
 STAMP_PATTERN must be:
 
     (a) full qualified timestamp (with suffix): "20201030160200"
@@ -109,6 +132,12 @@ STAMP_PATTERN must be:
     (d) year part only: "2020"
     (e) date part only: "1030"
 
+A STAMP_PATTERN other than (a) and (b) causes an error if it was used
+with "--week" option.
+
+When no STAMP_PATTERN was specified with "--week" option, the output
+would be as same as the KEYWORD, "this_week" was specified.
+
 KEYWORD:
 
     - "today"      (or "to")
@@ -117,17 +146,10 @@ KEYWORD:
     - "last_week"  (or "lw")
     - "this_month" (or "tm")
     - "last_month" (or "lm")
+    - "all"
 
-An option "--week" is also acceptable.  It specifies to enumerate all
-days of a week.  Typically, the option is used with a STAMP_PATTERN
-which specifies a date, such "20201117", then it enumerates all days
-of the week which contains "17th November 2020".
+The keyword, "all" specifies to enumerate all notes in the repository.
 
-A STAMP_PATTERN other than (a) and (b) causes an error if it was used
-with "--week" option.
-
-When no STAMP_PATTERN was specified with "--week" option, the output
-would be as same as the KEYWORD, "this_week" was specified.
 HELP
     end
 
@@ -135,6 +157,21 @@ HELP
 
     private
 
+    def parse_opts(args)
+      while args.size > 0
+        arg = args.shift
+        case arg
+        when "-w", "--week"
+          @opts[:enum_week] = true
+        when "-v", "--verbose"
+          @opts[:verbose] = true
+        else
+          args.unshift(arg)
+          break
+        end
+      end
+    end
+
     def collect_timestamps_by_date(timestamps)
       result = {}
       timestamps.map { |ts|

data/lib/rbnotes/commands/pick.rb

@@ -9,27 +9,28 @@ module Rbnotes::Commands
       "Pick a timestamp with a picker program"
     end
 
+    DEFAULT_BEHAVIOR = "today"  # :nodoc:
+
     def execute(args, conf)
       @opts = {}
-      while args.size > 0
-        arg = args.shift
-        case arg
-        when "-w", "--week"
-          @opts[:enum_week] = true
-        else
-          args.unshift(arg)
-          break
-        end
+      parse_opts(args)
+
+      if args.empty?
+        default_behavior = conf[:list_default] || DEFAULT_BEHAVIOR
+        args << default_behavior
       end
 
       utils = Rbnotes.utils
       patterns = utils.read_timestamp_patterns(args, enum_week: @opts[:enum_week])
 
-      @repo = Textrepo.init(conf)
+      repo = Textrepo.init(conf)
+
+      stamps = utils.find_notes(patterns, repo)
+      return if stamps.empty?
 
       list = []
-      utils.find_notes(patterns, @repo).each { |timestamp|
-        list << utils.make_headline(timestamp, @repo.read(timestamp))
+      stamps.each { |timestamp|
+        list << utils.make_headline(timestamp, repo.read(timestamp))
       }
 
       picker = conf[:picker]
@@ -61,5 +62,25 @@ is specified, it will behave as same as "list" command.
 
 HELP
     end
+
+    # :stopdoc:
+
+    private
+
+    def parse_opts(args)
+      while args.size > 0
+        arg = args.shift
+        case arg
+        when "-w", "--week"
+          @opts[:enum_week] = true
+        else
+          args.unshift(arg)
+          break
+        end
+      end
+    end
+
+    # :startdoc:
+
   end
 end

data/lib/rbnotes/commands/search.rb

@@ -29,6 +29,9 @@ module Rbnotes::Commands
     end
 
     def execute(args, conf)
+      @opts = {}
+      parse_opts(args)
+
       pattern = args.shift
       raise MissingArgumentError, args if pattern.nil?
 
@@ -46,11 +49,18 @@ module Rbnotes::Commands
     def help                    # :nodoc:
       puts <<HELP
 usage:
-    #{Rbnotes::NAME} search PATTERN [STAMP_PATTERN]
+    #{Rbnotes::NAME} search [OPTIONS] PATTERN [STAMP_PATTERN]
 
 PATTERN is a word (or words) to search, it may also be a regular
 expression.
 
+OPTIONS:
+    -s, --subject-only
+
+An option "--subject-only" is acceptable.  It specifies to search in
+only the subject of each note.  The subject means the first line of
+the note text.
+
 STAMP_PATTERN must be:
 
     (a) full qualified timestamp (with suffix): "20201030160200"
@@ -58,11 +68,25 @@ STAMP_PATTERN must be:
     (c) year and month part: "202010"
     (d) year part only: "2020"
     (e) date part only: "1030"
+
 HELP
     end
 
     private
 
+    def parse_opts(args)
+      while args.size > 0
+        arg = args.shift
+        case arg
+        when "-s", "--subject-only"
+          @opts[:subject_only] = true
+        else
+          args.unshift(arg)
+          break
+        end
+      end
+    end
+
     # Each entry of search result is:
     #
     #   [<timestamp>, <line_number>, <matched_text>]
@@ -84,6 +108,10 @@ HELP
     }
 
     def print_search_result(entries)
+      if @opts[:subject_only]
+        entries.select!{|e| e.line_number == 1}
+      end
+
       maxcol_stamp = entries.map(&:timestamp_size).max
       maxcol_num = entries.map(&:line_number_digits_size).max
 
@@ -91,7 +119,11 @@ HELP
         stamp_display = "%- *s" % [maxcol_stamp, e.timestamp]
         num_display = "%*d" % [maxcol_num, e.line_number]
 
-        puts "#{stamp_display}: #{num_display}: #{e.matched_text}"
+        if @opts[:subject_only]
+          puts "#{stamp_display}: #{e.matched_text}"
+        else
+          puts "#{stamp_display}: #{num_display}: #{e.matched_text}"
+        end
       }
     end
 

data/lib/rbnotes/commands/show.rb

@@ -1,18 +1,13 @@
 module Rbnotes::Commands
 
   ##
-  # Shows the content of the notes specified by arguments.  Each
-  # argument must be a string which can be converted into
-  # Textrepo::Timestamp object.
+  # Shows the content of the notes specified by arguments.  Arguments
+  # should be timestamp patterns or keywords.  See the document for
+  # the `list` command to know about such arguments.
   #
   # Accepts an option with `-n NUMBER` (or `--num-of-lines`), to show
   # the first NUMBER lines of the content of each note.
   #
-  # A string for Textrepo::Timestamp must be:
-  #
-  #     "20201106112600"     : year, date, time and sec
-  #     "20201106112600_012" : with suffix
-  #
   # If no argument is passed, reads the standard input for arguments.
   # If a specified timestamp does not exist in the repository as a key,
   # Rbnotes::MissingTimestampError will occur.
@@ -26,8 +21,9 @@ module Rbnotes::Commands
       @opts = {}
       parse_opts(args)
 
-      stamps = Rbnotes.utils.read_multiple_timestamps(args)
       repo = Textrepo.init(conf)
+      stamps = read_timestamps(args, repo)
+      return if stamps.empty?
 
       content = stamps.map { |stamp|
         begin
@@ -45,7 +41,7 @@ module Rbnotes::Commands
       }.to_h
 
       pager = conf[:pager]
-      unless pager.nil?
+      unless pager.nil? or @opts[:raw]
         puts_with_pager(pager, make_output(content))
       else
         puts make_output(content)
@@ -55,14 +51,23 @@ module Rbnotes::Commands
     def help                    # :nodoc:
       puts <<HELP
 usage:
-    #{Rbnotes::NAME} show [(-n|--num-of-lines) NUMBER] [TIMESTAMP...]
+    #{Rbnotes::NAME} show [OPTIONS] [STAMP_PATTERN|KEYWORD...]
 
-Show the content of given notes.  TIMESTAMP must be a fully qualified
-one, such "20201016165130" or "20201016165130_012" if it has a suffix.
+Show the content of given notes.  It accepts timestamp patterns and
+keywords like the `list` (or `pick`) command.  See the help for the
+`list` command to know more about stamp patterns and keywords.
+
+OPTIONS:
+    -n, --num-of-lines NUMBER
+    -r, --raw
 
 Accept an option with `-n NUMBER` (or `--num-of-lines`), to show the
 first NUMBER lines of the content of each note.
 
+Also accepts `-r` (or `--raw`) option to specify to use "raw" output,
+which means no use any pager, no apply to any process to make output.
+The behavior is intended to be used within a pipeline.
+
 The command try to read its argument from the standard input when no
 argument was passed in the command line.
 HELP
@@ -84,6 +89,8 @@ HELP
           raise ArgumentError, "illegal number (must be greater than 0): %d" % num_of_lines unless num_of_lines > 0
 
           @opts[:num_of_lines] = num_of_lines
+        when "-r", "--raw"
+          @opts[:raw] = true
         else
           args.unshift(arg)
           break
@@ -91,6 +98,17 @@ HELP
       end
     end
 
+    def read_timestamps(args, repo)
+      utils = Rbnotes.utils
+      if args.empty?
+        stamps = utils.read_multiple_timestamps(args)
+      else
+        patterns = utils.read_timestamp_patterns(args)
+        stamps = utils.find_notes(patterns, repo)
+      end
+      stamps
+    end
+
     def puts_with_pager(pager, output)
       require "open3"
       Open3.pipeline_w(pager) { |stdin|
@@ -108,7 +126,7 @@ HELP
 
       _, column = IO.console_size
       output = content.map { |timestamp, text|
-        ary = [make_heading(timestamp, [column, 72].min)]
+        ary = [make_heading(timestamp, column - 10)]
         ary.concat(text)
         ary
       }

data/lib/rbnotes/commands/statistics.rb

@@ -9,20 +9,14 @@ module Rbnotes::Commands
     end
 
     def execute(args, conf)
+      @opts = {}
+      parse_opts(args)
+
       report = :total
-      while args.size > 0
-        arg = args.shift
-        case arg
-        when "-y", "--yearly"
-          report = :yearly
-          break
-        when "-m", "--monthly"
-          report = :monthly
-          break
-        else
-          args.unshift(arg)
-          raise ArgumentError, "invalid option or argument: %s" % args.join(" ")
-        end
+      if @opts[:yearly]
+        report = :yearly
+      elsif @opts[:monthly]
+        report = :monthly
       end
 
       stats = Rbnotes::Statistics.new(conf)
@@ -51,5 +45,30 @@ In the version #{Rbnotes::VERSION}, only number of notes is supported.
 HELP
     end
 
+    # :stopdoc:
+
+    private
+
+    def parse_opts(args)
+      while args.size > 0
+        arg = args.shift
+        case arg
+        when "-y", "--yearly"
+          @opts[:yearly] = true
+          @opts[:monthly] = false
+          break
+        when "-m", "--monthly"
+          @opts[:yearly] = false
+          @opts[:monthly] = true
+          break
+        else
+          args.unshift(arg)
+          raise ArgumentError, "invalid option or argument: %s" % args.join(" ")
+        end
+      end
+    end
+
+    # :startdoc:
+
   end
 end

data/lib/rbnotes/commands/update.rb

@@ -32,16 +32,7 @@ module Rbnotes::Commands
 
     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
+      parse_opts(args)
 
       target_stamp = Rbnotes.utils.read_timestamp(args)
       editor = Rbnotes.utils.find_editor(conf[:editor])
@@ -100,5 +91,25 @@ editor program will be searched as same as add command.  If none of
 editors is available, the execution fails.
 HELP
     end
+
+    # :stopdoc:
+
+    private
+
+    def parse_opts(args)
+      while args.size > 0
+        arg = args.shift
+        case arg
+        when "-k", "--keep"
+          @opts[:keep_timestamp] = true
+        else
+          args.unshift(arg)
+          break
+        end
+      end
+    end
+
+    # :startdoc:
+
   end
 end

data/lib/rbnotes/utils.rb

@@ -103,6 +103,19 @@ module Rbnotes
       tmpfile
     end
 
+    # Acceptable delimiters to separate a timestamp string for human
+    # being to read and input easily.
+    #
+    # Here is some examples:
+    #
+    #   - "2021-04-15 15:34:56" -> "20210415153456" (a timestamp string)
+    #   - "2020-04-15_15:34:56" -> (same as above)
+    #   - "2020-04-15-15-34-56" -> (same as above)
+    #   - "2020 04 15 15 34 56" -> (same as above)
+    #   - "2020-04-15" -> "20200415" (a timestamp pattern)
+
+    TIMESTAMP_DELIMITERS = /[-:_\s]/
+
     ##
     # Generates a Textrepo::Timestamp object from a String which comes
     # from the command line arguments.  When no argument is given,
@@ -114,6 +127,8 @@ module Rbnotes
     def read_timestamp(args)
       str = args.shift || read_arg($stdin)
       raise NoArgumentError if str.nil?
+
+      str = remove_delimiters_from_timestamp_string(str)
       Textrepo::Timestamp.parse_s(str)
     end
 
@@ -135,7 +150,10 @@ module Rbnotes
     def read_multiple_timestamps(args)
       strings = args.size < 1 ? read_multiple_args($stdin) : args
       raise NoArgumentError if (strings.nil? || strings.empty?)
-      strings.uniq.map { |str| Textrepo::Timestamp.parse_s(str) }
+      strings.uniq.map { |str|
+        str = remove_delimiters_from_timestamp_string(str)
+        Textrepo::Timestamp.parse_s(str)
+      }
     end
 
     ##
@@ -147,11 +165,15 @@ module Rbnotes
     def read_timestamp_patterns(args, enum_week: false)
       patterns = nil
       if enum_week
-        arg = args.shift
-        begin
-          patterns = timestamp_patterns_in_week(arg.dup)
-        rescue InvalidTimestampPatternAsDateError => _e
-          raise InvalidTimestampPatternAsDateError, args.unshift(arg)
+        args.unshift(Time.now.strftime("%Y%m%d")) if args.size == 0
+        patterns = []
+        while args.size > 0
+          arg = args.shift
+          begin
+            patterns.concat(timestamp_patterns_in_week(arg.dup))
+          rescue InvalidTimestampPatternAsDateError => _e
+            raise InvalidTimestampPatternAsDateError, args.unshift(arg)
+          end
         end
       else
         patterns = expand_keyword_in_args(args)
@@ -174,7 +196,13 @@ module Rbnotes
     #     timestamp_patterns_in_week(String) -> [Array of Strings]
     #
     def timestamp_patterns_in_week(arg)
-      date_str = arg || Textrepo::Timestamp.now[0, 8]
+      date_str = nil
+
+      if arg
+        date_str = remove_delimiters_from_timestamp_string(arg)
+      else
+        date_str = Textrepo::Timestamp.now[0, 8]
+      end
 
       case date_str.size
       when "yyyymodd".size
@@ -220,23 +248,24 @@ module Rbnotes
     #   - "last_week"  (or "lw")
     #   - "this_month" (or "tm")
     #   - "last_month" (or "lm")
+    #   - "all"
     #
     # :call-seq:
     #   expand_keyword_in_args(Array of Strings) -> Array of Strings
     #
     def expand_keyword_in_args(args)
-      return [nil] if args.empty?
-
       patterns = []
       while args.size > 0
         arg = args.shift
-        if KEYWORDS.include?(arg)
+        if arg == "all"
+          return [nil]
+        elsif KEYWORDS.include?(arg)
           patterns.concat(expand_keyword(arg))
         else
           patterns << arg
         end
       end
-      patterns.sort.uniq
+      patterns.uniq.sort
     end
 
     ##
@@ -322,6 +351,15 @@ module Rbnotes
       }.compact
     end
 
+    def remove_delimiters_from_timestamp_string(stamp_str) # :nodoc:
+      str = stamp_str.gsub(TIMESTAMP_DELIMITERS, "")
+      base_size = "yyyymiddhhmoss".size
+      if str.size > base_size   # when suffix is specified
+        str = str[0...base_size] + "_" + str[base_size..-1]
+      end
+      str
+    end
+
     ##
     # Expands a keyword to timestamp strings.
     #

data/lib/rbnotes/version.rb

@@ -1,4 +1,4 @@
 module Rbnotes
-  VERSION = "0.4.14"
-  RELEASE = "2021-04-10"
+  VERSION = "0.4.19"
+  RELEASE = "2021-05-24"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbnotes
 version: !ruby/object:Gem::Version
-  version: 0.4.14
+  version: 0.4.19
 platform: ruby
 authors:
 - mnbi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-09 00:00:00.000000000 Z
+date: 2021-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: textrepo