ceedling 1.1.9 → 1.2.0

data/bin/cli_helper.rb

@@ -11,15 +11,15 @@ require 'app_cfg'
 require 'ceedling/constants'
 require 'ceedling/exceptions'
 require 'ceedling/rake_app/rakefile_component_resolver'
-require 'versionator' # Outisde DIY context
+require 'versionator' # Outside DIY context
 
 class CliHelper
 
-  constructor :file_wrapper, :actions_wrapper, :config_walkinator, :path_validator, :rake_task_registry, :loginator, :reportinator, :system_wrapper, :ruby_expandinator
+  constructor :file_wrapper, :actionator, :config_walkinator, :path_validator, :rake_task_registry, :loginator, :reportinator, :system_wrapper, :ruby_expandinator
 
   def setup
     # Aliases
-    @actions = @actions_wrapper
+    @actions = @actionator
     @registry = @rake_task_registry
   end
 
@@ -49,7 +49,7 @@ class CliHelper
 
     # Documentation incorporating Ceedling version tag in URL
     msg = "Ceedling Packet User Manual (v#{ceedling_tag})\n" +
-          "https://throwtheswitch.github.io/Ceedling/#{ceedling_tag}/\n\n"
+          "https://docs.throwtheswitch.org/Ceedling/#{ceedling_tag}/\n\n"
     @loginator.console( msg, LogLabels::DOCUMENTATION )
 
     # Ceedling Suite
@@ -74,28 +74,33 @@ class CliHelper
   end
 
 
-  def create_project_file(dest, local, ceedling_tag)
-    project_filepath = File.join( dest, DEFAULT_PROJECT_FILENAME )
-    source_filepath = File.join( 'assets', DEFAULT_PROJECT_FILENAME )
+  # #1250 -- `ceedling_yml:` names the generated file ALTERNATE_PROJECT_FILENAME
+  # (ceedling.yml) instead of the default DEFAULT_PROJECT_FILENAME (project.yml). Only
+  # the destination filename changes -- both are cloned from the same one template
+  # asset; no second template file exists or is needed.
+  def create_project_file(dest, local, ceedling_tag, ceedling_yml: false)
+    filename = ceedling_yml ? ALTERNATE_PROJECT_FILENAME : DEFAULT_PROJECT_FILENAME
+    project_filepath = File.join( dest, filename )
+    source_filepath = File.join( 'assets', 'features', DEFAULT_PROJECT_FILENAME )
 
     # Clone the project file
-    @actions._copy_file( source_filepath, project_filepath, :force => true)
+    @actions.copy_file( source_filepath, project_filepath, force: true)
 
     # Silently update internal version
