howzit 1.2.8 → 1.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b746b36bbf197ee183372cf3fbfd111a0314912820b814b587ed1a186821ce6
-  data.tar.gz: e93e32a4ddb60e786c5b8e4428589571309089498df718f4f6f1c931e1d863c3
+  metadata.gz: 24b630c81dbd81b43b8572bbc91baabe96063a17c3cb6295a8026e6a3176dd39
+  data.tar.gz: 04c98ab9c7a9c57e8c7536e7709b57d51b965a76cc315c846c46dca3a0a2105e
 SHA512:
-  metadata.gz: aad98d851e6a6e712743da60a0cceaaee32ef23aecf029ec460fc15b6c3ff65ca3e95a25c93be9c2694decbd692101801fa98f32e7d0814818ab8584912efbaa
-  data.tar.gz: 4e92229bc8f27ce3aabe11c267fd2c8cde31c189028f1970ccb6e2690f1f2a8f87004df56e2510e31646641493aa1334769fd78cd3ac843ba348729b2e08edce
+  metadata.gz: 3ce4d9a3cd8cd8970cd37e5b90c7154c0b66de06827780c4e38bb4f358d517b8c81d720383cbaa8fa84ff74f56a9f1f60e554f92614cf12e4f1f563092d9d651
+  data.tar.gz: 5187fbd097d9171ddd3756f9df92e62b0df5309d7e1d2e0aef26551f6641340d65ade5f49f1c9b0a47852e6913c64d5914d334732e15a1ac71f2277edde38fe7

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+### 1.2.11
+
+2022-08-01 08:23
+
+#### IMPROVED
+
+- Code cleanup and refactoring
+
+### 1.2.10
+
+2022-08-01 07:45
+
+#### FIXED
+
+- Headline formatting when iTerm markers are inserted
+
 ### 1.2.8
 
 2022-08-01 07:01

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in howzit.gemspec.

data/Guardfile

@@ -1,4 +1,6 @@
-scope groups: [:doc, :lint, :unit]
+# frozen_string_literal: true
+
+scope groups: %i[doc lint unit]
 
 group :doc do
   guard :yard do

data/README.md

