rbnotes 0.4.7 → 0.4.12

data/lib/rbnotes/error.rb

@@ -9,9 +9,13 @@ module Rbnotes
   module ErrMsg
     MISSING_ARGUMENT  = "missing argument: %s"
     MISSING_TIMESTAMP = "missing timestamp: %s"
-    NO_EDITOR         = "No editor is available: %s"
-    PROGRAM_ABORT     = "External program was aborted: %s"
-    UNKNOWN_KEYWORD   = "Unknown keyword: %s"
+    NO_EDITOR         = "no editor is available: %s"
+    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"
+    NO_TEMPLATE_FILE  = "no template file: %s"
+    INVALID_TIMESTAMP_PATTERN_AS_DATE = "invalid timestamp pattern as date: %s"
   end
 
   # :startdoc:
@@ -64,4 +68,52 @@ module Rbnotes
       super(ErrMsg::UNKNOWN_KEYWORD % keyword)
     end
   end
+
+  ##
+  # An error raised when an invalid timestamp pattern was specified.
+
+  class InvalidTimestampPatternError < Error
+    def initialize(pattern)
+      super(ErrMsg::INVALID_TIMESTAMP_PATTERN % pattern)
+    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
+
+  ##
+  # An error raised when no arguments is spcified.
+
+  class NoArgumentError < Error
+    def initialize
+      super
+    end
+  end
+
+  ##
+  # An error raised when the specified template files does not exist.
+  #
+  class NoTemplateFileError < Error
+    def initialize(filepath)
+      super(ErrMsg::NO_TEMPLATE_FILE % filepath)
+    end
+  end
+
+  ##
+  # An error raised when the specified pattern cannot be converted
+  # into a date.
+  #
+  class InvalidTimestampPatternAsDateError < Error
+    def initialize(pattern)
+      super(ErrMsg::INVALID_TIMESTAMP_PATTERN_AS_DATE % pattern)
+    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

@@ -99,27 +99,22 @@ module Rbnotes
 
     def read_timestamp(args)
       str = args.shift || read_arg($stdin)
+      raise NoArgumentError if str.nil?
       Textrepo::Timestamp.parse_s(str)
     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
+      raise NoArgumentError if (strings.nil? || strings.empty?)
+      strings.map { |str| Textrepo::Timestamp.parse_s(str) }
     end
 
     ##
@@ -143,6 +138,8 @@ module Rbnotes
     #   - "yeasterday" (or "ye")
     #   - "this_week"  (or "tw")
     #   - "last_week"  (or "lw")
+    #   - "this_month" (or "tm")
+    #   - "last_month" (or "lm")
     #
     # :call-seq:
     #   expand_keyword_in_args(Array of Strings) -> Array of Strings
@@ -154,7 +151,8 @@ module Rbnotes
       while args.size > 0
         arg = args.shift
         if ["today", "to", "yesterday", "ye",
-            "this_week", "tw", "last_week", "lw"].include?(arg)
+            "this_week", "tw", "last_week", "lw",
+            "this_month", "tm", "last_month", "lm"].include?(arg)
           patterns.concat(Rbnotes.utils.expand_keyword(arg))
         else
           patterns << arg
@@ -180,6 +178,10 @@ module Rbnotes
         patterns.concat(dates_in_this_week.map { |d| timestamp_pattern(d) })
       when "last_week", "lw"
         patterns.concat(dates_in_last_week.map { |d| timestamp_pattern(d) })
+      when "this_month", "tm"
+        patterns.concat(dates_in_this_month.map { |d| timestamp_pattern(d) })
+      when "last_month", "lm"
+        patterns.concat(dates_in_last_month.map { |d| timestamp_pattern(d) })
       else
         raise UnknownKeywordError, keyword
       end
@@ -190,25 +192,28 @@ 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]
-    #                     ++
-    #                      ^--- delimiter (2 characters)
+    #   |<--------------- console column size -------------------->|
+    #   |   |+-- timestamp ---+  +-subject (the 1st line of note) -+
+    #   |                     |  |                                 |
+    #   |   |20101010001000_123: I love Macintosh.                 [EOL]
+    #   |   |20100909090909_999: This is very very long looong subj[EOL]
+    #   |<->|                 |  |
+    #     ^--- pad             ++
+    #                          ^--- delimiter (2 characters)
     #
     # The subject part will truncate when it is long.
 