-    @actions._gsub_file(
+    @actions.gsub_file(
       project_filepath,
       /:ceedling_version:\s+'\?'/,
       ":ceedling_version: #{ceedling_tag}",
-      :verbose => false
+      verbose: false
     )
 
     # Silently path to point at local install
     if local
-      @actions._gsub_file(
+      @actions.gsub_file(
         project_filepath,
         /:which_ceedling:\s+gem/,
         ":which_ceedling: vendor/ceedling",
-        :verbose => false
+        verbose: false
       )
     end
   end
@@ -228,6 +233,16 @@ class CliHelper
   end
 
 
+  def process_force_test_rerun(force_test_rerun:, tasks:, default_tasks:)
+    # Do nothing if the flag wasn't set
+    return if !force_test_rerun
+
+    unless test_task?( tasks: (tasks.empty? ? default_tasks : tasks ) )
+      raise CeedlingException.new( "The force test rerun option is only applicable to test tasks. No test tasks were specified." )
+    end
+  end
+
+
   def process_graceful_fail(config:, cmdline_graceful_fail:, tasks:, default_tasks:)
     # Precedence
     #  1. Command line option
@@ -279,7 +294,7 @@ class CliHelper
     # If logging is enabled without a filepath in --logfile, then set up the default path
     elsif log
       filepath = File.join( logging_path, DEFAULT_CEEDLING_LOGFILE )
-    elsif logfile.empty?
+    else
       return ''
     end
 
@@ -402,7 +417,12 @@ class CliHelper
     PROJECT_VERBOSITY.freeze()
 
     # Create global constant PROJECT_DEBUG
-    debug = (verbosity == Verbosity::DEBUG)
+    #
+    # `debug` is read by the module_eval string below, which RuboCop cannot see into.
+    # The cop reads the assignment as useless and offers to delete it. Accepting that
+    # leaves the eval referencing a local that was never assigned, so PROJECT_DEBUG
+    # raises NameError. Do not autocorrect this line.
+    debug = (verbosity == Verbosity::DEBUG) # rubocop:disable Lint/UselessAssignment
     Object.send(:remove_const, 'PROJECT_DEBUG') if Object.const_defined?('PROJECT_DEBUG')
     Object.module_eval("PROJECT_DEBUG = debug")
     PROJECT_DEBUG.freeze()
@@ -426,7 +446,7 @@ class CliHelper
       # If we fail to find the section path, blow up
       if value.nil?
         # Reformat list of symbols to list of :<section>s
-        _sections.map! {|section| ":#{section.to_s}"}
+        _sections.map! {|section| ":#{section}"}
         msg = "Cound not find configuration section #{_sections.join(' ↳ ')}"
         raise(msg)
       end
@@ -435,7 +455,13 @@ class CliHelper
       _config = { _sections.last => value }
     end
 
-    File.open( filepath, 'w' ) {|out| YAML.dump( _config, out )}
+    # A nil filepath is the --stdout signal threaded down from the CLI layer --
+    # write the YAML directly to standard output instead of a file.
+    if filepath.nil?
+      YAML.dump( _config, $stdout )
+    else
+      File.open( filepath, 'w' ) {|out| YAML.dump( _config, out )}
+    end
   end
 
 
@@ -476,7 +502,7 @@ class CliHelper
       # Form glob to collect all markdown files
       glob = File.join( ceedling_root, src, '*.md' )
       # Look up markdown files
-      listing = @file_wrapper.directory_listing( glob ) # Already case-insensitive
+      listing = @file_wrapper.directory_listing( glob )
       # For each markdown filepath, add to hash
       listing.each do |filepath|
         # Reassign destination
@@ -492,12 +518,9 @@ class CliHelper
       'cmock'       => 'vendor/cmock',
       'c_exception' => 'vendor/c_exception',
     }.each do |dest, src|
-      glob = File.join( ceedling_root, src, 'license.txt' )
-      # Look up licenses (use glob as capitalization can be inconsistent)
-      listing = @file_wrapper.directory_listing( glob ) # Already case-insensitive
-      # Safety check on nil references since we explicitly reference first element
-      next if listing.empty?
-      filepath = listing.first
+      filepath = license_filepath( File.join( ceedling_root, src ) )
+      next if filepath.nil?
+
       # Reassign dest
       dest = File.join( dest, File.basename( filepath ) )
       doc_files[ dest ] = filepath
@@ -505,13 +528,13 @@ class CliHelper
 
     # Copy all individual documentation files gathered up
     doc_files.each_pair do |_dest, src|
-      @actions._copy_file(src, File.join( dest, _dest ), :force => true )
+      @actions.copy_file(src, File.join( dest, _dest ), force: true )
     end
 
     # If present copy internl HTML documentation bundle (site-local/) to docs/ceedling/
     site_local_path = File.join( ceedling_root, DOCS_SITE_LOCAL_PATH )
     if @file_wrapper.directory?( site_local_path )
-      @actions._directory( site_local_path, docs_path_ceedling, :force => true )
+      @actions.copy_directory( site_local_path, docs_path_ceedling, force: true )
     else
       @loginator.console( "Internal HTML documentation bundle not found", LogLabels::WARNING )
       return
@@ -533,15 +556,15 @@ class CliHelper
 
     # Copy folders from current Ceedling into project
     %w{plugins lib bin}.each do |folder|
-      @actions._directory( 
+      @actions.copy_directory( 
         folder,
         File.join( vendor_path, folder ),
-        :force => true
+        force: true
       )
     end
 
     # Mark ceedling as an executable
-    @actions._chmod( File.join( vendor_path, 'bin', 'ceedling' ), 0755 ) unless @system_wrapper.windows?
+    @actions.chmod( File.join( vendor_path, 'bin', 'ceedling' ), 0755 ) unless @system_wrapper.windows?
 
     # Assembly necessary subcomponent dirs
     components = [
@@ -559,14 +582,17 @@ class CliHelper
       _src = path
       _dest = File.join( vendor_path, path )
       # Copy entire directory, filter out any junk files
-      @actions._directory(
+      @actions.copy_directory(
         _src, _dest,
-        :force => true
+        force: true
       )
     end
 
     # Add licenses from Ceedling and supporting projects
     license_files = {}
+    # Only the vendor/ subcomponents, which arrive here as selected subdirectories and
+    # so would otherwise come without their licenses. plugins/, lib/, and bin/ are
+    # copied whole above, which already carries fff's license along with its source.
     [ # Source paths
       '.', # Ceedling
       'vendor/unity',
@@ -574,56 +600,71 @@ class CliHelper
       'vendor/c_exception',
       'vendor/diy'
     ].each do |src|
-      # Look up licenses using a Glob as capitalization can be inconsistent
-      glob = File.join( ceedling_root, src, 'license.txt' )
-      listing = @file_wrapper.directory_listing( glob ) # Already case-insensitive
-      
-      # Safety check on nil references since we explicitly reference first element
-      next if listing.empty?
-      
-      # Add license copying to hash      
-      license = listing.first
+      license = license_filepath( File.join( ceedling_root, src ) )
+      next if license.nil?
+
+      # Add license copying to hash
       filepath = File.join( vendor_path, src, File.basename( license ) )
       license_files[ filepath ] = license
     end
 
     # Copy license files into place
     license_files.each_pair do |dest, src|
-      @actions._copy_file( src, dest, :force => true)
+      @actions.copy_file( src, dest, force: true)
     end
 
     # Silently copy Git SHA file for version #.#.#-build lookups if it exists
     if @file_wrapper.exist?( File.join( ceedling_root, GIT_COMMIT_SHA_FILENAME) )
-      @actions._copy_file(
+      @actions.copy_file(
         GIT_COMMIT_SHA_FILENAME,
         File.join( vendor_path, GIT_COMMIT_SHA_FILENAME ),
-        :force => true, :verbose => false
+        force: true, verbose: false
       )
     end
 
     # Create executable helper scripts in project root
     if @system_wrapper.windows?
       # Windows command prompt launch script
-      @actions._copy_file(
-        File.join( 'assets', 'ceedling.cmd'),
+      @actions.copy_file(
+        File.join( 'assets', 'features', 'ceedling.cmd'),
         File.join( dest, 'ceedling.cmd'),
-        :force => true
+        force: true
       )
     else
       # Unix shell launch script
       launch = File.join( dest, 'ceedling')
-      @actions._copy_file(
-        File.join( 'assets', 'ceedling'),
+      @actions.copy_file(
+        File.join( 'assets', 'features', 'ceedling'),
         launch,
-        :force => true
+        force: true
       )
-      @actions._chmod( launch, 0755 )
+      @actions.chmod( launch, 0755 )
     end
   end
 
 
   private
 
+  # Matches a license filename whatever its capitalization and extension. The vendored
+  # projects disagree on all three: `license.txt`, `LICENSE.txt`, and fff's
+  # extensionless `LICENSE` all appear.
+  LICENSE_FILENAME = /\Alicen[sc]e/i
+
+  # Absolute path to a directory's license file, or nil when it holds none.
+  #
+  # Entry matching rather than a glob, because a glob cannot do this portably. A
+  # lowercase pattern finds `LICENSE.txt` only where the filesystem happens to be case
+  # insensitive, so globbing succeeded on macOS and dropped the Unity, CMock, and DIY
+  # licenses on Linux.
+  def license_filepath(directory)
+    return nil unless @file_wrapper.directory?( directory )
+
+    name = @file_wrapper.directory_entries( directory ).grep( LICENSE_FILENAME ).first
+    return nil if name.nil?
+
+    File.join( directory, name )
+  end
+
   def project_name_banner(config)
     name, _ = @config_walkinator.fetch_value( :project, :name, hash:config )
     return nil if name.nil? || name.empty?

data/bin/cli_options_transform.rb

@@ -0,0 +1,22 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+# Transforms Thor command options into the parameters CliHandler/CliHelper
+# expect. Kept free of any Thor dependency -- it only ever touches plain
+# Hashes -- so this logic is testable without configuring or invoking Thor.
+module CliOptionsTransform
+
+  # Every application command hides a --debug convenience flag that forces
+  # Verbosity::DEBUG. When --debug isn't set, :verbosity is left exactly as
+  # the caller already has it -- an explicit fallback set beforehand, an
+  # already-parsed --verbosity flag, or simply absent.
+  def self.apply_debug_flag(options)
+    options[:verbosity] = Verbosity::DEBUG if options[:debug]
+    return options
+  end
+
+end

data/bin/{configinator.rb → composinator.rb}

@@ -5,14 +5,13 @@
 #   SPDX-License-Identifier: MIT
 # =========================================================================
 
-require 'deep_merge'
 require 'ceedling/constants'
 
-class Configinator
+class Composinator
 
-  constructor :config_walkinator, :projectinator, :mixinator
+  constructor :config_walkinator, :projectinator, :mixin_resolvinator, :mixinator
 
-  def loadinate(builtin_mixins:, builtin_load_paths:[], filepath:nil, mixins:[], env:{}, silent:false)
+  def loadinate(builtin_load_paths:[], filepath:nil, mixins:[], env:{}, silent:false)
     # Aliases for clarity
     cmdline_filepath = filepath
     cmdline_mixins = mixins || []
@@ -21,10 +20,10 @@ class Configinator
     project_filepath, config = @projectinator.load( filepath:cmdline_filepath, env:env, silent:silent )
 
     # Extract cfg_enabled_mixins mixins list plus load paths list from config
-    cfg_enabled_mixins, cfg_load_paths = @projectinator.extract_mixins( config: config )
+    cfg_enabled_mixins, cfg_load_paths = @mixin_resolvinator.extract_mixins( config: config )
 
-    # Get our YAML file extension
-    yaml_ext = @projectinator.lookup_yaml_extension( config:config )
+    # Mixin filename extensions, from :extension ↳ :yaml if the project sets it
+    yaml_exts = @projectinator.lookup_yaml_extensions( config:config )
 
     # Remove any silly redundancies
     cfg_enabled_mixins.uniq!
@@ -59,26 +58,24 @@ class Configinator
     cmdline_file_values.uniq!
 
     # Validate :cfg_load_paths from :mixins section of project configuration
-    @projectinator.validate_mixin_load_paths( cfg_load_paths )
+    @mixin_resolvinator.validate_mixin_load_paths( cfg_load_paths )
 
     # Validate enabled mixins from :mixins section of project configuration
-    if not @projectinator.validate_mixins(
+    if not @mixin_resolvinator.validate_mixins(
       mixins: cfg_enabled_mixins,
       load_paths: cfg_load_paths,
-      builtins: builtin_mixins,
       source: 'Config :mixins ↳ :enabled =>',
-      yaml_extension: yaml_ext
+      yaml_extensions: yaml_exts
     )
       raise 'Project configuration file section :mixins failed validation'
     end
 
     # Validate only file-based cmdline entries; inline YAML is validated separately below
-    if not @projectinator.validate_mixins(
+    if not @mixin_resolvinator.validate_mixins(
       mixins: cmdline_file_values,
       load_paths: cfg_load_paths,
-      builtins: builtin_mixins,
       source: 'Mixin',
-      yaml_extension: yaml_ext
+      yaml_extensions: yaml_exts
     )
       raise 'Command line failed validation'
     end
@@ -86,13 +83,12 @@ class Configinator
     # Validate inline YAML strings: must parse cleanly and produce a Hash
     @mixinator.validate_cmdline_yaml_strings( cmdline_yaml_values )
 
-    # Find mixins in project file among load paths or built-in mixins
-    # Return ordered list of filepaths or built-in mixin names
-    config_mixins = @projectinator.lookup_mixins(
+    # Find mixins in project file among load paths
+    # Return ordered list of filepaths
+    config_mixins = @mixin_resolvinator.lookup_mixins(
       mixins: cfg_enabled_mixins,
       load_paths: cfg_load_paths,
-      builtins: builtin_mixins,
-      yaml_extension: yaml_ext
+      yaml_extensions: yaml_exts
     )
 
     # Pre-build config entries as tagged hashes carrying both the resolved path and
@@ -102,32 +98,41 @@ class Configinator
       {'project configuration' => path, :_input => name}
     end
 
-    # Resolve file-based names/paths to canonical filepaths (or built-in keys).
+    # Resolve file-based names/paths to canonical filepaths.
     # Returns values in the same order as the input; zip them back into a hash for
     # O(1) lookup when reconstructing positional order below.
-    resolved_file_values = @projectinator.lookup_mixins(
+    resolved_file_values = @mixin_resolvinator.lookup_mixins(
       mixins: cmdline_file_values,
       load_paths: cfg_load_paths,
-      builtins: builtin_mixins,
-      yaml_extension: yaml_ext
+      yaml_extensions: yaml_exts
     )
     file_resolution_map = Hash[cmdline_file_values.zip(resolved_file_values)]
 
+    # A repeated raw --mixin value (e.g. `--mixin foo.yml --mixin bar.yml
+    # --mixin foo.yml`) must resolve using its LAST occurrence's position, not
+    # its first, so the user's actual last-typed flag ends up last (highest
+    # priority) -- matching ordinary left-to-right command line override
+    # semantics. Record the index of each file value's last occurrence so the
+    # reconstruction below can keep only that one.
+    last_file_index = {}
+    tagged_cmdline.each_with_index do |e, idx|
+      last_file_index[e[:value]] = idx if e[:type] == :file
+    end
+
     # Reconstruct the full cmdline sequence in original left-to-right order,
     # replacing stripped file values with their resolved forms and tagging each
     # entry with a source label that mixin() uses to select the load strategy.
-    # File entries that were deduplicated (absent from map after first use) are
-    # skipped — delete after first fetch enforces single-use per unique value.
-    cmdline_ordered = tagged_cmdline.each_with_object([]) do |e, arr|
+    # An earlier occurrence of a file value superseded by a later, identical
+    # one is skipped entirely -- only the last occurrence's position survives.
+    cmdline_ordered = tagged_cmdline.each_with_index.each_with_object([]) do |(e, idx), arr|
       if e[:type] == :yaml
         # Inline YAML: source label 'command line (inline)' triggers load_string() in mixin()
         # :_input carries the raw YAML string as the original user value for history traceability
         arr << {'command line (inline)' => e[:value], :_input => e[:value]}
-      elsif (resolved = file_resolution_map[e[:value]])
+      elsif idx == last_file_index[e[:value]]
         # File/name: source label 'command line' triggers existing file/builtin dispatch in mixin()
         # :_input carries the original user-provided value (before load-path resolution) for history
-        arr << {'command line' => resolved, :_input => e[:value]}
-        file_resolution_map.delete(e[:value])  # consume so duplicate raw values are skipped
+        arr << {'command line' => file_resolution_map[e[:value]], :_input => e[:value]}
       end
     end
 
@@ -147,7 +152,7 @@ class Configinator
     )
 
     # Merge mixins
-    @mixinator.mixin( builtins:builtin_mixins, config:config, mixins:mixins_assembled )
+    @mixinator.mixin( config:config, mixins:mixins_assembled )
 
     return project_filepath, config
   end
@@ -160,8 +165,10 @@ class Configinator
       # Update method parameter to config value
       default_tasks = value.dup()
     else
-      # Set key/value in config if it's not set
-      config.deep_merge( {:project => {:default_tasks => default_tasks}} )
+      # Set key/value in config if it's not set, without disturbing any other
+      # existing :project keys
+      config[:project] ||= {}
+      config[:project][:default_tasks] = default_tasks
     end
 
     return default_tasks

data/bin/mixin_resolvinator.rb

@@ -0,0 +1,124 @@
+# =========================================================================
+#   Ceedling - Test-Centered Build System for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
+
+require 'ceedling/constants' # From Ceedling application
+
+class MixinResolvinator
+
+  constructor :file_wrapper, :path_validator, :loginator, :ruby_expandinator
+
+  # Pick apart a :mixins projcet configuration section and return components
+  # Layout mirrors :plugins section
+  def extract_mixins(config:)
+    # Get mixins config hash
+    _mixins = config[:mixins]
+
+    # If no :mixins section, return:
+    #  - Empty enabled list
+    #  - Empty load paths
+    return [], [] if _mixins.nil?
+
+    # Build list of load paths
+    # Configured load paths are higher in search path ordering
+    load_paths = _mixins[:load_paths] || []
+
+    # Get list of mixins
+    enabled = _mixins[:enabled] || []
+    enabled = enabled.clone # Ensure it's a copy of configuration section
+
+    # Handle any inline Ruby string expansion, then standardize Windows backslashes --
+    # cmdline and env var mixin paths already go through standardize_paths elsewhere,
+    # so config :mixins section paths need the same treatment for consistency.
+    load_paths.each do |load_path|
+      load_path.replace( @ruby_expandinator.expand( load_path, source: ":mixins ↳ :load_paths" ) )
+      load_path.replace( @path_validator.standardize_paths( load_path ).first )
+    end
+
+    enabled.each do |mixin|
+      mixin.replace( @ruby_expandinator.expand( mixin, source: ":mixins ↳ :enabled" ) )
+      mixin.replace( @path_validator.standardize_paths( mixin ).first )
+    end
+
+    # Remove the :mixins section of the configuration
+    config.delete( :mixins )
+
+    return enabled, load_paths
+  end
+
+
+  # Validate :load_paths from :mixins section in project configuration
+  def validate_mixin_load_paths(load_paths)
+    validated = @path_validator.validate(
+      paths: load_paths,
+      source: 'Config :mixins ↳ :load_paths =>',
+      type: :directory
+    )
+
+    if !validated
+      raise 'Project configuration file section :mixins failed validation'
+    end
+  end
+
+
+  # Validate mixins list
+  def validate_mixins(mixins:, load_paths:, source:, yaml_extensions:)
+    validated = true
+
+    mixins.each do |mixin|
+      # Validate mixin filepaths
+      if @path_validator.filepath?( mixin )
+        if !@file_wrapper.exist?( mixin )
+          @loginator.log( "Cannot find mixin at #{mixin}", Verbosity::ERRORS )
+          validated = false
+        end
+
+      # Otherwise, validate that mixin name can be found in load paths
+      elsif mixin_filepath( mixin, load_paths, yaml_extensions ).nil?
+        filenames = yaml_extensions.map { |extension| "'#{mixin}#{extension}'" }.join( ' or ' )
+        @loginator.log( "#{source} '#{mixin}' cannot be found in mixin load paths as #{filenames}", Verbosity::ERRORS )
+        validated = false
+      end
+    end
+
+    return validated
+  end
+
+
+  # Yield ordered list of filepaths
+  def lookup_mixins(mixins:, load_paths:, yaml_extensions:)
+    _mixins = []
+
+    # Already validated, so we know any mixin filepath or name is found in load_paths
+
+    # Fill filepaths array with filepaths
+    mixins.each do |mixin|
+      # Handle explicit filepaths
+      if @path_validator.filepath?( mixin )
+        _mixins << mixin
+        next # Success, move on in mixin iteration
+      end
+
+      # Look for mixin in load paths. Failing that, add the unmodified name to the list.
+      # validate_mixins() should have already confirmed it exists in load_paths.
+      _mixins << (mixin_filepath( mixin, load_paths, yaml_extensions ) || mixin)
+    end
+
+    return _mixins
+  end
+
+  ### Private ###
+
+  private
+
+  # The first existing file named for the mixin, searching each load path in turn for each
+  # extension
+  def mixin_filepath(mixin, load_paths, yaml_extensions)
+    candidates = load_paths.product( yaml_extensions ).map { |path, extension| File.join( path, mixin + extension ) }
+    return candidates.find { |filepath| @file_wrapper.exist?( filepath ) }
+  end
+
+end