rbnotes 0.4.12 → 0.4.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 517b5866c81f76286f87b2ed7d2e695c4dd09d5c7ab86f9557079232a58fde37
-  data.tar.gz: 1d89412445d155501f67cd0978a8070975ed722ee7440119cf5a9ba89ca946eb
+  metadata.gz: 55b7ddb12d306be2cb815400d4e729deff8badfbde55ede0f9edba78c380eb44
+  data.tar.gz: ae0720108810db518693959f3a8faf20c7ca985d6aaf3c39bac94327d45f25db
 SHA512:
-  metadata.gz: 1f0bab361e6f4a7f22a59433369b221b6dffc1e16b79f9d4bdc4027d78c3d61a6e949ab2b81ae1ab3be4c5d52af6bd74aed4b36c70a93f31e710a42b7bb23731
-  data.tar.gz: af38ba13276090ae653fee8b1b3f67f3de57596851ce8b645f4ed3463c38d71c4a950b3382bff55ad98853c42e2cb3f2df0e7e7652f756f385d53ef15f917085
+  metadata.gz: 8fc47bdc0c93bc964714c89d791655f1d385de0dfbf6af5202ec18c17f1be951efb02fcd4d9b0ac9b298cbb163e8a9e836a5c4d752bf9bad5299cc0d38983463
+  data.tar.gz: d2a3db96531609429775b9caf32308691afc6023ffaf2d8aae39df3d763e99b497a3efe763e821033ab725240e925ddd23a5385dac15d0a3bd5f3cb9f7c23ac1

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Build
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.0
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -35,7 +35,6 @@ build-iPhoneSimulator/
 ## Documentation cache and generated files:
 /.yardoc/
 /_yardoc/
-/doc/
 /rdoc/
 
 ## Environment normalization:

data/CHANGELOG.md

