mocha 1.1.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fee7267881fbeec218036679d2d7002f5a2f0f30
-  data.tar.gz: 8801ccb9858bbafe1a422702ca1d91e19d31c777
+SHA256:
+  metadata.gz: 4f349dc7259b6d387aaf194adc6c6f93fe39b9b785ce42489e2abf168c58dc84
+  data.tar.gz: '08a9210b39673183198a69a82d368b14af06722cc136a72635638b69a7a9e1b1'
 SHA512:
-  metadata.gz: a1a6ca8a2301842c8ecba0db5df9223232af8076e3d4745763307264c635f68ccb2ff13e8b359dad1d03950341f4fd226cbbda3ef6e22d3bcdea140b776a449e
-  data.tar.gz: 2cc8b79a37943f4039764780c9c602d30d63e083e6bf375937e387ef6e3f08369f8669dc0b55e99216f15aa6672f9a6033dc52a91e08a172f55b0c59d7f7bc6f
+  metadata.gz: 1d77dedb5f4016ab1f2932a18b9d574a0e1de87ab0bc77cf5757920c8ca231a2c5872688a5c1dc8dbd530e81d9e8f1c6feb218c469126685ca822e953c568263
+  data.tar.gz: 6545a73cfed1eb00f94ca06f1cd12606db4377c6e8a5f228a512464e106e129a584d6cedf195602dad45398a2e8346e2abd98c353209e41a4b13da64a9fbc635

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: floehopper

data/.rubocop.yml

@@ -0,0 +1,65 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.2 # closest to required_ruby_version of '>= 2.0'
+
+# Even the reference in the documentation suggests that you should prefer
+# `alias_method` vs `alias`, so I don't understand why that isn't the default.
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Style/Documentation:
+  Enabled: false
+
+# Enumerable#each_with_object only available since Ruby v1.9
+Style/EachWithObject:
+  Enabled: false
+
+# Kernel#__dir__ has only been available since Ruby v2.0
+Style/ExpandPathArguments:
+  Enabled: false
+
+# Kernel#format has only supported named references since Ruby v1.9
+Style/FormatStringToken:
+  EnforcedStyle: unannotated
+
+# ruby19 style has only been supported since Ruby v1.9
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+# I'm not keen on this cop, because it's easy to miss the conditional
+# I think the results are particularly unhelpful when Metrics/LineLength is big
+Style/IfUnlessModifier:
+  Enabled: false
+
+# Lambda literal syntax has only been supported since Ruby v2.0
+Style/Lambda:
+  EnforcedStyle: lambda
+
+# Symbol array literal syntax has only been supported since Ruby v2.0
+Style/SymbolArray:
+  Enabled: false
+
+# I'm not keen on this cop, because it's easy to miss the while/until
+Style/WhileUntilModifier:
+  Enabled: false
+
+# This recently introduced cop seems to have stirred up some controversy
+Style/AccessModifierDeclarations:
+  Enabled: false
+
+# This is useful when using `ExecutionPoint.current` to make tests more robust
+Style/Semicolon:
+  Enabled: false
+
+# Enabling this cop results in an "Infinite loop detected" exception
+Layout/AccessModifierIndentation:
+  Enabled: false
+
+# Allow long comment lines, e.g. YARD documentation
+Metrics/LineLength:
+  IgnoredPatterns: ['\A\s*#']
+
+# It's not possible to set TargetRubyVersion to Ruby < v2.2
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,27 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-11-16 18:15:36 +0000 using RuboCop version 0.58.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 57
+Metrics/AbcSize:
+  Max: 26
+
+# Offense count: 23
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 366
+
+# Offense count: 172
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 31
+
+# Offense count: 545
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 180

data/.yardopts

@@ -1,3 +1,4 @@
+--output-dir docs
 --template-path yard-templates
 --no-private
 lib/mocha/api.rb

data/CONTRIBUTING.md

@@ -1,12 +1,7 @@
 * Pull requests are welcomed.
 * Fork the repository.
 * Make your changes in a branch.
