kolor 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 88da60fa7cd1a6902ce9fb10e02e302c7aad67a9eed4795951dae6804f82a4f3
+  data.tar.gz: edfd12747056bff1941ffdd2cc6f8c2cf88b5e6030b6a46e85fbee3d5d95a632
+SHA512:
+  metadata.gz: c5876e47d82fb9a977aeb08d005a2a8b4aece912912f9214ae749f05d4f295890c2be4e1150d783a36b64be6a93b0458148a3c2b43ad9e48a0edd9fed88796f8
+  data.tar.gz: 6a809ff99c76a57ffb7cad178d9b5ead628e8acd12e6cf6a1b6a6f6e6adbf0b6ef0cd722c6f97d69567ddcbf08170dd9d9a31de9602d6e6a6bc4e9f5c3f710a9

data/LICENSE

@@ -0,0 +1,8 @@
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+    1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+    2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+    3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+    4. Redistributions of any form whatsoever must retain the following acknowledgment: 'This product includes software developed by the Łasačka (https://github.com/lasaczka/) saikinmirai@gmail.com'
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/bin/kolor

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/kolor/cli'
+
+Kolor::CLI.new(ARGV).run

data/lib/kolor/cli.rb

@@ -0,0 +1,310 @@
+# frozen_string_literal: true
+
+require_relative '../kolor'
+require_relative 'internal/config'
+require 'optparse'
+
+module Kolor
+  ##
+  # Kolor::CLI provides a command-line interface for the Kolor library.
+  #
+  # It supports:
+  # - Foreground and background colors
+  # - Text styles (bold, underline, etc.)
+  # - Predefined themes (via kolor/extra)
+  # - RGB and hex color input
+  # - Gradients and rainbow effects
+  # - Utility commands like listing options or showing a demo
+  #
+  # Input can be passed as arguments or piped via stdin.
+  # Output is automatically colorized unless redirected, in which case colors are disabled unless `KOLOR_FORCE` is set.
+  #
+  # @example Basic usage
+  #   kolor --red "Hello"
+  #
+  # @example Piped input
+  #   echo "Hello" | kolor --green --bold
+  #
+  # @example Theme usage (requires kolor/extra)
+  #   kolor --success "Done!"
+  #
+  # @example List available styles
+  #   kolor --list-styles
+  #
+  # @example Show demo
+  #   kolor --demo
+  class CLI
+    ##
+    # Initializes the CLI with given arguments.
+    #
+    # @param args [Array<String>] command-line arguments (defaults to ARGV)
+    def initialize(args = ARGV)
+      @args = args
+      @options = {}
+    end
+
+    ##
+    # Runs the CLI command.
+    #
+    # Loads config, parses options, and dispatches to appropriate handler.
+    #
+    # @return [void]
+    def run
+      Kolor::Config.init if extra_available?
+      parse_options
+
+      if @options[:list_colors]
+        list_colors
+      elsif @options[:list_styles]
+        list_styles
+      elsif @options[:list_themes]
+        list_themes
+      elsif @options[:demo]
+        show_demo
+      elsif @options[:version]
+        puts "Kolor #{Kolor::VERSION}"
+      elsif @options[:help]
+        puts @option_parser
+      else
+        colorize_text
+      end
+    end
+
+    private
+
+    ##
+    # Parses CLI options using OptionParser.
+    #
+    # Populates @options hash with parsed flags and values.
+    #
+    # @return [void]
+    def parse_options
+      @option_parser = OptionParser.new do |opts|
+        opts.banner = "Usage: kolor [options] TEXT"
+        opts.separator ""
+        opts.separator "Examples:"
+        opts.separator "  kolor --red 'Hello World'"
+        opts.separator "  kolor --green --bold 'Success!'"
+        opts.separator "  echo 'Hello' | kolor --red"
+        opts.separator "  kolor --success 'Done!' (requires kolor/extra)"
+        opts.separator ""
+        opts.separator "Options:"
+
+        Kolor::Enum::Foreground.keys.each do |color|
+          opts.on("--#{color}", "Apply #{color} foreground") { @options[:foreground] = color }
+        end
+
+        Kolor::Enum::Background.keys.each do |color|
+          opts.on("--on-#{color}", "Apply #{color} background") { @options[:background] = color }
+        end
+
+        Kolor::Enum::Style.keys.reject { |s| s == :clear }.each do |style|
+          opts.on("--#{style}", "Apply #{style} style") do
+            @options[:styles] ||= []
+            @options[:styles] << style
+          end
+        end
+
+        opts.on("--success", "Apply success theme (green + bold)") do
+          @options[:theme] = :success
+          require_extra
+        end
+
+        opts.on("--error", "Apply error theme (white on red + bold)") do
+          @options[:theme] = :error
+          require_extra
+        end
+
+        opts.on("--warning", "Apply warning theme (yellow + bold)") do
+          @options[:theme] = :warning
+          require_extra
+        end
+
+        opts.on("--info", "Apply info theme (cyan)") do
+          @options[:theme] = :info
+          require_extra
+        end
+
+        opts.on("--debug", "Apply debug theme (magenta)") do
+          @options[:theme] = :debug
+          require_extra
+        end
+
+        opts.on("--rgb R,G,B", Array, "Apply RGB color (e.g., 255,0,0)") do |rgb|
+          require_extra
+          @options[:rgb] = rgb.map(&:to_i)
+        end
+
+        opts.on("--with_hex COLOR", "Apply with_hex color (e.g., FF0000)") do |hex|
+          require_extra
+          @options[:with_hex] = hex
+        end
+
+        opts.on("--gradient START,END", Array, "Apply gradient (e.g., red,blue)") do |colors|
+          require_extra
+          @options[:gradient] = colors.map(&:to_sym)
+        end
+
+        opts.on("--rainbow", "Apply rainbow effect") do
+          require_extra
+          @options[:rainbow] = true
+        end
+
+        opts.on("--list-colors", "List available colors") { @options[:list_colors] = true }
+        opts.on("--list-styles", "List available styles") { @options[:list_styles] = true }
+        opts.on("--list-themes", "List available themes") { @options[:list_themes] = true }
+        opts.on("--demo", "Show color demonstration") { @options[:demo] = true }
+        opts.on("--no-color", "Disable colors") { Kolor.disable! }
+        opts.on("-v", "--version", "Show version") { @options[:version] = true }
+        opts.on("-h", "--help", "Show this help") { @options[:help] = true }
+      end
+
+      @option_parser.parse!(@args)
+    end
+
+    ##
+    # Requires kolor/extra and exits with error if not available.
+    #
+    # @return [void]
+    def require_extra
+      require_relative 'extra'
+    rescue LoadError
+      puts "Error: kolor/extra is required for this feature"
+      exit 1
+    end
+
+    ##
+    # Checks if kolor/extra is available.
+    #
+    # @return [Boolean]
+    def extra_available?
+      require_relative 'extra'
+      true
+    rescue LoadError
+      false
+    end
+
+    ##
+    # Applies selected colors/styles/themes to input text and prints result.
+    #
+    # @return [void]
+    def colorize_text
+      text = if @args.empty?
+               if $stdin.tty?
+                 puts "Error: No text provided"
+                 puts @option_parser
+                 exit 1
+               else
+                 $stdin.read.chomp
+               end
+             else
+               @args.join(' ')
+             end
+
+      Kolor.disable! if !$stdout.tty? && Kolor.enabled? && !ENV['KOLOR_FORCE']
+
+      if @options[:gradient]
+        text = text.gradient(*@options[:gradient])
+      elsif @options[:rainbow]
+        text = text.rainbow
+      elsif @options[:theme]
+        text = text.public_send(@options[:theme])
+      else
+        text = text.rgb(*@options[:rgb]) if @options[:rgb]&.size == 3
+        text = text.with_hex(@options[:with_hex]) if @options[:with_hex]
+        text = text.public_send(@options[:foreground]) if @options[:foreground]
+        text = text.public_send("on_#{@options[:background]}") if @options[:background]
+        @options[:styles]&.each { |style| text = text.public_send(style) }
+      end
+
+      puts text
+    end
+
+    ##
+    # Lists available foreground colors.
+    #
+    # @return [void]
+    def list_colors
+      puts "Available colors:\n\n"
+      Kolor::Enum::Foreground.keys.each do |color|
+        puts "  #{color.to_s.ljust(10)} - " + "Sample text".public_send(color)
+      end
+    end
+
+    ##
+    # Lists available text styles.
+    #
+    # @return [void]
+    def list_styles
+      puts "Available styles:\n\n"
+      Kolor::Enum::Style.keys.reject { |s| s == :clear }.each do |style|
+        puts "  #{style.to_s.ljust(10)} - " + "Sample text".public_send(style)
+      end
+    end
+
+    ##
+    # Lists available themes (requires kolor/extra).
+    #
+    # @return [void]
+    def list_themes
+      require_extra
+      puts "Available themes:\n\n"
+      Kolor::Extra.themes.each do |theme|
+        config = Kolor::Extra.get_theme(theme)
+        description = []
+        description << config[:foreground].to_s if config[:foreground]
+        description << "on_#{config[:background]}" if config[:background]
+        description += config[:styles].map(&:to_s)
+        puts "  #{theme.to_s.ljust(10)} - " + "Sample text".public_send(theme) +
+             " (#{description.join(', ')})"
+      end
+    end
+
+    ##
+    # Displays a full demo of colors, backgrounds, styles, and themes.
+    #
+    # @return [void]
+    def show_demo
+      puts "=== Kolor Demo ==="
+      puts ""
+
+      puts "Basic colors:"
+      Kolor::Enum::Foreground.keys.each do |color|
+        print "#{color}: ".ljust(12)
+        puts "The quick brown fox".public_send(color)
+      end
+      puts ""
+
+      puts "Background colors:"
+      Kolor::Enum::Background.keys.each do |color|
+        print "on_#{color}: ".ljust(12)
+        puts "The quick brown fox".public_send("on_#{color}")
+      end
+      puts ""
+
+      puts "Styles:"
+      Kolor::Enum::Style.keys.reject { |s| s == :clear }.each do |style|
+        print "#{style}: ".ljust(12)
+        puts "The quick brown fox".public_send(style)
+      end
+      puts ""
+
+      puts "Combinations:"
+      puts "Red on white: " + "The quick brown fox".red.on_white
+      puts "Bold green:   " + "The quick brown fox".green.bold
+      puts "Complex:      " + "The quick brown fox".red.on_blue.bold.underline
+      puts ""
+
+      if extra_available?
+        puts "Themes:"
+        Kolor::Extra.themes.each do |theme|
+          puts "#{theme}: ".ljust(12) + "The quick brown fox".public_send(theme)
+        end
+        puts ""
+
+        puts "Rainbow:"
+        puts "The quick brown fox jumps over the lazy dog".rainbow
+      end
+    end
+  end
+end

