ceedling 0.13.0 → 0.15.0

data/lib/{configurator_validator.rb → ceedling/configurator_validator.rb}

@@ -1,184 +1,184 @@
-require 'rubygems'
-require 'rake' # for ext()
-require 'constants'
-require 'tool_executor'    # for argument replacement pattern
-require 'file_path_utils'  # for glob handling class methods
-
-
-class ConfiguratorValidator
-  
-  constructor :file_wrapper, :stream_wrapper, :system_wrapper
-
-  # walk into config hash verify existence of data at key depth
-  def exists?(config, *keys)
-    hash  = retrieve_value(config, keys)
-    exist = !hash[:value].nil?
-
-    if (not exist)
-      # no verbosity checking since this is lowest level anyhow & verbosity checking depends on configurator
-      @stream_wrapper.stderr_puts("ERROR: Required config file entry #{format_key_sequence(keys, hash[:depth])} does not exist.")    
-    end
-    
-    return exist
-  end
-
-
-  # walk into config hash. verify directory path(s) at given key depth
-  def validate_path_list(config, *keys)
-    hash = retrieve_value(config, keys)
-    list = hash[:value]
-
-    # return early if we couldn't walk into hash and find a value
-    return false if (list.nil?)
-
-    path_list = []
-    exist = true
-    
-    case list
-      when String then path_list << list
-      when Array  then path_list =  list
-    end
-    
-    path_list.each do |path|
-      base_path = FilePathUtils::extract_path(path) # lop off add/subtract notation & glob specifiers
-      
-      if (not @file_wrapper.exist?(base_path))
-        # no verbosity checking since this is lowest level anyhow & verbosity checking depends on configurator
-        @stream_wrapper.stderr_puts("ERROR: Config path #{format_key_sequence(keys, hash[:depth])}['#{base_path}'] does not exist on disk.") 
-        exist = false
-      end 
-    end
-    
-    return exist
-  end
-
-  
-  # simple path verification
-  def validate_filepath_simple(path, *keys)
-    validate_path = path
-    
-    if (not @file_wrapper.exist?(validate_path))
-      # no verbosity checking since this is lowest level anyhow & verbosity checking depends on configurator
-      @stream_wrapper.stderr_puts("ERROR: Config path '#{validate_path}' associated with #{format_key_sequence(keys, keys.size)} does not exist on disk.") 
-      return false
-    end 
-    
-    return true
-  end
- 
-  # walk into config hash. verify specified file exists.
-  def validate_filepath(config, *keys)
-    hash          = retrieve_value(config, keys)
-    filepath      = hash[:value]
-
-    # return early if we couldn't walk into hash and find a value
-    return false if (filepath.nil?)
-
-    # skip everything if we've got an argument replacement pattern
-    return true if (filepath =~ TOOL_EXECUTOR_ARGUMENT_REPLACEMENT_PATTERN)
-    
-    if (not @file_wrapper.exist?(filepath))
-      # no verbosity checking since this is lowest level anyhow & verbosity checking depends on configurator
-      @stream_wrapper.stderr_puts("ERROR: Config filepath #{format_key_sequence(keys, hash[:depth])}['#{filepath}'] does not exist on disk.") 
-      return false
-    end      
-
-    return true
-  end
-
-  # walk into config hash. verify specified file exists.
-  def validate_executable_filepath(config, *keys)
-    exe_extension = config[:extension][:executable]
-    hash          = retrieve_value(config, keys)
-    filepath      = hash[:value]
-
-    # return early if we couldn't walk into hash and find a value
-    return false if (filepath.nil?)
-
-    # skip everything if we've got an argument replacement pattern
-    return true if (filepath =~ TOOL_EXECUTOR_ARGUMENT_REPLACEMENT_PATTERN)
-    
-    # if there's no path included, verify file exists somewhere in system search paths
-    if (not filepath.include?('/'))
-      exists = false
-      
-      @system_wrapper.search_paths.each do |path|
-        if (@file_wrapper.exist?( File.join(path, filepath)) )
-          exists = true
-          break
-        end
-        
-        if (@file_wrapper.exist?( (File.join(path, filepath)).ext( exe_extension ) ))
-          exists = true
-          break
-        elsif (@system_wrapper.windows? and @file_wrapper.exist?( (File.join(path, filepath)).ext( EXTENSION_WIN_EXE ) ))
-          exists = true
-          break
-        end
-      end
-      
-      if (not exists)
-        # no verbosity checking since this is lowest level anyhow & verbosity checking depends on configurator
-        @stream_wrapper.stderr_puts("ERROR: Config filepath #{format_key_sequence(keys, hash[:depth])}['#{filepath}'] does not exist in system search paths.") 
-        return false        
-      end
-      
-    # if there is a path included, check that explicit filepath exists
-    else
-      if (not @file_wrapper.exist?(filepath))
-        # no verbosity checking since this is lowest level anyhow & verbosity checking depends on configurator
-        @stream_wrapper.stderr_puts("ERROR: Config filepath #{format_key_sequence(keys, hash[:depth])}['#{filepath}'] does not exist on disk.") 
-        return false
-      end      
-    end
-
-    return true
-  end
-  
-  def validate_tool_stderr_redirect(config, tools, tool)
-    redirect = config[tools][tool][:stderr_redirect]
-    if (redirect.class == Symbol)
-      # map constants and force to array of strings for runtime universality across ruby versions
-      if (not StdErrRedirect.constants.map{|constant| constant.to_s}.include?(redirect.to_s.upcase))
-        error = "ERROR: [:#{tools}][:#{tool}][:stderr_redirect][:#{redirect}] is not a recognized option " +
-                "{#{StdErrRedirect.constants.map{|constant| ':' + constant.to_s.downcase}.join(', ')}}."
-        @stream_wrapper.stderr_puts(error) 
-        return false        
-      end
-    end
-    
-    return true
-  end
-  
-  private #########################################
-  
-  
-  def retrieve_value(config, keys)
-    value = nil
-    hash  = config
-    depth = 0
-
-    # walk into hash & extract value at requested key sequence
-    keys.each do |symbol|
-      depth += 1
-      if (not hash[symbol].nil?)
-        hash  = hash[symbol]
-        value = hash
-      else
-        value = nil
-        break
-      end
-    end
-    
-    return {:value => value, :depth => depth}
-  end
-
-
-  def format_key_sequence(keys, depth)
-    walked_keys    = keys.slice(0, depth)
-    formatted_keys = walked_keys.map{|key| "[:#{key.to_s}]"}
-    
-    return formatted_keys.join
-  end
-  
-end
+require 'rubygems'
+require 'rake' # for ext()
+require 'ceedling/constants'
+require 'ceedling/tool_executor'    # for argument replacement pattern
+require 'ceedling/file_path_utils'  # for glob handling class methods
+
+
+class ConfiguratorValidator
+  
+  constructor :file_wrapper, :stream_wrapper, :system_wrapper
+
+  # walk into config hash verify existence of data at key depth
+  def exists?(config, *keys)
+    hash  = retrieve_value(config, keys)
+    exist = !hash[:value].nil?
+
+    if (not exist)
+      # no verbosity checking since this is lowest level anyhow & verbosity checking depends on configurator
+      @stream_wrapper.stderr_puts("ERROR: Required config file entry #{format_key_sequence(keys, hash[:depth])} does not exist.")    
+    end
+    
+    return exist
+  end
+
+
+  # walk into config hash. verify directory path(s) at given key depth
+  def validate_path_list(config, *keys)
+    hash = retrieve_value(config, keys)
+    list = hash[:value]
+
+    # return early if we couldn't walk into hash and find a value
+    return false if (list.nil?)
+
+    path_list = []
+    exist = true
+    
+    case list
+      when String then path_list << list
+      when Array  then path_list =  list
+    end
+    
+    path_list.each do |path|
+      base_path = FilePathUtils::extract_path(path) # lop off add/subtract notation & glob specifiers
+      
+      if (not @file_wrapper.exist?(base_path))
+        # no verbosity checking since this is lowest level anyhow & verbosity checking depends on configurator
+        @stream_wrapper.stderr_puts("ERROR: Config path #{format_key_sequence(keys, hash[:depth])}['#{base_path}'] does not exist on disk.") 
+        exist = false
+      end 
+    end
+    
+    return exist
+  end
+
+  
+  # simple path verification
+  def validate_filepath_simple(path, *keys)
+    validate_path = path
+    
+    if (not @file_wrapper.exist?(validate_path))
+      # no verbosity checking since this is lowest level anyhow & verbosity checking depends on configurator
+      @stream_wrapper.stderr_puts("ERROR: Config path '#{validate_path}' associated with #{format_key_sequence(keys, keys.size)} does not exist on disk.") 
+      return false
+    end 
+    
+    return true
+  end
+ 
+  # walk into config hash. verify specified file exists.
+  def validate_filepath(config, *keys)
+    hash          = retrieve_value(config, keys)
+    filepath      = hash[:value]
+
+    # return early if we couldn't walk into hash and find a value
+    return false if (filepath.nil?)
+
+    # skip everything if we've got an argument replacement pattern
+    return true if (filepath =~ TOOL_EXECUTOR_ARGUMENT_REPLACEMENT_PATTERN)
+    
+    if (not @file_wrapper.exist?(filepath))
+      # no verbosity checking since this is lowest level anyhow & verbosity checking depends on configurator
+      @stream_wrapper.stderr_puts("ERROR: Config filepath #{format_key_sequence(keys, hash[:depth])}['#{filepath}'] does not exist on disk.") 
+      return false
+    end      
+
+    return true
+  end
+
+  # walk into config hash. verify specified file exists.
+  def validate_executable_filepath(config, *keys)
+    exe_extension = config[:extension][:executable]
+    hash          = retrieve_value(config, keys)
+    filepath      = hash[:value]
+
+    # return early if we couldn't walk into hash and find a value
+    return false if (filepath.nil?)
+
+    # skip everything if we've got an argument replacement pattern
+    return true if (filepath =~ TOOL_EXECUTOR_ARGUMENT_REPLACEMENT_PATTERN)
+    
+    # if there's no path included, verify file exists somewhere in system search paths
+    if (not filepath.include?('/'))
+      exists = false
+      
+      @system_wrapper.search_paths.each do |path|
+        if (@file_wrapper.exist?( File.join(path, filepath)) )
+          exists = true
+          break
+        end
+        
+        if (@file_wrapper.exist?( (File.join(path, filepath)).ext( exe_extension ) ))
+          exists = true
+          break
+        elsif (@system_wrapper.windows? and @file_wrapper.exist?( (File.join(path, filepath)).ext( EXTENSION_WIN_EXE ) ))
+          exists = true
+          break
+        end
+      end
+      
+      if (not exists)
+        # no verbosity checking since this is lowest level anyhow & verbosity checking depends on configurator
+        @stream_wrapper.stderr_puts("ERROR: Config filepath #{format_key_sequence(keys, hash[:depth])}['#{filepath}'] does not exist in system search paths.") 
+        return false        
+      end
+      
+    # if there is a path included, check that explicit filepath exists
+    else
+      if (not @file_wrapper.exist?(filepath))
+        # no verbosity checking since this is lowest level anyhow & verbosity checking depends on configurator
+        @stream_wrapper.stderr_puts("ERROR: Config filepath #{format_key_sequence(keys, hash[:depth])}['#{filepath}'] does not exist on disk.") 
+        return false
+      end      
+    end
+
+    return true
+  end
+  
+  def validate_tool_stderr_redirect(config, tools, tool)
+    redirect = config[tools][tool][:stderr_redirect]
+    if (redirect.class == Symbol)
+      # map constants and force to array of strings for runtime universality across ruby versions
+      if (not StdErrRedirect.constants.map{|constant| constant.to_s}.include?(redirect.to_s.upcase))
+        error = "ERROR: [:#{tools}][:#{tool}][:stderr_redirect][:#{redirect}] is not a recognized option " +
+                "{#{StdErrRedirect.constants.map{|constant| ':' + constant.to_s.downcase}.join(', ')}}."
+        @stream_wrapper.stderr_puts(error) 
+        return false        
+      end
+    end
+    
+    return true
+  end
+  
+  private #########################################
+  
+  
+  def retrieve_value(config, keys)
+    value = nil
+    hash  = config
+    depth = 0
+
+    # walk into hash & extract value at requested key sequence
+    keys.each do |symbol|
+      depth += 1
+      if (not hash[symbol].nil?)
+        hash  = hash[symbol]
+        value = hash
+      else
+        value = nil
+        break
+      end
+    end
+    
+    return {:value => value, :depth => depth}
+  end
+
+
+  def format_key_sequence(keys, depth)
+    walked_keys    = keys.slice(0, depth)
+    formatted_keys = walked_keys.map{|key| "[:#{key.to_s}]"}
+    
+    return formatted_keys.join
+  end
+  
+end

