standup_md 0.3.15 → 0.3.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b95cee87e34194f847a9830ccf56694e1c450c0bdbae04b8b0af0df7716daaaa
-  data.tar.gz: 2d8466163ca2687ca156e62c12399b01a65454e57eb3d7376931908e0e39a61c
+  metadata.gz: 171d0b1fdd697049f52d50db4d1b0ccb95db648dc70b67957c612ebdf74c57b2
+  data.tar.gz: 1c2347af65439e1d8263715eeb3d9b45b4cbc020793ddb1a51dbbd71ee71159b
 SHA512:
-  metadata.gz: 522d4e0c57d9887456210fb79ac5fd4920350ffd7265f8dd2bc40369405ed4ef624cd29425dae92e480b1e694ad9ff5e5733e36c0800527f8c692f3335128ee8
-  data.tar.gz: 1229afe074eacb10dcf0b84dabd80d3a41695c604ade83e175739548bdebdf4d84fd5161f6f50bb9931239816fa885c78ff217b7950fdf31f4498919fccaee0a
+  metadata.gz: faca92ff7d839b8fb83c579bc203ba3477e975d225f2fd7ef5c3c8b37625a674ed6a7e89e7f9033c2169f5cc6f52c0e7ae9a046fb29880bd95f1ac7a56bc400c
+  data.tar.gz: f365e31e43288e039e9c35b887f905a5def1233200d34fead1a250df79215f107cc5ff16534e503d074f1e2b29620fad64b285f94ce68042226cc3a6a1e04fcf

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    standup_md (0.3.15)
+    standup_md (0.3.16)
 
 GEM
   remote: https://rubygems.org/
@@ -115,7 +115,7 @@ CHECKSUMS
   standard (1.54.0) sha256=7a4b08f83d9893083c8f03bc486f0feeb6a84d48233b40829c03ef4767ea0100
   standard-custom (1.0.2) sha256=424adc84179a074f1a2a309bb9cf7cd6bfdb2b6541f20c6bf9436c0ba22a652b
   standard-performance (1.9.0) sha256=49483d31be448292951d80e5e67cdcb576c2502103c7b40aec6f1b6e9c88e3f2
-  standup_md (0.3.15)
+  standup_md (0.3.16)
   stringio (3.2.0) sha256=c37cb2e58b4ffbd33fe5cd948c05934af997b36e0b6ca6fdf43afa234cf222e1
   test-unit (3.7.8) sha256=689d1ca53f4d46f678b4e5d68d8e4294f87fc5e8b9238cc4de7c5727e8d65943
   tsort (0.2.0) sha256=9650a793f6859a43b6641671278f79cfead60ac714148aabe4e3f0060480089f

data/README.md

@@ -6,10 +6,11 @@
 
 > The cure for all your standup woes.
 
-A highly customizable and automated way to keep track of daily standups in
-markdown files.
+An automated, customizable way to keep track of daily standups in markdown
+files.
 