data/lib/kolor/enum/background.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Kolor::Enum::Background defines ANSI background color codes.
+# Each entry maps a symbolic name to its corresponding ANSI value.
+class Kolor::Enum::Background < Kolor::Enum
+  type Integer
+
+  # @return [Kolor::Enum::Background] black background (ANSI 40)
+  entry :black,   40
+
+  # @return [Kolor::Enum::Background] red background (ANSI 41)
+  entry :red,     41
+
+  # @return [Kolor::Enum::Background] green background (ANSI 42)
+  entry :green,   42
+
+  # @return [Kolor::Enum::Background] yellow background (ANSI 43)
+  entry :yellow,  43
+
+  # @return [Kolor::Enum::Background] blue background (ANSI 44)
+  entry :blue,    44
+
+  # @return [Kolor::Enum::Background] magenta background (ANSI 45)
+  entry :magenta, 45
+
+  # @return [Kolor::Enum::Background] cyan background (ANSI 46)
+  entry :cyan,    46
+
+  # @return [Kolor::Enum::Background] white background (ANSI 47)
+  entry :white,   47
+end

data/lib/kolor/enum/foreground.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Kolor::Enum::Foreground defines ANSI foreground color codes.
+# Each entry maps a symbolic name to its corresponding ANSI value.
+class Kolor::Enum::Foreground < Kolor::Enum
+  type Integer
+
+  # @return [Kolor::Enum::Foreground] black foreground (ANSI 30)
+  entry :black,   30
+
+  # @return [Kolor::Enum::Foreground] red foreground (ANSI 31)
+  entry :red,     31
+
+  # @return [Kolor::Enum::Foreground] green foreground (ANSI 32)
+  entry :green,   32
+
+  # @return [Kolor::Enum::Foreground] yellow foreground (ANSI 33)
+  entry :yellow,  33
+
+  # @return [Kolor::Enum::Foreground] blue foreground (ANSI 34)
+  entry :blue,    34
+
+  # @return [Kolor::Enum::Foreground] magenta foreground (ANSI 35)
+  entry :magenta, 35
+
+  # @return [Kolor::Enum::Foreground] cyan foreground (ANSI 36)
+  entry :cyan,    36
+
+  # @return [Kolor::Enum::Foreground] white foreground (ANSI 37)
+  entry :white,   37
+end

