ceedling 0.28.2 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5ab20a20fd53b1935cb3c11cffa2f890c18f4f10
-  data.tar.gz: 8d728ca829262063f0422614c248d0eb77ca77a7
+SHA256:
+  metadata.gz: b31288bb9de3d69e188046013dcbb67be81d806c92c0a5b929a2e371805dc6ef
+  data.tar.gz: 2d9258e4429ff1a98567efa2635d833c89866f1300462951b2f38f4058174ec2
 SHA512:
-  metadata.gz: 6aac3b5f1c9bf0179912b4bb8f1ea0889765643d9414afad5706bc45b20110045766b5ea8035809406df5247f8b6ec32ae7ebcc299ad1e2dce37365a50b3525c
-  data.tar.gz: e40627df9e67de61b8f7e0e6e5360bcc4d69f727c1cff93a13fdbaea06f1333184b1fbf56664eeefab381926f68ae66e142f1194660442a619e12a699bf577f0
+  metadata.gz: 00ba79ff0844313de7ffee17a1fa5dbe1f64638be98ee3e4a7f722c7eafd26af641ee1f7f99366fd22ff29e8afe8df763b286d30dd7caafd7535465b19ea8a9e
+  data.tar.gz: beff63833ed09a8c94bf306163d2395433bb1341642bc0ce407fe3d5c034313f8cdba6b134e07a913eae3ca00f97dc87bf55741262142f6d0baba2b22bd9fdb5

data/Gemfile

@@ -1,14 +1,14 @@
 source "http://rubygems.org/"
 
-gem "bundler", ">= 1.3.5"
-gem "rake", ">= 0.9.2.2"
-
-gem "rspec", "~> 3.0"
+gem "bundler"
+gem "rake"
+gem "rspec", "~> 3.8"
 gem "require_all"
 gem "constructor"
 gem "diy"
 gem "rr"
 gem "thor"
+gem "deep_merge"
 
 #these will be used if present, but ignored otherwise
 #gem "curses"

data/Gemfile.lock

@@ -2,39 +2,42 @@ GEM
   remote: http://rubygems.org/
   specs:
     constructor (2.0.0)
-    diff-lcs (1.2.5)
+    deep_merge (1.2.1)
+    diff-lcs (1.3)
     diy (1.1.2)
       constructor (>= 1.0.0)
-    rake (10.5.0)
+    rake (12.3.3)
     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)
+  bundler
   constructor
+  deep_merge
   diy
-  rake (>= 0.9.2.2)
+  rake
   require_all
   rr
-  rspec (~> 3.0)
+  rspec (~> 3.8)
   thor
 
 BUNDLED WITH
-   1.11.2
+   2.0.2

data/README.md

