shoulda 3.5.0 → 3.6.0

data/test/support/acceptance/helpers/active_model_helpers.rb

@@ -0,0 +1,11 @@
+require_relative 'gem_helpers'
+
+module AcceptanceTests
+  module ActiveModelHelpers
+    include GemHelpers
+
+    def active_model_version
+      bundle_version_of('activemodel')
+    end
+  end
+end

data/test/support/acceptance/helpers/array_helpers.rb

@@ -0,0 +1,13 @@
+module AcceptanceTests
+  module ArrayHelpers
+    def to_sentence(array)
+      if array.size == 1
+        array[0]
+      elsif array.size == 2
+        array.join(' and ')
+      else
+        to_sentence(array[1..-2].join(', '), [array[-1]])
+      end
+    end
+  end
+end

data/test/support/acceptance/helpers/base_helpers.rb

@@ -0,0 +1,14 @@
+require_relative '../../tests/bundle'
+require_relative '../../tests/filesystem'
+
+module AcceptanceTests
+  module BaseHelpers
+    def fs
+      @_fs ||= Tests::Filesystem.new
+    end
+
+    def bundle
+      @_bundle ||= Tests::Bundle.new
+    end
+  end
+end

data/test/support/acceptance/helpers/command_helpers.rb

@@ -0,0 +1,54 @@
+require_relative 'base_helpers'
+require_relative '../../tests/command_runner'
+
+module AcceptanceTests
+  module CommandHelpers
+    include BaseHelpers
+
+    def run_command(*args)
+      Tests::CommandRunner.run(*args) do |runner|
+        runner.directory = fs.project_directory
+        yield runner if block_given?
+      end
+    end
+
+    def run_command!(*args)
+      run_command(*args) do |runner|
+        runner.run_successfully = true
+        yield runner if block_given?
+      end
+    end
+
+    def run_command_within_bundle(*args)
+      run_command(*args) do |runner|
+        runner.command_prefix = 'bundle exec'
+        runner.env['BUNDLE_GEMFILE'] = fs.find_in_project('Gemfile').to_s
+
+        runner.around_command do |run_command|
+          Bundler.with_clean_env(&run_command)
+        end
+
+        yield runner if block_given?
+      end
+    end
+
+    def run_command_within_bundle!(*args)
+      run_command_within_bundle(*args) do |runner|
+        runner.run_successfully = true
+        yield runner if block_given?
+      end
+    end
+
+    def run_rake_tasks(*tasks)
+      options = tasks.last.is_a?(Hash) ? tasks.pop : {}
+      args = ['bundle', 'exec', 'rake', *tasks, '--trace'] + [options]
+      run_command(*args)
+    end
+
+    def run_rake_tasks!(*tasks)
+      options = tasks.last.is_a?(Hash) ? tasks.pop : {}
+      args = ['bundle', 'exec', 'rake', *tasks, '--trace'] + [options]
+      run_command!(*args)
+    end
+  end
+end

data/test/support/acceptance/helpers/file_helpers.rb

@@ -0,0 +1,19 @@
+require_relative 'base_helpers'
+
+module AcceptanceTests
+  module FileHelpers
+    include BaseHelpers
+
+    def append_to_file(path, content, options = {})
+      fs.append_to_file(path, content, options)
+    end
+
+    def remove_from_file(path, pattern)
+      fs.remove_from_file(path, pattern)
+    end
+
+    def write_file(path, content)
+      fs.write(path, content)
+    end
+  end
+end

data/test/support/acceptance/helpers/gem_helpers.rb

@@ -0,0 +1,31 @@
+require_relative 'base_helpers'
+require_relative 'command_helpers'
+require_relative 'file_helpers'
+
+module AcceptanceTests
+  module GemHelpers
+    include BaseHelpers
+    include CommandHelpers
+    include FileHelpers
+
+    def add_gem(gem, *args)
+      bundle.add_gem(gem, *args)
+    end
+
+    def install_gems
+      bundle.install_gems
+    end
+
+    def updating_bundle(&block)
+      bundle.updating(&block)
+    end
+
+    def bundle_version_of(gem)
+      bundle.version_of(gem)
+    end
+
+    def bundle_includes?(gem)
+      bundle.includes?(gem)
+    end
+  end
+end

