rbnotes 0.4.11 → 0.4.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4170ccc84305971d10f3726351cdc4138b5fabaa7293bc10a827ed0458f28b8c
-  data.tar.gz: 291efc32e2e65462e8c6996ecbbc7ffbb4e6887a5d0065bbb843d01dfbb8c78c
+  metadata.gz: 517b5866c81f76286f87b2ed7d2e695c4dd09d5c7ab86f9557079232a58fde37
+  data.tar.gz: 1d89412445d155501f67cd0978a8070975ed722ee7440119cf5a9ba89ca946eb
 SHA512:
-  metadata.gz: 1f6d2659c1a50f462867a53bff3f7b45e8b38035c3af44407b70d359c6af9409481f1033059384bd8d6b42d03981ce4f955ac87ee5fe7e99f5b50465d47f4e1b
-  data.tar.gz: f5949cfe44eef0951a80ec8949b6bb8a3440d5b483ddacdaf652d8b4dd258a7eb53db42c40290e9a2ebd6e3a1bf6e204f2382b41dd40b23ac8b271dd05547672
+  metadata.gz: 1f0bab361e6f4a7f22a59433369b221b6dffc1e16b79f9d4bdc4027d78c3d61a6e949ab2b81ae1ab3be4c5d52af6bd74aed4b36c70a93f31e710a42b7bb23731
+  data.tar.gz: af38ba13276090ae653fee8b1b3f67f3de57596851ce8b645f4ed3463c38d71c4a950b3382bff55ad98853c42e2cb3f2df0e7e7652f756f385d53ef15f917085

data/CHANGELOG.md

@@ -5,6 +5,19 @@ 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.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.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rbnotes (0.4.11)
+    rbnotes (0.4.12)
       textrepo (~> 0.5.4)
       unicode-display_width (~> 1.7)
 

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/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/list.rb

@@ -24,10 +24,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.
     #
@@ -57,6 +59,8 @@ module Rbnotes::Commands
         case arg
         when "-w", "--week"
           @opts[:enum_week] = true
+        when "-v", "--verbose"
+          @opts[:verbose] = true
         else
           args.unshift(arg)
           break
@@ -70,20 +74,41 @@ module Rbnotes::Commands
         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)
+        when "modd".size
+          this_year = Time.now.year.to_s
+          stamp_str = "#{this_year}#{arg}000000"
+          begin
+            timestamp = Textrepo::Timestamp.parse_s(stamp_str)
+          rescue Textrepo::InvalidTimestampStringError => _e
+            raise InvalidTimestampPatternAsDateError, arg
+          end
         else
-          raise InvalidTimestampPatternError,
-                "cannot convert to a date [%s]" % args.unshift(arg)
+          raise InvalidTimestampPatternAsDateError, args.unshift(arg)
         end
+        patterns = Rbnotes.utils.timestamp_patterns_in_week(timestamp)
       else
         patterns = Rbnotes.utils.expand_keyword_in_args(args)
       end
 
       @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 = Rbnotes.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 << Rbnotes.utils.make_headline(timestamp,
+                                                  @repo.read(timestamp), pad)
+          }
+        }
+      else
+        notes.each { |timestamp|
+          output << Rbnotes.utils.make_headline(timestamp,
+                                                @repo.read(timestamp))
+        }
+      end
+      puts output
     end
 
     def help                    # :nodoc:
@@ -110,6 +135,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 +151,24 @@ would be as same as the KEYWORD, "this_week" was specified.
 HELP
     end
 
+    # :stopdoc:
+
+    private
+
+    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

data/lib/rbnotes/commands/pick.rb

@@ -20,8 +20,12 @@ module Rbnotes::Commands
 
       picker = conf[:picker]
       unless picker.nil?
+        picker_opts = conf[:picker_option]
+        cmds = [picker]
+        cmds.concat(picker_opts.split) unless picker_opts.nil?
+
         require 'open3'
