rbnotes 0.4.2 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a43f87f2f4b03c9f8e27d06eb4fc426abb6dafbd420d5bbbcdb4ec2ea38d497
-  data.tar.gz: 0f9c060bfefde2e6c3f611d7d7e683fdd5ced20327b3ae6a3cbfcac39cdaf5a3
+  metadata.gz: a6625e8e9365a5c69cb9fd1f9d227e04247edda6ddbb9f5d3d442e0e7f87ac96
+  data.tar.gz: 5b00c1ecef74b47957112de785c57e249aa35b07c8809401872f75dec392f4c1
 SHA512:
-  metadata.gz: e28ed07cde6f385945a9ed3b92ff6402b8ec2dcdd2a75f6d1d0a8e391a2bf5e000245d708903fa815ec5faecfb2cfc39034240ef83a44818bd9a9ccb39c326ed
-  data.tar.gz: 0e2a87a92c5b5a674d143c3d4461577976e5f62508d67ebbdb5202bfbc771c04aacaab520f8860e29429411f50677351f059e01a919e0836fc889b6285507fbd
+  metadata.gz: 3d6e047ed738940dcbadd14bc8c176c486404951e4349eebe82c8bfbd92c1ad09fe996adb7c5db8bfdbf20ca364b6cebabd5dad3a2edbd9a597a2ad373a658ec
+  data.tar.gz: 504add631c2960e0b12eabce1075ba6d90745db531ebb95b1721a46bee236d7906d489169e0161d9e6213627cd28ceea59a8db1bb0e9c3f5ab0ba8878befb3c7

data/CHANGELOG.md

@@ -7,15 +7,45 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 ## [Unreleased]
 Nothing to record here.
 
