ceedling 0.0.3 → 0.0.4

data/Rakefile

@@ -1,18 +1,67 @@
-require 'bundler'
+require "bundler"
 Bundler::GemHelper.install_tasks
 require "./lib/ceedling"
+require "fileutils"
+require "erb"
 
-desc "update ceedling versions in gem; assumes ceedling up-to-date"
-task :update_versions do
+desc "update all the tools from sourceforge and update version info"
+task :update_tools do
+
+  puts "\nRetrieving ceedling content from SourceForge..."
+  rm_rf "temp"
+  mkdir "temp"
+  cd "temp" do
+    svn_checkout_command = 'svn co http://ceedling.svn.sourceforge.net/svnroot/ceedling/trunk .'
+    puts svn_checkout_command
+    `#{svn_checkout_command}`
+    rm_rf Dir["./**/.svn/"], :verbose => false # remove svn artifacts
+  end
+
+  # define mapping for pruning content from sourceforge
+  mapping = [
+    {:src => 'lib/',                                             :dest => ''},
+    {:src => 'plugins/',                                         :dest => ''},
+    {:src => 'release/',                                         :dest => ''},
+    {:src => 'vendor/c_exception/lib/',                          :dest => 'vendor/c_exception/'},
+    {:src => 'vendor/c_exception/release/',                      :dest => 'vendor/c_exception/'},
+    {:src => 'vendor/cmock/config/',                             :dest => 'vendor/cmock/'},
+    {:src => 'vendor/cmock/lib/',                                :dest => 'vendor/cmock/'},
+    {:src => 'vendor/cmock/release/',                            :dest => 'vendor/cmock/'},
+    {:src => 'vendor/cmock/src/',                                :dest => 'vendor/cmock/'},
+    {:src => 'vendor/constructor/lib/',                          :dest => 'vendor/constructor/'},
+    {:src => 'vendor/deep_merge/lib/',                           :dest => 'vendor/deep_merge/'},
+    {:src => 'vendor/diy/lib',                                   :dest => 'vendor/diy/'},
+    {:src => 'vendor/unity/release/',                            :dest => 'vendor/unity/'},
+    {:src => 'vendor/unity/src/',                                :dest => 'vendor/unity/'},
+    {:src => 'vendor/c_exception/docs/CExceptionSummary.pdf',    :dest => 'docs/', :is_file => true},
+    {:src => 'vendor/cmock/docs/CMock Summary.pdf',              :dest => 'docs/', :is_file => true},
+    {:src => 'docs/Ceedling Packet.pdf',                         :dest => 'docs/', :is_file => true},
+    {:src => 'vendor/unity/docs/Unity Summary.pdf',              :dest => 'docs/', :is_file => true},
+  ]
+
+  puts "\nUpdating tools with the latest goods..."
+  rm_rf "new_project_template/vendor/**"
+  mapping.each do |path|
+    dest = "new_project_template/vendor/ceedling/#{path[:dest]}"
+    dir = dest.sub(/\w+$/, '')
+    if !File.exist?(dir)
+      mkdir_p dest
+    end
+    puts "temp/#{path[:src]} -> #{dest}"
+    FileUtils.cp_r "temp/#{path[:src]}", "#{dest}"
+  end
+  rm_rf "temp"
+
+  puts "\nUpdating version info..."
   versions = {}
-  # There's an extra line of junk at the beginning, but who cares.
   full_version_info = nil
   Dir.chdir(Ceedling::NEW_PROJECT_DIR) { full_version_info = `rake version` }
+  puts full_version_info
   full_version_info.each_line do |line|
     line = line.split("::")
     versions[line.first.strip.upcase] = line.last.strip
   end
-  require "erb"
   result = ERB.new(File.read("lib/ceedling/version.rb.erb")).result(binding)
   File.open("lib/ceedling/version.rb", "wb+") { |f| f.puts result }
-end
+
+end

data/examples/temp_sensor/project.yml

@@ -62,8 +62,8 @@
     - UnityHelper.h
 
 :plugins:
-  :base_path: vendor/ceedling/plugins
-  :auxiliary_load_path: vendor/ceedling/plugins/support
+  :load_paths:
+    - vendor/ceedling/plugins
   :enabled:
     - stdout_pretty_tests_report
     - module_generator

