snagglepuss 0.0.1.alpha → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7fad3a0990bf01a7d62ef171a5b29b2def9aa63721e4b69b111fcd58d22e3a9
-  data.tar.gz: 5731a5acf520fe4e71868134de8741ea906ab7186a44e28a95063793f0a4d498
+  metadata.gz: de831b08b102db213d7a9b76b66ac0602304e52e30534178dca97d26becdb50b
+  data.tar.gz: 6b4aaad4ac4ad6cf77250847c42cbd7660f9920ede419de5c1ff7c817366cf72
 SHA512:
-  metadata.gz: 17b9a9fc53d823e4cf4377451f53f24d6d9885a6c43a4d0b9e109db5e54aee677e50dd2d051079899cae7b60bfeb09daccd6dd56c831e5234e8be0989605206a
-  data.tar.gz: 8ca692cb0eb989b2fecd2b43b9caa5ecc605ddd2d57b754b7a325ac9c25c4378bd3313c4f6863363706ead78dc9b6cc45b38e037739cf4a1c63188586b7a164e
+  metadata.gz: 13b5522498891d7adc8d058ae7ebda4f10bdd3a2fca72a0dc98c99825cfc3d60e3b4c47337dafaba13139521833111904481ed87078f22fcc36ef62fb7cd4d16
+  data.tar.gz: 7972db8e27abcf81591eafdc1378a2f0e09f8730a0b4c9337ad1580455effff442c81eeb12121177ac8427b99bb229f4bb84ad508868fb3d3ea075109a2f420d

data/changelog.md

@@ -1,10 +1,17 @@
 ## [Unreleased]
 
+## [0.0.1] - 2025-05-23
+
+* Gracefully exit when no error occurs (i.e. $! == nil)
+* Provide a header and footer that indicate when output starts and stops.
+* Provide more colorful output.
+
+
 ## [0.0.1.alpha] - 2025-05-23
 
-- Add initial implementation.
+* Add initial implementation.
 
 
 ## [0.1.0.alpha] - 2025-05-23
 
-- Initial release
+* Initial release

data/lib/snagglepuss/colorize.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+if defined?(ColorMeRad)
+  if [
+    :error,
+    :label,
+    :exclamation,
+    :partition,
+    :path,
+    :function,
+  ].all?{ |key| ColorMeRad.color_for_key(key) == :light_yellow }
+    ColorMeRad.configure do |config|
+      config.set_colors \
+        :error => :red,
+        :label => :magenta,
+        :exclamation => :green,
+        :path => :blue,
+        :partition => :light_black,
+        :function => :magenta
+    end
+  end
+end
+
+module Snagglepuss
+  module Colorize
+    extend self
+
+    [
+      :key,
+      :data,
+    ].each do |method|
+      define_method method do |*args|
+        return args.first.to_s unless enabled?
+        ColorMeRad.send method, *args
+      end
+    end
+
+    def enabled?
+      return false unless defined?(ColorMeRad)
+      ColorMeRad.enabled?
+    end
+  end
+end

