rbnotes 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 840d2acc4c93d5b03d833b6a518c9740518e025aeb3bb2b6751864d5cf9e9d1c
-  data.tar.gz: 759f8bdc29d64e32c73d7e02540603c3bdf84b6bdf3ac91b7a76bf8e3cf2005d
+  metadata.gz: e8c8badba84cecd738d81b16ec9539c6b8f51199433da1808bcf07fffd45635c
+  data.tar.gz: ab85b5e5d963b88014ffeb780c8da1beb2116e55789e13dfcd2fdea3183651e1
 SHA512:
-  metadata.gz: b47f361e68f7e5275b981848035621fd31342a994d6bd5d90002f91417f4806ba364714b4ea86728f993e43e74868bf08508701531361c4e785830cc772a5b2e
-  data.tar.gz: '09cea0ff486e4e2a8521d732296e64a520c7d076088dd63c05cc4a9c219a2be28e65e50234859bab0d2772a92fb466b1ffc580525fb3565e8d68f7f7f81f8eec'
+  metadata.gz: 6bcbd5ce75daf93183480fe1f00ab72d801b70c894bb9ba70ecc8f03cc7cdc3f2173c71dc0a7c6d119cfcbb9a0c63dff5b8c05a527c1df8dfbbe186509a4e41c
+  data.tar.gz: 72a593af5a18ce7482952df1ceb9d2eb6132d2072bb3adc70075b08118e0594d0f294738e74ddf0087adb2a06946f145cef4ff71b4425aeb855aeaf68e211ac9

data/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 ## [Unreleased]
 Nothing to record here.
 
