ceedling 0.13.0 → 0.15.0

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

@@ -1,19 +1,19 @@
-
-class PluginManagerHelper
-
-  def include?(plugins, name)
-		include = false
-		plugins.each do |plugin|
-			if (plugin.name == name)
-				include = true
-				break
-			end
-		end
-		return include
-  end
-
-  def instantiate_plugin_script(plugin, system_objects, name)
-    return eval("#{plugin}.new(system_objects, name)")
-  end
-
-end
+
+class PluginManagerHelper
+
+  def include?(plugins, name)
+		include = false
+		plugins.each do |plugin|
+			if (plugin.name == name)
+				include = true
+				break
+			end
+		end
+		return include
+  end
+
+  def instantiate_plugin_script(plugin, system_objects, name)
+    return eval("#{plugin}.new(system_objects, name)")
+  end
+
+end

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

@@ -1,5 +1,5 @@
-require 'constants'
-require 'defaults'
+require 'ceedling/constants'
+require 'ceedling/defaults'
 
 class PluginReportinator
   

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

@@ -1,7 +1,7 @@
-require 'constants'
 require 'erb'
 require 'rubygems'
 require 'rake' # for ext()
+require 'ceedling/constants'
 
 
 class PluginReportinatorHelper

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

@@ -1,43 +1,43 @@
-
-class Preprocessinator
-
-  attr_reader :preprocess_file_proc
-  
-  constructor :preprocessinator_helper, :preprocessinator_includes_handler, :preprocessinator_file_handler, :task_invoker, :file_path_utils, :yaml_wrapper
-
-
-  def setup
-    # fashion ourselves callbacks @preprocessinator_helper can use
-    @preprocess_includes_proc = Proc.new { |filepath| self.preprocess_shallow_includes(filepath) }
-    @preprocess_file_proc     = Proc.new { |filepath| self.preprocess_file(filepath) }
-  end
-
-
-  def preprocess_test_and_invoke_test_mocks(test)
-    @preprocessinator_helper.preprocess_includes(test, @preprocess_includes_proc)
-
-    mocks_list = @preprocessinator_helper.assemble_mocks_list(test)
-
-    @preprocessinator_helper.preprocess_mockable_headers(mocks_list, @preprocess_file_proc)
-
-    @task_invoker.invoke_test_mocks(mocks_list)
-
-    @preprocessinator_helper.preprocess_test_file(test, @preprocess_file_proc)
-    
-    return mocks_list
-  end
-
-  def preprocess_shallow_includes(filepath)
-    dependencies_rule = @preprocessinator_includes_handler.form_shallow_dependencies_rule(filepath)
-    includes          = @preprocessinator_includes_handler.extract_shallow_includes(dependencies_rule)
-
-    @preprocessinator_includes_handler.write_shallow_includes_list(
-      @file_path_utils.form_preprocessed_includes_list_filepath(filepath), includes)
-  end
-
-  def preprocess_file(filepath)
-    @preprocessinator_includes_handler.invoke_shallow_includes_list(filepath)
-    @preprocessinator_file_handler.preprocess_file( filepath, @yaml_wrapper.load(@file_path_utils.form_preprocessed_includes_list_filepath(filepath)) )
-  end
-
-end
+
+class Preprocessinator
+
+  attr_reader :preprocess_file_proc
+  
+  constructor :preprocessinator_helper, :preprocessinator_includes_handler, :preprocessinator_file_handler, :task_invoker, :file_path_utils, :yaml_wrapper
+
+
+  def setup
+    # fashion ourselves callbacks @preprocessinator_helper can use
+    @preprocess_includes_proc = Proc.new { |filepath| self.preprocess_shallow_includes(filepath) }
+    @preprocess_file_proc     = Proc.new { |filepath| self.preprocess_file(filepath) }
+  end
+
+
+  def preprocess_test_and_invoke_test_mocks(test)
+    @preprocessinator_helper.preprocess_includes(test, @preprocess_includes_proc)
+
+    mocks_list = @preprocessinator_helper.assemble_mocks_list(test)
+
+    @preprocessinator_helper.preprocess_mockable_headers(mocks_list, @preprocess_file_proc)
+
+    @task_invoker.invoke_test_mocks(mocks_list)
+
+    @preprocessinator_helper.preprocess_test_file(test, @preprocess_file_proc)
+    
+    return mocks_list
+  end
+
+  def preprocess_shallow_includes(filepath)
+    dependencies_rule = @preprocessinator_includes_handler.form_shallow_dependencies_rule(filepath)
+    includes          = @preprocessinator_includes_handler.extract_shallow_includes(dependencies_rule)
+
+    @preprocessinator_includes_handler.write_shallow_includes_list(
+      @file_path_utils.form_preprocessed_includes_list_filepath(filepath), includes)
+  end
+
+  def preprocess_file(filepath)
+    @preprocessinator_includes_handler.invoke_shallow_includes_list(filepath)
+    @preprocessinator_file_handler.preprocess_file( filepath, @yaml_wrapper.load(@file_path_utils.form_preprocessed_includes_list_filepath(filepath)) )
+  end
+
+end

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

