muack 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa29c09257f78580be72e3872fc7d3ef05650e02
-  data.tar.gz: 222e4d730c838c6f76d701c0505b41f7b3476d1e
+  metadata.gz: 2536a6bd8291b8510a652b7e8102c44e4d204586
+  data.tar.gz: b4ad06b8093fa3f241145a5586c07feb37487bc2
 SHA512:
-  metadata.gz: 3e539ea17a87076e48f85d980ad7e2c58afb91c8c627af09f05266a2811ecf2d22efb7adbc49f117c240ffca3c34a5e95229457ab2d82a7e8174a132aa17798e
-  data.tar.gz: 3b2de41a40ab1134c0952ec763423a0a07b0967ce180b076e129ecde0063ddc05853e278cf6b5fb2d0bb36ecb7ac6d612f3471bd3abefa0ff69a8b79fe0660e4
+  metadata.gz: e6c120cfe1b64fe2aa6a842de612c49eb7ec04166a1ac083fdc69f44deb6093fdc5e21a651faed82f76de70b8b25f25a94071311e61ef3a7d8a09700b91019ee
+  data.tar.gz: 692d50e023c30fa16a1906b18233d9c25a32839617c6a5ef951a7056ffced8ed5ed6173b6913e8824605e34aa8e4c26fa6e6832539e1183053f849b5b15b4273

data/.gitignore

@@ -1 +1,2 @@
 /pkg/
+/coverage/

data/.travis.yml

@@ -1,9 +1,11 @@
-before_install: 'git submodule update --init'
-script: 'ruby -r bundler/setup -S rake test'
 
+language: ruby
 rvm:
-  - 1.9
   - 2.0
   - 2.1
+  - 2.2
   - rbx-2
   - jruby
+
+install: 'bundle install --retry=3'
+script: 'ruby -r bundler/setup -S rake test'

data/CHANGES.md

@@ -1,5 +1,9 @@
 # CHANGES
 
+## Muack 1.2.0 -- 2015-03-10
+
+* Now stubs could be overwritten. Input from @mz026
+
 ## Muack 1.1.2 -- 2014-11-07
 
 * Introduced `Muack::API.coat`.

data/Gemfile

@@ -6,6 +6,9 @@ gemspec
 gem 'rake'
 gem 'pork'
 
+gem 'simplecov', :require => false if ENV['COV']
+gem 'coveralls', :require => false if ENV['CI']
+
 platform :rbx do
   gem 'rubysl-singleton' # used in rake
 end

data/README.md

