rspec-process-mocks 0.0.1

data/.gitignore

@@ -0,0 +1,11 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+doc
+tmp
+rerun.txt
+Gemfile.lock
+.bundle
+.rvmrc

data/Gemfile

@@ -0,0 +1,40 @@
+source "http://rubygems.org"
+
+### rspec libs
+%w[rspec rspec-core rspec-expectations rspec-mocks].each do |lib|
+  library_path = File.expand_path("../../#{lib}", __FILE__)
+  if File.exist?(library_path)
+    gem lib, :path => library_path
+  else
+    gem lib, :git => "git://github.com/rspec/#{lib}.git"
+  end
+end
+
+### dev dependencies
+gem "rake", "~> 0.8"
+gem "cucumber", "~> 0.10.2"
+gem "aruba", "~> 0.3.6"
+gem "rcov", "0.9.9", :platforms => :mri
+gem "relish", "0.2.0"
+gem "guard-rspec", "0.1.9"
+gem "growl", "1.0.3"
+gem "nokogiri", "1.4.4"
+
+platforms :mri_18 do
+  gem 'ruby-debug'
+end
+
+platforms :mri_19 do
+  gem 'linecache19', '0.5.11' # 0.5.12 cannot install on 1.9.1, and 0.5.11 appears to work with both 1.9.1 & 1.9.2
+  gem 'ruby-debug19'
+  gem 'ruby-debug-base19', RUBY_VERSION == '1.9.1' ? '0.11.23' : '~> 0.11.24'
+end
+
+platforms :mri_18, :mri_19 do
+  gem "rb-fsevent", "~> 0.3.9"
+  gem "ruby-prof", "~> 0.9.2"
+end
+
+platforms :jruby do
+  gem "jruby-openssl"
+end

data/README.md

