slack_progress_bar 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e51319bfad1449d02de2bb1bf0cf42667d6ef61493a08e71bc3091cc893482cc
+  data.tar.gz: e9abfed3a6fdcb1004226926732f51cfd857d0dcb98211cf7076021b490b701b
+SHA512:
+  metadata.gz: 408b6e327c38a008aceb3a28024e76ca9da1c87eb80fbda7e2b3832e23b38d340c32a8e653e29b32d01a2d61962d994577103a5fd009c34a4dba2d21d4ceb47c
+  data.tar.gz: 28611fa55290eed2374251d8f71e1db9c6388dc3a790406fe9571337ea6b10d6c78121e3c222047da29d8bfc538f0393ce3ac6dff7a6fec94c8a795eee4bfc9a

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: [laserlemon]

data/.github/workflows/rake.yml

@@ -0,0 +1,31 @@
+name: Rake
+on:
+  push:
+    branches:
+    - main
+  pull_request:
+    branches:
+    - main
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version:
+        - "2.6"
+        - "2.7"
+        - "3.0"
+        - head
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Install ImageMagick
+      run: |
+        sudo apt-get install imagemagick
+        convert -version
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,47 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Layout/ArgumentAlignment:
+  Enabled: true
+  EnforcedStyle: with_fixed_indentation
+
+Layout/LineLength:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Metrics:
+  Enabled: false
+
+Naming/RescuedExceptionsVariableName:
+  Enabled: true
+  PreferredName: error
+
+Style/BlockDelimiters:
+  Enabled: true
+  Exclude:
+    - "spec/**/*_spec.rb"
+
+Style/Documentation:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: comma

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at steve.richert@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rqrcode", "~> 2.0"
+gem "rspec", "~> 3.10"
+gem "rubocop", "~> 1.17.0"
+gem "rubocop-rake", "~> 0.5.1"
+gem "rubocop-rspec", "~> 2.4.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Steve Richert
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,246 @@
+# Slack Progress Bar<br><img src="https://user-images.githubusercontent.com/34264/125970661-b3229a24-439c-43e5-9108-97f46a2c47a6.png" alt="Progress bar preview" width="404" height="20" aria-hidden="true">
+
+Create _beautiful_ progress bars for Slack using **emoji**!
+
+Slack Progress Bar is a Ruby library capable of [generating a progress bar](https://github.com/laserlemon/slack_progress_bar/blob/main/README.md#generating-a-progress-bar) made with Slack emoji. The library can also [generate the emoji](https://github.com/laserlemon/slack_progress_bar/blob/main/README.md#generating-the-emoji) images that you'll need in your Slack workspace.
+
+[Try it out!](https://laserlemon.github.io/slack_progress_bar)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "slack_progress_bar"
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install slack_progress_bar
+```
+
+## Usage
+
+### Configuration
+
+The library uses default colors based on the [GitHub Primer color system](https://primer.style/css/support/color-system) that allow you to hit the ground running without any in-app configuration. 
+
+| Alias | Letter | Hex value | Preview |
+|:--- |:---:|:--- |:---:|
+| `purple` | `p` | `6f42c1ff` | <img src="https://user-images.githubusercontent.com/34264/125973904-b82923e7-9457-4d47-9e38-70c36ab3f07f.png" width="20" height="20"> |
+| `blue` | `b` | `0366d6ff` | <img src="https://user-images.githubusercontent.com/34264/125973900-f3faa84f-d7de-4102-b39e-6e5d12a443ed.png" width="20" height="20"> |
+| `green` | `g` | `28a745ff` | <img src="https://user-images.githubusercontent.com/34264/125973902-74679045-0d94-4b41-81e4-56275207d97d.png" width="20" height="20"> |
+| `yellow` | `y` | `ffd33dff` | <img src="https://user-images.githubusercontent.com/34264/125973907-2d615a1f-1016-40c6-9061-3f6243527869.png" width="20" height="20"> |
+| `orange` | `o` | `f66a0aff` | <img src="https://user-images.githubusercontent.com/34264/125973903-25daa839-16b1-43e8-91a3-7f4a134aa341.png" width="20" height="20"> |
+| `red` | `r` | `d73a49ff` | <img src="https://user-images.githubusercontent.com/34264/125973905-2708f63c-1783-4daf-af23-da115e2612c9.png" width="20" height="20"> |
+| `white` | `w` | `959da544` | <img src="https://user-images.githubusercontent.com/34264/125973906-c2a9dcf2-f009-4aa7-b303-529b7a24aa0f.png" width="20" height="20"> |
+
+You can configure color naming and sequence in a Rails initializer or any other Ruby configuration file:
+
+```ruby
+SlackProgressBar.configure do |config|
+  # These one-character color names are used in emoji image filenames.
+  # The last color configured here is the default and is used to fill the remainder of a progress bar.
+  config.letters = ["r", "g", "b", "w"]
+  
+  # Define your own aliases that map to each letter above, useful when generating a progress bar.
+  config.aliases = {
+    red: "r",
+    green: "g",
+    blue: "b",
+    white: "w",
+    deleted: "r",
+    created: "g",
+    updated: "b",
+  }
+end
+```
+
+The default emoji prefix is `pb`. For example, one Slack emoji using the configuration above could be `:pb-rgbw:`. The separator is `-` and isn't configurable. You can customize the prefix to prevent naming collisions. 
+
+```ruby
+SlackProgressBar.configure do |config|
+  # Name emoji like `bar-gggg`.
+  config.prefix = "bar"
+end
+```
+
+### Generating a progress bar
+
+Slack Progress Bar's primary interface for generating a progress bar is the `SlackProgressBar.new` and `SlackProgressBar#.to_s` methods. Examples below will assume default configuration.
+
+By default, Slack Progress Bar generates an empty progress bar with 14 emoji and rounded caps:
+
+```ruby
+bar = SlackProgressBar.new
+puts bar.to_s
+```
+
+```
+:pb-w-a::pb-wwww::pb-wwww::pb-wwww::pb-wwww::pb-wwww::pb-wwww::pb-wwww::pb-wwww::pb-wwww::pb-wwww::pb-wwww::pb-wwww::pb-w-z:
+```
+
+<img src="https://user-images.githubusercontent.com/34264/125977880-a36c14e0-3d7c-4891-a94f-0b024e3433a1.png" width="404" height="20">
+
+But most folks want to show some, well… progress!
+
+```ruby
+bar = SlackProgressBar.new(counts: { blue: 3, green: 2, red: 1 })
+puts bar.to_s
+```
+
+```
+:pb-b-a::pb-bbbb::pb-bbbb::pb-bbbb::pb-bbbb::pb-bbbb::pb-bbbb::pb-gggg::pb-gggg::pb-gggg::pb-gggg::pb-rrrr::pb-rrrr::pb-r-z:
+```
+
+<img src="https://user-images.githubusercontent.com/34264/125979277-f59e926c-2fc2-4192-9bc1-6e36b28b6f13.png" width="404" height="20">
+
+And if you want to indicate that progress is not yet finished:
+
+```ruby
+# Equivalent to: SlackProgressBar.new(counts: { blue: 3, green: 2, red: 1, white: 4 })
+bar = SlackProgressBar.new(counts: { blue: 3, green: 2, red: 1 }, total: 10)
+puts bar.to_s
+```
+
+```
+:pb-b-a::pb-bbbb::pb-bbbb::pb-bbbb::pb-bbgg::pb-gggg::pb-gggg::pb-rrrr::pb-rwww::pb-wwww::pb-wwww::pb-wwww::pb-wwww::pb-w-z:
+```
+
+<img src="https://user-images.githubusercontent.com/34264/125979830-ccc02bba-a85c-4509-957b-3dd234500448.png" width="404" height="20">
+
+You can also change the size (in emoji) of the progress bar from its default of 14:
+
+```ruby
+bar = SlackProgressBar.new(counts: { blue: 3, green: 2, red: 1 }, total: 10, size: 10)
+puts bar.to_s
+```
+
+```
+:pb-b-a::pb-bbbb::pb-bbbb::pb-bggg::pb-gggg::pb-rrrw::pb-wwww::pb-wwww::pb-wwww::pb-w-z:
+```
+
+<img src="https://user-images.githubusercontent.com/34264/125980287-0093d19f-0ed8-4558-9765-8d2cde706138.png" width="276" height="20">
+
+Finally, you can choose to generate your progress bar with square caps:
+
+```ruby
+bar = SlackProgressBar.new(counts: { blue: 3, green: 2, red: 1 }, total: 10, size: 10, rounded: false)
+puts bar.to_s
+```
+
+```
+:pb-bbbb::pb-bbbb::pb-bbbb::pb-gggg::pb-gggg::pb-rrrr::pb-wwww::pb-wwww::pb-wwww::pb-wwww:
+```
+
+<img src="https://user-images.githubusercontent.com/34264/125980701-f9d8a08c-d19a-424d-9198-f18ecbbd0c8d.png" width="320" height="20">
+
+### Generating the emoji
+
+The observent reader will notice that `SlackProgressBar#to_s` (above) only generates a string. For Slack to render your beautiful progress bar, you'll need to generate and upload beautiful Slack emoji images! The `slack_progress_bar` gem comes with a `slack_progress_bar` command line interface and we'll use the `slack_progress_bar generate` command to create all the images you'll need.
+
+For the default configuration, run `slack_progress_bar generate` with no arguments. Images will be created in your current working directory.
+
+```bash
+slack_progress_bar generate
+```
+
+The default configuration generates 233 images, which need to be uploaded to your Slack workspace. As of this writing, there is no API available to automate this manual process! 😅 You can reduce the number of images required by reducing the number of colors in your configuration:
+
+```bash
+slack_progress_bar generate --colors r:d73a49ff g:28a745ff b:0366d6ff w:959da544
+```
+
+The command above, configured for four colors, will generate only 49 images. Use the table below to help determine how many colors you're willing to support:
+
+| Colors | Images |
+| ---:| ---:|
+| 2 | 12 |
+| 3 | 25 |
+| 4 | 48 |
+| 5 | 86 |
+| 6 | 145 |
+| 7 | 232 |
+
+When generating your images, each color you configure contains eight hex digits. The first six are RGB and the last two are alpha transparency. You can experiment with different colors and progress bar styles below:
+
+### 🛠️ [Slack Progress Bar Sandbox](https://laserlemon.github.io/slack_progress_bar)
+
+## Questions
+
+### How does it work?
+
+Slack Progress Bar works in two steps. First it performs the one-time process of generating 128px square emoji images. Once those are uploaded to your Slack workspace, it references the names of those emoji to generate beautiful progress bars.
+
+### What's the progress bar's granularity?
+
+By default, exactly 2%. That's why the default rounded progress bar size is 14 emoji. Each cap represents a "stripe" and every interior emoji represents four more stripes, for a total of 50 stripes at 2% per stripe. Below is an exploded progress bar to illustrate how the images are combined:
+
+```
+:pb-p-a::pb-bbgg::pb-gyyy::pb-yooo::pb-oooo::pb-orrr::pb-rrrr::pb-rrrr::pb-rwww::pb-wwww::pb-wwww::pb-wwww::pb-wwww::pb-w-z:
+```
+
+<img src="https://user-images.githubusercontent.com/34264/125985441-823e4c2f-379e-49f6-860a-e3d104bd173a.png" width="32" height="32">&nbsp;
+<img src="https://user-images.githubusercontent.com/34264/125985470-67828620-291f-412d-b573-308271dbee5b.png" width="32" height="32">&nbsp;
+<img src="https://user-images.githubusercontent.com/34264/125985517-28bb320f-0a58-4477-89f8-4e40a80eee6f.png" width="32" height="32">&nbsp;
+<img src="https://user-images.githubusercontent.com/34264/125985564-b383037d-a0e8-4612-86c8-a1d9c8699e3c.png" width="32" height="32">&nbsp;
+<img src="https://user-images.githubusercontent.com/34264/125985587-67b4b120-2780-4b5f-be2b-8477c966b71a.png" width="32" height="32">&nbsp;
+<img src="https://user-images.githubusercontent.com/34264/125985616-8a121079-1c3e-4870-9df0-396b11cfbb06.png" width="32" height="32">&nbsp;
+<img src="https://user-images.githubusercontent.com/34264/125985657-7f778bf3-2483-402c-97ee-72bb226c20de.png" width="32" height="32">&nbsp;
+<img src="https://user-images.githubusercontent.com/34264/125985657-7f778bf3-2483-402c-97ee-72bb226c20de.png" width="32" height="32">&nbsp;
+<img src="https://user-images.githubusercontent.com/34264/125985681-00ebfc9b-1caf-409f-966e-d2471fbe78ff.png" width="32" height="32">&nbsp;
+<img src="https://user-images.githubusercontent.com/34264/125985711-afbcff71-f933-4ad3-bc37-e73f5906403b.png" width="32" height="32">&nbsp;
+<img src="https://user-images.githubusercontent.com/34264/125985711-afbcff71-f933-4ad3-bc37-e73f5906403b.png" width="32" height="32">&nbsp;
+<img src="https://user-images.githubusercontent.com/34264/125985711-afbcff71-f933-4ad3-bc37-e73f5906403b.png" width="32" height="32">&nbsp;
+<img src="https://user-images.githubusercontent.com/34264/125985711-afbcff71-f933-4ad3-bc37-e73f5906403b.png" width="32" height="32">&nbsp;
+<img src="https://user-images.githubusercontent.com/34264/125985743-150c8a04-8a90-4cd0-9da3-8614ef17410f.png" width="32" height="32">&nbsp;
+
+### Why not use narrow emoji?
+
+When you use a narrow rectangular emoji in Slack, horizontal margins are added so that it takes up the same amount of space as a square emoji. The result is that you can't position multiple narrow emoji _right_ next to each other. That's why Slack Progress Bar uses perfectly square emoji throughout.
+
+### Can I animate my progress bar?
+
+Sure! Slack's API gives you the ability to [create](https://api.slack.com/messaging/sending) and [update](https://api.slack.com/messaging/modifying) messages. So after you create your initial message with a blank progress bar, you can update that message as frequently as you like with the latest and greatest version of your progress bar.
+
+<img src="https://user-images.githubusercontent.com/34264/125991787-d8c49424-106f-40ea-bf58-985adced4b1b.gif" width="374" height="51">
+
+### Can I change the color order?
+
+Sadly, no. 😢 In an effort to reduce the number of images you need to generate and upload, the order in which colors appear is fixed. For Slack Progress Bar to generate 7-color, _order-flexible_ progress bars, it would need to generate 2,423 images rather than 232! 😱
+
+### Does it have dark mode?
+
+Sure, kind of! Setting alpha transparency for your color configuration gives you some control over how your progress bars look in light and dark surroundings. For example, the default "white" color is dimmed using alpha transparency. The effect is a progress bar that's beautiful any time of day _or_ night:
+
+<img src="https://user-images.githubusercontent.com/34264/125987921-3d7ac606-1ad3-4ebc-bf45-123df9b16411.png" width="448" height="32"><br>
+<img src="https://user-images.githubusercontent.com/34264/125987920-491636ad-55a7-4c63-a243-feff09c284e6.png" width="448" height="32">
+
+### I have a different question!
+
+Great! Please feel free to open an [issue](https://github.com/laserlemon/slack_progress_bar/issues/new) and I'll do my best to give you an answer. 💛
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/laserlemon/slack_progress_bar. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SlackProgressBar project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/laserlemon/slack_progress_bar/blob/main/CODE_OF_CONDUCT.md).

data/exe/slack_progress_bar

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "slack_progress_bar/cli"
+
+SlackProgressBar::CLI.start(ARGV)

data/lib/slack_progress_bar.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require "slack_progress_bar/config"
+require "slack_progress_bar/version"
+
+class SlackProgressBar
+  def self.config
+    @config ||= Config.new
+  end
+
+  def self.configure
+    yield config
+    config.validate!
+  end
+
+  attr_reader :counts, :total, :size
+
+  # Create a new progress bar.
+  #
+  # The "counts" argument is a hash of string or symbol keys and integer values.
+  # Only keys present in either config.letters or config.aliases will be
+  # rendered in the resulting progress bar. If not provided, it's assumed that
+  # no progress has been made.
+  #
+  # The "total" argument is optional, defaulting to the sum of all provided
+  # counts. If a total is provided that is greater than the sum of the counts,
+  # the last configured color will be used to fill in the remainder of the bar.
+  # If a total is provided that is less than the sum of the counts provided, the
+  # greater value will be used to render the progress bar.
+  #
+  # The "size" argument specifies how many emoji will be used to render the
+  # progress bar. The default is 14 because the default progress bar has rounded
+  # ends that each represent only one stripe. The remaining 12 emoji each
+  # represent four stripes, for a total of 50 stripes, making each stripe count
+  # for 2% of the total. Any size may be given but each stripe may represent an
+  # unusual, floating point percentage of the total.
+  #
+  # The "rounded" argument accepts a boolean for whether the progress bar should
+  # have rounded ends. This is a matter of personal preference and will affect
+  # the whitespace on either side of the progress bar since the rounded end
+  # emoji images are mostly negative space.
+  def initialize(counts: {}, total: counts.values.sum, size: 14, rounded: true)
+    @counts = {}
+    @total = total
+    @size = size
+    @rounded = rounded
+
+    counts.each do |key, count|
+      letter =
+        case key
+        when *config.letters then key
+        when *config.aliases.keys then config.aliases.fetch(key)
+        end
+      @counts[letter] ||= 0
+      @counts[letter] += count
+    end
+  end
+
+  def to_s
+    emoji
+  end
+
+  private
+
+  def config
+    self.class.config
+  end
+
+  def rounded?
+    @rounded
+  end
+
+  def emoji
+    return @emoji if @emoji
+
+    emoji = +""
+
+    if rounded?
+      emoji << emojify(letters.slice(0), suffix: "a")
+      emoji << emojify(letters.slice(1, stripes - 2))
+      emoji << emojify(letters.slice(-1), suffix: "z")
+    else
+      emoji << emojify(letters)
+    end
+
+    @emoji = emoji
+  end
+
+  def emojify(letters, suffix: nil)
+    emoji = +""
+
+    letters.scan(/[a-z]{1,4}/) do |group|
+      emoji << group
+        .prepend(config.prefix, config.separator)
+        .tap { |s| s.concat(config.separator, suffix) if suffix }
+        .prepend(":")
+        .concat(":")
+    end
+
+    emoji
+  end
+
+  def letters
+    return @letters if @letters
+
+    letters = +""
+    running_total = 0
+
+    config.letters.each do |letter|
+      count = counts[letter]
+      next unless count
+
+      running_total += count
+      running_stripes = (running_total.to_f / effective_total * stripes).floor
+      letters = letters.ljust(running_stripes, letter)
+    end
+
+    @letters = letters.ljust(stripes, config.default_letter)
+  end
+
+  def effective_total
+    @effective_total ||= [counts.values.sum, total, 1].max
+  end
+
+  def stripes
+    @stripes ||= rounded? ? ((size - 2) * 4) + 2 : size * 4
+  end
+end

data/lib/slack_progress_bar/cli.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "slack_progress_bar/generator"
+
+require "thor"
+
+class SlackProgressBar
+  class CLI < Thor
+    defaults = Generator.new
+
+    desc "generate",
+      "Generate Slack emoji images"
+    option :colors,
+      desc: "A collection of key/value pairs where the keys are letters used for image file naming and the values are hex colors used for image generation",
+      type: :hash,
+      default: defaults.colors
+    option :prefix,
+      desc: "A string used as the prefix for every generated image file name",
+      type: :string,
+      default: defaults.prefix
+    option :output,
+      desc: "The directory where all generated image files will be saved",
+      type: :string,
+      default: defaults.output
+
+    def generate
+      generator = Generator.new(
+        colors: options[:colors],
+        prefix: options[:prefix],
+        output: options[:output],
+      )
+
+      generator.generate
+    end
+  end
+end

data/lib/slack_progress_bar/config.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+class SlackProgressBar
+  class Config
+    InvalidConfigError = Class.new(StandardError)
+
+    DEFAULT_PREFIX = "pb"
+
+    # The default letters stand for: purple, blue, green, yellow, orange, red,
+    # and white. See SlackProgressBar::Generator::DEFAULT_COLORS for more
+    # information.
+    DEFAULT_LETTERS = %w[p b g y o r w].freeze
+
+    DEFAULT_ALIASES = {
+      purple: "p",
+      blue: "b",
+      green: "g",
+      yellow: "y",
+      orange: "o",
+      red: "r",
+      white: "w",
+    }.freeze
+
+    PREFIX_PATTERN = /\A[0-9a-z]+\z/.freeze
+    LETTER_PATTERN = /\A[a-z]\z/.freeze
+
+    SEPARATOR = "-"
+    LEFT_CAP_SUFFIX = "a"
+    RIGHT_CAP_SUFFIX = "z"
+    CIRCLE_SUFFIX = "o"
+
+    attr_accessor :prefix, :letters, :aliases
+
+    def initialize
+      @prefix = DEFAULT_PREFIX
+      @letters = DEFAULT_LETTERS
+      @aliases = DEFAULT_ALIASES
+    end
+
+    def validate!
+      unless prefix.is_a?(String)
+        raise InvalidConfigError, "The prefix must be a String. Found #{prefix.class.name}: #{prefix.inspect}"
+      end
+
+      unless PREFIX_PATTERN.match?(prefix)
+        raise InvalidConfigError, "The prefix must only contain digits 0-9 and/or lowercase letters a-z. Found: #{prefix.inspect}"
+      end
+
+      unless letters.is_a?(Array)
+        raise InvalidConfigError, "Configured letters must be an Array. Found #{letters.class.name}: #{letters.inspect}"
+      end
+
+      case letters.size
+      when 0
+        raise InvalidConfigError, "Provide at least two letters."
+      when 1
+        raise InvalidConfigError, "Provide at least two letters. The last letter will be used as the default."
+      end
+
+      unless letters.uniq.size == letters.size
+        raise InvalidConfigError, "Configured letters must be unique."
+      end
+
+      letters.each do |letter|
+        unless letter.is_a?(String)
+          raise InvalidConfigError, "Every letter must be a String. Found #{letter.class.name}: #{letter.inspect}"
+        end
+
+        unless LETTER_PATTERN.match?(letter)
+          raise InvalidConfigError, "The only valid letters are lowercase a-z. Found: #{letter.inspect}"
+        end
+      end
+
+      unless aliases.is_a?(Hash)
+        raise InvalidConfigError, "Configured aliases must be a Hash. Found #{aliases.class.name}: #{aliases.inspect}"
+      end
+
+      aliases.each do |name, letter|
+        unless name.is_a?(Symbol)
+          raise InvalidConfigError, "Every alias must have a Symbol name. Found #{name.class.name}: #{name.inspect}"
+        end
+
+        unless letter.is_a?(String)
+          raise InvalidConfigError, "Every alias must point to a String letter. Found #{letter.class.name}: #{letter.inspect}"
+        end
+
+        unless letters.include?(letter)
+          raise InvalidConfigError, "Every alias must point to a valid letter. Found: #{letter.inspect}"
+        end
+      end
+    end
+
+    def valid?
+      validate!
+    rescue InvalidConfigError
+      false
+    else
+      true
+    end
+
+    def default_letter
+      letters.last
+    end
+
+    def separator
+      SEPARATOR
+    end
+
+    def left_cap_suffix
+      LEFT_CAP_SUFFIX
+    end
+
+    def right_cap_suffix
+      RIGHT_CAP_SUFFIX
+    end
+
+    def circle_suffix
+      CIRCLE_SUFFIX
+    end
+  end
+end

data/lib/slack_progress_bar/generator.rb

@@ -0,0 +1,212 @@
+# frozen_string_literal: true
+
+require "slack_progress_bar"
+
+require "open3"
+require "rqrcode"
+
+class SlackProgressBar
+  class Generator
+    Error = Class.new(StandardError)
+    CommandFailedError = Class.new(Error)
+    ImageMagickError = Class.new(Error)
+    ImageMagickMissingError = Class.new(ImageMagickError)
+    ImageMagickOutdatedError = Class.new(ImageMagickError)
+    OutputError = Class.new(Error)
+    OutputMissingError = Class.new(OutputError)
+    OutputNotWritableError = Class.new(OutputError)
+
+    # The order in which these colors are configured is important; they will
+    # appear in the same order in a rendered progress bar.
+    #
+    # The default colors below were borrowed from GitHub's Primer color system.
+    # See: https://primer.style/css/support/color-system
+    #
+    # Each color consists of a six hex digits describing the RGB color and two
+    # additional hex digits to describe the color's transparency. "00" is fully
+    # transparent and "ff" is fully opaque.
+    DEFAULT_COLORS = {
+      "p" => "6f42c1ff", # purple
+      "b" => "0366d6ff", # blue
+      "g" => "28a745ff", # green
+      "y" => "ffd33dff", # yellow
+      "o" => "f66a0aff", # orange
+      "r" => "d73a49ff", # red
+      "w" => "959da544", # white
+    }.freeze
+
+    DEFAULT_OUTPUT = "./"
+
+    IMAGE_MAGICK_VERSION_PATTERN = /Version: ImageMagick (?<major_version>\d+)\.[^\s]+/.freeze
+    MINIMUM_IMAGE_MAGICK_MAJOR_VERSION = 6
+
+    attr_reader :colors, :prefix, :output
+
+    def initialize(colors: DEFAULT_COLORS, prefix: config.prefix, output: DEFAULT_OUTPUT)
+      @colors = colors
+      @prefix = prefix
+      @output = output
+    end
+
+    def config
+      @config ||= SlackProgressBar.config
+    end
+
+    def generate
+      check_image_magick!
+      check_output!
+
+      generate_left_caps
+      generate_right_caps
+      generate_circles
+      generate_stripes
+      generate_qr_code
+    end
+
+    private
+
+    def run_command(command)
+      output, status = Open3.capture2e(command)
+
+      raise CommandFailedError, output unless status.success?
+
+      output
+    end
+
+    def image_output_path(name)
+      File.join(output, "#{name}.png")
+    end
+
+    def check_image_magick!
+      output = run_command("convert -version")
+      major_version = output.slice(IMAGE_MAGICK_VERSION_PATTERN, :major_version).to_i
+
+      if major_version < MINIMUM_IMAGE_MAGICK_MAJOR_VERSION
+        raise ImageMagickOutdatedError, <<~ERR
+          ImageMagick is out of date.
+
+          Please upgrade to ImageMagick #{MINIMUM_IMAGE_MAGICK_MAJOR_VERSION} or later.
+        ERR
+      end
+
+      true
+    rescue CommandFailedError
+      raise ImageMagickMissingError, <<~ERR
+        ImageMagick's "convert" command was not found.
+
+        Please be sure that ImageMagick is installed, the "convert" command is
+        available, and your PATH is configured to find the "convert" command.
+      ERR
+    end
+
+    def check_output!
+      unless File.directory?(output)
+        raise OutputMissingError,
+          "Output directory #{output.inspect} was not found."
+      end
+
+      unless File.writable?(output)
+        raise OutputNotWritableError,
+          "Output directory #{output.inspect} is not writable."
+      end
+
+      true
+    end
+
+    def generate_left_caps
+      puts "Generating left caps"
+
+      colors.each do |letter, color|
+        name = [prefix, letter, config.left_cap_suffix].join(config.separator)
+        path = image_output_path(name)
+
+        run_command(%(convert -size 128x128 canvas:transparent -fill "##{color}" -draw "translate 127.5,63.5 circle 0,0 0,39.5" #{path}))
+        print "."
+      end
+
+      puts
+    end
+
+    def generate_right_caps
+      puts "Generating right caps"
+
+      colors.each do |letter, color|
+        name = [prefix, letter, config.right_cap_suffix].join(config.separator)
+        path = image_output_path(name)
+
+        run_command(%(convert -size 128x128 canvas:transparent -fill "##{color}" -draw "translate -0.5,63.5 circle 0,0 0,39.5" #{path}))
+        print "."
+      end
+
+      puts
+    end
+
+    def generate_circles
+      puts "Generating circles"
+
+      colors.each do |letter, color|
+        name = [prefix, letter, config.circle_suffix].join(config.separator)
+        path = image_output_path(name)
+
+        run_command(%(convert -size 128x128 canvas:transparent -fill "##{color}" -draw "translate 63.5,63.5 circle 0,0 0,39.5" #{path}))
+        print "."
+      end
+
+      puts
+    end
+
+    def generate_stripes
+      puts "Generating stripes"
+
+      colors.keys.repeated_combination(4).each do |four_letters|
+        four_colors = four_letters.map { |letter| colors.fetch(letter) }
+
+        command = +%(convert -size 128x128 canvas:transparent)
+
+        four_colors.each_with_index do |color, i|
+          x1 = i * 32
+          x2 = x1 + 31
+          command << %( -fill "##{color}" -draw "rectangle #{x1},24 #{x2},103")
+        end
+
+        name = four_letters.join.prepend(prefix, config.separator)
+        path = image_output_path(name)
+        command << %( #{path})
+
+        run_command(command)
+        print "."
+      end
+
+      puts
+    end
+
+    def generate_qr_code
+      puts "Generating QR code"
+
+      count = 1
+      previous_count = 0
+      configs = []
+
+      colors.each do |letter, color|
+        configs << "#{letter}:#{color}:#{count}"
+
+        count_to_add = previous_count
+        previous_count = count
+        count += count_to_add
+      end
+
+      anchor = configs.join("+")
+      url = "https://laserlemon.github.io/slack_progress_bar/##{anchor}"
+      qr = RQRCode::QRCode.new(url, level: :l)
+
+      name = "#{prefix}#{config.separator}qr"
+      path = image_output_path(name)
+
+      IO.binwrite(path, qr.as_png(
+        border_modules: 0,
+        resize_exactly_to: 128,
+      ))
+      puts "."
+    end
+  end
+end

data/lib/slack_progress_bar/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class SlackProgressBar
+  VERSION = Gem::Version.new("0.1.0")
+end

data/slack_progress_bar.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "lib/slack_progress_bar/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "slack_progress_bar"
+  spec.version = SlackProgressBar::VERSION
+  spec.summary = "Generate beautiful progress bars using custom Slack emoji"
+
+  spec.author  = "Steve Richert"
+  spec.email   = "steve.richert@gmail.com"
+  spec.license = "MIT"
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").grep_v(/\A(bin|spec|Rakefile)/)
+  end
+
+  spec.add_runtime_dependency "thor", "~> 1.0"
+
+  spec.add_development_dependency "bundler", ">= 2"
+  spec.add_development_dependency "rake", ">= 12"
+
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.bindir = "exe"
+  spec.executables = ["slack_progress_bar"]
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: slack_progress_bar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steve Richert
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12'
+description:
+email: steve.richert@gmail.com
+executables:
+- slack_progress_bar
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/FUNDING.yml"
+- ".github/workflows/rake.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- exe/slack_progress_bar
+- lib/slack_progress_bar.rb
+- lib/slack_progress_bar/cli.rb
+- lib/slack_progress_bar/config.rb
+- lib/slack_progress_bar/generator.rb
+- lib/slack_progress_bar/version.rb
+- slack_progress_bar.gemspec
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.19
+signing_key:
+specification_version: 4
+summary: Generate beautiful progress bars using custom Slack emoji
+test_files: []