ceedling 0.29.0 → 0.30.0

data/lib/ceedling.rb

@@ -1,99 +1,99 @@
-##
-# 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
-
-  ##
-  # 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
-
-  ##
-  # Return the path to the Ceedling Rakefile
-  # === Return
-  # _String_
-  def self.rakefile
-    File.join( self.location, 'lib', 'ceedling', 'rakefile.rb' )
-  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
-
-    # 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
-
+##
+# 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
+
+  ##
+  # 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
+
+  ##
+  # Return the path to the Ceedling Rakefile
+  # === Return
+  # _String_
+  def self.rakefile
+    File.join( self.location, 'lib', 'ceedling', 'rakefile.rb' )
+  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
+
+    # 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/license.txt

@@ -1,31 +1,31 @@
- Copyright (c) 2007-2019 Mike Karlesky, Mark VanderVoord, Greg Williams
-
- Permission is hereby granted, free of charge, to any person
- obtaining a copy of this software and associated documentation
- files (the "Software"), to deal in the Software without
- restriction, including without limitation the rights to use,
- copy, modify, merge, publish, distribute, sublicense, and/or sell
- copies of the Software, and to permit persons to whom the
- Software is furnished to do so, subject to the following
- conditions:
-
- The above copyright notice and this permission notice shall be
- included in all copies or substantial portions of the Software.
-
- The end-user documentation included with the redistribution, if
- any, must include the following acknowledgment: "This product
- includes software developed for the Unity Project, by Mike Karlesky,
- Mark VanderVoord, and Greg Williams and other contributors", in
- the same place and form as other third-party acknowledgments.
- Alternately, this acknowledgment may appear in the software
- itself, in the same form and location as other such third-party
- acknowledgments.
-
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
- OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
- NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
- HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
- WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
- FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
- OTHER DEALINGS IN THE SOFTWARE.
+ Copyright (c) 2007-2019 Mike Karlesky, Mark VanderVoord, Greg Williams
+
+ Permission is hereby granted, free of charge, to any person
+ obtaining a copy of this software and associated documentation
+ files (the "Software"), to deal in the Software without
+ restriction, including without limitation the rights to use,
+ copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the
+ Software is furnished to do so, subject to the following
+ conditions:
+
+ The above copyright notice and this permission notice shall be
+ included in all copies or substantial portions of the Software.
+
+ The end-user documentation included with the redistribution, if
+ any, must include the following acknowledgment: "This product
+ includes software developed for the Unity Project, by Mike Karlesky,
+ Mark VanderVoord, and Greg Williams and other contributors", in
+ the same place and form as other third-party acknowledgments.
+ Alternately, this acknowledgment may appear in the software
+ itself, in the same form and location as other such third-party
+ acknowledgments.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ OTHER DEALINGS IN THE SOFTWARE.

data/plugins/beep/README.md

@@ -1,22 +1,22 @@
-ceedling-beep
-=============
-
-This is a simple plugin that just beeps at the end of a build and/or test sequence. Are you getting too distracted surfing
-the internet, chatting with coworkers, or swordfighting while it's building or testing? The friendly beep will let you know
-it's time to pay attention again.
-
-This plugin has very few configuration options. At this time it can beep on completion of a task and/or on an error condition.
-For each of these, you can configure the method that it should beep.
-
-```
-:tools:
-  :beep_on_done: :bell
-  :beep_on_error: :bell
-```
-
-Each of these have the following options:
-
-  - :bell - this option uses the ASCII bell character out stdout
-  - :speaker_test - this uses the linux speaker-test command if installed
-
-Very likely, we'll be adding to this list if people find this to be useful.
+ceedling-beep
+=============
+
+This is a simple plugin that just beeps at the end of a build and/or test sequence. Are you getting too distracted surfing
+the internet, chatting with coworkers, or swordfighting while it's building or testing? The friendly beep will let you know
+it's time to pay attention again.
+
+This plugin has very few configuration options. At this time it can beep on completion of a task and/or on an error condition.
+For each of these, you can configure the method that it should beep.
+
+```
+:tools:
+  :beep_on_done: :bell
+  :beep_on_error: :bell
+```
+
+Each of these have the following options:
+
+  - :bell - this option uses the ASCII bell character out stdout
+  - :speaker_test - this uses the linux speaker-test command if installed
+
+Very likely, we'll be adding to this list if people find this to be useful.

data/plugins/beep/lib/beep.rb

