mocha 0.5.6 → 3.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 44d35f56fc0395b34a514c91a44a914ac782a500a4426db9e7c00aea8ae66c96
+  data.tar.gz: 2be9168ce81c71de23b3ba15593184274098938bdad1108226231c3a70fdb172
+SHA512:
+  metadata.gz: d2fe09345542097c73fdc4594ed43d6d737b5927dd29672b79e1d94fce9550ab580c38d0855524eb193eed9b7969078e6e2ad62f11a78156e48288d27b907c78
+  data.tar.gz: f17bfeb0fdc2ba83a65e69f515094c00da41b25de979b5bd75767b235fd9cc0e086673a7807d0b895474792a4760e81283b3bc0ba980e67899870f84c9dd638c

data/.github/FUNDING.yml

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

data/.rubocop.yml

@@ -0,0 +1,92 @@
+plugins:
+  - rubocop-rake
+
+inherit_from: .rubocop_todo.yml
+
+inherit_mode:
+  merge:
+    - Include
+
+AllCops:
+  TargetRubyVersion: 2.2
+
+  Include:
+    - "**/Gemfile.*"
+
+  Exclude:
+    - "**/Gemfile*.lock"
+
+  NewCops: enable
+
+# 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
+
+# Kernel#__dir__ has only been available since Ruby v2.0
+Style/ExpandPathArguments:
+  Enabled: false
+
+# 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
+
+# `Module#===` is useful in presence of objects such as mocks
+# that may have a `is_a?` implementation that lies.
+Style/CaseEquality:
+  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
+Layout/LineLength:
+  AllowedPatterns: ['\A\s*#']
+
+# It's not possible to set TargetRubyVersion to Ruby < v2.2
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+# This cop is useful for required environment variables, but not for optional ones
+Style/FetchEnvVar:
+  AllowedVars:
+    - MOCHA_RUN_INTEGRATION_TESTS
+
+Naming/FileName:
+  ExpectMatchingDefinition: true
+  Exclude:
+    - lib/mocha/version.rb
+    - lib/mocha/minitest.rb
+    - lib/mocha/test_unit.rb
+    - lib/mocha/ruby_version.rb
+    - lib/mocha/macos_version.rb
+    - test/test_helper.rb
+
+Metrics/BlockLength:
+  Exclude:
+    - "Rakefile"

data/.rubocop_todo.yml

@@ -0,0 +1,39 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-01-03 14:37:32 UTC using RuboCop version 1.69.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: 34
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 27
+
+# Offense count: 28
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 381
+
+# Offense count: 2
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+# Offense count: 200
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 27
+
+# Offense count: 3
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/PerceivedComplexity:
+  Max: 10
+
+# Offense count: 68
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 173

data/.yardopts

@@ -0,0 +1,25 @@
+--output-dir docs
+--no-private
+lib/mocha.rb
+lib/mocha/api.rb
+lib/mocha/hooks.rb
+lib/mocha/mock.rb
+lib/mocha/expectation.rb
+lib/mocha/object_methods.rb
+lib/mocha/class_methods.rb
+lib/mocha/parameter_matchers.rb
+lib/mocha/parameter_matchers
+lib/mocha/state_machine.rb
+lib/mocha/sequence.rb
+lib/mocha/configuration.rb
+lib/mocha/expectation_error_factory.rb
+lib/mocha/expectation_error.rb
+lib/mocha/stubbing_error.rb
+lib/mocha/unexpected_invocation.rb
+lib/mocha/integration.rb
+lib/mocha/integration/test_unit/adapter.rb
+lib/mocha/integration/minitest/adapter.rb
+-
+RELEASE.md
+COPYING.md
+MIT-LICENSE.md

data/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+* Pull requests are welcomed.
+* Fork the repository.
+* Make your changes in a branch.
+* 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/COPYING.md