@@ -0,0 +1,54 @@
+WARNING: This is just a big hack right now. If you are interested in using this
+project but I haven't removed this warning yet, please bug me to lessen the
+hackiness and make it more usable.
+
+
+# RSpec Process Mocks
+
+rspec-process-mocks is an addon to rspec-mocks that provides support
+for method stubs, fakes, and message expectations within child processes.
+
+## Documentation
+
+## Setup
+
+Gemfile
+
+    gem 'rspec-process-mocks', :git => 'git://github.com/thoughtless/rspec-process-mocks.git'
+
+`bundle install`
+
+spec/spec_helper.rb
+
+    require 'rspec/process_mocks' # This line must be after 'config.mock_with :rspec'
+
+## Message Expectations
+
+    describe "some action" do
+      context "when bad stuff happens" do
+        it "logs the error" do
+          logger = double('logger')
+          doer = Doer.new(logger)
+          logger.should_receive_in_child_process(:log)
+          doer.do_something_with(:bad_data)
+          sleep 0.1 # Leave time for the child process to run.
+        end
+      end
+    end
+
+    class Doer
+      attr_accessor :logger
+      def do_something_with(data)
+        Process.fork { logger.log(data) }
+      end
+    end
+
+## Contribute
+
+See [http://github.com/thoughtless/rspec-process-mocks](http://github.com/thoughtless/rspec-process-mocks)
+
+## Also see
+
+* [http://github.com/rspec/rspec](http://github.com/rspec/rspec)
+* [http://github.com/rspec/rspec-core](http://github.com/rspec/rspec-core)
+* [http://github.com/rspec/rspec-expectations](http://github.com/rspec/rspec-expectations)

data/cucumber.yml

@@ -0,0 +1,2 @@
+default: --require features --tags ~@wip features --format progress
+wip: --require features --tags @wip:3 --wip features

data/features/message_expectations/expect_message.feature

@@ -0,0 +1,154 @@
+Feature: expect a message
+
+  Use should_receive() to set an expectation that a receiver should receive a
+  message before the example is completed.
+
+  Scenario: expect a message
+    Given a file named "spec/account_spec.rb" with:
+      """
+      RSpec.configuration.mock_framework = :rspec
+      $: << File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'lib'))
+      require 'rspec/process_mocks'
+      require "account"
+
+      describe Account do
+        context "when closed" do
+          it "logs an account closed message in a child process" do
+
+            logger = double("logger")
+            account = Account.new
+            account.logger = logger
+
+            logger.should_receive_in_child_process(:account_closed)
+
+            account.close
+
+            sleep 0.1
+          end
+        end
+      end
+      """
+    And a file named "lib/account.rb" with:
+      """
+      class Account
+        attr_accessor :logger
+
+        def close
+          Process.fork { logger.account_closed }
+        end
+      end
+      """
+    When I run `rspec spec/account_spec.rb`
+    Then the output should contain "1 example, 0 failures"
+
+  Scenario: expect a message, but it isn't called
+    Given a file named "spec/account_spec.rb" with:
+      """
+      RSpec.configuration.mock_framework = :rspec
+      $: << File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'lib'))
+      require 'rspec/process_mocks'
+      require "account"
+
+      describe Account do
+        context "when closed" do
+          it "logs an account closed message in a child process" do
+
+            logger = double("logger")
+            account = Account.new
+            account.logger = logger
+
+            logger.should_receive_in_child_process(:account_closed)
+
+            account.close
+
+            sleep 0.1
+          end
+        end
+      end
+      """
+    And a file named "lib/account.rb" with:
+      """
+      class Account
+        attr_accessor :logger
+
+        def close
+          Process.fork { logger.object_id }
+        end
+      end
+      """
+    When I run `rspec spec/account_spec.rb`
+    Then the output should contain "1 example, 1 failure"
+    And the output should contain "expected: 1 time"
+    And the output should contain "received: 0 times"
+
+  @wip
+  Scenario: expect a message with an argument
+    Given a file named "spec/account_spec.rb" with:
+      """
+      RSpec.configuration.mock_framework = :rspec
+      $: << File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'lib'))
+      require 'rspec/process_mocks'
+      require "account"
+
+      describe Account do
+        context "when closed" do
+          it "logs an account closed message" do
+            logger = double("logger")
+            account = Account.new
+            account.logger = logger
+
+            logger.should_receive_in_child_process(:account_closed).with(account)
+
+            account.close
+
+            puts 'start sleep'
+            sleep 1
+            puts 'end sleep'
+
+            account.logger
+          end
+        end
+      end
+      """
+    And a file named "lib/account.rb" with:
+      """
+      class Account
+        attr_accessor :logger
+
+        def close
+          Process.fork { logger.account_closed(self) }
+        end
+      end
+      """
+    When I run `rspec spec/account_spec.rb`
+    Then the output should contain "1 example, 0 failures"
+
+  @wip
+  Scenario: provide a return value
+    Given a file named "message_expectation_spec.rb" with:
+      """
+      RSpec.configuration.mock_framework = :rspec
+      $: << File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'lib'))
+      require 'rspec/process_mocks'
+      describe "a message expectation" do
+        context "with a return value" do
+          context "specified in a block" do
+            it "returns the specified value" do
+              receiver = double("receiver")
+              receiver.should_receive_in_child_process(:message) { :return_value }
+              receiver.message.should eq(:return_value)
+            end
+          end
+
+          context "specified with and_return" do
+            it "returns the specified value" do
+              receiver = double("receiver")
+              receiver.should_receive_in_child_process(:message).and_return(:return_value)
+              receiver.message.should eq(:return_value)
+            end
+          end
+        end
+      end
+      """
+    When I run `rspec message_expectation_spec.rb`
+    Then the output should contain "2 examples, 0 failures"

data/features/support/env.rb

@@ -0,0 +1,9 @@
+require 'bundler'
+Bundler.require(:default, :development, :test)
+
+require 'aruba/cucumber'
+require 'rspec/expectations'
+
+Before do
+  @aruba_timeout_seconds = 3
+end

data/lib/rspec/process_mocks/framework.rb

@@ -0,0 +1,4 @@
+require 'rspec/process_mocks/methods'
+require 'rspec/process_mocks/proxy'
+require 'rspec/process_mocks/method_double'
+require 'rspec/process_mocks/message_expectation'

data/lib/rspec/process_mocks/message_expectation.rb

@@ -0,0 +1,66 @@
+require 'tempfile'
+
+module RSpec
+  module ProcessMocks
+    class ChildProcessMessageExpectation < RSpec::Mocks::MessageExpectation
+      def initialize(*args)
+        super
+
+        # The tempfile is used for interprocess communication
+        @tempfile = Tempfile.new("should-receive-#{@expected_from.object_id}-#{@sym}")
+      end
+      def verify_messages_received
+        # Maybe we should add a sleep loop here if @tempfile is empty. This may
+        # prevent a user of this library from having to add a sleep in the spec.
+        # Maybe this:
+        #     @tempfile.rewind
+        #     lines = @tempfile.readlines
+        #     timeout = Configure.verify_timeout
+        #     while lines.empty? && timeout > 0
+        #       sleep 0.1
+        #       timeout -= 0.1
+        #       @tempfile.rewind
+        #       lines = @tempfile.readlines
+        #     end
+
+        @tempfile.rewind
+        lines = @tempfile.readlines
+#puts "lines in verify_messages_received: #{lines.inspect}"
+        return true if lines.size == 1 #&& # Called exactly once.
+#          lines[0] == "[]\n" # Called with no arguments.
+
+        generate_error
+      rescue RSpec::Mocks::MockExpectationError => error
+        error.backtrace.insert(0, @expected_from)
+        Kernel::raise error
+      end
+
+      # This is a hack to get it to work. But it means we can only ever expect
+      # exactly 1 message.
+      def matches_exact_count?
+        lines.size == 1
+      end
+
+      # This method is executed in the _child_ process when the stubbed method
+      # is called.
+      def invoke(*args, &block)
+
+        msg = args.inspect
+        @tempfile.puts msg
+        @tempfile.flush
+#        puts "##{@sym} called on #{@expected_from.class}-#{@expected_from.object_id}; args: #{args.inspect}"
+#        yield block, *args if defined?(block)
+      end
+
+      # This is a hack to get it to work. But it means we don't get info about
+      # "similar" methods in the failure output. Similar messages are those with
+      # a matching method name, but not matching arguments.
+      # Note: this is only a rough definition of "similar" methods. "Similar"
+      # methods are not part of RSpec's external API, so their definition is not
+      # strictly documented.
+      def similar_messages
+        []
+      end
+    end
+  end
+end

data/lib/rspec/process_mocks/method_double.rb

@@ -0,0 +1,28 @@
+module RSpec
+  module ProcessMocks
+    module MethodDouble
+      # This has no checking for existing expectations on this object (like RSpec
+      # does). It will probably only work if you set one expectation per object.
+      def add_child_process_expectation(error_generator, expectation_ordering, expected_from, opts, &block)
+        configure_method
+#        expectation = if existing_stub = stubs.first
+#          existing_stub.build_child(expected_from, block, 1, opts)
+#        else
+#          ChildProcessMessageExpectation.new(error_generator, expectation_ordering, expected_from, @method_name, block, 1, opts)
+#        end
+#        expectations << expectation
+        expectation = ChildProcessMessageExpectation.new(error_generator, expectation_ordering, expected_from, @method_name, block, 1, opts)
+        expectations << expectation
+        expectation
+      end
+    end
+  end
+end
+
+module RSpec
+  module Mocks
+    class MethodDouble
+      include RSpec::ProcessMocks::MethodDouble
+    end
+  end
+end

data/lib/rspec/process_mocks/methods.rb

@@ -0,0 +1,17 @@
+module RSpec
+  module ProcessMocks
+    module Methods
+      def should_receive_in_child_process(sym, opts={}, &block)
+        __mock_proxy.add_child_process_message_expectation(opts[:expected_from] || caller(1)[0], sym.to_sym, opts, &block)
+      end
+    end
+  end
+end
+
+module RSpec
+  module Mocks
+    module Methods
+      include RSpec::ProcessMocks::Methods
+    end
+  end
+end

data/lib/rspec/process_mocks/proxy.rb

@@ -0,0 +1,17 @@
+module RSpec
+  module ProcessMocks
+    module Proxy
+      def add_child_process_message_expectation(location, method_name, opts={}, &block)
+        method_double[method_name].add_child_process_expectation @error_generator, @expectation_ordering, location, opts, &block
+      end
+    end
+  end
+end
+
+module RSpec
+  module Mocks
+    class Proxy
+      include RSpec::ProcessMocks::Proxy
+    end
+  end
+end

data/lib/rspec/process_mocks/version.rb

@@ -0,0 +1,7 @@
+module RSpec # :nodoc:
+  module ProcessMocks # :nodoc:
+    module Version # :nodoc:
+      STRING = '0.0.1'
+    end
+  end
+end

data/lib/rspec/process_mocks.rb

@@ -0,0 +1,7 @@
+require 'rspec/process_mocks/framework'
+require 'rspec/process_mocks/version'
+
+module RSpec
+  module ProcessMocks
+  end
+end

data/rspec-process-mocks.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "rspec/process_mocks/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rspec-process-mocks"
+  s.version     = RSpec::ProcessMocks::Version::STRING
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Paul Cortens"]
+  s.email       = "paul@thoughtless.ca"
+  s.homepage    = "http://github.com/thoughtless/rspec-process-mocks"
+  s.summary     = "rspec-process-mocks-#{RSpec::ProcessMocks::Version::STRING}"
+  s.description = "Add-on for RSpec's 'test double' framework, with support for stubbing and mocking within child processes"
+
+  s.files            = `git ls-files`.split("\n")
+  s.test_files       = `git ls-files -- {spec,features}/*`.split("\n")
+  s.executables      = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.extra_rdoc_files = [ "README.md" ]
+  s.rdoc_options     = ["--charset=UTF-8"]
+  s.require_path     = "lib"
+end
+

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: rspec-process-mocks
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Paul Cortens
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-28 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Add-on for RSpec's 'test double' framework, with support for stubbing and mocking within child processes
+email: paul@thoughtless.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- cucumber.yml
+- features/message_expectations/expect_message.feature
+- features/support/env.rb
+- lib/rspec/process_mocks.rb
+- lib/rspec/process_mocks/framework.rb
+- lib/rspec/process_mocks/message_expectation.rb
+- lib/rspec/process_mocks/method_double.rb
+- lib/rspec/process_mocks/methods.rb
+- lib/rspec/process_mocks/proxy.rb
+- lib/rspec/process_mocks/version.rb
+- rspec-process-mocks.gemspec
+has_rdoc: true
+homepage: http://github.com/thoughtless/rspec-process-mocks
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: rspec-process-mocks-0.0.1
+test_files: []
+