data/lib/ceedling/version.rb

@@ -2,12 +2,12 @@
 module Ceedling
   module Version
     # @private
-    GEM = "0.0.3"
+    GEM = "0.0.4"
 
     # @private
-    CEEDLING = "0.9.157"
+    CEEDLING = "0.9.172"
     # @private
-    CEXCEPTION = "1.2.0.16"
+    CEXCEPTION = "1.2.16"
     # @private
     CMOCK = "2.0.209"
     # @private

data/lib/ceedling/version.rb.erb

@@ -2,7 +2,7 @@
 module Ceedling
   module Version
     # @private
-    GEM = "0.0.1"
+    GEM = "0.0.4"
 
     # @private
     CEEDLING = "<%= versions["CEEDLING"] %>"

data/new_project_template/project.yml

@@ -59,7 +59,7 @@
 
 :plugins:
   :load_paths:
-    - "#{File.join(PROJECT_CEEDLING_ROOT, 'plugins')}"
+    - vendor/ceedling/plugins
   :enabled:
     - stdout_pretty_tests_report
 ...

data/new_project_template/vendor/ceedling/lib/configurator.rb

@@ -7,7 +7,7 @@ require 'deep_merge'
 
 class Configurator
 
-  attr_reader :project_config_hash, :environment, :script_plugins, :rake_plugins
+  attr_reader :project_config_hash, :script_plugins, :rake_plugins
   attr_accessor :project_logging, :project_debug, :project_verbosity, :sanity_checks
   
   constructor(:configurator_setup, :configurator_builder, :configurator_plugins, :cmock_builder, :yaml_wrapper, :system_wrapper) do
@@ -17,14 +17,10 @@ class Configurator
     @sanity_checks     = TestResultsSanityChecks::NORMAL
   end
   
-  
   def setup
     # special copy of cmock config to provide to cmock for construction
     @cmock_config_hash = {}
 
-    # capture our source config for later merge operations
-    @source_config_hash = {}
-    
     # note: project_config_hash is an instance variable so constants and accessors created
     # in eval() statements in build() have something of proper scope and persistence to reference
     @project_config_hash = {}
@@ -33,7 +29,7 @@ class Configurator
     @script_plugins = []
     @rake_plugins   = []
   end
-
+  
   
   def replace_flattened_config(config)
     @project_config_hash.merge!(config)
@@ -69,13 +65,13 @@ class Configurator
 
 
   def populate_defaults(config)
-    new_config = DEFAULT_CEEDLING_CONFIG.clone
+    new_config = DEFAULT_CEEDLING_CONFIG.deep_clone
     new_config.deep_merge!(config)
     config.replace(new_config)
 
     @configurator_builder.populate_defaults( config, DEFAULT_TOOLS_TEST )
     @configurator_builder.populate_defaults( config, DEFAULT_TOOLS_TEST_PREPROCESSORS ) if (config[:project][:use_test_preprocessor])
-    @configurator_builder.populate_defaults( config, DEFAULT_TOOLS_TEST_DEPENDENCIES ) if (config[:project][:use_auxiliary_dependencies])
+    @configurator_builder.populate_defaults( config, DEFAULT_TOOLS_TEST_DEPENDENCIES )  if (config[:project][:use_auxiliary_dependencies])
     
     @configurator_builder.populate_defaults( config, DEFAULT_TOOLS_RELEASE )              if (config[:project][:release_build])
     @configurator_builder.populate_defaults( config, DEFAULT_TOOLS_RELEASE_ASSEMBLER )    if (config[:project][:release_build] and config[:release_build][:use_assembly])
@@ -131,18 +127,39 @@ class Configurator
 
 
   # grab tool names from yaml and insert into tool structures so available for error messages
-  def populate_tool_names_and_stderr_redirect(config)
+  # set up default values
+  def tools_setup(config)
     config[:tools].each_key do |name|
       tool = config[:tools][name]
-      
+
       # populate name if not given      
       tool[:name] = name.to_s if (tool[:name].nil?)
 
       # populate stderr redirect option
       tool[:stderr_redirect] = StdErrRedirect::NONE if (tool[:stderr_redirect].nil?)