@@ -1,6 +1,7 @@
 # Howzit
 
 [![Gem](https://img.shields.io/gem/v/howzit.svg)](https://rubygems.org/gems/howzit)
+[![Travis](https://img.shields.io/travis/makenew/ruby-gem.svg)](https://travis-ci.org/makenew/ruby-gem)
 [![GitHub license](https://img.shields.io/github/license/ttscoff/howzit.svg)](./LICENSE.txt)
 
 A command-line reference tool for tracking project build systems

data/Rakefile

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 require 'bump/tasks'
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 require 'yard'
 
-task default: [:test, :yard]
+task default: %i[test yard]
 
 desc 'Run test suite'
-task test: [:rubocop, :spec]
+task test: %i[rubocop spec]
 
 RSpec::Core::RakeTask.new
 

data/bin/howzit

@@ -1,6 +1,9 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
+
 $LOAD_PATH.unshift File.join(__dir__, '..', 'lib')
 require 'howzit'
 
-Howzit::BuildNotes.new(ARGV)
+how = Howzit::BuildNotes.new(ARGV)
+how.process
+

data/howzit.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop', '~> 0.28'
   spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'simplecov', '~> 0.9'
-  spec.add_development_dependency 'codecov', '~> 0.1'
+  # spec.add_development_dependency 'codecov', '~> 0.1'
   spec.add_development_dependency 'fuubar', '~> 2.0'
 
   spec.add_development_dependency 'yard', '~> 0.9.5'

data/lib/howzit/buildnotes.rb

@@ -3,7 +3,7 @@ module Howzit
   class BuildNotes
     include Prompt
 
-    attr_accessor :arguments, :metadata
+    attr_accessor :cli_args, :arguments, :metadata
 
     def topics
       @topics ||= read_help
@@ -132,8 +132,12 @@ module Howzit
       end
     end
 
+    def should_mark_iterm?
+      ENV['TERM_PROGRAM'] =~ /^iTerm/ && !@options[:run] && !@options[:paginate]
+    end
+
     def iterm_marker
-      "\e]1337;SetMark\a\n" if ENV['TERM_PROGRAM'] =~ /^iTerm/ && !@options[:run] && !@options[:paginate]
+      "\e]1337;SetMark\a" if should_mark_iterm?
     end
 
     def color_single_options(choices = %w[y n])
@@ -226,16 +230,23 @@ module Howzit
       options = {
         hr: "\u{254C}",
         color: '1;32',
-        border: '0'
+        border: '0',
+        mark: false
       }
 
       options.merge!(opts)
 
       cols = TTY::Screen.columns
+
       cols = @options[:wrap] if (@options[:wrap]).positive? && cols > @options[:wrap]
-      title = "\e[#{options[:border]}m#{options[:hr]}#{options[:hr]}( \e[#{options[:color]}m#{title}\e[#{options[:border]}m )"
-      tail = options[:hr] * (cols - title.uncolor.length)
-      options[:hr] =~ /╌/ ? "#{iterm_marker}#{title}#{tail}\e[0m" : "#{title}#{tail}\e[0m"
+      title = "\e[#{options[:border]}m#{options[:hr] * 2}( \e[#{options[:color]}m#{title}\e[#{options[:border]}m )"
+
+      tail = if should_mark_iterm?
+               "#{options[:hr] * (cols - title.uncolor.length - 15)}#{options[:mark] ? iterm_marker : ''}"
+             else
+               options[:hr] * (cols - title.uncolor.length)
+             end
+      "#{title}#{tail}\e[0m"
     end
 
     def os_open(command)
@@ -344,7 +355,7 @@ module Howzit
 
       output = []
       if opt[:header]
-        output.push(format_header(key))
+        output.push(format_header(key, { mark: should_mark_iterm? }))
         output.push('')
       end
       topic = topics[key].strip
@@ -662,7 +673,7 @@ module Howzit
       matches
     end
 
-    def initialize(args)
+    def initialize(args = [])
       flags = {
         run: false,
         list_topics: false,
@@ -705,7 +716,8 @@ module Howzit
       OptionParser.new do |opts|
         opts.banner = "Usage: #{__FILE__} [OPTIONS] [TOPIC]"
         opts.separator ''
-        opts.separator 'Show build notes for the current project (buildnotes.md). Include a topic name to see just that topic, or no argument to display all.'
+        opts.separator 'Show build notes for the current project (buildnotes.md).
+        Include a topic name to see just that topic, or no argument to display all.'
         opts.separator ''
         opts.separator 'Options:'
 
@@ -714,7 +726,8 @@ module Howzit
           Process.exit 0
         end
 
-        opts.on('-e', '--edit', "Edit buildnotes file in current working directory using #{File.basename(ENV['EDITOR'])}") do
+        opts.on('-e', '--edit', "Edit buildnotes file in current working directory
+                using #{File.basename(ENV['EDITOR'])}") do
           edit_note
           Process.exit 0
         end
@@ -732,7 +745,8 @@ module Howzit
           @options[:list_topics] = true
         end
 
-        opts.on('-m', '--matching TYPE', MATCHING_OPTIONS, 'Topics matching type', "(#{MATCHING_OPTIONS.join(', ')})") do |c|
+        opts.on('-m', '--matching TYPE', MATCHING_OPTIONS,
+                'Topics matching type', "(#{MATCHING_OPTIONS.join(', ')})") do |c|
           @options[:matching] = c
         end
 
@@ -795,7 +809,7 @@ module Howzit
             puts "\e[1;30m[\e[1;37mtasks\e[1;30m]──────────────────────────────────────┐\e[0m"
             metadata = file.extract_metadata
             topics = read_help_file(file)
-            topics.keys.each do |topic|
+            topics.each_key do |topic|
               puts " \e[1;30m│\e[1;37m-\e[0m \e[1;36;40m#{template}:#{topic.sub(/^.*?:/, '')}\e[0m"
             end
             if metadata.size > 0
@@ -834,7 +848,7 @@ module Howzit
         end
       end.parse!(args)
 
-      process(args)
+      @cli_args = args
     end
 
     def edit_note
@@ -851,7 +865,7 @@ module Howzit
     end
 
     ##
-    ## @brief      Traverse up directory tree looking for build notes
+    ## Traverse up directory tree looking for build notes
     ##
     ## @return     topics dictionary
     ##
@@ -1053,7 +1067,7 @@ module Howzit
       `#{ENV['EDITOR']} "#{config_file}"`
     end
 
-    def process(args)
+    def process
       output = []
 
       unless note_file
@@ -1107,9 +1121,9 @@ module Howzit
       elsif @options[:choose]
         topic_match = choose(topics.keys)
       # If there are arguments use those to search for a matching topic
-      elsif !args.empty?
+      elsif !@cli_args.empty?
 
-        search = args.join(' ').strip.downcase
+        search = @cli_args.join(' ').strip.downcase
         matches = match_topic(search)
 
         if matches.empty?

data/lib/howzit/stringutils.rb

@@ -5,7 +5,7 @@ module Howzit
   module StringUtils
     # Just strip out color codes when requested
     def uncolor
-      gsub(/\e\[[\d;]+m/, '').gsub(/\e]1337;SetMark/,'')
+      gsub(/\e\[[\d;]+m/, '').gsub(/\e\]1337;SetMark/,'')
     end
 
     # Adapted from https://github.com/pazdera/word_wrap/,

data/lib/howzit/version.rb

@@ -2,5 +2,5 @@
 # Primary module for this gem.
 module Howzit
   # Current Howzit version.
-  VERSION = '1.2.8'.freeze
+  VERSION = '1.2.11'.freeze
 end

data/spec/ruby_gem_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Howzit::BuildNotes do
-  subject(:ruby_gem) { Howzit::BuildNotes.new }
+  subject(:ruby_gem) { Howzit::BuildNotes.new([]) }
 
   describe ".new" do
     it "makes a new instance" do

data/spec/spec_helper.rb

@@ -1,13 +1,13 @@
-require 'simplecov'
+# require 'simplecov'
 
-SimpleCov.start
+# SimpleCov.start
 
-if ENV['CI'] == 'true'
-  require 'codecov'
-  SimpleCov.formatter = SimpleCov::Formatter::Codecov
-else
-  SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
-end
+# if ENV['CI'] == 'true'
+#   require 'codecov'
+#   SimpleCov.formatter = SimpleCov::Formatter::Codecov
+# else
+#   SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
+# end
 
 require 'howzit'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: howzit
 version: !ruby/object:Gem::Version
-  version: 1.2.8
+  version: 1.2.11
 platform: ruby
 authors:
 - Brett Terpstra
@@ -150,20 +150,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: codecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: fuubar
   requirement: !ruby/object:Gem::Requirement