ceedling 0.13.0 → 0.15.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 93e5e75f4dbc6f24d4d149af4ec3486bd1a89c52
+  data.tar.gz: 1f242b5f415f91f82bda4455da047b8f33f96a35
+SHA512:
+  metadata.gz: 001836b3654ddb94a70748db1da1fc00b385ece34409a2e43418fbcf061c37a7fe8741e8350b5196aef43019c5aff931ecdbb824f4e95658cf266bffd7fe435d
+  data.tar.gz: 8f67b9be15af0db6ed83fcc641d560efe79739f858b2060168257f9f650944b160947082852eae28874b60b2c5a741cd6eccc4cde53bb5992bffeb1b2381a7e6

data/Gemfile

@@ -1,6 +1,6 @@
 source "http://rubygems.org/"
 
-gem "bundler", "~> 1.1.rc.7"
+gem "bundler", ">= 1.3.5"
 gem "rake", ">= 0.9.2.2"
 
 gem "rspec"

data/Gemfile.lock

@@ -2,27 +2,31 @@ GEM
   remote: http://rubygems.org/
   specs:
     constructor (2.0.0)
-    diff-lcs (1.1.3)
+    diff-lcs (1.2.5)
     diy (1.1.2)
       constructor (>= 1.0.0)
-    rake (0.9.2.2)
-    require_all (1.2.1)
-    rr (1.0.4)
-    rspec (2.8.0)
-      rspec-core (~> 2.8.0)
-      rspec-expectations (~> 2.8.0)
-      rspec-mocks (~> 2.8.0)
-    rspec-core (2.8.0)
-    rspec-expectations (2.8.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.8.0)
-    thor (0.16.0)
+    rake (10.3.2)
+    require_all (1.3.2)
+    rr (1.1.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.2)
+    thor (0.19.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.1.rc.7)
+  bundler (>= 1.3.5)
   constructor
   diy
   rake (>= 0.9.2.2)

data/README.md

@@ -6,8 +6,10 @@ to be used without having to worry about external dependencies.
 
     ceedling new [your new project name]
 
-Using Ceedling outside of a project as a gem (EXPERIMENTAL AND AWKWARD)
-=======================================================================
+Using Ceedling outside of a project as a gem
+============================================
+
+(Note: This is still somewhat experimental.)
 
 Ceedling can also be used as a gem. The following Rakefile is the
 bare minimum required in order to use Ceedling this way:
@@ -76,8 +78,8 @@ started:
     :plugins:
       :load_paths:
         # This is required to use builtin ceedling plugins
-        - "#{builtin_ceedling_plugins_path}"
-        # Uncomment this and create the directory in order to use your own 
+        - "#{Ceedling.load_path}"
+        # Uncomment this and create the directory in order to use your own
         # custom ceedling plugins
         # - ceedling_plugins
       :enabled:

data/assets/project_as_gem.yml

@@ -64,7 +64,7 @@
 
 :plugins:
   :load_paths:
-    - "#{builtin_ceedling_plugins_path}"
+    - "#{Ceedling.load_path}"
   :enabled:
     - stdout_pretty_tests_report
     - module_generator

data/assets/rakefile_as_gem.rb

@@ -1 +1,3 @@
 require 'ceedling'
+
+Ceedling.load_project

data/assets/rakefile_with_guts.rb

@@ -1,4 +1,6 @@
 PROJECT_CEEDLING_ROOT = "vendor/ceedling"
-load "#{PROJECT_CEEDLING_ROOT}/lib/rakefile.rb"
+load "#{PROJECT_CEEDLING_ROOT}/lib/ceedling.rb"
+
+Ceedling.load_project
 
 task :default => %w[ test:all release ]

data/ceedling.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |s|
   s.homepage    = "http://throwtheswitch.org/"
   s.summary     = %q{Ceedling is a set of tools for the automation of builds and test running for C}
   s.description = %q{Ceedling provides a set of tools to deploy its guts in a folder or which can be required in a Rakefile}
+  s.licenses    = ['MIT']
 
   s.rubyforge_project = "ceedling"
 

data/examples/blinky/rakefile.rb

@@ -1,5 +1,5 @@
 PROJECT_CEEDLING_ROOT = "vendor/ceedling"
