rbnotes 0.4.12 → 0.4.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 517b5866c81f76286f87b2ed7d2e695c4dd09d5c7ab86f9557079232a58fde37
-  data.tar.gz: 1d89412445d155501f67cd0978a8070975ed722ee7440119cf5a9ba89ca946eb
+  metadata.gz: 65aec23d03fa8672d8aada42a39d6d0f97643ca3481050926ae11aa2a05dc433
+  data.tar.gz: c28a9209d1374f351a87e0a0a696312bdc37f70b2d55c97e5e2920703c83643b
 SHA512:
-  metadata.gz: 1f0bab361e6f4a7f22a59433369b221b6dffc1e16b79f9d4bdc4027d78c3d61a6e949ab2b81ae1ab3be4c5d52af6bd74aed4b36c70a93f31e710a42b7bb23731
-  data.tar.gz: af38ba13276090ae653fee8b1b3f67f3de57596851ce8b645f4ed3463c38d71c4a950b3382bff55ad98853c42e2cb3f2df0e7e7652f756f385d53ef15f917085
+  metadata.gz: 285b05aee90d97dcf11fca4d753e2265ae11253d504e9a787b34f4d64a74e47486cd6a127d652f6f746b934f90c6c699342ea8621b13ef06da2816ef3f91eb98
+  data.tar.gz: 581f9192f023a4a50f43ea475b72aa5a145c054520c6b25f9a59c2f758f980c81259df788c34c47c08b7a901b55f6f77ae60e39de0e5e230727d990fcd9f54d3

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Build
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.0
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -35,7 +35,6 @@ build-iPhoneSimulator/
 ## Documentation cache and generated files:
 /.yardoc/
 /_yardoc/
-/doc/
 /rdoc/
 
 ## Environment normalization:

data/CHANGELOG.md

