rbnotes 0.4.0 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87313e606a2e62b90b3e1c3f00ff46300f0e7a14e3b2fc8ffcad0abfda217646
-  data.tar.gz: 95b8a57ca200b8a8460f61edfe0d796dcfec2f63cba4ec024294915f07752aa8
+  metadata.gz: 840d2acc4c93d5b03d833b6a518c9740518e025aeb3bb2b6751864d5cf9e9d1c
+  data.tar.gz: 759f8bdc29d64e32c73d7e02540603c3bdf84b6bdf3ac91b7a76bf8e3cf2005d
 SHA512:
-  metadata.gz: 238f9140497e09ee4aedc331716c5725e61e00332255160d70844099e7f5d3f072f00edc3800e063f1f09e9e9c67669ca901c60c16c88a37e4594c07c9744238
-  data.tar.gz: de00ee60c187517ec47f4601c572abc83f99dc3f4cde96c4db86e8cdda012eda5bdd5b1529fdf086f7f1858637720752bba8fa244d3e21f63d25456c56b7c71e
+  metadata.gz: b47f361e68f7e5275b981848035621fd31342a994d6bd5d90002f91417f4806ba364714b4ea86728f993e43e74868bf08508701531361c4e785830cc772a5b2e
+  data.tar.gz: '09cea0ff486e4e2a8521d732296e64a520c7d076088dd63c05cc4a9c219a2be28e65e50234859bab0d2772a92fb466b1ffc580525fb3565e8d68f7f7f81f8eec'

data/CHANGELOG.md

@@ -7,26 +7,57 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 ## [Unreleased]
 Nothing to record here.
 
+## [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
+### Changed
+- Add a feature to accept a timestamp in `add` command. (#34)
+
 ## [0.4.0] - 2020-11-03
 ### Added
 - Add a new command `search` to perform full text search. (#33)
 
 ## [0.3.1] - 2020-10-30
 ### Added
-- Add feature to specify configuration file in the command line. (#21)
+- 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
@@ -36,15 +67,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

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

data/Gemfile.lock

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

data/README.md

@@ -4,6 +4,9 @@
 
 Rbnotes is a simple utility to write a note in the single repository.
 
+This document provides the basic information to use rbnotes.
+You may find more useful information in [Wiki pages](https://github.com/mnbi/rbnotes/wiki).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -39,6 +42,8 @@ rbnotes [global_opts] [command] [command_opts] [args]
   - imports existing files
 - list
   - lists notes in the repository with their timestamps and subject
+- search
+  - search a word (or words) in the repository
 - show
   - shows the content of a note
 - add
@@ -145,6 +150,38 @@ The short-hand notation of the home directory ("~") is usable.
 
 - :pager : specify a pager program
 - :editor : specify a editor program
+- :searcher: specify a program to perform search
+- :searcher_options: specify options to pass to the searcher program
+
+Be careful to set `:searcher` and `:searcher_options`. The searcher
+program must be expected to behave equivalent to `grep` with `-inRE`.
+At least, its output must be the same format and it must runs
+recursively to a directory.
+
+If your favorite searcher is one of the followings, see the default
+options which `textrepo` sets for those searchers.  In most cases, you
+don't have to set `:searcher_options` for them.
+
+| searcher | default options in `textrepo`                      |
+|:---------|:---------------------------------------------------|
+| `grep`   | `["-i", "-n", "-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
+might use different names.
+
+- `grep` and `egrep` -> BSD grep (macOS default)
+- `ggrep` and `gegrep` -> GNU grep
+- `rg` -> ripgrep
+
+If the name is different, `:searcher_options` should be set with the
+same value.  For example, if you system use the name `gnugrep` as GNU
+grep, and you want to use it as the searcher (that is, set `gnugrep`
+to `:searcher`), you should set `:searcher_options` value with `["-i",
+"-n", "-R", "-E"]`.
 
 ##### Default values for mandatory variables
 

data/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
@@ -43,7 +51,8 @@ begin
 rescue MissingArgumentError, MissingTimestampError,
        NoEditorError, ProgramAbortError,
        Textrepo::InvalidTimestampStringError,
-       ArgumentError => e
+       ArgumentError,
+       Errno::EACCES => e
   puts e.message
   exit 1
 end

data/lib/rbnotes.rb

@@ -1,6 +1,8 @@
 require "textrepo"
 
 module Rbnotes
+  NAME = File.basename($PROGRAM_NAME) # :nodoc:
+
   require_relative "rbnotes/version"
   require_relative "rbnotes/error"
   require_relative "rbnotes/conf"

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,54 +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]
+      class Usage < Command
 
-command:
-    add            : create a new note
-    import FILE    : import a FILE into the repository
+        def description
+          "Print usage"
+        end
 
-    list PATTERN   : list notes those timestamp matches PATTERN
+        def execute(_, _)
+          puts <<USAGE
+Syntax:
+  #{Rbnotes::NAME} [-c| --conf CONF_FILE] [command] [args]
 
-    PATTERN must be:
-        (a) full qualified timestamp (with suffix): "20201030160200"
-        (b) year and date part: "20201030"
-        (c) year part only: "2020"
-        (d) date part only: "1030"
+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]
 
-    show STAMP     : show the note specified with STAMP
-    update STAMP   : edit the note with external editor
-    delete STAMP   : delete the note specified with STAMP
+Further help for each command:
+  #{Rbnotes::NAME} help commands
+  #{Rbnotes::NAME} help [COMMAND]
 
-    STAMP must be a sequence of digits to represent year, date and
-    time (and suffix), such "20201030160200" or "20201030160200_012".
+Further information:
+  https://github.com/mnbi/rbnotes/wiki
 
-    show/update/delete reads its argument from the standard input when
-    no argument was passed in the command line.
+USAGE
+        end
 
-    version        : print version
-    help           : show help
+        def help
+          puts <<HELP_USAGE
+usage:
+    #{Rbnotes::NAME} usage
 
-commands for development purpose:
-    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
+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]
@@ -89,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?
@@ -111,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?
@@ -123,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
 
-    DEFAULT_CMD_NAME = "help"
+        def default_cmd
+          Usage
+        end
+
+        def command(name)
+          begin
+            const_defined?(name, false) ? const_get(name, false) : nil
+          rescue NameError => _
+            nil
+          end
+        end
+      end
+    end
 
     # :startdoc:
 
@@ -139,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