@@ -1,4 +1,4 @@
-# Muack [![Build Status](https://secure.travis-ci.org/godfat/muack.png?branch=master)](http://travis-ci.org/godfat/muack)
+# Muack [![Build Status](https://secure.travis-ci.org/godfat/muack.png?branch=master)](http://travis-ci.org/godfat/muack) [![Coverage Status](https://coveralls.io/repos/godfat/muack/badge.png?branch=master)](https://coveralls.io/r/godfat/muack?branch=master)
 
 by Lin Jen-Shin ([godfat](http://godfat.org))
 
@@ -461,8 +461,8 @@ p obj.name     # 2
 p Muack.verify # true
 ```
 
-Note that this does not apply to stubs because stubs never run out, thus
-making stubs defined later have no effects at all.
+Note that this does not apply to stubs because stubs never run out. Instead,
+the latter stub would overwrite the previous one.
 
 ``` ruby
 obj = Object.new
@@ -471,9 +471,9 @@ stub(obj) do |m|
   m.name{ 1 }
   m.name{ 2 }
 end
-p obj.name     # 0
-p obj.name     # 0
-p obj.name     # 0
+p obj.name     # 2
+p obj.name     # 2
+p obj.name     # 2
 p Muack.verify # true
 ```
 
@@ -1078,6 +1078,38 @@ verifiers details.
 [dm-core]: https://github.com/datamapper/dm-core
 [ruby-lint]: https://github.com/YorickPeterse/ruby-lint
 
+#### Why didn't mocks nor stubs check if the injected method exists before?
+
+Long story short. I can't find a set of good APIs along with good
+implementation. My ideal APIs would be that for mocks and stubs, they
+do check if the injected methods exist before, and if we don't want
+that check, we use `fake` instead of `mock` or `stub`.
+
+However, how do we specify if `fake` should act like `mock` or `stub`?
+Introducing yet another name would make the terms even more confusing
+(which are already fairly confusing!), and I don't want something like:
+`fake.mock` or `mock.fake` or `fake_mock` or `mock_fake`. Using an option
+would also raise the other questions.
+
+What if we make `mock.with_any_times` work exactly like `stub` then?
+Then we could have `fake.with_any_times` and that would be the stub
+version of fake. This should greatly reduce the complexity and confusion.
+However this won't work well because stub is not just mock without times.
+They are different in:
+
+* Mocked methods are called in FIFO (queue) order
+* Stubbed methods are called in FILO (stack) order
+* Stubbed methods could do some pattern matching
+
+Of course we could break them though, but do we really have to, just for
+this simple feature? Also, it could be pretty challenging to implement
+existing method checking for `any_instance_of`.
+
+If you could find a good set of APIs while implementing it nicely, please
+do let me know. Compatibility is not an issue. We could always bump the
+major number to inform this incompatibility. I am open to breaking legacy.
+Or, I am happy to break legacy.
+
 ## USERS:
 
 * [Rib][]
@@ -1092,7 +1124,7 @@ verifiers details.
 
 Apache License 2.0
 
-Copyright (c) 2013-2014, Lin Jen-Shin (godfat)
+Copyright (c) 2013-2015, Lin Jen-Shin (godfat)
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/lib/muack/mock.rb

@@ -181,7 +181,7 @@ module Muack
     # used for __mock_dispatch_call
     def __mock_block_call context, block, actual_args, actual_block, splat
       return unless block
-      # for AnyInstanceOf, we don't have actually context at the time
+      # for AnyInstanceOf, we don't have the actual context at the time
       # we're defining it, so we update it here
       block.context = context if block.kind_of?(Block)
       if splat

data/lib/muack/stub.rb

@@ -6,6 +6,13 @@ module Muack
     # used for Muack::Session#verify
     def __mock_verify; true; end
 
+    # used for Muack::Modifier#times
+    def __mock_defis_push defi
+      # since stubs never wear out, the reverse ordering would make more sense
+      # so that the latter wins over the previous one (overwrite)
+      __mock_defis[defi.msg].unshift(defi)
+    end
+
     # used for mocked object to dispatch mocked method
     def __mock_dispatch msg, actual_args
       if defi = __mock_defis[msg].find{ |d|

data/lib/muack/version.rb

@@ -1,4 +1,4 @@
 
 module Muack
-  VERSION = '1.1.2'
+  VERSION = '1.2.0'
 end

data/muack.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: muack 1.1.2 ruby lib
+# stub: muack 1.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "muack"
-  s.version = "1.1.2"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Lin Jen-Shin (godfat)"]
-  s.date = "2014-11-07"
+  s.date = "2015-03-10"
   s.description = "Muack -- A fast, small, yet powerful mocking library.\n\nInspired by [RR][], and it's 32x times faster (750s vs 23s) than RR\nfor running [Rib][] tests.\n\n[RR]: https://github.com/rr/rr\n[Rib]: https://github.com/godfat/rib"
   s.email = ["godfat (XD) godfat.org"]
   s.files = [
@@ -48,7 +48,7 @@ Gem::Specification.new do |s|
   "test/test_stub.rb"]
   s.homepage = "https://github.com/godfat/muack"
   s.licenses = ["Apache License 2.0"]
-  s.rubygems_version = "2.4.2"
+  s.rubygems_version = "2.4.6"
   s.summary = "Muack -- A fast, small, yet powerful mocking library."
   s.test_files = [
   "test/test_any_instance_of.rb",

data/task/gemgem.rb

@@ -38,6 +38,103 @@ module Gemgem
     self.spec = spec
   end
 
+  def gem_install
+    require 'rubygems/commands/install_command'
+    # read ~/.gemrc
+    Gem.use_paths(Gem.configuration[:gemhome], Gem.configuration[:gempath])
+    Gem::Command.extra_args = Gem.configuration[:gem]
+
+    # setup install options
+    cmd = Gem::Commands::InstallCommand.new
+    cmd.handle_options([])
+
+    # install
+    install = Gem::Installer.new(gem_path, cmd.options)
+    install.install
+    puts "\e[35mGem installed: \e[33m#{strip_path(install.gem_dir)}\e[0m"
+  end
+
+  def gem_spec
+    create
+    write
+  end
+
+  def gem_build
+    require 'fileutils'
+    require 'rubygems/package'
+    gem = nil
+    Dir.chdir(dir) do
+      gem = Gem::Package.build(Gem::Specification.load(spec_path))
+      FileUtils.mkdir_p(pkg_dir)
+      FileUtils.mv(gem, pkg_dir) # gem is relative path, but might be ok
+    end
+    puts "\e[35mGem built: \e[33m#{strip_path("#{pkg_dir}/#{gem}")}\e[0m"
+  end
+
+  def gem_release
+    sh_git('tag', gem_tag)
+    sh_git('push')
+    sh_git('push', '--tags')
+    sh_gem('push', gem_path)
+  end
+
+  def gem_check
+    ver = spec.version.to_s
+
+    if ENV['VERSION'].nil?
+      puts("\e[35mExpected "                                  \
+           "\e[33mVERSION\e[35m=\e[33m#{ver}\e[0m")
+      exit(1)
+
+    elsif ENV['VERSION'] != ver
+      puts("\e[35mExpected \e[33mVERSION\e[35m=\e[33m#{ver} " \
+           "\e[35mbut got\n         "                         \
+           "\e[33mVERSION\e[35m=\e[33m#{ENV['VERSION']}\e[0m")
+      exit(2)
+    end
+  end
+
+  def test
+    return if test_files.empty?
+
+    if ENV['COV'] || ENV['CI']
+      require 'simplecov'
+      if ENV['CI']
+        begin
+          require 'coveralls'
+          SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+        rescue LoadError => e
+          puts "Cannot load coveralls, skip: #{e}"
+        end
+      end
+      SimpleCov.start do
+        add_filter('test/')
+        add_filter('test.rb')
+      end
+    end
+
+    test_files.each{ |file| require "#{dir}/#{file[0..-4]}" }
+  end
+
+  def clean
+    return if ignored_files.empty?
+
+    require 'fileutils'
+    trash = File.expand_path("~/.Trash/#{spec.name}")
+    puts "Move the following files into: \e[35m#{strip_path(trash)}\e[33m"
+
+    ignored_files.each do |file|
+      from = "#{dir}/#{file}"
+      to   = "#{trash}/#{File.dirname(file)}"
+      puts strip_path(from)
+
+      FileUtils.mkdir_p(to)
+      FileUtils.mv(from, to)
+    end
+
+    print "\e[0m"
+  end
+
   def write
     File.open(spec_path, 'w'){ |f| f << split_lines(spec.to_ruby) }
   end
@@ -173,82 +270,38 @@ namespace :gem do
 
 desc 'Install gem'
 task :install => [:build] do
-  Gemgem.sh_gem('install', Gemgem.gem_path)
+  Gemgem.gem_install
 end
 
 desc 'Build gem'
 task :build => [:spec] do
-  require 'fileutils'
-  require 'rubygems/package'
-  gem = nil
-  Dir.chdir(Gemgem.dir) do
-    gem = Gem::Package.build(Gem::Specification.load(Gemgem.spec_path))
-    FileUtils.mkdir_p(Gemgem.pkg_dir)
-    FileUtils.mv(gem, Gemgem.pkg_dir) # gem is relative path, but might be ok
-  end
-  puts "\e[35mGem built: \e[33m" \
-       "#{Gemgem.strip_path("#{Gemgem.pkg_dir}/#{gem}")}\e[0m"
+  Gemgem.gem_build
 end
 
 desc 'Generate gemspec'
 task :spec do
-  Gemgem.create
-  Gemgem.write
+  Gemgem.gem_spec
 end
 
 desc 'Release gem'
 task :release => [:spec, :check, :build] do
-  Gemgem.module_eval do
-    sh_git('tag', Gemgem.gem_tag)
-    sh_git('push')
-    sh_git('push', '--tags')
-    sh_gem('push', Gemgem.gem_path)
-  end
+  Gemgem.gem_release
 end
 
 task :check do
-  ver = Gemgem.spec.version.to_s
-
-  if ENV['VERSION'].nil?
-    puts("\e[35mExpected "                                  \
-         "\e[33mVERSION\e[35m=\e[33m#{ver}\e[0m")
-    exit(1)
-
-  elsif ENV['VERSION'] != ver
-    puts("\e[35mExpected \e[33mVERSION\e[35m=\e[33m#{ver} " \
-         "\e[35mbut got\n         "                         \
-         "\e[33mVERSION\e[35m=\e[33m#{ENV['VERSION']}\e[0m")
-    exit(2)
-  end
+  Gemgem.gem_check
 end
 
 end # of gem namespace
 
 desc 'Run tests'
 task :test do
-  next if Gemgem.test_files.empty?
-  Gemgem.test_files.each{ |file| require "#{Gemgem.dir}/#{file[0..-4]}" }
+  Gemgem.test
 end
 
 desc 'Trash ignored files'
 task :clean => ['gem:spec'] do
-  next if Gemgem.ignored_files.empty?
-
-  require 'fileutils'
-  trash = File.expand_path("~/.Trash/#{Gemgem.spec.name}")
-  puts "Move the following files into:" \
-       " \e[35m#{Gemgem.strip_path(trash)}\e[33m"
-
-  Gemgem.ignored_files.each do |file|
-    from = "#{Gemgem.dir}/#{file}"
-    to   = "#{trash}/#{File.dirname(file)}"
-    puts Gemgem.strip_path(from)
-
-    FileUtils.mkdir_p(to)
-    FileUtils.mv(from, to)
-  end
-
-  print "\e[0m"
+  Gemgem.clean
 end
 
 task :default do

data/test/test_from_readme.rb

@@ -9,7 +9,12 @@ describe 'from README.md' do
   after{ Muack.reset }
 
   Context = Module.new{
-    include Pork::API, Muack::API
+    include Muack::API
+
+    def describe desc, &block
+      @executor.describe(desc, &block)
+      @executor.execute(@stat)
+    end
 
     def results; @results ||= []; end
     def p res  ; results << res ; end
@@ -29,7 +34,11 @@ describe 'from README.md' do
 
   codes.each.with_index do |code, index|
     would 'pass from README.md #%02d' % index do
-      context = Module.new{extend Context}
+      executor, stat = Class.new(self.class){ init }, pork_stat
+      context = Module.new do
+        extend Context
+        @executor, @stat = executor, stat
+      end
       begin
         context.instance_eval(code, 'README.md', 0)
       rescue Muack::Failure => e

data/test/test_stub.rb

@@ -109,7 +109,7 @@ describe Muack::Stub do
       stub(Obj).say(0){ 'boo' }
       stub(Obj).say(1){ 'moo' }
       e = should.raise(Muack::Unexpected){ Obj.say(false) }
-      e.expected.should.eq "obj.say(0)\n      or: obj.say(1)"
+      e.expected.should.eq "obj.say(1)\n      or: obj.say(0)"
       e.was     .should.eq 'obj.say(false)'
       e.message .should.eq "\nExpected: #{e.expected}\n but was: #{e.was}"
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: muack
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Lin Jen-Shin (godfat)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-07 00:00:00.000000000 Z
+date: 2015-03-10 00:00:00.000000000 Z
 dependencies: []
 description: |-
   Muack -- A fast, small, yet powerful mocking library.
@@ -78,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Muack -- A fast, small, yet powerful mocking library.