shoulda 3.5.0 → 3.6.0

data/test/support/tests/command_runner.rb

@@ -0,0 +1,230 @@
+require 'timeout'
+require 'shellwords'
+
+module Tests
+  class CommandRunner
+    TimeoutError = Class.new(StandardError)
+
+    def self.run(*args)
+      new(*args).tap do |runner|
+        yield runner
+        runner.call
+      end
+    end
+
+    def self.run!(*args)
+      run(*args) do |runner|
+        runner.run_successfully = true
+        yield runner if block_given?
+      end
+    end
+
+    attr_reader :status, :options, :env
+    attr_accessor :command_prefix, :run_quickly, :run_successfully, :retries,
+      :timeout
+
+    def initialize(*args)
+      @reader, @writer = IO.pipe
+      options = (args.last.is_a?(Hash) ? args.pop : {})
+      @args = args
+      @options = options.merge(
+        err: [:child, :out],
+        out: writer,
+      )
+      @env = extract_env_from(@options)
+
+      @wrapper = ->(block) { block.call }
+      @command_prefix = ''
+      self.directory = Dir.pwd
+      @run_quickly = false
+      @run_successfully = false
+      @retries = 1
+      @num_times_run = 0
+      @timeout = 20
+    end
+
+    def around_command(&block)
+      @wrapper = block
+    end
+
+    def directory
+      @options[:chdir]
+    end
+
+    def directory=(directory)
+      @options[:chdir] = directory || Dir.pwd
+    end
+
+    def formatted_command
+      [formatted_env, Shellwords.join(command)].
+        select { |value| !value.empty? }.
+        join(' ')
+    end
+
+    def call
+      possibly_retrying do
+        possibly_running_quickly do
+          run_with_debugging
+
+          if run_successfully && !success?
+            fail!
+          end
+        end
+      end
+
+      self
+    end
+
+    def stop
+      unless writer.closed?
+        writer.close
+      end
+    end
+
+    def output
+      @_output ||= begin
+        stop
+        without_colors(reader.read)
+      end
+    end
+
+    def elided_output
+      lines = output.split(/\n/)
+      new_lines = lines[0..4]
+
+      if lines.size > 10
+        new_lines << "(...#{lines.size - 10} more lines...)"
+      end
+
+      new_lines << lines[-5..-1]
+      new_lines.join("\n")
+    end
+
+    def success?
+      status.success?
+    end
+
+    def exit_status
+      status.exitstatus
+    end
+
+    def fail!
+      raise <<-MESSAGE
+Command #{formatted_command.inspect} exited with status #{exit_status}.
+Output:
+#{divider('START') + output + divider('END')}
+      MESSAGE
+    end
+
+    def has_output?(expected_output)
+      if expected_output.is_a?(Regexp)
+        output =~ expected_output
+      else
+        output.include?(expected_output)
+      end
+    end
+
+    protected
+
+    attr_reader :args, :reader, :writer, :wrapper
+
+    private
+
+    def extract_env_from(options)
+      options.delete(:env) { {} }.inject({}) do |hash, (key, value)|
+        hash[key.to_s] = value
+        hash
+      end
+    end
+
+    def command
+      ([command_prefix] + args).flatten.flat_map do |word|
+        Shellwords.split(word)
+      end
+    end
+
+    def formatted_env
+      env.map { |key, value| "#{key}=#{value.inspect}" }.join(' ')
+    end
+
+    def run
+      pid = spawn(env, *command, options)
+      Process.waitpid(pid)
+      @status = $?
+    end
+
+    def run_with_wrapper
+      wrapper.call(method(:run))
+    end
+
+    def run_with_debugging
+      debug { "\n\e[33mChanging to directory:\e[0m #{directory}" }
+      debug { "\e[32mRunning command:\e[0m #{formatted_command}" }
+
+      run_with_wrapper
+
+      debug { "\n" + divider('START') + output + divider('END') }
+    end
+
+    def possibly_running_quickly(&block)
+      if run_quickly
+        begin
+          Timeout.timeout(timeout, &block)
+        rescue Timeout::Error
+          stop
+
+          message =
+            "Command timed out after #{timeout} seconds: #{formatted_command}\n" +
+            "Output:\n" +
+            output
+
+          raise TimeoutError, message
+        end
+      else
+        yield
+      end
+    end
+
+    def possibly_retrying
+      begin
+        @num_times_run += 1
+        yield
+      rescue => error
+        debug { "#{error.class}: #{error.message}" }
+
+        if @num_times_run < @retries
+          sleep @num_times_run
+          retry
+        else
+          raise error
+        end
+      end
+    end
+
+    def divider(title = '')
+      total_length = 72
+      start_length = 3
+
+      string = ''
+      string << ('-' * start_length)
+      string << title
+      string << '-' * (total_length - start_length - title.length)
+      string << "\n"
+      string
+    end
+
+    def without_colors(string)
+      string.gsub(/\e\[\d+(?:;\d+)?m(.+?)\e\[0m/, '\1')
+    end
+
+    def debugging_enabled?
+      ENV['DEBUG_COMMANDS'] == '1'
+    end
+
+    def debug
+      if debugging_enabled?
+        puts yield
+      end
+    end
+  end
+end

data/test/support/tests/current_bundle.rb

@@ -0,0 +1,61 @@
+require 'bundler'
+require 'appraisal'
+
+module Tests
+  class CurrentBundle
+    AppraisalNotSpecified = Class.new(ArgumentError)
+
+    include Singleton
+
+    def assert_appraisal!
+      unless appraisal_in_use?
+        message = <<EOT
+
+
+Please run tests starting with `appraisal <appraisal_name>`.
+Possible appraisals are: #{available_appraisals}
+
+EOT
+        raise AppraisalNotSpecified, message
+      end
+    end
+
+    def appraisal_in_use?
+      path.dirname == root.join('gemfiles')
+    end
+
+    def current_or_latest_appraisal
+      current_appraisal || latest_appraisal
+    end
+
+    def latest_appraisal
+      available_appraisals.sort.last
+    end
+
+    private
+
+    def available_appraisals
+      appraisals = []
+
+      Appraisal::AppraisalFile.each do |appraisal|
+        appraisals << appraisal.name
+      end
+
+      appraisals
+    end
+
+    def current_appraisal
+      if appraisal_in_use?
+        File.basename(path, '.gemfile')
+      end
+    end
+
+    def path
+      Bundler.default_gemfile
+    end
+
+    def root
+      Pathname.new('../../../..').expand_path(__FILE__)
+    end
+  end
+end

data/test/support/tests/filesystem.rb

@@ -0,0 +1,100 @@
+require 'fileutils'
+
+module Tests
+  class Filesystem
+    PROJECT_NAME = 'test-project'.freeze
+    ROOT_DIRECTORY = Pathname.new('../../../..').expand_path(__FILE__)
+    TEMP_DIRECTORY = ROOT_DIRECTORY.join('tmp/acceptance')
+    PROJECT_DIRECTORY = TEMP_DIRECTORY.join(PROJECT_NAME)
+
+    def root_directory
+      ROOT_DIRECTORY
+    end
+
+    def temp_directory
+      TEMP_DIRECTORY
+    end
+
+    def project_directory
+      PROJECT_DIRECTORY
+    end
+
+    def wrap(path)
+      if path.is_a?(Pathname)
+        path
+      else
+        find_in_project(path)
+      end
+    end
+
+    def within_project(&block)
+      Dir.chdir(project_directory, &block)
+    end
+
+    def clean
+      if temp_directory.exist?
+        temp_directory.rmtree
+      end
+    end
+
+    def create
+      project_directory.mkpath
+    end
+
+    def find_in_project(path)
+      project_directory.join(path)
+    end
+
+    def open(path, *args, &block)
+      find_in_project(path).open(*args, &block)
+    end
+
+    def read(path)
+      find_in_project(path).read
+    end
+
+    def write(path, content)
+      pathname = wrap(path)
+      create_parents_of(pathname)
+      pathname.open('w') { |f| f.write(content) }
+    end
+
+    def create_parents_of(path)
+      wrap(path).dirname.mkpath
+    end
+
+    def append_to_file(path, content, _options = {})
+      create_parents_of(path)
+      open(path, 'a') { |f| f.puts(content + "\n") }
+    end
+
+    def remove_from_file(path, pattern)
+      unless pattern.is_a?(Regexp)
+        pattern = Regexp.new('^' + Regexp.escape(pattern) + '$')
+      end
+
+      transform(path) do |lines|
+        lines.reject { |line| line =~ pattern }
+      end
+    end
+
+    def comment_lines_matching(path, pattern)
+      transform(path) do |lines|
+        lines.map do |line|
+          if line =~ pattern
+            "###{line}"
+          else
+            line
+          end
+        end
+      end
+    end
+
+    def transform(path)
+      content = read(path)
+      lines = content.split(/\n/)
+      transformed_lines = yield lines
+      write(path, transformed_lines.join("\n") + "\n")
+    end
+  end
+end

data/test/support/tests/version.rb

@@ -0,0 +1,45 @@
+module Tests
+  class Version
+    def initialize(version)
+      @version = Gem::Version.new(version.to_s + '')
+    end
+
+    def <(other_version)
+      compare?(:<, other_version)
+    end
+
+    def <=(other_version)
+      compare?(:<=, other_version)
+    end
+
+    def ==(other_version)
+      compare?(:==, other_version)
+    end
+
+    def >=(other_version)
+      compare?(:>=, other_version)
+    end
+
+    def >(other_version)
+      compare?(:>, other_version)
+    end
+
+    def =~(other_version)
+      Gem::Requirement.new(other_version).satisfied_by?(version)
+    end
+
+    def to_s
+      version.to_s
+    end
+
+    protected
+
+    attr_reader :version
+
+    private
+
+    def compare?(op, other_version)
+      Gem::Requirement.new("#{op} #{other_version}").satisfied_by?(version)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+PROJECT_ROOT = Pathname.new('../..').expand_path(__FILE__).freeze
+$LOAD_PATH << File.join(PROJECT_ROOT, 'lib')
+
+require 'pry'
+require 'pry-byebug'
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'shoulda'
+
+Minitest::Reporters.use!(Minitest::Reporters::SpecReporter.new)
+
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :minitest
+  end
+end
+
+$VERBOSE = true