rbnotes 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 906c366a81295b7d9a1c2e86ad2bd6f1d35f410ac7360f1e2067c0a0f8e4f48b
-  data.tar.gz: d2af84cbd9ddbb60fe6f21ddffb9c072ebe0b767e8c8ab6ae4cac0c1bca30acd
+  metadata.gz: 2cb54d2116edee3136979232f749434f0b4c068fa5162321bd02dfc96fcd8ece
+  data.tar.gz: 1d3d61b2cafa2d7a2825deb764ee232729e0a7bc8afa51868dbd98db2b7c016f
 SHA512:
-  metadata.gz: 5fa3929995ebda0b4970c18516dadc37b5ddeb99d2a33c39ce90ac9f8bb90556c7a406b995b3373e4bc559c56b57750f0a0796f53b3d25624d1a891d2da456d1
-  data.tar.gz: 99c4dd49875b4cf1f262cbd845bbccb6482449f0a1573ed188b50cd6814c1220cc7cea1032cc2b6bbaaeb2e05c4f21f8a241e8931ff8d44128e72f8457c1b113
+  metadata.gz: 07a40884e1f0a73bc4b3d70104d98d56814084ce643b86715cf739ece89124da45236cccc4ba881f78e176b8ee318eceaa5974811e4f990d81dce17a018b8a74
+  data.tar.gz: fd70d8ed8d461610cf0f60fe506588414abbd2f9a6fe9deabe8de49ca7a3146d49efcb799b25bb4f66158afc4298643993f1d2a3a7e21d095efe2e7462d8792f

data/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 ## [Unreleased]
 Nothing to record here.
 