data/lib/snagglepuss/line_formatter.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Snagglepuss
+  module LineFormatter
+    extend self
+
+    def execute(line)
+      return line unless Colorize.enabled?
+      return Colorize.key(line, :stacktrace) unless full_match?(line)
+
+      path, number, description = line.split(':')
+      function = description.match(/`(.*)'/)[1].to_s
+
+      '%s:%s in `%s`' % [
+        Colorize.key(path, :path),
+        Colorize.data(number.to_i),
+        Colorize.key(function, :function),
+      ]
+    end
+
+    private
+
+    def full_match?(line)
+      line.match(/[\/\w]+:\d+:in `.*'$/)
+    end
+  end
+end

data/lib/snagglepuss/show_exception.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Snagglepuss
+  module ShowException
+    extend self
+
+    def execute(e)
+      exit_stage :right
+
+      show_backtrace_for e
+
+      puts '%s: %s' % [
+        Colorize.data(e.class),
+        Colorize.key(e.message, :error),
+      ]
+
+      exit_stage :left
+    end
+
+    private
+
+    def show_backtrace_for(e)
+      app_trace = []
+      e.backtrace.each do |line|
+        formatted = LineFormatter.execute(line)
+        puts formatted
+        next if EXCLUSIONS.any?{ |e| line.match(e) }
+
+        app_trace << formatted
+      end
+
+      puts '%s %s %s' % [
+        Colorize.key('<== ', :partition),
+        Colorize.key('Application trace', :label),
+        Colorize.key('=' * 57 + '>', :partition),
+      ]
+
+      puts app_trace
+
+      puts Colorize.key('=' * 80, :partition)
+    end
+
+    def exit_stage(direction)
+      exclamation = "Exit, stage #{direction}!"
+      padding = 80 - (exclamation.length + 5)
+
+      is_right = direction == :right
+
+      fill = is_right ? '<' : '>'
+      fill = Colorize.key(fill, :partition)
+
+      puts '%s %s %s' % [
+        (is_right ? fill * 3 : fill * padding),
+        Colorize.key("Exit, stage #{direction}!", :exclamation),
+        (is_right ? fill * padding : fill * 3),
+      ]
+    end
+  end
+end

data/lib/snagglepuss/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Snagglepuss
-  VERSION = '0.0.1.alpha'
+  VERSION = '0.0.1'
 end

data/lib/snagglepuss.rb

@@ -1,59 +1,33 @@
 # frozen_string_literal: true
 
-require_relative "snagglepuss/version"
-
-if defined?(ColorMeRad)
-  if ColorMeRad.color_for_key(:error) == :light_yellow &&
-      ColorMeRad.color_for_key(:label) == :light_yellow
-    ColorMeRad.configure do |config|
-      config.set_colors \
-        :error => :red,
-        :label => :magenta
-    end
-  end
-end
-
-module Colorize
-  extend self
-
-  [
-    :key,
-    :data,
-  ].each do |method|
-    define_method method do |*args|
-      return args.first.to_s unless defined?(ColorMeRad)
-      ColorMeRad.send method, *args
-    end
-  end
-end
+require_relative 'snagglepuss/version'
+require_relative 'snagglepuss/colorize'
+require_relative 'snagglepuss/line_formatter'
+require_relative 'snagglepuss/show_exception'
 
 module Snagglepuss
   extend self
 
-  class Error < StandardError; end
+  SKIPPABLE_CLASSES = [
+    NilClass,
+    SystemExit,
+  ]
 
-  def exit_gracefully(e)
-    return if e.is_a?(SystemExit)
+  EXCLUSIONS = [
+    /\/\.?asdf\//,
+    /\/\.gems\//,
+  ]
 
-    puts e.backtrace
-    puts '=' * 80
-    puts Colorize.key('Application trace:', :label)
-    puts '-' * 80
-    e.backtrace.each do |line|
-      puts line if !line.match(/\/\.?asdf\//) && !line.match(/\/\.gems\//)
-    end
-    puts '=' * 80
+  def exit_stage_right(e)
+    return if SKIPPABLE_CLASSES.any?{ |c| e.is_a?(c) }
 
-    puts '%s: %s' % [
-      Colorize.data(e.class),
-      Colorize.key(e.message, :error),
-    ]
+    ShowException.execute e
 
     $stderr.reopen(IO::NULL)
     $stdout.reopen(IO::NULL)
   end
 
   at_exit do
-    exit_gracefully $!
+    exit_stage_right $!
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snagglepuss
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha
+  version: 0.0.1
 platform: ruby
 authors:
 - Travis Herrick
@@ -34,6 +34,9 @@ extra_rdoc_files: []
 files:
 - changelog.md
 - lib/snagglepuss.rb
+- lib/snagglepuss/colorize.rb
+- lib/snagglepuss/line_formatter.rb
+- lib/snagglepuss/show_exception.rb
 - lib/snagglepuss/version.rb
 - readme.md
 - snagglepuss.gemspec
@@ -54,9 +57,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.3
 signing_key: