Merge pull request #425 from ThrowTheSwitch/cmock_2_6_rc

CMock 2.6 Release Candidate

Author: mvandervoord

.github/workflows/main.yml

@@ -15,16 +15,14 @@ jobs:
   unit-tests:
     name: "Unit Tests"
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['3.0', '3.1', '3.2', '3.3']
     steps:
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '3.0' # Not needed with a .ruby-version file
-          bundler-cache: true # runs 'bundle install' and caches
-
       # Install Multilib
       - name: Install Multilib
         run: |
-          sudo apt-get update --assume-yes
+          sudo apt-get update -qq
           sudo apt-get install --assume-yes --quiet gcc-multilib
 
       # Checks out repository under $GITHUB_WORKSPACE
@@ -33,12 +31,19 @@ jobs:
         with: 
           submodules: recursive
 
+      # Setup Ruby Testing Tools to do tests on multiple ruby version
+      - name: Setup Ruby Testing Tools
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
       # Install Ruby Testing Tools
       - name: Setup Ruby Testing Tools
         run: |
-          sudo gem install bundler
           sudo gem install rspec
-          sudo gem install rubocop -v 0.57.2
+          sudo gem install rubocop -v 1.57.2
+          sudo gem install bundler
+          bundle update
           bundle install 
 
       # Run Tests

Gemfile

@@ -1,8 +1 @@
 source "http://rubygems.org/"
-
-gem "bundler"
-gem "rake"
-gem "minitest"
-gem "require_all"
-gem "constructor"
-gem "diy"

LICENSE.txt

@@ -1,4 +1,6 @@
-Copyright (c) 2007-14 Mike Karlesky, Mark VanderVoord, Greg Williams
+The MIT License (MIT)
+
+Copyright (c) 2007-25 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

README.md

@@ -1,5 +1,6 @@
 CMock ![CI](https://github.com/ThrowTheSwitch/CMock/workflows/CI/badge.svg)
 =====
+
 CMock is a mock and stub generator and runtime for unit testing C. It's been designed
 to work smoothly with Unity Test, another of the embedded-software testing tools 
 developed by ThrowTheSwitch.org. CMock automagically parses your C headers and creates
@@ -8,30 +9,45 @@ useful and usable mock interfaces for unit testing. Give it a try!
 If you don't care to manage unit testing builds yourself, consider checking out Ceedling, 
 a test-centered build manager for unit testing C code.
 
+ - [Known Issues](docs/CMockKnownIssues.md)
+ - [Change Log](docs/CMockChangeLog.md)
+
 Getting Started
-================
+===============
+
+Your first step is to get yourself a copy of CMock. There are a number of ways to do this:
 
-If you're using Ceedling, there is no need to install CMock. It will handle it for you.
-For everyone else, the simplest way is to grab it off github. You can also download it
-as a zip if you prefer. The Github method looks something like this:
+1. If you're using Ceedling, there is no need to install CMock. It will handle it for you.
+
+2. The simplest way is to grab it off github. The Github method looks something like this:
 
     > git clone --recursive https://github.com/throwtheswitch/cmock.git
-    > cd cmock
-    > bundle install # Ensures you have all RubyGems needed
+
+3. You can also grab the `zip` file from github. If you do this, you'll also need to grab yourself a
+copy of Unity and CException, because github unfortunately doesn't bake dependencies into the zip
+files. 
+
+Contributing to this Project
+============================
 
 If you plan to help with the development of CMock (or just want to verify that it can
-perform its self tests on your system) then you can enter the test directory and then
-ask it to test:
+perform its self tests on your system) then you can grab its self-testing dependencies, 
+then run its self-tests:
 
+    > cd cmock
+    > bundle install   # Ensures you have all RubyGems needed
     > cd test
-    > rake # Run all CMock self tests
+    > rake             # Run all CMock self tests
+
+Before working on this project, you're going to want to read our guidelines on 
+[contributing](docs/CONTRIBUTING.md). 
 
 API Documentation
 =================
 
 * Not sure what you're doing?
 	* [View docs/CMock_Summary.md](docs/CMock_Summary.md)
-* Interested in our MIT-style license?
+* Interested in our MIT license?
 	* [View docs/license.txt](LICENSE.txt)
 * Are there examples?
 	* They are all in [/examples](examples/)