@@ -0,0 +1,3 @@
+Copyright James Mead 2006
+
+You may use, copy and redistribute this library under the same terms as [Ruby itself](https://www.ruby-lang.org/en/about/license.txt) or under the [MIT license](https://mit-license.org/).

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'benchmark'
+  gem 'introspection', '~> 0.0.1'
+  gem 'minitest'
+  gem 'rake'
+
+  if ENV['MOCHA_GENERATE_DOCS']
+    gem 'irb'
+    gem 'rdoc'
+    gem 'redcarpet'
+    gem 'yard'
+  end
+end

data/{MIT-LICENSE → MIT-LICENSE.md}

@@ -1,7 +1,7 @@
-Copyright (c) 2006 Revieworld Ltd.
+Copyright (c) 2006 James Mead
 
 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 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.
+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/README.md

@@ -0,0 +1,361 @@
+## Mocha [![CircleCI status of freerange/mocha](https://circleci.com/gh/freerange/mocha.svg?style=shield)](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](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
+
+Install the latest version of the gem with the following command...
+
+    $ gem install mocha
+
+Note: If you are intending to use Mocha with Test::Unit or Minitest, you should only setup Mocha *after* loading the relevant test library...
+
+##### Test::Unit
+
+```ruby
+require 'rubygems'
+gem 'mocha'
+require 'test/unit'
+require 'mocha/test_unit'
+```
+
+##### Minitest
+
+```ruby
+require 'rubygems'
+gem 'mocha'
+require 'minitest/autorun'
+require 'mocha/minitest'
+```
+
+#### Bundler
+
+If you're using Bundler, include Mocha in the `Gemfile` and then setup Mocha later once you know the test library has been loaded...
+
+##### Test::Unit
+
+```ruby
+# Gemfile
+gem 'mocha'
+
+# Elsewhere after Bundler has loaded gems e.g. after `require 'bundler/setup'`
+require 'test/unit'
+require 'mocha/test_unit'
+```
+
+##### Minitest
+
+```ruby
+# Gemfile
+gem 'mocha'
+
+# Elsewhere after Bundler has loaded gems e.g. after `require 'bundler/setup'`
+require 'minitest/autorun'
+require 'mocha/minitest'
+```
+
+##### RSpec
+
+RSpec includes a mocha adapter. Just tell RSpec you want to mock with `:mocha`:
+
+```ruby
+# Gemfile in Rails app
+gem 'mocha'
+
+# Within `spec/spec_helper.rb`
+RSpec.configure do |config|
+  config.mock_with :mocha
+end
+```
+
+Note: There is no need to use a require statement to setup Mocha; RSpec does this itself.
+
+##### Cucumber
+
+```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
+```
+
+#### 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/minitest'
+```
+
+##### 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
+
+* Prior to v1.15.0 (when support for Ruby v1.8 was dropped), 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 v1.8. See `test/acceptance/stub_method_defined_on_module_and_aliased_test.rb` for an example of this behaviour.
+
+### Usage
+
+#### Quick Start
+
+```ruby
+require 'test/unit'
+require 'mocha/test_unit'
+
+class MiscExampleTest < Test::Unit::TestCase
+  def test_mocking_a_class_method
+    product = Product.new
+    Product.expects(:find).with(1).returns(product)
+    assert_equal product, Product.find(1)
+  end
+
+  def test_mocking_an_instance_method_on_a_real_object
+    product = Product.new
+    product.expects(:save).returns(true)
+    assert product.save
+  end
+
+  def test_stubbing_instance_methods_on_real_objects
+    prices = [stub(pence: 1000), stub(pence: 2000)]
+    product = Product.new
+    product.stubs(:prices).returns(prices)
+    assert_equal [1000, 2000], product.prices.collect {|p| p.pence}
+  end
+
+  def test_stubbing_an_instance_method_on_all_instances_of_a_class
+    Product.any_instance.stubs(:name).returns('stubbed_name')
+    product = Product.new
+    assert_equal 'stubbed_name', product.name
+  end
+
+  def test_traditional_mocking
+    object = mock('object')
+    object.expects(:expected_method).with(:p1, :p2).returns(:result)
+    assert_equal :result, object.expected_method(:p1, :p2)
+  end
+
+  def test_shortcuts
+    object = stub(method1: :result1, method2: :result2)
+    assert_equal :result1, object.method1
+    assert_equal :result2, object.method2
+  end
+end
+```
+
+#### Mock Objects
+
+```ruby
+class Enterprise
+  def initialize(dilithium)
+    @dilithium = dilithium
+  end
+
+  def go(warp_factor)
+    warp_factor.times { @dilithium.nuke(:anti_matter) }
+  end
+end
+
+require 'test/unit'
+require 'mocha/test_unit'
+
+class EnterpriseTest < Test::Unit::TestCase
+  def test_should_boldly_go
+    dilithium = mock()
+    dilithium.expects(:nuke).with(:anti_matter).at_least_once  # auto-verified at end of test
+    enterprise = Enterprise.new(dilithium)
+    enterprise.go(2)
+  end
+end
+```
+
+#### Partial Mocking
+
+```ruby
+class Order
+  attr_accessor :shipped_on
+
+  def total_cost
+    line_items.inject(0) { |total, line_item| total + line_item.price } + shipping_cost
+  end
+
+  def total_weight
+    line_items.inject(0) { |total, line_item| total + line_item.weight }
+  end
+
+  def shipping_cost
+    total_weight * 5 + 10
+  end
+
+  class << self
+    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
+
+    def unshipped_value
+      find_all.inject(0) { |total, order| order.shipped_on ? total : total + order.total_cost }
+    end
+  end
+end
+
+require 'test/unit'
+require 'mocha/test_unit'
+
+class OrderTest < Test::Unit::TestCase
+  # illustrates stubbing instance method
+  def test_should_calculate_shipping_cost_based_on_total_weight
+    order = Order.new
+    order.stubs(:total_weight).returns(10)
+    assert_equal 60, order.shipping_cost
+  end
+
+  # illustrates stubbing class method
+  def test_should_count_number_of_orders_shipped_after_specified_date
+    now = Time.now; week_in_secs = 7 * 24 * 60 * 60
+    order_1 = Order.new; order_1.shipped_on = now - 1 * week_in_secs
+    order_2 = Order.new; order_2.shipped_on = now - 3 * week_in_secs
+    Order.stubs(:find_all).returns([order_1, order_2])
+    assert_equal 1, Order.number_shipped_since(now - 2 * week_in_secs)
+  end
+
+  # illustrates stubbing instance method for all instances of a class
+  def test_should_calculate_value_of_unshipped_orders
+    Order.stubs(:find_all).returns([Order.new, Order.new, Order.new])
+    Order.any_instance.stubs(:shipped_on).returns(nil)
+    Order.any_instance.stubs(:total_cost).returns(10)
+    assert_equal 30, Order.unshipped_value
+  end
+end
+```
+
+### Thread safety
+
+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
+
+Stubs and expectations are basically the same thing. A stub is just an expectation of zero or more invocations. The `Expectation#stubs` method is syntactic sugar to make the intent of the test more explicit.
+
+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. If the expectation that matches the invocation has a cardinality of "never", then an unexpected invocation error is reported.
+
+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.
+
+### Debugging
+
+Mocha provides some extra output to help with debugging when the standard Ruby debug option (`-d`) is set.
+
+### 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](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/)
+* [An Introduction To Mock Objects In Ruby](http://jamesmead.org/talks/2007-07-09-introduction-to-mock-objects-in-ruby-at-lrug/)
+* [Mocks Aren't Stubs](http://martinfowler.com/articles/mocksArentStubs.html)
+* [Growing Object-Oriented Software Guided By Tests](http://www.growing-object-oriented-software.com/)
+* [Mock Roles Not Objects](http://www.jmock.org/oopsla2004.pdf)
+* [jMock](http://www.jmock.org/)
+
+### Contributors
+
+See this [list of contributors](https://github.com/freerange/mocha/graphs/contributors).
+
+### 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
+
+* Generate documentation:
+
+```bash
+$ MOCHA_GENERATE_DOCS=true bundle install
+
+$ MOCHA_GENERATE_DOCS=true bundle exec rake 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
+$ bundle exec 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
+
+Mocha was initially harvested from projects at [Reevoo](http://www.reevoo.com/). It's syntax is heavily based on that of [jMock](http://www.jmock.org).
+
+### License
+
+&copy; Copyright James Mead 2006
+
+You may use, copy and redistribute this library under the same terms as [Ruby itself](https://www.ruby-lang.org/en/about/license.txt) or under the [MIT license](https://mit-license.org/).