standup_md 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47c9542a3be072fc9067823aeeaf6c41741e657f7c628476cf1811c3699978f0
-  data.tar.gz: 165f18178d4e7038f2c2511e0b7e0e907671c6819f9158fc601c29ebd18ac3be
+  metadata.gz: d76ddd28cf3a01f84583cb1a9a03ac2b4731b0e5f977e400e88bfa382f456582
+  data.tar.gz: a227c637b17cbc82a32b3d98cb0dc2de93c23861c41635049681e489515a87f3
 SHA512:
-  metadata.gz: e56ad3a3e3e633f235af7078708ebb27f1a184cd6a0bd94a1b52299e82de2b75842f169e9495003f26c49907a9f0eb9b5c8d52511bf6cc39e1978f60848a2ca8
-  data.tar.gz: 043a1a0119e0921196840fae06143f33a87dbbe4e9b62c381c671defd1695c6e1d5694174872a15932b63c42119dd19764cff992cd3c0f456220f0c9474d15d6
+  metadata.gz: ebc8045842abc5356997c8fa38f5cff05350946cb854528f68ec88714e15b7853cfbcf1a5c6663dae138de0c26b14ec007fca0c62a11279217b35dcda1ae8af3
+  data.tar.gz: 2eefdcfae08a7e983a0b9d232795ab501b19ada60c159ad7c5c6fbda9956f1b51d4c521f20bf6ab669be1871199376362b5d05303a303b5bcf2802b08193d6cc

data/.ruby-version

