rr 1.1.1 → 3.0.0

data/spec/global_helper.rb

@@ -0,0 +1,38 @@
+require 'pp'
+require 'rubygems'
+require 'bundler'
+
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start
+end
+
+module RR
+  module Test
+    def self.setup_test_suite(adapter_name)
+      puts "Setting up test suite for #{adapter_name}" if ENV['RR_DEBUG']
+      unset_bundler_vars
+      adapter = Adapter.new(adapter_name)
+      ENV['ADAPTER'] = adapter.name.to_s
+      puts "Using appraisal: #{adapter.appraisal.name}" if ENV['RR_DEBUG']
+      ENV['BUNDLE_GEMFILE'] = adapter.appraisal.gemfile_path
+      puts "Using gemfile: #{adapter.appraisal.gemfile_path}" if ENV['RR_DEBUG']
+      Bundler.setup(:default)
+      $:.unshift File.expand_path('../../lib', __FILE__)
+    end
+
+    def self.unset_bundler_vars
+      # Copied from appraisal
+      %w(RUBYOPT BUNDLE_PATH BUNDLE_BIN_PATH BUNDLE_GEMFILE).each do |name|
+        ENV[name] = nil
+      end
+    end
+  end
+end
+
+lib_path = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+
+Dir[ File.expand_path('../support/**/*.rb', __FILE__) ].each { |fn| require fn }
+
+$stdout.sync = true

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--require ./spec/custom_formatter_for_rspec
+--format CustomFormatterForRSpec
+--color

data/spec/spec_suite_configuration.rb

@@ -0,0 +1,126 @@
+require File.expand_path('../spec_suite_runner', __FILE__)
+
+require 'yaml'
+require 'erb'
+require 'forwardable'
+require 'ostruct'
+
+class SpecSuiteConfiguration
+  SUITES_CONFIG_FILE = File.expand_path('../suites.yml', __FILE__)
+  TRAVIS_CONFIG_FILE = File.expand_path('../../.travis.yml', __FILE__)
+
+  class Suite < Struct.new(:name, :desc, :rvm_version, :ruby_id, :env, :travis)
+    attr_reader :runner
+
+    def initialize(name, desc, rvm_version, ruby_id, env, travis)
+      super
+      @runner = SpecSuiteRunner.new(self)
+    end
+
+    def appraisal_name
+      "ruby_#{ruby_id}_#{name}"
+    end
+
+    def run
+      runner.call
+    end
+
+    def current_ruby_id
+      '19'
+    end
+
+    def matching_current_ruby_version?
+      ruby_id == current_ruby_id
+    end
+  end
+
+  attr_reader :ruby_groups, :runners
+
+  def self.build
+    new(parse)
+  end
+
+  def self.parse
+    suites = []
+    yaml = ERB.new(File.read(SUITES_CONFIG_FILE)).result(binding)
+    ruby_groups = YAML.load(yaml)
+    ruby_groups.each do |ruby_id, ruby_group|
+      base_env = ruby_group.fetch('env', {})
+      ruby_group['suites'].each do |suite|
+        ruby_group['rvm_versions'].each do |rvm_version|
+          suite = suite.dup
+          suite['ruby_id'] = ruby_id.to_s
+          suite['rvm_version'] = rvm_version['name']
+          suite['env'] = base_env.merge(rvm_version.fetch('env', {}))
+          suite['travis'] = ruby_group.fetch('travis', {})
+          suite['travis']['env'] = base_env.merge(suite['travis'].fetch('env', {}))
+          suites << suite
+        end
+      end
+    end
+    suites
+  end
+
+  def self.root_dir
+    File.expand_path('../..', __FILE__)
+  end
+
+  attr_reader :suites
+
+  def initialize(suites)
+    @suites = suites.map do |suite|
+      Suite.new(
+        suite['name'],
+        suite['desc'],
+        suite['rvm_version'],
+        suite['ruby_id'],
+        suite['env'],
+        suite['travis']
+      )
+    end
+  end
+
+  def each_matching_suite(&block)
+    suites.
+      select { |suite| suite.matching_current_ruby_version? }.
+      each(&block)
+  end
+
+  def to_travis_config
+    inclusions = []
+    allowed_failures = []
+
+    sorted_suites = suites.sort_by { |suite| [suite.rvm_version, suite.name] }
+
+    sorted_suites.each do |suite|
+      env = suite.travis['env'].merge('SUITE' => suite.name)
+      row = {
+        'rvm' => suite.rvm_version,
+        'env' => env.map { |key, val| "#{key}=#{val.inspect}" }
+      }
+      inclusions << row
+      if suite.rvm_version == 'jruby-19mode'
+        allowed_failures << row
+      end
+    end
+    {
+      'language' => 'ruby',
+      'script' => 'rake spec:${SUITE}',
+      'rvm' => '1.9.3',
+      'matrix' => {
+        # exclude default row
+        'exclude' => [
+          {'rvm' => '1.9.3'},
+        ],
+        'include' => inclusions,
+        'allow_failures' => allowed_failures
+      }
+    }
+  end
+
+  def generate_travis_config
+    config = to_travis_config
+    File.open(TRAVIS_CONFIG_FILE, 'w') {|f| YAML.dump(config, f) }
+    puts "Updated .travis.yml."
+  end
+end