-load "#{PROJECT_CEEDLING_ROOT}/lib/rakefile.rb"
+load "#{PROJECT_CEEDLING_ROOT}/lib/ceedling/rakefile.rb"
 
 task :default => %w[ test:all release ]
 
@@ -27,4 +27,4 @@ task :program => [:convert, :serial_port] do
   cmd = "avrdude -F -V -c arduino -p #{ENV['MCU']} -P #{ENV['SERIAL_PORT']} -b 115200 -U flash:w:#{hex_file}"
   puts cmd
   sh cmd
-end
+end

data/examples/temp_sensor/rakefile.rb

@@ -1,4 +1,4 @@
 PROJECT_CEEDLING_ROOT = "vendor/ceedling"
-load "#{PROJECT_CEEDLING_ROOT}/lib/rakefile.rb"
+load "#{PROJECT_CEEDLING_ROOT}/lib/ceedling/rakefile.rb"
 
 task :default => %w[ test:all release ]

data/examples/temp_sensor/src/TemperatureFilter.c

@@ -27,8 +27,7 @@ void TemperatureFilter_ProcessInput(float temperature)
   {
     if (temperature == +INFINITY ||
         temperature == -INFINITY ||
-        temperature == +NAN ||
-        temperature == -NAN)
+        isnan(temperature))
     {
       initialized = FALSE;
       temperature = -INFINITY;

data/examples/temp_sensor/test/TestTemperatureCalculator.c

@@ -29,5 +29,5 @@ void testTemperatureCalculatorShouldCalculateTemperatureFromMillivolts(void)
 
 void testShouldReturnNegativeInfinityWhen_0_millivoltsInput(void)
 {
-  TEST_ASSERT_FLOAT_WITHIN(0.0000001f, -INFINITY, TemperatureCalculator_Calculate(0));
+  TEST_ASSERT_FLOAT_IS_NEG_INF(TemperatureCalculator_Calculate(0));
 }

data/examples/temp_sensor/test/TestTemperatureFilter.c

@@ -15,7 +15,7 @@ void tearDown(void)
 void testShouldInitializeTemeratureToInvalidValue(void)
 {
   TemperatureFilter_Init();
-  TEST_ASSERT_FLOAT_WITHIN(0.0001f, -INFINITY, TemperatureFilter_GetTemperatureInCelcius());
+  TEST_ASSERT_FLOAT_IS_NEG_INF(TemperatureFilter_GetTemperatureInCelcius());
 }
 
 void testShouldInitializeTemperatureAfterCallToInit(void)
@@ -34,7 +34,17 @@ void setValueAndVerifyResponse(float input, float response)
   float actual;
   TemperatureFilter_ProcessInput(input);
   actual = TemperatureFilter_GetTemperatureInCelcius();
-  TEST_ASSERT_FLOAT_WITHIN(0.0001f, response, actual);
+
+  if (input == +INFINITY ||
+      input == -INFINITY ||
+      isnan(input))
+  {
+    TEST_ASSERT_FLOAT_IS_NEG_INF(actual);
+  }
+  else
+  {
+    TEST_ASSERT_FLOAT_WITHIN(0.0001f, response, actual);
+  }
 }
 
 void testShouldWeightEachSubsequentValueBy25PercentAfterInitialValue(void)

data/lib/ceedling.rb

@@ -1,27 +1,99 @@
-require 'rake'
+##
+# This module defines the interface for interacting with and loading a project
+# with Ceedling.
+module Ceedling
+  ##
+  # Returns the location where the gem is installed.
+  # === Return
+  # _String_ - The location where the gem lives.
+  def self.location
+    File.join( File.dirname(__FILE__), '..')
+  end
 
-ERR_MSG = <<EOF
-I expected to see a project.yml file in the current directoy. Please create one
-by hand or by using the 'ceedling' shell command.
-EOF
+  ##
+  # Return the path to the "built-in" plugins.
+  # === Return
+  # _String_ - The path where the default plugins live.
+  def self.load_path
+    File.join( self.location, 'plugins')
+  end
 
-def ceedling_dir
-  File.join(
-    File.dirname(__FILE__),
-    '..')
-end
+  ##
+  # Return the path to the Ceedling Rakefile
+  # === Return
+  # _String_
+  def self.rakefile
+    File.join( self.location, 'lib', 'ceedling', 'rakefile.rb' )
+  end
 
