rbnotes 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74c8725b48ee7e4048c6689227e519e27490e604463f84822211b0bad0bf8849
-  data.tar.gz: 71ef7e862a20d309c2c8fb29dc54ddacd42f6c3ab1f2eefd2e1dfb17e6ca8b2b
+  metadata.gz: 906c366a81295b7d9a1c2e86ad2bd6f1d35f410ac7360f1e2067c0a0f8e4f48b
+  data.tar.gz: d2af84cbd9ddbb60fe6f21ddffb9c072ebe0b767e8c8ab6ae4cac0c1bca30acd
 SHA512:
-  metadata.gz: b3310eae55fd1bc5e5b8a9b83a0ba5ae7f76e3d953a8a94f62fb7aabd9952ff03f868328e4b1e978b9c80a9c9b3563b676fc10eb776dbb47051bb1026fcad765
-  data.tar.gz: 36e328b4a3a6fe64f52c52f31050c46b372f91e2f768420b235c1ed811908634e80197aa7cf358cc87e434f57cba61fcbefa76a0aa61633e119d70f3502a9997
+  metadata.gz: 5fa3929995ebda0b4970c18516dadc37b5ddeb99d2a33c39ce90ac9f8bb90556c7a406b995b3373e4bc559c56b57750f0a0796f53b3d25624d1a891d2da456d1
+  data.tar.gz: 99c4dd49875b4cf1f262cbd845bbccb6482449f0a1573ed188b50cd6814c1220cc7cea1032cc2b6bbaaeb2e05c4f21f8a241e8931ff8d44128e72f8457c1b113

data/CHANGELOG.md

@@ -7,8 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 ## [Unreleased]
 Nothing to record here.
 
