rbnotes 0.4.11 → 0.4.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4170ccc84305971d10f3726351cdc4138b5fabaa7293bc10a827ed0458f28b8c
-  data.tar.gz: 291efc32e2e65462e8c6996ecbbc7ffbb4e6887a5d0065bbb843d01dfbb8c78c
+  metadata.gz: a3f023516dcf1e39f18c6cd0195a548debfd635e23d476bdb7e89a6ddc5f981e
+  data.tar.gz: 52507a17c873c8732922e1cc5990fa41d74f36fca1f558fa5440090f3fcd9fe2
 SHA512:
-  metadata.gz: 1f6d2659c1a50f462867a53bff3f7b45e8b38035c3af44407b70d359c6af9409481f1033059384bd8d6b42d03981ce4f955ac87ee5fe7e99f5b50465d47f4e1b
-  data.tar.gz: f5949cfe44eef0951a80ec8949b6bb8a3440d5b483ddacdaf652d8b4dd258a7eb53db42c40290e9a2ebd6e3a1bf6e204f2382b41dd40b23ac8b271dd05547672
+  metadata.gz: '0946450a7eeda50688cc5dc836ce30e86d5db28e2af8dca8e84805026648ba018116e98d5b3d316339960a0273d1e717178c4832932418440e0db3c1d1b4e9a9'
+  data.tar.gz: 125c3c6fa116fc5cf13d82ba6fb522972b82364b61002de2adc6d36ab1f6d77051f89a948a7cc9ec28acce8179399b040bfc4d983e1c83c65bb2548cc44ee8eb

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,6 +5,42 @@ 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.
+
+## [0.4.16] - 2021-04-17
+- Add a new configuration setting to change the default behavior of
+  the `list` (and `pick`) command. (#109)
+
+## [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)

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.11)
-      textrepo (~> 0.5.4)
+    rbnotes (0.4.16)
+      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/exe/rbnotes

@@ -48,16 +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

@@ -10,9 +10,4 @@ module Rbnotes
   require_relative "rbnotes/commands"
   require_relative "rbnotes/statistics"
 
-  class << self
-    def utils
-      Utils.instance
-    end
-  end
 end

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.
     #

data/lib/rbnotes/commands/import.rb

@@ -29,16 +29,7 @@ module Rbnotes::Commands
 
     def execute(args, conf)
       @opts = {}
-      while args.size > 0
-        arg = args.shift
-        case arg
-        when "-m", "--use-mtime"
-          @opts[:use_mtime] = true
-        else
-          args.unshift(arg)
-          break
-        end
-      end
+      parse_opts(args)
 
       file = args.shift
       unless file.nil?
@@ -116,5 +107,25 @@ If birthtime is not available on the system, use mtime (modification
 time).
 HELP
     end
+
+    # :stopdoc:
+
+    private
+
+    def parse_opts(args)
+      while args.size > 0
+        arg = args.shift
+        case arg
+        when "-m", "--use-mtime"
+          @opts[:use_mtime] = true
+        else
+          args.unshift(arg)
+          break
+        end
+      end
+    end
+
+    # :startdoc:
+
   end
 end

data/lib/rbnotes/commands/list.rb

@@ -10,6 +10,8 @@ module Rbnotes::Commands
       "List notes"
     end
 
+    DEFAULT_BEHAVIOR = "today"  # :nodoc:
+
     ##
     # Shows a list of notes in the repository.  Arguments are
     # optional.  If several args are passed, each of them must be a
@@ -24,10 +26,12 @@ module Rbnotes::Commands
     #
     # A keyword must be one of them:
     #
-    # - "today"      (or "to")
-    # - "yeasterday" (or "ye")
-    # - "this_week"  (or "tw")
-    # - "last_week"  (or "lw")
+    #   - "today"      (or "to")
+    #   - "yeasterday" (or "ye")
+    #   - "this_week"  (or "tw")
+    #   - "last_week"  (or "lw")
+    #   - "this_month" (or "tm")
+    #   - "last_month" (or "lm")
     #
     # Here is several examples of timestamp patterns.
     #
@@ -52,38 +56,35 @@ module Rbnotes::Commands
 
     def execute(args, conf)
       @opts = {}
-      while args.size > 0
-        arg = args.shift
-        case arg
-        when "-w", "--week"
-          @opts[:enum_week] = true
-        else
-          args.unshift(arg)
-          break
-        end
-      end
+      parse_opts(args)
 
-      patterns = nil
-      if @opts[:enum_week]
-        arg = args.shift || Textrepo::Timestamp.now[0, 8]
-        case arg.size
-        when "yyyymodd".size, "yyyymoddhhmiss".size, "yyyymoddhhmiss_sfx".size
-          stamp_str = "#{arg}000000"[0, 14]
-          timestamp = Textrepo::Timestamp.parse_s(stamp_str)
-          patterns = Rbnotes.utils.timestamp_patterns_in_week(timestamp)
-        else
-          raise InvalidTimestampPatternError,
-                "cannot convert to a date [%s]" % args.unshift(arg)
-        end
-      else
-        patterns = Rbnotes.utils.expand_keyword_in_args(args)
+      if args.empty?
+        default_behavior = conf[:list_default] || DEFAULT_BEHAVIOR
+        args << default_behavior
       end
 
+      utils = Rbnotes.utils
+      patterns = utils.read_timestamp_patterns(args, enum_week: @opts[:enum_week])
+
       @repo = Textrepo.init(conf)
-      # newer stamp shoud be above
-      Rbnotes.utils.find_notes(patterns, @repo).each { |timestamp|
-        puts Rbnotes.utils.make_headline(timestamp, @repo.read(timestamp))
-      }
+      notes = utils.find_notes(patterns, @repo)
+      output = []
+      if @opts[:verbose]
+        collect_timestamps_by_date(notes).each { |date, timestamps|
+          output << "#{date} (#{timestamps.size})"
+          timestamps.each { |timestamp|
+            pad = "  "
+            output << utils.make_headline(timestamp,
+                                          @repo.read(timestamp), pad)
+          }
+        }
+      else
+        notes.each { |timestamp|
+          output << utils.make_headline(timestamp,
+                                        @repo.read(timestamp))
+        }
+      end
+      puts output
     end
 
     def help                    # :nodoc:
@@ -110,6 +111,8 @@ KEYWORD:
     - "yeasterday" (or "ye")
     - "this_week"  (or "tw")
     - "last_week"  (or "lw")
+    - "this_month" (or "tm")
+    - "last_month" (or "lm")
 
 An option "--week" is also acceptable.  It specifies to enumerate all
 days of a week.  Typically, the option is used with a STAMP_PATTERN
@@ -124,5 +127,39 @@ would be as same as the KEYWORD, "this_week" was specified.
 HELP
     end
 
+    # :stopdoc:
+
+    private
+
+    def parse_opts(args)
+      while args.size > 0
+        arg = args.shift
+        case arg
+        when "-w", "--week"
+          @opts[:enum_week] = true
+        when "-v", "--verbose"
+          @opts[:verbose] = true
+        else
+          args.unshift(arg)
+          break
+        end
+      end
+    end
+
+    def collect_timestamps_by_date(timestamps)
+      result = {}
+      timestamps.map { |ts|
+        [ts.strftime("%Y-%m-%d"), ts]
+      }.reduce(result) { |r, pair|
+        date, stamp = pair
+        r[date] ||= []
+        r[date] << stamp
+        r
+      }
+      result
+    end
+
+    # :startdoc:
+
   end
 end