howzit 2.1.3 → 2.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d34bc56b28033e3f708225b2706bca8d0c2ccaa3d727f9193855412940071e68
-  data.tar.gz: 0f78cefe615f34c31590e206081c01d3b7229da6e1045ea215872fc71ba2942c
+  metadata.gz: 1299678fe342467585d3ced3e03840c89964312c17e865beb77bbeb10fd84d5c
+  data.tar.gz: 247e0c2819675d4da66c07e7d80af7cfdcb3a1be461a1fea4df901ca0b924bbc
 SHA512:
-  metadata.gz: e22946b9e257c6d13ce3d950584049f31c570aa618e047e6041ea1ef5b3a9ca85322124ef6fcc04a41dac4860b3441045265a4080886df13d31322b7bd88ad80
-  data.tar.gz: 120350fb80cea5353cc79dbe8f63e5adec7d14b45fa6df526cc3de349a8d54a797bf283467d4d45f4156a34b3ea2d06c8915f9b66b7e1eff6cf0d95fd6f777a7
+  metadata.gz: 676fc60b51f92daa8fa61c10ca1d3029e1ac310da7c9dfb9563e40cf090572ccb97cef1384fc2fd7a7e6ef93bd113f6a677d4d61f60ddebf706a9983a0cebafc
+  data.tar.gz: 3c2e3820b771428413019e68510e50eb7ee3423af04c5540974825c0f18a07844af4eb72a1b3a83818195ce0085b5135b6f21cb6b44621da244afb54e2f98843

data/.howzit.taskpaper.bak

@@ -0,0 +1,27 @@
+Inbox:
+	- Topic summaries @na
+		Maybe in square brackets on line after topic title, or as a blockquote. When doing a list of available topics, include its summary in the output. Ignore or specially style summary when viewing full topic.
+	- Named positional arguments for topics @na
+		Parenthesis after title like a function (arg1, arg2). Variables can have default values (arg1 = testing) and are available as [%var1] replacements in scripts
+howzit:
+	New Features:
+	Ideas:
+		- Nested topics @maybe @na
+			Allow increased header levels to nest topics within a parent
+			Running/viewing a parent includes all nested subtopics
+			All topics still available via search
+			When reading file, set a base level from first header, then test each additional topic title to see whether it's greater than the current level. If so, change current level and begin collecting subtopics at the same level
+			Howzit::Topic has a subtopic attribute, consisting of an array of Topics. Each of these Topics also has a subtopics attr. These are collected and assigned during initila reading of note file
+			When read in, a topic is added to the top level build notes topic, as well as appended to its parent's subtopics if it's a higher level than the base
+			just need methods to determine base level (first # match) and check the current headers level when discovering a topic (count #)
+			
+			no, wait. topics should read in their own children. Determine base header level, split topics at that level, then recurse each topic the same way
+			include statements will need to be adjusted to allow includes as children. Multiple at symbols could indicate the level to nest at, two symbols would indicate that the include belonged to the last parent. When importing, adjust base header levels appropriately (increase 1).
+	Bugs:
+Archive:
+	- Add a preview when selecting topic with fzf @priority(3) @na @done(2022-08-06) @project(Inbox)
+Search Definitions:
+	Top Priority @search(@priority = 5 and not @done)
+	High Priority @search(@priority > 3 and not @done)
+	Maybe @search(@maybe)
+	Next @search(@na and not @done and not project = "Archive")

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+### 2.1.5
+
+2023-04-12 15:13
+
+#### FIXED
+
+- Allow tilde in path to editor
+
+### 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

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
@@ -241,7 +284,9 @@ module Howzit
       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
-
-      "\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/util.rb

@@ -39,6 +39,7 @@ module Howzit
       ##
       def command_exist?(command)
         exts = ENV.fetch('PATHEXT', '').split(::File::PATH_SEPARATOR)
+        command = File.expand_path(command) if command =~ /^~/
         if Pathname.new(command).absolute?
           ::File.exist?(command) || exts.any? { |ext| ::File.exist?("#{command}#{ext}") }
         else

data/lib/howzit/version.rb

@@ -3,5 +3,5 @@
 # Primary module for this gem.
 module Howzit
   # Current Howzit version.
-  VERSION = '2.1.3'
+  VERSION = '2.1.5'
 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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: howzit
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.1.5
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-07 00:00:00.000000000 Z
+date: 2023-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -292,6 +292,7 @@ extra_rdoc_files: []
 files:
 - ".editorconfig"
 - ".gitignore"
+- ".howzit.taskpaper.bak"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"