@@ -1,30 +1,30 @@
-class PreprocessinatorExtractor
-  def extract_base_file_from_preprocessed_expansion(filepath)
-    # preprocessing by way of toolchain preprocessor expands macros, eliminates
-    # comments, strips out #ifdef code, etc.  however, it also expands in place
-    # each #include'd file.  so, we must extract only the lines of the file
-    # that belong to the file originally preprocessed
-
-    # iterate through all lines and alternate between extract and ignore modes
-    # all lines between a '#'line containing file name of our filepath and the
-    # next '#'line should be extracted
-
-    base_name  = File.basename(filepath)
-    not_pragma = /^#(?!pragma\b)/ # preprocessor directive that's not a #pragma
-    pattern    = /^#.*(\s|\/|\\|\")#{Regexp.escape(base_name)}/
-    found_file = false # have we found the file we care about?
-
-    lines = []
-    File.readlines(filepath).each do |line|
-      if found_file and not line.match(not_pragma)
-        lines << line
-      else
-        found_file = false
-      end
-
-      found_file = true if line.match(pattern)
-    end
-
-    return lines
-  end
-end
+class PreprocessinatorExtractor
+  def extract_base_file_from_preprocessed_expansion(filepath)
+    # preprocessing by way of toolchain preprocessor expands macros, eliminates
+    # comments, strips out #ifdef code, etc.  however, it also expands in place
+    # each #include'd file.  so, we must extract only the lines of the file
+    # that belong to the file originally preprocessed
+
+    # iterate through all lines and alternate between extract and ignore modes
+    # all lines between a '#'line containing file name of our filepath and the
+    # next '#'line should be extracted
+
+    base_name  = File.basename(filepath)
+    not_pragma = /^#(?!pragma\b)/ # preprocessor directive that's not a #pragma
+    pattern    = /^#.*(\s|\/|\\|\")#{Regexp.escape(base_name)}/
+    found_file = false # have we found the file we care about?
+
+    lines = []
+    File.readlines(filepath).each do |line|
+      if found_file and not line.match(not_pragma)
+        lines << line
+      else
+        found_file = false
+      end
+
+      found_file = true if line.match(pattern)
+    end
+
+    return lines
+  end
+end

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

@@ -1,21 +1,21 @@
-
-
-class PreprocessinatorFileHandler
-  
-  constructor :preprocessinator_extractor, :configurator, :tool_executor, :file_path_utils, :file_wrapper
-
-  
-  def preprocess_file(filepath, includes)
-    preprocessed_filepath = @file_path_utils.form_preprocessed_file_filepath(filepath)
-        
-    command = @tool_executor.build_command_line(@configurator.tools_test_file_preprocessor, filepath, preprocessed_filepath)
-    @tool_executor.exec(command[:line], command[:options])
-    
-    contents = @preprocessinator_extractor.extract_base_file_from_preprocessed_expansion(preprocessed_filepath)
-
-    includes.each{|include| contents.unshift("#include \"#{include}\"")}
-
-    @file_wrapper.write(preprocessed_filepath, contents.join("\n"))    
-  end
-
-end
+
+
+class PreprocessinatorFileHandler
+  
+  constructor :preprocessinator_extractor, :configurator, :tool_executor, :file_path_utils, :file_wrapper
+
+  
+  def preprocess_file(filepath, includes)
+    preprocessed_filepath = @file_path_utils.form_preprocessed_file_filepath(filepath)
+        
+    command = @tool_executor.build_command_line(@configurator.tools_test_file_preprocessor, filepath, preprocessed_filepath)
+    @tool_executor.exec(command[:line], command[:options])
+    
+    contents = @preprocessinator_extractor.extract_base_file_from_preprocessed_expansion(preprocessed_filepath)
+
+    includes.each{|include| contents.unshift("#include \"#{include}\"")}
+
+    @file_wrapper.write(preprocessed_filepath, contents.join("\n"))    
+  end
+
+end

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

