rbnotes 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3b44e20631a0216391b389aee7faca4ecebe31502bbff92606c938023a98240
-  data.tar.gz: 4a39041ad77631da13be01ebde0745edd38f22f52b5c9ad2ae1a002053739c1b
+  metadata.gz: 74c8725b48ee7e4048c6689227e519e27490e604463f84822211b0bad0bf8849
+  data.tar.gz: 71ef7e862a20d309c2c8fb29dc54ddacd42f6c3ab1f2eefd2e1dfb17e6ca8b2b
 SHA512:
-  metadata.gz: e98fabf28f56131caf2ec40c1111aa74a0819d923937cd033eeed6921c5ce43102657e8c3d787a8b9718b3057e7505921d2f7d316a327a041e80dcc2bce4b2ae
-  data.tar.gz: 672cd941dd68c545056c752a714bc29df9a9de5b14ce00b8c6568562df619e796c7cea77b376380bb3c32c06d680f834552c3c6367033bf2ab02b7460c4e1b0f
+  metadata.gz: b3310eae55fd1bc5e5b8a9b83a0ba5ae7f76e3d953a8a94f62fb7aabd9952ff03f868328e4b1e978b9c80a9c9b3563b676fc10eb776dbb47051bb1026fcad765
+  data.tar.gz: 36e328b4a3a6fe64f52c52f31050c46b372f91e2f768420b235c1ed811908634e80197aa7cf358cc87e434f57cba61fcbefa76a0aa61633e119d70f3502a9997

data/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 ## [Unreleased]
 Nothing to record here.
 
+## [0.2.2] - 2020-10-27
+###
+- Add feature to accept a timestamp pattern in `list` command. (#22)
+
 ## [0.2.1] - 2020-10-25
 ### Added
 - Add feature to load the configuration from an external file.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rbnotes (0.2.1)
+    rbnotes (0.2.2)
       textrepo (~> 0.4)
       unicode-display_width (~> 1.7)
 
@@ -10,7 +10,7 @@ GEM
   specs:
     minitest (5.14.2)
     rake (13.0.1)
-    textrepo (0.4.2)
+    textrepo (0.4.3)
     unicode-display_width (1.7.0)
 
 PLATFORMS

data/README.md

@@ -9,13 +9,17 @@ Rbnotes is a simple utility to write a note in the single repository.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'rbnotes, github: 'mnbi/rbnotes, branch: 'main'
+gem 'rbnotes'
 ```
 
 And then execute:
 
     $ bundle install
 
+Or install it yourself as:
+
+    $ gem install rbnotes
+
 ## Usage
 
 General syntax is:

data/lib/rbnotes/commands.rb

@@ -31,6 +31,8 @@ module Rbnotes
 usage: rbnotes [command] [args]
 
 command:
+    add             : create a new note
+    update STAMP    : edit the note with external editor
     import FILE     : import a FILE into the repository
     list NUM        : list NUM notes
     show STAMP      : show the note specified with STAMP

data/lib/rbnotes/commands/list.rb

@@ -2,42 +2,78 @@ require "unicode/display_width"
 require "io/console/size"
 
 module Rbnotes
+  ##
+  # Defines `list` command for `rbnotes`.  See the document of execute
+  # method to know about the behavior of this command.
+
   class Commands::List < Commands::Command
+
+    ##
+    # Shows the list of notes in the repository.  The only argument is
+    # optional.  If it passed, it must be an timestamp pattern.  A
+    # timestamp is an instance of Textrepo::Timestamp class.  A
+    # timestamp pattern is a string which would match several
+    # Timestamp objects.
+    #
+    # Here is
+    # several examples of timestamp patterns.
+    #
+    #   "20201027093600_012": a complete string to represent a timestamp
+    #   - this pattern would match exactly one Timestamp object
+    #
+    #   "20201027": specifies year and date
+    #   - all Timestamps those have the same year and date would match
+    #
+    #   "2020": specifies year only
+    #   - all Timestamps those have the same year would match
+    #
+    #   "1027": specifies date only
+    #   - all Timestamps those have the same date would match, even if
+    #     they have the different year.
+    #
+    # :call-seq:
+    #     execute(Array, Rbnotes::Conf or Hash) -> nil
+
     def execute(args, conf)
-      @row, @column = IO.console_size
-      max = (args.shift || @row - 3).to_i
+      pattern = args.shift      # `nil` is acceptable
 
       @repo = Textrepo.init(conf)
-      notes = @repo.entries.sort{|a, b| b <=> a}
-      notes[0, max].each { |timestamp_str|
-        puts make_headline(timestamp_str)
+      # newer stamp shoud be above
+      stamps = @repo.entries(pattern).sort{|a, b| b <=> a}
+      stamps.each { |timestamp|
+        puts make_headline(timestamp)
       }
     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)
+    #   |<------------------ 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_str)
 
+    def make_headline(timestamp)
+      _, column = IO.console_size
       delimiter = ": "
-      subject_width = @column - TIMESTAMP_STR_MAX_WIDTH - delimiter.size - 1
+      subject_width = column - TIMESTAMP_STR_MAX_WIDTH - delimiter.size - 1
 
-      subject = @repo.read(Textrepo::Timestamp.parse_s(timestamp_str))[0]
+      subject = @repo.read(timestamp)[0]
       prefix = '# '
       subject = prefix + subject.lstrip if subject[0, 2] != prefix
 
-      ts_part = "#{timestamp_str}    "[0..(TIMESTAMP_STR_MAX_WIDTH - 1)] 
+      ts_part = "#{timestamp.to_s}    "[0..(TIMESTAMP_STR_MAX_WIDTH - 1)] 
       sj_part = truncate_str(subject, subject_width)
 
       ts_part + delimiter + sj_part
@@ -53,5 +89,7 @@ module Rbnotes
       }
       result
     end
+
+    # :startdoc:
   end
 end

data/lib/rbnotes/version.rb

@@ -1,4 +1,4 @@
 module Rbnotes
-  VERSION = "0.2.1"
-  RELEASE = '2020-10-25'
+  VERSION = "0.2.2"
+  RELEASE = '2020-10-27'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbnotes
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - mnbi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-25 00:00:00.000000000 Z
+date: 2020-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: textrepo