hilighter 1.5.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 12de20d926f333f17c63422220db0c8c5baf18e7870127de78e8ad55cf4598d6
+  data.tar.gz: 23057327a183158182505494e5943733c8da2ab55995af832d363c315dd61b1f
+SHA512:
+  metadata.gz: fd5a67726beb497ed99e5357275fe6cabb23ca575152172010fab86873faa40039db76050dad00bcafa987df923dbca75ff12024adfd0ddb4e0f6aa1bf74cf0b
+  data.tar.gz: e139afef30ae8387e7e9dde274a48b907f41d62df8c091a1c2f9eed8eb34c4e3f870c9ce4bcf4a20e23f0f33ff9084dcd8cb705878f90dbcb5829d41baff95ff

data/bin/hilight

@@ -0,0 +1,192 @@
+#!/usr/bin/env ruby
+
+require "hilighter"
+require "io/wait"
+require "optparse"
+
+### Helpers begin
+def err(msg)
+    puts("[!] #{msg}".red)
+end
+def errx(msg)
+    raise Exception.new(msg)
+end
+def good(msg)
+    puts("[+] #{msg}".green)
+end
+def info(msg)
+    puts("[*] #{msg}".white)
+end
+def subinfo(msg)
+    puts("[=] #{msg}".cyan)
+end
+def warn(msg)
+    puts("[-] #{msg}".yellow)
+end
+### Helpers end
+
+class HilighterExit
+    GOOD = 0
+    INVALID_OPTION = 1
+    INVALID_ARGUMENT = 2
+    MISSING_ARGUMENT = 3
+    EXTRA_ARGUMENTS = 4
+    EXCEPTION = 5
+    AMBIGUOUS_ARGUMENT = 6
+end
+
+def parse(args)
+    options = Hash.new
+    options["action"] = "default"
+    options["verbose"] = false
+
+    info = [
+        "Hilights the text from stdin using the methods passed on",
+        "the CLI."
+    ].join(" ")
+
+    parser = OptionParser.new do |opts|
+        opts.summary_width = 19
+
+        opts.banner = [
+            "Usage: #{File.basename($0)} [OPTIONS] [color1]...",
+            "[colorN]"
+        ].join(" ")
+
+        opts.on("", "DESCRIPTION")
+
+        info.wrap(76).each_line do |line|
+            opts.on("    #{line.chomp}")
+        end
+
+        opts.on("", "OPTIONS")
+
+        opts.on("-h", "--help", "Display this help message") do
+            puts(opts)
+            exit HilighterExit::GOOD
+        end
+
+        opts.on("--[no-]color", "Disable colorized output") do |c|
+            Hilighter.disable if (!c)
+        end
+
+        opts.on(
+            "-s",
+            "--sample",
+            "Show sample foreground/background colors"
+        ) do
+            options["action"] = "sample"
+        end
+
+        opts.on("-t", "--table", "Show the color table") do
+            options["action"] = "table"
+        end
+
+        opts.on(
+            "-v",
+            "--verbose",
+            "Show backtrace when error occurs"
+        ) do
+            options["verbose"] = true
+        end
+
+        opts.on("-V", "--version", "Show version") do
+            __FILE__.match(/hilighter-(\d+\.\d+\.\d+)/) do |m|
+                puts(m[1])
+            end
+            exit HilighterExit::GOOD
+        end
+    end
+
+    begin
+        parser.parse!
+    rescue OptionParser::InvalidOption => e
+        puts(e.message)
+        puts(parser)
+        exit HilighterExit::INVALID_OPTION
+    rescue OptionParser::InvalidArgument => e
+        puts(e.message)
+        puts(parser)
+        exit HilighterExit::INVALID_ARGUMENT
+    rescue OptionParser::MissingArgument => e
+        puts(e.message)
+        puts(parser)
+        exit HilighterExit::MISSING_ARGUMENT
+    rescue OptionParser::AmbiguousOption => e
+        puts(e.message)
+        puts(parser)
+        exit Exit::AMBIGUOUS_ARGUMENT
+    end
+
+    return options
+end
+
+begin
+    options = parse(ARGV)
+rescue Interrupt
+    # Exit gracefully on ^C
+    exit HilighterExit::GOOD
+end
+
+begin
+    case options["action"]
+    when "sample"
+        Hilighter.sample
+    when "table"
+        Hilighter.table
+    else
+        bad = Array.new
+        loop do
+            # Get input
+            input = STDIN.gets
+
+            # Break if EOF, otherwise remove existing color codes
+            break if (input.nil?)
+
+            # Apply all requested color codes
+            ARGV.each do |color|
+                begin
+                    input = input.send(color)
+                rescue NoMethodError
+                    bad.push(color)
+                end
+            end
+            break if (!bad.empty?)
+
+            # Output
+            puts(input)
+        end
+        puts("Invalid colors: #{bad.join(", ")}") if (!bad.empty?)
+    end
+rescue Interrupt
+    # Exit gracefully on ^C
+rescue Errno::EPIPE
+    # Do nothing. This can happen if piping to another program such as
+    # less. Usually if less is closed before we're done with STDOUT.
+rescue Exception => e
+    $stderr.puts(
+        [
+            "Oops! Looks like an error has occured! If the error",
+            "persists, file a bug at:"
+        ].join(" ").wrap
+    )
+    $stderr.puts
+    $stderr.puts("  https://gitlab.com/mjwhitta/hilighter/issues")
+    $stderr.puts
+    $stderr.puts(
+        [
+            "Maybe the message below will help. If not, you can use",
+            "the --verbose flag to get a backtrace."
+        ].join(" ").wrap
+    )
+    $stderr.puts
+
+    $stderr.puts(e.message.white.on_red)
+    if (options["verbose"])
+        e.backtrace.each do |line|
+            $stderr.puts(line.light_yellow)
+        end
+    end
+    exit HilighterExit::EXCEPTION
+end
+exit HilighterExit::GOOD

