flexmock 1.3.3 → 2.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8fc2db94cd104d7f780ee838c07b73a09649317
-  data.tar.gz: 18c344caf1b37f52f0226b563e8c18fe2832d46f
+  metadata.gz: 4ade2170748d406102f5fb790cf747729faef19b
+  data.tar.gz: af92a2e818928d228f710c3e05b9d76267603c76
 SHA512:
-  metadata.gz: aaa6e22a1f390003d539e753d1ebbed9f20e37ce2fb825f39cd1032811f3084236ee4bb591e52644a1eb0bf09d173bda64f9169e619f75a4bf033c70279c51e3
-  data.tar.gz: f106c0edb36b898a2907a7e5930b078a6d36ee7389081ce3fc9a192aad29ebe785ff8d848953ba84955449c37405bd75396cd662db375134fe364f8c0e2a5370
+  metadata.gz: efd2242d6a87e8c35a7656f1612e00b8d653875ba10a9d47c4353ff8157b05ace064fa98ec78cafb35ec6d1f30ccf28167a192d06a6fd75556de6bdcce3429ab
+  data.tar.gz: 7fdb2eafeca01e7f5a3e88234d75f7274846ce2b4d1d79c063990713cb4bff1c24b825ba408324377bf0de558541a25e2ebcc8616d0ea39f0b5e6d7f555c3f5e

data/.autotest

@@ -0,0 +1,3 @@
+Autotest.add_hook :run do |at|
+  at.exceptions = /^(?:.\/)?(?:db|doc|log|public|script|sphinx|tmp|filestore|vendor\/rails)|\.svn|test_unit_integration|(?:.*_flymake\.rb$|\.log$)/
+end

data/.gitignore

