rbnotes 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87313e606a2e62b90b3e1c3f00ff46300f0e7a14e3b2fc8ffcad0abfda217646
-  data.tar.gz: 95b8a57ca200b8a8460f61edfe0d796dcfec2f63cba4ec024294915f07752aa8
+  metadata.gz: '09f402dd55c244533d8f8ba3518df3d13cde1c5952efad94598f210a43a88c11'
+  data.tar.gz: a824e8e2e33c1c1e67d2ff27ab22618d83aa7138a889db20d43f40491f6e1c82
 SHA512:
-  metadata.gz: 238f9140497e09ee4aedc331716c5725e61e00332255160d70844099e7f5d3f072f00edc3800e063f1f09e9e9c67669ca901c60c16c88a37e4594c07c9744238
-  data.tar.gz: de00ee60c187517ec47f4601c572abc83f99dc3f4cde96c4db86e8cdda012eda5bdd5b1529fdf086f7f1858637720752bba8fa244d3e21f63d25456c56b7c71e
+  metadata.gz: e52be521f1d1502ca2d36fd6853203436e15c3f830e17ff509529b0b7f08a2fad26a264714d81732603e6f6dabe69c2d40bebdb400b306f4fba1218c86c2ac52
+  data.tar.gz: c555b3b74717d45d18a6d63959356ff411457b2f3b47819ca53ecca38fc6de03a9e5d5839e622e5b65d3513c40dfe487b2649206697d075400c1121a61ea99d4

data/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 ## [Unreleased]
 Nothing to record here.
 
+## [0.4.1] - 2020-11-04
+### Added
+- Add a feature to accept a timestamp in `add` command. (#34)
+
 ## [0.4.0] - 2020-11-03
 ### Added
 - Add a new command `search` to perform full text search. (#33)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rbnotes (0.4.0)
+    rbnotes (0.4.1)
       textrepo (~> 0.5)
       unicode-display_width (~> 1.7)
 

data/README.md

@@ -4,6 +4,9 @@
 
 Rbnotes is a simple utility to write a note in the single repository.
 
+This document provides the basic information to use rbnotes.
+You may find more useful information in [Wiki pages](https://github.com/mnbi/rbnotes/wiki).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -39,6 +42,8 @@ rbnotes [global_opts] [command] [command_opts] [args]
   - imports existing files
 - list
   - lists notes in the repository with their timestamps and subject
+- search
+  - search a word (or words) in the repository
 - show
   - shows the content of a note
 - add
@@ -145,6 +150,38 @@ The short-hand notation of the home directory ("~") is usable.
 
 - :pager : specify a pager program
 - :editor : specify a editor program
+- :searcher: specify a program to perform search
+- :searcher_options: specify options to pass to the searcher program
+
+Be careful to set `:searcher` and `:searcher_options`. The searcher
+program must be expected to behave equivalent to `grep` with `-inRE`.
+At least, its output must be the same format and it must runs
+recursively to a directory.
+
+If your favorite searcher is one of the followings, see the default
+options which `textrepo` sets for those searchers.  In most cases, you
+don't have to set `:searcher_options` for them.
+
+| searcher | default options in `textrepo`                      |
+|:---------|:---------------------------------------------------|
+| `grep`   | `["-i", "-n", "-R", "-E"]`                         |
+| `egrep`  | `["-i", "-n", "-R"]`                               |
+| `ggrep`  | `["-i", "-n", "-R", "-E"]`                         |
+| `gegrep` | `["-i", "-n", "-R"]`                               |
+| `rg`     | `["-S", "-n", "--no-heading", "--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
+
+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
+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"]`.
 
 ##### Default values for mandatory variables
 

data/lib/rbnotes/commands.rb

@@ -32,23 +32,36 @@ module Rbnotes
       class Help < Command
         def execute(_, _)
           puts <<USAGE
-usage: rbnotes [-c|--conf CONF_FILE] [command] [args]
+usage:
+    rbnotes [-c|--conf CONF_FILE] [command] [args]
+
+option:
+    -c, --conf [CONF_FILE] : specifiy the configuration file
+
+    CONF_FILE must be written in YAML.  To know about details of the
+    configuration file, see README.md or Wiki page.
 
 command:
     add            : create a new note
     import FILE    : import a FILE into the repository
 
-    list PATTERN   : list notes those timestamp matches PATTERN
+    list [STAMP_PATTERN] : list notes those timestamp matches PATTERN
+    search PATTERN [STAMP_PATTERN] : search PATTERN
+
+    STAMP_PATTERN must be:
 
-    PATTERN must be:
         (a) full qualified timestamp (with suffix): "20201030160200"
         (b) year and date part: "20201030"
-        (c) year part only: "2020"
-        (d) date part only: "1030"
+        (c) year and month part: "202010"
+        (d) year part only: "2020"
+        (e) date part only: "1030"
 
-    show STAMP     : show the note specified with STAMP
-    update STAMP   : edit the note with external editor
-    delete STAMP   : delete the note specified with STAMP
+    PATTERN is a word (or words) to search, it may also be a regular
+    expression.
+
+    show   [STAMP] : show the note specified with STAMP
+    update [STAMP] : edit the note with external editor
+    delete [STAMP] : delete the note specified with STAMP
 
     STAMP must be a sequence of digits to represent year, date and
     time (and suffix), such "20201030160200" or "20201030160200_012".
@@ -59,11 +72,15 @@ command:
     version        : print version
     help           : show help
 
-commands for development purpose:
+command for development:
     conf           : print the current configuraitons
     repo           : print the repository path
     stamp TIME_STR : convert TIME_STR into a timestamp
     time  STAMP    : convert STAMP into a time string
+
+For more information, see Wiki page.
+    - https://github.com/mnbi/rbnotes/wiki
+
 USAGE
         end
       end

data/lib/rbnotes/commands/add.rb

@@ -1,9 +1,20 @@
 module Rbnotes::Commands
+
   ##
-  # Adds a new note to the repository.  A new timestamp is generated
-  # at the execution time, then it is attached to the note.  If the
-  # timestamp has already existed in the repository, the command
-  # fails.
+  # 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
+  # note.  If the timestamp has already existed in the repository, the
+  # command fails.
+  #
+  # Accepts an option with `-t STAMP_PATTERN` (or `--timestamp`), a
+  # timestamp is generated according to `STAMP_PATTERN`.
+  #
+  # STAMP_PATTERN could be one of followings:
+  #
+  #   "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)
   #
   # This command starts the external editor program to prepare text to
   # store.  The editor program will be searched in the following order:
@@ -14,23 +25,37 @@ module Rbnotes::Commands
   # 4. "vi"
   #
   # If none of the above editor is available, the command fails.
-  #
+
   class Add < Command
     include ::Rbnotes::Utils
 
     def execute(args, conf)
-      newstamp = Textrepo::Timestamp.new(Time.now)
+      @opts = {}
+      while args.size > 0
+        arg = args.shift
+        case arg
+        when "-t", "--timestamp"
+          stamp_str = args.shift
+          raise ArgumentError, "missing timestamp: %s" % args.unshift(arg) if stamp_str.nil?
+          stamp_str = complement_timestamp_pattern(stamp_str)
+          @opts[:timestamp] = Textrepo::Timestamp.parse_s(stamp_str)
+        else
+          args.unshift(arg)
+        end
+      end
+
+      stamp = @opts[:timestamp] || Textrepo::Timestamp.new(Time.now)
 
       candidates = [conf[:editor], ENV["EDITOR"], "nano", "vi"].compact
       editor = find_program(candidates)
       raise Rbnotes::NoEditorError, candidates if editor.nil?
 
-      tmpfile = run_with_tmpfile(editor, newstamp.to_s)
+      tmpfile = run_with_tmpfile(editor, stamp.to_s)
       text = File.readlines(tmpfile)
 
       repo = Textrepo.init(conf)
       begin
-        repo.create(newstamp, text)
+        repo.create(stamp, text)
       rescue Textrepo::DuplicateTimestampError => e
         puts e.message
         puts "Just wait a second, then retry."
@@ -39,11 +64,28 @@ module Rbnotes::Commands
       rescue StandardError => e
         puts e.message
       else
-        puts "Add a note [%s]" % newstamp.to_s
+        puts "Add a note [%s]" % stamp.to_s
       ensure
         # Don't forget to remove the temporary file.
         File.delete(tmpfile)
       end
     end
+
+    # :stopdoc:
+    private
+    def complement_timestamp_pattern(pattern)
+      stamp_str = nil
+      case pattern.to_s.size
+      when "yyyymoddhhmiss_lll".size, "yyyymoddhhmiss".size
+        stamp_str = pattern.dup
+      when "yyyymoddhhmi".size  # omit sec part
+        stamp_str = "#{pattern}00"
+      when "moddhhmi".size      # omit year and sec part
+        stamp_str = "#{Time.now.year}#{pattern}00"
+      else
+        raise Textrepo::InvalidTimestampStringError, pattern
+      end
+      stamp_str
+    end
   end
 end

data/lib/rbnotes/commands/search.rb

@@ -1,29 +1,27 @@
-# :markup: markdown
-
-##
-# Searches a given pattern in notes those have timestamps match a
-# given timestamp pattern.  The first argument is a pattern to search.
-# It is a String object represents a portion of text or it may a
-# String represents a regular expression.  The second argument is
-# optional and it is a timestamp pattern to specify the search target.
-#
-# A pattern for search is mandatory.  If no pattern, raises
-# Rbnotes::MissingArgumentError.
-#
-# Example of PATTERN:
-#     ""rbnotes" (a word)
-#     "macOS Big Sur" (a few words)
-#     "2[0-9]{3}(0[1-9]|1[0-2])(0[1-9]|[12][0-9]|3[01])" (a regular expression)
-#
-# A timestamp pattern is optional.  If no timestamp pattern, all notes
-# in the repository would be target of search.
-#
-# See the document of `Rbnotes::Commands::List#execute` to know about
-# a timestamp pattern.
+module Rbnotes
 
-# :stopdoc: 
+  ##
+  # Searches a given pattern in notes those have timestamps match a
+  # given timestamp pattern.  The first argument is a pattern to search.
+  # It is a String object represents a portion of text or it may a
+  # String represents a regular expression.  The second argument is
+  # optional and it is a timestamp pattern to specify the search target.
+  #
+  # A pattern for search is mandatory.  If no pattern, raises
+  # Rbnotes::MissingArgumentError.
+  #
+  # Example of PATTERN for search:
+  #
+  #   "rbnotes" (a word)
+  #   "macOS Big Sur" (a few words)
+  #   "2[0-9]{3}(0[1-9]|1[0-2])(0[1-9]|[12][0-9]|3[01])" (a regular expression)
+  #
+  # A timestamp pattern is optional.  If no timestamp pattern, all notes
+  # in the repository would be target of search.
+  #
+  # See the document of `Rbnotes::Commands::List#execute` to know about
+  # a timestamp pattern.
 
-module Rbnotes
   class Commands::Search < Commands::Command
     def execute(args, conf)
       pattern = args.shift

data/lib/rbnotes/version.rb

@@ -1,4 +1,4 @@
 module Rbnotes
-  VERSION = "0.4.0"
-  RELEASE = "2020-11-03"
+  VERSION = "0.4.1"
+  RELEASE = "2020-11-04"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbnotes
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - mnbi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-03 00:00:00.000000000 Z
+date: 2020-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: textrepo