rbnotes 0.4.10 → 0.4.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e6de4675ffb2b409f72f240e4509a6d254793d977a8dd68cc54cf6d0c839e3d
-  data.tar.gz: 364d4deb47d049af7145024cfb3151639ea9cf0504963c1b72e5a15e465a84a6
+  metadata.gz: 4170ccc84305971d10f3726351cdc4138b5fabaa7293bc10a827ed0458f28b8c
+  data.tar.gz: 291efc32e2e65462e8c6996ecbbc7ffbb4e6887a5d0065bbb843d01dfbb8c78c
 SHA512:
-  metadata.gz: bf90b255e23257a921f7a9254d4df5233f97394e73368f27f6a4a8e96989fa3aa76ab55fca69b201ecd9a15264d5d07cf974ee9b745854ca80d3c962accbe37a
-  data.tar.gz: c9fca12a0a6a71562a968775b09e3ebf7bda202ce7251666ab7b727236c47f8b5981d7ee703b94bfc22fae038cc161f76b10ed413ca28bcac3a9d9e0417f7f83
+  metadata.gz: 1f6d2659c1a50f462867a53bff3f7b45e8b38035c3af44407b70d359c6af9409481f1033059384bd8d6b42d03981ce4f955ac87ee5fe7e99f5b50465d47f4e1b
+  data.tar.gz: f5949cfe44eef0951a80ec8949b6bb8a3440d5b483ddacdaf652d8b4dd258a7eb53db42c40290e9a2ebd6e3a1bf6e204f2382b41dd40b23ac8b271dd05547672

data/CHANGELOG.md