@@ -1,46 +1,46 @@
-
-
-class PreprocessinatorHelper
-  
-  constructor :configurator, :test_includes_extractor, :task_invoker, :file_finder, :file_path_utils
-
-
-  def preprocess_includes(test, preprocess_includes_proc)
-    if (@configurator.project_use_test_preprocessor)
-      preprocessed_includes_list = @file_path_utils.form_preprocessed_includes_list_filepath(test)
-      preprocess_includes_proc.call( @file_finder.find_test_from_file_path(preprocessed_includes_list) )
-      @test_includes_extractor.parse_includes_list(preprocessed_includes_list)
-    else
-      @test_includes_extractor.parse_test_file(test)      
-    end  
-  end
-
-  def assemble_mocks_list(test)
-    return @file_path_utils.form_mocks_source_filelist( @test_includes_extractor.lookup_raw_mock_list(test) )
-  end
-
-  def preprocess_mockable_headers(mock_list, preprocess_file_proc)
-    if (@configurator.project_use_test_preprocessor)
-      preprocess_files_smartly(
-        @file_path_utils.form_preprocessed_mockable_headers_filelist(mock_list),
-        preprocess_file_proc ) { |file| @file_finder.find_header_file(file) }
-    end
-  end
-
-  def preprocess_test_file(test, preprocess_file_proc)
-    return if (!@configurator.project_use_test_preprocessor)
-    
-    preprocess_file_proc.call(test)
-  end
-  
-  private ############################
-
-  def preprocess_files_smartly(file_list, preprocess_file_proc)
-    if (@configurator.project_use_deep_dependencies)
-      @task_invoker.invoke_test_preprocessed_files(file_list)
-    else
-      file_list.each { |file| preprocess_file_proc.call( yield(file) ) }
-    end
-  end
-
-end
+
+
+class PreprocessinatorHelper
+  
+  constructor :configurator, :test_includes_extractor, :task_invoker, :file_finder, :file_path_utils
+
+
+  def preprocess_includes(test, preprocess_includes_proc)
+    if (@configurator.project_use_test_preprocessor)
+      preprocessed_includes_list = @file_path_utils.form_preprocessed_includes_list_filepath(test)
+      preprocess_includes_proc.call( @file_finder.find_test_from_file_path(preprocessed_includes_list) )
+      @test_includes_extractor.parse_includes_list(preprocessed_includes_list)
+    else
+      @test_includes_extractor.parse_test_file(test)      
+    end  
+  end
+
+  def assemble_mocks_list(test)
+    return @file_path_utils.form_mocks_source_filelist( @test_includes_extractor.lookup_raw_mock_list(test) )
+  end
+
+  def preprocess_mockable_headers(mock_list, preprocess_file_proc)
+    if (@configurator.project_use_test_preprocessor)
+      preprocess_files_smartly(
+        @file_path_utils.form_preprocessed_mockable_headers_filelist(mock_list),
+        preprocess_file_proc ) { |file| @file_finder.find_header_file(file) }
+    end
+  end
+
+  def preprocess_test_file(test, preprocess_file_proc)
+    return if (!@configurator.project_use_test_preprocessor)
+    
+    preprocess_file_proc.call(test)
+  end
+  
+  private ############################
+
+  def preprocess_files_smartly(file_list, preprocess_file_proc)
+    if (@configurator.project_use_deep_dependencies)
+      @task_invoker.invoke_test_preprocessed_files(file_list)
+    else
+      file_list.each { |file| preprocess_file_proc.call( yield(file) ) }
+    end
+  end
+
+end

data/lib/ceedling/preprocessinator_includes_handler.rb

