muack 0.7.3 → 1.0.0

data/lib/muack/block.rb

@@ -0,0 +1,17 @@
+
+module Muack
+  class Block
+    attr_accessor :block, :context
+    def initialize block, context=nil
+      self.block, self.context = block, context
+    end
+
+    def call *args, &actual_block
+      if context # ruby: no way to pass actual_block to instance_exec
+        context.instance_exec(*args, &block)
+      else
+        block.call(*args, &actual_block)
+      end
+    end
+  end
+end

data/lib/muack/definition.rb

@@ -1,6 +1,7 @@
 
 module Muack
-  Definition  = Class.new(Struct.new(:msg, :args, :block,
-                                     :original_method, :proxy))
+  Definition  = Class.new(Struct.new(:msg, :args, :returns,
+                                     :peek_args, :peek_return,
+                                     :original_method))
   WithAnyArgs = Object.new
 end

data/lib/muack/mock.rb

@@ -2,9 +2,12 @@
 require 'muack/definition'
 require 'muack/modifier'
 require 'muack/failure'
+require 'muack/block'
 require 'muack/error'
 
 module Muack
+  EmptyBlock = proc{}
+
   class Mock < BasicObject
     attr_reader :object
     def initialize object
@@ -70,21 +73,29 @@ module Muack
     end
 
     # used for mocked object to dispatch mocked method
-    def __mock_dispatch_call disp, actual_args, actual_block
-      if disp.proxy
-        value = yield # need the original context for proxy or AnyInstanceOf
-        if disp.block
-          disp.block.call(value)
-        else
-          value
-        end
-      elsif block = disp.block
-        arity = block.arity
-        if arity < 0
-          block.call(*actual_args             , &actual_block)
-        else
-          block.call(*actual_args.first(arity), &actual_block)
-        end
+    def __mock_dispatch_call context, disp, actual_args, actual_block, &_yield
+      args = if disp.peek_args
+               __mock_block_call(context, disp.peek_args,
+                                 actual_args, actual_block, true)
+             else
+               actual_args
+             end
+
+      ret = if disp.returns
+              __mock_block_call(context, disp.returns,
+                                args, actual_block, true)
+            elsif disp.original_method # proxies for singleton methods
+              context.__send__(disp.original_method, *args, &actual_block)
+            else # proxies for instance methods
+              # need the original context for calling `super`
+              # ruby: can't pass a block to yield, so we name it _yield
+              _yield.call(*args, &actual_block)
+            end
+
+      if disp.peek_return
+        __mock_block_call(context, disp.peek_return, ret, EmptyBlock, false)
+      else
+        ret
       end
     end
 
@@ -105,9 +116,10 @@ module Muack
         object.singleton_class.module_eval do
           remove_method(defi.msg)
           # restore original method
-          if instance_methods(false).include?(defi.original_method)
-            alias_method defi.msg, defi.original_method
-            remove_method defi.original_method
+          if instance_methods(false).include?(defi.original_method) ||
+             private_instance_methods(false).include?(defi.original_method)
+            alias_method(defi.msg, defi.original_method)
+            remove_method(defi.original_method)
           end
         end
       end
@@ -120,16 +132,23 @@ module Muack
     def __mock_inject_method defi
       __mock_injected[defi.msg] = defi
       target = object.singleton_class # would be the class in AnyInstanceOf
-      Mock.store_original_method(target, defi)
-       __mock_inject_mock_method(target, defi)
+      privilege = Mock.store_original_method(target, defi)
+      __mock_inject_mock_method(target, defi, privilege)
     end
 
     def self.store_original_method klass, defi
-      return unless klass.instance_methods(false).include?(defi.msg)
+      privilege = if klass.instance_methods(false).include?(defi.msg)
+        :public # TODO: forget about protected methods?
+      elsif klass.private_instance_methods(false).include?(defi.msg)
+        :private
+      end
+
+      return :public unless privilege
       # store original method
       original_method = find_new_name(klass, defi.msg)
       klass.__send__(:alias_method, original_method, defi.msg)
       defi.original_method = original_method
+      privilege
     end
 
     def self.find_new_name klass, message, level=0
@@ -137,7 +156,7 @@ module Muack
         raise CannotFindInjectionName.new(level+1, message)
       end
 
-      new_name = "__muack_mock_#{level}_#{message}".to_sym
+      new_name = "__muack_#{name}_#{level}_#{message}".to_sym
       if klass.instance_methods(false).include?(new_name)
         find_new_name(klass, message, level+1)
       else
@@ -145,18 +164,29 @@ module Muack
       end
     end
 
-    def __mock_inject_mock_method target, defi
+    def __mock_inject_mock_method target, defi, privilege=:public
       mock = self # remember the context