data/lib/{constants.rb → ceedling/constants.rb}

@@ -32,6 +32,9 @@ class BackgroundExec
   UNIX = :unix
 end
 
+unless defined?(PROJECT_ROOT)
+  PROJECT_ROOT = Dir.pwd()
+end
 
 EXTENSION_WIN_EXE    = '.exe'
 EXTENSION_NONWIN_EXE = '.out'
@@ -54,30 +57,30 @@ CMOCK_C_FILE    = 'cmock.c'
 CMOCK_H_FILE    = 'cmock.h'
 
 
-DEFAULT_CEEDLING_MAIN_PROJECT_FILE = 'project.yml' # main project file
-DEFAULT_CEEDLING_USER_PROJECT_FILE = 'user.yml'    # supplemental user config file
+DEFAULT_CEEDLING_MAIN_PROJECT_FILE = 'project.yml' unless defined?(DEFAULT_CEEDLING_MAIN_PROJECT_FILE) # main project file
+DEFAULT_CEEDLING_USER_PROJECT_FILE = 'user.yml'    unless defined?(DEFAULT_CEEDLING_USER_PROJECT_FILE) # supplemental user config file
 
-INPUT_CONFIGURATION_CACHE_FILE     = 'input.yml'   # input configuration file dump
+INPUT_CONFIGURATION_CACHE_FILE     = 'input.yml'   unless defined?(INPUT_CONFIGURATION_CACHE_FILE)     # input configuration file dump
 
 
-TEST_ROOT_NAME    = 'test'
-TEST_TASK_ROOT    = TEST_ROOT_NAME + ':'
-TEST_SYM          = TEST_ROOT_NAME.to_sym
+TEST_ROOT_NAME    = 'test'                unless defined?(TEST_ROOT_NAME)
+TEST_TASK_ROOT    = TEST_ROOT_NAME + ':'  unless defined?(TEST_TASK_ROOT)
+TEST_SYM          = TEST_ROOT_NAME.to_sym unless defined?(TEST_SYM)
 