+
+      # populate background execution option
+      tool[:background_exec] = BackgroundExec::NONE if (tool[:background_exec].nil?)
+
+      # populate optional option to control verification of executable in search paths
+      tool[:optional] = false if (tool[:optional].nil?)
     end
   end
   
+  def tools_supplement_arguments(config)
+    config[:tools].each_key do |name|
+      tool = @project_config_hash[('tools_' + name.to_s).to_sym]
+
+      # smoosh in extra arguments if specified at top-level of config (useful for plugins & default gcc tools)
+      # arguments are squirted in at beginning of list
+      top_level_tool = ('tool_' + name.to_s).to_sym
+      if (not config[top_level_tool].nil?)
+         # adding and flattening is not a good idea: might over-flatten if there's array nesting in tool args
+         # use _with_index to preserve order
+         config[top_level_tool][:arguments].each_with_index { |arg, index| tool[:arguments].insert( index, arg ) }
+      end
+    end
+  end
 
   def find_and_merge_plugins(config)
     # plugins must be loaded before generic path evaluation & magic that happen later: perform path magic here as discrete step
@@ -151,7 +168,7 @@ class Configurator
       FilePathUtils::standardize(path)
     end
     
-    @configurator_plugins.add_load_paths(config)
+    paths_hash = @configurator_plugins.add_load_paths(config)
   
     @rake_plugins   = @configurator_plugins.find_rake_plugins(config)
     @script_plugins = @configurator_plugins.find_script_plugins(config)
@@ -168,6 +185,8 @@ class Configurator
     
     # special plugin setting for results printing
     config[:plugins][:display_raw_test_results] = true if (config[:plugins][:display_raw_test_results].nil?)
+    
+    paths_hash.each_pair { |name, path| config[:plugins][name] = path }
   end
 
   
@@ -179,7 +198,7 @@ class Configurator
         value_string.replace(@system_wrapper.module_eval(value_string))
       end
       @system_wrapper.env_set(key.to_s.upcase, value_string)
-    end    
+    end
   end
 
   
@@ -234,14 +253,44 @@ class Configurator
   end
     
   
-  def build(config)
-    built_config = @configurator_setup.build_project_config(config)
+  # create constants and accessors (attached to this object) from given hash
+  def build(config, *keys)
+    # create flattened & expanded configuration hash
+    built_config = @configurator_setup.build_project_config( config, @configurator_builder.flattenify( config ) )
     
-    @source_config_hash   = config.clone
-    @project_config_hash  = built_config.clone
+    @project_config_hash = built_config.clone
     store_config()
 
     @configurator_setup.build_constants_and_accessors(built_config, binding())
+    
+    # top-level keys disappear when we flatten, so create global constants & accessors to any specified keys
+    keys.each do |key|
+      hash = { key => config[key] }
+      @configurator_setup.build_constants_and_accessors(hash, binding())      
+    end
+  end
+
+
+  # add to constants and accessors as post build step
+  def build_supplement(config_base, config_more)
+    # merge in our post-build additions to base configuration hash
+    config_base.deep_merge!( config_more )
+
+    # flatten our addition hash
+    config_more_flattened = @configurator_builder.flattenify( config_more )
+    
+    # merge our flattened hash with built hash from previous build
+    @project_config_hash.deep_merge!( config_more_flattened )
+    store_config()
+
+    # create more constants and accessors
+    @configurator_setup.build_constants_and_accessors(config_more_flattened, binding())
+    
+    # recreate constants & update accessors with new merged, base values
+    config_more.keys.each do |key|
+      hash = { key => config_base[key] }
+      @configurator_setup.build_constants_and_accessors(hash, binding())
+    end
   end
     
   

data/new_project_template/vendor/ceedling/lib/configurator_builder.rb

@@ -64,7 +64,7 @@ class ConfiguratorBuilder
   def populate_defaults(config, defaults)
     defaults.keys.sort.each do |section|
       defaults[section].keys.sort.each do |entry|