data/bin/hl

@@ -0,0 +1,192 @@
+#!/usr/bin/env ruby
+
+require "hilighter"
+require "io/wait"
+require "optparse"
+
+### Helpers begin
+def err(msg)
+    puts("[!] #{msg}".red)
+end
+def errx(msg)
+    raise Exception.new(msg)
+end
+def good(msg)
+    puts("[+] #{msg}".green)
+end
+def info(msg)
+    puts("[*] #{msg}".white)
+end
+def subinfo(msg)
+    puts("[=] #{msg}".cyan)
+end
+def warn(msg)
+    puts("[-] #{msg}".yellow)
+end
+### Helpers end
+
+class HilighterExit
+    GOOD = 0
+    INVALID_OPTION = 1
+    INVALID_ARGUMENT = 2
+    MISSING_ARGUMENT = 3
+    EXTRA_ARGUMENTS = 4
+    EXCEPTION = 5
+    AMBIGUOUS_ARGUMENT = 6
+end
+
+def parse(args)
+    options = Hash.new
+    options["action"] = "default"
+    options["verbose"] = false
+
+    info = [
+        "Hilights the text from stdin using the methods passed on",
+        "the CLI."
+    ].join(" ")
+
+    parser = OptionParser.new do |opts|
+        opts.summary_width = 19
+
+        opts.banner = [
+            "Usage: #{File.basename($0)} [OPTIONS] [color1]...",
+            "[colorN]"
+        ].join(" ")
+
+        opts.on("", "DESCRIPTION")
+
+        info.wrap(76).each_line do |line|
+            opts.on("    #{line.chomp}")
+        end
+
+        opts.on("", "OPTIONS")
+
+        opts.on("-h", "--help", "Display this help message") do
+            puts(opts)
+            exit HilighterExit::GOOD
+        end
+
+        opts.on("--[no-]color", "Disable colorized output") do |c|
+            Hilighter.disable if (!c)
+        end
+
+        opts.on(
+            "-s",
+            "--sample",
+            "Show sample foreground/background colors"
+        ) do
+            options["action"] = "sample"
+        end
+
+        opts.on("-t", "--table", "Show the color table") do
+            options["action"] = "table"
+        end
+
+        opts.on(
+            "-v",
+            "--verbose",
+            "Show backtrace when error occurs"
+        ) do
+            options["verbose"] = true
+        end
+
+        opts.on("-V", "--version", "Show version") do
+            __FILE__.match(/hilighter-(\d+\.\d+\.\d+)/) do |m|
+                puts(m[1])
+            end
+            exit HilighterExit::GOOD
+        end
+    end
+
+    begin
+        parser.parse!
+    rescue OptionParser::InvalidOption => e
+        puts(e.message)
+        puts(parser)
+        exit HilighterExit::INVALID_OPTION
+    rescue OptionParser::InvalidArgument => e
+        puts(e.message)
+        puts(parser)
+        exit HilighterExit::INVALID_ARGUMENT
+    rescue OptionParser::MissingArgument => e
+        puts(e.message)
+        puts(parser)
+        exit HilighterExit::MISSING_ARGUMENT
+    rescue OptionParser::AmbiguousOption => e
+        puts(e.message)
+        puts(parser)
+        exit Exit::AMBIGUOUS_ARGUMENT
+    end
+
+    return options
+end
+
+begin
+    options = parse(ARGV)
+rescue Interrupt
+    # Exit gracefully on ^C
+    exit HilighterExit::GOOD
+end
+
+begin
+    case options["action"]
+    when "sample"
+        Hilighter.sample
+    when "table"
+        Hilighter.table
+    else
+        bad = Array.new
+        loop do
+            # Get input
+            input = STDIN.gets
+
+            # Break if EOF, otherwise remove existing color codes
+            break if (input.nil?)
+
+            # Apply all requested color codes
+            ARGV.each do |color|
+                begin
+                    input = input.send(color)
+                rescue NoMethodError
+                    bad.push(color)
+                end
+            end
+            break if (!bad.empty?)
+
+            # Output
+            puts(input)
+        end
+        puts("Invalid colors: #{bad.join(", ")}") if (!bad.empty?)
+    end
+rescue Interrupt
+    # Exit gracefully on ^C
+rescue Errno::EPIPE
+    # Do nothing. This can happen if piping to another program such as
+    # less. Usually if less is closed before we're done with STDOUT.
+rescue Exception => e
+    $stderr.puts(
+        [
+            "Oops! Looks like an error has occured! If the error",
+            "persists, file a bug at:"
+        ].join(" ").wrap
+    )
+    $stderr.puts
+    $stderr.puts("  https://gitlab.com/mjwhitta/hilighter/issues")
+    $stderr.puts
+    $stderr.puts(
+        [
+            "Maybe the message below will help. If not, you can use",
+            "the --verbose flag to get a backtrace."
+        ].join(" ").wrap
+    )
+    $stderr.puts
+
+    $stderr.puts(e.message.white.on_red)
+    if (options["verbose"])
+        e.backtrace.each do |line|
+            $stderr.puts(line.light_yellow)
+        end
+    end
+    exit HilighterExit::EXCEPTION
+end
+exit HilighterExit::GOOD