data/test/support/acceptance/helpers/pluralization_helpers.rb

@@ -0,0 +1,13 @@
+module AcceptanceTests
+  module PluralizationHelpers
+    def pluralize(count, singular_version, plural_version = nil)
+      plural_version ||= singular_version + 's'
+
+      if count == 1
+        "#{count} #{singular_version}"
+      else
+        "#{count} #{plural_version}"
+      end
+    end
+  end
+end

data/test/support/acceptance/helpers/step_helpers.rb

@@ -0,0 +1,69 @@
+require_relative 'file_helpers'
+require_relative 'gem_helpers'
+
+module AcceptanceTests
+  module StepHelpers
+    include FileHelpers
+    include GemHelpers
+
+    def add_shoulda_to_project(options = {})
+      AddShouldaToProject.call(options)
+    end
+
+    def add_minitest_to_project
+      add_gem 'minitest-reporters'
+
+      append_to_file 'test/test_helper.rb', <<-FILE
+        require 'minitest/autorun'
+        require 'minitest/reporters'
+
+        Minitest::Reporters.use!(Minitest::Reporters::SpecReporter.new)
+      FILE
+    end
+
+    def run_n_unit_tests(*paths)
+      run_command_within_bundle 'ruby -I lib -I test', *paths
+    end
+
+    def run_n_unit_test_suite
+      run_rake_tasks('test', env: { TESTOPTS: '-v' })
+    end
+
+    def create_rails_application
+      fs.clean
+      rails_new
+      remove_unnecessary_gems
+      add_minitest_reporters_to_test_helper
+    end
+
+    private
+
+    def rails_new
+      command = "bundle exec rails new #{fs.project_directory} --skip-bundle --no-rc"
+
+      run_command!(command) do |runner|
+        runner.directory = nil
+      end
+
+      command
+    end
+
+    def remove_unnecessary_gems
+      updating_bundle do |bundle|
+        bundle.remove_gem 'turn'
+        bundle.remove_gem 'coffee-rails'
+        bundle.remove_gem 'uglifier'
+        bundle.remove_gem 'debugger'
+        bundle.remove_gem 'byebug'
+        bundle.remove_gem 'web-console'
+      end
+    end
+
+    def add_minitest_reporters_to_test_helper
+      fs.append_to_file 'test/test_helper.rb', <<-TEXT
+require 'minitest/reporters'
+Minitest::Reporters.use!(Minitest::Reporters::SpecReporter.new)
+      TEXT
+    end
+  end
+end

data/test/support/acceptance/matchers/have_output.rb

@@ -0,0 +1,31 @@
+module AcceptanceTests
+  module Matchers
+    def have_output(output)
+      HaveOutputMatcher.new(output)
+    end
+
+    class HaveOutputMatcher
+      def initialize(output)
+        @output = output
+      end
+
+      def matches?(runner)
+        @runner = runner
+        runner.has_output?(output)
+      end
+
+      def failure_message
+        "Expected command to have output, but did not.\n\n" +
+          "Command: #{runner.formatted_command}\n\n" +
+          "Expected output:\n" +
+          output.inspect + "\n\n" +
+          "Actual output:\n" +
+          runner.output
+      end
+
+      protected
+
+      attr_reader :output, :runner
+    end
+  end
+end

data/test/support/acceptance/matchers/indicate_number_of_tests_was_run_matcher.rb

@@ -0,0 +1,54 @@
+require_relative '../helpers/pluralization_helpers'
+
+module AcceptanceTests
+  module Matchers
+    def indicate_number_of_tests_was_run(expected_output)
+      IndicateNumberOfTestsWasRunMatcher.new(expected_output)
+    end
+
+    class IndicateNumberOfTestsWasRunMatcher
+      include PluralizationHelpers
+
+      def initialize(number)
+        @number = number
+      end
+
+      def matches?(runner)
+        @runner = runner
+        expected_output === actual_output
+      end
+
+      def failure_message
+        message = "Expected output to indicate that #{some_tests_were_run}.\n" +
+          "Expected output: #{expected_output}\n"
+
+        message <<
+          if actual_output.empty?
+            'Actual output: (empty)'
+          else
+            "Actual output:\n#{actual_output}"
+          end
+
+        message
+      end
+
+      protected
+
+      attr_reader :number, :runner
+
+      private
+
+      def expected_output
+        /#{number} (?:tests?|runs?|examples?)(?:, #{number} assertions)?, 0 failures(?:, 0 errors(?:, 0 skips)?)?/
+      end
+
+      def actual_output
+        runner.output
+      end
+
+      def some_tests_were_run
+        pluralize(number, 'test was', 'tests were') + ' run'
+      end
+    end
+  end
+end