-RELEASE_ROOT_NAME = 'release'
-RELEASE_TASK_ROOT = RELEASE_ROOT_NAME + ':'
-RELEASE_SYM       = RELEASE_ROOT_NAME.to_sym
+RELEASE_ROOT_NAME = 'release'                unless defined?(RELEASE_ROOT_NAME)
+RELEASE_TASK_ROOT = RELEASE_ROOT_NAME + ':'  unless defined?(RELEASE_TASK_ROOT)
+RELEASE_SYM       = RELEASE_ROOT_NAME.to_sym unless defined?(RELEASE_SYM)
 
-REFRESH_ROOT_NAME = 'refresh'
-REFRESH_TASK_ROOT = REFRESH_ROOT_NAME + ':'
-REFRESH_SYM       = REFRESH_ROOT_NAME.to_sym
+REFRESH_ROOT_NAME = 'refresh'                unless defined?(REFRESH_ROOT_NAME)
+REFRESH_TASK_ROOT = REFRESH_ROOT_NAME + ':'  unless defined?(REFRESH_TASK_ROOT)
+REFRESH_SYM       = REFRESH_ROOT_NAME.to_sym unless defined?(REFRESH_SYM)
 
-UTILS_ROOT_NAME   = 'utils'
-UTILS_TASK_ROOT   = UTILS_ROOT_NAME + ':'
-UTILS_SYM         = UTILS_ROOT_NAME.to_sym
+UTILS_ROOT_NAME   = 'utils'                unless defined?(UTILS_ROOT_NAME)
+UTILS_TASK_ROOT   = UTILS_ROOT_NAME + ':'  unless defined?(UTILS_TASK_ROOT)
+UTILS_SYM         = UTILS_ROOT_NAME.to_sym unless defined?(UTILS_SYM)
 
