rbnotes 0.4.19 → 0.4.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b77835e83f5e0d1397d86e19cde13466b02cfb84d211d2521c7180f2e362861
-  data.tar.gz: 28821a8a8b53df64caf1c06baa83d61ffd63ae4a739199971e9d560111fc709f
+  metadata.gz: 29c624241fbfb8377565617bbb8313a225bcade6dbbad9bc22711b1edc44588e
+  data.tar.gz: d91950eeeba599c6807860ebfd0c9dbaab235441bced620c1441abc7dbd710e9
 SHA512:
-  metadata.gz: 1aad71bb657dd5c3fd9ec40b493fb3290df4e21a4b333bd8c7bb1cfe0368ae226eff1cee04615fc2f7a5cd7054593de20924d1722e88743d9faf686eb8959298
-  data.tar.gz: 3c4a1631efceb61c11f90cc3c97dcdeeb9a7b8dee3cc5cabb3b5071af9e97ce01296fefba830a346edfdf7fd28a3a6930793b1d09e185c3d0c2615bf73f18d32
+  metadata.gz: 992d4ac0aa2c1cef5413ecf6229569f9e080c38a439e548c7728b7e569f8e4e09521d3278041342edfa4e19a1bda2b2f90ce6597683da177cf25bff16baec04c
+  data.tar.gz: f9bc08bf6eab09f7183e9d0a8aeb4708ba660a99ceca3867d037f64f1602258aec01be11e2d71a35a78f2684d8f65074c356fe2a3caae2848f43020cb6d888d5

data/.github/workflows/main.yml

@@ -6,13 +6,11 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.0.0
+        ruby-version: 3.3
+        bundler-cache: true
     - name: Run the default task
-      run: |
-        gem install bundler -v 2.2.3
-        bundle install
-        bundle exec rake
+      run: bundle exec rake

data/.gitignore

@@ -1,3 +1,4 @@
+Gemfile.lock
 *.gem
 *.rbc
 /.config

data/CHANGELOG.md

@@ -5,7 +5,18 @@ 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)
+
+## [0.4.21] - 2022-11-03
+- Use ruby 3.3.5.
+- Remove the codefactor badge from `README.md`
+- Add copyright year (2024) to `LICENSE`.
+- Fix issue #135: incomplete timestamp patterns are acceptable.
+- 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

data/Gemfile

@@ -3,7 +3,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in rbnotes.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-gem "minitest", "~> 5.0"
+gem "rake", "~> 13.1"
+gem "minitest", "~> 5.20"
 
-gem 'textrepo', "~> 0.5.8"
+gem 'textrepo', "~> 0.5.10"

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020, 2021 mnbi
+Copyright (c) 2020, 2021, 2024 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/README.md

@@ -1,7 +1,6 @@
 # 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/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,7 @@ 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.
@@ -67,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|
@@ -146,9 +149,12 @@ KEYWORD:
     - "last_week"  (or "lw")
     - "this_month" (or "tm")
     - "last_month" (or "lm")
+    - "recent"     (or "re")
     - "all"
 
-The keyword, "all" specifies to enumerate all notes in the repository.
+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/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.19"
-  RELEASE = "2021-05-24"
+  VERSION = "0.4.21"
+  RELEASE = "2024-11-03"
 end

data/rbnotes.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.description   = %q{Rbnotes allows you to write a note into a single repository.}
   spec.homepage      = "https://github.com/mnbi/rbnotes"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.3.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/mnbi/rbnotes"
@@ -25,6 +25,8 @@ 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.10"
+  spec.add_dependency "unicode-display_width", "~> 2.6"
+
+  spec.add_development_dependency "bundler", "~> 2.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbnotes
 version: !ruby/object:Gem::Version
-  version: 0.4.19
+  version: 0.4.21
 platform: ruby
 authors:
 - mnbi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-23 00:00:00.000000000 Z
+date: 2024-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: textrepo
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.8
+        version: 0.5.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.8
+        version: 0.5.10
 - !ruby/object:Gem::Dependency
   name: unicode-display_width
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
 description: Rbnotes allows you to write a note into a single repository.
 email:
 - mnbi@users.noreply.github.com
@@ -50,7 +64,6 @@ files:
 - ".gitignore"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -99,14 +112,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
 summary: A simple utility to write a note.

data/Gemfile.lock

@@ -1,26 +0,0 @@
-PATH
-  remote: .
-  specs:
-    rbnotes (0.4.19)
-      textrepo (~> 0.5.8)
-      unicode-display_width (~> 1.7)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    minitest (5.14.4)
-    rake (13.0.3)
-    textrepo (0.5.8)
-    unicode-display_width (1.7.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  minitest (~> 5.0)
-  rake (~> 13.0)
-  rbnotes!
-  textrepo (~> 0.5.8)
-
-BUNDLED WITH
-   2.2.15