data/test/support/acceptance/matchers/indicate_that_tests_were_run_matcher.rb

@@ -0,0 +1,75 @@
+require_relative '../helpers/array_helpers'
+require_relative '../helpers/pluralization_helpers'
+
+module AcceptanceTests
+  module Matchers
+    def indicate_that_tests_were_run(series)
+      IndicateThatTestsWereRunMatcher.new(series)
+    end
+
+    class IndicateThatTestsWereRunMatcher
+      include ArrayHelpers
+      include PluralizationHelpers
+
+      def initialize(args)
+        @args = args
+        @series = args.values
+      end
+
+      def matches?(runner)
+        @runner = runner
+        !matching_expected_output.nil?
+      end
+
+      def failure_message
+        "Expected output to indicate that #{some_tests_were_run}.\n" +
+          "#{formatted_expected_output}\n" +
+          "#{formatted_actual_output}\n"
+      end
+
+      protected
+
+      attr_reader :args, :series, :runner
+
+      private
+
+      def matching_expected_output
+        @_matching_expected_output ||=
+          actual_output =~ expected_output
+      end
+
+      def expected_output
+        total = series.inject(:+)
+        /#{total} (tests|runs), #{total} assertions, 0 failures, 0 errors(, 0 skips)?/
+      end
+
+      def formatted_expected_output
+        if matching_expected_output
+          "Expected output:\n#{matching_actual_output}"
+        else
+          'Expected output: (n/a)'
+        end
+      end
+
+      def actual_output
+        runner.output
+      end
+
+      def formatted_actual_output
+        if actual_output.empty?
+          'Actual output: (empty)'
+        else
+          "Actual output:\n#{actual_output}"
+        end
+      end
+
+      def some_tests_were_run
+        clauses = args.map do |type, number|
+          pluralize(number, "#{type} test was run", "#{type} tests were run")
+        end
+
+        to_sentence(clauses)
+      end
+    end
+  end
+end

data/test/support/tests/bundle.rb

@@ -0,0 +1,94 @@
+require_relative 'filesystem'
+require_relative 'command_runner'
+require_relative 'version'
+
+module Tests
+  class Bundle
+    def initialize
+      @already_updating = false
+      @fs = Filesystem.new
+    end
+
+    def updating
+      if already_updating?
+        yield self
+        return
+      end
+
+      @already_updating = true
+
+      yield self
+
+      @already_updating = false
+
+      install_gems
+    end
+
+    def add_gem(gem, *args)
+      updating do
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        version = args.shift
+        line = assemble_gem_line(gem, version, options)
+        fs.append_to_file('Gemfile', line)
+      end
+    end
+
+    def remove_gem(gem)
+      updating do
+        fs.comment_lines_matching('Gemfile', /^[ ]*gem ("|')#{gem}\1/)
+      end
+    end
+
+    def install_gems
+      CommandRunner.run!('bundle install --local') do |runner|
+        runner.retries = 5
+      end
+    end
+
+    def version_of(gem)
+      Version.new(Bundler.definition.specs[gem][0].version)
+    end
+
+    def includes?(gem)
+      Bundler.definition.dependencies.any? do |dependency|
+        dependency.name == gem
+      end
+    end
+
+    protected
+
+    attr_reader :fs
+
+    private
+
+    def already_updating?
+      @already_updating
+    end
+
+    def assemble_gem_line(gem, version, options)
+      formatted_options = options.
+        map { |key, value| "#{key}: #{formatted_value(value)}" }.
+        join(', ')
+
+      line = %(gem '#{gem}')
+
+      if version
+        line << %(, '#{version}')
+      end
+
+      if options.any?
+        line << %(, #{formatted_options})
+      end
+
+      line << "\n"
+    end
+
+    def formatted_value(value)
+      if value.is_a?(Pathname)
+        value.to_s.inspect
+      else
+        value.inspect
+      end
+    end
+  end
+end