-OPERATION_COMPILE_SYM = :compile
-OPERATION_LINK_SYM    = :link
+OPERATION_COMPILE_SYM = :compile unless defined?(OPERATION_COMPILE_SYM)
+OPERATION_LINK_SYM    = :link    unless defined?(OPERATION_LINK_SYM)
 
 
 RUBY_STRING_REPLACEMENT_PATTERN = /#\{.+\}/

data/lib/{defaults.rb → ceedling/defaults.rb}

@@ -1,6 +1,6 @@
-require 'constants'
-require 'system_wrapper'
-require 'file_path_utils'
+require 'ceedling/constants'
+require 'ceedling/system_wrapper'
+require 'ceedling/file_path_utils'
 
 
 DEFAULT_TEST_COMPILER_TOOL = {
@@ -14,9 +14,10 @@ DEFAULT_TEST_COMPILER_TOOL = {
     {"-I\"$\"" => 'COLLECTION_PATHS_TEST_TOOLCHAIN_INCLUDE'}.freeze,
     {"-D$" => 'COLLECTION_DEFINES_TEST_AND_VENDOR'}.freeze,
     "-DGNU_COMPILER".freeze,
+    "-g".freeze,
     "-c \"${1}\"".freeze,
     "-o \"${2}\"".freeze,
-    # gcc's list file output options are complex; no use of ${3} parameter in default config    
+    # gcc's list file output options are complex; no use of ${3} parameter in default config
     ].freeze
   }
 
