rbnotes 0.3.0 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 906c366a81295b7d9a1c2e86ad2bd6f1d35f410ac7360f1e2067c0a0f8e4f48b
-  data.tar.gz: d2af84cbd9ddbb60fe6f21ddffb9c072ebe0b767e8c8ab6ae4cac0c1bca30acd
+  metadata.gz: f48ac5666d917964e9c103c11be86b12736b81ced6e072be4707e1e943b6ff76
+  data.tar.gz: d29b9b68d6ebfcfdc7289962405a0390daed2705cd80b3beb50e036d2f8d9e85
 SHA512:
-  metadata.gz: 5fa3929995ebda0b4970c18516dadc37b5ddeb99d2a33c39ce90ac9f8bb90556c7a406b995b3373e4bc559c56b57750f0a0796f53b3d25624d1a891d2da456d1
-  data.tar.gz: 99c4dd49875b4cf1f262cbd845bbccb6482449f0a1573ed188b50cd6814c1220cc7cea1032cc2b6bbaaeb2e05c4f21f8a241e8931ff8d44128e72f8457c1b113
+  metadata.gz: f5be0687fc189a5dad6178104a05af0f64e35fc44dd1a73bf677a232038b81b4f88e5562ca9f9e8f098152136c005ebdc334158d34652c0fe7a2bea8e13c4056
+  data.tar.gz: a1e5d671d93ff9efdbe33e7c6751984f851c39756304df7c874fe82df558b18b7f4f716d82253e99b2d8e21cc1d795d6b81c0f1ba665f8f3e99e38c30e4d19d8

data/CHANGELOG.md

@@ -7,6 +7,33 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 ## [Unreleased]
 Nothing to record here.
 
+## [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
+### Added
+- 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
+- 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)
+
 ## [0.3.0] - 2020-10-29
 ### Added
 - Add feature to read argument from the standard input. (#27)

data/Gemfile

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

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    rbnotes (0.3.0)
-      textrepo (~> 0.4)
+    rbnotes (0.4.3)
+      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.4.4)
+    textrepo (0.5.4)
     unicode-display_width (1.7.0)
 
 PLATFORMS
@@ -20,7 +20,7 @@ DEPENDENCIES
   minitest (~> 5.0)
   rake (~> 13.0)
   rbnotes!
-  textrepo (~> 0.4)
+  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:
@@ -28,12 +31,19 @@ General syntax is:
 rbnotes [global_opts] [command] [command_opts] [args]
 ```
 
+### Global options
+
+- "-c CONF_FILE", "--conf"
+  - specifies a configuration file
+
 ### Commands
 
 - import
   - 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
@@ -57,6 +67,8 @@ Searches the configuration file in the following order:
 
 None of them is found, then the default configuration is used.
 
+The global option "-c CONF_FILE" will override the location.
+
 #### Content
 
 The format of the configuration file must be written in YAML.
@@ -75,14 +87,16 @@ A real example:
 
 ``` yaml
 ---
-:run_mode: :development
+:run_mode: :production
 :repository_type: :file_system
 :repository_name: "notes"
 :repository_base: "~"
-:pager: "bat"
+:pager: "bat -l md"
 :editor: "/usr/local/bin/emacsclient"
 ```
 
+The content is identical to `conf/config.yml`.
+
 #### Variables
 
 ##### :run-mode (mandatory)
@@ -124,13 +138,50 @@ the `:repository_name` value.  It would be:
 
 > :repository_base/:repository_name
 
-The value must be an absolute path.  The short-hand notation of the
-home directory ("~") is usable.
+The value is recommended to be an absolute path in the production
+time, since relative path will be expanded with the current working
+directory.  However, in the development and testing time, the relative
+path may be useful.  See `conf/config_deve.yml` or
+`conf/config_test.yml`.
+
+The short-hand notation of the home directory ("~") is usable.
 
 ##### Miscellaneous variables (optional)
 
 - :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", "-R", "-E"]`                         |
+| `egrep`  | `["-i", "-n", "-R"]`                               |
+| `ggrep`  | `["-i", "-n", "-R", "-E"]`                         |
+| `gegrep` | `["-i", "-n", "-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/conf/config.yml

@@ -0,0 +1,7 @@
+---
+:run_mode: :production
+:repository_type: :file_system
+:repository_name: "notes"
+:repository_base: "~"
+:pager: "bat -l md"
+:editor: "/usr/local/bin/emacsclient"

data/conf/config_deve.yml

@@ -0,0 +1,7 @@
+---
+:run_mode: :development
+:repository_type: :file_system
+:repository_name: "notes"
+:repository_base: "tmp"
+:pager: "bat -l md"
+:editor: "/usr/local/bin/emacsclient"

data/conf/config_test.yml

@@ -0,0 +1,5 @@
+---
+:run_mode: :test
+:repository_type: :file_system
+:repository_name: "notes"
+:repository_base: "test/sandbox"

data/exe/rbnotes

@@ -4,20 +4,55 @@ require "rbnotes"
 
 include Rbnotes
 
-DEBUG = true
-
 class App
+  def initialize
+    @gopts = {}
+  end
+
+  def options
+    @gopts
+  end
+
+  def parse_global_options(args)
+    while args.size > 0
+      arg = args.shift
+      case arg
+      when "-c", "--conf"
+        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) 
+        @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
+      end
+    end
+  end
+
   def run(args)
     cmd = args.shift
-    Commands.load(cmd).execute(args, Rbnotes.conf)
+    Commands.load(cmd).execute(args, Rbnotes.conf(@gopts[:conf_file]))
   end
 end
 
 app = App.new
 begin
+  app.parse_global_options(ARGV)
   app.run(ARGV)
 rescue MissingArgumentError, MissingTimestampError,
-       InvalidTimestampStringError, NoEditorError, ProgramAbortError => e
+       NoEditorError, ProgramAbortError,
+       Textrepo::InvalidTimestampStringError,
+       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,20 +1,40 @@
 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:
-      #   Array, Hash -> nil
+      #   execute(Array, Hash) -> nil
+      #
       #   - Array: arguments for each command
       #   - 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:
@@ -25,38 +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
+      class Usage < Command
+
+        def description
+          "Print usage"
+        end
+
         def execute(_, _)
           puts <<USAGE
-usage: rbnotes [command] [args]
-
-command:
-    add             : create a new note
-    update STAMP    : edit the note with external editor
-    import FILE     : import a FILE into the repository
-    list NUM        : list NUM notes
-    show STAMP      : show the note specified with STAMP
-    delete STAMP    : delete the note specified with STAMP
-
-    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
-    version         : print version
-    help            : show help
+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]
+  #{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
+
 USAGE
         end
+
+        def help
+          puts <<HELP_USAGE
+usage:
+    #{Rbnotes::NAME} 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]
@@ -64,24 +119,54 @@ USAGE
 
           puts case type
                when :file_system
-                 "#{base}/#{name}"
+                 File.expand_path(name, base)
                else
-                 "#{base}/#{name}"
+                 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?
@@ -91,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?
@@ -103,39 +209,73 @@ 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:
 
     class << self
+
       ##
       # Loads a class to perfom the command, then returns an instance
       # of the class.
       #
       # :call-seq:
-      #   "import" -> an object of Rbnotes::Commnads::Import
-      #   "list"   -> an object of Rbnotes::Commands::List
-      #   "show"   -> an object of Rbnotes::Commands::Show
-      #
+      #   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