standup_md 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47c9542a3be072fc9067823aeeaf6c41741e657f7c628476cf1811c3699978f0
-  data.tar.gz: 165f18178d4e7038f2c2511e0b7e0e907671c6819f9158fc601c29ebd18ac3be
+  metadata.gz: d5b3c3f8fe55eadcdc0ae76de9cb745bfe0c557c2c715884fd1056403fba31f1
+  data.tar.gz: d7191750ade93198d7a432762eb3327425a0dcb632389dc90ba6216735b941f2
 SHA512:
-  metadata.gz: e56ad3a3e3e633f235af7078708ebb27f1a184cd6a0bd94a1b52299e82de2b75842f169e9495003f26c49907a9f0eb9b5c8d52511bf6cc39e1978f60848a2ca8
-  data.tar.gz: 043a1a0119e0921196840fae06143f33a87dbbe4e9b62c381c671defd1695c6e1d5694174872a15932b63c42119dd19764cff992cd3c0f456220f0c9474d15d6
+  metadata.gz: 1cc3f477255e687f122e018ce1e4d31e6ca0ca7d9c16a003c463324230e68e528a97fc08a52194fa98965ae9ca82bfd963d0343f3b38f12526b5f8bb276b832b
+  data.tar.gz: c0291b6fabd240ac6b292b4e97c2e5c97ed74afd8675b0274295129625326b94ae2a866ff1dabf89a5e91678537b09b572ab677cc6c87bdbb80d8a2e6e36d401

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    standup_md (2.0.0)
+    standup_md (2.0.1)
 
 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 (2.0.0)
+  standup_md (2.0.1)
   stringio (3.2.0) sha256=c37cb2e58b4ffbd33fe5cd948c05934af997b36e0b6ca6fdf43afa234cf222e1
   test-unit (3.7.8) sha256=689d1ca53f4d46f678b4e5d68d8e4294f87fc5e8b9238cc4de7c5727e8d65943
   tsort (0.2.0) sha256=9650a793f6859a43b6641671278f79cfead60ac714148aabe4e3f0060480089f

data/README.md

@@ -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
@@ -263,6 +264,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
@@ -505,14 +509,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/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/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,
@@ -157,7 +160,11 @@ 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,
@@ -182,6 +189,15 @@ module StandupMD
         prev_entry_tasks(file.entries)
       end
 
+      def append_current_entry(entry)
+        current = entry.section(:current)
+        config.entry.current.each { |task| current << task }
+      end
+
+      def current_option_passed?
+        @current_option_passed
+      end
+
       ##
       # Parses the optional file date argument.
       #

data/lib/standup_md/cli.rb

@@ -131,6 +131,7 @@ module StandupMD
       @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)

data/lib/standup_md/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: standup_md
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Evan Gray
@@ -105,6 +105,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- SLACK_SETUP_GUIDE.md
 - _config.yml
 - bin/standup
 - completion/zsh/_standup