-    def make_headline(timestamp, text)
+    def make_headline(timestamp, text, pad = nil)
       _, column = IO.console_size
       delimiter = ": "
       timestamp_width = timestamp.to_s.size
       subject_width = column - timestamp_width - delimiter.size - 1
+      subject_width -= pad.size unless pad.nil?
 
       subject = remove_heading_markup(text[0])
 
       ts_part = "#{timestamp.to_s}    "[0..(timestamp_width - 1)]
+      ts_part.prepend(pad) unless pad.nil?
       sj_part = truncate_str(subject, subject_width)
 
       ts_part + delimiter + sj_part
@@ -217,6 +222,7 @@ module Rbnotes
     ##
     # Finds all notes those timestamps match to given patterns in the
     # given repository.  Returns an Array contains Timestamp objects.
+    # The returned Array is sorted by Timestamp.
     #
     # :call-seq:
     #     find_notes(Array of timestamp patterns, Textrepo::Repository)
@@ -227,9 +233,55 @@ module Rbnotes
       }.flatten.sort{ |a, b| b <=> a }.uniq
     end
 
+    ##
+    # Enumerates all timestamp patterns in a week which contains a
+    # given timestamp as a day of the week.
+    #
+    # :call-seq:
+    #     timestamp_patterns_in_week(timestamp) -> [Array of Strings]
+
+    def timestamp_patterns_in_week(timestamp)
+      dates_in_week(start_date_in_the_week(timestamp.time)).map { |date| timestamp_pattern(date) }
+    end
+
     # :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|
@@ -268,14 +320,18 @@ module Rbnotes
     end
 
     def start_date_in_this_week
-      today = Time.now
-      Date.new(today.year, today.mon, today.day).prev_day(wday(today))
+      start_date_in_the_week(Time.now)
     end
 
     def start_date_in_last_week
       start_date_in_this_week.prev_day(7)
     end
 
+    def start_date_in_the_week(time)
+      parts = [:year, :mon, :day].map { |sym| time.send(sym) }
+      Date.new(*parts).prev_day(wday(time))
+    end
+
     def wday(time)
       (time.wday - 1) % 7
     end
@@ -286,6 +342,36 @@ module Rbnotes
       dates
     end
 
+    def dates_in_this_month
+      today = Time.now
+      first_date = date(Time.new(today.year, today.mon, 1))
+      dates_in_month(first_date)
+    end
+
+    def dates_in_last_month
+      today = Time.now
+      first_date_of_this_month = date(Time.new(today.year, today.mon, 1))
+      dates_in_month(first_date_of_this_month.prev_month)
+    end
+
+    def dates_in_month(first_date)
+      days = days_in_month(first_date.mon, leap: first_date.leap?)
+      dates = [first_date]
+      1.upto(days - 1) { |i| dates << first_date.next_day(i) }
+      dates
+    end
+
+    DAYS = {
+      #             1   2   3   4   5   6   7   8   9  10  11  12
+      #            Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec
+      false => [0, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31],
+      true  => [0, 31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31],
+    }
+
+    def days_in_month(mon, leap: false)
+      DAYS[leap][mon]
+    end
+
     def truncate_str(str, size)
       count = 0
       result = ""

data/lib/rbnotes/version.rb

@@ -1,4 +1,4 @@
 module Rbnotes
-  VERSION = "0.4.7"
-  RELEASE = "2020-11-15"
+  VERSION = "0.4.12"
+  RELEASE = "2020-12-18"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbnotes
 version: !ruby/object:Gem::Version
-  version: 0.4.7
+  version: 0.4.12
 platform: ruby
 authors:
 - mnbi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-15 00:00:00.000000000 Z
+date: 2020-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: textrepo
@@ -58,11 +58,16 @@ files:
 - bin/setup
 - conf/config.yml
 - conf/config_deve.yml
+- conf/config_deve_fzf_no_opts.yml
+- conf/config_deve_no_picker.yml
+- conf/config_deve_peco.yml
 - conf/config_test.yml
+- etc/zsh/_rbnotes
 - exe/rbnotes
 - lib/rbnotes.rb
 - lib/rbnotes/commands.rb
 - lib/rbnotes/commands/add.rb
+- lib/rbnotes/commands/commands.rb
 - lib/rbnotes/commands/delete.rb
 - lib/rbnotes/commands/export.rb
 - lib/rbnotes/commands/help.rb
@@ -71,9 +76,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