@@ -0,0 +1,14 @@
+*~
+*.bak
+pkg
+.DS_Store
+coverage
+html
+TAGS
+doc/examples/*.rdoc
+Gemfile.lock
+vendor/
+.*.sw?
+.yardoc/
+.bundle/
+html/

data/.togglerc

@@ -0,0 +1,7 @@
+(add-to-list
+ 'toggle-mapping-styles
+ '(flexmock
+   ("test/\\1_test.rb" . "lib/flexmock/\\1.rb")
+   ("\\1_test.rb"      . "\\1.rb")))
+
+(buffer-toggle-style 'flexmock)

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.6
+  - 2.2.2

data/.yardopts

@@ -0,0 +1,2 @@
+--output-dir html
+--readme doc/index.rdoc

data/CHANGES

@@ -1,5 +1,16 @@
 = Changes for FlexMock
 
+== Version 2.0.0
+
+* bump to 2.0 to mark the change of maintainership. I hope I won't disappoint.
+* require 'flexmock' no longer pulls test_unit_integration. Require the latter
+  explicitely
+* dropped support for pre-2.0 Rubies
+* added explicit minitest support. This makes the minitest integration much
+  nicer to work with (in particular, the flexmock_teardown is now executed "just
+  at the right place"), and fixes issues with minitest 5
+* partial mocks now supports prepended modules
+
 == Version 1.0.0
 
 * Added spy support.

data/Gemfile

@@ -1,7 +1,4 @@
 source 'http://rubygems.org'
 
-gem 'rake', ">= 0.9.2.2"
+gemspec
 
-group 'test' do
-  gem 'rspec', ">= 2.0"
-end

data/README.md

@@ -1,17 +1,20 @@
 # Flex Mock -- Making Mocking Easy
 
+[![Build Status](https://travis-ci.org/doudou/flexmock.svg?branch=master)](https://travis-ci.org/doudou/flexmock)
+[![Gem Version](https://badge.fury.io/rb/flexmock.svg)](http://badge.fury.io/rb/flexmock)
+
 FlexMock is a simple, but flexible, mock object library for Ruby unit
 testing.
 
-Version :: 1.3.1
+Version :: 2.0
 
 # Links
 
-* **Documents** -- http://flexmock.rubyforge.org
+* **Documents** -- http://rubydoc.info/gems/flemxock
 * **RubyGems**   -- Install with: `gem install flexmock`
-* **Source** -- https://github.com/jimweirich/flexmock
-* **Bug Reports / Issue Tracking** -- https://github.com/jimweirich/flexmock/issues
-* **Continuous Integration** -- http://travis-ci.org/#!/jimweirich/flexmock
+* **Source** -- https://github.com/doudou/flexmock
+* **Bug Reports / Issue Tracking** -- https://github.com/doudou/flexmock/issues
+* **Continuous Integration** -- http://travis-ci.org/#!/doudou/flexmock
 
 ## Installation
 
@@ -64,6 +67,33 @@ You can find an extended example of FlexMock in
 [Google Example](http://flexmock.rubyforge.org/files/doc/GoogleExample_rdoc.html
 "Example").
 
+## Minitest Integration
+
+FlexMock integrates nicely with Minitest. Just require the
+'flexmock/minitest' file at the top of your test file. The
+`flexmock` method will be available for mock creation, and
+any created mocks will be automatically validated and closed at the
+end of the individual test. It works with both tests unit-style
+(subclasses of Minitest::Test) and spec-style.
+
+Your test case will look something like this:
+
+```ruby
+  require 'flexmock/minitest'
+
+  class TestDog < Minitest::Test
+    def test_dog_wags
+      tail_mock = flexmock(:wag => :happy)
+      assert_equal :happy, tail_mock.wag
+    end
+  end
+```
+
+**NOTE:** If you don't want to automatically extend every Minitest::Test
+with the flexmock methods and overhead, then require the 'flexmock'
+file and explicitly include the FlexMock::Minitest module in each test
+case class where you wish to use mock objects.
+
 ## Test::Unit Integration
 
 FlexMock integrates nicely with Test::Unit. Just require the
@@ -1168,16 +1198,14 @@ Refer to the following documents for examples of using FlexMock:
 ## License
 
 Copyright 2003-2013 by Jim Weirich (jim.weirich@gmail.com).
-All rights reserved.
+Copyright 2014- by Sylvain Joyeux (sylvain.joyeux@m4x.org)
 
-Permission is granted for use, copying, modification, distribution,
-and distribution of modified versions of this work as long as the
-above copyright notice is included.
+Licensed under [the MIT license](http://opensource.org/licenses/MIT)
 
 # Other stuff
 
-* **Author** -- Jim Weirich <jim.weirich@gmail.com>
-* **Requires** -- Ruby 1.9.2 or later (also works with Ruby 1.8.7)
+* **Author** -- Jim Weirich <jim.weirich@gmail.com> and Sylvain Joyeux <sylvain.joyeux@m4x.org>
+* **Requires** -- Ruby 2.0 or later
 
 ## See Also
 

data/Rakefile

@@ -1,221 +1,10 @@
-# Rakefile for flexmock        -*- ruby -*-
+require "bundler/gem_tasks"
+require "rake/testtask"
 
-#---
-# Copyright 2003, 2004, 2005, 2006, 2007 by Jim Weirich (jim@weirichhouse.org).
-# All rights reserved.
-
-# Permission is granted for use, copying, modification, distribution,
-# and distribution of modified versions of this work as long as the
-# above copyright notice is included.
-#+++
-task :noop
-require 'rubygems'
-require 'rake/clean'
-require 'rake/testtask'
-require 'rake/contrib/rubyforgepublisher'
-
-require 'rubygems/package_task'
-
-CLEAN.include('*.tmp')
-CLOBBER.include("html", 'pkg')
-
-load './lib/flexmock/version.rb'
-
-PKG_VERSION = FlexMock::VERSION
-
-EXAMPLE_RB = FileList['doc/examples/*.rb']
-EXAMPLE_DOC = EXAMPLE_RB.ext('rdoc')
-
-CLOBBER.include(EXAMPLE_DOC)
-CLEAN.include('pkg/flexmock-*').exclude("pkg/*.gem")
-
-PKG_FILES = FileList[
-  '[A-Z]*',
-  'lib/**/*.rb',
-  'test/**/*.rb',
-  '*.blurb',
-  'install.rb'
-]
-
-RDOC_FILES = FileList[
-  'doc/index.rdoc',
-  'CHANGES',
-  'lib/**/*.rb',
-  'doc/**/*.rdoc',
-] + EXAMPLE_DOC
-
-task :default => [:test_all, :rspec, :testunit]
-task :test_all => [:test]
-task :test_units => [:test]
-task :ta => [:test_all]
-
-# Test Targets -------------------------------------------------------
-
-Rake::TestTask.new do |t|
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
   t.test_files = FileList['test/*_test.rb']