-        config[section][entry] = defaults[section][entry] if (config[section].nil? or config[section][entry].nil?)
+        config[section][entry] = defaults[section][entry].deep_clone if (config[section].nil? or config[section][entry].nil?)
       end
     end
   end
@@ -192,13 +192,6 @@ class ConfiguratorBuilder
   end
   
 
-  def collect_environment_variables(in_hash)
-    return {
-      :collection_environment => in_hash[:environment]
-      }
-  end
-
-  
   def collect_project_options(in_hash)
     options = []
     

data/new_project_template/vendor/ceedling/lib/configurator_plugins.rb

@@ -11,14 +11,21 @@ class ConfiguratorPlugins
 
   
   def add_load_paths(config)
+    plugin_paths = {}
+    
     config[:plugins][:load_paths].each do |root|
       @system_wrapper.add_load_path( root ) if ( not @file_wrapper.directory_listing( File.join( root, '*.rb' ) ).empty? )
     
       config[:plugins][:enabled].each do |plugin|
         path = File.join( root, plugin )
-        @system_wrapper.add_load_path( path ) if ( not @file_wrapper.directory_listing( File.join( path, '*.rb' ) ).empty? )
+        if ( not @file_wrapper.directory_listing( File.join( path, '*.rb' ) ).empty? )
+          plugin_paths[(plugin + '_path').to_sym] = path
+          @system_wrapper.add_load_path( path )
+        end
       end
     end
+    
+    return plugin_paths
   end
   
   

data/new_project_template/vendor/ceedling/lib/configurator_setup.rb

@@ -14,40 +14,36 @@ class ConfiguratorSetup
   constructor :configurator_builder, :configurator_validator
   
   
-  def build_project_config(config)
-    # convert config object to flattened hash
-    new_config = @configurator_builder.flattenify(config)
-
-    # flesh out config
-    @configurator_builder.clean(new_config)
+  def build_project_config(config, flattened_config)
+    ### flesh out config
+    @configurator_builder.clean(flattened_config)
     
-    # add to hash values we build up from configuration & file system contents
-    new_config.merge!(@configurator_builder.set_build_paths(new_config))
-    new_config.merge!(@configurator_builder.set_force_build_filepaths(new_config))
-    new_config.merge!(@configurator_builder.set_rakefile_components(new_config))
-    new_config.merge!(@configurator_builder.set_library_build_info_filepaths(new_config))
-    new_config.merge!(@configurator_builder.set_release_target(new_config))
-    new_config.merge!(@configurator_builder.collect_project_options(new_config))
-    new_config.merge!(@configurator_builder.collect_environment_variables(config))
+    ### add to hash values we build up from configuration & file system contents
+    flattened_config.merge!(@configurator_builder.set_build_paths(flattened_config))
+    flattened_config.merge!(@configurator_builder.set_force_build_filepaths(flattened_config))
+    flattened_config.merge!(@configurator_builder.set_rakefile_components(flattened_config))
+    flattened_config.merge!(@configurator_builder.set_library_build_info_filepaths(flattened_config))
+    flattened_config.merge!(@configurator_builder.set_release_target(flattened_config))
+    flattened_config.merge!(@configurator_builder.collect_project_options(flattened_config))
     
-    # iterate through all entries in paths section and expand any & all globs to actual paths
-    new_config.merge!(@configurator_builder.expand_all_path_globs(new_config))
+    ### iterate through all entries in paths section and expand any & all globs to actual paths
+    flattened_config.merge!(@configurator_builder.expand_all_path_globs(flattened_config))
     
