rbnotes 0.4.10 → 0.4.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e6de4675ffb2b409f72f240e4509a6d254793d977a8dd68cc54cf6d0c839e3d
-  data.tar.gz: 364d4deb47d049af7145024cfb3151639ea9cf0504963c1b72e5a15e465a84a6
+  metadata.gz: 54f0c34e51ca307615ee9995cf7daeb2f65dff0a3aaa41df305f3414ce6e197e
+  data.tar.gz: 48bb529501aabc93ec78dd3fa6d984e11eb4a5dfb8e823d8ea6bdcb80e065e9c
 SHA512:
-  metadata.gz: bf90b255e23257a921f7a9254d4df5233f97394e73368f27f6a4a8e96989fa3aa76ab55fca69b201ecd9a15264d5d07cf974ee9b745854ca80d3c962accbe37a
-  data.tar.gz: c9fca12a0a6a71562a968775b09e3ebf7bda202ce7251666ab7b727236c47f8b5981d7ee703b94bfc22fae038cc161f76b10ed413ca28bcac3a9d9e0417f7f83
+  metadata.gz: b51574083b7d894773b1f597e693209ea6a152533d0035342f4e88f764ac925bf8fe1effd0b81b1a17200d1d5b6e386a0f12c4d790746aae4a6ee7896aa3b990
+  data.tar.gz: 59032141edc6f7335d6f6b00c76da7c64f983be04825603b9f3feaa3213e4599b55eff19744df446e5d66b1f8248c523f926a155de3a9d1a5f94a907afea7646

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Build
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.0
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -35,7 +35,6 @@ build-iPhoneSimulator/
 ## Documentation cache and generated files:
 /.yardoc/
 /_yardoc/
-/doc/
 /rdoc/
 
 ## Environment normalization:

data/CHANGELOG.md

@@ -5,7 +5,51 @@ 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.15] - 2021-04-15
+- Enable to use delimiters within a timestamp string. (#104)
+- Fix issue #105: `list` ignores the 2nd arg when specified `-w`
+  option.
+
+## [0.4.14] - 2021-04-10
+- Add `-n` option to `show` command. (#102)
+- Fix issue #100: modify to catch Textrepo::MissingTimestampError.
+
+## [0.4.13] - 2021-03-30
+### Changed
+- Use GitHub/Actions instead of Travis-CI.
+- Add `--week` option to `pick` command. (#88)
+
+### Fixed
+- Fix issue #98: remove redundant args
+  (Rbnotes::Utils.read_multiple_timestamps). (#98)
+- Update `textrepo`. -> 0.5.8 (#97)
+
+## [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

data/Gemfile

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

data/Gemfile.lock

@@ -1,16 +1,16 @@
 PATH
   remote: .
   specs:
-    rbnotes (0.4.10)
-      textrepo (~> 0.5.4)
+    rbnotes (0.4.15)
+      textrepo (~> 0.5.8)
       unicode-display_width (~> 1.7)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    minitest (5.14.2)
-    rake (13.0.1)
-    textrepo (0.5.7)
+    minitest (5.14.4)
+    rake (13.0.3)
+    textrepo (0.5.8)
     unicode-display_width (1.7.0)
 
 PLATFORMS
@@ -20,7 +20,7 @@ DEPENDENCIES
   minitest (~> 5.0)
   rake (~> 13.0)
   rbnotes!
-  textrepo (~> 0.5.4)
+  textrepo (~> 0.5.8)
 
 BUNDLED WITH
-   2.1.4
+   2.2.15

data/README.md

@@ -1,6 +1,7 @@
 # Rbnotes
 
-[![Build Status](https://travis-ci.org/mnbi/rbnotes.svg?branch=main)](https://travis-ci.org/mnbi/rbnotes)
+[![Build Status](https://github.com/mnbi/rbnotes/workflows/Build/badge.svg)](https://github.com/mnbi/rbnotes/actions?query=workflow%3A"Build")
+[![CodeFactor](https://www.codefactor.io/repository/github/mnbi/rbnotes/badge)](https://www.codefactor.io/repository/github/mnbi/rbnotes)
 
 Rbnotes is a simple utility to write a note in the single repository.
 

data/Rakefile

@@ -25,6 +25,6 @@ require "rdoc/task"
 
 RDoc::Task.new do |rdoc|
   rdoc.generator = "ri"
-  rdoc.rdoc_dir = "doc"
+  rdoc.rdoc_dir = "rdoc"
   rdoc.rdoc_files.include("lib/**/*.rb")
 end

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,15 +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,10 +8,6 @@ module Rbnotes
   require_relative "rbnotes/conf"
   require_relative "rbnotes/utils"
   require_relative "rbnotes/commands"
+  require_relative "rbnotes/statistics"
 
-  class << self
-    def utils
-      Utils.instance
-    end
-  end
 end

data/lib/rbnotes/commands.rb

@@ -61,10 +61,11 @@ Example usage:
   #{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} show [TIMESTAMP...]
+  #{Rbnotes::NAME} statistics ([-y]|[-m])
   #{Rbnotes::NAME} update [-k] [TIMESTAMP]
 
 Further help for each command:

data/lib/rbnotes/commands/add.rb

@@ -34,19 +34,7 @@ module Rbnotes::Commands
 
     def execute(args, conf)
       @opts = {}
-      while args.size > 0
-        arg = args.shift
-        case arg
-        when "-t", "--timestamp"
-          stamp_str = args.shift
-          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)
-        else
-          args.unshift(arg)
-          break
-        end
-      end
+      parse_opts(args)
 
       stamp = @opts[:timestamp] || Textrepo::Timestamp.new(Time.now)
 
@@ -54,7 +42,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"
@@ -112,7 +101,28 @@ HELP
     end
 
     # :stopdoc:
+
     private
+
+    def parse_opts(args)
+      while args.size > 0
+        arg = args.shift
+        case arg
+        when "-t", "--timestamp"
+          stamp_str = args.shift
+          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
+        end
+      end
+    end
+
     def complement_timestamp_pattern(pattern)
       stamp_str = nil
       case pattern.to_s.size
@@ -127,5 +137,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

@@ -12,18 +12,7 @@ module Rbnotes::Commands
 
     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
+      parse_opts(args)
 
       puts commands(@opts[:print_deve_commands]).join(" ")
     end
@@ -42,8 +31,24 @@ HELP
     end
 
     # :stopdoc:
+
     private
 
+    def parse_opts(args)
+      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
+    end
+
     ##
     # Enumerates all command names.
     #