-      target.__send__(:define_method, defi.msg){|*actual_args, &actual_block|
+      target.__send__(:define_method, defi.msg){ |*actual_args, &actual_block|
         disp = mock.__mock_dispatch(defi.msg, actual_args)
-        mock.__mock_dispatch_call(disp, actual_args, actual_block){
-          if disp.original_method
-            __send__(disp.original_method, *actual_args, &actual_block)
-          else
-            super(*actual_args, &actual_block)
-          end
-        }
+        mock.__mock_dispatch_call(self, disp, actual_args,
+                                              actual_block) do |args, &block|
+          super(*args, &block)
+        end
       }
+      target.__send__(privilege, defi.msg)
+    end
+
+    # 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
+      # we're defining it, so we update it here
+      block.context = context if block.kind_of?(Block)
+      if splat
+        block.call(*actual_args, &actual_block)
+      else # peek_return doesn't need splat
+        block.call(actual_args, &actual_block)
+      end
     end
 
     def __mock_check_args expected_args, actual_args

data/lib/muack/modifier.rb

@@ -1,8 +1,25 @@
 
+require 'muack/block'
 require 'muack/error'
 
 module Muack
   class Modifier < Struct.new(:mock, :defi)
+    # Public API
+    def times number
+      if mock.__mock_class == Stub
+        raise StubHasNoTimes.new(object, defi, number)
+      end
+
+      if number >= 1
+        (number - 1).times{ mock.__mock_defis_push(defi) }
+      elsif number == 0
+        mock.__mock_defis_pop(defi)
+      else
+        raise "What would you expect from calling a method #{number} times?"
+      end
+      self
+    end
+
     # Public API
     def with_any_args
       defi.args = [WithAnyArgs]
@@ -10,30 +27,20 @@ module Muack
     end
 
     # Public API
-    def returns val=nil, &block
-      defi.block = block || lambda{ val }
+    def returns opts={}, &block
+      defi.returns = create_block(block, opts)
       self
     end
 
     # Public API
-    def proxy
-      defi.proxy = true
+    def peek_args opts={}, &block
+      defi.peek_args = create_block(block, opts)
       self
     end
 
     # Public API
-    def times number
-      if mock.__mock_class == Stub
-        raise StubHasNoTimes.new(object, defi, number)
-      end
-
-      if number >= 1
-        (number - 1).times{ mock.__mock_defis_push(defi) }
-      elsif number == 0
-        mock.__mock_defis_pop(defi)
-      else
-        raise "What would you expect from calling a method #{number} times?"
-      end
+    def peek_return opts={}, &block
+      defi.peek_return = create_block(block, opts)
       self
     end
 
@@ -41,5 +48,10 @@ module Muack
     def object
       mock.object
     end
+
+    private
+    def create_block block, opts
+      if opts[:instance_exec] then Block.new(block) else block end
+    end
   end
 end

data/lib/muack/satisfy.rb

@@ -5,10 +5,10 @@ module Muack
       !!block.call(actual_arg)
     end
 
-    def | rhs; Satisfy::Union.new(self, rhs); end
-    def & rhs; Satisfy::Inter.new(self, rhs); end
+    def | rhs; Satisfy::Disj.new(self, rhs); end
+    def & rhs; Satisfy::Conj.new(self, rhs); end
 
-    class Union < Satisfy
+    class Disj < Satisfy
       def initialize lhs, rhs
         @lhs, @rhs = lhs, rhs
         super(lambda{ |actual_arg| lhs.match(actual_arg) ||
@@ -19,7 +19,7 @@ module Muack
       alias_method :inspect, :to_s
     end
 
-    class Inter < Satisfy
+    class Conj < Satisfy
       def initialize lhs, rhs
         @lhs, @rhs = lhs, rhs
         super(lambda{ |actual_arg| lhs.match(actual_arg) &&
@@ -36,7 +36,7 @@ module Muack
     alias_method :inspect, :to_s
 
     def api_name
-      self.class.name[/::(\w+)$/, 1].
+      (self.class.name || 'Unknown')[/(::)*(\w+)$/, 2].
         gsub(/([A-Z][a-z]*)+?(?=[A-Z][a-z]*)/, '\\1_').downcase
     end
 

data/lib/muack/session.rb

@@ -20,7 +20,7 @@ module Muack
 
     def reset
       instance_variable_defined?(:@others) && @others.clear
-      each_value(&:__mock_reset)
+      reverse_each{ |_, m| m.__mock_reset }
       clear
     end
   end

data/lib/muack/test.rb

@@ -10,6 +10,10 @@ Str = 'Moo'
 def Obj.inspect
   'obj'
 end
+def Obj.private
+  'pri'
+end
+Obj.singleton_class.__send__(:private, :private)
 
 Muack::EnsureReset = lambda{
   [Obj, Str].each do |o|

data/lib/muack/version.rb

@@ -1,4 +1,4 @@
 
 module Muack
-  VERSION = '0.7.3'
+  VERSION = '1.0.0'
 end

data/muack.gemspec

@@ -1,14 +1,15 @@
 # -*- encoding: utf-8 -*-
-# stub: muack 0.7.3 ruby lib
+# stub: muack 1.0.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "muack"
-  s.version = "0.7.3"
+  s.version = "1.0.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 = "2013-10-01"
-  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.date = "2014-01-06"
+  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 = [
   ".gitignore",
@@ -21,6 +22,7 @@ Gem::Specification.new do |s|
   "Rakefile",
   "lib/muack.rb",
   "lib/muack/any_instance_of.rb",
+  "lib/muack/block.rb",
   "lib/muack/definition.rb",
   "lib/muack/error.rb",
   "lib/muack/failure.rb",
@@ -33,24 +35,25 @@ Gem::Specification.new do |s|
   "lib/muack/test.rb",
   "lib/muack/version.rb",
   "muack.gemspec",
-  "task/.gitignore",
+  "task/README.md",
   "task/gemgem.rb",
   "test/test_any_instance_of.rb",
+  "test/test_from_readme.rb",
   "test/test_mock.rb",
+  "test/test_modifier.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.1.5"
-  s.summary = "Muack -- Yet another mocking library."
+  s.rubygems_version = "2.2.0"
+  s.summary = "Muack -- A fast, small, yet powerful mocking library."
   s.test_files = [
   "test/test_any_instance_of.rb",
+  "test/test_from_readme.rb",
   "test/test_mock.rb",
+  "test/test_modifier.rb",
   "test/test_proxy.rb",
-  "test/test_readme.rb",
   "test/test_satisfy.rb",
   "test/test_stub.rb"]
 end

data/task/README.md

@@ -0,0 +1,54 @@
+# Gemgem
+
+## DESCRIPTION:
+
+Provided tasks:
+
+    rake clean        # Remove ignored files
+    rake gem:build    # Build gem
+    rake gem:install  # Install gem
+    rake gem:release  # Release gem
+    rake gem:spec     # Generate gemspec
+    rake test         # Run tests in memory
+
+## REQUIREMENTS:
+
+* Tested with MRI (official CRuby) 1.9.3, 2.0.0, Rubinius and JRuby.
+
+## INSTALLATION:
+
+    git submodule add git://github.com/godfat/gemgem.git task
+
+And in Rakefile:
+
+``` ruby
+begin
+  require "#{dir = File.dirname(__FILE__)}/task/gemgem"
+rescue LoadError
+  sh 'git submodule update --init'
+  exec Gem.ruby, '-S', $PROGRAM_NAME, *ARGV
+end
+
+Gemgem.init(dir) do |s|
+  s.name    = 'your-gem'
+  s.version = '0.1.0'
+end
+```
+
+## LICENSE:
+
+Apache License 2.0
+
+Copyright (c) 2011-2013, 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.
+You may obtain a copy of the License at
+
+<http://www.apache.org/licenses/LICENSE-2.0>
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/task/gemgem.rb

@@ -144,20 +144,18 @@ module Gemgem
   end
 
   def ignored_pattern
-    @ignored_pattern ||= Regexp.new(expand_patterns(gitignore).join('|'))
+    @ignored_pattern ||= if gitignore.empty?
+                           /^$/
+                         else
+                           Regexp.new(expand_patterns(gitignore).join('|'))
+                         end
   end
 
   def expand_patterns pathes
     # http://git-scm.com/docs/gitignore
     pathes.flat_map{ |path|
-      case path
-      when %r{\*}
-        Regexp.escape(path).gsub(/\\\*/, '[^/]*')
-      when %r{^/}
-        "^#{Regexp.escape(path[1..-1])}"
-      else # we didn't implement negative pattern for now
-        Regexp.escape(path)
-      end
+      # we didn't implement negative pattern for now
+      Regexp.escape(path).sub(%r{^/}, '^').gsub(/\\\*/, '[^/]*')
     }
   end
 
@@ -226,7 +224,7 @@ end
 
 end # of gem namespace
 
-desc 'Run tests in memory'
+desc 'Run tests'
 task :test do
   next if Gemgem.test_files.empty?
 
@@ -236,7 +234,7 @@ task :test do
   Gemgem.test_files.each{ |file| require "#{Gemgem.dir}/#{file[0..-4]}" }
 end
 
-desc 'Remove ignored files'
+desc 'Trash ignored files'
 task :clean => ['gem:spec'] do
   next if Gemgem.ignored_files.empty?