shoulda-context 1.2.2 → 2.0.0

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    shoulda-context (2.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.0)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    jaro_winkler (1.5.4)
+    m (1.5.1)
+      method_source (>= 0.6.7)
+      rake (>= 0.9.2.2)
+    method_source (0.9.2)
+    minitest (5.14.0)
+    mocha (1.11.2)
+    parallel (1.19.1)
+    parser (2.7.1.0)
+      ast (~> 2.4.0)
+    power_assert (1.1.7)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rubocop (0.71.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    snowglobe (0.3.0)
+    test-unit (3.3.5)
+      power_assert
+    thor (1.0.1)
+    unicode-display_width (1.6.1)
+    warnings_logger (0.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  bundler (~> 1.0)
+  byebug
+  m
+  minitest
+  mocha
+  pry (~> 0.12.0)
+  pry-byebug (~> 3.6.0)
+  rake
+  rubocop (= 0.71.0)
+  shoulda-context!
+  snowglobe (>= 0.3.0)
+  test-unit
+  warnings_logger
+
+BUNDLED WITH
+   1.17.3

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2006-2013, Tammer Saleh, thoughtbot, inc.
+Copyright (c) 2006-2020, Tammer Saleh and thoughtbot, inc.
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/README.md

@@ -1,22 +1,35 @@
-# shoulda-context [![Gem Version](https://badge.fury.io/rb/shoulda-context.png)](http://badge.fury.io/rb/shoulda-context) [![Build Status](https://travis-ci.org/thoughtbot/shoulda-context.png?branch=master)](https://travis-ci.org/thoughtbot/shoulda-context)
+# Shoulda Context [![Gem Version][version-badge]][rubygems] [![Build Status][travis-badge]][travis] ![Downloads][downloads-badge] [![Hound][hound-badge]][hound]
 
-[Official Documentation](http://rubydoc.info/github/thoughtbot/shoulda-context/master/frames)
+[version-badge]: https://img.shields.io/gem/v/shoulda-context.svg
+[rubygems]: https://rubygems.org/gems/shoulda-matchers
+[travis-badge]: https://img.shields.io/travis/thoughtbot/shoulda-context/master.svg
+[travis]: https://travis-ci.org/thoughtbot/shoulda-context
+[downloads-badge]: https://img.shields.io/gem/dtv/shoulda-context.svg
+[hound-badge]: https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg
+[hound]: https://houndci.com
 
-Shoulda's contexts make it easy to write understandable and maintainable tests for Test::Unit.
-It's fully compatible with your existing tests in Test::Unit, and requires no retooling to use.
+Shoulda Context makes it easy to write understandable and maintainable tests
+under Minitest and Test::Unit within Rails projects or plain Ruby projects. It's
+fully compatible with your existing tests and requires no retooling to use.
 
-Refer to the [shoulda](https://github.com/thoughtbot/shoulda) gem if you want to know more
-about using shoulda with Rails or RSpec.
+## Quick links
 
-## Contexts
+📖 **[Read the documentation for the latest version.][rubydocs]**  
+📢 **[See what's changed in recent versions.][changelog]**
 
-Instead of writing Ruby methods with `lots_of_underscores`, shoulda-context adds
-context, setup, and should blocks...
+[rubydocs]: http://rubydoc.info/github/thoughtbot/shoulda-context/master/frames
+[changelog]: CHANGELOG.md
 
-```ruby
-require "test/unit"
+## Usage
+
+Instead of writing Ruby methods with `lots_of_underscores`, Shoulda Context lets
+you name your tests and group them together using English.
+
+At a minimum, the gem provides some convenience layers around core Minitest /
+Test::Unit functionality. For instance, this test case:
 
-class CalculatorTest < Test::Unit::TestCase
+```ruby
+class CalculatorTest < Minitest::Test
   context "a calculator" do
     setup do
       @calculator = Calculator.new
@@ -33,35 +46,133 @@ class CalculatorTest < Test::Unit::TestCase
 end
 ```
 
-... which combine to produce the following test methods:
+turns into:
+
+```ruby
+class CalculatorTest < Minitest::Test
+  def setup
+    @calculator = Calculator.new
+  end
+
+  define_method "test_: a calculator should add two numbers for the sum" do
+    assert_equal 4, @calculator.sum(2, 2)
+  end
+
+  define_method "test_: a calculator should multiply two numbers for the product" do
+    assert_equal 10, @calculator.product(2, 5)
+  end
+end
+```
+
+However, Shoulda Context also provides functionality apart from Minitest /
+Test::Unit that allows you to shorten tests drastically by making use of
+RSpec-compatible matchers. For instance, with [Shoulda
+Matchers][shoulda-matchers] you can write such tests as:
 
-    "test: a calculator should add two numbers for the sum."
-    "test: a calculator should multiply two numbers for the product."
+```ruby
+class User < ActiveSupport::TestCase
+  context "validations" do
+    subject { FactoryBot.build(:user) }
+
+    should validate_presence_of(:first_name)
+    should validate_presence_of(:last_name)
+    should validate_uniqueness_of(:email)
+    should_not allow_value('weird').for(:email)
+  end
+end
+```
 
-When running a single test method via (example from a Rails context):
+[shoulda-matchers]: https://github.com/thoughtbot/shoulda-matchers
 
-    ruby -I"lib:test" path_to_test_file -n name_of_the_test_method
+## API
 
-you should include a trailing space(!), e.g.,
+### DSL
 
-    ruby -I"lib:test" path_to_test_file -n "test: a calculator should add two numbers for the sum. "
+The primary method in Shoulda Context's API is `context`, which declares a group
+of a tests.
 
+These methods are available inside of a `context`:
 
-## Assertions
+* `setup` — a DSL-y alternative to defining a `setup` method
+* `teardown` — a DSL-y alternative to defining a `teardown` method
+* `should` — There are two forms:
+  1. when passed a name + block, creates a test equivalent to defining a
+  `test_` method
+  2. when passed a matcher, creates a test that will run the matcher, asserting
+  that it passes
+* `should_not` — like the matcher version of `should`, but creates a test that
+  asserts that the matcher fails
+* `should_eventually` — allows you to temporarily skip tests
+* `context` — creates a subcontext
 
-It also has two additional Test::Unit assertions for working with Ruby's Array:
+These methods are available within a test case class, but outside of a
+`context`:
 
-    assert_same_elements([:a, :b, :c], [:c, :a, :b])
-    assert_contains(['a', '1'], /\d/)
-    assert_contains(['a', '1'], 'a')
+* `should` — same as above
+* `should_not` — same as above
+* `should_eventually` — same as above
+* `described_type` — returns the class being tested, as determined by the class
+  name of the outermost class
+* `subject` — lets you define an object that is the primary focus of the tests
+  within a context; this is most useful when using a matcher as the matcher will
+  make use of this as _its_ subject
+
+And these methods are available inside of a test (whether defined via a method
+or via `should`):
+
+* `subject` — an instance of the class under test, which is derived
+  automatically from the name of the test case class but is overridable via the
+  class method version of `subject` above
+
+### Assertions
+
+In addition to the main API, the gem also provides some extra assertions that
+may be of use:
+
+* `assert_same_elements` — compares two arrays for equality, but ignoring
+  ordering
+* `assert_contains` — asserts that an array has an item
+* `assert_does_not_contain` — the opposite of `assert_contains`
+* `assert_accepts` — what `should` uses internally; asserts that a matcher
+  object matches against a value
+* `assert_reject` — what `should_not` uses internally; asserts that a matcher
+  object does not match against a value
+
+## Note on running tests
+
+Normally, you will run a single test like this:
+
+    ruby -I lib -I test path_to_test.rb -n name_of_test_method
+
+When using Shoulda Context, however, you'll need to put a space after the test
+name:
+
+    ruby -I lib -I test path_to_test.rb -n "test_: a calculator should add two numbers for the sum. "
+
+If this is too cumbersome, consider using the [m] gem to run tests instead:
+
+    m path_to_test.rb:39
+
+[m]: https://github.com/qrush/m
+
+## Compatibility
+
+Shoulda Context is tested and supported against Rails 4.x+, Minitest 4.x,
+Test::Unit 3.x, and Ruby 2.4+.
 
 ## Credits
 
-Shoulda is maintained and funded by [thoughtbot](http://thoughtbot.com/community).
-shoulda-context is maintained by [Travis Jeffery](https://github.com/travisjeffery).
-Thank you to all the [contributors](https://github.com/thoughtbot/shoulda-context/contributors).
+Shoulda Context is maintained by [Elliot Winkler][elliot-winkler], [Travis
+Jeffery][travis-jeffery], and thoughtbot. Thank you to all the [contributors].
+
+[elliot-winkler]: https://github.com/mcmire
+[travis-jeffery]: https://github.com/travisjeffery
+[contributors]: https://github.com/thoughtbot/shoulda-context/contributors
 
 ## License
 
-Shoulda is Copyright © 2006-2016 thoughtbot, inc.
-It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.
+Shoulda Context is copyright © 2006-2020 [thoughtbot, inc][thoughtbot-website].
+It is free software, and may be redistributed under the terms specified in the
+[MIT-LICENSE](MIT-LICENSE) file.
+
+[thoughtbot-website]: https://thoughtbot.com

data/Rakefile

@@ -1,21 +1,26 @@
-require 'bundler/setup'
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-require 'appraisal'
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "pry-byebug"
 
-$LOAD_PATH.unshift("lib")
-load 'tasks/shoulda.rake'
+require_relative "test/support/current_bundle"
+
+load "tasks/shoulda.rake"
 
 Rake::TestTask.new do |t|
-  t.libs << 'lib' << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
+  t.libs << "test"
+  t.ruby_opts += ["-w"]
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
 end
 
-desc 'Test the plugin under all supported Rails versions.'
-task :all => ['appraisal:cleanup', 'appraisal:install'] do
-  exec('rake appraisal test')
+task :default do
+  if Tests::CurrentBundle.instance.appraisal_in_use?
+    Rake::Task["test"].invoke
+  elsif ENV["CI"]
+    exec "appraisal install && appraisal rake --trace"
+  else
+    appraisal = Tests::CurrentBundle.instance.latest_appraisal
+    exec "appraisal install && appraisal #{appraisal} rake --trace"
+  end
 end
-
-desc 'Default: run tests'
-task :default => [:all]

data/bin/install_gems_in_all_appraisals

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+set -euo pipefail
+
+SUPPORTED_VERSIONS=$(bin/supported_ruby_versions)
+
+install-gems-for-version() {
+  local version="$1"
+  (export RBENV_VERSION=$version; bundle && bundle exec appraisal install)
+}
+
+for version in $SUPPORTED_VERSIONS; do
+  echo
+  echo "*** Installing gems for $version ***"
+  install-gems-for-version $version
+done

data/bin/run_all_tests

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+set -euo pipefail
+
+SUPPORTED_VERSIONS=$(bin/supported_ruby_versions)
+
+run-tests-for-version() {
+  local version="$1"
+  (export RBENV_VERSION=$version; bundle exec rake)
+}
+
+for version in $SUPPORTED_VERSIONS; do
+  echo
+  echo "*** Running tests for $version ***"
+  run-tests-for-version $version
+done

data/bin/setup

@@ -0,0 +1,190 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+RUBY_VERSION=$(bin/supported_ruby_versions | xargs -n 1 echo | sort -V | tail -n 1)
+
+cd "$(dirname "$(dirname "$0")")"
+
+uname=$(uname)
+
+if [[ $uname == 'Darwin' ]]; then
+  platform='mac'
+else
+  platform='linux'
+fi
+
+banner() {
+  echo -e "\033[34m== $@ ==\033[0m"
+}
+
+success() {
+  echo -e "\033[32m$@\033[0m"
+}
+
+warning() {
+  echo -e "\033[33m$@\033[0m"
+}
+
+error() {
+  echo -e "\033[31m$@\033[0m"
+}
+
+has-executable() {
+  type "$1" &>/dev/null
+}
+
+is-running() {
+  pgrep "$1" >/dev/null
+}
+
+install() {
+  local apt_package=""
+  local rpm_package=""
+  local brew_package=""
+  local default_package=""
+  local package=""
+
+  for arg in "$@"; do
+    case $arg in
+      apt=*)
+        apt_package="$arg"
+        ;;
+      rpm=*)
+        rpm_package="$arg"
+        ;;
+      brew=*)
+        brew_package="$arg"
+        ;;
+      *)
+        default_package="$arg"
+        ;;
+    esac
+  done
+
+  if has-executable brew; then
+    package="${brew_package:-$default_package}"
+
+    if [[ -n $package ]]; then
+      brew install "$package"
+    fi
+  elif has-executable apt-get; then
+    package="${apt_package:-$default_package}"
+
+    if [[ -n $package ]]; then
+      sudo apt-get install -y "$package"
+    fi
+  elif has-executable yum; then
+    package="${yum_package:-$default_package}"
+
+    if [[ -n $package ]]; then
+      sudo yum install -y "$package"
+    fi
+  else
+    error "Sorry, I'm not sure how to install $default_package."
+    exit 1
+  fi
+}
+
+check-for-build-tools() {
+  if [[ $platform == "linux" ]]; then
+    if ! has-executable apt-get; then
+      error "You don't seem to have a package manager installed."
+      echo "The setup script assumes you're using Debian or a Debian-derived flavor of Linux"
+      echo "(i.e. something with Apt). If this is not the case, then we would gladly take a"
+      echo "PR fixing this!"
+      exit 1
+    fi
+
+    # TODO: Check if build-essential is installed on Debian?
+  else
+    if ! has-executable brew; then
+      error "You don't seem to have Homebrew installed."
+      echo
+      echo "Follow the instructions here to do this:"
+      echo
+      echo "http://brew.sh"
+      exit 1
+    fi
+
+    # TODO: Check that OS X Command Line Tools are installed?
+  fi
+}
+
+install-development-libraries() {
+  install apt=ruby-dev rpm=ruby-devel
+  install rpm=zlib-devel
+}
+
+install-dependencies() {
+  if ! has-executable sqlite3; then
+    banner 'Installing SQLite 3'
+    install sqlite3
+    install apt=libsqlite3-dev rpm=sqlite-devel
+  fi
+
+  if ! has-executable psql; then
+    banner 'Installing PostgreSQL'
+    install postgresql
+    install apt=libpq-dev rpm=postgresql-devel
+  fi
+
+  if ! is-running postgres; then
+    banner 'Starting PostgreSQL'
+    start postgresql
+  fi
+
+  if ! has-executable heroku; then
+    banner 'Installing Heroku'
+    install heroku/brew/heroku heroku
+  fi
+
+  if has-executable rbenv; then
+    if ! (rbenv versions | grep $RUBY_VERSION'\>' &>/dev/null); then
+      banner "Installing Ruby $RUBY_VERSION with rbenv"
+      rbenv install --skip-existing "$RUBY_VERSION"
+    fi
+  elif has-executable rvm; then
+    if ! (rvm ls | grep $RUBY_VERSION'\>' &>/dev/null); then
+      banner "Installing Ruby $RUBY_VERSION with rvm"
+      error "You don't seem to have Ruby $RUBY_VERSION installed."
+      echo
+      echo "Use RVM to do so, and then re-run this command."
+      echo
+    fi
+  else
+    error "You don't seem to have a Ruby manager installed."
+    echo
+    echo 'We recommend using rbenv. You can find installation instructions here:'
+    echo
+    echo 'http://github.com/rbenv/rbenv'
+    echo
+    echo "When you're done, simply re-run this script!"
+    exit 1
+  fi
+
+  banner 'Installing Ruby dependencies'
+  gem install bundler -v '~> 1.0' --conservative
+  bundle check || bundle install
+  bundle exec appraisal install
+
+  if ! has-executable node; then
+    banner 'Installing Node'
+
+    if [[ $platform == 'linux' ]]; then
+      curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
+
+      install nodejs
+
+      if ! has-executable npm; then
+        install npm
+      fi
+    else
+      install nodejs
+    fi
+  fi
+}
+
+check-for-build-tools
+install-development-libraries
+install-dependencies