@@ -5,7 +5,53 @@ 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.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
+### Changed
+- Use GitHub/Actions instead of Travis-CI.
+- Add `--week` option to `pick` command. (#88)
+
+### Fixed
+- Fix issue #98: remove redundant args
+  (Rbnotes::Utils.read_multiple_timestamps). (#98)
+- Update `textrepo`. -> 0.5.8 (#97)
 
 ## [0.4.12] - 2020-12-18
 ### Changed

data/Gemfile

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

data/Gemfile.lock

@@ -1,16 +1,16 @@
 PATH
   remote: .
   specs:
-    rbnotes (0.4.12)
-      textrepo (~> 0.5.4)
+    rbnotes (0.4.17)
+      textrepo (~> 0.5.8)
       unicode-display_width (~> 1.7)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    minitest (5.14.2)
-    rake (13.0.1)
-    textrepo (0.5.7)
+    minitest (5.14.4)
+    rake (13.0.3)
+    textrepo (0.5.8)
     unicode-display_width (1.7.0)
 
 PLATFORMS
@@ -20,7 +20,7 @@ DEPENDENCIES
   minitest (~> 5.0)
   rake (~> 13.0)
   rbnotes!
-  textrepo (~> 0.5.4)
+  textrepo (~> 0.5.8)
 
 BUNDLED WITH
-   2.1.4
+   2.2.15

data/README.md

@@ -1,6 +1,7 @@
 # Rbnotes
 
-[![Build Status](https://travis-ci.org/mnbi/rbnotes.svg?branch=main)](https://travis-ci.org/mnbi/rbnotes)
+[![Build Status](https://github.com/mnbi/rbnotes/workflows/Build/badge.svg)](https://github.com/mnbi/rbnotes/actions?query=workflow%3A"Build")
+[![CodeFactor](https://www.codefactor.io/repository/github/mnbi/rbnotes/badge)](https://www.codefactor.io/repository/github/mnbi/rbnotes)
 
 Rbnotes is a simple utility to write a note in the single repository.
 

data/Rakefile

@@ -25,6 +25,6 @@ require "rdoc/task"
 
 RDoc::Task.new do |rdoc|
   rdoc.generator = "ri"
-  rdoc.rdoc_dir = "doc"
+  rdoc.rdoc_dir = "rdoc"
   rdoc.rdoc_files.include("lib/**/*.rb")
 end

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.rb

@@ -10,9 +10,4 @@ module Rbnotes
   require_relative "rbnotes/commands"
   require_relative "rbnotes/statistics"
 
-  class << self
-    def utils
-      Utils.instance
-    end
-  end
 end

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

@@ -34,22 +34,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)
 
@@ -116,7 +101,28 @@ 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

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
@@ -54,58 +57,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
-      end
+      parse_opts(args)
 
-      patterns = nil
-      if @opts[:enum_week]
-        arg = args.shift || Textrepo::Timestamp.now[0, 8]
-        case arg.size
-        when "yyyymodd".size, "yyyymoddhhmiss".size, "yyyymoddhhmiss_sfx".size
-          stamp_str = "#{arg}000000"[0, 14]
-          timestamp = Textrepo::Timestamp.parse_s(stamp_str)
-        when "modd".size
-          this_year = Time.now.year.to_s
-          stamp_str = "#{this_year}#{arg}000000"
-          begin
-            timestamp = Textrepo::Timestamp.parse_s(stamp_str)
-          rescue Textrepo::InvalidTimestampStringError => _e
-            raise InvalidTimestampPatternAsDateError, arg
-          end
-        else
-          raise InvalidTimestampPatternAsDateError, args.unshift(arg)
-        end
-        patterns = Rbnotes.utils.timestamp_patterns_in_week(timestamp)
-      else
-        patterns = Rbnotes.utils.expand_keyword_in_args(args)
+      if args.empty? and !@opts[:enum_week]
+        default_behavior = conf[:list_default] || DEFAULT_BEHAVIOR
+        args << default_behavior
       end
 
-      @repo = Textrepo.init(conf)
-      notes = Rbnotes.utils.find_notes(patterns, @repo)
+      utils = Rbnotes.utils
+      patterns = utils.read_timestamp_patterns(args, enum_week: @opts[:enum_week])
+
+      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 << Rbnotes.utils.make_headline(timestamp,
-                                                  @repo.read(timestamp), pad)
+            output << utils.make_headline(timestamp,
+                                          repo.read(timestamp), pad)
           }
         }
       else
-        notes.each { |timestamp|
-          output << Rbnotes.utils.make_headline(timestamp,
-                                                @repo.read(timestamp))
+        stamps.each { |timestamp|
+          output << utils.make_headline(timestamp, repo.read(timestamp))
         }
       end
       puts output
@@ -114,13 +90,17 @@ 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
 used.
 
+OPTIONS:
+    -v, --verbose
+    -w, --week
+
 STAMP_PATTERN must be:
 
     (a) full qualified timestamp (with suffix): "20201030160200"
@@ -138,6 +118,24 @@ KEYWORD:
     - "this_month" (or "tm")
     - "last_month" (or "lm")
 
+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
+          :
+
+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.
+
 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
@@ -155,6 +153,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,13 +9,28 @@ module Rbnotes::Commands
       "Pick a timestamp with a picker program"
     end
 
+    DEFAULT_BEHAVIOR = "today"  # :nodoc:
+
     def execute(args, conf)
-      patterns = Rbnotes.utils.expand_keyword_in_args(args)
-      @repo = Textrepo.init(conf)
+      @opts = {}
+      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)
+
+      stamps = utils.find_notes(patterns, repo)
+      return if stamps.empty?
 
       list = []
-      Rbnotes.utils.find_notes(patterns, @repo).each { |timestamp|
-        list << Rbnotes.utils.make_headline(timestamp, @repo.read(timestamp))
+      stamps.each { |timestamp|
+        list << utils.make_headline(timestamp, repo.read(timestamp))
       }
 
       picker = conf[:picker]
@@ -47,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/show.rb

@@ -1,17 +1,16 @@
 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.
   #
-  # A string for Textrepo::Timestamp must be:
-  #
-  #     "20201106112600"     : year, date, time and sec
-  #     "20201106112600_012" : with suffix
+  # Accepts an option with `-n NUMBER` (or `--num-of-lines`), to show
+  # the first NUMBER lines of the content of each note.
   #
   # 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.
   class Show < Command
 
     def description             # :nodoc:
@@ -19,13 +18,30 @@ module Rbnotes::Commands
     end
 
     def execute(args, conf)
-      stamps = Rbnotes.utils.read_multiple_timestamps(args)
+      @opts = {}
+      parse_opts(args)
+
       repo = Textrepo.init(conf)
+      stamps = read_timestamps(args, repo)
+      return if stamps.empty?
+
+      content = stamps.map { |stamp|
+        begin
+          text = repo.read(stamp)
+        rescue Textrepo::MissingTimestampError => _
+          raise Rbnotes::MissingTimestampError, stamp
+        end
 
-      content = stamps.map { |stamp| [stamp, repo.read(stamp)] }.to_h
+        lines = text.size
+        if @opts[:num_of_lines].to_i > 0
+          lines = [@opts[:num_of_lines], lines].min
+        end
+
+        [stamp, text[0, lines]]
+      }.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)
@@ -35,10 +51,22 @@ module Rbnotes::Commands
     def help                    # :nodoc:
       puts <<HELP
 usage:
-    #{Rbnotes::NAME} show [TIMESTAMP...]
+    #{Rbnotes::NAME} show [OPTIONS] [STAMP_PATTERN|KEYWORD...]
+
+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.
 
-Show the content of given notes.  TIMESTAMP must be a fully qualified
-one, such "20201016165130" or "20201016165130_012" if it has a suffix.
+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.
@@ -49,6 +77,38 @@ HELP
 
     private
 
+    def parse_opts(args)
+      while args.size > 0
+        arg = args.shift
+        case arg
+        when "-n", "--num-of-lines"
+          num_of_lines = args.shift
+          raise ArgumentError, "missing number: %s" % args.unshift(arg) if num_of_lines.nil?
+
+          num_of_lines = num_of_lines.to_i
+          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
+        end
+      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|
@@ -66,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

@@ -7,6 +7,20 @@ require "io/console/size"
 require "unicode/display_width"
 
 module Rbnotes
+
+  class << self
+
+    ##
+    # Retrieves the singleton instance of Rbnotes::Utils class.
+    # Typical usage is as follows:
+    #
+    #   Rbnotes.utils.find_editor("emacsclient")
+    #
+    def utils
+      Utils.instance
+    end
+  end
+
   ##
   # Defines several utility methods those are intended to be used in
   # Rbnotes classes.
@@ -89,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,
@@ -100,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
 
@@ -108,13 +137,92 @@ module Rbnotes
     # line arguments.  When no argument is given, try to read from
     # STDIN.
     #
+    # When multiple strings those point the identical time are
+    # included the arguments (passed or read form STDIN), the
+    # redundant strings will be removed.
+    #
+    # The order of the arguments will be preserved into the return
+    # value, even if the redundant strings were removed.
+    #
     # :call-seq:
     #   read_multiple_timestamps(args) -> [String]
 
     def read_multiple_timestamps(args)
       strings = args.size < 1 ? read_multiple_args($stdin) : args
       raise NoArgumentError if (strings.nil? || strings.empty?)
-      strings.map { |str| Textrepo::Timestamp.parse_s(str) }
+      strings.uniq.map { |str|
+        str = remove_delimiters_from_timestamp_string(str)
+        Textrepo::Timestamp.parse_s(str)
+      }
+    end
+
+    ##
+    # Reads timestamp patterns in an array of arguments.  It supports
+    # keywords expansion and enumeration of week.  The function is
+    # intended to be used from Commands::List#execute and
+    # Commands::Pick#execute.
+    #
+    def read_timestamp_patterns(args, enum_week: false)
+      patterns = nil
+      if enum_week
+        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)
+      end
+      patterns
+    end
+
+    ##
+    # Enumerates all timestamp patterns in a week which contains a
+    # given timestamp as a day of the week.
+    #
+    # The argument must be one of the followings:
+    #   - "yyyymodd" (eg. "20201220")
+    #   - "yymoddhhmiss" (eg. "20201220120048")
+    #   - "yymoddhhmiss_sfx" (eg. "20201220120048_012")
+    #   - "modd" (eg. "1220") (assums in the current year)
+    #   - nil (assumes today)
+    #
+    # :call-seq:
+    #     timestamp_patterns_in_week(String) -> [Array of Strings]
+    #
+    def timestamp_patterns_in_week(arg)
+      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
+        # nothing to do
+      when "yyyymoddhhmiss".size, "yyyymoddhhmiss_sfx".size
+        date_str = date_str[0, 8]
+      when "modd".size
+        this_year = Time.now.year.to_s
+        date_str = "#{this_year}#{date_str}"
+      else
+        raise InvalidTimestampPatternAsDateError, arg
+      end
+
+      begin
+        date = Date.parse(date_str)
+      rescue Date::Error => _e
+        raise InvalidTimestampPatternAsDateError, arg
+      end
+
+      dates_in_week(date).map { |date| timestamp_pattern(date) }
     end
 
     ##
@@ -140,52 +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 ["today", "to", "yesterday", "ye",
-            "this_week", "tw", "last_week", "lw",
-            "this_month", "tm", "last_month", "lm"].include?(arg)
-          patterns.concat(Rbnotes.utils.expand_keyword(arg))
+        if arg == "all"
+          return [nil]
+        elsif KEYWORDS.include?(arg)
+          patterns.concat(expand_keyword(arg))
         else
           patterns << arg
         end
       end
-      patterns.sort.uniq
-    end
-
-    ##
-    # Expands a keyword to timestamp strings.
-    #
-    # :call-seq:
-    #     expand_keyword(keyword as String) -> Array of timestamp Strings
-
-    def expand_keyword(keyword)
-      patterns = []
-      case keyword
-      when "today", "to"
-        patterns << timestamp_pattern(date_of_today)
-      when "yesterday", "ye"
-        patterns << timestamp_pattern(date_of_yesterday)
-      when "this_week", "tw"
-        patterns.concat(dates_in_this_week.map { |d| timestamp_pattern(d) })
-      when "last_week", "lw"
-        patterns.concat(dates_in_last_week.map { |d| timestamp_pattern(d) })
-      when "this_month", "tm"
-        patterns.concat(dates_in_this_month.map { |d| timestamp_pattern(d) })
-      when "last_month", "lm"
-        patterns.concat(dates_in_last_month.map { |d| timestamp_pattern(d) })
-      else
-        raise UnknownKeywordError, keyword
-      end
-      patterns
+      patterns.uniq.sort
     end
 
     ##
@@ -233,17 +313,6 @@ module Rbnotes
       }.flatten.sort{ |a, b| b <=> a }.uniq
     end
 
-    ##
-    # Enumerates all timestamp patterns in a week which contains a
-    # given timestamp as a day of the week.
-    #
-    # :call-seq:
-    #     timestamp_patterns_in_week(timestamp) -> [Array of Strings]
-
-    def timestamp_patterns_in_week(timestamp)
-      dates_in_week(start_date_in_the_week(timestamp.time)).map { |date| timestamp_pattern(date) }
-    end
-
     # :stopdoc:
 
     private
@@ -282,6 +351,48 @@ 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.
+    #
+    # :call-seq:
+    #     expand_keyword(keyword as String) -> Array of timestamp Strings
+    #
+    def expand_keyword(keyword)
+      patterns = []
+      case keyword
+      when "today", "to"
+        patterns << timestamp_pattern(Date.today)
+      when "yesterday", "ye"
+        patterns << timestamp_pattern(Date.today.prev_day)
+      when "this_week", "tw"
+        patterns.concat(dates_in_this_week.map { |d| timestamp_pattern(d) })
+      when "last_week", "lw"
+        patterns.concat(dates_in_last_week.map { |d| timestamp_pattern(d) })
+      when "this_month", "tm"
+        patterns.concat(dates_in_this_month.map { |d| timestamp_pattern(d) })
+      when "last_month", "lm"
+        patterns.concat(dates_in_last_month.map { |d| timestamp_pattern(d) })
+      else
+        raise UnknownKeywordError, keyword
+      end
+      patterns
+    end
+
+    KEYWORDS = %w(
+      today to yesterday ye
+      this_week tw last_week lw
+      this_month tm last_month lm
+    )
+
     def search_in_path(name)
       search_paths = ENV["PATH"].split(":")
       found = search_paths.map { |path|
@@ -299,58 +410,40 @@ module Rbnotes
       date.strftime("%Y%m%d")
     end
 
-    def date_of_today
-      date(Time.now)
-    end
-
-    def date_of_yesterday
-      date(Time.now).prev_day
-    end
-
     def date(time)
       Date.new(time.year, time.mon, time.day)
     end
 
     def dates_in_this_week
-      dates_in_week(start_date_in_this_week)
+      dates_in_week(Date.today)
     end
 
     def dates_in_last_week
-      dates_in_week(start_date_in_last_week)
-    end
-
-    def start_date_in_this_week
-      start_date_in_the_week(Time.now)
+      dates_in_week(Date.today.prev_day(7))
     end
 
-    def start_date_in_last_week
-      start_date_in_this_week.prev_day(7)
-    end
-
-    def start_date_in_the_week(time)
-      parts = [:year, :mon, :day].map { |sym| time.send(sym) }
-      Date.new(*parts).prev_day(wday(time))
+    def dates_in_week(date)
+      start_date = start_date_of_week(date)
+      dates = [start_date]
+      1.upto(6) { |i| dates << start_date.next_day(i) }
+      dates
     end
 
-    def wday(time)
-      (time.wday - 1) % 7
+    def start_date_of_week(date)
+      # week day in monday start calendar
+      date.prev_day((date.wday - 1) % 7)
     end
 
-    def dates_in_week(start_date)
-      dates = [start_date]
-      1.upto(6) { |i| dates << start_date.next_day(i) }
-      dates
+    def first_date_of_this_month
+      today = Time.now
+      date(Time.new(today.year, today.mon, 1))
     end
 
     def dates_in_this_month
-      today = Time.now
-      first_date = date(Time.new(today.year, today.mon, 1))
-      dates_in_month(first_date)
+      dates_in_month(first_date_of_this_month)
     end
 
     def dates_in_last_month
-      today = Time.now
-      first_date_of_this_month = date(Time.new(today.year, today.mon, 1))
       dates_in_month(first_date_of_this_month.prev_month)
     end
 

data/lib/rbnotes/version.rb

@@ -1,4 +1,4 @@
 module Rbnotes
-  VERSION = "0.4.12"
-  RELEASE = "2020-12-18"
+  VERSION = "0.4.17"
+  RELEASE = "2021-04-21"
 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.4"
+  spec.add_dependency "textrepo", "~> 0.5.8"
   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.12
+  version: 0.4.17
 platform: ruby
 authors:
 - mnbi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-18 00:00:00.000000000 Z
+date: 2021-04-20 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.4
+        version: 0.5.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.4
+        version: 0.5.8
 - !ruby/object:Gem::Dependency
   name: unicode-display_width
   requirement: !ruby/object:Gem::Requirement
@@ -46,8 +46,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: A simple utility to write a note.

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.2
-before_install: gem install bundler -v 2.1.4