-    new_config.merge!(@configurator_builder.collect_source_and_include_paths(new_config))
-    new_config.merge!(@configurator_builder.collect_source_include_vendor_paths(new_config))
-    new_config.merge!(@configurator_builder.collect_test_support_source_include_paths(new_config))
-    new_config.merge!(@configurator_builder.collect_test_support_source_include_vendor_paths(new_config))
-    new_config.merge!(@configurator_builder.collect_tests(new_config))
-    new_config.merge!(@configurator_builder.collect_assembly(new_config))
-    new_config.merge!(@configurator_builder.collect_source(new_config))
-    new_config.merge!(@configurator_builder.collect_headers(new_config))
-    new_config.merge!(@configurator_builder.collect_all_existing_compilation_input(new_config))
-    new_config.merge!(@configurator_builder.collect_test_and_vendor_defines(new_config))
-    new_config.merge!(@configurator_builder.collect_release_and_vendor_defines(new_config))
-    new_config.merge!(@configurator_builder.collect_release_artifact_extra_link_objects(new_config))
-    new_config.merge!(@configurator_builder.collect_test_fixture_extra_link_objects(new_config))
-
-    return new_config
+    flattened_config.merge!(@configurator_builder.collect_source_and_include_paths(flattened_config))
+    flattened_config.merge!(@configurator_builder.collect_source_include_vendor_paths(flattened_config))
+    flattened_config.merge!(@configurator_builder.collect_test_support_source_include_paths(flattened_config))
+    flattened_config.merge!(@configurator_builder.collect_test_support_source_include_vendor_paths(flattened_config))
+    flattened_config.merge!(@configurator_builder.collect_tests(flattened_config))
+    flattened_config.merge!(@configurator_builder.collect_assembly(flattened_config))
+    flattened_config.merge!(@configurator_builder.collect_source(flattened_config))
+    flattened_config.merge!(@configurator_builder.collect_headers(flattened_config))
+    flattened_config.merge!(@configurator_builder.collect_all_existing_compilation_input(flattened_config))
+    flattened_config.merge!(@configurator_builder.collect_test_and_vendor_defines(flattened_config))
+    flattened_config.merge!(@configurator_builder.collect_release_and_vendor_defines(flattened_config))
+    flattened_config.merge!(@configurator_builder.collect_release_artifact_extra_link_objects(flattened_config))
+    flattened_config.merge!(@configurator_builder.collect_test_fixture_extra_link_objects(flattened_config))
+
+    return flattened_config
   end
 
   
@@ -79,8 +75,8 @@ class ConfiguratorSetup
   def validate_paths(config)
     validation = []
 
-    validation << @configurator_validator.validate_filepath(config, {:search_system_path => false}, :project, :build_root)
-    validation << @configurator_validator.validate_filepath(config, {:search_system_path => false}, :cmock, :unity_helper) if config[:cmock][:unity_helper]
+    validation << @configurator_validator.validate_filepath(config, :project, :build_root)
+    validation << @configurator_validator.validate_filepath(config, :cmock, :unity_helper) if config[:cmock][:unity_helper]
 
     config[:project][:options_paths].each do |path|
       validation << @configurator_validator.validate_filepath_simple( path, :project, :options_paths )
@@ -103,7 +99,7 @@ class ConfiguratorSetup
 
     config[:tools].keys.sort.each do |key|
       validation << @configurator_validator.exists?(config, :tools, key, :executable)
-      validation << @configurator_validator.validate_filepath(config, {:search_system_path => true}, :tools, key, :executable)
+      validation << @configurator_validator.validate_executable_filepath(config, :tools, key, :executable) if (not config[:tools][key][:optional])
       validation << @configurator_validator.validate_tool_stderr_redirect(config, :tools, key)
     end
 

data/new_project_template/vendor/ceedling/lib/configurator_validator.rb

@@ -1,3 +1,5 @@
+require 'rubygems'
+require 'rake' # for ext()
 require 'constants'
 require 'tool_executor'    # for argument replacement pattern
 require 'file_path_utils'  # for glob handling class methods
@@ -63,12 +65,32 @@ class ConfiguratorValidator
     
     return true
   end
-
  
   # walk into config hash. verify specified file exists.
-  def validate_filepath(config, options, *keys)
-    hash = retrieve_value(config, keys)
-    filepath = hash[:value]
+  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?)
@@ -77,7 +99,7 @@ class ConfiguratorValidator
     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?('/') and options[:search_system_path])
+    if (not filepath.include?('/'))
       exists = false
       
       @system_wrapper.search_paths.each do |path|
@@ -85,6 +107,11 @@ class ConfiguratorValidator
           exists = true
           break
         end
+        
+        if (@file_wrapper.exist?( (File.join(path, filepath)).ext( exe_extension ) ))
+          exists = true
+          break
+        end
       end
       
       if (not exists)