rbnotes 0.4.16 → 0.4.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3f023516dcf1e39f18c6cd0195a548debfd635e23d476bdb7e89a6ddc5f981e
-  data.tar.gz: 52507a17c873c8732922e1cc5990fa41d74f36fca1f558fa5440090f3fcd9fe2
+  metadata.gz: 65aec23d03fa8672d8aada42a39d6d0f97643ca3481050926ae11aa2a05dc433
+  data.tar.gz: c28a9209d1374f351a87e0a0a696312bdc37f70b2d55c97e5e2920703c83643b
 SHA512:
-  metadata.gz: '0946450a7eeda50688cc5dc836ce30e86d5db28e2af8dca8e84805026648ba018116e98d5b3d316339960a0273d1e717178c4832932418440e0db3c1d1b4e9a9'
-  data.tar.gz: 125c3c6fa116fc5cf13d82ba6fb522972b82364b61002de2adc6d36ab1f6d77051f89a948a7cc9ec28acce8179399b040bfc4d983e1c83c65bb2548cc44ee8eb
+  metadata.gz: 285b05aee90d97dcf11fca4d753e2265ae11253d504e9a787b34f4d64a74e47486cd6a127d652f6f746b934f90c6c699342ea8621b13ef06da2816ef3f91eb98
+  data.tar.gz: 581f9192f023a4a50f43ea475b72aa5a145c054520c6b25f9a59c2f758f980c81259df788c34c47c08b7a901b55f6f77ae60e39de0e5e230727d990fcd9f54d3

data/CHANGELOG.md

@@ -5,19 +5,42 @@ 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

data/Gemfile.lock

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

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

@@ -18,7 +18,8 @@ module Rbnotes::Commands
     # 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
@@ -58,7 +59,7 @@ module Rbnotes::Commands
       @opts = {}
       parse_opts(args)
 
-      if args.empty?
+      if args.empty? and !@opts[:enum_week]
         default_behavior = conf[:list_default] || DEFAULT_BEHAVIOR
         args << default_behavior
       end
@@ -66,22 +67,21 @@ module Rbnotes::Commands
       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
@@ -90,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"
@@ -114,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

data/lib/rbnotes/commands/pick.rb

@@ -23,11 +23,14 @@ module Rbnotes::Commands
       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]

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

@@ -165,6 +165,7 @@ module Rbnotes
     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

data/lib/rbnotes/version.rb

@@ -1,4 +1,4 @@
 module Rbnotes
-  VERSION = "0.4.16"
-  RELEASE = "2021-04-17"
+  VERSION = "0.4.17"
+  RELEASE = "2021-04-21"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbnotes
 version: !ruby/object:Gem::Version
-  version: 0.4.16
+  version: 0.4.17
 platform: ruby
 authors:
 - mnbi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-17 00:00:00.000000000 Z
+date: 2021-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: textrepo