howzit 2.1.2 → 2.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23a304a27d457b410c8764ed0b83f0a00e2e6e9108ba3fd4a7bef722695d8607
-  data.tar.gz: 2041090127040e2315691750de2ee9ccaf3d770a7b8561d328f573e78e633a50
+  metadata.gz: c6636feaeffc5a9b8ece43a5ac13d50959412ae83b45aa22f2c8f45aa3243b51
+  data.tar.gz: 537931680e6c7edcb1149339b09877df06d283daa0d0513486cfd1452de4f0b3
 SHA512:
-  metadata.gz: 8dda575709255dec600f6ba6f259c856b67ab91d9418fbcbc374f85a8eaa6a2842ac8a0b9bdd22a5eec9621e17353b6f2dfa7bc7b6f9b7de9d0c64006d5a27b1
-  data.tar.gz: 236c40bbd997c4bd956aa9796999771b965907add10b208929ba45a09c04679126177232dce1a5d29d15cec4ebfd09315b8bc274e588b0fccc02a938395731ef
+  metadata.gz: 93b5c6136f0c612aa914151e0e0df4caa2c4a01259325b4b725aad289eda22d11b09f70d4801d40bb9587733ee8ff62c9117a9b14d53344ee449c6a1c394e612
+  data.tar.gz: 1ccc318642663bde10dd806752f796d39344cebea009b930d7dbe2ead69a537fbd5077f66f1e0876d41706fba9a982c4bb6328ddfcea17d2d4f09ae42d4c69bc

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+### 2.1.4
+
+2023-03-07 12:52
+
+#### NEW
+
+- A theme file is automatically created where you can change the default output of any color that Howzit outputs. They can be 2-3 digit ANSI escape codes, or '#XXXXXX' RGB hex codes
+
+### 2.1.3
+
+2023-03-07 11:21
+
+#### FIXED
+
+- Annoying warning about color template format string having too many arguments
+
 ### 2.1.2
 
 2023-03-07 10:24

data/lib/howzit/colors.rb

@@ -205,6 +205,49 @@ module Howzit
         @coloring ||= true
       end
 