-* Add tests for new behaviour. Modify/remove existing tests for changes to existing behaviour.
-* Run `bin/build-matrix` from the root directory and ensure all the tests pass.
-  * This script depends on `rbenv` being installed.
-  * You must have all the ruby versions listed in `.travis.yml` under the `rvm` key installed (currently 1.8.7, 1.9.3 & 2.0.0).
-  * I use `rbenv-aliases` to alias the patch versions.
-  * Note that the build matrix takes quite a while to run.
-* Send us a pull request from your fork/branch.
-* Wait for your pull request to build on [Travis CI](https://travis-ci.org/freerange/mocha).
-* I will not accept pull requests with failing tests.
+* Add/modify/remove tests as appropriate.
+* Open a pull request based on a branch on your fork.
+* Wait for your pull request build to pass on [Circle CI](https://app.circleci.com/pipelines/github/freerange/mocha).
+* Pull requests with failing tests will not be accepted.

data/Gemfile

@@ -1,3 +1,30 @@
 source 'https://rubygems.org'
 
 gemspec
+
+# rubocop:disable Bundler/DuplicatedGem
+if RUBY_VERSION < '2.2'
+  gem 'rake', '~> 12.3.3'
+else
+  gem 'rake'
+end
+# rubocop:enable Bundler/DuplicatedGem
+
+gem 'introspection', '~> 0.0.1'
+
+# Avoid breaking change in psych v4 (https://bugs.ruby-lang.org/issues/17866)
+if RUBY_VERSION >= '3.1.0'
+  gem 'psych', '< 4'
+end
+
+if RUBY_VERSION >= '2.2.0'
+  # No test libraries in standard library
+  gem 'minitest'
+end
+if RUBY_VERSION >= '2.2.0'
+  gem 'rubocop', '<= 0.58.2'
+end
+if ENV['MOCHA_GENERATE_DOCS']
+  gem 'redcarpet'
+  gem 'yard'
+end

data/README.md

@@ -1,12 +1,15 @@
-## Mocha [![build status](https://secure.travis-ci.org/freerange/mocha.png)](https://secure.travis-ci.org/freerange/mocha) [![Gem Version](https://badge.fury.io/rb/mocha.png)](http://badge.fury.io/rb/mocha)
+## Mocha [![CircleCI status of freerange/mocha](https://circleci.com/gh/freerange/mocha.svg?style=shield&circle-token=bc1f6576c77da43ec58badde9273fa4eb1d7f53a)](https://app.circleci.com/pipelines/github/freerange/mocha) [![Gem Version](https://badge.fury.io/rb/mocha.svg)](http://badge.fury.io/rb/mocha)
 
 ### Description
 
-* A Ruby library for mocking and stubbing.
+* A Ruby library for [mocking](http://xunitpatterns.com/Mock%20Object.html) and [stubbing](http://xunitpatterns.com/Test%20Stub.html) - but deliberately not (yet) [faking](http://xunitpatterns.com/Fake%20Object.html) or [spying](http://xunitpatterns.com/Test%20Spy.html).
 * A unified, simple and readable syntax for both full & partial mocking.
 * Built-in support for MiniTest and Test::Unit.
 * Supported by many other test frameworks.
 
+### Intended Usage
+Mocha is intended to be used in unit tests for the [Mock Object](http://xunitpatterns.com/Mock%20Object.html) or [Test Stub](http://xunitpatterns.com/Test%20Stub.html) types of [Test Double](http://xunitpatterns.com/Test%20Double.html), not the [Fake Object](http://xunitpatterns.com/Fake%20Object.html) or [Test Spy](http://xunitpatterns.com/Test%20Spy.html) types. Although it would be possible to extend Mocha to allow the implementation of fakes and spies, we have chosen to keep it focused on mocks and stubs.
+
 ### Installation
 
 #### Gem
@@ -32,7 +35,7 @@ require 'mocha/test_unit'
 require 'rubygems'
 gem 'mocha'
 require 'minitest/unit'
-require 'mocha/mini_test'
+require 'mocha/minitest'
 ```
 
 #### Bundler
@@ -43,59 +46,88 @@ If you're using Bundler, include Mocha in the `Gemfile` and then setup Mocha lat
 
 ```ruby
 # Gemfile
-gem "mocha"
+gem 'mocha'
 
 # Elsewhere after Bundler has loaded gems e.g. after `require 'bundler/setup'`
-require "test/unit"
-require "mocha/test_unit"
+require 'test/unit'
+require 'mocha/test_unit'
 ```
 
 ##### MiniTest
 
 ```ruby
 # Gemfile
-gem "mocha"
+gem 'mocha'
 
 # Elsewhere after Bundler has loaded gems e.g. after `require 'bundler/setup'`
-require "minitest/unit"
-require "mocha/mini_test"
+require 'minitest/unit'
+require 'mocha/minitest'
 ```
 
-#### Rails
-
-If you're loading Mocha using Bundler within a Rails application, you should setup Mocha manually e.g. at the bottom of your `test_helper.rb`.
+##### RSpec
 
-##### MiniTest
+RSpec includes a mocha adapter. Just tell RSpec you want to mock with `:mocha`:
 
 ```ruby
 # Gemfile in Rails app
 gem 'mocha'
 
-# At bottom of test_helper.rb (or at least after `require 'rails/test_help'`)
-require 'mocha/mini_test'
+# Within `spec/spec_helper.rb`
+RSpec.configure do |config|
+  config.mock_with :mocha
+end
 ```
 
-#### Rails Plugin
+Note: There is no need to use a require statement to setup Mocha; RSpec does this itself.
 
-Install the Rails plugin...
+##### Cucumber
 
-    $ rails plugin install git://github.com/freerange/mocha.git
+```ruby
+# In e.g. features/support/mocha.rb
+require 'mocha/api'
+
+World(Mocha::API)
+
+Around do |scenario, block|
+  begin
+    mocha_setup
+    block.call
+    mocha_verify
+  ensure
+    mocha_teardown
+  end
+end
+```
 
-Note: As of version 0.9.8, the Mocha plugin is not automatically setup at plugin load time. Instead it must be manually setup e.g. at the bottom of your `test_helper.rb`.
+#### Rails
+
+If you're loading Mocha using Bundler within a Rails application, you should setup Mocha manually e.g. at the bottom of your `test_helper.rb`.
 
 ##### MiniTest
 
+Note that since Rails v4 (at least), `ActiveSupport::TestCase` has inherited from `Minitest::Test` or its earlier equivalents. Thus unless you are *explicitly* using Test::Unit, you are likely to be using MiniTest.
+
 ```ruby
+# Gemfile in Rails app
+gem 'mocha'
+
 # At bottom of test_helper.rb (or at least after `require 'rails/test_help'`)
-require 'mocha/mini_test'
+require 'mocha/minitest'
 ```
 
-#### Know Issues
+##### Other Test Framework
 
+Follow the instructions for the relevant test framework in the [Bundler](#bundler) section, but ensure that the relevant Mocha file (`mocha/minitest`, `mocha/test_unit`, or `mocha/api`) is required **after** the test framework has been loaded, e.g. at the bottom of `test_helper.rb` or `spec_helper.rb`, or at least after `rails/test_help` has been required.
+
+#### Known Issues
+
+* In Mocha v1.10.0 an undocumented feature of `API#mock`, `API#stub` & `API#stub_everything` was changed. Previously when these methods were passed a single symbol, they returned a mock object that responded to the method identified by the symbol. Now Passing a single symbol is equivalent to passing a single string, i.e. it now defines the 'name' of the mock object.
+* In Mocha v1.2.0 there is a scenario where stubbing a class method originally defined in a module hangs the Ruby interpreter due to [a bug in Ruby v2.3.1](https://bugs.ruby-lang.org/issues/12832). See #272. This was fixed in Mocha v1.2.1.
+* Since v1.1.0 Mocha has used prepended modules internally for stubbing methods. There is [an obscure Ruby bug](https://bugs.ruby-lang.org/issues/12876) in many (but not all) versions of Ruby between v2.0 & v2.3 which under certain circumstances may cause your Ruby interpreter to hang. See the Ruby bug report for more details. The bug has been fixed in Ruby v2.3.3 & v2.4.0.
+* Stubbing an aliased class method, where the original method is defined in a module that's used to `extend` the class doesn't work in Ruby 1.8.x. See stub_method_defined_on_module_and_aliased_test.rb for an example of this behaviour.
 * 0.13.x versions cause a harmless, but annoying, deprecation warning when used with Rails 3.2.0-3.2.12, 3.1.0-3.1.10 & 3.0.0-3.0.19.
 * 0.11.x versions don't work with Rails 3.2.13 (`TypeError: superclass mismatch for class ExpectationError`). See #115.
 * Versions 0.10.2, 0.10.3 & 0.11.0 of the Mocha gem were broken. Please do not use these versions.
-* Versions 0.9.6 & 0.9.7 of the Mocha Rails plugin were broken. Please do not use these versions.
 
 ### Usage
 
@@ -193,7 +225,7 @@ class Order
     def find_all
       # Database.connection.execute('select * from orders...
     end
-  
+
     def number_shipped_since(date)
       find_all.select { |order| order.shipped_on > date }.length
     end
@@ -236,7 +268,15 @@ end
 
 ### Thread safety
 
-Mocha is currently *not* thread-safe. There are two main reasons for this: (a) in multi-threaded code Mocha exceptions may be raised in a thread other than the one which is running the test and thus a Mocha exception may not be correctly intercepted by Mocha exception handling code; and (b) partial mocking changes the state of objects in the `ObjectSpace` which is shared across all threads in the Ruby process and this access to what is effectively global state is not synchronized.
+Mocha currently *does not* attempt to be thread-safe.
+
+#### Can I test multi-threaded code with Mocha?
+
+The short answer is no. In multi-threaded code Mocha exceptions may be raised in a thread other than the one which is running the test and thus a Mocha exception may not be correctly intercepted by Mocha exception handling code.
+
+#### Can I run my tests across multiple threads?
+
+Maybe, but probably not. Partial mocking changes the state of objects in the `ObjectSpace` which is shared across all threads in the Ruby process and this access to what is effectively global state is not synchronized. So, for example, if two tests are running concurrently and one uses `#any_instance` to modify a class, both tests will see those changes immediately.
 
 ### Expectation matching / invocation order
 
@@ -244,11 +284,33 @@ Stubs and expectations are basically the same thing. A stub is just an expectati
 
 When a method is invoked on a mock object, the mock object searches through its expectations from newest to oldest to find one that matches the invocation. After the invocation, the matching expectation might stop matching further invocations.
 
-See the [documentation](http://gofreerange.com/mocha/docs/Mocha/Mock.html) for `Mocha::Mock` for further details.
+See the [documentation](https://mocha.jamesmead.org/Mocha/Mock.html) for `Mocha::Mock` for further details.
+
+### Configuration
+
+If you want, Mocha can generate a warning or raise an exception when:
+
+* stubbing a method unnecessarily
+* stubbing method on a non-mock object
+* stubbing a non-existent method
+* stubbing a non-public method
+
+See the [documentation](https://mocha.jamesmead.org/Mocha/Configuration.html) for `Mocha::Configuration` for further details.
+
+##### MOCHA_OPTIONS
+`MOCHA_OPTIONS` is an environment variable whose value can be set to a comma-separated list, so that we can specify multiple options e.g. `MOCHA_OPTIONS=debug,use_test_unit_gem`.
+Only the following values are currently recognized and have an effect:
+* `debug`: Enables a debug mode which will output backtraces for each deprecation warning. This is useful for finding where in the test suite the deprecated calls are.
+
+### Semantic versioning
+
+* Every effort is made to comply with [semantic versioning](https://semver.org/).
+* However, this only applies to the behaviour documented in the public API.
+* The documented public API does *not* include the content or format of messsages displayed to the user, e.g. assertion failure messages.
 
 ### Useful Links
 
-* [Official Documentation](http://gofreerange.com/mocha/docs/)
+* [Official Documentation](https://mocha.jamesmead.org)
 * [Source Code](http://github.com/freerange/mocha)
 * [Mailing List](http://groups.google.com/group/mocha-developer)
 * [James Mead's Blog](http://jamesmead.org/blog/)
@@ -262,9 +324,39 @@ See the [documentation](http://gofreerange.com/mocha/docs/Mocha/Mock.html) for `
 
 See this [list of contributors](https://github.com/freerange/mocha/graphs/contributors).
 
-### Translations
+### Releasing a new version
+
+* Update the RELEASE.md file with a summary of changes
+* Bump the version in `lib/mocha/version.rb`
+* Commit & push to GitHub
+* Check CircleCI build is passing - https://app.circleci.com/pipelines/github/freerange/mocha
 
-* [Serbo-Croatian](http://science.webhostinggeeks.com/mocha) by [WHG Team](http://webhostinggeeks.com/). (may be out-of-date)
+* Sign in to Google Analytics - https://analytics.google.com/analytics/web/
+* Find the web property ID for floehopper (625523) > Mocha Documentation (UA-625523-7)
+* Generate documentation:
+
+```bash
+$ MOCHA_GENERATE_DOCS=true bundle install
+
+$ MOCHA_GENERATE_DOCS=true GOOGLE_ANALYTICS_WEB_PROPERTY_ID=UA-625523-7 rake generate_docs
+```
+* Commit documentation & push to GitHub
+* Sign in to rubygems.org and find API key - https://rubygems.org/profile/edit
+
+```bash
+$ curl -u <email-address> -H 'OTP:<one-time-password>' https://rubygems.org/api/v1/api_key.yaml > ~/.gem/credentials; chmod 0600 ~/.gem/credentials
+```
+
+* Release gem to Rubygems:
+
+```bash
+$ rake release
+[runs tests]
+mocha 1.2.0 built to pkg/mocha-1.2.0.gem.
+Tagged v1.2.0.
+Pushed git commits and tags.
+Pushed mocha 1.2.0 to rubygems.org.
+```
 
 ### History