rbnotes 0.4.17 → 0.4.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65aec23d03fa8672d8aada42a39d6d0f97643ca3481050926ae11aa2a05dc433
-  data.tar.gz: c28a9209d1374f351a87e0a0a696312bdc37f70b2d55c97e5e2920703c83643b
+  metadata.gz: 8a831d67abfd0bae05156f047b6baf44428bc4940058e43bfb9825b5d91c4177
+  data.tar.gz: 7fb70e39e9feb75edfabe3461697ddfb0145cf449205c25068471687952908d0
 SHA512:
-  metadata.gz: 285b05aee90d97dcf11fca4d753e2265ae11253d504e9a787b34f4d64a74e47486cd6a127d652f6f746b934f90c6c699342ea8621b13ef06da2816ef3f91eb98
-  data.tar.gz: 581f9192f023a4a50f43ea475b72aa5a145c054520c6b25f9a59c2f758f980c81259df788c34c47c08b7a901b55f6f77ae60e39de0e5e230727d990fcd9f54d3
+  metadata.gz: 7ea3b1ea6517130e5ba5ece651da8f3e30f1013aaa40aa375ad16fb09a7e07a033c7da4e59a721fade178ed4720cf804cb60cc843ea42cbcb177fdf81f947f01
+  data.tar.gz: 6a19760bdecd4b967717c30bed0974a8098d5b3f9e9df9a90bd81cd6b1498a6ba226f2e5654547f1ec67da9beb3d54c740ab9895163d8488df9801b74539f8aa

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.
+- (nothing to record here)
+
+## [0.4.18] - 2021-04-29
+### Added
+- Use ERB to generate the initial content of a new note from the
+  template file (`add`) (#125)
+
+### Fixed
+- Add info about template feature of `add`: (#124)
+  - update help text of `add`,
+  - update `README.md`.
+- Add description about `ugrep` to `README.md`. (#122)
+- Fix issue #118: help text of `list` is wrong.
+- Fix issue #119: a test for `Rbnotes::Utils` may fails.
+  - fix the test.
 
 ## [0.4.17] - 2021-04-21
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rbnotes (0.4.17)
+    rbnotes (0.4.18)
       textrepo (~> 0.5.8)
       unicode-display_width (~> 1.7)
 

data/README.md

@@ -149,6 +149,7 @@ The short-hand notation of the home directory ("~") is usable.
 
 ##### Miscellaneous variables (optional)
 
+- :template : specify a template file for `add` command
 - :pager : specify a pager program
 - :editor : specify a editor program
 - :searcher: specify a program to perform search
@@ -170,13 +171,15 @@ don't have to set `:searcher_options` for them.
 | `ggrep`  | `["-i", "-n", "-H", "-R", "-E"]`                   |
 | `gegrep` | `["-i", "-n", "-H", "-R"]`                         |
 | `rg`     | `["-S", "-n", "--no-heading", "--color", "never"]` |
+| `ugrep`  | `["-i", "-n", "-H", "-R", "--color=never"]`        |
 
 Those searcher names are used in macOS (with Homebrew).  Any other OS
 might use different names.
 
 - `grep` and `egrep` -> BSD grep (macOS default)
-- `ggrep` and `gegrep` -> GNU grep
-- `rg` -> ripgrep
+- `ggrep` and `gegrep` -> [GNU grep](https://www.gnu.org/software/grep/)
+- `rg` -> [BurntSushi/ripgrep](https://github.com/BurntSushi/ripgrep)
+- `ugrep` -> [Genivia/ugrep](https://github.com/Genivia/ugrep)
 
 If the name is different, `:searcher_options` should be set with the
 same value.  For example, if you system use the name `gnugrep` as GNU
@@ -184,6 +187,48 @@ grep, and you want to use it as the searcher (that is, set `gnugrep`
 to `:searcher`), you should set `:searcher_options` value with `["-i",
 "-n", "-R", "-E"]`.
 
+##### Template file for `add` command
+
+`Add` command always searches a template file in the default
+directory.  The default directory is,
+
+- `$XDG_CONIFG_HOME/rbnotes/templates` (if `$XDG_CONFIG_HOME` is defined)
+
+or
+
+- `$HOME/.config/rbnotes/templates`
+
+If a file which named as `default.md` is found in the above directory,
+it will use as a template file to generate the initial content of a
+new note.
+
+When a command line option or a setting of the configuration file is
+specified to use a template file, `add` command will read it instead
+of the default template file.
+
+Command line option of `add` to specify a template file is:
+
+``` shell
+> rbntoes add -f /somewhere/template.md
+```
+
+See the above section about the configuration file setting to specify
+a template file.
+
+Though a template file can be written any format of text (markdown,
+HTML, plain text, or ...), `add` command will process the content
+using ERB.  So, using ERB syntax, you can mix Ruby code in a template
+file.
+
+Here is a very simple and short example to use ERB syntax:
+
+``` markdown
+## <%= Time.now.strftime("%Y-%m-%d") %>
+```
+
+It just insert a date string like "2021-04-29" at the top of a new
+note which generates by `add` command.
+
 ##### Default values for mandatory variables
 
 All mandatory variables have their default values.  Here is the list

data/lib/rbnotes/commands/add.rb

@@ -1,5 +1,7 @@
 module Rbnotes::Commands
 
+  require "erb"
+
   ##
   # Adds a new note to the repository.  If no options, a new timestamp
   # is generated at the execution time, then it is attached to the
@@ -16,15 +18,39 @@ module Rbnotes::Commands
   #   "202011041722"       : year, date and time (omit second part)
   #   "11041722"           : date and time (omit year and second part)
   #
+  # Also accepts an option with `-f FILENAME` (or `--template-file`)
+  # to specify a template file which will be the initial content of a
+  # new note.
+  #
   # This command starts the external editor program to prepare text to
   # store.  The editor program will be searched in the following order:
   #
-  # 1. conf[:editor] (conf is the 1st arg of execute method)
-  # 2. ENV["EDITOR"]
-  # 3. "nano"
-  # 4. "vi"
+  #   1. conf[:editor] (conf is the 1st arg of execute method)
+  #   2. ENV["EDITOR"]
+  #   3. "nano"
+  #   4. "vi"
   #
   # If none of the above editor is available, the command fails.
+  #
+  # TEMPLATE FILE:
+  #
+  # This command search a file as its template which will be the initial
+  # conent of a new note when an option or a setting in the configuration
+  # file (`:template`) is specified a template file.
+  #
+  # Or, even if neither an option nor a setting about a template file is
+  # specified, it always searches the default directory to read a template
+  # file.  The directory is:
+  #
+  #   - $XDG_CONIFG_HOME/rbnotes/templates (if $XDG_CONFIG_HOME is defined)
+  # or
+  #   - $HOME/.config/rbnotes/templates
+  #
+  # If a file, `default.md` exists in the above directory, it will used as
+  # a template.
+  #
+  # A template file can be written in ERB syntax.  See ERB manual to know
+  # about how to mix ruby code and text content in ERB syntax.
 
   class Add < Command
 
@@ -78,16 +104,26 @@ usage:
 Add a new note to the repository.  If no options, a new timestamp is
 generated at the execution time, then it is attached to the note.
 
+OPTIONS:
+    -t, --timestamp STAMP_PATTERN
+    -f, --template-file FILENAME
+
 Accept an option with `-t STAMP_PATTERN` (or `--timestamp`), a
-timestamp is generated according to `STAMP_PATTERN`.
+timestamp of a new note is generated according to `STAMP_PATTERN`.
 
-STAMP_PATTERN could be one of followings:
+Also accepts an option with `-f FILENAME` (or `--template-file`) to
+specify a template file which will be the initial content of a new
+note.  See below section more about a template file.
+
+STAMP_PATTERN could be:
 
     "20201104172230_078" : full qualified timestamp string
     "20201104172230"     : full qualified timestamp string (no suffix)
     "202011041722"       : year, date and time (omit second part)
     "11041722"           : date and time (omit year and second part)
 
+EDITOR:
+
 This command starts the external editor program to prepare text to
 store.  The editor program will be searched in the following order:
 
@@ -97,6 +133,29 @@ store.  The editor program will be searched in the following order:
     4. "vi"
 
 If none of the above editor is available, the execution fails.
+
+TEMPLATE FILE:
+
+This command search a file as its template which will be the initial
+conent of a new note when an option or a setting in the configuration
+file (`:template`) is specified a template file.
+
+Or, even if neither an option nor a setting about a template file is
+specified, it always searches the default directory to read a template
+file.  The directory is:
+
+- $XDG_CONIFG_HOME/rbnotes/templates (if $XDG_CONFIG_HOME is defined)
+
+or
+
+- $HOME/.config/rbnotes/templates
+
+If a file, `default.md` exists in the above directory, it will used as
+a template.
+
+A template file can be written in ERB syntax.  See ERB manual to know
+about how to mix ruby code and text content in ERB syntax.
+
 HELP
     end
 
@@ -144,10 +203,15 @@ HELP
 
       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)
+        return nil unless FileTest.exist?(template_path)
+      end
+
+      erb_source = File.read(template_path)
+      if erb_source and !erb_source.empty?
+        erb = ERB.new(erb_source)
+        template = erb.result.split("\n")
       end
 
       template

data/lib/rbnotes/commands/list.rb

@@ -92,11 +92,16 @@ module Rbnotes::Commands
 usage:
     #{Rbnotes::NAME} list [OPTIONS] [STAMP_PATTERN|KEYWORD]
 
-Show a list of notes.  When no arguments, make a list with all notes
-in the repository.  When specified STAMP_PATTERN, only those match the
-pattern are listed.  Instead of STAMP_PATTERN, some KEYWORDs could be
+Show a list of notes.  When specified several STAMP_PATTERNs, only
+those match the pattern are listed.  Also, some KEYWORDs could be
 used.
 
+When no STAMP_PATTERN or KEYWORD was specified, the behavior of this
+command could be specified with a configuration setting,
+":list_default:".  The value must be one of valid keywords.  If no
+settings was also given, this command would behave like "today" was
+specified as the setting.
+
 OPTIONS:
     -v, --verbose
     -w, --week
@@ -130,12 +135,6 @@ like as follows:
       20210418125353: Hoge
           :
 
-When no STAMP_PATTERN or KEYWORD was specified, the behavior of this
-command could be specified with a configuration setting,
-":list_default:".  The value must be one of valid keywords.  If no
-settings was also given, this command would behave like "today" was
-specified as the setting.
-
 An option "--week" is also acceptable.  It specifies to enumerate all
 days of a week.  Typically, the option is used with a STAMP_PATTERN
 which specifies a date, such "20201117", then it enumerates all days

data/lib/rbnotes/version.rb

@@ -1,4 +1,4 @@
 module Rbnotes
-  VERSION = "0.4.17"
-  RELEASE = "2021-04-21"
+  VERSION = "0.4.18"
+  RELEASE = "2021-04-29"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbnotes
 version: !ruby/object:Gem::Version
-  version: 0.4.17
+  version: 0.4.18
 platform: ruby
 authors:
 - mnbi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-20 00:00:00.000000000 Z
+date: 2021-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: textrepo