@@ -1,17 +1,20 @@
-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.
+Ceedling ![CI](https://github.com/ThrowTheSwitch/Ceedling/workflows/CI/badge.svg)
+========
+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)
-============================
+Getting Started
+===============
 
 First make sure Ruby is installed on your system (if it's not already). Then, from a command prompt:
 
@@ -23,44 +26,86 @@ First make sure Ruby is installed on your system (if it's not already). Then, fr
     > 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
+    > git submodule update --init --recursive # Updates all submodules
+    > bundle exec rake # Run all Ceedling 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
-=================================
+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:
 
-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.
+    > 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
 
-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.
+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.
 
-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.
+    ceedling new --docs MyAwesomeProject
 
-Using Ceedling From A Ruby Gem
+Bonding Your Tools And Project
 ==============================
 
-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 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
 
-    ceedling new YourNewProjectName --as_gem
+Git Integration
+===============
 
-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.
+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/assets/auto_link_deep_dependencies/src/a.c

@@ -0,0 +1,7 @@
+#include "a.h"
+#include "b.h"
+
+int function_from_a(int a)
+{
+  return 2 * function_from_b(a);
+}

data/assets/auto_link_deep_dependencies/src/b.c

@@ -0,0 +1,7 @@
+#include "b.h"
+#include "c.h"
+
+int function_from_b(int b)
+{
+  return 2 * function_from_c(b);
+}

data/assets/auto_link_deep_dependencies/src/c.c

@@ -0,0 +1,8 @@
+#include "c.h"
+#include "never_compiled.h"
+
+int function_from_c(int c)
+{
+  function_never_compiled(2);
+  return 2 * c;
+}

data/assets/auto_link_deep_dependencies/src/internal_inc/a.h

@@ -0,0 +1,6 @@
+#ifndef A_H
+#define A_H
+
+int function_from_a(int a);
+
+#endif /* A_H */

data/assets/auto_link_deep_dependencies/src/internal_inc/b.h

@@ -0,0 +1,6 @@
+#ifndef B_H
+#define B_H
+
+int function_from_b(int b);
+
+#endif /* B_H */

data/assets/auto_link_deep_dependencies/src/internal_inc/c.h

@@ -0,0 +1,6 @@
+#ifndef C_H
+#define C_H
+
+int function_from_c(int c);
+
+#endif /* C_H */

data/assets/auto_link_deep_dependencies/src/internal_inc/never_compiled.h

@@ -0,0 +1,6 @@
+#ifndef NEVER_COMPILED_H
+#define NEVER_COMPILED_H
+
+int function_never_compiled(int x);
+
+#endif /* NEVER_COMPILED_H */

data/assets/auto_link_deep_dependencies/src/never_compiled.c

@@ -0,0 +1,6 @@
+#include "never_compiled.h"
+
+int function_never_compiled(int x)
+{
+  never runed function
+}

data/assets/auto_link_deep_dependencies/test/test_a.c

@@ -0,0 +1,11 @@
+#include "unity.h"
+#include "a.h"
+#include "mock_never_compiled.h"
+
+void setUp(void) {}
+void tearDown(void) {}
+
+void test_function_from_a_should_return_16(void) {
+  function_never_compiled_ExpectAndReturn(2, 2);
+  TEST_ASSERT_EQUAL(16, function_from_a(2));
+}

data/assets/auto_link_deep_dependencies/test/test_b.c

@@ -0,0 +1,11 @@
+#include "unity.h"
+#include "b.h"
+#include "mock_never_compiled.h"
+
+void setUp(void) {}
+void tearDown(void) {}
+
+void test_function_from_b_should_return_8(void) {
+  function_never_compiled_ExpectAndReturn(2, 2);
+  TEST_ASSERT_EQUAL(8, function_from_b(2));
+}

data/assets/auto_link_deep_dependencies/test/test_c.c

@@ -0,0 +1,11 @@
+#include "unity.h"
+#include "c.h"
+#include "mock_never_compiled.h"
+
+void setUp(void) {}
+void tearDown(void) {}
+
+void test_function_from_c_should_return_4(void) {
+  function_never_compiled_ExpectAndReturn(2, 2);
+  TEST_ASSERT_EQUAL(4, function_from_c(2));
+}

data/assets/ceedling

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

data/assets/ceedling.cmd

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

data/assets/default_gitignore

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

data/assets/project_as_gem.yml

@@ -13,9 +13,13 @@
 #  :release_build: TRUE
   :test_file_prefix: test_
   :which_ceedling: gem
+  :ceedling_version: '?'
   :default_tasks:
     - test:all
 
+#:test_build:
+#  :use_assembly: TRUE
+
 #:release_build:
 #  :output: MyApp.out
 #  :use_assembly: FALSE
@@ -33,12 +37,13 @@
     - src/**
   :support:
     - test/support
+  :libraries: []
 
 :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 []
+  :common: &common_defines []
   :test:
     - *common_defines
     - TEST
@@ -60,8 +65,15 @@
     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_type: basic
+  :reports:
+    - HtmlDetailed
+  :gcovr:
+    :html_medium_threshold: 75
+    :html_high_threshold: 90
 
 #:tools:
 # Ceedling defaults to using gcc for compiling, linking, etc.
@@ -74,12 +86,11 @@
 # 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
+  :flag: "-l${1}"
+  :path_flag: "-L ${1}"
+  :system: []    # for example, you might list 'm' to grab the math library
+  :test: []
+  :release: []
 
 :plugins:
   :load_paths:

data/assets/project_with_guts.yml

@@ -13,9 +13,13 @@
 #  :release_build: TRUE
   :test_file_prefix: test_
   :which_ceedling: vendor/ceedling
+  :ceedling_version: '?'
   :default_tasks:
     - test:all
 
+#:test_build:
+#  :use_assembly: TRUE
+
 #:release_build:
 #  :output: MyApp.out
 #  :use_assembly: FALSE
@@ -33,12 +37,13 @@
     - src/**
   :support:
     - test/support
+  :libraries: []
 
 :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 []
+  :common: &common_defines []
   :test:
     - *common_defines
     - TEST
@@ -60,8 +65,15 @@
     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_type: basic
+  :reports:
+    - HtmlDetailed
+  :gcovr:
+    :html_medium_threshold: 75
+    :html_high_threshold: 90
 
 #:tools:
 # Ceedling defaults to using gcc for compiling, linking, etc.
@@ -74,12 +86,11 @@
 # 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
+  :flag: "-l${1}"
+  :path_flag: "-L ${1}"
+  :system: []    # for example, you might list 'm' to grab the math library
+  :test: []
+  :release: []
 
 :plugins:
   :load_paths:
@@ -87,4 +98,5 @@
   :enabled:
     - stdout_pretty_tests_report
     - module_generator
+    - raw_output_report
 ...