+## [0.3.0] - 2020-10-29
+### Added
+- Add feature to read argument from the standard input. (#27)
+
 ## [0.2.2] - 2020-10-27
-###
+### Added
 - Add feature to accept a timestamp pattern in `list` command. (#22)
 
 ## [0.2.1] - 2020-10-25

data/Gemfile.lock

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

data/exe/rbnotes

@@ -17,7 +17,7 @@ app = App.new
 begin
   app.run(ARGV)
 rescue MissingArgumentError, MissingTimestampError,
-       NoEditorError, ProgramAbortError => e
+       InvalidTimestampStringError, NoEditorError, ProgramAbortError => e
   puts e.message
   exit 1
 end

data/lib/rbnotes/commands/delete.rb

@@ -14,21 +14,17 @@
 module Rbnotes
   class Commands::Delete < Commands::Command
     def execute(args, conf)
-      stamp_str = args.shift
-      unless stamp_str.nil?
-        repo = Textrepo.init(conf)
-        begin
-          stamp = Textrepo::Timestamp.parse_s(stamp_str)
-          repo.delete(stamp)
-        rescue Textrepo::MissingTimestampError => e
-          puts e.message
-        rescue StandardError => e
-          puts e.message
-        else
-          puts "Delete [%s]" % stamp.to_s
-        end
+      stamp = Rbnotes::Utils.read_timestamp(args)
+
+      repo = Textrepo.init(conf)
+      begin
+        repo.delete(stamp)
+      rescue Textrepo::MissingTimestampError => e
+        puts e.message
+      rescue StandardError => e
+        puts e.message
       else
-        super
+        puts "Delete [%s]" % stamp.to_s
       end
     end
   end

data/lib/rbnotes/commands/import.rb

@@ -29,7 +29,7 @@ module Rbnotes
               puts "The note [%s] in the repository exactly matches" \
                    " the specified file." % stamp
               puts "It seems there is no need to import the file [%s]." % file
-              exit              # normal end
+              break
             else
               puts "The text in the repository does not match the" \
                    " specified file."
@@ -40,8 +40,8 @@ module Rbnotes
             end
           rescue Textrepo::EmptyTextError => _
             puts "... aborted."
-            puts "The specified file is empyt."
-            exit 1              # error
+            puts "The specified file is empty."
+            break
           end
         end
         if count > 999

data/lib/rbnotes/commands/list.rb

@@ -54,11 +54,11 @@ module Rbnotes
     # 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]
+    #   |<------------------ 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)
     #
@@ -69,9 +69,7 @@ module Rbnotes
       delimiter = ": "
       subject_width = column - TIMESTAMP_STR_MAX_WIDTH - delimiter.size - 1
 
-      subject = @repo.read(timestamp)[0]
-      prefix = '# '
-      subject = prefix + subject.lstrip if subject[0, 2] != prefix
+      subject = remove_heading_markup(@repo.read(timestamp)[0])
 
       ts_part = "#{timestamp.to_s}    "[0..(TIMESTAMP_STR_MAX_WIDTH - 1)] 
       sj_part = truncate_str(subject, subject_width)
@@ -90,6 +88,10 @@ module Rbnotes
       result
     end
 
+    def remove_heading_markup(str)
+      str.sub(/^#+ +/, '')
+    end
+
     # :startdoc:
   end
 end

data/lib/rbnotes/commands/show.rb

@@ -1,24 +1,20 @@
 module Rbnotes
   class Commands::Show < Commands::Command
     def execute(args, conf)
-      stamp_str = args.shift
-      unless stamp_str.nil?
-        repo = Textrepo.init(conf)
-        stamp = Textrepo::Timestamp.parse_s(stamp_str)
-        content = repo.read(stamp)
+      stamp = Rbnotes::Utils.read_timestamp(args)
 
-        pager = conf[:pager]
-        unless pager.nil?
-          require 'open3'
-          Open3.pipeline_w(pager) { |stdin|
-            stdin.puts content
-            stdin.close
-          }
-        else
-          puts content
-        end
+      repo = Textrepo.init(conf)
+      content = repo.read(stamp)
+
+      pager = conf[:pager]
+      unless pager.nil?
+        require 'open3'
+        Open3.pipeline_w(pager) { |stdin|
+          stdin.puts content
+          stdin.close
+        }
       else
-        super
+        puts content
       end
     end
   end

data/lib/rbnotes/commands/update.rb

@@ -19,7 +19,7 @@ module Rbnotes::Commands
   # as add command.
   #
   # If none of editors is available, the command fails.
-  #
+
   class Update < Command
     include ::Rbnotes::Utils
 
@@ -30,19 +30,10 @@ module Rbnotes::Commands
     #
     # :call-seq:
     #     "20201020112233" -> "20201021123400"
-    #
-    def execute(args, conf)
-      raise Rbnotes::MissingArgumentError, args if args.size < 1
-
-      target_stamp = nil
-      begin
-        target_stamp = Textrepo::Timestamp.parse_s(args.shift)
-      rescue ArgumentError => e
-        raise Rbnotes::MissingArgumentError, args
-      end
 
+    def execute(args, conf)
+      target_stamp = Rbnotes::Utils.read_timestamp(args)
       editor = find_editor(conf[:editor])
-
       repo = Textrepo.init(conf)
 
       text = nil

data/lib/rbnotes/error.rb

@@ -1,13 +1,15 @@
 module Rbnotes
   ##
   # A base class for each error class of rbnotes.
-  #
+
   class Error < StandardError; end
 
   # :stopdoc:
+
   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
@@ -16,7 +18,7 @@ module Rbnotes
 
   ##
   # An error raised if an essential argument was missing.
-  #
+
   class MissingArgumentError < Error
     def initialize(args)
       super(ErrMsg::MISSING_ARGUMENT % args.to_s)
@@ -26,17 +28,27 @@ module Rbnotes
   ##
   # An error raised if a given timestamp was not found in the
   # repository.
-  #
+
   class MissingTimestampError < Error
     def initialize(timestamp)
       super(ErrMsg::MISSING_TIMESTAMP % timestamp)
     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".
-  #
+
   class NoEditorError < Error
     def initialize(names)
       super(ErrMsg::NO_EDITOR % names.to_s)
@@ -46,6 +58,7 @@ module Rbnotes
   ##
   # An error raised when a external program such an editor was aborted
   # during its execution.
+
   class ProgramAbortError < Error
     def initialize(cmdline)
       super(ErrMsg::PROGRAM_ABORT % cmdline.join(" "))

data/lib/rbnotes/utils.rb

@@ -86,6 +86,41 @@ module Rbnotes
     end
     module_function :run_with_tmpfile
 
+    ##
+    # Generates a Textrepo::Timestamp object from a String which comes
+    # from the command line arguments.  When no argument is given,
+    # then reads from STDIN.
+    #
+    # :call-seq:
+    #   read_timestamp(args) -> String
+
+    def read_timestamp(args)
+      str = args.shift || read_arg($stdin)
+      begin
+        Textrepo::Timestamp.parse_s(str)
+      rescue ArgumentError => _
+        raise InvalidTimestampStringError, str
+      end
+    end
+    module_function :read_timestamp
+
+    ##
+    # Reads an argument from the IO object.  Typically, it is intended
+    # to be used with STDIN.
+    #
+    # :call-seq:
+    #   read_arg(IO) -> String
+
+    def read_arg(io)
+      # assumes the reading line looks like:
+      #
+      #     foo bar baz ...
+      #
+      # then, only the first string is interested
+      io.gets.split(" ")[0]
+    end
+    module_function :read_arg
+
     # :stopdoc:
 
     private

data/lib/rbnotes/version.rb

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

metadata

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