slack_message 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 858633fd4b83922e886bbec641c0075aab65aa9551d0a268cab9b51e3f3722fc
-  data.tar.gz: 3bc79397b71344abe4b535424d9913ca8a7f37259b4904da43acc0149674a6c6
+  metadata.gz: c5a3275f61d16198e8a8283d22f1258dc9480ad7b66b977b6505fcfe79ef69fd
+  data.tar.gz: 8cf6cdddbfbfcd1cb476aaa6384de6f94a7030fd813bdeef4aeda70e34811d2a
 SHA512:
-  metadata.gz: d8cb6fcfaeeade894cba87671231d49de003917069e597906d53a166a8d2e74a25a1e2f55aaadefbe606b940106f8123afe02b9d820191210bfccd3e8962ce95
-  data.tar.gz: fa49ddfecbd19538bfe91d62f0e7decc88cc52ef42e6d0c880138820671b27d23334dd90fd7a970e080a85221bdbf5b40929e3ee3d6e73db0e039efc1d17acd9
+  metadata.gz: 5a2395b51855660a9eba01115f3dbef9859c554c6365ede4d12c74353e72b117a763c0c526fe211f44b1489281fccb2a8fa3e53cc2883aa8cbc935d932598df8
+  data.tar.gz: af50cc1f1bd0d93124115f34eae72bbe90e9309d79ec862b0a62e4d8b6c7bb0bc5e32e950bc9c7bc86f22fa30787c54d110974dcdd2f320d85b7afc0fb26dcc0

data/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## [Unreleased]
 
+## [1.5.0] - 2021-10-01
+- Added `ol` and `ul` to sections w/ some formatting
+
 ## [1.4.0] - 2021-09-27
 - Moved image to accessory_image to differentiate between the image block
   and the accessory image within a block.

data/README.md

@@ -192,6 +192,18 @@ SlackMessage.post_to('#general') do
 end
 ```
 
+Opinionated Stances
+------------
+
+Slack's API has a lot of options available to you! But this gem takes some
+opinionated stances on how to make use of that API. For instance:
+
+* Unless you request otherwise, text is always rendered using `mrkdwn`. If you
+  want plaintext, you'll need to ask for it.
+* Generally, same goes for the `emoji` flag on almost every text element.
+* It's possible to ask for a `blank_line` in sections, even though that concept
+  isn't real. In this case, a text line containing only an emspace is rendered.
+
 What it Doesn't Do
 ------------
 
@@ -210,6 +222,8 @@ Also, some behaviors that are still planned but not yet added:
 * more of BlockKit's options
 * any interactive elements at all (I don't understand them yet)
 * more interesting return types for your message
+* some way to specify default channel for a given profile (and omit param to post_to)
+* richer text formatting (ul is currently a hack)
 
 Contributing
 ------------

data/lib/slack_message/dsl.rb

@@ -1,6 +1,8 @@
 class SlackMessage::Dsl
   attr_reader :body, :default_section, :custom_bot_name
 
+  EMSPACE = " " # unicode emspace
+
   def initialize
     @body = []
     @default_section = Section.new
@@ -61,6 +63,8 @@ class SlackMessage::Dsl
   def blank_line(*args); default_section.blank_line(*args); end
   def link(*args); default_section.link(*args); end
   def list_item(*args); default_section.list_item(*args); end
+  def ul(*args); default_section.ul(*args); end
+  def ol(*args); default_section.ol(*args); end
 
   # end delegation
 
@@ -106,6 +110,20 @@ class SlackMessage::Dsl
       end
     end
 
+    def ul(elements)
+      raise Arguments, "please pass an array" unless elements.respond_to?(:map)
+      text(
+        elements.map { |text| "#{EMSPACE}• #{text}" }.join("\n")
+      )
+    end
+
+    def ol(elements)
+      raise Arguments, "please pass an array" unless elements.respond_to?(:map)
+      text(
+        elements.map.with_index(1) { |text, idx| "#{EMSPACE}#{idx}. #{text}" }.join("\n")
+      )
+    end
+
     # styles:  default, primary, danger
     def link_button(label, target, style: :primary)
       if !@body[:accessory].nil?
@@ -164,7 +182,7 @@ class SlackMessage::Dsl
     end
 
     def blank_line
-      text " " # unicode emspace
+      text EMSPACE
     end
 
     def has_content?

data/slack_message.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name        = 'slack_message'
-  gem.version     = "1.4.0"
+  gem.version     = "1.5.0"
   gem.summary     = "A nice DSL for composing rich messages in Slack"
   gem.authors     = ["Joe Mastey"]
   gem.email       = 'hello@joemastey.com'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack_message
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Joe Mastey
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-27 00:00:00.000000000 Z
+date: 2021-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec