ceedling 0.28.3 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a42e9eac6e308f7c966953c1c2d3dc9f1ccfc9bb
-  data.tar.gz: bc07f7ab10c38c3f3ddc106e87610d2cb504f263
+SHA256:
+  metadata.gz: e7af7d95453c0e7c09164e299afb08c59bd1004ebfb279e8857df5d117e0e7de
+  data.tar.gz: 4f10c322dc7526a2296dcb725b726de50d353e303ddc16d3b47a62cf80c1a1b5
 SHA512:
-  metadata.gz: 1af9dc3072c77add2e69897021dfadb222b7568315c23777233afd1b27cf4fe0dc1bd1b865762676244a79ce785774468d7bf7a18c70e60b47c5d685db9bc2c8
-  data.tar.gz: 10c3c3203587c59f3c93fad88b53f3608c0a52f41d81753c2982167b8c4804524a5f6ac773db311bb3d0eb6c34431b3732fa4551d16eec608ef561343815134e
+  metadata.gz: 18f1c30727ed97eb04c84116d50e698a5a9907beaf0448264595593cc2d790ff26ebe1c94265792c7373b4270f9276676929c669616b80098797d417f11d424e
+  data.tar.gz: 02f2ac736750915514646d5818de1e5a37e66e2610d14e7649f66b00e12ac41de79f2708380d4669e6aaa3518885251ef2864c68a2572ac9ff79b87e8891a268

data/Gemfile

@@ -1,16 +1,16 @@
-source "http://rubygems.org/"
-
-gem "bundler", ">= 1.3.5"
-gem "rake", ">= 0.9.2.2"
-
-gem "rspec", "~> 3.0"
-gem "require_all"
-gem "constructor"
-gem "diy"
-gem "rr"
-gem "thor"
-
-#these will be used if present, but ignored otherwise
-#gem "curses"
-#gem "pty",    :platforms => [ :ruby ] #automatically included on *nix platforms
-#gem "popen4", :platforms => [ :mswin ]
+source "http://rubygems.org/"
+
+gem "bundler", ">= 1.3.5"
+gem "rake", ">= 12.2.1"
+
+gem "rspec", "~> 3.8"
+gem "require_all"
+gem "constructor"
+gem "diy"
+gem "rr"
+gem "thor"
+
+#these will be used if present, but ignored otherwise
+#gem "curses"
+#gem "pty",    :platforms => [ :ruby ] #automatically included on *nix platforms
+#gem "popen4", :platforms => [ :mswin ]

data/Gemfile.lock

@@ -2,39 +2,40 @@ GEM
   remote: http://rubygems.org/
   specs:
     constructor (2.0.0)
-    diff-lcs (1.2.5)
+    diff-lcs (1.3)
     diy (1.1.2)
       constructor (>= 1.0.0)
-    rake (10.5.0)
+    rake (12.3.2)
     require_all (1.3.3)
     rr (1.1.2)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.2)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
     thor (0.19.1)
 
 PLATFORMS
   ruby
+  x64-mingw32
 
 DEPENDENCIES
   bundler (>= 1.3.5)
   constructor
   diy
-  rake (>= 0.9.2.2)
+  rake (>= 12.2.1)
   require_all
   rr
-  rspec (~> 3.0)
+  rspec (~> 3.8)
   thor
 
 BUNDLED WITH
-   1.11.2
+   2.0.2

data/README.md

@@ -1,66 +1,107 @@
-Ceedling - Build/test system for C based on Ruby/Rake
-=====================================================
-
-[![Ceedling Build Status](https://api.travis-ci.org/ThrowTheSwitch/Ceedling.png?branch=master)](https://travis-ci.org/ThrowTheSwitch/Ceedling)
-
-Ceedling is a build system for C projects that is something of an extension around Ruby’s Rake (make-ish) build system. Ceedling also makes TDD (Test-Driven Development) in C a breeze by integrating [CMock](https://github.com/throwtheswitch/cmock), [Unity](https://github.com/throwtheswitch/unity), and [CException](https://github.com/throwtheswitch/cexception) -- three other awesome open-source projects you can’t live without if you're creating awesomeness in the C language. Ceedling is also extensible with a handy plugin mechanism.
-
-Usage Documentation
-===================
-
-Documentation and license info exists [in the repo in docs/](docs/CeedlingPacket.md)
-
-Getting Started (Developers)
-============================
-
-First make sure Ruby is installed on your system (if it's not already). Then, from a command prompt:
-
-    > gem install ceedling
-
-(Alternate Installation for Those Planning to Be Ceedling Developers)
-======================================================================
-
-    > git clone --recursive https://github.com/throwtheswitch/ceedling.git
-    > cd ceedling
-    > bundle install # Ensures you have all RubyGems needed
-    > bundle exec rake # Run all CMock library tests
-
-If bundler isn't installed on your system or you run into problems, you might have to install it:
-
-    > sudo gem install bundler
-
-Pulling Ceedling inside a Project
-=================================
-
-Ceedling can deploy all of its guts into a folder. This allows it
-to be used without having to worry about external dependencies.
-You don't have to worry about Ceedling changing for this particular
-project just because you updated your gems.
-
-    ceedling new YourNewProjectName
-
-This will install all of Unity, CMock, and Ceedling into a new folder
-named YourNewProjectName. It will also create a simple directory structure
-for you with src and test folders. SCORE! It's also creates a simple
-rakefile and project.yml file that you can tweak to your own needs.
-
-It'll also include documentation for all of these tools, unless you
-specify --nodocs at when you issue the command above... then it skips
-that step for you.
-
-Using Ceedling From A Ruby Gem
-==============================
-
-Ceedling can also be used as a gem. By installing it this way, you
-can automatically update to the latest version of Ceedling, Unity,
-and CMock just by running an update on your gems. Use this if you
-are only running one project OR if you feel you want to keep all
-your projects up to date.
-
-    ceedling new YourNewProjectName --as_gem
-
-This creates a new folder named YourNewProjectName. Inside it will be your
-shiny new project file, rakefile, and a couple of src and test directories
-to get you started. You can then tweak all of those things to your heart's
-content.
-
+Ceedling - Build/Test System for C Based on Ruby/Rake
+=====================================================
+
+[![Ceedling Build Status](https://api.travis-ci.org/ThrowTheSwitch/Ceedling.png?branch=master)](https://travis-ci.org/ThrowTheSwitch/Ceedling)
+
+Ceedling is a build system for C projects that is something of an extension around Ruby’s Rake (make-ish) build system. Ceedling also makes TDD (Test-Driven Development) in C a breeze by integrating [CMock](https://github.com/throwtheswitch/cmock), [Unity](https://github.com/throwtheswitch/unity), and [CException](https://github.com/throwtheswitch/cexception) -- three other awesome open-source projects you can’t live without if you're creating awesomeness in the C language. Ceedling is also extensible with a handy plugin mechanism.
+
+Usage Documentation
+===================
+
+Documentation and license info exists [in the repo in docs/](docs/CeedlingPacket.md)
+
+Getting Started
+===============
+
+First make sure Ruby is installed on your system (if it's not already). Then, from a command prompt:
+
+    > gem install ceedling
+
+(Alternate Installation for Those Planning to Be Ceedling Developers)
+======================================================================
+
+    > git clone --recursive https://github.com/throwtheswitch/ceedling.git
+    > cd ceedling
+    > bundle install # Ensures you have all RubyGems needed
+    > bundle exec rake # Run all CMock library tests
+
+If bundler isn't installed on your system or you run into problems, you might have to install it:
+
+    > sudo gem install bundler
+
+If you run into trouble running bundler and get messages like this `can't find gem
+bundler (>= 0.a) with executable bundle (Gem::GemNotFoundException)`, you may
+need to install a different version of bundler. For this please reference the
+version in the Gemfile.lock. An example based on the current Gemfile.lock is as
+followed:
+
+    > sudo gem install bundler -v 1.16.2
+
+Creating A Project
+==================
+
+Creating a project with Ceedling is easy. Simply tell ceedling the
+name of the project, and it will create a subdirectory called that
+name and fill it with a default directory structure and configuration.
+
+    ceedling new YourNewProjectName
+
+You can add files to your src and test directories and they will
+instantly become part of your test build. Need a different structure?
+You can start to tweak the `project.yml` file immediately with your new
+path or tool requirements.
+
+You can upgrade to the latest version of Ceedling at any time,
+automatically gaining access to the packaged Unity and CMock that
+come with it.
+
+    gem update ceedling
+
+Documentation
+=============
+
+Are you just getting started with Ceedling? Maybe you'd like your
+project to be installed with some of its handy documentation? No problem!
+You can do this when you create a new project.
+
+    ceedling new --docs MyAwesomeProject
+
+Bonding Your Tools And Project
+==============================
+
+Ceedling can deploy all of its guts into the project as well. This
+allows it to be used without having to worry about external dependencies.
+You don't have to worry about Ceedling changing for this particular
+project just because you updated your gems... no need to worry about
+changes in Unity or CMock breaking your build in the future. If you'd like
+to use Ceedling this way, tell it you want a local copy when you create
+your project:
+
+    ceedling new --local YourNewProjectName
+
+This will install all of Unity, CMock, and Ceedling into a new folder
+named `vendor` inside your project `YourNewProjectName`. It will still create
+the simple directory structure for you with `src` and `test` folders.
+
+SCORE!
+
+If you want to force a locally installed version of Ceedling to upgrade
+to match your latest gem later, it's easy! Just issue the following command:
+
+    ceedling upgrade --local YourNewProjectName
+
+Just like the `new` command, it's called from the parent directory of your
+project.
+
+Are you afraid of losing all your local changes when this happens? You can keep
+Ceedling from updating your project file by issuing `no_configs`.
+
+    ceedling upgrade --local --no_configs TheProject
+
+Git Integration
+===============
+
+Are you using Git? You might want to automatically have Ceedling create a
+`gitignore` file for you by adding `--gitignore` to your `new` call.
+
+*HAPPY TESTING!*

data/Rakefile

@@ -1,11 +1,11 @@
-#!/usr/bin/env rake
-require 'bundler'
-require 'rspec/core/rake_task'
-
-desc "Run all rspecs"
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.pattern = 'spec/**/*_spec.rb'
-end
-
-task :default => [:spec]
-task :ci => [:spec]
+#!/usr/bin/env rake
+require 'bundler'
+require 'rspec/core/rake_task'
+
+desc "Run all rspecs"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => [:spec]
+task :ci => [:spec]

data/assets/ceedling

@@ -1,3 +1,3 @@
-#!/bin/bash
-
-ruby vendor/ceedling/bin/ceedling $*
+#!/bin/bash
+
+ruby vendor/ceedling/bin/ceedling $*

data/assets/ceedling.cmd

@@ -1 +1 @@
-ruby vendor\ceedling\bin\ceedling %*
+ruby vendor\ceedling\bin\ceedling %*

data/assets/default_gitignore

@@ -1,5 +1,5 @@
-build/artifacts
-build/gcov
-builld/logs 
-build/temp
-build/test
+build/artifacts
+build/gcov
+build/logs 
+build/temp
+build/test

data/assets/example_file.c

@@ -1,5 +1,5 @@
-#include "example_file.h"
-
-int add_numbers(int a, int b) {
-  return a + b;
-}
+#include "example_file.h"
+
+int add_numbers(int a, int b) {
+  return a + b;
+}

data/assets/example_file.h

@@ -1,6 +1,6 @@
-#ifndef EXAMPLE_FILE_H
-#define EXAMPLE_FILE_H
-
-int add_numbers(int a, int b);
-
-#endif /* EXAMPLE_FILE_H */
+#ifndef EXAMPLE_FILE_H
+#define EXAMPLE_FILE_H
+
+int add_numbers(int a, int b);
+
+#endif /* EXAMPLE_FILE_H */

data/assets/project_as_gem.yml

@@ -1,90 +1,100 @@
----
-
-# Notes:
-# Sample project C code is not presently written to produce a release artifact.
-# As such, release build options are disabled.
-# This sample, therefore, only demonstrates running a collection of unit tests.
-
-:project:
-  :use_exceptions: FALSE
-  :use_test_preprocessor: TRUE
-  :use_auxiliary_dependencies: TRUE
-  :build_root: build
-#  :release_build: TRUE
-  :test_file_prefix: test_
-  :which_ceedling: gem
-  :default_tasks:
-    - test:all
-
-#:release_build:
-#  :output: MyApp.out
-#  :use_assembly: FALSE
-
-:environment:
-
-:extension:
-  :executable: .out
-
-:paths:
-  :test:
-    - +:test/**
-    - -:test/support
-  :source:
-    - src/**
-  :support:
-    - test/support
-
-:defines:
-  # in order to add common defines:
-  #  1) remove the trailing [] from the :common: section
-  #  2) add entries to the :common: section (e.g. :test: has TEST defined)
-  :commmon: &common_defines []
-  :test:
-    - *common_defines
-    - TEST
-  :test_preprocess:
-    - *common_defines
-    - TEST
-
-:cmock:
-  :mock_prefix: mock_
-  :when_no_prototypes: :warn
-  :enforce_strict_ordering: TRUE
-  :plugins:
-    - :ignore
-    - :callback
-  :treat_as:
-    uint8:    HEX8
-    uint16:   HEX16
-    uint32:   UINT32
-    int8:     INT8
-    bool:     UINT8
-
-:gcov:
-    :html_report_type: basic
-
-#:tools:
-# Ceedling defaults to using gcc for compiling, linking, etc.
-# As [:tools] is blank, gcc will be used (so long as it's in your system path)
-# See documentation to configure a given toolchain for use
-
-# LIBRARIES
-# These libraries are automatically injected into the build process. Those specified as
-# common will be used in all types of builds. Otherwise, libraries can be injected in just
-# tests or releases. These options are MERGED with the options in supplemental yaml files.
-:libraries:
-  :placement: :end
-  :flag: "${1}"  # or "-L ${1}" for example
-  :common: &common_libraries []
-  :test:
-    - *common_libraries
-  :release:
-    - *common_libraries
-
-:plugins:
-  :load_paths:
-    - "#{Ceedling.load_path}"
-  :enabled:
-    - stdout_pretty_tests_report
-    - module_generator
-...
+---
+
+# Notes:
+# Sample project C code is not presently written to produce a release artifact.
+# As such, release build options are disabled.
+# This sample, therefore, only demonstrates running a collection of unit tests.
+
+:project:
+  :use_exceptions: FALSE
+  :use_test_preprocessor: TRUE
+  :use_auxiliary_dependencies: TRUE
+  :build_root: build
+#  :release_build: TRUE
+  :test_file_prefix: test_
+  :which_ceedling: gem
+  :default_tasks:
+    - test:all
+
+#:test_build:
+#  :use_assembly: TRUE
+
+#:release_build:
+#  :output: MyApp.out
+#  :use_assembly: FALSE
+
+:environment:
+
+:extension:
+  :executable: .out
+
+:paths:
+  :test:
+    - +:test/**
+    - -:test/support
+  :source:
+    - src/**
+  :support:
+    - test/support
+
+:defines:
+  # in order to add common defines:
+  #  1) remove the trailing [] from the :common: section
+  #  2) add entries to the :common: section (e.g. :test: has TEST defined)
+  :common: &common_defines []
+  :test:
+    - *common_defines
+    - TEST
+  :test_preprocess:
+    - *common_defines
+    - TEST
+
+:cmock:
+  :mock_prefix: mock_
+  :when_no_prototypes: :warn
+  :enforce_strict_ordering: TRUE
+  :plugins:
+    - :ignore
+    - :callback
+  :treat_as:
+    uint8:    HEX8
+    uint16:   HEX16
+    uint32:   UINT32
+    int8:     INT8
+    bool:     UINT8
+
+# Add -gcov to the plugins list to make sure of the gcov plugin
+# You will need to have gcov and gcovr both installed to make it work.
+# For more information on these options, see docs in plugins/gcov
+:gcov:
+    :html_report: TRUE
+    :html_report_type: detailed
+    :html_medium_threshold: 75
+    :html_high_threshold: 90
+    :xml_report: FALSE
+
+#:tools:
+# Ceedling defaults to using gcc for compiling, linking, etc.
+# As [:tools] is blank, gcc will be used (so long as it's in your system path)
+# See documentation to configure a given toolchain for use
+
+# LIBRARIES
+# These libraries are automatically injected into the build process. Those specified as
+# common will be used in all types of builds. Otherwise, libraries can be injected in just
+# tests or releases. These options are MERGED with the options in supplemental yaml files.
+:libraries:
+  :placement: :end
+  :flag: "${1}"  # or "-L ${1}" for example
+  :common: &common_libraries []
+  :test:
+    - *common_libraries
+  :release:
+    - *common_libraries
+
+:plugins:
+  :load_paths:
+    - "#{Ceedling.load_path}"
+  :enabled:
+    - stdout_pretty_tests_report
+    - module_generator
+...