-def builtin_ceedling_plugins_path
-  File.join(
-    ceedling_dir,
-    'plugins')
-end
+  ##
+  # This method selects the project file that Ceedling will use by setting the
+  # CEEDLING_MAIN_PROJECT_FILE environment variable before loading the ceedling
+  # rakefile. A path supplied as an argument to this method will override the
+  # current value of the environment variable. If no path is supplied as an
+  # argument then the existing value of the environment variable is used. If
+  # the environment variable has not been set and no argument has been supplied
+  # then a default path of './project.yml' will be used.
+  #
+  # === Arguments
+  # +options+ _Hash_::
+  #   A hash containing the options for ceedling. Currently the following
+  #   options are supported:
+  #   * +config+ - The path to the project YAML configuration file.
+  #   * +root+ - The root of the project directory.
+  #   * +prefix+ - A prefix to prepend to plugin names in order to determine the
+  #     corresponding gem name.
+  #   * +plugins+ - The list of ceedling plugins to load
+  def self.load_project(options = {})
+    # Make sure our path to the yaml file is setup
+    if options.has_key? :config
+      ENV['CEEDLING_MAIN_PROJECT_FILE'] = options[:config]
+    elsif ENV['CEEDLING_MAIN_PROJECT_FILE'].nil?
+      ENV['CEEDLING_MAIN_PROJECT_FILE'] = './project.yml'
+    end
+
+    # Register the plugins
+    if options.has_key? :plugins
+      options[:plugins].each do |plugin|
+        register_plugin( plugin, options[:prefix] )
+      end
+    end
+
+    # Define the root of the project if specified
+    Object.const_set('PROJECT_ROOT', options[:root]) if options.has_key? :root
 
-ceeling_lib_rakefile = File.join( ceedling_dir,
-                                 'lib',
-                                 'rakefile.rb')
-if File.exists? "./project.yml"
-  load ceeling_lib_rakefile
-else
-  $stderr.puts ERR_MSG
+    # Load ceedling
+    load "#{self.rakefile}"
+  end
+
+  ##
+  # Register a plugin for ceedling to use when a project is loaded. This method
+  # *must* be called prior to calling the _load_project_ method.
+  #
+  # This method is intended to be used for loading plugins distributed via the
+  # RubyGems mechanism. As such, the following gem structure is assumed for
+  # plugins.
+  #
+  # * The gem name must be prefixed with 'ceedling-' followed by the plugin
+  #   name (ex. 'ceedling-bullseye')
+  #
+  # * The contents of the plugin must be isntalled into a subdirectory of
+  #   the gem with the same name as the plugin (ex. 'bullseye/')
+  #
+  # === Arguments
+  # +name+ _String_:: The name of the plugin to load.
+  # +prefix+ _String_::
+  #   (optional, default = nil) The prefix to use for the full gem name.
+  def self.register_plugin(name, prefix=nil)
+    # Figure out the full name of the gem and location
+    prefix   ||= 'ceedling-'
+    gem_name   = prefix + name
+    gem_dir    = Gem::Specification.find_by_name(gem_name).gem_dir()
+
+    # Register the plugin with Ceedling
+    require 'ceedling/defaults'
+    DEFAULT_CEEDLING_CONFIG[:plugins][:enabled]    << name
+    DEFAULT_CEEDLING_CONFIG[:plugins][:load_paths] << gem_dir
+  end
 end
+

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