+## [0.4.6] - 2020-11-13
+### Added
+- Add a new command `pick` to select a note with picker program. (#59)
+
 ## [0.4.5] - 2020-11-12
 ### Changed
 - Add a feature to accept multiple args for `list`. (#57)

data/Gemfile.lock

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

data/conf/config.yml

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

data/conf/config_deve.yml

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

data/lib/rbnotes.rb

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

data/lib/rbnotes/commands/add.rb

@@ -27,7 +27,6 @@ module Rbnotes::Commands
   # If none of the above editor is available, the command fails.
 
   class Add < Command
-    include ::Rbnotes::Utils
 
     def description             # :nodoc:
       "Add a new note"
@@ -52,10 +51,10 @@ module Rbnotes::Commands
       stamp = @opts[:timestamp] || Textrepo::Timestamp.new(Time.now)
 
       candidates = [conf[:editor], ENV["EDITOR"], "nano", "vi"].compact
-      editor = find_program(candidates)
+      editor = Rbnotes.utils.find_program(candidates)
       raise Rbnotes::NoEditorError, candidates if editor.nil?
 
-      tmpfile = run_with_tmpfile(editor, stamp.to_s)
+      tmpfile = Rbnotes.utils.run_with_tmpfile(editor, stamp.to_s)
 
       unless FileTest.exist?(tmpfile)
         puts "Cancel adding, since nothing to store"

data/lib/rbnotes/commands/delete.rb

@@ -13,7 +13,7 @@ module Rbnotes::Commands
     end
 
     def execute(args, conf)
-      stamp = Rbnotes::Utils.read_timestamp(args)
+      stamp = Rbnotes.utils.read_timestamp(args)
 
       repo = Textrepo.init(conf)
       begin

data/lib/rbnotes/commands/export.rb

@@ -21,7 +21,7 @@ module Rbnotes::Commands
     #     execute([a String as timestring], Rbnotes::Conf or Hash) -> nil
 
     def execute(args, conf)
-      stamp = Rbnotes::Utils.read_timestamp(args)
+      stamp = Rbnotes.utils.read_timestamp(args)
 
       repo = Textrepo.init(conf)
       begin

data/lib/rbnotes/commands/list.rb

@@ -1,7 +1,3 @@
-require "date"
-require "unicode/display_width"
-require "io/console/size"
-
 module Rbnotes::Commands
 
   ##
@@ -55,15 +51,11 @@ module Rbnotes::Commands
     #     execute(Array, Rbnotes::Conf or Hash) -> nil
 
     def execute(args, conf)
-      patterns = args.size > 0 ? convert_keyword(args) : [nil]
-
+      patterns = Rbnotes.utils.expand_keyword_in_args(args)
       @repo = Textrepo.init(conf)
       # newer stamp shoud be above
-      stamps = patterns.map { |pat|
-        @repo.entries(pat)
-      }.flatten.sort{|a, b| b <=> a}.uniq
-      stamps.each { |timestamp|
-        puts make_headline(timestamp)
+      Rbnotes.utils.find_notes(patterns, @repo).each { |timestamp|
+        puts Rbnotes.utils.make_headline(timestamp, @repo.read(timestamp))
       }
     end
 
@@ -95,97 +87,5 @@ KEYWORD:
 HELP
     end
 
-    # :stopdoc:
-
-    private
-    TIMESTAMP_STR_MAX_WIDTH = "yyyymoddhhmiss_sfx".size
-
-    ##
-    # 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)
-    #
-    # The subject part will truncate when it is long.
-
-    def make_headline(timestamp)
-      _, column = IO.console_size
-      delimiter = ": "
-      subject_width = column - TIMESTAMP_STR_MAX_WIDTH - delimiter.size - 1
-
-      subject = remove_heading_markup(@repo.read(timestamp)[0])
-
-      ts_part = "#{timestamp.to_s}    "[0..(TIMESTAMP_STR_MAX_WIDTH - 1)] 
-      sj_part = truncate_str(subject, subject_width)
-
-      ts_part + delimiter + sj_part
-    end
-
-    def truncate_str(str, size)
-      count = 0
-      result = ""
-      str.each_char { |c|
-        count += Unicode::DisplayWidth.of(c)
-        break if count > size
-        result << c
-      }
-      result
-    end
-
-    def remove_heading_markup(str)
-      str.sub(/^#+ +/, '')
-    end
-
-    def convert_keyword(args)
-      patterns = []
-      while args.size > 0
-        arg = args.shift
-        case arg.to_s
-        when "today", "to"
-          patterns << Textrepo::Timestamp.new(Time.now).to_s[0..7]
-        when "yesterday", "ye"
-          t = Time.now
-          patterns << Date.new(t.year, t.mon, t.day).prev_day.strftime("%Y%m%d")
-        when "this_week", "tw"
-          patterns.concat(dates_in_this_week)
-        when "last_week", "lw"
-          patterns.concat(dates_in_last_week)
-        else
-          patterns << arg
-        end
-      end
-      patterns.sort!.uniq
-    end
-
-    # week day for Monday start calendar
-    def wday(time)
-      (time.wday - 1) % 7
-    end
-
-    def dates_in_this_week
-      to = Time.now
-      start = Date.new(to.year, to.mon, to.day).prev_day(wday(to))
-      dates_in_week(start)
-    end
-
-    def dates_in_last_week
-      to = Time.now
-      start_of_this_week = Date.new(to.year, to.mon, to.day).prev_day(wday(to))
-      dates_in_week(start_of_this_week.prev_day(7))
-    end
-
-    def dates_in_week(start_date)
-      dates = [start_date]
-      1.upto(6) { |i| dates << start_date.next_day(i) }
-      dates.map { |d| d.strftime("%Y%m%d") }
-    end
-
-    # :startdoc:
   end
 end

data/lib/rbnotes/commands/pick.rb

@@ -0,0 +1,47 @@
+module Rbnotes::Commands
+
+  ##
+  # Picks a timestamp with a picker program, like `fzf`.
+
+  class Pick < Command
+
+    def description             # :nodoc:
+      "Pick a timestamp with a picker program"
+    end
+
+    def execute(args, conf)
+      patterns = Rbnotes.utils.expand_keyword_in_args(args)
+      @repo = Textrepo.init(conf)
+
+      list = []
+      Rbnotes.utils.find_notes(patterns, @repo).each { |timestamp|
+        list << Rbnotes.utils.make_headline(timestamp, @repo.read(timestamp))
+      }
+
+      picker = conf[:picker]
+      unless picker.nil?
+        require 'open3'
+        result = Open3.pipeline_rw(picker) { |stdin, stdout, _|
+          stdin.puts list
+          stdin.close
+          stdout.read
+        }
+        puts result
+      else
+        puts list
+      end
+    end
+
+    def help                    # :nodoc:
+      puts <<HELP
+usage:
+    #{Rbnotes::NAME} pick
+
+Pick a timestamp with a picker program, like `fzf`.  This command
+refers the configuration setting of ":picker".  If no picker program
+is specified, it will behave as same as "list" command.
+
+HELP
+    end
+  end
+end

data/lib/rbnotes/commands/show.rb

@@ -19,7 +19,7 @@ module Rbnotes::Commands
     end
 
     def execute(args, conf)
-      stamp = Rbnotes::Utils.read_timestamp(args)
+      stamp = Rbnotes.utils.read_timestamp(args)
 
       repo = Textrepo.init(conf)
       content = repo.read(stamp)

data/lib/rbnotes/commands/update.rb

@@ -18,7 +18,6 @@ module Rbnotes::Commands
   # none of editors is available, the execution fails.
 
   class Update < Command
-    include ::Rbnotes::Utils
 
     def description             # :nodoc:
       "Update the content of a note"
@@ -44,8 +43,8 @@ module Rbnotes::Commands
         end
       end
 
-      target_stamp = Rbnotes::Utils.read_timestamp(args)
-      editor = find_editor(conf[:editor])
+      target_stamp = Rbnotes.utils.read_timestamp(args)
+      editor = Rbnotes.utils.find_editor(conf[:editor])
       repo = Textrepo.init(conf)
 
       text = nil
@@ -55,7 +54,7 @@ module Rbnotes::Commands
         raise Rbnotes::MissingTimestampError, target_stamp
       end
 
-      tmpfile = run_with_tmpfile(editor, target_stamp.to_s, text)
+      tmpfile = Rbnotes.utils.run_with_tmpfile(editor, target_stamp.to_s, text)
       text = File.readlines(tmpfile, :chomp => true)
 
       unless text.empty?

data/lib/rbnotes/error.rb

@@ -11,6 +11,7 @@ module Rbnotes
     MISSING_TIMESTAMP = "missing timestamp: %s"
     NO_EDITOR         = "No editor is available: %s"
     PROGRAM_ABORT     = "External program was aborted: %s"
+    UNKNOWN_KEYWORD   = "Unknown keyword: %s"
   end
 
   # :startdoc:
@@ -53,4 +54,14 @@ module Rbnotes
       super(ErrMsg::PROGRAM_ABORT % cmdline.join(" "))
     end
   end
+
+  ##
+  # An eeror raised when an unknown keyword was specified as a
+  # timestamp string pattern.
+
+  class UnknownKeywordError < Error
+    def initialize(keyword)
+      super(ErrMsg::UNKNOWN_KEYWORD % keyword)
+    end
+  end
 end

data/lib/rbnotes/utils.rb

@@ -1,12 +1,18 @@
+require "singleton"
 require "pathname"
 require "tmpdir"
+require "date"
+require "io/console/size"
+
+require "unicode/display_width"
 
 module Rbnotes
   ##
   # Defines several utility methods those are intended to be used in
   # Rbnotes classes.
   #
-  module Utils
+  class Utils
+    include Singleton
 
     ##
     # Finds a external editor program which is specified with the
@@ -26,7 +32,6 @@ module Rbnotes
     def find_editor(preferred_editor)
       find_program([preferred_editor, ENV["EDITOR"], "nano", "vi"].compact)
     end
-    module_function :find_editor
 
     ##
     # Finds a executable program in given names.  When the executable
@@ -60,7 +65,6 @@ module Rbnotes
       }
       nil
     end
-    module_function :find_program
 
     ##
     # Executes the program with passing the given filename as argument.
@@ -84,7 +88,6 @@ module Rbnotes
       raise ProgramAbortError, [prog, tmpfile] unless rc
       tmpfile
     end
-    module_function :run_with_tmpfile
 
     ##
     # Generates a Textrepo::Timestamp object from a String which comes
@@ -98,7 +101,6 @@ module Rbnotes
       str = args.shift || read_arg($stdin)
       Textrepo::Timestamp.parse_s(str)
     end
-    module_function :read_timestamp
 
     ##
     # Reads an argument from the IO object.  Typically, it is intended
@@ -119,7 +121,110 @@ module Rbnotes
         nil
       end
     end
-    module_function :read_arg
+
+    ##
+    # Parses the given arguments and expand keywords if found.  Each
+    # of the arguments is assumed to represent a timestamp pattern (or
+    # a keyword to be expand into several timestamp pattern).  Returns
+    # an Array of timestamp partterns (each pattern is a String
+    # object).
+    #
+    # A timestamp pattern looks like:
+    #
+    #   (a) full qualified timestamp (with suffix): "20201030160200"
+    #   (b) year and date part: "20201030"
+    #   (c) year and month part: "202010"
+    #   (d) year part only: "2020"
+    #   (e) date part only: "1030"
+    #
+    # KEYWORD:
+    #
+    #   - "today"      (or "to")
+    #   - "yeasterday" (or "ye")
+    #   - "this_week"  (or "tw")
+    #   - "last_week"  (or "lw")
+    #
+    # :call-seq:
+    #   expand_keyword_in_args(Array of Strings) -> Array of Strings
+
+    def expand_keyword_in_args(args)
+      return [nil] if args.empty?
+
+      patterns = []
+      while args.size > 0
+        arg = args.shift
+        if ["today", "to", "yesterday", "ye",
+            "this_week", "tw", "last_week", "lw"].include?(arg)
+          patterns.concat(Rbnotes.utils.expand_keyword(arg))
+        else
+          patterns << arg
+        end
+      end
+      patterns.sort.uniq
+    end
+
+    ##
+    # Expands a keyword to timestamp strings.
+    #
+    # :call-seq:
+    #     expand_keyword(keyword as String) -> Array of timestamp Strings
+
+    def expand_keyword(keyword)
+      patterns = []
+      case keyword
+      when "today", "to"
+        patterns << timestamp_pattern(date_of_today)
+      when "yesterday", "ye"
+        patterns << timestamp_pattern(date_of_yesterday)
+      when "this_week", "tw"
+        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) })
+      else
+        raise UnknownKeywordError, keyword
+      end
+      patterns
+    end
+
+    ##
+    # 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)
+    #
+    # The subject part will truncate when it is long.
+
+    def make_headline(timestamp, text)
+      _, column = IO.console_size
+      delimiter = ": "
+      subject_width = column - TIMESTAMP_STR_MAX_WIDTH - delimiter.size - 1
+
+      subject = remove_heading_markup(text[0])
+
+      ts_part = "#{timestamp.to_s}    "[0..(TIMESTAMP_STR_MAX_WIDTH - 1)] 
+      sj_part = truncate_str(subject, subject_width)
+
+      ts_part + delimiter + sj_part
+    end
+
+    ##
+    # Finds all notes those timestamps match to given patterns in the
+    # given repository.  Returns an Array contains Timestamp objects.
+    #
+    # :call-seq:
+    #     find_notes(Array of timestamp patterns, Textrepo::Repository)
+
+    def find_notes(timestamp_patterns, repo)
+      timestamp_patterns.map { |pat|
+        repo.entries(pat)
+      }.flatten.sort{ |a, b| b <=> a }.uniq
+    end
 
     # :stopdoc:
 
@@ -132,11 +237,72 @@ module Rbnotes
       }
       found.compact[0]
     end
-    module_function :search_in_path
 
     def add_extension(basename)
       "#{basename}.md"
     end
-    module_function :add_extension
+
+    def timestamp_pattern(date)
+      date.strftime("%Y%m%d")
+    end
+
+    def date_of_today
+      date(Time.now)
+    end
+
+    def date_of_yesterday
+      date(Time.now).prev_day
+    end
+
+    def date(time)
+      Date.new(time.year, time.mon, time.day)
+    end
+
+    def dates_in_this_week
+      dates_in_week(start_date_in_this_week)
+    end
+
+    def dates_in_last_week
+      dates_in_week(start_date_in_last_week)
+    end
+
+    def start_date_in_this_week
+      today = Time.now
+      Date.new(today.year, today.mon, today.day).prev_day(wday(today))
+    end
+
+    def start_date_in_last_week
+      start_date_in_this_week.prev_day(7)
+    end
+
+    def wday(time)
+      (time.wday - 1) % 7
+    end
+
+    def dates_in_week(start_date)
+      dates = [start_date]
+      1.upto(6) { |i| dates << start_date.next_day(i) }
+      dates
+    end
+
+    TIMESTAMP_STR_MAX_WIDTH = "yyyymoddhhmiss_sfx".size
+
+    def truncate_str(str, size)
+      count = 0
+      result = ""
+      str.each_char { |c|
+        count += Unicode::DisplayWidth.of(c)
+        break if count > size
+        result << c
+      }
+      result
+    end
+
+    def remove_heading_markup(str)
+      str.sub(/^#+ +/, '')
+    end
+
+    # :startdoc:
+
   end
 end

data/lib/rbnotes/version.rb

@@ -1,4 +1,4 @@
 module Rbnotes
-  VERSION = "0.4.5"
-  RELEASE = "2020-11-12"
+  VERSION = "0.4.6"
+  RELEASE = "2020-11-13"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbnotes
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - mnbi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-12 00:00:00.000000000 Z
+date: 2020-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: textrepo
@@ -68,6 +68,7 @@ files:
 - lib/rbnotes/commands/help.rb
 - lib/rbnotes/commands/import.rb
 - lib/rbnotes/commands/list.rb
+- lib/rbnotes/commands/pick.rb
 - lib/rbnotes/commands/search.rb
 - lib/rbnotes/commands/show.rb
 - lib/rbnotes/commands/update.rb