data/lib/hilighter.rb

@@ -0,0 +1,109 @@
+class Hilighter
+    def self.disable(val = true)
+        @@disable = val
+    end
+
+    def self.disable?
+        @@disable ||= false
+        return @@disable
+    end
+
+    # Convert hex to xterm-256 8-bit value
+    # https://stackoverflow.com/questions/11765623/convert-hex-hex_to_256bitto-closest-x11-color-number
+    def self.hex_to_x256(hex)
+        @@cached_codes ||= Hash.new
+        cache = @@cached_codes[hex]
+        return "color_#{cache}" if (!cache.nil?)
+
+        # For simplicity, assume RGB space is perceptually uniform.
+        # There are 5 places where one of two outputs needs to be
+        # chosen when the input is the exact middle:
+        # - The r/g/b channels and the gray value:
+        #     - the higher value output is chosen
+        # - If the gray and color values have same distance from the
+        #   input
+        #     - color is chosen
+
+        # Calculate the nearest 0-based color index at 16..231
+        r = g = b = 0
+        x = "[A-Fa-f0-9]{2}"
+        hex.match(/^#?(#{x})(#{x})(#{x})(#{x})?$/) do |m|
+            r = m[1].to_i(16)
+            g = m[2].to_i(16)
+            b = m[3].to_i(16)
+        end
+
+        # 0..5 each
+        ir = (r < 48) ? 0 : (r < 115) ? 1 : ((r - 35) / 40)
+        ig = (g < 48) ? 0 : (g < 115) ? 1 : ((g - 35) / 40)
+        ib = (b < 48) ? 0 : (b < 115) ? 1 : ((b - 35) / 40)
+
+        # 0..215 lazy evaluation
+        cidx = (36 * ir) + (6 * ig) + ib + 16
+
+        # Calculate the nearest 0-based gray index at 232..255
+        average = (r + g + b) / 3
+
+        # 0..23
+        gidx = (average > 238) ? 23 : (average - 3) / 10
+
+        # Calculate the represented colors back from the index
+        i2cv = [0, 0x5f, 0x87, 0xaf, 0xd7, 0xff]
+
+        # r/g/b  0..255 each
+        cr = i2cv[ir]
+        cg = i2cv[ig]
+        cb = i2cv[ib]
+
+        # same value for r/g/b  0..255
+        gv = (10 * gidx) + 8
+
+        # Return the one which is nearer to the original rgb
+        # values
+        clr_err = ((cr - r) ** 2 + (cg - g) ** 2 + (cb - b) ** 2)
+        gray_err = ((gv - r) ** 2 + (gv - g) ** 2 + (gv - b) ** 2)
+
+        if (clr_err <= gray_err)
+            @@cached_codes[hex] = cidx.to_s.rjust(3, "0")
+        else
+            @@cached_codes[hex] = (gidx + 232).to_s.rjust(3, "0")
+        end
+
+        return "color_#{@@cached_codes[hex]}"
+    end
+
+    def self.sample
+        String.colors.keys[0..15].each do |fg|
+            String.colors.keys[16..31].each do |bg|
+                print(" mw ".send(fg).send(bg))
+            end
+            puts
+        end
+    end
+
+    def self.table
+        (0..15).each do |i|
+            bg = i.to_s.rjust(3, "0")
+            print(" ".send("on_color_#{bg}"))
+            print(bg.black.send("on_color_#{bg}"))
+            print(" ".send("on_color_#{bg}"))
+            print(bg.white.send("on_color_#{bg}"))
+            print(" ".send("on_color_#{bg}"))
+            puts if (((i + 1) % 8) == 0)
+        end
+
+        (16..255).each do |i|
+            bg = i.to_s.rjust(3, "0")
+            print(" ".send("on_color_#{bg}"))
+            print(bg.black.send("on_color_#{bg}"))
+            print(" ".send("on_color_#{bg}"))
+            print(bg.white.send("on_color_#{bg}"))
+            print(" ".send("on_color_#{bg}"))
+            puts if (((i - 15) % 6) == 0)
+        end
+    end
+end
+
+require "hilighter/codes"
+require "hilighter/methods"
+require "string"

data/lib/hilighter/codes.rb

@@ -0,0 +1,151 @@
+class Hilighter
+    module Codes
+        def add_methods
+            color_regex = /(^|\n)(\e\[([0-9;]+m|K))+(\n|$)/
+
+            colors.each do |key, val|
+                if (key.start_with?("on_"))
+                    on_default = colors["on_default"]
+                    define_method key do
+                        return self.plain if (Hilighter.disable?)
+
+                        return [
+                            "\e[#{val}m",
+                            self.plain_bg.gsub(
+                                /\n/,
+                                "\e[#{on_default}m\n\e[#{val}m"
+                            ),
+                            "\e[#{on_default}m"
+                        ].join.gsub(color_regex, "\\1\\4")
+                    end
+                else
+                    default = colors["default"]
+                    define_method key do
+                        return self.plain if (Hilighter.disable?)
+
+                        return [
+                            "\e[#{val}m",
+                            self.plain_fg.gsub(
+                                /\n/,
+                                "\e[#{default}m\n\e[#{val}m"
+                            ),
+                            "\e[#{default}m"
+                        ].join.gsub(color_regex, "\\1\\4")
+                    end
+                end
+            end
+
+            modes.each do |key, val|
+                rm = [
+                    modes[key],
+                    modes["no_#{key}".gsub(/^no_no_/, "")]
+                ].delete_if(&:nil?).uniq.join("|")
+
+                off = "no_#{key}"
+                if modes.has_key?(off)
+                    off = "\e[#{modes[off]}m"
+                else
+                    off = ""
+                end
+
+                define_method key do
+                    return self.plain if (Hilighter.disable?)
+                    self.gsub!(/\e\[(#{rm})m/, "")
+                    return "\e[#{val}m#{self}#{off}".gsub(
+                        color_regex,
+                        "\\1\\4"
+                    )
+                end
+            end
+        end
+
+        def colors
+            @valid_colors ||= {
+                "black" => 30,
+                "red" => 31,
+                "green" => 32,
+                "yellow" => 33,
+                "blue" => 34,
+                "magenta" => 35,
+                "cyan" => 36,
+                "white" => 37,
+                "light_black" => 90,
+                "light_red" => 91,
+                "light_green" => 92,
+                "light_yellow" => 93,
+                "light_blue" => 94,
+                "light_magenta" => 95,
+                "light_cyan" => 96,
+                "light_white" => 97,
+
+                "on_black" => 40,
+                "on_red" => 41,
+                "on_green" => 42,
+                "on_yellow" => 43,
+                "on_blue" => 44,
+                "on_magenta" => 45,
+                "on_cyan" => 46,
+                "on_white" => 47,
+                "on_light_black" => 100,
+                "on_light_red" => 101,
+                "on_light_green" => 102,
+                "on_light_yellow" => 103,
+                "on_light_blue" => 104,
+                "on_light_magenta" => 105,
+                "on_light_cyan" => 106,
+                "on_light_white" => 107,
+
+                "default" => 39,
+                "on_default" => 49
+            }
+            if (@valid_colors.length < 256)
+                256.times.each do |i|
+                    clr = i.to_s.rjust(3, "0")
+                    @valid_colors["color_#{clr}"] = "38;5;#{clr}"
+                    @valid_colors["on_color_#{clr}"] = "48;5;#{clr}"
+                end
+            end
+            return @valid_colors
+        end
+
+        def modes
+            return {
+                "reset" => 0,
+                "normal" => 0,
+                "bold" => 1,
+                "dim" => 2,
+                "faint" => 2,
+                "italic" => 3,
+                "underline" => 4,
+                "blink" => 5,
+                "blink_slow" => 5,
+                "blink_rapid" => 6,
+                "inverse" => 7,
+                "negative" => 7,
+                "swap" => 7,
+                "hide" => 8,
+                "conceal" => 8,
+                "crossed_out" => 9,
+                "strikethrough" => 9,
+                "fraktur" => 20,
+
+                "no_bold" => 21,
+                "no_dim" => 22,
+                "no_faint" => 22,
+                "no_italic" => 23,
+                "no_fraktur" => 23,
+                "no_underline" => 24,
+                "no_blink" => 25,
+                "no_blink_slow" => 25,
+                "no_blink_rapid" => 26,
+                "no_inverse" => 27,
+                "no_negative" => 27,
+                "no_swap" => 27,
+                "no_hide" => 28,
+                "no_conceal" => 28,
+                "no_crossed_out" => 29,
+                "no_strikethrough" => 29
+            }
+        end
+    end
+end

data/lib/hilighter/methods.rb

@@ -0,0 +1,103 @@
+class Hilighter
+    module Methods
+        def color_regex
+            return /\e\[([0-9;]*m|K)/
+        end
+        private :color_regex
+
+        def hex_color(hex)
+            return self.send(Hilighter.hex_to_x256(hex))
+        end
+
+        def method_missing(method_name, *args)
+            method_name.to_s.match(/^([A-Fa-f0-9]{6})$/) do |m|
+                return self.hex_color(m[1])
+            end
+            method_name.to_s.match(/^on_([A-Fa-f0-9]{6})$/) do |m|
+                return self.on_hex_color(m[1])
+            end
+            method_name.to_s.match(/^wrap(_(\d+))?$/) do |m|
+                width = nil
+                width = m[2].to_i if (!m[1].nil?)
+                return self.wrap(width)
+            end
+            super
+        end
+
+        def on_hex_color(hex)
+            return self.send("on_#{Hilighter.hex_to_x256(hex)}")
+        end
+
+        def on_rainbow
+            return self.plain if (Hilighter.disable?)
+
+            clrs = rainbow_colors
+            out = Array.new
+
+            self.plain_bg.each_line do |line|
+                line.chomp!
+                colorized = line.scan(
+                    /((#{color_regex})*[^\e](#{color_regex})*)/
+                ).map.with_index do |c, i|
+                    "\e[#{clrs[i % clrs.length] + 10}m#{c[0]}"
+                end.join
+                out.push("#{colorized}\e[49m\n")
+            end
+
+            return out.join.gsub(/^(#{color_regex})+$/, "")
+        end
+
+        def plain
+            return self.gsub(color_regex, "")
+        end
+
+        def plain_bg
+            return self.gsub(/\e\[(4|10)[0-9;]+m/, "")
+        end
+
+        def plain_fg
+            return self.gsub(/\e\[[39][0-9;]+m/, "")
+        end
+
+        def rainbow_colors
+            return [31, 32, 33, 34, 35, 36, 91, 92, 93, 94, 95, 96]
+        end
+        private :rainbow_colors
+
+        def rainbow
+            return self.plain if (Hilighter.disable?)
+
+            clrs = rainbow_colors
+            out = Array.new
+
+            self.plain_fg.each_line do |line|
+                line.chomp!
+                colorized = line.scan(
+                    /((#{color_regex})*[^\e](#{color_regex})*)/
+                ).map.with_index do |c, i|
+                    "\e[#{clrs[i % clrs.length]}m#{c[0]}"
+                end.join
+                out.push("#{colorized}\n")
+            end
+
+            return out.join.gsub(/^(#{color_regex})+$/, "")
+        end
+
+        def wrap(width = 80)
+            line = ""
+            lines = Array.new
+            self.split(/\s+/).each do |word|
+                if ((line.plain.size + word.plain.size) > width)
+                    lines.push("#{line}\n")
+                    line = word
+                elsif (line.empty?)
+                    line = word
+                else
+                    line += " #{word}"
+                end
+            end
+            lines.push("#{line}\n") if (!line.empty?)
+            return lines.join
+        end
+    end
+end

data/lib/string.rb

@@ -0,0 +1,5 @@
+class String
+    extend Hilighter::Codes
+    include Hilighter::Methods
+    add_methods
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: hilighter
+version: !ruby/object:Gem::Version
+  version: 1.5.2
+platform: ruby
+authors:
+- Miles Whittaker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: Adds color methods to String class. Also allows for string wrapping that
+  accounts for color escape codes.
+email: mj@whitta.dev
+executables:
+- hl
+- hilight
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/hilight
+- bin/hl
+- lib/hilighter.rb
+- lib/hilighter/codes.rb
+- lib/hilighter/methods.rb
+- lib/string.rb
+homepage: https://gitlab.com/mjwhitta/hilighter/tree/ruby
+licenses:
+- GPL-3.0
+metadata:
+  source_code_uri: https://gitlab.com/mjwhitta/hilighter/tree/ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Adds color methods to String class
+test_files: []