@@ -1,27 +1,27 @@
-require 'constants'
-
-
-class BuildInvokerUtils
-
-  constructor :configurator, :streaminator
-  
-  def process_exception(exception, context, test_build=true)
-    if (exception.message =~ /Don't know how to build task '(.+)'/i)
-      error_header  = "ERROR: Rake could not find file referenced in source"
-      error_header += " or test" if (test_build) 
-      error_header += ": '#{$1}'. Possible stale dependency."
-      
-      @streaminator.stderr_puts( error_header )
-
-      if (@configurator.project_use_deep_dependencies)
-        help_message = "Try fixing #include statements or adding missing file. Then run '#{REFRESH_TASK_ROOT}#{context.to_s}' task and try again."      
-        @streaminator.stderr_puts( help_message )
-      end
-      
-      raise ''
-    else
-      raise exception
-    end
-  end
-  
-end
+require 'ceedling/constants'
+
+
+class BuildInvokerUtils
+
+  constructor :configurator, :streaminator
+  
+  def process_exception(exception, context, test_build=true)
+    if (exception.message =~ /Don't know how to build task '(.+)'/i)
+      error_header  = "ERROR: Rake could not find file referenced in source"
+      error_header += " or test" if (test_build) 
+      error_header += ": '#{$1}'. Possible stale dependency."
+      
+      @streaminator.stderr_puts( error_header )
+
+      if (@configurator.project_use_deep_dependencies)
+        help_message = "Try fixing #include statements or adding missing file. Then run '#{REFRESH_TASK_ROOT}#{context.to_s}' task and try again."      
+        @streaminator.stderr_puts( help_message )
+      end
+      
+      raise ''
+    else
+      raise exception
+    end
+  end
+  
+end

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

@@ -1,42 +1,42 @@
-
-class Cacheinator
-
-  constructor :cacheinator_helper, :file_path_utils, :file_wrapper, :yaml_wrapper
-  
-  def cache_test_config(hash)
-    @yaml_wrapper.dump( @file_path_utils.form_test_build_cache_path( INPUT_CONFIGURATION_CACHE_FILE), hash )
-  end
-
-  def cache_release_config(hash)
-    @yaml_wrapper.dump( @file_path_utils.form_release_build_cache_path( INPUT_CONFIGURATION_CACHE_FILE ), hash )
-  end
-
-  
-  def diff_cached_test_file( filepath )
-    cached_filepath = @file_path_utils.form_test_build_cache_path( filepath )
-  
-    if (@file_wrapper.exist?( cached_filepath ) and (!@file_wrapper.compare( filepath, cached_filepath )))
-      @file_wrapper.cp(filepath, cached_filepath, {:preserve => false})
-      return filepath
-    elsif (!@file_wrapper.exist?( cached_filepath ))
-      @file_wrapper.cp(filepath, cached_filepath, {:preserve => false}) 
-      return filepath
-    end
-
-    return cached_filepath
-  end
-
-  
-  def diff_cached_test_config?(hash)
-    cached_filepath = @file_path_utils.form_test_build_cache_path(INPUT_CONFIGURATION_CACHE_FILE)
-    
-    return @cacheinator_helper.diff_cached_config?( cached_filepath, hash )
-  end
-
-  def diff_cached_release_config?(hash)
-    cached_filepath = @file_path_utils.form_release_build_cache_path(INPUT_CONFIGURATION_CACHE_FILE)
-    
-    return @cacheinator_helper.diff_cached_config?( cached_filepath, hash )
-  end
-  
-end
+
+class Cacheinator
+
+  constructor :cacheinator_helper, :file_path_utils, :file_wrapper, :yaml_wrapper
+  
+  def cache_test_config(hash)
+    @yaml_wrapper.dump( @file_path_utils.form_test_build_cache_path( INPUT_CONFIGURATION_CACHE_FILE), hash )
+  end
+
+  def cache_release_config(hash)
+    @yaml_wrapper.dump( @file_path_utils.form_release_build_cache_path( INPUT_CONFIGURATION_CACHE_FILE ), hash )
+  end
+
+  
+  def diff_cached_test_file( filepath )
+    cached_filepath = @file_path_utils.form_test_build_cache_path( filepath )
+  
+    if (@file_wrapper.exist?( cached_filepath ) and (!@file_wrapper.compare( filepath, cached_filepath )))
+      @file_wrapper.cp(filepath, cached_filepath, {:preserve => false})
+      return filepath
+    elsif (!@file_wrapper.exist?( cached_filepath ))
+      @file_wrapper.cp(filepath, cached_filepath, {:preserve => false}) 
+      return filepath
+    end
+
+    return cached_filepath
+  end
+
+  
+  def diff_cached_test_config?(hash)
+    cached_filepath = @file_path_utils.form_test_build_cache_path(INPUT_CONFIGURATION_CACHE_FILE)
+    
+    return @cacheinator_helper.diff_cached_config?( cached_filepath, hash )
+  end
+
+  def diff_cached_release_config?(hash)
+    cached_filepath = @file_path_utils.form_release_build_cache_path(INPUT_CONFIGURATION_CACHE_FILE)
+    
+    return @cacheinator_helper.diff_cached_config?( cached_filepath, hash )
+  end
+  
+end