-## [0.4.2] - 2020-11-05
+## [0.4.7] - 2020-11-15
+### Changed
+- Beautify output of the `search` command. (#63)
+
+### Fixed
+- Fix issue #61: `list` command fails in pipeline.
+
+## [0.4.6] - 2020-11-13
 ### Added
-- Add a feature to keep the timestamp in `update` command. (#44)
+- Add a new command `pick` to select a note with picker program. (#59)
+
+## [0.4.5] - 2020-11-12
+### Changed
+- Add a feature to accept multiple args for `list`. (#57)
+
+### Fixed
+- Fix issue #54: Notes list does not sort correctly.
+
+## [0.4.4] - 2020-11-09
+### Changed
+- Add a feature to use a keyword as an argument for `list`. (#47)
+
+## [0.4.3] - 2020-11-08
+### Added
+- Add a new command `export` to write out a note into a file. (#51)
+- Add individual help for each command. (#42)
+
+### Fixed
+- Fix `add` fails without modification (#48)
 
+## [0.4.2] - 2020-11-05
 ### Changed
+- Add a feature to keep the timestamp in `update` command. (#44)
+
+### Fixed
 - Fix issue #45: hanging up of `add` command.
 
 ## [0.4.1] - 2020-11-04
-### Added
+### Changed
 - Add a feature to accept a timestamp in `add` command. (#34)
 
 ## [0.4.0] - 2020-11-03
@@ -24,20 +54,21 @@ Nothing to record here.
 
 ## [0.3.1] - 2020-10-30
 ### Added
-- Add feature to specify configuration file in the command line. (#21)
+- Add a feature to specify configuration file in the command
+  line. (#21)
 
 ## [0.3.0] - 2020-10-29
-### Added
+### Changed
 - 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)
+### Changed
+- Add a 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.
-- Add description about the configuration file in README.md
+- Add a feature to load the configuration from an external file.
+  - Add a description about the configuration file in README.md.
 
 ## [0.2.0] - 2020-10-23
 ### Added
@@ -47,15 +78,15 @@ Nothing to record here.
 - Add a new task into `Rakefile` to generate RI docs.
   - The intention of the task is to verify RI docs.
 
-### Fixed
+### Changed
 - Refactor some tests.
 
 ## [0.1.3] - 2020-10-15
-### Fixed
+### Changed
 - Add help text for the `conf` command.
 
 ## [0.1.2] - 2020-10-15
-### Fixed
+### Changed
 - Adapt the API change in `textrepo` (0.4.0).
 
 ## [0.1.0] - 2020-10-12

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rbnotes (0.4.2)
+    rbnotes (0.4.7)
       textrepo (~> 0.5.4)
       unicode-display_width (~> 1.7)
 
@@ -10,7 +10,7 @@ GEM
   specs:
     minitest (5.14.2)
     rake (13.0.1)
-    textrepo (0.5.4)
+    textrepo (0.5.6)
     unicode-display_width (1.7.0)
 
 PLATFORMS

data/README.md

@@ -164,10 +164,10 @@ 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"]`                               |
+| `grep`   | `["-i", "-n", "-H", "-R", "-E"]`                   |
+| `egrep`  | `["-i", "-n", "-H", "-R"]`                         |
+| `ggrep`  | `["-i", "-n", "-H", "-R", "-E"]`                   |
+| `gegrep` | `["-i", "-n", "-H", "-R"]`                         |
 | `rg`     | `["-S", "-n", "--no-heading", "--color", "never"]` |
 
 Those searcher names are used in macOS (with Homebrew).  Any other OS

data/conf/config.yml

@@ -4,4 +4,5 @@
 :repository_name: "notes"
 :repository_base: "~"
 :pager: "bat -l md"
+:picker: "fzf"
 :editor: "/usr/local/bin/emacsclient"

data/conf/config_deve.yml

@@ -4,4 +4,5 @@
 :repository_name: "notes"
 :repository_base: "tmp"
 :pager: "bat -l md"
+:picker: "fzf"
 :editor: "/usr/local/bin/emacsclient"

data/exe/rbnotes

@@ -23,6 +23,14 @@ class App
         file = File.expand_path(file)
         raise ArgumentError, "no such file: %s" % file unless FileTest.exist?(file) 
         @gopts[:conf_file] = file
+      when "-v", "--version"
+        args.clear
+        args.unshift("version")
+        break
+      when "-h", "--help"
+        args.clear
+        args.unshift("help")
+        break
       else
         args.unshift(arg)
         break
@@ -40,10 +48,16 @@ app = App.new
 begin
   app.parse_global_options(ARGV)
   app.run(ARGV)
+rescue Errno::EPIPE => e
+  # Fix issue #61: When the pipeline which rbnotes connects is
+  # discarded by the other program, the execption was raised.  It does
+  # not end abnormally for rbnotes.  So, just ignores the exception.
+  exit 0
 rescue MissingArgumentError, MissingTimestampError,
        NoEditorError, ProgramAbortError,
        Textrepo::InvalidTimestampStringError,
-       ArgumentError => e
+       ArgumentError,
+       Errno::EACCES => e
   puts e.message
   exit 1
 end

data/lib/rbnotes.rb

@@ -1,9 +1,17 @@
 require "textrepo"
 
 module Rbnotes
+  NAME = File.basename($PROGRAM_NAME) # :nodoc:
+
   require_relative "rbnotes/version"
   require_relative "rbnotes/error"
   require_relative "rbnotes/conf"
   require_relative "rbnotes/utils"
   require_relative "rbnotes/commands"
+
+  class << self
+    def utils
+      Utils.instance
+    end
+  end
 end

data/lib/rbnotes/commands.rb

@@ -1,14 +1,21 @@
 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
 
+      ##
+      # Short description of each command.
+
+      def description; nil; end
+
       ##
       # :call-seq:
       #   execute(Array, Hash) -> nil
@@ -17,8 +24,17 @@ module Rbnotes
       #   - Hash : rbnotes configuration
 
       def execute(args, conf)
-        Builtins::DEFAULT_CMD.new.execute(args, conf)
+        Builtins.default_cmd.new.execute(args, conf)
       end
+
+      ##
+      # Shows the help message for the command.
+      #
+
+      def help
+        Builtins::Usage.new.execute(nil, nil)
+      end
+
     end
 
     # :stopdoc:
@@ -29,71 +45,73 @@ module Rbnotes
     # - stamp: converts given TIME_STR into a timestamp.
     # - time: converts given STAMP into a time string.
     module Builtins
-      class Help < Command
-        def execute(_, _)
-          puts <<USAGE
-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:
-    add            : create a new note
-    import FILE    : import a FILE into the repository
+      class Usage < Command
 
-    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.
+        def description
+          "Print usage"
+        end
 
-    version        : print version
-    help           : show help
+        def execute(_, _)
+          puts <<USAGE
+Syntax:
+  #{Rbnotes::NAME} [-c| --conf CONF_FILE] [command] [args]
+
+Example usage:
+  #{Rbnotes::NAME} add [-t STAMP_PATTERN]
+  #{Rbnotes::NAME} delete [TIMESTAMP]
+  #{Rbnotes::NAME} export [TIMESTAMP [FILENAME]]
+  #{Rbnotes::NAME} import FILE
+  #{Rbnotes::NAME} list [STAMP_PATTERN|KEYWORD]
+  #{Rbnotes::NAME} search PATTERN [STAMP_PATTERN]
+  #{Rbnotes::NAME} show [TIMESTAMP]
+  #{Rbnotes::NAME} update [TIMESTAMP]
+
+Further help for each command:
+  #{Rbnotes::NAME} help commands
+  #{Rbnotes::NAME} help [COMMAND]
+
+Further information:
+  https://github.com/mnbi/rbnotes/wiki
 
-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
+USAGE
+        end
 
-For more information, see Wiki page.
-    - https://github.com/mnbi/rbnotes/wiki
+        def help
+          puts <<HELP_USAGE
+usage:
+    #{Rbnotes::NAME} usage
 
-USAGE
+Print a short example of usage.
+HELP_USAGE
         end
       end
 
       class Version < Command
+        def description
+          "Print version"
+        end
+
         def execute(_, _)
-          rbnotes_version = "rbnotes #{Rbnotes::VERSION} (#{Rbnotes::RELEASE})"
+          rbnotes_version = "#{Rbnotes::NAME} #{Rbnotes::VERSION} (#{Rbnotes::RELEASE})"
           textrepo_version = "textrepo #{Textrepo::VERSION}"
           puts "#{rbnotes_version} [#{textrepo_version}]"
         end
+
+        def help
+          puts <<VERSION
+usage:
+    #{Rbnotes::NAME} version
+
+Print version of #{Rbnotes::NAME} and release date.
+VERSION
+        end
       end
 
       class Repo < Command
+        def description
+          "Print repository path"
+        end
+
         def execute(_, conf)
           name = conf[:repository_name]
           base = conf[:repository_base]
@@ -106,19 +124,49 @@ USAGE
                  File.join(base, name)
                end
         end
+
+        def help
+          puts <<REPO
+usage:
+    #{Rbnotes::NAME} repo
+
+Print the path of the repository.  The type of the path entity depends
+on what type is specified to the repository type in the configuration.
+When ":file_system" is set to "repository_type", the path is a
+directory which contains all note files.  The structure of the
+directory depends on the implementation of `textrepo`.
+REPO
+        end
       end
 
       class Conf < Command
+        def description
+          "Print the current configuration"
+        end
+
         def execute(_, conf)
           conf.keys.sort.each { |k|
             puts "#{k}=#{conf[k]}"
           }
         end
+
+        def help
+          puts <<CONF
+usage:
+    #{Rbnotes::NAME} conf
+
+Print the current configuration values.
+CONF
+        end
       end
 
       require "time"
 
       class Stamp < Command
+        def description
+          "Convert a time string into a timestamp string"
+        end
+
         def execute(args, _)
           time_str = args.shift
           unless time_str.nil?
@@ -128,9 +176,30 @@ USAGE
             super
           end
         end
+
+        def help
+          puts <<STAMP
+usage:
+    #{Rbnotes::NAME} stamp
+
+Convert a given time string into a timestamp string.  The timestamp
+string could be used as an argument of some rbnotes commands, such
+"show".  Here is short example of conversion:
+
+    "2020-11-06 16:51:15" -> "20201106165115"
+    "2020-11-06"          -> "20201106000000"
+    "20201106"            -> "20201106000000"
+    "2020-11-06 16"       -> "20201106160000"
+    "2020-11-06 16:51"    -> "20201106165100" 
+STAMP
+        end
       end
 
       class Time < Command
+        def description
+          "Convert a timestamp into a time string"
+        end
+
         def execute(args, _)
           stamp = args.shift
           unless stamp.nil?
@@ -140,12 +209,41 @@ USAGE
             super
           end
         end
+
+        def help
+          puts <<TIME
+usage:
+    #{Rbnotes::NAME} time
+
+Convert a given timestamp string into a time string.  Here is short
+example of conversion:
+
+    "20201106165115" -> "2020-11-06 16:51:15 +0900"
+    "202011061651"   -> "2020-11-06 16:51:00 +0900"
+    "2020110616"     -> "2020-11-06 16:00:00 +0900"
+    "20201106"       -> "2020-11-06 00:00:00 +0900"
+TIME
+        end
       end
 
-      DEFAULT_CMD = Help
-    end
+      class << self
+        def default_cmd_name
+          "usage"
+        end
+
+        def default_cmd
+          Usage
+        end
 
-    DEFAULT_CMD_NAME = "help"
+        def command(name)
+          begin
+            const_defined?(name, false) ? const_get(name, false) : nil
+          rescue NameError => _
+            nil
+          end
+        end
+      end
+    end
 
     # :startdoc:
 
@@ -156,24 +254,28 @@ USAGE
       # of the class.
       #
       # :call-seq:
+      #   load("add")    -> Rbnotes::Commands::Add
+      #   load("delete") -> Rbnotes::Commands::Delete
+      #   load("export") -> Rbnotes::Commands::Export
+      #   load("help")   -> Rbnotes::Commands::Help
       #   load("import") -> Rbnotes::Commnads::Import
       #   load("list")   -> Rbnotes::Commands::List
+      #   load("search") -> Rbnotes::Commands::Search
       #   load("show")   -> Rbnotes::Commands::Show
+      #   load("update") -> Rbnotes::Commands::Update
 
       def load(cmd_name)
-        cmd_name ||= DEFAULT_CMD_NAME
+        cmd_name ||= Builtins.default_cmd_name
         klass_name =  cmd_name.capitalize
 
-        klass = nil
-        if Builtins.const_defined?(klass_name, false)
-          klass = Builtins::const_get(klass_name, false)
-        else
+        klass = Builtins.command(klass_name)
+        if klass.nil?
           begin
             require_relative "commands/#{cmd_name}"
             klass = const_get(klass_name, false)
           rescue LoadError => _
             STDERR.puts "unknown command: #{cmd_name}"
-            klass = Builtins::DEFAULT_CMD
+            klass = Builtins.default_cmd
           end
         end
         klass.new