@@ -0,0 +1 @@
+4.0.4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    standup_md (2.0.0)
+    standup_md (2.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -49,6 +49,7 @@ GEM
       rubocop (>= 1.75.0, < 2.0)
       rubocop-ast (>= 1.47.1, < 2.0)
     ruby-progressbar (1.13.0)
+    semverve (0.1.0)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -82,6 +83,7 @@ PLATFORMS
 DEPENDENCIES
   rake (~> 13.0, >= 13.0.1)
   rdoc
+  semverve
   simplecov
   standard (~> 1.54.0)
   standup_md!
@@ -109,13 +111,14 @@ CHECKSUMS
   rubocop-ast (1.49.1) sha256=4412f3ee70f6fe4546cc489548e0f6fcf76cafcfa80fa03af67098ffed755035
   rubocop-performance (1.26.1) sha256=cd19b936ff196df85829d264b522fd4f98b6c89ad271fa52744a8c11b8f71834
   ruby-progressbar (1.13.0) sha256=80fc9c47a9b640d6834e0dc7b3c94c9df37f08cb072b7761e4a71e22cff29b33
+  semverve (0.1.0) sha256=cda51f2cc148af0a163ac5b25616ff3c3d20fc5aa9f036a7f2910e20ee3058b6
   simplecov (0.22.0) sha256=fe2622c7834ff23b98066bb0a854284b2729a569ac659f82621fc22ef36213a5
   simplecov-html (0.13.2) sha256=bd0b8e54e7c2d7685927e8d6286466359b6f16b18cb0df47b508e8d73c777246
   simplecov_json_formatter (0.1.4) sha256=529418fbe8de1713ac2b2d612aa3daa56d316975d307244399fa4838c601b428
   standard (1.54.0) sha256=7a4b08f83d9893083c8f03bc486f0feeb6a84d48233b40829c03ef4767ea0100
   standard-custom (1.0.2) sha256=424adc84179a074f1a2a309bb9cf7cd6bfdb2b6541f20c6bf9436c0ba22a652b
   standard-performance (1.9.0) sha256=49483d31be448292951d80e5e67cdcb576c2502103c7b40aec6f1b6e9c88e3f2
-  standup_md (2.0.0)
+  standup_md (2.1.0)
   stringio (3.2.0) sha256=c37cb2e58b4ffbd33fe5cd948c05934af997b36e0b6ca6fdf43afa234cf222e1
   test-unit (3.7.8) sha256=689d1ca53f4d46f678b4e5d68d8e4294f87fc5e8b9238cc4de7c5727e8d65943
   tsort (0.2.0) sha256=9650a793f6859a43b6641671278f79cfead60ac714148aabe4e3f0060480089f

data/README.md

@@ -1,8 +1,8 @@
 # The Standup Doctor
 <!-- vi: set ts=4 sw=4 : -->
 [![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fevanthegrayt%2Fstandup_md%2Fbadge%3Fref%3Dmaster&style=flat)](https://actions-badge.atrox.dev/evanthegrayt/standup_md/goto?ref=master)
+[![Language: Ruby](https://img.shields.io/static/v1?label=language&message=Ruby&color=CC342D&style=flat&logo=ruby&logoColor=CC342D)](https://www.ruby-lang.org/)
 [![Gem Version](https://img.shields.io/gem/v/standup_md.svg)](https://rubygems.org/gems/standup_md)
-![Language: Ruby](https://img.shields.io/static/v1?label=language&message=Ruby&color=CC342D&style=flat&logo=ruby&logoColor=CC342D)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 > The cure for all your standup woes.
@@ -19,7 +19,8 @@ client, such as Slack, Mattermost, or Riot. Typing out my standup every day
 became tedious, as I'd have to look up what I did the day before, copy and paste
 yesterday's work into a new entry, and add today's tasks. This gem automates
 most of this process, along with providing means of opening the file in your
-editor, and finding and displaying entries from the command line.
+editor, finding and displaying entries from the command line, and posting
+today's standup directly to a chat client.
 
 In a nutshell, calling `standup` from the command line will open a standup file
 for the current month in your preferred editor. If an entry for today is already
@@ -125,6 +126,13 @@ file:
 - None
 ```
 
+Impediments are not carried forward by default. To copy the previous entry's
+impediments into a new entry, pass `-i` or `--carry-forward-impediments`.
+
+```sh
+standup -i
+```
+
 #### Copy the entry for today to clipboard
 There are also flags that will print entries to the command line. There's a full
 list of features below, but as a quick example, you can copy today's entry to
@@ -219,6 +227,7 @@ StandupMD.configure do |c|
   c.cli.post_adapter       = nil
   c.cli.post_channel       = nil
   c.cli.auto_fill_previous = true
+  c.cli.carry_forward_impediments = false
   c.cli.preference_file    = ::File.expand_path(::File.join(ENV["HOME"], ".standuprc"))
 
   # Defaults for posting standups to chat clients.
@@ -251,6 +260,8 @@ follows.
 -d, --directory DIRECTORY      The directory where standup files are located
 -w, --[no-]write               Write current entry if it doesn't exist. Default is true
 -a, --[no-]auto-fill-previous  Auto-generate 'previous' tasks for new entries
+-i, --[no-]carry-forward-impediments
+                               Carry impediments forward for new entries
 -e, --[no-]edit                Open the file in the editor. Default is true
 -v, --[no-]verbose             Verbose output. Default is false.
     --zsh-completion           Print zsh completion setup instructions
@@ -263,6 +274,9 @@ follows.
 ```
 
 #### Posting and Secrets
+For a real-world example of how to get the Slack integration working, see [the
+guide](SLACK_SETUP_GUIDE.md).
+
 The built-in Slack adapter sends the rendered markdown entry to Slack's
 `chat.postMessage` API. It needs a Slack token with the `chat:write` scope and a
 channel or conversation. Channel-like IDs such as `C123456`, `G123456`, and
@@ -426,11 +440,11 @@ markdown = parser.render(entries, start_date: entries.first.date, end_date: entr
 runtime = StandupMD.config.copy
 runtime.file.directory = "/tmp/request-standups"
 runtime.entry.current = ["Work scoped to this request"]
+runtime.cli.carry_forward_impediments = true
 
-file = StandupMD::File.find_by_date(Date.today, config: runtime.file).load
-entry = StandupMD::Entry.create(config: runtime.entry)
-file.entries << entry
-file.write
+cli = StandupMD::Cli.new(["--no-edit"], config: runtime)
+entry = cli.entry
+cli.write_file
 ```
 
 ### API Examples
@@ -505,14 +519,10 @@ g:standup_dir = $HOME . '/.cache/standup_md' " the directory where your files ar
 g:standup_file = strftime('%Y_%m.md')        " the file format to use
 ```
 
-## Reporting Bugs and Requesting Features
-If you have an idea or find a bug, please [create an
-issue](https://github.com/evanthegrayt/standup_md/issues/new). Just make sure
-the topic doesn't already exist. Better yet, you can always submit a Pull
-Request.
-
-## Self-Promotion
-I do these projects for fun, and I enjoy knowing that they're helpful to people.
-Consider starring [the repository](https://github.com/evanthegrayt/standup_md)
-if you like it! If you love it, follow me [on
-Github](https://github.com/evanthegrayt)!
+## Support this project
+I love knowing when people find my work useful. Any kind of support is very much
+appreciated!
+
+- ⭐️ Like the project? Star [the repository](https://github.com/evanthegrayt/standup_md)!
+- ❤️ Love the project? Follow me [on GitHub](https://github.com/evanthegrayt)!
+- 💸 *Really* love it? Consider [buying me a tea](https://paypal.me/evanrgray)!

data/Rakefile

@@ -2,13 +2,18 @@
 
 $LOAD_PATH.unshift(File.expand_path("lib", __dir__))
 
-require "standup_md"
 require "bundler/gem_tasks"
 require "rdoc/task"
 require "rake/testtask"
+require "semverve/task"
+require "standup_md"
 
 STANDARD_FILES = ["lib", "test"].freeze
 
+Semverve::Task.new do |t|
+  t.bundle_lock = true
+end
+
 Rake::TestTask.new do |t|
   t.libs = ["lib"]
   t.warning = true
@@ -22,6 +27,8 @@ RDoc::Task.new do |rdoc|
   rdoc.rdoc_files.include("README.md", "lib/**/*.rb")
 end
 
+task default: :test
+
 desc "Lint with the Standard Ruby style guide"
 task :standard do
   require "standard"
@@ -37,50 +44,3 @@ task :"standard:fix" do
   exit_code = Standard::Cli.new(STANDARD_FILES + ["--fix"]).run
   fail unless exit_code.zero?
 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/SLACK_SETUP_GUIDE.md

@@ -0,0 +1,82 @@
+# Slack Setup for StandupMD Posting
+
+## Summary
+Create a private Slack app for your workspace, give its bot permission to post
+messages, install it, copy the bot token, invite the bot to `#general`, and
+configure StandupMD with the bot token plus the channel ID.
+
+Workflow last tested and validated 2026-06-27.
+
+## Assumptions
+- You only need to post your standup into one Slack channel.
+- The app is just for your own workspace, not a public Slack Marketplace app.
+- `chat:write` plus inviting the bot to `#general` is the preferred setup.
+- `chat:write.public` is not needed unless you want posting to public channels
+  without inviting the bot first.
+
+## Exact Slack Steps
+1. From the screen in your screenshot, click **Create an App**.
+2. Choose **From scratch**.
+3. Set:
+   - **App Name:** `StandupMD`
+   - **Pick a workspace:** choose the workspace where `#general` lives
+4. Click **Create App**.
+5. In the app sidebar, go to **OAuth & Permissions**.
+6. Under **Scopes** → **Bot Token Scopes**, add:
+   - `chat:write`
+7. Optional: add `chat:write.public` only if you want the bot to post to public
+   channels without being invited first. For the simplest and safest setup, skip
+   this and invite the bot to the channel.
+8. Scroll up and click **Install to Workspace**.
+9. Approve the installation.
+10. After installation, stay on **OAuth & Permissions** and copy the **Bot User
+    OAuth Token**.
+    - It should start with `xoxb-`.
+    - Do not use an `xoxp-` user token.
+    - Do not use an app configuration token.
+
+## Channel Setup
+1. In Slack, go to `#general`.
+2. Invite the app/bot:
+   ```text
+   /invite @StandupMD
+   ```
+3. Get the channel ID for `#general`.
+   - Open `#general`.
+   - Click the channel name at the top.
+   - Look for **Copy channel ID** in the details or more/options menu.
+   - The ID should look like `C1234567890`.
+
+Prefer using the channel ID over `#general` when configuring StandupMD, as the
+name can change but the ID won't.
+
+## StandupMD Values
+Set your token in the shell:
+
+```sh
+export STANDUP_MD_SLACK_TOKEN="xoxb-your-bot-token"
+```
+
+Post with the channel ID:
+
+```sh
+standup -P slack --post-channel C1234567890
+```
+
+Optional config in `~/.standuprc`:
+
+```ruby
+StandupMD.configure do |c|
+  c.post.configure_adapter(:slack, channel: "C1234567890")
+  c.post.title = "%s -- YOUR NAME"
+end
+```
+
+Then you can run:
+
+```sh
+standup -P
+```
+
+If you have multiple users using the same bot, the `c.post.title` is important
+to specify the user posting the standup, since the bot's name is `StandupMD`.

data/completion/zsh/_standup

@@ -66,6 +66,8 @@ _arguments -s -S \
   '(-w --write --no-write)--no-write[do not write current entry if it does not exist]' \
   '(-a --auto-fill-previous --no-auto-fill-previous)'{-a,--auto-fill-previous}'[auto-generate previous tasks for new entries]' \
   '(-a --auto-fill-previous --no-auto-fill-previous)--no-auto-fill-previous[do not auto-generate previous tasks for new entries]' \
+  '(-i --carry-forward-impediments --no-carry-forward-impediments)'{-i,--carry-forward-impediments}'[carry impediments forward for new entries]' \
+  '(-i --carry-forward-impediments --no-carry-forward-impediments)--no-carry-forward-impediments[do not carry impediments forward for new entries]' \
   '(-e --edit --no-edit)'{-e,--edit}'[open the file in the editor]' \
   '(-e --edit --no-edit)--no-edit[do not open the file in the editor]' \
   '(-v --verbose --no-verbose)'{-v,--verbose}'[use verbose output]' \

data/lib/standup_md/cli/helpers.rb

@@ -61,7 +61,10 @@ module StandupMD
           opts.on(
             "--current ARRAY", Array,
             "List of current entry's tasks"
-          ) { |v| config.entry.current = v }
+          ) do |v|
+            @current_option_passed = true
+            config.entry.current = v
+          end
 
           opts.on(
             "--previous ARRAY", Array,
@@ -98,6 +101,11 @@ module StandupMD
             "Auto-generate 'previous' tasks for new entries. Default is true"
           ) { |v| config.cli.auto_fill_previous = v }
 
+          opts.on(
+            "-i", "--[no-]carry-forward-impediments",
+            "Carry impediments forward for new entries. Default is false"
+          ) { |v| config.cli.carry_forward_impediments = v }
+
           opts.on(
             "-e", "--[no-]edit",
             "Open the file in the editor. Default is true"
@@ -157,13 +165,17 @@ module StandupMD
       # @return [StandupMD::Entry]
       def new_entry(file)
         entry = file.entries.find(config.cli.date)
-        return entry if read_only? || entry || config.cli.date != Date.today
+        return entry if read_only? || config.cli.date != Date.today
+        if entry
+          append_current_entry(entry) if current_option_passed?
+          return entry
+        end
 
         StandupMD::Entry.new(
           config.cli.date,
           config.entry.current,
           previous_entry(file),
-          config.entry.impediments,
+          impediments_entry(file),
           config.entry.notes
         ).tap { |e| file.entries << e }
       end
@@ -174,12 +186,29 @@ module StandupMD
       # @return [Array]
       def previous_entry(file)
         return config.entry.previous unless config.cli.auto_fill_previous
-        if file.new?
-          previous_file = prev_file_exists?
-          return prev_entry_tasks(previous_file.load.entries) if previous_file
+
+        carry_forward_tasks(file, fallback: []) { |entry| entry.current_tasks }
+      end
+
+      ##
+      # The "impediments" tasks.
+      #
+      # @return [Array]
+      def impediments_entry(file)
+        return config.entry.impediments unless config.cli.carry_forward_impediments
+
+        carry_forward_tasks(file, fallback: config.entry.impediments) do |entry|
+          entry.impediments_tasks
         end
+      end
+
+      def append_current_entry(entry)
+        current = entry.section(:current)
+        config.entry.current.each { |task| current << task }
+      end
 
-        prev_entry_tasks(file.entries)
+      def current_option_passed?
+        @current_option_passed
       end
 
       ##
@@ -201,14 +230,19 @@ module StandupMD
         raise OptionParser::InvalidArgument, value
       end
 
-      ##
-      # The previous entry's current tasks.
-      #
-      # @param [StandupMD::EntryList] entries
-      #
-      # @return [Array<StandupMD::Task>]
-      def prev_entry_tasks(entries)
-        entries.empty? ? [] : entries.last.current_tasks
+      def carry_forward_tasks(file, fallback:)
+        entry = carry_forward_entry(file)
+        entry.nil? ? fallback : yield(entry)
+      end
+
+      def carry_forward_entry(file)
+        carry_forward_entries(file).last
+      end
+
+      def carry_forward_entries(file)
+        return file.entries unless file.new?
+
+        find_previous_month_file&.load&.entries || file.entries
       end
 
       ##
@@ -217,14 +251,27 @@ module StandupMD
       # @param [StandupMD::Config::File] config
       #
       # @return [StandupMD::File]
-      def prev_file(config: self.config.file)
+      def previous_month_file(config: self.config.file)
         StandupMD::File.find_by_date(Date.today.prev_month, config: config)
       end
 
-      def prev_file_exists?
-        without_file_creation { |file_config| prev_file(config: file_config) }
-      rescue StandupMD::File::NotFoundError
-        nil
+      def previous_month_file?
+        ::File.file?(previous_month_file_path)
+      end
+
+      def find_previous_month_file
+        return nil unless previous_month_file?
+
+        without_file_creation do |file_config|
+          previous_month_file(config: file_config)
+        end
+      end
+
+      def previous_month_file_path
+        ::File.join(
+          config.file.directory,
+          Date.today.prev_month.strftime(config.file.name_format)
+        )
       end
 
       ##

data/lib/standup_md/cli.rb

@@ -127,16 +127,21 @@ module StandupMD
     # Constructor. Sets defaults.
     #
     # @param [Array] options
-    def initialize(options = [], load_config: true)
+    #
+    # @param [Boolean] load_config
+    #
+    # @param [StandupMD::Config, nil] config
+    def initialize(options = [], load_config: true, config: nil)
       @config = nil
       @preference_file_loaded = false
       @file_date_argument = false
+      @current_option_passed = false
       @zsh_completion_requested = false
       @options = options
       return if load_zsh_completion_request(options)
 
-      load_preferences if load_config
-      @config = StandupMD.config.copy
+      load_preferences if load_config && config.nil?
+      @config = config.nil? ? StandupMD.config.copy : config.copy
       load_runtime_preferences(options)
       return if zsh_completion_requested?
 

data/lib/standup_md/config/cli.rb

@@ -22,6 +22,7 @@ module StandupMD
         post_adapter: nil,
         post_channel: nil,
         auto_fill_previous: true,
+        carry_forward_impediments: false,
         preference_file: ::File.expand_path(
           ::File.join(ENV["HOME"], ".standuprc")
         )
@@ -123,6 +124,15 @@ module StandupMD
       # @return [Boolean]
       attr_accessor :auto_fill_previous
 
+      ##
+      # When writing a new entry, should impediments be pulled from the last
+      # entry?
+      #
+      # @param [Boolean] carry_forward_impediments
+      #
+      # @return [Boolean]
+      attr_accessor :carry_forward_impediments
+
       ##
       # Initializes the config with default values.
       def initialize

data/lib/standup_md/version.rb

@@ -15,7 +15,7 @@ module StandupMD
     # Minor version.
     #
     # @return [Integer]
-    MINOR = 0
+    MINOR = 1
 
     ##
     # Patch version.

data/standup_md.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.add_development_dependency "rake", "~> 13.0", ">= 13.0.1"
   spec.add_development_dependency "rdoc"
+  spec.add_development_dependency "semverve"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "standard", "~> 1.54.0"
   spec.add_development_dependency "test-unit", "~> 3.3", ">= 3.3.5"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: standup_md
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Evan Gray
@@ -43,6 +43,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: semverve
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -100,11 +114,13 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
+- ".ruby-version"
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
+- SLACK_SETUP_GUIDE.md
 - _config.yml
 - bin/standup
 - completion/zsh/_standup