data/spec/spec_suite_runner.rb

@@ -0,0 +1,47 @@
+class SpecSuiteRunner
+  attr_reader :suite
+
+  def initialize(suite)
+    @suite = suite
+  end
+
+  def call
+    command = build_command
+    if ENV['RR_DEBUG']
+      puts "Running: #{command}"
+    end
+    execute_command(command)
+  end
+
+  private
+
+  def execute_command(command)
+    system(command)
+    status = $?.exitstatus
+    OpenStruct.new(:success? => (status == 0))
+  end
+
+  def build_command
+    parts = ['env'] + build_env_pairs + ['ruby'] + build_file_list
+    parts.join(" ")
+  end
+
+  def build_env_pairs
+    # If `bundle exec rake` is run instead of just `rake`, Bundler will set
+    # RUBYOPT to "-I <path to bundler> -r bundler/setup". This is unfortunate as
+    # it causes Bundler to be loaded before we load Bundler in
+    # RR::Test.setup_test_suite, thereby rendering our second Bundler.setup a
+    # no-op.
+    env = suite.env.merge(
+      'BUNDLE_BIN_PATH' => '',
+      'BUNDLE_GEMFILE' => '',
+      'RUBYOPT' => '',
+      'ADAPTER' => suite.name
+    )
+    env.map { |key, val| "#{key}=\"#{val}\"" }
+  end
+
+  def build_file_list
+    Dir[ File.expand_path("../suites/#{suite.name}/{.,*,**}/*_spec.rb", __FILE__) ]
+  end
+end

data/spec/suites.yml

@@ -0,0 +1,10 @@
+19:
+  rvm_versions:
+    - name: 1.9.3
+    - name: 2.0.0
+    - name: jruby-19mode
+  suites:
+    - name: rspec_2
+      desc: 'RSpec 2'
+  env:
+    SPEC_OPTS: '--require $PWD/spec/custom_formatter_for_rspec_2 --format CustomFormatterForRSpec2 --backtrace'

data/spec/suites/rspec_2/functional/any_instance_of_spec.rb