@@ -1,40 +1,40 @@
-require 'ceedling/plugin'
-require 'ceedling/constants'
-
-class Beep < Plugin
-
-  attr_reader :config
-
-  def setup
-    @config = {
-      :on_done  => ((defined? TOOLS_BEEP_ON_DONE)  ? TOOLS_BEEP_ON_DONE  : :bell  ),
-      :on_error => ((defined? TOOLS_BEEP_ON_ERROR) ? TOOLS_BEEP_ON_ERROR : :bell  ),
-    }
-  end
-
-  def post_build
-    beep @config[:on_done]
-  end
-
-  def post_error
-    beep @config[:on_error]
-  end
-
-  private
-
-  def beep(method = :none)
-    case method
-    when :bell
-      if (SystemWrapper.windows?)
-        puts "echo '\007'"
-      else
-        puts "echo -ne '\007'"
-      end
-    when :speaker_test
-      `speaker-test -t sine -f 1000 -l 1`
-    else
-      #do nothing with illegal or :none
-    end
-  end
-end
-
+require 'ceedling/plugin'
+require 'ceedling/constants'
+
+class Beep < Plugin
+
+  attr_reader :config
+
+  def setup
+    @config = {
+      :on_done  => ((defined? TOOLS_BEEP_ON_DONE)  ? TOOLS_BEEP_ON_DONE  : :bell  ),
+      :on_error => ((defined? TOOLS_BEEP_ON_ERROR) ? TOOLS_BEEP_ON_ERROR : :bell  ),
+    }
+  end
+
+  def post_build
+    beep @config[:on_done]
+  end
+
+  def post_error
+    beep @config[:on_error]
+  end
+
+  private
+
+  def beep(method = :none)
+    case method
+    when :bell
+      if (SystemWrapper.windows?)
+        puts "echo '\007'"
+      else
+        puts "echo -ne '\007'"
+      end
+    when :speaker_test
+      `speaker-test -t sine -f 1000 -l 1`
+    else
+      #do nothing with illegal or :none
+    end
+  end
+end
+

data/plugins/bullseye/README.md

@@ -0,0 +1,76 @@
+ceedling-bullseye
+=================
+
+# Plugin Overview
+
+Plugin for integrating Bullseye code coverage tool into Ceedling projects.
+This plugin requires a working license to Bullseye code coverage tools. The tools
+must be within the path or the path should be added to the environment in the 
+`project.yml file`.
+
+## Configuration
+
+The bullseye plugin supports configuration options via your `project.yml` provided
+by Ceedling. The following is a typical configuration example:
+
+```
+:bullseye:
+  :auto_license: TRUE
+:plugins:
+  :bullseye_lib_path: []
+:paths:
+  :bullseye_toolchain_include: []
+
+:tools:
+  :bullseye_instrumentation:
+    :executable: covc
+    :arguments:
+      - '--file $': ENVIRONMENT_COVFILE
+      - -q
+      - ${1}
+  :bullseye_compiler:
+    :executable: gcc
+    :arguments:
+      - -g
+      - -I"$": COLLECTION_PATHS_TEST_SUPPORT_SOURCE_INCLUDE_VENDOR
+      - -I"$": COLLECTION_PATHS_BULLSEYE_TOOLCHAIN_INCLUDE
+      - -D$: COLLECTION_DEFINES_TEST_AND_VENDOR
+      - -DBULLSEYE_COMPILER
+      - -c "${1}"
+      - -o "${2}"
+  :bullseye_linker:
+    :executable: gcc
+    :arguments:
+      - ${1}
+      - -o ${2}
+      - -L$: PLUGINS_BULLSEYE_LIB_PATH
+      - -lcov
+  :bullseye_fixture:
+    :executable: ${1}
+  :bullseye_report_covsrc:
+    :executable: covsrc
+    :arguments:
+      - '--file $': ENVIRONMENT_COVFILE
+      - -q
+      - -w140
+  :bullseye_report_covfn:
+    :executable: covfn
+    :stderr_redirect: :auto
+    :arguments:
+      - '--file $': ENVIRONMENT_COVFILE
+      - --width 120
+      - --no-source
+      - '"${1}"'
+  :bullseye_browser:
+    :executable: CoverageBrowser
+    :background_exec: :auto
+    :optional: TRUE
+    :arguments:
+      - '"$"': ENVIRONMENT_COVFILE
+```
+
+## Example Usage
+
+```sh
+ceedling bullseye:all utils:bullseye
+```

data/plugins/bullseye/assets/template.erb

@@ -1,15 +1,15 @@
-% function_string = hash[:coverage][:functions].to_s
-% branch_string   = hash[:coverage][:branches].to_s
-% format_string   = "%#{[function_string.length, branch_string.length].max}i"
-<%=@ceedling[:plugin_reportinator].generate_banner("#{hash[:header]}: CODE COVERAGE SUMMARY")%>
-% if (!hash[:coverage][:functions].nil?)
-FUNCTIONS: <%=sprintf(format_string, hash[:coverage][:functions])%>%
-% else
-FUNCTIONS: none
-% end
-% if (!hash[:coverage][:branches].nil?)
-BRANCHES:  <%=sprintf(format_string, hash[:coverage][:branches])%>%
-% else
-BRANCHES:  none
-% end
-
+% function_string = hash[:coverage][:functions].to_s
+% branch_string   = hash[:coverage][:branches].to_s
+% format_string   = "%#{[function_string.length, branch_string.length].max}i"
+<%=@ceedling[:plugin_reportinator].generate_banner("#{hash[:header]}: CODE COVERAGE SUMMARY")%>
+% if (!hash[:coverage][:functions].nil?)
+FUNCTIONS: <%=sprintf(format_string, hash[:coverage][:functions])%>%
+% else
+FUNCTIONS: none
+% end
+% if (!hash[:coverage][:branches].nil?)
+BRANCHES:  <%=sprintf(format_string, hash[:coverage][:branches])%>%
+% else
+BRANCHES:  none
+% end
+