Merge pull request #1043 from ThrowTheSwitch/feature/link_notices_in_help

Helpful resources / support links in command line help footer

Author: mkarlesky

README.md

@@ -369,7 +369,7 @@ _Note:_ Check the [Release Notes][release-notes] for a “cheat sheet” illustr
 
 ## Online tutorial
 
-Matt Chernosky’s **[detailed tutorial][tutorial]** demonstrates using Ceedling to build a C project with test suite. As the tutorial is a number of years old, the content is a bit out of date. That said, it provides an excellent overview of a real project. Matt is the author of [FFF] and the [FFF plugin][FFF-plugin] for Ceedling.
+Matt Chernosky’s **[detailed tutorial][tutorial]** demonstrates using Ceedling to build a C project with test suite. As the tutorial is a number of years old, the content is a bit out of date. That said, it provides an excellent overview of a real project. Matt is the author of [FFF].
 
 [ceedling-packet]: docs/CeedlingPacket.md
 [release-notes]: docs/ReleaseNotes.md

bin/ceedling

@@ -88,7 +88,6 @@ begin
   require 'cli'
 
   # Remove all load paths we've relied on (main application will set up load paths again)
-  $LOAD_PATH.delete( ceedling_bin_path )
   $LOAD_PATH.delete( CEEDLING_APPCFG[:ceedling_lib_path] )
   $LOAD_PATH.delete( diy_vendor_path )
 

bin/cli_handler.rb

@@ -64,6 +64,10 @@ def app_help(env, app_cfg, options, command, &thor_help)
       # Silent Ceedling loading unless debug verbosity
       silent: !(verbosity == Verbosity::DEBUG)
     )
+
+    version = @helper.manufacture_app_version( app_cfg )
+
+    @helper.help_footer( version.ceedling_tag )
   end
 
 
@@ -395,10 +399,7 @@ def version(env, app_cfg)
     @helper.which_ceedling?( env:env, app_cfg:app_cfg )
 
     # Ceedling application
-    application = Versionator.new(
-      app_cfg[:ceedling_root_path],
-      app_cfg[:ceedling_vendor_path]
-    )
+    application = @helper.manufacture_app_version( app_cfg )
 
     # Blank Ceedling version block to be built out conditionally below
     ceedling = nil

bin/cli_helper.rb

@@ -10,6 +10,7 @@
 # From Ceedling application
 require 'ceedling/constants'
 require 'ceedling/exceptions'
+require 'versionator' # Outisde DIY context
 
 class CliHelper
 
@@ -21,7 +22,40 @@ def setup
   end
 
 
-  def project_exists?( path, op, *components )
+  def manufacture_app_version(app_cfg)
+    return Versionator.new(
+      app_cfg[:ceedling_root_path],
+      app_cfg[:ceedling_vendor_path]
+    )
+  end
+
+
+  def help_footer(ceedling_tag='master')
+    # Blank line
+    @loginator.log( "" )
+
+    # Documentation incorporating Ceedling version tag in URL
+    msg = "Ceedling Packet User Manual (v#{ceedling_tag})\n" +
+          "https://github.com/ThrowTheSwitch/Ceedling/blob/#{ceedling_tag}/docs/CeedlingPacket.md"
+    @loginator.log( msg, Verbosity::NORMAL, LogLabels::DOCUMENTATION )
+
+    # Blank line
+    @loginator.log( "" )
+
+    # Ceedling Suite
+    msg = "Ceedling Suite can help you do more ➡️ https://www.thingamabyte.com/ceedling"
+    @loginator.log( msg, Verbosity::NORMAL, LogLabels::COMMERCIAL )
+
+    # GitHub Sponsors
+    msg = "Please consider supporting this work ➡️ https://github.com/sponsors/throwtheswitch"
+    @loginator.log( msg, Verbosity::NORMAL, LogLabels::REQUEST )
+
+    # Blank line
+    @loginator.log( "" )
+  end
+
+
+  def project_exists?(path, op, *components)
     exists = []
 
     components.each do |f|
@@ -243,12 +277,25 @@ def build_or_plugin_task?(tasks:, default_tasks:)
 
 
   def print_rake_tasks()
-    # (This required digging into Rake internals a bit.)
+    # This all required digging into Rake internals a bit.
+
+    # Monkey patch Rake::Application class to prevent writing to $stdout directly
+    require 'rake_patches'
+    Rake::Application.include( CaptureHelpOutput )
+
     Rake.application.define_singleton_method(:name=) {|n| @name = n}
     Rake.application.name = 'ceedling'
     Rake.application.options.show_tasks = :tasks
     Rake.application.options.show_task_pattern = /^(?!.*build).*$/
