rbnotes 0.4.7 → 0.4.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6625e8e9365a5c69cb9fd1f9d227e04247edda6ddbb9f5d3d442e0e7f87ac96
-  data.tar.gz: 5b00c1ecef74b47957112de785c57e249aa35b07c8809401872f75dec392f4c1
+  metadata.gz: 517b5866c81f76286f87b2ed7d2e695c4dd09d5c7ab86f9557079232a58fde37
+  data.tar.gz: 1d89412445d155501f67cd0978a8070975ed722ee7440119cf5a9ba89ca946eb
 SHA512:
-  metadata.gz: 3d6e047ed738940dcbadd14bc8c176c486404951e4349eebe82c8bfbd92c1ad09fe996adb7c5db8bfdbf20ca364b6cebabd5dad3a2edbd9a597a2ad373a658ec
-  data.tar.gz: 504add631c2960e0b12eabce1075ba6d90745db531ebb95b1721a46bee236d7906d489169e0161d9e6213627cd28ceea59a8db1bb0e9c3f5ab0ba8878befb3c7
+  metadata.gz: 1f0bab361e6f4a7f22a59433369b221b6dffc1e16b79f9d4bdc4027d78c3d61a6e949ab2b81ae1ab3be4c5d52af6bd74aed4b36c70a93f31e710a42b7bb23731
+  data.tar.gz: af38ba13276090ae653fee8b1b3f67f3de57596851ce8b645f4ed3463c38d71c4a950b3382bff55ad98853c42e2cb3f2df0e7e7652f756f385d53ef15f917085

data/CHANGELOG.md

@@ -7,6 +7,46 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 ## [Unreleased]
 Nothing to record here.
 
+## [0.4.12] - 2020-12-18
+### Changed
+- Make clear the spec of `list` command args. (#94)
+- Add a feature to use a template file for `add` command. (#87)
+- Add new keywords for `list` command. (#90)
+  - `this_month` and `last_month`
+- Add a new option, `verbose` for `list` command. (#76)
+
+### Fixed
+- Fix issue #80: suppress unnecessary error message.
+
+## [0.4.11] - 2020-12-07
+### Added
+- Add a new command `statistics`. (#73)
+  - limited features
+- Add a completion file for `zsh`.
+  - a new file `etc/zsh/_rbnotes`
+
+### Changed
+- Add a new option for `import` to use `mtime`. (#82)
+- Add a feature to show multiple notes at once. (#79)
+
+### Fixed
+- Fix issue #77: no error with a non-existing config file.
+
+## [0.4.10] - 2020-11-20
+### Added
+- Add a new command `commands` to show all command names. (#71)
+
+### Fixed
+- Fix issue #69: crashes with invalid timestamp pattern.
+
+## [0.4.9] - 2020-11-17
+### Added
+- Add a new option `--week` to the `list` command. (#67)
+
+## [0.4.8] - 2020-11-16
+### Fixed
+- Fix issue #65: messy output of the `search` command.
+
 ## [0.4.7] - 2020-11-15
 ### Changed
 - Beautify output of the `search` command. (#63)
@@ -35,7 +75,7 @@ Nothing to record here.
 - Add individual help for each command. (#42)
 
 ### Fixed
-- Fix `add` fails without modification (#48)
+- Fix issue #48: `add` fails without modification.
 
 ## [0.4.2] - 2020-11-05
 ### Changed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rbnotes (0.4.7)
+    rbnotes (0.4.12)
       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.6)
+    textrepo (0.5.7)
     unicode-display_width (1.7.0)
 
 PLATFORMS

data/conf/config.yml

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

data/conf/config_deve.yml

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

data/conf/config_deve_fzf_no_opts.yml

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

data/conf/config_deve_no_picker.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_deve_peco.yml

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

data/etc/zsh/_rbnotes

@@ -0,0 +1,93 @@
+#compdef rbnotes
+
+local __rbnotes_cmd __rbnotes_debug
+
+__rbnotes_process() {
+}
+
+function _rbnotes() {
+    local context curcontext=$curcontext stat line
+    typeset -A opt_args
+    local ret=1
+
+    _arguments \
+	-C \
+	'(- *)'{-v,--version}'[print version]' \
+	'(- *)'{-h,--help}'[show help]' \
+	'(- *)'{-c,--conf}'[config file]: :->conffile' \
+	'1: :__rbnotes_commands' \
+	'*:: :->args'
+
+    case $state in
+	(conffile)
+	    _files -g "*.yml" && ret=0
+	    ;;
+	(args)
+	    case $words[1] in
+		(add)
+		    _arguments \
+			-C \
+			'(-t --timestamp)'{-t,--timestamp}'[set timestamp]' \
+			'(-)*:: :->null_state' \
+			&& ret=0
+		    ;;
+		(export)
+		    _directories && ret=0
+		    ;;
+		(help)
+		    _arguments \
+			-C \
+			'1: :__rbnotes_commands' \
+			&& ret=0
+		    ;;
+		(import)
+		    _files -g '*.md' && ret=0
+		    ;;
+		(list|pick)
+		    _arguments \
+			-C \
+			'1: :__rbnotes_list_keywords' \
+			&& ret=0
+		    ;;
+		(update)
+		    _arguments \
+			-C \
+			'(-k --keep)'{-k,--keep}'[keep timestamp]' \
+			'(-)*:: :->nul_state' \
+			&& ret=0
+		    ;;
+	    esac
+	    ;;
+    esac
+
+    return ret
+}
+
+__rbnotes_commands() {
+    local -a _cmds
+    _cmds=( $(rbnotes commands -d) )
+    _describe -t commands Commands _cmds
+}
+
+__rbnotes_list_keywords() {
+    local -a _kw _this_month _this_year
+    _this_month=$(date "+%Y%m")
+    _last_month=$(date -v-1m "+%Y%m")
+    _this_year=$(date "+%Y")
+    _kw=(
+	{to,today}':Today'
+	{ye,yesterday}':Yesterday'
+	{tw,this_week}':This week'
+	{lw,last_week}':Last week'
+	"${_this_month}:This month"
+	"${_last_month}:Last month"
+	"${_this_year}:This year"
+	)
+    _describe -t keywords Keywords _kw
+}
+
+_rbnotes "$@"
+
+# Local Variables:
+# mode: shell-script
+# End:

data/exe/rbnotes

@@ -48,14 +48,24 @@ app = App.new
 begin
   app.parse_global_options(ARGV)
   app.run(ARGV)
-rescue Errno::EPIPE => e
+rescue Errno::EPIPE => _
   # 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 NoArgumentError => _
+  # Fix issue #80: Typically, this error raises when a command tries
+  # to read the standard input for its arguments and gets nil.  It
+  # means user wants to cancel to execute.  So, just ignore the error
+  # and exit.
+  exit 0
 rescue MissingArgumentError, MissingTimestampError,
        NoEditorError, ProgramAbortError,
        Textrepo::InvalidTimestampStringError,
+       InvalidTimestampPatternError,
+       InvalidTimestampPatternAsDateError,
+       NoConfFileError,
+       NoTemplateFileError,
        ArgumentError,
        Errno::EACCES => e
   puts e.message

data/lib/rbnotes.rb

@@ -8,6 +8,7 @@ module Rbnotes
   require_relative "rbnotes/conf"
   require_relative "rbnotes/utils"
   require_relative "rbnotes/commands"
+  require_relative "rbnotes/statistics"
 
   class << self
     def utils

data/lib/rbnotes/commands.rb

@@ -58,13 +58,15 @@ Syntax:
 
 Example usage:
   #{Rbnotes::NAME} add [-t STAMP_PATTERN]
+  #{Rbnotes::NAME} commands [-d]
   #{Rbnotes::NAME} delete [TIMESTAMP]
   #{Rbnotes::NAME} export [TIMESTAMP [FILENAME]]
-  #{Rbnotes::NAME} import FILE
+  #{Rbnotes::NAME} import [-m|--use-mtime] FILE
   #{Rbnotes::NAME} list [STAMP_PATTERN|KEYWORD]
   #{Rbnotes::NAME} search PATTERN [STAMP_PATTERN]
-  #{Rbnotes::NAME} show [TIMESTAMP]
-  #{Rbnotes::NAME} update [TIMESTAMP]
+  #{Rbnotes::NAME} show [TIMESTAMP...]
+  #{Rbnotes::NAME} statistics ([-y]|[-m])
+  #{Rbnotes::NAME} update [-k] [TIMESTAMP]
 
 Further help for each command:
   #{Rbnotes::NAME} help commands

data/lib/rbnotes/commands/add.rb

@@ -42,6 +42,9 @@ module Rbnotes::Commands
           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
@@ -54,7 +57,8 @@ module Rbnotes::Commands
       editor = Rbnotes.utils.find_program(candidates)
       raise Rbnotes::NoEditorError, candidates if editor.nil?
 
-      tmpfile = Rbnotes.utils.run_with_tmpfile(editor, stamp.to_s)
+      template = read_template(conf)
+      tmpfile = Rbnotes.utils.run_with_tmpfile(editor, stamp.to_s, template)
 
       unless FileTest.exist?(tmpfile)
         puts "Cancel adding, since nothing to store"
@@ -127,5 +131,26 @@ HELP
       end
       stamp_str
     end
+
+    def read_template(conf)
+      template = nil
+      template_path = @opts[:template] || conf[:template]
+
+      if template_path
+        raise Rbnotes::NoTemplateFileError, template_path unless FileTest.exist?(template_path)
+        template = File.readlines(template_path, chomp: true)
+      else
+        template_path = default_template_file(conf)
+        template = File.readlines(template_path, chomp: true) if FileTest.exist?(template_path)
+      end
+
+      template
+    end
+
+    def default_template_file(conf)
+      dir = File.join(conf[:config_home], "templates")
+      File.expand_path("default.md", dir)
+    end
+
   end
 end

data/lib/rbnotes/commands/commands.rb

@@ -0,0 +1,121 @@
+module Rbnotes::Commands
+  ##
+  # Prints all command names into a single line.  When `-d` (or
+  # `--deve-commands`) was specified, development commands (such
+  # `conf`) would be also printed in addition to general commands.
+
+  class Commands < Command
+
+    def description             # :nodoc:
+      "Print all command names into a single line"
+    end
+
+    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
+
+      puts commands(@opts[:print_deve_commands]).join(" ")
+    end
+
+    def help
+      puts <<HELP
+usage:
+    #{Rbnotes::NAME} [-d|--deve-commands]
+
+Print all command names into a single line.  If "-d" option (or
+"--deve-commands") is specified, commands for development purpose are
+also printed.
+
+HELP
+      print_commands
+    end
+
+    # :stopdoc:
+    private
+
+    ##
+    # Enumerates all command names.
+    #
+    # :call-seq:
+    #     commands(builtins = false) -> [Array of Strings]
+
+    def commands(include_builtins = false)
+      names = external_commands.map { |cmd| cmd.to_s.downcase }
+      names += builtin_commands.map { |cmd| cmd.to_s.downcase } if include_builtins
+      names
+    end
+
+    def external_commands
+      Dir.glob("*.rb", :base => __dir__) { |rb|
+        require_relative rb
+      }
+      Rbnotes::Commands.constants.difference([:Builtins, :Command]).sort
+    end
+
+    def builtin_commands
+      Rbnotes::Commands::Builtins.constants.sort
+    end
+
+    def print_commands
+      Dir.glob("*.rb", :base => __dir__) { |rb|
+        require_relative rb
+      }
+      puts "#{Rbnotes::NAME.capitalize} Commands:"
+      print_commands_desc(external_commands)
+      puts
+      puts "for development purpose"
+      print_builtins_desc(builtin_commands)
+    end
+
+    def print_commands_desc(commands)
+      print_desc(Rbnotes::Commands, commands)
+    end
+
+    def print_builtins_desc(builtins)
+      print_desc(Rbnotes::Commands::Builtins, builtins)
+    end
+
+    class CmdNames
+      attr_reader :symbol, :name, :size
+      def initialize(cmd)
+        @symbol = cmd
+        @name = cmd.to_s.downcase
+        @size = name.size
+      end
+    end
+
+    def print_desc(mod, commands)
+      cmds = commands.map { |cmd| CmdNames.new(cmd) }
+      name_part_size = cmds.map(&:size).max + 2
+      cmds.map { |cmd|
+        puts "#{spaces(4)}#{name_part(cmd.name, name_part_size)} #{desc_part(cmd.symbol, mod)}"
+      }
+    end
+
+    def name_part(name, size)
+      "#{name}#{spaces(size)}"[0, size]
+    end
+
+    def desc_part(symbol, mod)
+      mod.const_get(symbol, false).new.description
+    end
+
+    def spaces(size)
+      Array.new(size, " ").join
+    end
+
+    # :startdoc:
+
+  end
+end

data/lib/rbnotes/commands/help.rb

@@ -7,7 +7,7 @@ module Rbnotes::Commands
   class Help < Command
 
     def description             # :nodoc:
-      "Provide help on each command"
+      "Print help of each command"
     end
 
     ##
@@ -20,8 +20,6 @@ module Rbnotes::Commands
       case cmd_name
       when nil
         self.help
-      when "commands"
-        print_commands
       else
         Commands.load(cmd_name).help
       end
@@ -59,40 +57,5 @@ Further information:
 HELP
     end
 
-    # :stopdoc:
-    private
-
-    def print_commands
-      Dir.glob("*.rb", :base => __dir__) { |rb|
-        next if rb == "help.rb"
-        require_relative rb
-      }
-      commands = Commands.constants.difference([:Builtins, :Command])
-      builtins = Commands::Builtins.constants
-
-      puts "#{Rbnotes::NAME.capitalize} Commands:"
-      print_commands_desc(commands.sort)
-      puts
-      puts "for development purpose"
-      print_builtins_desc(builtins.sort)
-    end
-
-    def print_commands_desc(commands)
-      print_desc(Commands, commands)
-    end
-
-    def print_builtins_desc(builtins)
-      print_desc(Commands::Builtins, builtins)
-    end
-
-    def print_desc(mod, commands)
-      commands.map { |cmd|
-        name = "#{cmd.to_s.downcase}        "[0, 8]
-        desc = mod.const_get(cmd, false).new.description
-        puts "    #{name} #{desc}"
-      }
-    end
-
-    # :startdoc:
   end
 end