cmock.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), 'lib'))
+require "lib/cmock_version"
+require 'date'
+
+Gem::Specification.new do |s|
+  s.name        = "cmock"
+  s.version     = CMockVersion::GEM
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Mark VanderVoord", "Michael Karlesky", "Greg Williams"]
+  s.email       = ["[email protected]", "[email protected]", "[email protected]"]
+  s.homepage    = "http://throwtheswitch.org/cmock"
+  s.summary     = "CMock is a mocking framework for C unit testing. It's a member of the ThrowTheSwitch.org family of tools."
+  s.description = <<-DESC
+CMock is a mocking framework for C unit testing. It accepts header files and generates mocks automagically for you.
+  DESC
+  s.licenses    = ['MIT']
+
+  s.metadata = {
+    "homepage_uri"      => s.homepage,
+    "bug_tracker_uri"   => "https://github.com/ThrowTheSwitch/CMock/issues",
+    "documentation_uri" => "https://github.com/ThrowTheSwitch/CMock/blob/master/docs/CMock_Summary.md",
+    "mailing_list_uri"  => "https://groups.google.com/forum/#!categories/throwtheswitch/cmock",
+    "source_code_uri"   => "https://github.com/ThrowTheSwitch/CMock"
+  }
+  
+  s.required_ruby_version = ">= 3.0.0"
+
+  s.files      += Dir['**/*']
+  s.test_files  = Dir['test/**/*']
+  s.executables = ['lib/cmock.rb']
+
+  s.require_paths = ["lib"]
+end

config/production_environment.rb

@@ -1,12 +1,13 @@
-# ==========================================
-#   CMock Project - Automatic Mock Generation for C
-#   Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams
-#   [Released under MIT License. Please refer to license.txt for details]
-# ==========================================
+# =========================================================================
+#   CMock - Automatic Mock Generation for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2007-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
 
 # Setup our load path:
 [
   'lib'
 ].each do |dir|
-  $:.unshift(File.join(__dir__ + '/../', dir))
+  $:.unshift(File.join("#{__dir__}//..//", dir))
 end

config/test_environment.rb

@@ -1,8 +1,9 @@
-# ==========================================
-#   CMock Project - Automatic Mock Generation for C
-#   Copyright (c) 2007 Mike Karlesky, Mark VanderVoord, Greg Williams
-#   [Released under MIT License. Please refer to license.txt for details]
-# ==========================================
+# =========================================================================
+#   CMock - Automatic Mock Generation for C
+#   ThrowTheSwitch.org
+#   Copyright (c) 2007-25 Mike Karlesky, Mark VanderVoord, & Greg Williams
+#   SPDX-License-Identifier: MIT
+# =========================================================================
 
 # Setup our load path:
 [
@@ -12,5 +13,5 @@
   './vendor/unity/auto/',
   './test/system/'
 ].each do |dir|
-  $:.unshift(File.join(File.expand_path(File.dirname(__FILE__) + '/../'), dir))
+  $:.unshift(File.join(File.expand_path("#{File.dirname(__FILE__)}//..//"), dir))
 end

docs/CMockChangeLog.md

@@ -0,0 +1,166 @@
+# CMock - Change Log
+
+## A Note
+
+This document captures significant features and fixes to the CMock project core source files 
+and scripts. More detail can be found in the history on Github. 
+
+This project is now tracking changes in more detail. Previous releases get less detailed as
+we move back in histroy. 
+
+Prior to 2012, the project was hosted on SourceForge.net
+Prior to 2008, the project was an internal project and not released to the public.
+
+## Log
+
+### CMock 2.6.0 (January 2025)
+
+New Features:
+
+  - Reintroduced option to run CMock without setjmp (slightly limited)
+  - Significant speed improvements to parsing
+
+Significant Bugfixes:
+
+  - Make return-thru-pointer calls const
+  - Fix handling of static inlines
+  - Fix some situations where parenthetical statements were misinterpreted as functions
+  - Fix error in skeleton creation
+  - Improvements towards making generated code fully C-compliant and warning free
+
+Other:
+
+  - Improve error message wording where possible
+  - Improve documentation
+  - Updated to Ruby 3.0 - 3.3
+  - Reintroduce matrix testing across multiple Ruby versions
+
+### CMock 2.5.3 (January 2021)
+
+New Features:
+
+  - Support mocks in sub-folders
+  - Improved handling of static and inline functions
+  - Stateless Ignore plugin added
+
+Significant Bugfixes:
+
+  - Allow setting values to empty at command prompt
+  - Improvements towards making generated code fully C-compliant and warning free
+
+Other:
+  
+  - Really basic mocking of cpp files (like C files with extern C)
+
+### CMock 2.5.2 (May 2020)
+
+Significant Bugfixes:
+
+  - Fix whitespace errors
+  - Fix Stop Ignore
+
+### CMock 2.5.1 (April 2020)
+
+New Features:
+
+  - Add StopIgnore function to Ignore Plugin
+  - Add ability to generate skeleton from a header.
+  - Inline functions now have option to remove and mock (with Ceedling's help)
+
+Significant Bugfixes:
+
+  - Convert internal handling of bools to chars from ints for memory savings
+  - Convert CMOCK_MEM_INDEX_TYPE default type to size_t 
+  - Switch to old-school comments for supporting old C compilers
+  - Significant improvements to handling array length expressions
+  - Significant improvements to our "C parser"
+  - Added brace-pair counting to improve parsing
+  - Fixed error when `:unity_helper_path` is relative
+
+Other:
+
+ - Improve documentation
+ - Optimize speed for pass case, particularly in `_verify()` functions
+ - Increased depth of unit and system tests
+
+### CMock 2.5.0 (October 2019)
+
+New Features:
+
+  - New memory bounds checking.
+  - New memory alignment algorithm.
+  - Add `ExpectAnyArgs` plugin
+  - Divided `CVallback` from `Stub` functionality so we can do both.
+  - Improved wording of failure messages.
+  - Added `:treat_as_array` configuration option
+
+Significant Bugfixes:
+
+  - Fixed bug where `CMock_Guts_MemBytesUsed()` didn't always return `0` before usage
+  - Fixed bug which sometimes got `CMOCK_MEM_ALIGN` wrong
+  - Fixed bug where `ExpectAnyArgs` was generated for functions without args.
+  - Better handling of function pointers
+
+Other:
+
+  - `void*` now tested as bytewise array comparison.
+  - Documentation fixes, particularly to examples.
+  - Added `resetTest` to documentation
+  - New handling of messaging to greatly reduce memory footprint
+
+### CMock 2.4.6 (November 2017)
+
+Significant Bugfixes:
+
+  - Fixed critical bug when running dynamic memory.
+
+### CMock 2.4.5 (September 2017)
+
+New Features:
+
+  - Simple threading of mocks introduced.
+
+Significant Bugfixes:
+  
+  - Improvements to handling pointer const arguments.
+  - Treat `char*` separately from an array of bytes.
+  - Fixed handling of string arguments.
+  - Preserve `const` in all arguments.
+  - Fixed race condition when `require`ing plugins
+
+Other:
+
+  - Expand docs on `strict_mock_calling`
+
+### CMock 2.4.4 (April 2017)
+
+New Features:
+
+  - Add `INCLUDE_PATH` option for specifying source
+
+Significant Bugfixes:
+
+  - Parsing improvements related to braces, brackets, and parenthesis
+  - `ReturnThruPtr` checks destination not null before copying data.
+  - Stub overrides Ignore
+  - Improvements to guessing memory alignment based on datatypes
+
+Other:
+
+  - Reorganize testing into subdirectory to not clutter for new users
+  - Docs switching to markdown from pdf
+
+### CMock 2.4.3 (October 2016)
+
+New Features:
+
+  - Support multiple helper header files.
+  - Add ability to use `weak` symbols if compiler supports it
+  - Add mock suffix option in addition to mock prefix.
+
+Significant Bugfixes:
+
+  - Improved UNICODE support
+
+
+

docs/CMockKnownIssues.md

@@ -0,0 +1,13 @@
+# CMock - Known Issues
+
+## A Note
+
+This project will do its best to keep track of significant bugs that might effect your usage of this
+project and its supporting scripts. A more detailed and up-to-date list for cutting edge CMock can
+be found on our Github repository.
+
+## Issues
+
+  - Able to parse most C header files without preprocessor needs, but when handling headers with significant preprocessor usage (#ifdefs, etc), it can get confused
+  - Multi-dimensional arrays currently simplified to single dimensional arrays of the full size
+  - Incomplete support for VarArgs