-    Rake.application.display_tasks_and_comments()
+
+    # Use our monkey patched help string accessor instead of Rake's `display_tasks_and_comments()`
+    rake_tasks = Rake.application.capture_display_tasks()
+    # Indent task help to match Thow
+    indentation = ' ' * 2
+    rake_tasks.gsub!(/^/, indentation)
+
+    # Add Rake logging output to our logging handler
+    @loginator.log( rake_tasks )
   end
 
 

bin/rake_patches.rb

@@ -0,0 +1,24 @@
+require 'rake'
+require 'stringio'
+
+module CaptureHelpOutput
+  def capture_display_tasks
+    original_stdout = $stdout
+    output_string = StringIO.new
+    $stdout = output_string
+    
+    begin
+      # Call the original method that writes directly to $stdout with printf()
+      display_tasks_and_comments
+    ensure
+      # This block will always execute, even if an exception occurs
+      $stdout = original_stdout
+    end
+
+    # Restore original stdout
+    $stdout = original_stdout
+    
+    # Return the captured output
+    output_string.string
+  end
+end

lib/ceedling/constants.rb

@@ -26,18 +26,21 @@ class Verbosity
 
 # Label + decorator options for logging
 class LogLabels
-  NONE       =  0  # Override logic and settings with no label and no decoration
-  AUTO       =  1  # Default labeling and decorators
-  NOTICE     =  2  # decorator + 'NOTICE:'
-  WARNING    =  3  # decorator + 'WARNING:'
-  ERROR      =  4  # decorator + 'ERROR:'
-  EXCEPTION  =  5  # decorator + 'EXCEPTION:'
-  CONSTRUCT  =  6  # decorator only
-  RUN        =  7  # decorator only
-  CRASH      =  8  # decorator only
-  PASS       =  9  # decorator only
-  FAIL       = 10  # decorator only
-  TITLE      = 11  # decorator only
+  NONE          =  0  # Override logic and settings with no label and no decoration
+  AUTO          =  1  # Default labeling and decorators
+  NOTICE        =  2  # decorator + 'NOTICE:'
+  WARNING       =  3  # decorator + 'WARNING:'
+  ERROR         =  4  # decorator + 'ERROR:'
+  EXCEPTION     =  5  # decorator + 'EXCEPTION:'
+  CONSTRUCT     =  6  # decorator only
+  RUN           =  7  # decorator only
+  CRASH         =  8  # decorator only
+  PASS          =  9  # decorator only
+  FAIL          = 10  # decorator only
+  TITLE         = 11  # decorator only
+  DOCUMENTATION = 12  # decorator only
+  COMMERCIAL    = 13  # decorator only
+  REQUEST       = 14  # decorator only
 
   # Verbosity levels ERRORS – DEBUG default to certain labels or lack thereof
   # The above label constants are available to override Loginator's default AUTO level as needed

lib/ceedling/loginator.rb

@@ -38,8 +38,9 @@ def setup()
 
     @replace = {
       # Problematic characters pattern => Simple characters
-      /↳/ => '>>', # Config sub-entry notation
-      /•/ => '*',  # Bulleted lists
+      /↳/ => '>>',   # Config sub-entry notation
+      /•/ => '*',    # Bulleted lists
+      /➡️/ => '>>',  # Right arrow
     }
 
     @project_logging = false
@@ -170,7 +171,7 @@ def log_debug_backtrace(exception)
       # Send backtrace to debug logging, formatted almost identically to how Ruby does it.
       # Don't log the exception message itself in the first `log()` call as it will already be logged elsewhere
       log( "#{exception.backtrace.first}: (#{exception.class})", Verbosity::DEBUG )
-      log( exception.backtrace.drop(1).map{|s| "\t#{s}"}.join("\n"),                  Verbosity::DEBUG )
+      log( exception.backtrace.drop(1).map{|s| "\t#{s}"}.join("\n"), Verbosity::DEBUG )
   end
 
 
@@ -200,6 +201,12 @@ def decorate(str, label=LogLabels::NONE)
       prepend = '❌ '
     when LogLabels::TITLE
       prepend = '🌱 '
+    when LogLabels::DOCUMENTATION
+      prepend = '📝 '
+    when LogLabels::COMMERCIAL
+      prepend = '💼 '
+    when LogLabels::REQUEST
+      prepend = '🙏 '
     end
 
     return prepend + str