data/lib/kolor/enum/style.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Kolor::Enum::Style defines ANSI text style codes.
+# These control formatting like bold, underline, and reversed text.
+class Kolor::Enum::Style < Kolor::Enum
+  type Integer
+
+  # @return [Kolor::Enum::Style] reset all styles (ANSI 0)
+  entry :clear,     0
+
+  # @return [Kolor::Enum::Style] bold text (ANSI 1)
+  entry :bold,      1
+
+  # @return [Kolor::Enum::Style] underlined text (ANSI 4)
+  entry :underline, 4
+
+  # @return [Kolor::Enum::Style] reversed foreground/background (ANSI 7)
+  entry :reversed,  7
+end

data/lib/kolor/enum/theme.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# Kolor::Enum::Theme defines named color themes for terminal output.
+# Each theme is a structured hash containing:
+#   - foreground: the main text color
+#   - background: optional background color
+#   - styles: optional array of text styles (e.g. :bold, :underline)
+#
+# These themes are used to apply consistent formatting across messages,
+# and can be extended or overridden via Kolor::Extra.theme.
+#
+# @example
+#   Kolor::Enum::Theme[:success].value
+#   # => { foreground: :green, background: nil, styles: [:bold] }
+class Kolor::Enum::Theme < Kolor::Enum
+  type Hash
+
+  # @return [Kolor::Enum::Theme] green bold text for success messages
+  entry :success, { foreground: :green, background: nil, styles: [:bold] }
+
+  # @return [Kolor::Enum::Theme] white text on red background for errors
+  entry :error,   { foreground: :white, background: :red, styles: [:bold] }
+
+  # @return [Kolor::Enum::Theme] yellow bold text for warnings
+  entry :warning, { foreground: :yellow, background: nil, styles: [:bold] }
+
+  # @return [Kolor::Enum::Theme] cyan text for informational messages
+  entry :info,    { foreground: :cyan, background: nil, styles: [] }
+
+  # @return [Kolor::Enum::Theme] magenta text for debugging output
+  entry :debug,   { foreground: :magenta, background: nil, styles: [] }
+end