+## [0.3.1] - 2020-10-30
+### Added
+- Add feature to specify configuration file in the command line. (#21)
+
 ## [0.3.0] - 2020-10-29
 ### Added
 - Add feature to read argument from the standard input. (#27)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rbnotes (0.3.0)
+    rbnotes (0.3.1)
       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.4)
+    textrepo (0.4.5)
     unicode-display_width (1.7.0)
 
 PLATFORMS

data/README.md

@@ -28,6 +28,11 @@ General syntax is:
 rbnotes [global_opts] [command] [command_opts] [args]
 ```
 
+### Global options
+
+- "-c CONF_FILE", "--conf"
+  - specifies a configuration file
+
 ### Commands
 
 - import
@@ -57,6 +62,8 @@ Searches the configuration file in the following order:
 
 None of them is found, then the default configuration is used.
 
+The global option "-c CONF_FILE" will override the location.
+
 #### Content
 
 The format of the configuration file must be written in YAML.
@@ -75,14 +82,16 @@ A real example:
 
 ``` yaml
 ---
-:run_mode: :development
+:run_mode: :production
 :repository_type: :file_system
 :repository_name: "notes"
 :repository_base: "~"
-:pager: "bat"
+:pager: "bat -l md"
 :editor: "/usr/local/bin/emacsclient"
 ```
 
+The content is identical to `conf/config.yml`.
+
 #### Variables
 
 ##### :run-mode (mandatory)
@@ -124,8 +133,13 @@ the `:repository_name` value.  It would be:
 
 > :repository_base/:repository_name
 
-The value must be an absolute path.  The short-hand notation of the
-home directory ("~") is usable.
+The value is recommended to be an absolute path in the production
+time, since relative path will be expanded with the current working
+directory.  However, in the development and testing time, the relative
+path may be useful.  See `conf/config_deve.yml` or
+`conf/config_test.yml`.
+
+The short-hand notation of the home directory ("~") is usable.
 
 ##### Miscellaneous variables (optional)
 

data/conf/config.yml

@@ -0,0 +1,7 @@
+---
+:run_mode: :production
+:repository_type: :file_system
+:repository_name: "notes"
+:repository_base: "~"
+:pager: "bat -l md"
+:editor: "/usr/local/bin/emacsclient"

data/conf/config_deve.yml

@@ -0,0 +1,7 @@
+---
+:run_mode: :development
+:repository_type: :file_system
+:repository_name: "notes"
+:repository_base: "tmp"
+:pager: "bat -l md"
+:editor: "/usr/local/bin/emacsclient"

data/conf/config_test.yml

@@ -0,0 +1,5 @@
+---
+:run_mode: :test
+:repository_type: :file_system
+:repository_name: "notes"
+:repository_base: "test/sandbox"

data/exe/rbnotes

@@ -7,17 +7,45 @@ include Rbnotes
 DEBUG = true
 
 class App
+  def initialize
+    @gopts = {}
+  end
+
+  def options
+    @gopts
+  end
+
+  def parse_global_options(args)
+    while args.size > 0
+      arg = args.shift
+      case arg
+      when "-c", "--conf"
+        file = args.shift
+        raise ArgumentError, args.unshift(arg) if file.nil?
+        file = File.expand_path(file)
+        raise ArgumentError, "no such file: %s" % file unless FileTest.exist?(file) 
+        @gopts[:conf_file] = file
+      else
+        args.unshift(arg)
+        break
+      end
+    end
+  end
+
   def run(args)
     cmd = args.shift
-    Commands.load(cmd).execute(args, Rbnotes.conf)
+    Commands.load(cmd).execute(args, Rbnotes.conf(@gopts[:conf_file]))
   end
 end
 
 app = App.new
 begin
+  app.parse_global_options(ARGV)
   app.run(ARGV)
 rescue MissingArgumentError, MissingTimestampError,
-       InvalidTimestampStringError, NoEditorError, ProgramAbortError => e
+       NoEditorError, ProgramAbortError,
+       Textrepo::InvalidTimestampStringError,
+       ArgumentError => e
   puts e.message
   exit 1
 end

data/lib/rbnotes/commands.rb

@@ -2,16 +2,20 @@ module Rbnotes
   ##
   # This module defines all command classes of rbnotes.  Each command
   # class must be derived from Rbnotes::Commands::Command class.
+
   module Commands
     ##
     # The base class for a command class.
+
     class Command
+
       ##
       # :call-seq:
-      #   Array, Hash -> nil
+      #   execute(Array, Hash) -> nil
+      #
       #   - Array: arguments for each command
       #   - Hash : rbnotes configuration
-      #
+
       def execute(args, conf)
         Builtins::DEFAULT_CMD.new.execute(args, conf)
       end
@@ -28,22 +32,38 @@ module Rbnotes
       class Help < Command
         def execute(_, _)
           puts <<USAGE
-usage: rbnotes [command] [args]
+usage: rbnotes [-c|--conf CONF_FILE] [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
-    delete STAMP    : delete the note specified with STAMP
-
-    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
-    version         : print version
-    help            : show help
+    add            : create a new note
+    import FILE    : import a FILE into the repository
+
+    list PATTERN   : list notes those timestamp matches PATTERN
+
+    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"
+
+    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".
+
+    show/update/delete reads its argument from the standard input when
+    no argument was passed in the command line.
+
+    version        : print version
+    help           : show help
+
+commands for development purpose:
+    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
 USAGE
         end
       end
@@ -64,9 +84,9 @@ USAGE
 
           puts case type
                when :file_system
-                 "#{base}/#{name}"
+                 File.expand_path(name, base)
                else
-                 "#{base}/#{name}"
+                 File.join(base, name)
                end
         end
       end
@@ -113,15 +133,16 @@ USAGE
     # :startdoc:
 
     class << self
+
       ##
       # Loads a class to perfom the command, then returns an instance
       # of the class.
       #
       # :call-seq:
-      #   "import" -> an object of Rbnotes::Commnads::Import
-      #   "list"   -> an object of Rbnotes::Commands::List
-      #   "show"   -> an object of Rbnotes::Commands::Show
-      #
+      #   load("import") -> Rbnotes::Commnads::Import
+      #   load("list")   -> Rbnotes::Commands::List
+      #   load("show")   -> Rbnotes::Commands::Show
+
       def load(cmd_name)
         cmd_name ||= DEFAULT_CMD_NAME
         klass_name =  cmd_name.capitalize

data/lib/rbnotes/error.rb

@@ -9,7 +9,6 @@ module Rbnotes
   module ErrMsg
     MISSING_ARGUMENT  = "missing argument: %s"
     MISSING_TIMESTAMP = "missing timestamp: %s"
-    INVALID_TIMESTAMP_STRING = "invalid string as timestamp: %s"
     NO_EDITOR         = "No editor is available: %s"
     PROGRAM_ABORT     = "External program was aborted: %s"
   end
@@ -35,16 +34,6 @@ module Rbnotes
     end
   end
 
-  ##
-  # An error raised if an argument is invalid to convert a
-  # Textrepo::Timestamp object.
-
-  class InvalidTimestampStringError < Error
-    def initialize(str)
-      super(ErrMsg::INVALID_TIMESTAMP_STRING % str)
-    end
-  end
-
   ##
   # An error raised if no external editor is available to edit a note,
   # even "nano" or "vi".

data/lib/rbnotes/utils.rb

@@ -96,11 +96,7 @@ module Rbnotes
 
     def read_timestamp(args)
       str = args.shift || read_arg($stdin)
-      begin
-        Textrepo::Timestamp.parse_s(str)
-      rescue ArgumentError => _
-        raise InvalidTimestampStringError, str
-      end
+      Textrepo::Timestamp.parse_s(str)
     end
     module_function :read_timestamp
 

data/lib/rbnotes/version.rb

@@ -1,4 +1,4 @@
 module Rbnotes
-  VERSION = "0.3.0"
-  RELEASE = '2020-10-29'
+  VERSION = "0.3.1"
+  RELEASE = '2020-10-30'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbnotes
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - mnbi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-29 00:00:00.000000000 Z
+date: 2020-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: textrepo
@@ -56,6 +56,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- conf/config.yml
+- conf/config_deve.yml
+- conf/config_test.yml
 - exe/rbnotes
 - lib/rbnotes.rb
 - lib/rbnotes/commands.rb