-  t.libs << "."
-  t.verbose = false
-  t.warning = true
 end
 
-module Configuration
-  def self.minitest?
-    require 'minitest/autorun'
-    return true
-  rescue Exception
-    return false
-  end
-end
-
-task :testunit do
-  files = FileList['test/test_unit_integration/*_test.rb']
-  if ! Configuration.minitest?
-    files = files.reject { |fn| fn =~ /minitest/ }
-  end
-  files.each do |file|
-    sh "ruby -Ilib:. #{file}"
-  end
-end
-
-task :rspec do
-  sh "rspec test/rspec_integration"
-end
-
-# RCov Target --------------------------------------------------------
-
-begin
-  require 'rcov/rcovtask'
-
-  Rcov::RcovTask.new do |t|
-    t.libs << "test"
-    t.rcov_opts = ['-xRakefile', '-xrakefile', '-xpublish.rf', '-x/Lib*', '--text-report', '--sort', 'coverage']
-    t.test_files = FileList['test/test*.rb']
-    t.verbose = true
-  end
-rescue LoadError => ex
-end
-
-# RDoc Target --------------------------------------------------------
-
-task :rdoc => ["html/index.html", :fixcss]
-
-file "html/index.html" => ["Rakefile"] + RDOC_FILES do
-  Bundler.with_clean_env do
-    sh "rdoc -o html --title FlexMock --line-numbers -m doc/index.rdoc #{RDOC_FILES}"
-  end
-end
-
-EXAMPLE_RB.zip(EXAMPLE_DOC).each do |source, target|
-  file target => source do
-    open(source, "r") do |ins|
-      open(target, "w") do |outs|
-        outs.puts "= FlexMock Examples"
-        ins.each do |line|
-          outs.puts "    #{line}"
-        end
-      end
-    end
-  end
-end
-
-file "README.md" => ["Rakefile", "lib/flexmock/version.rb"] do
-  ruby %{-i.bak -pe '$_.sub!(/^Version: *((\\d+|beta|rc)\\.)+\\d+ *$/i, "Version :: #{PKG_VERSION}")' README.md} # "
-end
-
-desc "Fix the Darkfish CSS so that paragraphs in lists have a bit of spacing"
-task :fixcss do
-  open("html/rdoc.css") do |ins|
-    open("html/rdoc.new", "w") do |outs|
-      count = 0
-      ins.each do |line|
-        if line =~ /^ *margin: +0;$/
-          count += 1
-          if count == 3
-            line = "  margin: 0.5em 0;"
-          end
-        end
-        outs.puts line
-      end
-    end
-  end
-  rm_f "html/rdoc.css"
-  mv "html/rdoc.new", "html/rdoc.css"
-end
-
-# Package Task -------------------------------------------------------
-
-if ! defined?(Gem)
-  puts "Package Target requires RubyGEMs"
-else
-  spec = Gem::Specification.new do |s|
-
-    #### Basic information.
-
-    s.name = 'flexmock'
-    s.version = PKG_VERSION
-    s.summary = "Simple and Flexible Mock Objects for Testing"
-    s.description = %{
-      FlexMock is a extremely simple mock object class compatible
-      with the Test::Unit framework.  Although the FlexMock's
-      interface is simple, it is very flexible.
-    }				# '
-
-    #### Dependencies and requirements.
-
-    #s.add_dependency('log4r', '> 1.0.4')
-    #s.requirements << ""
-
-    #### Which files are to be included in this gem?  Everything!  (Except CVS directories.)
-
-    s.files = PKG_FILES.to_a
-
-    #### C code extensions.
-
-    #s.extensions << "ext/rmagic/extconf.rb"
-
-    #### Load-time details: library and application (you will need one or both).
-
-    s.require_path = 'lib'                         # Use these for libraries.
-
-    #### Documentation and testing.
-
-    s.has_rdoc = true
-    s.extra_rdoc_files = RDOC_FILES.reject { |fn| fn =~ /\.rb$/ }.to_a
-    s.rdoc_options <<
-      '--title' <<  'FlexMock' <<
-      '--main' << 'README.rdoc' <<
-      '--line-numbers'
-
-    #### Author and project details.
-
-    s.author = "Jim Weirich"
-    s.email = "jim.weirich@gmail.com"
-    s.homepage = "https://github.com/jimweirich/flexmock"
-  end
-
-  Gem::PackageTask.new(spec) do |pkg|
-    pkg.need_zip = true
-    pkg.need_tar = false
-  end
-end
-
-require 'rake/contrib/publisher'
-require 'rake/contrib/sshpublisher'
-
-publisher = Rake::CompositePublisher.new
-publisher.add(Rake::RubyForgePublisher.new('flexmock', 'jimweirich'))
-
-desc "Publish the documentation on public websites"
-task :publish => [:rdoc] do
-  publisher.upload
-end
-
-task :specs do
-  specs = FileList['test/spec_*.rb']
-  ENV['RUBYLIB'] = "lib:test:#{ENV['RUBYLIB']}"
-  sh %{rspec #{specs}}
-end
-
-task :tag do
-  sh "git tag 'flexmock-#{PKG_VERSION}'"
-end
+task :default => :test

data/doc/examples/rspec_examples_spec.rb

@@ -0,0 +1,244 @@
+RSpec.configure do |config|
+  config.mock_with :flexmock
+end
+
+describe "Simple Spec" do
+
+  # Simple stubbing of some methods
+
+  it "stubs a couple of methods" do
+    m = flexmock(:pi => 3.1416, :e => 2.71)
+    m.pi.should == 3.1416
+    m.e.should == 2.71
+  end
+end
+
+
+describe "Returning Undefined" do
+
+  # Create a mock object that returns an undefined object for method calls
+
+  it "returns undefined values" do
+    m = flexmock("mock")
+    m.should_receive(:divide_by).with(0).
+      and_return_undefined
+
+    m.divide_by(0).should == FlexMock.undefined
+  end
+end
+
+describe "Multiple Queries and Single Updates" do
+
+  # Expect multiple queries and a single update
+
+  # Multiple calls to the query method will be allows, and calls may
+  # have any argument list. Each call to query will return the three
+  # element array [1, 2, 3]. The call to update must have a specific
+  # argument of 5.
+
+  it "queries the db" do
+    db = flexmock('db')
+    db.should_receive(:query).and_return([1,2,3])
+    db.should_receive(:update).with(5).and_return(nil).once
+
+    # Test Code
+
+    db.query
+    db.update(5)
+  end
+end
+
+describe "Ordered Mocks" do
+
+  # Expect all queries before any updates
+
+  # All the query message must occur before any of the update
+  # messages.
+
+  it "queries and updates the database" do
+    db = flexmock('db')
+    db.should_receive(:query).and_return([1,2,3]).ordered
+    db.should_receive(:update).and_return(nil).ordered
+
+    # test code here
+
+    db.query
+    db.update
+  end
+end
+
+describe "Ordered Mocks" do
+
+  # Expect several queries with different parameters
+
+  # The queries should happen after startup but before finish. The
+  # queries themselves may happen in any order (because they are in
+  # the same order group). The first two queries should happen exactly
+  # once, but the third query (which matches any query call with a
+  # four character parameter) may be called multiple times (but at
+  # least once). Startup and finish must also happen exactly once.
+
+  # Also note that we use the <code>with</code> method to match
+  # different argument values to figure out what value to return.
+
+  it "queries the database in a particular order" do
+    db = flexmock('db')
+    db.should_receive(:startup).once.ordered
+    db.should_receive(:query).with("CPWR").and_return(12.3).
+      once.ordered(:queries)
+    db.should_receive(:query).with("MSFT").and_return(10.0).
+      once.ordered(:queries)
+    db.should_receive(:query).with(/^....$/).and_return(3.3).
+      at_least.once.ordered(:queries)
+    db.should_receive(:finish).once.ordered
+
+    # Test Code
+
+    db.startup
+    db.query("MSFT")
+    db.query("XYZY")
+    db.query("CPWR")
+    db.finish
+  end
+end
+
+describe "Ordered Mocks" do
+
+  # Same as above, but using the Record Mode interface
+
+  # The record mode interface offers much the same features as the
+  # <code>should_receive</code> interface introduced so far, but it
+  # allows the messages to be sent directly to a recording object
+  # rather than be specified indirectly using a symbol.
+
+
+  it "records the queries for replay" do
+    db = flexmock('db')
+    db.should_expect do |rec|
+      rec.startup.once.ordered
+      rec.query("CPWR") { 12.3 }.once.ordered(:queries)
+      rec.query("MSFT") { 10.0 }.once.ordered(:queries)
+      rec.query(/^....$/) { 3.3 }.at_least.once.ordered(:queries)
+      rec.finish.once.ordered
+    end
+
+    # Test Code
+
+    db.startup
+    db.query("MSFT")
+    db.query("XYZY")
+    db.query("CPWR")
+    db.finish
+  end
+end
+
+describe "Record Mode" do
+
+  # Using Record Mode to record a known, good algorithm for testing
+
+  # Record mode is nice when you have a known, good algorithm that can
+  # use a recording mock object to record the steps. Then you compare
+  # the execution of a new algorithm to behavior of the old using the
+  # recorded expectations in the mock. For this you probably want to
+  # put the recorder in _strict_ mode so that the recorded
+  # expectations use exact matching on argument lists, and strict
+  # ordering of the method calls.
+
+  # <b>Note:</b> This is most useful when there are no queries on the
+  # mock objects, because the query responses cannot be programmed
+  # into the recorder object.
+
+  it "compares a know algorithm with a new algorithm" do
+    builder = flexmock('builder')
+    builder.should_expect do |rec|
+      rec.should_be_strict
+      known_good_way_to_build_xml(rec)  # record the messages
+    end
+    new_way_to_build_xml(builder)       # compare to new way
+  end
+
+  def known_good_way_to_build_xml(builder)
+    builder.person
+  end
+
+  def new_way_to_build_xml(builder)
+    builder.person
+  end
+
+end
+
+describe "Multiple Return Values" do
+
+  # Expect multiple calls, returning a different value each time
+
+  # Sometimes you need to return different values for each call to a
+  # mocked method. This example shifts values out of a list for this
+  # effect.
+
+  it "returns multiple values" do
+    file = flexmock('file')
+    file.should_receive(:gets).with_no_args.
+      and_return("line 1\n", "line 2\n")
+
+    # test code here
+
+    file.gets                   # returns "line 1"
+    file.gets                   # returns "line 2"
+  end
+end
+
+describe "Ignore Unimportant Messages" do
+
+  # Ignore uninteresting messages
+
+  # Generally you need to mock only those methods that return an
+  # interesting value or wish to assert were sent in a particular
+  # manner. Use the <code>should_ignore_missing</code> method to turn
+  # on missing method ignoring.
+
+  it "ignores unimportant messages" do
+    m = flexmock('m')
+    m.should_receive(:an_important_message).and_return(1).once
+    m.should_ignore_missing
+
+    # Test Code
+
+    m.an_important_message
+    m.an_unimportant_message
+  end
+
+  # When <code>should_ignore_missing</code> is enabled, ignored
+  # missing methods will return an undefined object. Any operation on
+  # the undefined object will return the undefined object.
+
+end
+
+
+describe "Partial Mocks" do
+
+  # Mock just one method on an existing object
+
+  # The Portfolio class calculate the value of a set of stocks by
+  # talking to a quote service via a web service. Since we don't want
+  # to use a real web service in our unit tests, we will mock the
+  # quote service.
+
+  it "returns the portfolio value" do
+    flexmock(QuoteService).new_instances do |m|
+      m.should_receive(:quote).and_return(100)
+    end
+    port = Portfolio.new
+    value = port.value     # Portfolio calls QuoteService.quote
+    value.should == 100
+  end
+
+  class QuoteService
+  end
+
+  class Portfolio
+    def value
+      qs = QuoteService.new
+      qs.quote
+    end
+  end
+end