muack 0.5.0

data/lib/muack/stub.rb

@@ -0,0 +1,22 @@
+
+require 'muack/mock'
+
+module Muack
+  class Stub < Mock
+    # used for Muack::Session#verify
+    def __mock_verify; true; end
+
+    # used for mocked object to dispatch mocked method
+    def __mock_dispatch msg, actual_args, actual_block
+      defi = __mock_defis[msg].find{ |d|
+        __mock_check_args(d.args, actual_args)
+      }
+      if defi
+        __mock_block_call(defi, actual_args, actual_block)
+      else
+        Mock.__send__(:raise, # Wrong argument
+          Unexpected.new(object, __mock_defis[msg], msg, actual_args))
+      end
+    end
+  end
+end

data/lib/muack/test.rb

@@ -0,0 +1,26 @@
+
+require 'bacon'
+require 'muack'
+
+Bacon.summary_on_exit
+include Muack::API
+
+Obj = Object.new
+Str = 'Moo'
+def Obj.inspect
+  'obj'
+end
+
+Muack::EnsureReset = lambda{
+  [Obj, Str].each do |o|
+    o.methods.select{ |m|
+      m.to_s.start_with?('__muack_mock') || m.to_s.start_with?('say')
+    }.should.empty
+  end
+}
+
+module Kernel
+  def eq? rhs
+    self == rhs
+  end
+end

data/lib/muack/version.rb

@@ -0,0 +1,4 @@
+
+module Muack
+  VERSION = '0.5.0'
+end

data/muack.gemspec