@@ -31,7 +32,7 @@ DEFAULT_TEST_LINKER_TOOL = {
     "-o \"${2}\"".freeze,
     ].freeze
   }
-  
+
 DEFAULT_TEST_FIXTURE_TOOL = {
   :executable => '${1}'.freeze,
   :name => 'default_test_fixture'.freeze,
@@ -91,8 +92,8 @@ DEFAULT_TEST_DEPENDENCIES_GENERATOR_TOOL = {
   :arguments => [
     {"-I\"$\"" => 'COLLECTION_PATHS_TEST_SUPPORT_SOURCE_INCLUDE_VENDOR'}.freeze,
     {"-I\"$\"" => 'COLLECTION_PATHS_TEST_TOOLCHAIN_INCLUDE'}.freeze,
-    {"-D$" => 'COLLECTION_DEFINES_TEST_AND_VENDOR'}.freeze, 
-    {"-D$" => 'DEFINES_TEST_PREPROCESS'}.freeze,     
+    {"-D$" => 'COLLECTION_DEFINES_TEST_AND_VENDOR'}.freeze,
+    {"-D$" => 'DEFINES_TEST_PREPROCESS'}.freeze,
     "-DGNU_PREPROCESSOR".freeze,
     "-MT \"${3}\"".freeze,
     '-MM'.freeze,
@@ -138,7 +139,7 @@ DEFAULT_RELEASE_COMPILER_TOOL = {
     "-DGNU_COMPILER".freeze,
     "-c \"${1}\"".freeze,
     "-o \"${2}\"".freeze,
-    # gcc's list file output options are complex; no use of ${3} parameter in default config    
+    # gcc's list file output options are complex; no use of ${3} parameter in default config
     ].freeze
   }
 
@@ -167,7 +168,7 @@ DEFAULT_RELEASE_LINKER_TOOL = {
     ].freeze
   }
 
-  
+
 DEFAULT_TOOLS_TEST = {
   :tools => {
     :test_compiler => DEFAULT_TEST_COMPILER_TOOL,
@@ -175,7 +176,7 @@ DEFAULT_TOOLS_TEST = {
     :test_fixture  => DEFAULT_TEST_FIXTURE_TOOL,
     }
   }
-  
+
 DEFAULT_TOOLS_TEST_PREPROCESSORS = {
   :tools => {
     :test_includes_preprocessor => DEFAULT_TEST_INCLUDES_PREPROCESSOR_TOOL,
@@ -209,7 +210,7 @@ DEFAULT_TOOLS_RELEASE_DEPENDENCIES = {
     }
   }
 
-  
+
 DEFAULT_RELEASE_TARGET_NAME = 'project'
 
 DEFAULT_CEEDLING_CONFIG = {
@@ -240,7 +241,7 @@ DEFAULT_CEEDLING_CONFIG = {
       :test_toolchain_include => [],
       :release_toolchain_include => [],
     },
-    
+
     :files => {
       :test => [],
       :source => [],
@@ -248,22 +249,22 @@ DEFAULT_CEEDLING_CONFIG = {
       :support => [],
       :include => [],
     },
-    
+
     # unlike other top-level entries, environment's value is an array to preserve order
     :environment => [
       # when evaluated, this provides wider text field for rake task comments
       {:rake_columns => '120'},
     ],
-    
+
     :defines => {
       :test => [],
       :test_preprocess => [],
       :release => [],
       :release_preprocess => [],
     },
-    
+
     :flags => {},
-    
+
     :extension => {
       :header => '.h',
       :source => '.c',
@@ -301,7 +302,7 @@ DEFAULT_CEEDLING_CONFIG = {
     # (these can be overridden in project file to add arguments to tools without totally redefining tools)
     :test_compiler => { :arguments => [] },
     :test_linker   => { :arguments => [] },
-    :test_fixture  => { 
+    :test_fixture  => {
       :arguments => [],
       :link_objects => [], # compiled object files to always be linked in (e.g. cmock.o if using mocks)
     },
@@ -319,7 +320,7 @@ DEFAULT_CEEDLING_CONFIG = {
     }
   }.freeze
 
-  
+
 DEFAULT_TESTS_RESULTS_REPORT_TEMPLATE = %q{
 % ignored        = hash[:results][:counts][:ignored]
 % failed         = hash[:results][:counts][:failed]