@@ -5,7 +5,19 @@ 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.
+## [0.4.11] - 2020-12-07
+### Added
+- Add a new command `statistics`. (#73)
+  - limited features
+- Add a completion file for `zsh`.
+  - a new file `etc/zsh/_rbnotes`
+
+### Changed
+- Add a new option for `import` to use `mtime`. (#82)
+- Add a feature to show multiple notes at once. (#79)
+
+### Fixed
+- Fix issue #77: no error with a non-existing config file.
 
 ## [0.4.10] - 2020-11-20
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rbnotes (0.4.10)
+    rbnotes (0.4.11)
       textrepo (~> 0.5.4)
       unicode-display_width (~> 1.7)
 

data/etc/zsh/_rbnotes

@@ -0,0 +1,93 @@
+#compdef rbnotes
+
+local __rbnotes_cmd __rbnotes_debug
+
+__rbnotes_process() {
+}
+
+function _rbnotes() {
+    local context curcontext=$curcontext stat line
+    typeset -A opt_args
+    local ret=1
+
+    _arguments \
+	-C \
+	'(- *)'{-v,--version}'[print version]' \
+	'(- *)'{-h,--help}'[show help]' \
+	'(- *)'{-c,--conf}'[config file]: :->conffile' \
+	'1: :__rbnotes_commands' \
+	'*:: :->args'
+
+    case $state in
+	(conffile)
+	    _files -g "*.yml" && ret=0
+	    ;;
+	(args)
+	    case $words[1] in
+		(add)
+		    _arguments \
+			-C \
+			'(-t --timestamp)'{-t,--timestamp}'[set timestamp]' \
+			'(-)*:: :->null_state' \
+			&& ret=0
+		    ;;
+		(export)
+		    _directories && ret=0
+		    ;;
+		(help)
+		    _arguments \
+			-C \
+			'1: :__rbnotes_commands' \
+			&& ret=0
+		    ;;
+		(import)
+		    _files -g '*.md' && ret=0
+		    ;;
+		(list|pick)
+		    _arguments \
+			-C \
+			'1: :__rbnotes_list_keywords' \
+			&& ret=0
+		    ;;
+		(update)
+		    _arguments \
+			-C \
+			'(-k --keep)'{-k,--keep}'[keep timestamp]' \
+			'(-)*:: :->nul_state' \
+			&& ret=0
+		    ;;
+	    esac
+	    ;;
+    esac
+
+    return ret
+}
+
+__rbnotes_commands() {
+    local -a _cmds
+    _cmds=( $(rbnotes commands -d) )
+    _describe -t commands Commands _cmds
+}
+
+__rbnotes_list_keywords() {
+    local -a _kw _this_month _this_year
+    _this_month=$(date "+%Y%m")
+    _last_month=$(date -v-1m "+%Y%m")
+    _this_year=$(date "+%Y")
+    _kw=(
+	{to,today}':Today'
+	{ye,yesterday}':Yesterday'
+	{tw,this_week}':This week'
+	{lw,last_week}':Last week'
+	"${_this_month}:This month"
+	"${_last_month}:Last month"
+	"${_this_year}:This year"
+	)
+    _describe -t keywords Keywords _kw
+}
+
+_rbnotes "$@"
+
+# Local Variables:
+# mode: shell-script
+# End:

data/exe/rbnotes

@@ -57,6 +57,7 @@ rescue MissingArgumentError, MissingTimestampError,
        NoEditorError, ProgramAbortError,
        Textrepo::InvalidTimestampStringError,
        InvalidTimestampPatternError,
+       NoConfFileError,
        ArgumentError,
        Errno::EACCES => e
   puts e.message

data/lib/rbnotes.rb

@@ -8,6 +8,7 @@ module Rbnotes
   require_relative "rbnotes/conf"
   require_relative "rbnotes/utils"
   require_relative "rbnotes/commands"
+  require_relative "rbnotes/statistics"
 
   class << self
     def utils

data/lib/rbnotes/commands.rb

@@ -61,10 +61,11 @@ Example usage:
   #{Rbnotes::NAME} commands [-d]
   #{Rbnotes::NAME} delete [TIMESTAMP]
   #{Rbnotes::NAME} export [TIMESTAMP [FILENAME]]
-  #{Rbnotes::NAME} import FILE
+  #{Rbnotes::NAME} import [-m|--use-mtime] FILE
   #{Rbnotes::NAME} list [STAMP_PATTERN|KEYWORD]
   #{Rbnotes::NAME} search PATTERN [STAMP_PATTERN]
-  #{Rbnotes::NAME} show [TIMESTAMP]
+  #{Rbnotes::NAME} show [TIMESTAMP...]
+  #{Rbnotes::NAME} statistics ([-y]|[-m])
   #{Rbnotes::NAME} update [-k] [TIMESTAMP]
 
 Further help for each command:

data/lib/rbnotes/commands/import.rb

@@ -4,9 +4,12 @@ module Rbnotes::Commands
   # Imports a existing file which specified by the argument as a note.
   #
   # A timestamp is generated referring to the birthtime of the given
-  # file.  If birthtime is not available on the system, use mtime
+  # file.  If birthtime is not available on the system, uses mtime
   # (modification time).
   #
+  # When the option, "-m" (or "--use-mtime") is specified, uses mtime
+  # instead of birthtime.
+  #
   # Occasionally, there is another note which has the same timestmap
   # in the repository.  Then, tries to create a new timestamp with a
   # suffix.  Unluckily, when such timestamp with a suffix already
@@ -25,11 +28,29 @@ module Rbnotes::Commands
     #     execute([PATHNAME], Rbnotes::Conf or Hash) -> nil
 
     def execute(args, conf)
+      @opts = {}
+      while args.size > 0
+        arg = args.shift
+        case arg
+        when "-m", "--use-mtime"
+          @opts[:use_mtime] = true
+        else
+          args.unshift(arg)
+          break
+        end
+      end
+
       file = args.shift
       unless file.nil?
         st = File::Stat.new(file)
-        btime = st.respond_to?(:birthtime) ? st.birthtime : st.mtime
-        stamp = Textrepo::Timestamp.new(btime)
+        time = nil
+        if @opts[:use_mtime]
+          time = st.mtime
+        else
+          time = st.respond_to?(:birthtime) ? st.birthtime : st.mtime
+        end
+
+        stamp = Textrepo::Timestamp.new(time)
         puts "Import [%s] (timestamp [%s]) ..." % [file, stamp]
 
         repo = Textrepo.init(conf)
@@ -72,7 +93,7 @@ module Rbnotes::Commands
           puts "Cannot create a text into the repository with the" \
                " specified file [%s]."  % file
           puts "For, the birthtime [%s] is identical to some notes" \
-               " already exists in the reopsitory." % btime
+               " already exists in the reopsitory." % time
           puts "Change the birthtime of the target file, then retry."
         else
           puts "... Done."
@@ -86,7 +107,7 @@ module Rbnotes::Commands
     def help                    # :nodoc:
       puts <<HELP
 usage:
-    #{Rbnotes::NAME} import FILE
+    #{Rbnotes::NAME} import [-m|--use-mtime] FILE
 
 Imports a existing file which specified by the argument as a note.
 

data/lib/rbnotes/commands/show.rb

@@ -1,52 +1,97 @@
 module Rbnotes::Commands
 
   ##
-  # Shows the content of the note specified by the argument.  The
+  # Shows the content of the notes specified by arguments.  Each
   # argument must be a string which can be converted into
   # Textrepo::Timestamp object.
   #
-  # A string for Timestamp must be:
+  # A string for Textrepo::Timestamp must be:
   #
   #     "20201106112600"     : year, date, time and sec
   #     "20201106112600_012" : with suffix
   #
-  # If no argument is passed, reads the standard input for an argument.
+  # If no argument is passed, reads the standard input for arguments.
 
   class Show < Command
 
     def description             # :nodoc:
-      "Show the content of a note"
+      "Show the content of notes"
     end
 
     def execute(args, conf)
-      stamp = Rbnotes.utils.read_timestamp(args)
-
+      stamps = Rbnotes.utils.read_multiple_timestamps(args)
       repo = Textrepo.init(conf)
-      content = repo.read(stamp)
+
+      content = stamps.map { |stamp| [stamp, repo.read(stamp)] }.to_h
 
       pager = conf[:pager]
       unless pager.nil?
-        require 'open3'
-        Open3.pipeline_w(pager) { |stdin|
-          stdin.puts content
-          stdin.close
-        }
+        puts_with_pager(pager, make_output(content))
       else
-        puts content
+        puts make_output(content)
       end
     end
 
     def help                    # :nodoc:
       puts <<HELP
 usage:
-    #{Rbnotes::NAME} show [TIMESTAMP]
+    #{Rbnotes::NAME} show [TIMESTAMP...]
 
-Show the content of given note.  TIMESTAMP must be a fully qualified
+Show the content of given notes.  TIMESTAMP must be a fully qualified
 one, such "20201016165130" or "20201016165130_012" if it has a suffix.
 
 The command try to read its argument from the standard input when no
 argument was passed in the command line.
 HELP
     end
+
+    # :stopdoc:
+
+    private
+
+    def puts_with_pager(pager, output)
+      require "open3"
+      Open3.pipeline_w(pager) { |stdin|
+        stdin.puts output
+        stdin.close
+      }
+    end
+
+    require "io/console/size"
+
+    def make_output(content)
+      if content.size <= 1
+        return content.values[0]
+      end
+
+      _, column = IO.console_size
+      output = content.map { |timestamp, text|
+        ary = [make_heading(timestamp, [column, 72].min)]
+        ary.concat(text)
+        ary
+      }
+
+      output = insert_delimiter(output, "")
+      output.flatten
+    end
+
+    def make_heading(timestamp, column)
+      stamp_str = timestamp.to_s
+      length = column - (stamp_str.size + 2)
+      "#{stamp_str} #{Array.new(length, '-').join}"
+    end
+
+    def insert_delimiter(ary, delimiter = "")
+      result = []
+      ary.each { |e|
+        result << e
+        result << delimiter
+      }
+      result.delete_at(-1)
+      result
+    end
+
+    # :startdoc:
+
   end
 end

data/lib/rbnotes/commands/statistics.rb

@@ -0,0 +1,55 @@
+module Rbnotes::Commands
+  ##
+  # Shows statistics.
+
+  class Statistics < Command
+
+    def description             # :nodoc:
+      "Show statistics values"
+    end
+
+    def execute(args, conf)
+      report = :total
+      while args.size > 0
+        arg = args.shift
+        case arg
+        when "-y", "--yearly"
+          report = :yearly
+          break
+        when "-m", "--monthly"
+          report = :monthly
+          break
+        else
+          args.unshift(arg)
+          raise ArgumentError, "invalid option or argument: %s" % args.join(" ")
+        end
+      end
+
+      stats = Rbnotes::Statistics.new(conf)
+      case report
+      when :yearly
+        stats.yearly_report
+      when :monthly
+        stats.monthly_report
+      else
+        stats.total_report
+      end
+    end
+
+    def help
+      puts <<HELP
+usage:
+    #{Rbnotes::NAME} statistics ([-y|--yearly]|[-m|--monthly])
+
+option:
+    -y, --yearly  : print yearly report
+    -m, --monthly : print monthly report
+
+Show statistics.
+
+In the version #{Rbnotes::VERSION}, only number of notes is supported.
+HELP
+    end
+
+  end
+end

data/lib/rbnotes/conf.rb

@@ -32,16 +32,18 @@ module Rbnotes
     DIRNAME_COMMON_CONF = ".config"
 
     def initialize(conf_path = nil)   # :nodoc:
-      @conf_path = conf_path || File.join(base_path, FILENAME_CONF)
-
+      @conf_path = conf_path
       @conf = {}
-      if FileTest.exist?(@conf_path)
+
+      if use_default_values?
+        @conf.merge!(DEFAULT_VALUES)
+      else
+        @conf_path ||= default_conf_file
+        raise NoConfFileError, @conf_path unless File.exist?(@conf_path)
+
         yaml_str = File.open(@conf_path, "r") { |f| f.read }
         @conf = YAML.load(yaml_str)
-      else
-        @conf.merge(DEFAULT_VALUES)
       end
-      self
     end
 
     def_delegators(:@conf,
@@ -99,10 +101,19 @@ module Rbnotes
       end
       return path
     end
-  end
+
+    def default_conf_file
+      File.join(base_path, FILENAME_CONF)
+    end
+
+    def use_default_values?
+      @conf_path.nil? && !File.exist?(default_conf_file)
+    end
 
   # :startdoc:
 
+  end
+
   class << self
     ##
     # Gets the instance of Rbnotes::Conf.  An optional argument is to

data/lib/rbnotes/error.rb

@@ -13,6 +13,7 @@ module Rbnotes
     PROGRAM_ABORT     = "External program was aborted: %s"
     UNKNOWN_KEYWORD   = "Unknown keyword: %s"
     INVALID_TIMESTAMP_PATTERN = "Invalid timestamp pattern: %s"
+    NO_CONF_FILE      = "No configuration file: %s"
   end
 
   # :startdoc:
@@ -75,4 +76,14 @@ module Rbnotes
     end
   end
 
+  ##
+  # An error raised when the specified configuration file does not
+  # exist.
+
+  class NoConfFileError < Error
+    def initialize(filename)
+      super(ErrMsg::NO_CONF_FILE % filename)
+    end
+  end
+
 end

data/lib/rbnotes/statistics.rb

@@ -0,0 +1,101 @@
+module Rbnotes
+  ##
+  # Calculates statistics of the repository.
+  class Statistics
+    include Enumerable
+
+    def initialize(conf)
+      @repo = Textrepo.init(conf)
+      @values = construct_values(@repo)
+    end
+
+    def total_report
+      puts @repo.entries.size
+    end
+
+    def yearly_report
+      self.each_year { |year, monthly_values|
+        num_of_notes = monthly_values.map { |_mon, values| values.size }.sum
+        puts "#{year}: #{num_of_notes}"
+      }
+    end
+
+    def monthly_report
+      self.each { |year, mon, values|
+        num_of_notes = values.size
+        puts "#{year}/#{mon}: #{num_of_notes}"
+      }
+    end
+
+    def each(&block)
+      if block.nil?
+        @values.map { |year, monthly_values|
+          monthly_values.each { |mon, values|
+            [year, mon, values]
+          }
+        }.to_enum(:each)
+      else
+        @values.each { |year, monthly_values|
+          monthly_values.each { |mon, values|
+            yield [year, mon, values]
+          }
+        }
+      end
+    end
+
+    def years
+      @values.keys
+    end
+
+    def months(year)
+      @values[year] || []
+    end
+
+    def each_year(&block)
+      if block.nil?
+        @values.map { |year, monthly_values|
+          [year, monthly_values]
+        }.to_enum(:each)
+      else
+        @values.each { |year, monthly_values|
+          yield [year, monthly_values]
+        }
+      end
+    end
+
+    private
+
+    def construct_values(repo)
+      values = {}
+      repo.each { |timestamp, text|
+        value = StatisticValue.new(timestamp, text)
+        y = value.year
+        m = value.mon
+        values[y] ||= {}
+        values[y][m] ||= []
+
+        values[y][m] << value
+      }
+      values
+    end
+
+    class StatisticValue
+
+      attr_reader :lines
+
+      def initialize(timestamp, text)
+        @timestamp = timestamp
+        @lines = text.size
+      end
+
+      def year
+        @timestamp[:year]
+      end
+
+      def mon
+        @timestamp[:mon]
+      end
+    end
+
+  end
+end

data/lib/rbnotes/utils.rb

@@ -103,23 +103,16 @@ module Rbnotes
     end
 
     ##
-    # Reads an argument from the IO object.  Typically, it is intended
-    # to be used with STDIN.
+    # Generates multiple Textrepo::Timestamp objects from the command
+    # line arguments.  When no argument is given, try to read from
+    # STDIN.
     #
     # :call-seq:
-    #   read_arg(IO) -> String
+    #   read_multiple_timestamps(args) -> [String]
 
-    def read_arg(io)
-      # assumes the reading line looks like:
-      #
-      #     foo bar baz ...
-      #
-      # then, only the first string is interested
-      begin
-        io.gets.split(":")[0].rstrip
-      rescue NoMethodError => _
-        nil
-      end
+    def read_multiple_timestamps(args)
+      strings = args.size < 1 ? read_multiple_args($stdin) : args
+      strings.map { |str| Textrepo::Timestamp.parse_s(str) }
     end
 
     ##
@@ -241,6 +234,41 @@ module Rbnotes
     # :stopdoc:
 
     private
+
+    ##
+    # 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)
+      read_multiple_args(io)[0]
+    end
+
+    ##
+    # Reads arguments from the IO object.  Typically, it is intended
+    # to be used with STDIN.
+    #
+    # :call-seq:
+    #   read_multiple_arg(IO) -> [String]
+
+    def read_multiple_args(io)
+      strings = io.readlines
+      strings.map { |str|
+        # assumes the reading line looks like:
+        #
+        #     foo bar baz ...
+        #
+        # then, only the first string is interested
+        begin
+          str.split(":")[0].rstrip
+        rescue NoMethodError => _
+          nil
+        end
+      }.compact
+    end
+
     def search_in_path(name)
       search_paths = ENV["PATH"].split(":")
       found = search_paths.map { |path|

data/lib/rbnotes/version.rb

@@ -1,4 +1,4 @@
 module Rbnotes
-  VERSION = "0.4.10"
-  RELEASE = "2020-11-20"
+  VERSION = "0.4.11"
+  RELEASE = "2020-12-07"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbnotes
 version: !ruby/object:Gem::Version
-  version: 0.4.10
+  version: 0.4.11
 platform: ruby
 authors:
 - mnbi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-20 00:00:00.000000000 Z
+date: 2020-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: textrepo
@@ -59,6 +59,7 @@ files:
 - conf/config.yml
 - conf/config_deve.yml
 - conf/config_test.yml
+- etc/zsh/_rbnotes
 - exe/rbnotes
 - lib/rbnotes.rb
 - lib/rbnotes/commands.rb
@@ -72,9 +73,11 @@ files:
 - lib/rbnotes/commands/pick.rb
 - lib/rbnotes/commands/search.rb
 - lib/rbnotes/commands/show.rb
+- lib/rbnotes/commands/statistics.rb
 - lib/rbnotes/commands/update.rb
 - lib/rbnotes/conf.rb
 - lib/rbnotes/error.rb
+- lib/rbnotes/statistics.rb
 - lib/rbnotes/utils.rb
 - lib/rbnotes/version.rb
 - rbnotes.gemspec