@@ -0,0 +1,147 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe 'any_instance_of' do
+  context 'stubs for instance methods of a class' do
+    context 'via block form' do
+      context 'for existing methods' do
+        it "can be defined" do
+          a_class = Class.new { def some_method; 'value'; end }
+          any_instance_of(a_class) { |c| stub(c).some_method { 'value' } }
+          instance = a_class.new
+          expect(instance.some_method).to eq 'value'
+        end
+
+        it "can be reset" do
+          a_class = Class.new { def some_method; 'original value'; end }
+          any_instance_of(a_class) { |c| stub(c).some_method { 'value' } }
+          RR.reset
+          instance = a_class.new
+          expect(instance.some_method).to eq 'original value'
+        end
+      end
+
+      context 'for non-existing methods' do
+        it "can be defined" do
+          a_class = Class.new
+          any_instance_of(a_class) { |c| stub(c).some_method { 'value' } }
+          instance = a_class.new
+          expect(instance.some_method).to eq 'value'
+        end
+
+        it "can be reset" do
+          a_class = Class.new
+          any_instance_of(a_class) { |c| stub(c).some_method { 'value' } }
+          RR.reset
+          instance = a_class.new
+          expect(instance).not_to respond_to(:some_method)
+        end
+      end
+    end
+
+    context 'via hash form' do
+      context 'for existing methods' do
+        it "can be defined" do
+          a_class = Class.new { def some_method; 'value'; end }
+          any_instance_of(a_class, :some_method => lambda { 'value' })
+          instance = a_class.new
+          expect(instance.some_method).to eq 'value'
+        end
+
+        it "can be reset" do
+          a_class = Class.new { def some_method; 'original value'; end }
+          any_instance_of(a_class, :some_method => lambda { 'value' })
+          RR.reset
+          instance = a_class.new
+          expect(instance.some_method).to eq 'original value'
+        end
+      end
+
+      context 'for non-existing methods' do
+        it "can be defined" do
+          a_class = Class.new
+          any_instance_of(a_class, :some_method => lambda { 'value' })
+          instance = a_class.new
+          expect(instance.some_method).to eq 'value'
+        end
+
+        it "can be reset" do
+          a_class = Class.new
+          any_instance_of(a_class, :some_method => lambda { 'value' })
+          RR.reset
+          instance = a_class.new
+          expect(instance).not_to respond_to(:some_method)
+        end
+      end
+    end
+  end
+
+  context 'stub-proxies for instance methods of a class' do
+    it "can be defined" do
+      a_class = Class.new { def some_method; 'value'; end }
+      any_instance_of(a_class) { |c| stub.proxy(c).some_method { 'value' } }
+      instance = a_class.new
+      expect(instance.some_method).to eq 'value'
+    end
+
+    it "can be reset" do
+      a_class = Class.new { def some_method; 'original value'; end }
+      any_instance_of(a_class) { |c| stub.proxy(c).some_method { 'value' } }
+      RR.reset
+      instance = a_class.new
+      expect(instance.some_method).to eq 'original value'
+    end
+  end
+
+  context 'mocks for instance methods of a class' do
+    context 'for existing methods' do
+      it "can be defined" do
+        a_class = Class.new { def some_method; 'value'; end }
+        any_instance_of(a_class) { |c| mock(c).some_method { 'value' } }
+        instance = a_class.new
+        expect(instance.some_method).to eq 'value'
+      end
+
+      it "can be reset" do
+        a_class = Class.new { def some_method; 'original value'; end }
+        any_instance_of(a_class) { |c| mock(c).some_method { 'value' } }
+        RR.reset
+        instance = a_class.new
+        expect(instance.some_method).to eq 'original value'
+      end
+    end
+
+    context 'for non-existing methods' do
+      it "can be defined" do
+        a_class = Class.new
+        any_instance_of(a_class) { |c| mock(c).some_method { 'value' } }
+        instance = a_class.new
+        expect(instance.some_method).to eq 'value'
+      end
+
+      it "can be reset" do
+        a_class = Class.new
+        any_instance_of(a_class) { |c| mock(c).some_method { 'value' } }
+        RR.reset
+        instance = a_class.new
+        expect(instance).not_to respond_to(:some_method)
+      end
+    end
+  end
+
+  context 'mock-proxies for instance methods of a class' do
+    it "can be defined" do
+      a_class = Class.new { def some_method; 'value'; end }
+      any_instance_of(a_class) { |c| mock.proxy(c).some_method { 'value' } }
+      instance = a_class.new
+      expect(instance.some_method).to eq 'value'
+    end
+
+    it "can be reset" do
+      a_class = Class.new { def some_method; 'original value'; end }
+      any_instance_of(a_class) { |c| mock.proxy(c).some_method { 'value' } }
+      RR.reset
+      instance = a_class.new
+      expect(instance.some_method).to eq 'original value'
+    end
+  end
+end

data/spec/suites/rspec_2/functional/dont_allow_spec.rb

@@ -0,0 +1,17 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe 'dont_allow', is_mock: true, is_dont_allow: true do
+  include MockDefinitionCreatorHelpers
+
+  context 'against instance methods', method_type: :instance do
+    include_context 'tests for a double definition creator method that supports dont_allow'
+  end
+
+  context 'against class methods', method_type: :class do
+    include_context 'tests for a double definition creator method that supports dont_allow'
+  end
+
+  def double_definition_creator_for(object, &block)
+    dont_allow(object, &block)
+  end
+end

data/spec/suites/rspec_2/functional/mock_bang_spec.rb

@@ -0,0 +1,20 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe 'mock!' do
+  it "is a terser way of creating an object and mocking it" do
+    object = mock!.some_method { 'value' }.subject
+    expect(object.some_method).to eq 'value'
+  end
+
+  it "can be used inside the implementation block of a double" do
+    object = Object.new
+    stub(object).some_method { mock!.another_method { 'value' } }
+    expect(object.some_method.another_method).to eq 'value'
+  end
+
+  it "can be called on a double" do
+    object = Object.new
+    stub(object).some_method.mock!.another_method { 'value' }
+    expect(object.some_method.another_method).to eq 'value'
+  end
+end

data/spec/suites/rspec_2/functional/mock_instance_of_spec.rb

@@ -0,0 +1,14 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+permutations =
+  %w(mock instance_of).permutation.map { |parts| parts.join('.') }
+
+permutations.each do |permutation|
+  describe permutation, is_mock: true, is_instance_of: true do
+    include_context 'mock + instance_of'
+
+    define_method(:double_definition_creator_for) do |object, &block|
+      eval(permutation + '(object, &block)')
+    end
+  end
+end

data/spec/suites/rspec_2/functional/mock_instance_of_strong_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+permutations =
+  %w(mock instance_of strong).permutation.to_a.
+  map { |parts| parts.join('.') }
+
+permutations.each do |permutation|
+  describe permutation, is_mock: true, is_instance_of: true, is_strong: true do
+    include_context 'mock + instance_of + strong'
+
+    define_method(:double_definition_creator_for) do |object, &block|
+      eval(permutation + '(object, &block)')
+    end
+  end
+end