@@ -0,0 +1,82 @@
+
+
+class PreprocessinatorIncludesHandler
+
+  constructor :configurator, :tool_executor, :task_invoker, :file_path_utils, :yaml_wrapper, :file_wrapper
+
+  # shallow includes: only those headers a source file explicitly includes
+
+  def invoke_shallow_includes_list(filepath)
+    @task_invoker.invoke_test_shallow_include_lists( [@file_path_utils.form_preprocessed_includes_list_filepath(filepath)] )
+  end
+
+  ##
+  # Ask the preprocessor for a make-style dependency rule of only the headers
+  # the source file immediately includes.
+  #
+  # === Arguments
+  # +filepath+ _String_:: Path to the test file to process.
+  #
+  # === Return
+  # _String_:: The text of the dependency rule generated by the preprocessor.
+  def form_shallow_dependencies_rule(filepath)
+    # change filename (prefix of '_') to prevent preprocessor from finding
+    # include files in temp directory containing file it's scanning
+    temp_filepath = @file_path_utils.form_temp_path(filepath, '_')
+
+    # read the file and replace all include statements with a decorated version
+    # (decorating the names creates file names that don't exist, thus preventing
+    # the preprocessor from snaking out and discovering the entire include path
+    # that winds through the code). The decorated filenames indicate files that
+    # are included directly by the test file.
+    contents = @file_wrapper.read(filepath)
+    contents.gsub!( /^\s*#include\s+[\"<]\s*(\S+)\s*[\">]/, "#include \"\\1\"\n#include \"@@@@\\1\"" )
+    @file_wrapper.write( temp_filepath, contents )
+
+    # extract the make-style dependency rule telling the preprocessor to
+    # ignore the fact that it can't find the included files
+    command = @tool_executor.build_command_line(@configurator.tools_test_includes_preprocessor, temp_filepath)
+    shell_result = @tool_executor.exec(command[:line], command[:options])
+
+    return shell_result[:output]
+  end
+
+  ##
+  # Extract the headers that are directly included by a source file using the
+  # provided, annotated Make dependency rule.
+  #
+  # === Arguments
+  # +make_rule+ _String_:: Annotated Make dependency rule.
+  #
+  # === Return
+  # _Array_ of _String_:: Array of the direct dependencies for the source file.
+  def extract_shallow_includes(make_rule)
+    # Extract the dependencies from the make rule
+    hdr_ext = @configurator.extension_header
+    dependencies = make_rule.split.find_all {|path| path.end_with?(hdr_ext) }.uniq
+    dependencies.map! {|hdr| hdr.gsub('\\','/') }
+
+    # Separate the real files form the annotated ones and remove the '@@@@'
+    annotated_headers, real_headers = dependencies.partition {|hdr| hdr =~ /^@@@@/ }
+    annotated_headers.map! {|hdr| hdr.gsub('@@@@','') }
+
+    # Find which of our annotated headers are "real" dependencies. This is
+    # intended to weed out dependencies that have been removed due to build
+    # options defined in the project yaml and/or in the headers themselves.
+    annotated_headers.find_all do |annotated_header|
+      # find the index of the "real" include that matches the annotated one.
+      idx = real_headers.find_index do |real_header|
+        real_header =~ /^(.*\/)?#{Regexp.escape(annotated_header)}$/
+      end
+      # If we found a real include, delete it from the array and return it,
+      # otherwise return nil. Since nil is falsy this has the effect of making
+      # find_all return only the annotated headers for which a real include was
+      # found/deleted
+      idx ? real_headers.delete_at(idx) : nil
+    end.compact
+  end
+
+  def write_shallow_includes_list(filepath, list)
+    @yaml_wrapper.dump(filepath, list)
+  end
+end

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

@@ -1,38 +1,38 @@
-require 'constants'
-
-
-class ProjectConfigManager
-
-  attr_reader   :options_files, :release_config_changed, :test_config_changed
-  attr_accessor :config_hash
-
-  constructor :cacheinator, :yaml_wrapper
-
-
-  def setup
-    @options_files = []
-    @release_config_changed = false
-    @test_config_changed    = false
-  end
-
-
-  def merge_options(config_hash, option_filepath)
-    @options_files << File.basename( option_filepath )
-    config_hash.deep_merge( @yaml_wrapper.load( option_filepath ) )
-    return config_hash
-  end 
-  
-
-  
-  def process_release_config_change
-    # has project configuration changed since last release build
-    @release_config_changed = @cacheinator.diff_cached_release_config?( @config_hash )
-  end
-
-
-  def process_test_config_change
-    # has project configuration changed since last test build
-    @test_config_changed = @cacheinator.diff_cached_test_config?( @config_hash )
-  end
-
-end
+require 'ceedling/constants'
+
+
+class ProjectConfigManager
+
+  attr_reader   :options_files, :release_config_changed, :test_config_changed
+  attr_accessor :config_hash
+
+  constructor :cacheinator, :yaml_wrapper
+
+
+  def setup
+    @options_files = []
+    @release_config_changed = false
+    @test_config_changed    = false
+  end
+
+
+  def merge_options(config_hash, option_filepath)
+    @options_files << File.basename( option_filepath )
+    config_hash.deep_merge( @yaml_wrapper.load( option_filepath ) )
+    return config_hash
+  end 
+  
+
+  
+  def process_release_config_change
+    # has project configuration changed since last release build
+    @release_config_changed = @cacheinator.diff_cached_release_config?( @config_hash )
+  end
+
+
+  def process_test_config_change
+    # has project configuration changed since last test build
+    @test_config_changed = @cacheinator.diff_cached_test_config?( @config_hash )
+  end
+
+end