-        result = Open3.pipeline_rw(picker) { |stdin, stdout, _|
+        result = Open3.pipeline_rw(cmds) { |stdin, stdout, _|
           stdin.puts list
           stdin.close
           stdout.read

data/lib/rbnotes/conf.rb

@@ -31,19 +31,26 @@ module Rbnotes
 
     DIRNAME_COMMON_CONF = ".config"
 
-    def initialize(conf_path = nil)   # :nodoc:
-      @conf_path = conf_path
+    def initialize(path = nil)   # :nodoc:
       @conf = {}
 
-      if use_default_values?
-        @conf.merge!(DEFAULT_VALUES)
+      unless path.nil?
+        abspath = File.expand_path(path)
+        raise NoConfFileError, path unless FileTest.exist?(abspath)
+        @conf[:path] = abspath
       else
-        @conf_path ||= default_conf_file
-        raise NoConfFileError, @conf_path unless File.exist?(@conf_path)
-
-        yaml_str = File.open(@conf_path, "r") { |f| f.read }
-        @conf = YAML.load(yaml_str)
+        @conf[:path] = default_conf_path
       end
+
+      values =
+        if FileTest.exist?(@conf[:path])
+          yaml_str = File.open(@conf[:path], "r") { |f| f.read }
+          YAML.load(yaml_str)
+        else
+          DEFAULT_VALUES
+        end
+      @conf.merge!(values)
+      @conf[:config_home] = config_home
     end
 
     def_delegators(:@conf,
@@ -91,7 +98,7 @@ module Rbnotes
       :test => "_test",
     }
 
-    def base_path
+    def config_home
       path = nil
       xdg, user = ["XDG_CONFIG_HOME", "HOME"].map{|n| ENV[n]}
       if xdg
@@ -99,15 +106,11 @@ module Rbnotes
       else
         path = File.join(user, DIRNAME_COMMON_CONF, DIRNAME_RBNOTES)
       end
-      return path
-    end
-
-    def default_conf_file
-      File.join(base_path, FILENAME_CONF)
+      path
     end
 
-    def use_default_values?
-      @conf_path.nil? && !File.exist?(default_conf_file)
+    def default_conf_path
+      File.join(config_home, FILENAME_CONF)
     end
 
   # :startdoc:

data/lib/rbnotes/error.rb

@@ -7,13 +7,15 @@ module Rbnotes
   # :stopdoc:
 
   module ErrMsg
-    MISSING_ARGUMENT  = "Missing argument: %s"
-    MISSING_TIMESTAMP = "Missing timestamp: %s"
-    NO_EDITOR         = "No editor is available: %s"
-    PROGRAM_ABORT     = "External program was aborted: %s"
-    UNKNOWN_KEYWORD   = "Unknown keyword: %s"
-    INVALID_TIMESTAMP_PATTERN = "Invalid timestamp pattern: %s"
-    NO_CONF_FILE      = "No configuration file: %s"
+    MISSING_ARGUMENT  = "missing argument: %s"
+    MISSING_TIMESTAMP = "missing timestamp: %s"
+    NO_EDITOR         = "no editor is available: %s"
+    PROGRAM_ABORT     = "external program was aborted: %s"
+    UNKNOWN_KEYWORD   = "unknown keyword: %s"
+    INVALID_TIMESTAMP_PATTERN = "invalid timestamp pattern: %s"
+    NO_CONF_FILE      = "no configuration file: %s"
+    NO_TEMPLATE_FILE  = "no template file: %s"
+    INVALID_TIMESTAMP_PATTERN_AS_DATE = "invalid timestamp pattern as date: %s"
   end
 
   # :startdoc:
@@ -86,4 +88,32 @@ module Rbnotes
     end
   end
 
+  ##
+  # An error raised when no arguments is spcified.
+
+  class NoArgumentError < Error
+    def initialize
+      super
+    end
+  end
+
+  ##
+  # An error raised when the specified template files does not exist.
+  #
+  class NoTemplateFileError < Error
+    def initialize(filepath)
+      super(ErrMsg::NO_TEMPLATE_FILE % filepath)
+    end
+  end
+
+  ##
+  # An error raised when the specified pattern cannot be converted
+  # into a date.
+  #
+  class InvalidTimestampPatternAsDateError < Error
+    def initialize(pattern)
+      super(ErrMsg::INVALID_TIMESTAMP_PATTERN_AS_DATE % pattern)
+    end
+  end
+
 end

data/lib/rbnotes/utils.rb

@@ -99,6 +99,7 @@ module Rbnotes
 
     def read_timestamp(args)
       str = args.shift || read_arg($stdin)
+      raise NoArgumentError if str.nil?
       Textrepo::Timestamp.parse_s(str)
     end
 
@@ -112,6 +113,7 @@ module Rbnotes
 
     def read_multiple_timestamps(args)
       strings = args.size < 1 ? read_multiple_args($stdin) : args
+      raise NoArgumentError if (strings.nil? || strings.empty?)
       strings.map { |str| Textrepo::Timestamp.parse_s(str) }
     end
 
@@ -136,6 +138,8 @@ module Rbnotes
     #   - "yeasterday" (or "ye")
     #   - "this_week"  (or "tw")
     #   - "last_week"  (or "lw")
+    #   - "this_month" (or "tm")
+    #   - "last_month" (or "lm")
     #
     # :call-seq:
     #   expand_keyword_in_args(Array of Strings) -> Array of Strings
@@ -147,7 +151,8 @@ module Rbnotes
       while args.size > 0
         arg = args.shift
         if ["today", "to", "yesterday", "ye",
-            "this_week", "tw", "last_week", "lw"].include?(arg)
+            "this_week", "tw", "last_week", "lw",
+            "this_month", "tm", "last_month", "lm"].include?(arg)
           patterns.concat(Rbnotes.utils.expand_keyword(arg))
         else
           patterns << arg
@@ -173,6 +178,10 @@ module Rbnotes
         patterns.concat(dates_in_this_week.map { |d| timestamp_pattern(d) })
       when "last_week", "lw"
         patterns.concat(dates_in_last_week.map { |d| timestamp_pattern(d) })
+      when "this_month", "tm"
+        patterns.concat(dates_in_this_month.map { |d| timestamp_pattern(d) })
+      when "last_month", "lm"
+        patterns.concat(dates_in_last_month.map { |d| timestamp_pattern(d) })
       else
         raise UnknownKeywordError, keyword
       end
@@ -183,25 +192,28 @@ module Rbnotes
     # Makes a headline with the timestamp and subject of the notes, it
     # looks like as follows:
     #
-    #   |<------------------ console column size ------------------->|
-    #   +-- timestamp ---+  +-  subject (the 1st line of each note) -+
-    #   |                |  |                                        |
-    #   20101010001000_123: I love Macintosh.                        [EOL]
-    #   20100909090909_999: This is very very long long loooong subje[EOL]
-    #                     ++
-    #                      ^--- delimiter (2 characters)
+    #   |<--------------- console column size -------------------->|
+    #   |   |+-- timestamp ---+  +-subject (the 1st line of note) -+
+    #   |                     |  |                                 |
+    #   |   |20101010001000_123: I love Macintosh.                 [EOL]
+    #   |   |20100909090909_999: This is very very long looong subj[EOL]
+    #   |<->|                 |  |
+    #     ^--- pad             ++
+    #                          ^--- delimiter (2 characters)
     #
     # The subject part will truncate when it is long.
 
-    def make_headline(timestamp, text)
+    def make_headline(timestamp, text, pad = nil)
       _, column = IO.console_size
       delimiter = ": "
       timestamp_width = timestamp.to_s.size
       subject_width = column - timestamp_width - delimiter.size - 1
+      subject_width -= pad.size unless pad.nil?
 
       subject = remove_heading_markup(text[0])
 
       ts_part = "#{timestamp.to_s}    "[0..(timestamp_width - 1)]
+      ts_part.prepend(pad) unless pad.nil?
       sj_part = truncate_str(subject, subject_width)
 
       ts_part + delimiter + sj_part
@@ -210,6 +222,7 @@ module Rbnotes
     ##
     # Finds all notes those timestamps match to given patterns in the
     # given repository.  Returns an Array contains Timestamp objects.
+    # The returned Array is sorted by Timestamp.
     #
     # :call-seq:
     #     find_notes(Array of timestamp patterns, Textrepo::Repository)
@@ -329,6 +342,36 @@ module Rbnotes
       dates
     end
 
+    def dates_in_this_month
+      today = Time.now
+      first_date = date(Time.new(today.year, today.mon, 1))
+      dates_in_month(first_date)
+    end
+
+    def dates_in_last_month
+      today = Time.now
+      first_date_of_this_month = date(Time.new(today.year, today.mon, 1))
+      dates_in_month(first_date_of_this_month.prev_month)
+    end
+
+    def dates_in_month(first_date)
+      days = days_in_month(first_date.mon, leap: first_date.leap?)
+      dates = [first_date]
+      1.upto(days - 1) { |i| dates << first_date.next_day(i) }
+      dates
+    end
+
+    DAYS = {
+      #             1   2   3   4   5   6   7   8   9  10  11  12
+      #            Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec
+      false => [0, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31],
+      true  => [0, 31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31],
+    }
+
+    def days_in_month(mon, leap: false)
+      DAYS[leap][mon]
+    end
+
     def truncate_str(str, size)
       count = 0
       result = ""

data/lib/rbnotes/version.rb

@@ -1,4 +1,4 @@
 module Rbnotes
-  VERSION = "0.4.11"
-  RELEASE = "2020-12-07"
+  VERSION = "0.4.12"
+  RELEASE = "2020-12-18"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbnotes
 version: !ruby/object:Gem::Version
-  version: 0.4.11
+  version: 0.4.12
 platform: ruby
 authors:
 - mnbi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-07 00:00:00.000000000 Z
+date: 2020-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: textrepo
@@ -58,6 +58,9 @@ files:
 - bin/setup
 - conf/config.yml
 - conf/config_deve.yml
+- conf/config_deve_fzf_no_opts.yml
+- conf/config_deve_no_picker.yml
+- conf/config_deve_peco.yml
 - conf/config_test.yml
 - etc/zsh/_rbnotes
 - exe/rbnotes