@@ -0,0 +1,53 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "muack"
+  s.version = "0.5.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Lin Jen-Shin (godfat)"]
+  s.date = "2013-06-24"
+  s.description = "Muack -- Yet another mocking library.\n\nBasically it's an [RR][] clone, but much faster under heavy use.\nIt's 32x times faster (750s vs 23s) for 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 = [
+  ".gitmodules",
+  ".travis.yml",
+  "CHANGES.md",
+  "Gemfile",
+  "LICENSE",
+  "README.md",
+  "Rakefile",
+  "lib/muack.rb",
+  "lib/muack/any_instance_of.rb",
+  "lib/muack/definition.rb",
+  "lib/muack/failure.rb",
+  "lib/muack/mock.rb",
+  "lib/muack/modifier.rb",
+  "lib/muack/proxy.rb",
+  "lib/muack/satisfy.rb",
+  "lib/muack/session.rb",
+  "lib/muack/stub.rb",
+  "lib/muack/test.rb",
+  "lib/muack/version.rb",
+  "muack.gemspec",
+  "task/.gitignore",
+  "task/gemgem.rb",
+  "test/test_any_instance_of.rb",
+  "test/test_mock.rb",
+  "test/test_proxy.rb",
+  "test/test_readme.rb",
+  "test/test_satisfy.rb",
+  "test/test_stub.rb"]
+  s.homepage = "https://github.com/godfat/muack"
+  s.licenses = ["Apache License 2.0"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.3"
+  s.summary = "Muack -- Yet another mocking library."
+  s.test_files = [
+  "test/test_any_instance_of.rb",
+  "test/test_mock.rb",
+  "test/test_proxy.rb",
+  "test/test_readme.rb",
+  "test/test_satisfy.rb",
+  "test/test_stub.rb"]
+end

data/task/.gitignore

@@ -0,0 +1 @@
+*.rbc

data/task/gemgem.rb

@@ -0,0 +1,268 @@
+
+require 'pathname'
+
+module Gemgem
+  class << self
+    attr_accessor :dir, :spec
+  end
+
+  module_function
+  def create
+    yield(spec = Gem::Specification.new{ |s|
+      s.authors     = ['Lin Jen-Shin (godfat)']
+      s.email       = ['godfat (XD) godfat.org']
+
+      s.description = description.join
+      s.summary     = description.first
+      s.license     = readme['LICENSE'].sub(/.+\n\n/, '').lines.first.strip
+
+      s.rubygems_version = Gem::VERSION
+      s.date             = Time.now.strftime('%Y-%m-%d')
+      s.files            = gem_files
+      s.test_files       = gem_files.grep(%r{^test/(.+?/)*test_.+?\.rb$})
+      s.executables      = Dir['bin/*'].map{ |f| File.basename(f) }
+      s.require_paths    = %w[lib]
+    })
+    spec.homepage ||= "https://github.com/godfat/#{spec.name}"
+    spec
+  end
+
+  def readme
+    path = %w[README.md README].find{ |name|
+      File.exist?("#{Gemgem.dir}/#{name}")
+    }
+    @readme ||=
+      if path
+        ps = "##{File.read(path)}".
+             scan(/((#+)[^\n]+\n\n.+?(?=(\n\n\2[^#\n]+\n)|\Z))/m).map(&:first)
+        ps.inject('HEADER' => ps.first){ |r, s, i|
+          r[s[/\w+/]] = s
+          r
+        }
+      else
+        {}
+      end
+  end
+
+  def description
+    @description ||= (readme['DESCRIPTION']||'').sub(/.+\n\n/, '').lines
+  end
+
+  def changes
+    path = %w[CHANGES.md CHANGES].find{ |name|
+      File.exist?("#{Gemgem.dir}/#{name}")
+    }
+    @changes ||=
+      if path
+        date = '\d+{4}\-\d+{2}\-\d{2}'
+        File.read(path).match(
+          /([^\n]+#{date}\n\n(.+?))(?=\n\n[^\n]+#{date}\n|\Z)/m)[1]
+      else
+        ''
+      end
+  end
+
+  def ann_md
+     "#{readme['HEADER'].sub(/([\w\-]+)/, "[\\1](#{spec.homepage})")}\n\n" \
+    "##{readme['DESCRIPTION'][/[^\n]+\n\n[^\n]+/]}\n\n"                    \
+    "### CHANGES:\n\n"                                                     \
+    "###{changes}\n\n"                                                     \
+    "##{readme['INSTALLATION']}\n\n"                                       +
+    if readme['SYNOPSIS'] then "##{readme['SYNOPSIS'][/[^\n]+\n\n[^\n]+/]}"
+    else '' end
+  end
+
+  def ann_html
+    gem 'nokogiri'
+    gem 'kramdown'
+
+    IO.popen('kramdown', 'r+') do |md|
+      md.puts Gemgem.ann_md
+      md.close_write
+      require 'nokogiri'
+      html = Nokogiri::XML.parse("<gemgem>#{md.read}</gemgem>")
+      html.css('*').each{ |n| n.delete('id') }
+      html.root.children.to_html
+    end
+  end
+
+  def ann_email
+    "#{readme['HEADER'].sub(/([\w\-]+)/, "\\1 <#{spec.homepage}>")}\n\n" \
+    "#{readme['DESCRIPTION']}\n\n"                                       \
+    "#{readme['INSTALLATION']}\n\n"                                      +
+    if readme['SYNOPSIS'] then "##{readme['SYNOPSIS']}\n\n" else '' end  +
+    "## CHANGES:\n\n"                                                    \
+    "##{changes}\n\n"
+  end
+
+  def gem_tag
+    "#{spec.name}-#{spec.version}"
+  end
+
+  def write
+    File.open("#{dir}/#{spec.name}.gemspec", 'w'){ |f|
+      f << split_lines(spec.to_ruby) }
+  end
+
+  def split_lines ruby
+    ruby.gsub(/(.+?)\s*=\s*\[(.+?)\]/){ |s|
+      if $2.index(',')
+        "#{$1} = [\n  #{$2.split(',').map(&:strip).join(",\n  ")}]"
+      else
+        s
+      end
+    }
+  end
+
+  def all_files
+    @all_files ||= find_files(Pathname.new(dir)).map{ |file|
+      if file.to_s =~ %r{\.git/|\.git$}
+        nil
+      else
+        file.to_s
+      end
+    }.compact.sort
+  end
+
+  def gem_files
+    @gem_files ||= all_files - ignored_files
+  end
+
+  def ignored_files
+    @ignored_file ||= all_files.select{ |path| ignore_patterns.find{ |ignore|
+      path =~ ignore && !git_files.include?(path)}}
+  end
+
+  def git_files
+    @git_files ||= if File.exist?("#{dir}/.git")
+                     `git ls-files`.split("\n")
+                   else
+                     []
+                   end
+  end
+
+  # protected
+  def find_files path
+    path.children.select(&:file?).map{|file| file.to_s[(dir.size+1)..-1]} +
+    path.children.select(&:directory?).map{|dir| find_files(dir)}.flatten
+  end
+
+  def ignore_patterns
+    @ignore_files ||= expand_patterns(
+      gitignore.split("\n").reject{ |pattern|
+        pattern.strip == ''
+      }).map{ |pattern| %r{^([^/]+/)*?#{Regexp.escape(pattern)}(/[^/]+)*?$} }
+  end
+
+  def expand_patterns pathes
+    pathes.map{ |path|
+      if path !~ /\*/
+        path
+      else
+        expand_patterns(
+          Dir[path] +
+          Pathname.new(File.dirname(path)).children.select(&:directory?).
+            map{ |prefix| "#{prefix}/#{File.basename(path)}" })
+      end
+    }.flatten
+  end
+
+  def gitignore
+    if File.exist?(path = "#{dir}/.gitignore")
+      File.read(path)
+    else
+      ''
+    end
+  end
+end
+
+namespace :gem do
+
+desc 'Install gem'
+task :install => [:build] do
+  sh("#{Gem.ruby} -S gem install pkg/#{Gemgem.gem_tag}.gem")
+end
+
+desc 'Build gem'
+task :build => [:spec] do
+  sh("#{Gem.ruby} -S gem build #{Gemgem.spec.name}.gemspec")
+  sh("mkdir -p pkg")
+  sh("mv #{Gemgem.gem_tag}.gem pkg/")
+end
+
+desc 'Release gem'
+task :release => [:spec, :check, :build] do
+  sh("git tag #{Gemgem.gem_tag}")
+  sh("git push")
+  sh("git push --tags")
+  sh("#{Gem.ruby} -S gem push pkg/#{Gemgem.gem_tag}.gem")
+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
+end
+
+end # of gem namespace
+
+desc 'Run tests in memory'
+task :test do
+  require 'bacon'
+  Bacon.extend(Bacon::TestUnitOutput)
+  Bacon.summary_on_exit
+  $LOAD_PATH.unshift('lib')
+  Dir['./test/**/test_*.rb'].each{ |file| require file[0..-4] }
+end
+
+desc 'Run tests with shell'
+task 'test:shell', :RUBY_OPTS do |t, args|
+  files = Dir['test/**/test_*.rb'].join(' ')
+
+  cmd = [Gem.ruby, args[:RUBY_OPTS],
+         '-I', 'lib', '-S', 'bacon', '--quiet', files]
+
+  sh(cmd.compact.join(' '))
+end
+
+desc 'Generate ann markdown'
+task 'ann:md' => ['gem:spec'] do
+  puts Gemgem.ann_md
+end
+
+desc 'Generate ann html'
+task 'ann:html' => ['gem:spec'] do
+  puts Gemgem.ann_html
+end
+
+desc 'Generate ann email'
+task 'ann:email' => ['gem:spec'] do
+  puts Gemgem.ann_email
+end
+
+desc 'Generate rdoc'
+task :doc => ['gem:spec'] do
+  sh("yardoc -o rdoc --main README.md" \
+     " --files #{Gemgem.spec.extra_rdoc_files.join(',')}")
+end
+
+desc 'Remove ignored files'
+task :clean => ['gem:spec'] do
+  trash = "~/.Trash/#{Gemgem.spec.name}/"
+  sh "mkdir -p #{trash}" unless File.exist?(File.expand_path(trash))
+  Gemgem.ignored_files.each{ |file| sh "mv #{file} #{trash}" }
+end
+
+task :default do
+  puts `#{Gem.ruby} -S #{$PROGRAM_NAME} -T`
+end

data/test/test_any_instance_of.rb

@@ -0,0 +1,30 @@
+
+require 'muack/test'
+
+describe Muack::AnyInstanceOf do
+  should 'mock any_instance_of' do
+    klass = Class.new
+    any_instance_of(klass){ |instance| mock(instance).say{ true } }
+    obj = klass.new
+    obj.say              .should.eq true
+    obj.respond_to?(:say).should.eq true
+    Muack.verify         .should.eq true
+    obj.respond_to?(:say).should.eq false
+  end
+
+  should 'proxy any_instance_of' do
+    klass = Class.new{ def f; true; end }
+    any_instance_of(klass){ |instance| mock_proxy(instance).f }
+    obj = klass.new
+    obj.f.should.eq true
+    Muack.verify.should.eq true
+  end
+
+  should 'proxy any_instance_of with a block' do
+    klass = Class.new{ def f; 0; end }
+    any_instance_of(klass){ |instance| mock_proxy(instance).f{ |i| i+1 } }
+    obj = klass.new
+    obj.f.should.eq 1
+    Muack.verify.should.eq true
+  end
+end

data/test/test_mock.rb

@@ -0,0 +1,170 @@
+
+require 'muack/test'
+
+describe Muack::Mock do
+  describe 'Muack.verify==true' do
+    after do
+      Muack.verify.should.eq true
+      Muack::EnsureReset.call
+    end
+
+    should 'mock with regular method' do
+      mock(Obj).say(true){ 'boo' }
+      Obj.say(true).should.eq 'boo'
+    end
+
+    should 'mock existing method' do
+      mock(Obj).to_s{ 'zoo' }
+      Obj.to_s.should.eq 'zoo'
+    end
+
+    should 'mock twice' do
+      mock(Obj).say(true){ Obj.saya }
+      mock(Obj).saya{ 'coo' }
+      Obj.say(true).should.eq 'coo'
+    end
+
+    should 'also mock with with' do
+      mock(Str).method_missing(:say, 0){ 0 }
+      Str.say(0).should.eq 0
+      Muack.verify.should.eq true
+      mock(Str).method_missing(:say, 1){ 1 }
+      lambda{ Str.say(2) }.should.raise(Muack::Unexpected)
+      Muack.reset
+    end
+
+    should 'mock multiple times' do
+      3.times{ |i| mock(Obj).say(i){ i } }
+      3.times{ |i| Obj.say(i).should.eq i }
+    end
+
+    should 'mock multiple times with times(n) modifier' do
+      mock(Obj).say{ 0 }.times(3)
+      3.times{ |i| Obj.say.should.eq 0 }
+    end
+
+    should 'mock 0 times with times(0) modifier' do
+      mock(Obj).say{ 0 }.times(0).should.kind_of Muack::Modifier
+    end
+
+    should 'mix mock and stub' do
+      mock(Obj).say { 0 }
+      stub(Obj).saya{ 1 }
+      3.times{ Obj.saya.should.eq 1 }
+               Obj.say .should.eq 0
+    end
+
+    should 'unnamed mock' do
+      mock.say{1}.object.say.should.eq 1
+    end
+
+    should 'inspect' do
+      mock(Obj).inspect.should.eq "#<Muack::Mock object=obj>"
+    end
+
+    should 'mock and call, mock and call' do
+      mock(Obj).say{0}
+      Obj.say.should.eq 0
+      mock(Obj).say{1}
+      Obj.say.should.eq 1
+    end
+  end
+
+  describe 'Muack.verify==false' do
+    after do
+      Muack.reset
+      Muack::EnsureReset.call
+    end
+
+    should 'raise Muack::Unexpected error if passing unexpected argument' do
+      mock(Obj).say(true){ 'boo' }
+      begin
+        Obj.say(false)
+        'never'.should.eq 'reach'
+      rescue Muack::Unexpected => e
+        e.expected.should.eq 'obj.say(true)'
+        e.was     .should.eq 'obj.say(false)'
+        e.message .should.eq "\nExpected: #{e.expected}\n but was: #{e.was}"
+      end
+    end
+
+    should 'have correct message for multiple mocks with the same name' do
+      2.times{ mock(Obj).say }
+      begin
+        3.times{ Obj.say }
+        'never'.should.eq 'reach'
+      rescue Muack::Expected => e
+        e.expected.should.eq 'obj.say()'
+        e.expected_times.should.eq 2
+        e.actual_times  .should.eq 3
+        e.message       .should.eq "\nExpected: obj.say()\n  " \
+                                   "called 2 times\n but was 3 times."
+      end
+    end
+
+    should 'raise if a mock with times(0) gets called' do
+      mock(Obj).say.times(0)
+      begin
+        Obj.say
+        'never'.should.eq 'reach'
+      rescue Muack::Unexpected => e
+        e.expected.should.eq nil
+        e.was     .should.eq 'obj.say()'
+        e.message .should.start_with "\nExpected: #{e.was}\n"
+      end
+    end
+
+    should 'raise if a mock with times(0) gets called with diff sig' do
+      mock(Obj).say.times(0)
+      begin
+        Obj.say(true)
+        'never'.should.eq 'reach'
+      rescue Muack::Unexpected => e
+        e.expected.should.eq nil
+        e.was     .should.eq 'obj.say(true)'
+        e.message .should.start_with "\nExpected: #{e.was}\n"
+      end
+    end
+
+    should 'raise Muack::Unexpected when calling with diff sig' do
+      mock(Obj).say(true){1}
+      Obj.say(true).should.eq 1
+      begin
+        Obj.say
+        'never'.should.eq 'reach'
+      rescue Muack::Unexpected => e
+        e.expected.should.eq 'obj.say(true)'
+        e.was     .should.eq 'obj.say()'
+        e.message .should.eq "\nExpected: #{e.expected}\n but was: #{e.was}"
+      end
+    end
+
+    should 'raise Muack::Expected error if mock methods not called' do
+      mock(Obj).say(true){ 'boo' }
+      begin
+        Muack.verify
+      rescue Muack::Expected => e
+        e.expected      .should.eq 'obj.say(true)'
+        e.expected_times.should.eq 1
+        e.actual_times  .should.eq 0
+        e.message       .should.eq "\nExpected: obj.say(true)\n  " \
+                                   "called 1 times\n but was 0 times."
+      end
+    end
+
+    should 'show first not enough calls' do
+      mock(Obj).say{ 'boo' }.times(2)
+      mock(Obj).saya        .times(2)
+      begin
+        Obj.say
+        Muack.verify
+      rescue Muack::Expected => e
+        e.expected      .should.eq 'obj.say()'
+        e.expected_times.should.eq 2
+        e.actual_times  .should.eq 1
+        e.message       .should.eq "\nExpected: obj.say()\n  " \
+                                   "called 2 times\n but was 1 times."
+      end
+    end
+  end
+end