-You can view the documentation [here](https://evanthegrayt.github.io/standup_md/).
+You can view the documentation
+[here](https://evanthegrayt.github.io/standup_md/).
 
 ## About
 I've now been at two separate companies where we post our daily standups in a
@@ -43,7 +44,7 @@ gem install standup_md
 To include in your project, add the following to your `Gemfile`.
 
 ```ruby
-gem 'standup_md'
+gem "standup_md"
 ```
 
 ### Manual Installation
@@ -73,6 +74,14 @@ important; you may add new entries, but don't change any of the headers. Doing
 so will cause the parser to break. If you want to customize the headers, you can
 do so in the [configuration file](#available-config-file-options-and-defaults).
 
+To open a previous month's standup file, pass the date as an argument. Both
+`YYYY-MM` and `YYYY-MM-DD` are accepted, and both open the file for that month.
+
+```sh
+standup 2026-06
+standup 2026-06-18
+```
+
 ### CLI Examples
 #### Adding an entry for today via editor
 For example, if the standup entry from yesterday reads as follows:
@@ -150,36 +159,36 @@ rails project, create an initializer (`config/initializers/standup_md.rb`).
 StandupMD.configure do |c|
   # Defaults for how the file is formatted.
   # See https://evanthegrayt.github.io/standup_md/doc/StandupMD/Config/Cli.html
-  c.file.header_date_format = '%Y-%m-%d'
+  c.file.header_date_format = "%Y-%m-%d"
   c.file.header_depth       = 1
   c.file.sub_header_depth   = 2
-  c.file.current_header     = 'Current'
-  c.file.previous_header    = 'Previous'
-  c.file.impediments_header = 'Impediments'
-  c.file.notes_header       = 'Notes'
+  c.file.current_header     = "Current"
+  c.file.previous_header    = "Previous"
+  c.file.impediments_header = "Impediments"
+  c.file.notes_header       = "Notes"
   c.file.sub_header_order   = %w[previous current impediments notes]
-  c.file.directory          = ::File.join(ENV['HOME'], '.cache', 'standup_md')
-  c.file.bullet_character   = '-'
-  c.file.name_format        = '%Y_%m.md'
+  c.file.directory          = ::File.join(ENV["HOME"], ".cache", "standup_md")
+  c.file.bullet_character   = "-"
+  c.file.name_format        = "%Y_%m.md"
   c.file.create             = true
 
-  # Defaults for entries
+  # Defaults for entries.
   # See https://evanthegrayt.github.io/standup_md/doc/StandupMD/Config/Entry.html
   c.entry.current          = ["<!-- ADD TODAY'S WORK HERE -->"]
   c.entry.previous         = []
-  c.entry.impediments      = ['None']
+  c.entry.impediments      = ["None"]
   c.entry.notes            = []
 
   # Defaults for executable runtime behavior.
   # See https://evanthegrayt.github.io/standup_md/doc/StandupMD/Config/Cli.html
   c.cli.date               = Date.today
-  c.cli.editor             = 'vim' # Checks $VISUAL and $EDITOR first, in that order
+  c.cli.editor             = "vim" # Checks $VISUAL and $EDITOR first, in that order
   c.cli.verbose            = false
   c.cli.edit               = true
   c.cli.write              = true
   c.cli.print              = false
   c.cli.auto_fill_previous = true
-  c.cli.preference_file    = ::File.expand_path(::File.join(ENV['HOME'], '.standuprc'))
+  c.cli.preference_file    = ::File.expand_path(::File.join(ENV["HOME"], ".standuprc"))
 end
 ```
 
@@ -250,11 +259,11 @@ Your `~/.standuprc` should contain:
 StandupMD.configure do |c|
   c.file.header_depth       = 2
   c.file.sub_header_depth   = 3
-  c.file.current_header     = 'Today'
-  c.file.previous_header    = 'Yesterday'
-  c.file.impediments_header = 'Hold-ups'
-  c.file.bullet_character   = '*'
-  c.file.header_date_format = '%m/%d/%Y'
+  c.file.current_header     = "Today"
+  c.file.previous_header    = "Yesterday"
+  c.file.impediments_header = "Hold-ups"
+  c.file.bullet_character   = "*"
+  c.file.header_date_format = "%m/%d/%Y"
   c.file.sub_header_order   = %w[current previous impediments notes]
 end
 ```
@@ -270,14 +279,14 @@ new entry via code could look like the following:
 ### API Examples
 #### Adding an entry for today
 ```ruby
-require 'standup_md'
+require "standup_md"
 
 StandupMD.configure do |c|
-  c.file.current_header = 'Today',
+  c.file.current_header = "Today",
 end
 
 file = StandupMD::File.find_by_date(Date.today)
-entry = StandupMD::Entry.create { |e| e.current = ['Stuff I will do today'] }
+entry = StandupMD::Entry.create { |e| e.current = ["Stuff I will do today"] }
 file.entries << entry
 file.write
 ```
@@ -286,11 +295,11 @@ The above example was written as such to show how the different pieces of the
 API fit together. The code can actually be simplified to the following.
 
 ```ruby
-require 'standup_md'
+require "standup_md"
 
 StandupMD.configure do |c|
-  c.file.current_header = 'Today',
-  c.entry.current = ['Stuff I will do today']
+  c.file.current_header = "Today",
+  c.entry.current = ["Stuff I will do today"]
 end
 
 StandupMD::File.find_by_date(Date.today).load.write
@@ -298,7 +307,7 @@ StandupMD::File.find_by_date(Date.today).load.write
 
 #### Finding a past entry
 ```ruby
-require 'standup_md'
+require "standup_md"
 
 date = Date.new(2020, 04, 15)
 file = StandupMD::File.find_by_date(date).load

data/Rakefile

@@ -39,3 +39,48 @@ task :"standard:fix" do
 end
 
 task default: :test
+
+namespace :version do
+  desc "Print the current version from the version.rb file"
+  task :current do
+    puts StandupMD::VERSION
+  end
+
+  namespace :increment do
+    desc "Increment the version's PATCH level"
+    task :patch do
+      File.join(__dir__, "lib", "standup_md", "version.rb").then do |version_file|
+        File.write(
+          version_file,
+          File.read(version_file).sub(/(PATCH\s=\s)(\d+)/) { "#{$1}#{$2.next}" }
+        )
+      end
+      system("bundle lock")
+    end
+    desc "Increment the version's MINOR level"
+    task :minor do
+      File.join(__dir__, "lib", "standup_md", "version.rb").then do |version_file|
+        File.write(
+          version_file,
+          File.read(version_file)
+            .sub(/(PATCH\s=\s)(\d+)/) { "#{$1}0" }
+            .sub(/(MINOR\s=\s)(\d+)/) { "#{$1}#{$2.next}" }
+        )
+      end
+      system("bundle lock")
+    end
+    desc "Increment the version's MAJOR level"
+    task :major do
+      File.join(__dir__, "lib", "standup_md", "version.rb").then do |version_file|
+        File.write(
+          version_file,
+          File.read(version_file)
+            .sub(/(PATCH\s=\s)(\d+)/) { "#{$1}0" }
+            .sub(/(MINOR\s=\s)(\d+)/) { "#{$1}0" }
+            .sub(/(MAJOR\s=\s)(\d+)/) { "#{$1}#{$2.next}" }
+        )
+      end
+      system("bundle lock")
+    end
+  end
+end

data/lib/standup_md/cli/helpers.rb

@@ -115,6 +115,11 @@ module StandupMD
               v.nil? ? Date.today : Date.strptime(v, config.file.header_date_format)
           end
         end.parse!(options)
+        unless options.empty?
+          @file_date_argument = true
+          config.cli.date = parse_file_date(options.shift)
+        end
+        raise OptionParser::InvalidArgument, options.join(" ") unless options.empty?
       end
 
       ##
@@ -123,7 +128,7 @@ module StandupMD
       # @return [StandupMD::Entry]
       def new_entry(file)
         entry = file.entries.find(config.cli.date)
-        return entry unless entry.nil? && config.cli.date == Date.today
+        return entry if read_only? || entry || config.cli.date != Date.today
 
         StandupMD::Entry.new(
           config.cli.date,
@@ -145,6 +150,25 @@ module StandupMD
         prev_entry(file.entries)
       end
 
+      ##
+      # Parses the optional file date argument.
+      #
+      # @param [String] value
+      #
+      # @return [Date]
+      def parse_file_date(value)
+        case value
+        when /\A\d{4}-\d{2}-\d{2}\z/
+          Date.strptime(value, "%Y-%m-%d")
+        when /\A\d{4}-\d{2}\z/
+          Date.strptime(value, "%Y-%m")
+        else
+          raise OptionParser::InvalidArgument, value
+        end
+      rescue ArgumentError
+        raise OptionParser::InvalidArgument, value
+      end
+
       ##
       # The previous entry.
       #

data/lib/standup_md/cli.rb

@@ -29,7 +29,7 @@ module StandupMD
     # Creates an instance of +StandupMD+ and runs what the user requested.
     def self.execute(options = [])
       new(options).tap do |exe|
-        exe.write_file if config.write
+        exe.write_file if exe.write?
         if config.print
           exe.print(exe.entry)
         elsif config.edit
@@ -56,6 +56,14 @@ module StandupMD
     # @return [StandupMD::File]
     attr_reader :file
 
+    ##
+    # Was a file date argument passed?
+    #
+    # @return [Boolean]
+    def file_date_argument?
+      @file_date_argument
+    end
+
     ##
     # Constructor. Sets defaults.
     #
@@ -63,12 +71,13 @@ module StandupMD
     def initialize(options = [], load_config: true)
       @config = self.class.config
       @preference_file_loaded = false
+      @file_date_argument = false
       @options = options
       load_preferences if load_config
       load_runtime_preferences(options)
-      @file = StandupMD::File.find_by_date(@config.date)
-      @file.load
-      @entry = new_entry(@file)
+      @file = find_file
+      @file&.load
+      @entry = @file.nil? ? nil : new_entry(@file)
     end
 
     ##
@@ -110,6 +119,14 @@ module StandupMD
       file.write
     end
 
+    ##
+    # Should the file be written?
+    #
+    # @return [Boolean]
+    def write?
+      !!(@config.write && !read_only? && entry)
+    end
+
     ##
     # Quick access to +Cli.echo+.
     #
@@ -117,5 +134,41 @@ module StandupMD
     def echo(msg)
       self.class.echo(msg)
     end
+
+    private
+
+    ##
+    # Is this a read-only action?
+    #
+    # @return [Boolean]
+    def read_only?
+      @config.print || file_date_argument?
+    end
+
+    ##
+    # Finds the file, avoiding file creation for read-only actions.
+    #
+    # @return [StandupMD::File, nil]
+    def find_file
+      return StandupMD::File.find_by_date(@config.date) unless read_only?
+
+      without_file_creation { StandupMD::File.find_by_date(@config.date) }
+    rescue
+      raise unless @config.print
+
+      nil
+    end
+
+    ##
+    # Temporarily disables file creation while looking for a file.
+    #
+    # @return [StandupMD::File]
+    def without_file_creation
+      original_create = config.file.create
+      config.file.create = false
+      yield
+    ensure
+      config.file.create = original_create
+    end
   end
 end

data/lib/standup_md/version.rb

@@ -21,7 +21,7 @@ module StandupMD
     # Patch version.
     #
     # @return [Integer]
-    PATCH = 15
+    PATCH = 16
 
     ##
     # Version as +[MAJOR, MINOR, PATCH]+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: standup_md
 version: !ruby/object:Gem::Version
-  version: 0.3.15
+  version: 0.3.16
 platform: ruby
 authors:
 - Evan Gray