@@ -5,7 +5,16 @@ 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.13] - 2021-03-30
+### Changed
+- Use GitHub/Actions instead of Travis-CI.
+- Add `--week` option to `pick` command. (#88)
+
+### Fixed
+- Fix issue #98: remove redundant args
+  (Rbnotes::Utils.read_multiple_timestamps). (#98)
+- Update `textrepo`. -> 0.5.8 (#97)
 
 ## [0.4.12] - 2020-12-18
 ### Changed

data/Gemfile

@@ -6,4 +6,4 @@ gemspec
 gem "rake", "~> 13.0"
 gem "minitest", "~> 5.0"
 
-gem 'textrepo', "~> 0.5.4"
+gem 'textrepo', "~> 0.5.8"

data/Gemfile.lock

@@ -1,16 +1,16 @@
 PATH
   remote: .
   specs:
-    rbnotes (0.4.12)
-      textrepo (~> 0.5.4)
+    rbnotes (0.4.13)
+      textrepo (~> 0.5.8)
       unicode-display_width (~> 1.7)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    minitest (5.14.2)
-    rake (13.0.1)
-    textrepo (0.5.7)
+    minitest (5.14.4)
+    rake (13.0.3)
+    textrepo (0.5.8)
     unicode-display_width (1.7.0)
 
 PLATFORMS
@@ -20,7 +20,7 @@ DEPENDENCIES
   minitest (~> 5.0)
   rake (~> 13.0)
   rbnotes!
-  textrepo (~> 0.5.4)
+  textrepo (~> 0.5.8)
 
 BUNDLED WITH
-   2.1.4
+   2.2.3

data/README.md

@@ -1,6 +1,6 @@
 # Rbnotes
 
-[![Build Status](https://travis-ci.org/mnbi/rbnotes.svg?branch=main)](https://travis-ci.org/mnbi/rbnotes)
+[![Build Status](https://github.com/mnbi/rbnotes/workflows/Build/badge.svg)](https://github.com/mnbi/rbnotes/actions?query=workflow%3A"Build")
 
 Rbnotes is a simple utility to write a note in the single repository.
 

data/Rakefile

@@ -25,6 +25,6 @@ require "rdoc/task"
 
 RDoc::Task.new do |rdoc|
   rdoc.generator = "ri"
-  rdoc.rdoc_dir = "doc"
+  rdoc.rdoc_dir = "rdoc"
   rdoc.rdoc_files.include("lib/**/*.rb")
 end

data/lib/rbnotes.rb

@@ -10,9 +10,4 @@ module Rbnotes
   require_relative "rbnotes/commands"
   require_relative "rbnotes/statistics"
 
-  class << self
-    def utils
-      Utils.instance
-    end
-  end
 end

data/lib/rbnotes/commands/list.rb

@@ -67,44 +67,24 @@ module Rbnotes::Commands
         end
       end
 
-      patterns = nil
-      if @opts[:enum_week]
-        arg = args.shift || Textrepo::Timestamp.now[0, 8]
-        case arg.size
-        when "yyyymodd".size, "yyyymoddhhmiss".size, "yyyymoddhhmiss_sfx".size
-          stamp_str = "#{arg}000000"[0, 14]
-          timestamp = Textrepo::Timestamp.parse_s(stamp_str)
-        when "modd".size
-          this_year = Time.now.year.to_s
-          stamp_str = "#{this_year}#{arg}000000"
-          begin
-            timestamp = Textrepo::Timestamp.parse_s(stamp_str)
-          rescue Textrepo::InvalidTimestampStringError => _e
-            raise InvalidTimestampPatternAsDateError, arg
-          end
-        else
-          raise InvalidTimestampPatternAsDateError, args.unshift(arg)
-        end
-        patterns = Rbnotes.utils.timestamp_patterns_in_week(timestamp)
-      else
-        patterns = Rbnotes.utils.expand_keyword_in_args(args)
-      end
+      utils = Rbnotes.utils
+      patterns = utils.read_timestamp_patterns(args, enum_week: @opts[:enum_week])
 
       @repo = Textrepo.init(conf)
-      notes = Rbnotes.utils.find_notes(patterns, @repo)
+      notes = utils.find_notes(patterns, @repo)
       output = []
       if @opts[:verbose]
         collect_timestamps_by_date(notes).each { |date, timestamps|
           output << "#{date} (#{timestamps.size})"
           timestamps.each { |timestamp|
             pad = "  "
-            output << Rbnotes.utils.make_headline(timestamp,
+            output << utils.make_headline(timestamp,
                                                   @repo.read(timestamp), pad)
           }
         }
       else
         notes.each { |timestamp|
-          output << Rbnotes.utils.make_headline(timestamp,
+          output << utils.make_headline(timestamp,
                                                 @repo.read(timestamp))
         }
       end

data/lib/rbnotes/commands/pick.rb

@@ -10,12 +10,26 @@ module Rbnotes::Commands
     end
 
     def execute(args, conf)
-      patterns = Rbnotes.utils.expand_keyword_in_args(args)
+      @opts = {}
+      while args.size > 0
+        arg = args.shift
+        case arg
+        when "-w", "--week"
+          @opts[:enum_week] = true
+        else
+          args.unshift(arg)
+          break
+        end
+      end
+
+      utils = Rbnotes.utils
+      patterns = utils.read_timestamp_patterns(args, enum_week: @opts[:enum_week])
+
       @repo = Textrepo.init(conf)
 
       list = []
-      Rbnotes.utils.find_notes(patterns, @repo).each { |timestamp|
-        list << Rbnotes.utils.make_headline(timestamp, @repo.read(timestamp))
+      utils.find_notes(patterns, @repo).each { |timestamp|
+        list << utils.make_headline(timestamp, @repo.read(timestamp))
       }
 
       picker = conf[:picker]

data/lib/rbnotes/utils.rb

@@ -7,6 +7,20 @@ require "io/console/size"
 require "unicode/display_width"
 
 module Rbnotes
+
+  class << self
+
+    ##
+    # Retrieves the singleton instance of Rbnotes::Utils class.
+    # Typical usage is as follows:
+    #
+    #   Rbnotes.utils.find_editor("emacsclient")
+    #
+    def utils
+      Utils.instance
+    end
+  end
+
   ##
   # Defines several utility methods those are intended to be used in
   # Rbnotes classes.
@@ -108,13 +122,79 @@ module Rbnotes
     # line arguments.  When no argument is given, try to read from
     # STDIN.
     #
+    # When multiple strings those point the identical time are
+    # included the arguments (passed or read form STDIN), the
+    # redundant strings will be removed.
+    #
+    # The order of the arguments will be preserved into the return
+    # value, even if the redundant strings were removed.
+    #
     # :call-seq:
     #   read_multiple_timestamps(args) -> [String]
 
     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) }
+      strings.uniq.map { |str| Textrepo::Timestamp.parse_s(str) }
+    end
+
+    ##
+    # Reads timestamp patterns in an array of arguments.  It supports
+    # keywords expansion and enumeration of week.  The function is
+    # intended to be used from Commands::List#execute and
+    # Commands::Pick#execute.
+    #
+    def read_timestamp_patterns(args, enum_week: false)
+      patterns = nil
+      if enum_week
+        arg = args.shift
+        begin
+          patterns = timestamp_patterns_in_week(arg.dup)
+        rescue InvalidTimestampPatternAsDateError => _e
+          raise InvalidTimestampPatternAsDateError, args.unshift(arg)
+        end
+      else
+        patterns = expand_keyword_in_args(args)
+      end
+      patterns
+    end
+
+    ##
+    # Enumerates all timestamp patterns in a week which contains a
+    # given timestamp as a day of the week.
+    #
+    # The argument must be one of the followings:
+    #   - "yyyymodd" (eg. "20201220")
+    #   - "yymoddhhmiss" (eg. "20201220120048")
+    #   - "yymoddhhmiss_sfx" (eg. "20201220120048_012")
+    #   - "modd" (eg. "1220") (assums in the current year)
+    #   - nil (assumes today)
+    #
+    # :call-seq:
+    #     timestamp_patterns_in_week(String) -> [Array of Strings]
+    #
+    def timestamp_patterns_in_week(arg)
+      date_str = arg || Textrepo::Timestamp.now[0, 8]
+
+      case date_str.size
+      when "yyyymodd".size
+        # nothing to do
+      when "yyyymoddhhmiss".size, "yyyymoddhhmiss_sfx".size
+        date_str = date_str[0, 8]
+      when "modd".size
+        this_year = Time.now.year.to_s
+        date_str = "#{this_year}#{date_str}"
+      else
+        raise InvalidTimestampPatternAsDateError, arg
+      end
+
+      begin
+        date = Date.parse(date_str)
+      rescue Date::Error => _e
+        raise InvalidTimestampPatternAsDateError, arg
+      end
+
+      dates_in_week(date).map { |date| timestamp_pattern(date) }
     end
 
     ##
@@ -143,17 +223,15 @@ module Rbnotes
     #
     # :call-seq:
     #   expand_keyword_in_args(Array of Strings) -> Array of Strings
-
+    #
     def expand_keyword_in_args(args)
       return [nil] if args.empty?
 
       patterns = []
       while args.size > 0
         arg = args.shift
-        if ["today", "to", "yesterday", "ye",
-            "this_week", "tw", "last_week", "lw",
-            "this_month", "tm", "last_month", "lm"].include?(arg)
-          patterns.concat(Rbnotes.utils.expand_keyword(arg))
+        if KEYWORDS.include?(arg)
+          patterns.concat(expand_keyword(arg))
         else
           patterns << arg
         end
@@ -161,33 +239,6 @@ module Rbnotes
       patterns.sort.uniq
     end
 
-    ##
-    # Expands a keyword to timestamp strings.
-    #
-    # :call-seq:
-    #     expand_keyword(keyword as String) -> Array of timestamp Strings
-
-    def expand_keyword(keyword)
-      patterns = []
-      case keyword
-      when "today", "to"
-        patterns << timestamp_pattern(date_of_today)
-      when "yesterday", "ye"
-        patterns << timestamp_pattern(date_of_yesterday)
-      when "this_week", "tw"
-        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
-      patterns
-    end
-
     ##
     # Makes a headline with the timestamp and subject of the notes, it
     # looks like as follows:
@@ -233,17 +284,6 @@ 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
@@ -282,6 +322,39 @@ module Rbnotes
       }.compact
     end
 
+    ##
+    # Expands a keyword to timestamp strings.
+    #
+    # :call-seq:
+    #     expand_keyword(keyword as String) -> Array of timestamp Strings
+    #
+    def expand_keyword(keyword)
+      patterns = []
+      case keyword
+      when "today", "to"
+        patterns << timestamp_pattern(Date.today)
+      when "yesterday", "ye"
+        patterns << timestamp_pattern(Date.today.prev_day)
+      when "this_week", "tw"
+        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
+      patterns
+    end
+
+    KEYWORDS = %w(
+      today to yesterday ye
+      this_week tw last_week lw
+      this_month tm last_month lm
+    )
+
     def search_in_path(name)
       search_paths = ENV["PATH"].split(":")
       found = search_paths.map { |path|
@@ -299,58 +372,40 @@ module Rbnotes
       date.strftime("%Y%m%d")
     end
 
-    def date_of_today
-      date(Time.now)
-    end
-
-    def date_of_yesterday
-      date(Time.now).prev_day
-    end
-
     def date(time)
       Date.new(time.year, time.mon, time.day)
     end
 
     def dates_in_this_week
-      dates_in_week(start_date_in_this_week)
+      dates_in_week(Date.today)
     end
 
     def dates_in_last_week
-      dates_in_week(start_date_in_last_week)
-    end
-
-    def start_date_in_this_week
-      start_date_in_the_week(Time.now)
+      dates_in_week(Date.today.prev_day(7))
     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))
+    def dates_in_week(date)
+      start_date = start_date_of_week(date)
+      dates = [start_date]
+      1.upto(6) { |i| dates << start_date.next_day(i) }
+      dates
     end
 
-    def wday(time)
-      (time.wday - 1) % 7
+    def start_date_of_week(date)
+      # week day in monday start calendar
+      date.prev_day((date.wday - 1) % 7)
     end
 
-    def dates_in_week(start_date)
-      dates = [start_date]
-      1.upto(6) { |i| dates << start_date.next_day(i) }
-      dates
+    def first_date_of_this_month
+      today = Time.now
+      date(Time.new(today.year, today.mon, 1))
     end
 
     def dates_in_this_month
-      today = Time.now
-      first_date = date(Time.new(today.year, today.mon, 1))
-      dates_in_month(first_date)
+      dates_in_month(first_date_of_this_month)
     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
 

data/lib/rbnotes/version.rb

@@ -1,4 +1,4 @@
 module Rbnotes
-  VERSION = "0.4.12"
-  RELEASE = "2020-12-18"
+  VERSION = "0.4.13"
+  RELEASE = "2021-03-30"
 end

data/rbnotes.gemspec

@@ -25,6 +25,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "textrepo", "~> 0.5.4"
+  spec.add_dependency "textrepo", "~> 0.5.8"
   spec.add_dependency "unicode-display_width", "~> 1.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbnotes
 version: !ruby/object:Gem::Version
-  version: 0.4.12
+  version: 0.4.13
 platform: ruby
 authors:
 - mnbi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-18 00:00:00.000000000 Z
+date: 2021-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: textrepo
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.4
+        version: 0.5.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.4
+        version: 0.5.8
 - !ruby/object:Gem::Dependency
   name: unicode-display_width
   requirement: !ruby/object:Gem::Requirement
@@ -46,8 +46,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: A simple utility to write a note.

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.2
-before_install: gem install bundler -v 2.1.4