+      def translate_rgb(code)
+        return code if code !~ /#[A-Z0-9]{3,6}/i
+
+        rgb(code)
+      end
+
+      ##
+      ## Generate escape codes for hex colors
+      ##
+      ## @param      hex   [String] The hexadecimal color code
+      ##
+      ## @return     [String] ANSI escape string
+      ##
+      def rgb(hex)
+        is_bg = hex.match(/^bg?#/) ? true : false
+        hex_string = hex.sub(/^([fb]g?)?#/, '')
+
+        parts = hex_string.match(/(?<r>..)(?<g>..)(?<b>..)/)
+        t = []
+        %w[r g b].each do |e|
+          t << parts[e].hex
+        end
+
+        "\e[#{is_bg ? '48' : '38'};2;#{t.join(';')}"
+      end
+
+      # Merge config file colors into attributes
+      def configured_colors
+        color_file = File.join(File.expand_path(CONFIG_DIR), COLOR_FILE)
+        if File.exist?(color_file)
+          colors = YAML.load(Util.read_file(color_file))
+          return ATTRIBUTES unless !colors.nil? && colors.is_a?(Hash)
+
+          attrs = ATTRIBUTES.to_h
+          attrs = attrs.merge(colors.symbolize_keys)
+          new_colors = {}
+          attrs.each { |k, v| new_colors[k] = translate_rgb(v) }
+          new_colors.to_a
+        else
+          ATTRIBUTES
+        end
+      end
+
       ##
       ## Convert a template string to a colored string.
       ## Colors are specified with single letters inside
@@ -237,11 +280,13 @@ module Howzit
                    Y: bgyellow, C: bgcyan, M: bgmagenta, R: bgred,
                    d: dark, b: bold, u: underline, i: italic, x: reset }
 
-        format(fmt, colors)
+        fmt.empty? ? input : format(fmt, colors)
       end
     end
 
-    ATTRIBUTES.each do |c, v|
+    # Dynamically generate methods for each color name. Each
+    # resulting method can be called with a string or a block.
+    configured_colors.each do |c, v|
       new_method = <<-EOSCRIPT
         # Color string as #{c}
         def #{c}(string = nil)
@@ -288,26 +333,6 @@ module Howzit
       module_eval(new_method)
     end
 
-    ##
-    ## Generate escape codes for hex colors
-    ##
-    ## @param      hex   [String] The hexadecimal color code
-    ##
-    ## @return     [String] ANSI escape string
-    ##
-    def rgb(hex)
-      is_bg = hex.match(/^bg?#/) ? true : false
-      hex_string = hex.sub(/^([fb]g?)?#/, '')
-
-      parts = hex_string.match(/(?<r>..)(?<g>..)(?<b>..)/)
-      t = []
-      %w[r g b].each do |e|
-        t << parts[e].hex
-      end
-      color =
-      "\e[#{is_bg ? '48' : '38'};2;#{t.join(';')}m"
-    end
-
     # Regular expression that is used to scan for ANSI-sequences while
     # uncoloring strings.
     COLORED_REGEXP = /\e\[(?:(?:[349]|10)[0-7]|[0-9])?m/.freeze

data/lib/howzit/config.rb

@@ -23,6 +23,45 @@ module Howzit
       wrap: 0
     }.deep_freeze
 
+    DEFAULT_COLORS = [
+      [:black,              30],
+      [:red,                31],
+      [:green,              32],
+      [:yellow,             33],
+      [:blue,               34],
+      [:magenta,            35],
+      [:purple,             35],
+      [:cyan,               36],
+      [:white,              37],
+      [:bgblack,            40],
+      [:bgred,              41],
+      [:bggreen,            42],
+      [:bgyellow,           43],
+      [:bgblue,             44],
+      [:bgmagenta,          45],
+      [:bgpurple,           45],
+      [:bgcyan,             46],
+      [:bgwhite,            47],
+      [:boldblack,          90],
+      [:boldred,            91],
+      [:boldgreen,          92],
+      [:boldyellow,         93],
+      [:boldblue,           94],
+      [:boldmagenta,        95],
+      [:boldpurple,         95],
+      [:boldcyan,           96],
+      [:boldwhite,          97],
+      [:boldbgblack,       100],
+      [:boldbgred,         101],
+      [:boldbggreen,       102],
+      [:boldbgyellow,      103],
+      [:boldbgblue,        104],
+      [:boldbgmagenta,     105],
+      [:boldbgpurple,      105],
+      [:boldbgcyan,        106],
+      [:boldbgwhite,       107]
+    ].to_h.deep_freeze
+
     ##
     ## Initialize a config object
     ##
@@ -39,6 +78,15 @@ module Howzit
       File.open(config_file, 'w') { |f| f.puts config.to_yaml }
     end
 
+    ##
+    ## Write a theme to a file
+    ##
+    ## @param      config  The configuration
+    ##
+    def write_theme(config)
+      File.open(theme_file, 'w') { |f| f.puts config.to_yaml }
+    end
+
     ##
     ## Test if a file should be ignored based on YAML file
     ##
@@ -105,6 +153,7 @@ module Howzit
       }
 
       config = load_config
+      load_theme
       @options = flags.merge(config)
     end
 
@@ -126,6 +175,15 @@ module Howzit
       File.join(config_dir, CONFIG_FILE)
     end
 
+    ##
+    ## Get the theme file
+    ##
+    ## @return     [String] path to config file
+    ##
+    def theme_file
+      File.join(config_dir, COLOR_FILE)
+    end
+
     ##
     ## Get the ignore config file
     ##
@@ -153,6 +211,24 @@ module Howzit
       config_file
     end
 
+    ##
+    ## Create a new config file (and directory if needed)
+    ##
+    ## @param      default     [Hash] default configuration to write
+    ##
+    def create_theme(default)
+      unless File.directory?(config_dir)
+        Howzit::ConsoleLogger.new(1).info "Creating theme directory at #{config_dir}"
+        FileUtils.mkdir_p(config_dir)
+      end
+
+      unless File.exist?(theme_file)
+        Howzit::ConsoleLogger.new(1).info "Writing fresh theme file to #{theme_file}"
+        write_theme(default)
+      end
+      theme_file
+    end
+
     ##
     ## Load the config file
     ##
@@ -166,6 +242,19 @@ module Howzit
       newconfig.dup
     end
 
+    ##
+    ## Load the theme file
+    ##
+    ## @return     [Hash] configuration object
+    ##
+    def load_theme
+      file = create_theme(DEFAULT_COLORS)
+      config = YAML.load(Util.read_file(file))
+      newconfig = config ? DEFAULT_COLORS.merge(config) : DEFAULT_COLORS
+      write_theme(newconfig)
+      newconfig.dup
+    end
+
     ##
     ## Open the config in an editor
     ##

data/lib/howzit/version.rb

@@ -3,5 +3,5 @@
 # Primary module for this gem.
 module Howzit
   # Current Howzit version.
-  VERSION = '2.1.2'
+  VERSION = '2.1.4'
 end

data/lib/howzit.rb

@@ -1,35 +1,14 @@
 # frozen_string_literal: true
 
-require_relative 'howzit/version'
-require_relative 'howzit/prompt'
-require_relative 'howzit/colors'
-require_relative 'howzit/stringutils'
-
-require_relative 'howzit/hash'
-require_relative 'howzit/console_logger'
-require_relative 'howzit/util'
-require_relative 'howzit/config'
-require_relative 'howzit/task'
-require_relative 'howzit/topic'
-require_relative 'howzit/buildnote'
-
-require 'optparse'
-require 'shellwords'
-require 'pathname'
-require 'readline'
-require 'tempfile'
-require 'yaml'
-
-require 'tty/screen'
-require 'tty/box'
-# require 'tty/prompt'
-
 # Main config dir
 CONFIG_DIR = '~/.config/howzit'
 
 # Config file name
 CONFIG_FILE = 'howzit.yaml'
 
+# Color template name
+COLOR_FILE = 'theme.yaml'
+
 # Ignore file name
 IGNORE_FILE = 'ignore.yaml'
 
@@ -42,6 +21,31 @@ MULTIPLE_OPTIONS = %w[first best all choose].freeze
 # Available options for header formatting
 HEADER_FORMAT_OPTIONS = %w[border block].freeze
 
+require 'optparse'
+require 'shellwords'
+require 'pathname'
+require 'readline'
+require 'tempfile'
+require 'yaml'
+
+require_relative 'howzit/util'
+require_relative 'howzit/hash'
+
+require_relative 'howzit/version'
+require_relative 'howzit/prompt'
+require_relative 'howzit/colors'
+require_relative 'howzit/stringutils'
+
+require_relative 'howzit/console_logger'
+require_relative 'howzit/config'
+require_relative 'howzit/task'
+require_relative 'howzit/topic'
+require_relative 'howzit/buildnote'
+
+require 'tty/screen'
+require 'tty/box'
+# require 'tty/prompt'
+
 # Main module for howzit
 module Howzit
   class << self

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: howzit
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.1.4
 platform: ruby
 authors:
 - Brett Terpstra