rbnotes 0.4.18 → 0.4.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a831d67abfd0bae05156f047b6baf44428bc4940058e43bfb9825b5d91c4177
-  data.tar.gz: 7fb70e39e9feb75edfabe3461697ddfb0145cf449205c25068471687952908d0
+  metadata.gz: c983ec2e16d7e384a8b1ba50cd79ed327a1b69cf415c471becfb19dfd71ba5a2
+  data.tar.gz: 2147e0b2c7564fc18f664dbd39ee597dbb642a8e6b42575d71078c5cc85cc8c4
 SHA512:
-  metadata.gz: 7ea3b1ea6517130e5ba5ece651da8f3e30f1013aaa40aa375ad16fb09a7e07a033c7da4e59a721fade178ed4720cf804cb60cc843ea42cbcb177fdf81f947f01
-  data.tar.gz: 6a19760bdecd4b967717c30bed0974a8098d5b3f9e9df9a90bd81cd6b1498a6ba226f2e5654547f1ec67da9beb3d54c740ab9895163d8488df9801b74539f8aa
+  metadata.gz: f2389e447037b2b9a5a9f2136b435c44cc86bc8f1b84da057ffe9b1474132564034baf539e946dc74aeafa7ba609cd81bd32c1036c60991b1959e691523a3ad9
+  data.tar.gz: 257fd944e264ae91780b63a9b37bfca1658943e2098ca4a007e49f05b875e4c496d475e10299496c4d397ffaa6cefe23549267bd3a0a07c8a5d6f658a37e2941

data/.github/workflows/main.yml

@@ -10,7 +10,7 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.0.0
+        ruby-version: 3.1.0
     - name: Run the default task
       run: |
         gem install bundler -v 2.2.3

data/CHANGELOG.md

