Rename Colors to Styles

Author: gustavothecoder

docsite/source/colorizing-your-output.html.md

@@ -12,7 +12,7 @@ sections:
   - variadic-arguments
   - commands-with-subcommands-and-params
   - callbacks
-  - colorizing-your-output
+  - styling-your-output
 ---
 
 `dry-cli` is a general-purpose framework for developing Command Line Interface (CLI) applications. It represents commands as objects that can be registered and offers support for arguments, options and forwarding variadic arguments to a sub-command.

docsite/source/index.html.md

@@ -0,0 +1,59 @@
+---
+title: Styling your output
+layout: gem-single
+name: dry-cli
+---
+
+`dry-cli` comes with some functions to help you style text in the terminal. The program bellow demonstrate all available styles:
+
+```ruby
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "dry/cli"
+
+module StylesDemo
+  extend Dry::CLI::Registry
+
+  class Print < Dry::CLI::Command
+    desc "Demonstrate all available styles"
+
+    # rubocop:disable Metrics/AbcSize
+    def call
+      demo = <<~DEMO
+        `bold`                   #{bold("This is bold")}
+        `dim`                    #{dim("This is dim")}
+        `italic`                 #{italic("This is italic")}
+        `underline`              #{underline("This is underline")}
+        `blink`                  #{blink("This blinks")}
+        `reverse`                #{reverse("This was reversed")}
+        `invisible`              #{invisible("This is invisible")} (you can't see it, right?)
+        `black`                  #{black("This is black")}
+        `red`                    #{red("This is red")}
+        `green`                  #{green("This is green")}
+        `yellow`                 #{yellow("This is yellow")}
+        `blue`                   #{blue("This is blue")}
+        `magenta`                #{magenta("This is magenta")}
+        `cyan`                   #{cyan("This is cyan")}
+        `white`                  #{white("This is white")}
+        `on_black`               #{on_black("This is black")}
+        `on_red`                 #{on_red("This is red")}
+        `on_green`               #{on_green("This is green")}
+        `on_yellow`              #{on_yellow("This is yellow")}
+        `on_blue`                #{on_blue("This is blue")}
+        `on_magenta`             #{on_magenta("This is magenta")}
+        `on_cyan`                #{on_cyan("This is cyan")}
+        `on_white`               #{on_white("This is white")}
+        `bold`+`red`:            #{bold(red("This is bold red"))}
+        `bold`+`on_green`:       #{bold(on_green("This is bold on green"))}
+        `bold`+`red`+`on_green`: #{bold(red(on_green("This is bold red on green")))}
+      DEMO
+      puts demo
+    end
+    # rubocop:enable Metrics/AbcSize
+  end
+
+  register "print", Print
+end
+
+Dry.CLI(StylesDemo).call
+```

docsite/source/styling-your-output.html.md

@@ -2,15 +2,15 @@
 
 require "forwardable"
 require "dry/cli/option"
-require "dry/cli/colors"
+require "dry/cli/styles"
 
 module Dry
   class CLI
     # Base class for commands
     #
     # @since 0.1.0
     class Command
-      include Colors
+      include Styles
 
       # @since 0.1.0
       # @api private

lib/dry/cli/command.rb

@@ -2,15 +2,45 @@
 
 module Dry
   class CLI
-    # Collection of functions to colorize text.
+    # Collection of functions to style text.
     #
     # @since 1.3.0
-    module Colors
+    module Styles
       # since 1.3.0
       def bold(text)
         ensure_clean_sequence("\e[1m#{text}")
       end
 
+      # since 1.3.0
+      def dim(text)
+        ensure_clean_sequence("\e[2m#{text}")
+      end
+
+      # since 1.3.0
+      def italic(text)
+        ensure_clean_sequence("\e[3m#{text}")
+      end
+
+      # since 1.3.0
+      def underline(text)
+        ensure_clean_sequence("\e[4m#{text}")
+      end
+
+      # since 1.3.0
+      def blink(text)
+        ensure_clean_sequence("\e[5m#{text}")
+      end
+
+      # since 1.3.0
+      def reverse(text)
+        ensure_clean_sequence("\e[7m#{text}")
+      end
+
+      # since 1.3.0
+      def invisible(text)
+        ensure_clean_sequence("\e[8m#{text}")
+      end
+
       # since 1.3.0
       def black(text)
         ensure_clean_sequence("\e[30m#{text}")

lib/dry/cli/colors.rb lib/dry/cli/styles.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift "#{__dir__}/../../../lib"
+require "dry/cli"
+
+module StylesDemo
+  extend Dry::CLI::Registry
+
+  class Print < Dry::CLI::Command
+    desc "Demonstrate all available styles"
+
+    # rubocop:disable Metrics/AbcSize
+    def call
+      demo = <<~DEMO
+        `bold`                   #{bold("This is bold")}
+        `dim`                    #{dim("This is dim")}
+        `italic`                 #{italic("This is italic")}
+        `underline`              #{underline("This is underline")}
+        `blink`                  #{blink("This blinks")}
+        `reverse`                #{reverse("This was reversed")}
+        `invisible`              #{invisible("This is invisible")} (you can't see it, right?)
+        `black`                  #{black("This is black")}
+        `red`                    #{red("This is red")}
+        `green`                  #{green("This is green")}
+        `yellow`                 #{yellow("This is yellow")}
+        `blue`                   #{blue("This is blue")}
+        `magenta`                #{magenta("This is magenta")}
+        `cyan`                   #{cyan("This is cyan")}
+        `white`                  #{white("This is white")}
+        `on_black`               #{on_black("This is black")}
+        `on_red`                 #{on_red("This is red")}
+        `on_green`               #{on_green("This is green")}
+        `on_yellow`              #{on_yellow("This is yellow")}
+        `on_blue`                #{on_blue("This is blue")}
+        `on_magenta`             #{on_magenta("This is magenta")}
+        `on_cyan`                #{on_cyan("This is cyan")}
+        `on_white`               #{on_white("This is white")}
+        `bold`+`red`:            #{bold(red("This is bold red"))}
+        `bold`+`on_green`:       #{bold(on_green("This is bold on green"))}
+        `bold`+`red`+`on_green`: #{bold(red(on_green("This is bold red on green")))}
+      DEMO
+      puts demo
+    end
+    # rubocop:enable Metrics/AbcSize
+  end
+
+  register "print", Print
+end
+
+Dry.CLI(StylesDemo).call

spec/support/fixtures/colors

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+RSpec.describe "Styles" do
+  class Dummy
+    include Dry::CLI::Styles
+
+    def bold_and_black
+      black(bold("two"))
+    end
+  end
+
+  it "doesn't duplicate clean escape sequences" do
+    bold_and_black = Dummy.new.bold_and_black
+    expect(bold_and_black.end_with?("\e[0m")).to eq(true)
+    expect(bold_and_black.end_with?("\e[0m\e[0m")).to eq(false)
+  end
+end