@@ -5,7 +5,21 @@ 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)
+- Fix issue #133: some tests fail.
+
+## [0.4.20] - 2022-12-03
+### Added
+- Add a new keyword, `recent`. (#131)
+
+## [0.4.19] - 2021-05-24
+### Added
+- Add an option to search in only the subject of each note. (#128)
+
+### Modified
+- Update copyright year in `LICENSE`. (#127)
+
+### Fixed
+- Fix #129: add description about the keyword, "all."
 
 ## [0.4.18] - 2021-04-29
 ### Added

data/Gemfile

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

data/Gemfile.lock

@@ -1,26 +1,26 @@
 PATH
   remote: .
   specs:
-    rbnotes (0.4.18)
-      textrepo (~> 0.5.8)
-      unicode-display_width (~> 1.7)
+    rbnotes (0.4.20)
+      textrepo (~> 0.5.9)
+      unicode-display_width (~> 1.8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    minitest (5.14.4)
-    rake (13.0.3)
-    textrepo (0.5.8)
-    unicode-display_width (1.7.0)
+    minitest (5.16.3)
+    rake (13.0.6)
+    textrepo (0.5.9)
+    unicode-display_width (1.8.0)
 
 PLATFORMS
-  ruby
+  x86_64-darwin-22
 
 DEPENDENCIES
   minitest (~> 5.0)
   rake (~> 13.0)
   rbnotes!
-  textrepo (~> 0.5.8)
+  textrepo (~> 0.5.9)
 
 BUNDLED WITH
-   2.2.15
+   2.3.11

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 mnbi
+Copyright (c) 2020, 2021 mnbi
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/exe/rbnotes

@@ -66,6 +66,7 @@ rescue MissingArgumentError, MissingTimestampError,
        InvalidTimestampPatternAsDateError,
        NoConfFileError,
        NoTemplateFileError,
+       UnknownKeywordError,
        ArgumentError,
        Errno::EACCES => e
   puts e.message

data/lib/rbnotes/commands/export.rb

@@ -22,6 +22,7 @@ module Rbnotes::Commands
 
     def execute(args, conf)
       stamp = Rbnotes.utils.read_timestamp(args)
+      args.shift                # drop the 1st argument
 
       repo = Textrepo.init(conf)
       begin

data/lib/rbnotes/commands/list.rb

@@ -33,6 +33,8 @@ module Rbnotes::Commands
     #   - "last_week"  (or "lw")
     #   - "this_month" (or "tm")
     #   - "last_month" (or "lm")
+    #   - "recent"     (or "re")
+    #   - "all"
     #
     # Here is several examples of timestamp patterns.
     #
@@ -66,9 +68,11 @@ module Rbnotes::Commands
 
       utils = Rbnotes.utils
       patterns = utils.read_timestamp_patterns(args, enum_week: @opts[:enum_week])
-
       repo = Textrepo.init(conf)
-      stamps = utils.find_notes(patterns, repo)
+
+      num_of_notes = utils.specified_recent?(args) ? conf[:number_of_recent_notes] : 0
+      stamps = utils.find_notes(patterns, repo, num_of_notes)
+
       output = []
       if @opts[:verbose]
         collect_timestamps_by_date(stamps).each { |date, timestamps|
@@ -106,23 +110,6 @@ OPTIONS:
     -v, --verbose
     -w, --week
 
-STAMP_PATTERN must be:
-
-    (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")
-    - "this_month" (or "tm")
-    - "last_month" (or "lm")
-
 An option "--verbose" is acceptable.  It specifies to counts number of
 notes by each day, then put it with the date before notes.  It looks
 like as follows:
@@ -140,11 +127,35 @@ days of a week.  Typically, the option is used with a STAMP_PATTERN
 which specifies a date, such "20201117", then it enumerates all days
 of the week which contains "17th November 2020".
 
+STAMP_PATTERN must be:
+
+    (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"
+
 A STAMP_PATTERN other than (a) and (b) causes an error if it was used
 with "--week" option.
 
 When no STAMP_PATTERN was specified with "--week" option, the output
 would be as same as the KEYWORD, "this_week" was specified.
+
+KEYWORD:
+
+    - "today"      (or "to")
+    - "yeasterday" (or "ye")
+    - "this_week"  (or "tw")
+    - "last_week"  (or "lw")
+    - "this_month" (or "tm")
+    - "last_month" (or "lm")
+    - "recent"     (or "re")
+    - "all"
+
+The keyword, "recent" specifies to enumerate recent notes in the
+repository.  The keyword, "all" specifies to enumerate all notes in
+the repository.
+
 HELP
     end
 

data/lib/rbnotes/commands/pick.rb

@@ -25,7 +25,8 @@ module Rbnotes::Commands
 
       repo = Textrepo.init(conf)
 
-      stamps = utils.find_notes(patterns, repo)
+      num_of_notes = utils.specified_recent?(args) ? conf[:number_of_recent_notes] : 0
+      stamps = utils.find_notes(patterns, repo, num_of_notes)
       return if stamps.empty?
 
       list = []

data/lib/rbnotes/commands/search.rb

@@ -29,6 +29,9 @@ module Rbnotes::Commands
     end
 
     def execute(args, conf)
+      @opts = {}
+      parse_opts(args)
+
       pattern = args.shift
       raise MissingArgumentError, args if pattern.nil?
 
@@ -46,11 +49,18 @@ module Rbnotes::Commands
     def help                    # :nodoc:
       puts <<HELP
 usage:
-    #{Rbnotes::NAME} search PATTERN [STAMP_PATTERN]
+    #{Rbnotes::NAME} search [OPTIONS] PATTERN [STAMP_PATTERN]
 
 PATTERN is a word (or words) to search, it may also be a regular
 expression.
 
+OPTIONS:
+    -s, --subject-only
+
+An option "--subject-only" is acceptable.  It specifies to search in
+only the subject of each note.  The subject means the first line of
+the note text.
+
 STAMP_PATTERN must be:
 
     (a) full qualified timestamp (with suffix): "20201030160200"
@@ -58,11 +68,25 @@ STAMP_PATTERN must be:
     (c) year and month part: "202010"
     (d) year part only: "2020"
     (e) date part only: "1030"
+
 HELP
     end
 
     private
 
+    def parse_opts(args)
+      while args.size > 0
+        arg = args.shift
+        case arg
+        when "-s", "--subject-only"
+          @opts[:subject_only] = true
+        else
+          args.unshift(arg)
+          break
+        end
+      end
+    end
+
     # Each entry of search result is:
     #
     #   [<timestamp>, <line_number>, <matched_text>]
@@ -84,6 +108,10 @@ HELP
     }
 
     def print_search_result(entries)
+      if @opts[:subject_only]
+        entries.select!{|e| e.line_number == 1}
+      end
+
       maxcol_stamp = entries.map(&:timestamp_size).max
       maxcol_num = entries.map(&:line_number_digits_size).max
 
@@ -91,7 +119,11 @@ HELP
         stamp_display = "%- *s" % [maxcol_stamp, e.timestamp]
         num_display = "%*d" % [maxcol_num, e.line_number]
 
-        puts "#{stamp_display}: #{num_display}: #{e.matched_text}"
+        if @opts[:subject_only]
+          puts "#{stamp_display}: #{e.matched_text}"
+        else
+          puts "#{stamp_display}: #{num_display}: #{e.matched_text}"
+        end
       }
     end
 

data/lib/rbnotes/commands/show.rb

@@ -22,7 +22,7 @@ module Rbnotes::Commands
       parse_opts(args)
 
       repo = Textrepo.init(conf)
-      stamps = read_timestamps(args, repo)
+      stamps = read_timestamps(args, repo, conf)
       return if stamps.empty?
 
       content = stamps.map { |stamp|
@@ -98,13 +98,14 @@ HELP
       end
     end
 
-    def read_timestamps(args, repo)
+    def read_timestamps(args, repo, conf)
       utils = Rbnotes.utils
       if args.empty?
         stamps = utils.read_multiple_timestamps(args)
       else
         patterns = utils.read_timestamp_patterns(args)
-        stamps = utils.find_notes(patterns, repo)
+        num_of_notes = utils.specified_recent?(args) ? conf[:number_of_recent_notes] : 0
+        stamps = utils.find_notes(patterns, repo, num_of_notes)
       end
       stamps
     end

data/lib/rbnotes/conf.rb

@@ -31,6 +31,12 @@ module Rbnotes
 
     DIRNAME_COMMON_CONF = ".config"
 
+    ##
+    # Name of the number of notes to enumerate.  The values is
+    # referred only to enumerate the recent notes.
+
+    NUMBER_OF_RECENT_NOTES = 10
+
     def initialize(path = nil)   # :nodoc:
       @conf = {}
 
@@ -90,6 +96,7 @@ module Rbnotes
       :repository_type => :file_system,
       :repository_name => "notes",
       :repository_base => "~",
+      :number_of_recent_notes => 10,
     }
 
     MODE_POSTFIX = {

data/lib/rbnotes/utils.rb

@@ -125,6 +125,8 @@ module Rbnotes
     #   read_timestamp(args) -> String
 
     def read_timestamp(args)
+      args = args.dup
+
       str = args.shift || read_arg($stdin)
       raise NoArgumentError if str.nil?
 
@@ -163,6 +165,9 @@ module Rbnotes
     # Commands::Pick#execute.
     #
     def read_timestamp_patterns(args, enum_week: false)
+      args = args.dup
+
+      validate_arguments(args)
       patterns = nil
       if enum_week
         args.unshift(Time.now.strftime("%Y%m%d")) if args.size == 0
@@ -254,12 +259,13 @@ module Rbnotes
     #   expand_keyword_in_args(Array of Strings) -> Array of Strings
     #
     def expand_keyword_in_args(args)
+      args = args.dup
       patterns = []
       while args.size > 0
         arg = args.shift
-        if arg == "all"
+        if arg == "all" or arg == "recent" or arg == "re"
           return [nil]
-        elsif KEYWORDS.include?(arg)
+        elsif valid_keyword?(arg)
           patterns.concat(expand_keyword(arg))
         else
           patterns << arg
@@ -304,13 +310,27 @@ module Rbnotes
     # given repository.  Returns an Array contains Timestamp objects.
     # The returned Array is sorted by Timestamp.
     #
+    # When a positive number was specified as the 3rd argument, the
+    # number was used as the limitation count of enumerated notes.
+    #
     # :call-seq:
-    #     find_notes(Array of timestamp patterns, Textrepo::Repository)
+    #     find_notes(Array of timestamp patterns, Textrepo::Repository, Integer)
 
-    def find_notes(timestamp_patterns, repo)
-      timestamp_patterns.map { |pat|
+    def find_notes(timestamp_patterns, repo, num_of_notes = 0)
+      notes = timestamp_patterns.map { |pat|
         repo.entries(pat)
       }.flatten.sort{ |a, b| b <=> a }.uniq
+
+      if num_of_notes > 0
+        notes[0,num_of_notes]
+      else
+        notes
+      end
+    end
+
+    def specified_recent?(args)
+      validate_arguments(args)
+      args.include?("recent") or args.include?("re")
     end
 
     # :stopdoc:
@@ -360,6 +380,30 @@ module Rbnotes
       str
     end
 
+    ##
+    # Validates arguments as timestamp strings or keywords.  If all
+    # arguments are valid as timestamp strings or keywords, do
+    # nothing.  Otherwise, raise an error.
+    #
+    # :call-seq:
+    #   validate_arguments(an array of strings) -> nil
+    #
+    def validate_arguments(args)
+      args.each { |arg|
+        unless valid_keyword?(arg) or valid_timestamp_pattern?(arg)
+          raise InvalidTimestampPatternError, arg
+        end
+      }
+    end
+
+    def valid_keyword?(arg)
+      KEYWORDS.include?(arg)
+    end
+
+    def valid_timestamp_pattern?(arg)
+      !/[^_\d]/.match(arg)
+    end
+
     ##
     # Expands a keyword to timestamp strings.
     #
@@ -388,6 +432,8 @@ module Rbnotes
     end
 
     KEYWORDS = %w(
+      all
+      recent re
       today to yesterday ye
       this_week tw last_week lw
       this_month tm last_month lm

data/lib/rbnotes/version.rb

@@ -1,4 +1,4 @@
 module Rbnotes
-  VERSION = "0.4.18"
-  RELEASE = "2021-04-29"
+  VERSION = "0.4.20"
+  RELEASE = "2022-12-03"
 end

data/rbnotes.gemspec

@@ -25,6 +25,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "textrepo", "~> 0.5.8"
-  spec.add_dependency "unicode-display_width", "~> 1.7"
+  spec.add_dependency "textrepo", "~> 0.5.9"
+  spec.add_dependency "unicode-display_width", "~> 1.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbnotes
 version: !ruby/object:Gem::Version
-  version: 0.4.18
+  version: 0.4.20
 platform: ruby
 authors:
 - mnbi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-29 00:00:00.000000000 Z
+date: 2022-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: textrepo
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.8
+        version: 0.5.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.8
+        version: 0.5.9
 - !ruby/object:Gem::Dependency
   name: unicode-display_width
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.8'
 description: Rbnotes allows you to write a note into a single repository.
 email:
 - mnbi@users.noreply.github.com
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.11
 signing_key:
 specification_version: 4
 summary: A simple utility to write a note.