minitest-candy 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5c47c24552004733e311fb281724958f311787ae88b3fd938d241a5e0bc7d013
+  data.tar.gz: 76617ceaf124064e4b73cb3d380be02948e4ad19b080aff18285dc4d2106e82e
+SHA512:
+  metadata.gz: 6b95bf869d8bd92bbb7e068a61ca842c9015526028d324fb0a4d6bb83755b91ad504b1eef4aa7be6b517052388c0b90ae5294bd20f828d2f1d0b1cd9dd212fd0
+  data.tar.gz: 1fc572626856a6c1dc97984d778f38be1c15db1c859882b47fabc9e2ffde3917c4274cfdc8d8107364d68b48bd3f0e081a94a88df663fa9ec59f4f7ea118b3e6

data/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+
+    - name: Run tests
+      run: bundle exec rake test
+
+    - name: Run linter
+      run: bundle exec rake standard

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 13.0"
+gem "standard", "~> 1.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Francesco Rodríguez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+minitest-candy ![CI](https://github.com/frodsan/minitest-candy/actions/workflows/ci.yml/badge.svg)
+==============
+
+Useful helpers for Minitest 5+.
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "minitest-candy"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install minitest-candy
+```
+
+Usage
+-----
+
+```ruby
+require "minitest/autorun"
+require "minitest/candy"
+
+class TruthTest < Minitest::Test
+  # Adds support for `setup` and `teardown` callbacks:
+  setup do
+    @truth = true
+  end
+
+  teardown do
+    @truth = nil
+  end
+
+  # Define a test method using a String. Instead of
+  # `def test_assert_the_truth`, do:
+  test "assert the truth" do
+    assert @truth
+  end
+
+  # Includes extra assertions:
+  test "better assertions" do
+    assert_not false
+    assert_not_equal "1", "2"
+    assert_not_empty [1, 2, 3]
+    assert_nothing_raised do
+      super_secure_method()
+    end
+  end
+end
+```
+
+Contributing
+------------
+
+Fork the project with:
+
+```
+$ git clone git@github.com:frodsan/minitest-candy.git
+```
+
+To install dependencies, use:
+
+```
+$ bundle install
+```
+
+To run the test suite, do:
+
+```
+$ rake test
+```
+
+For bug reports and pull requests use [GitHub][issues].
+
+License
+-------
+
+This gem is released under the [MIT License][mit].
+
+[mit]: http://www.opensource.org/licenses/MIT
+[issues]: https://github.com/frodsan/minitest-candy/issues

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "standard/rake"
+
+task default: :test
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_test.rb"
+  t.warning = true
+end

data/lib/minitest/candy/assertions.rb

@@ -0,0 +1,51 @@
+module Minitest
+  module Candy
+    module Assertions
+      # Public: Asserts that an expression is not truthy. Passes if <tt>object</tt> is
+      # +nil+ or +false+. "Truthy" means "considered true in a conditional" like <tt>if foo</tt>.
+      #
+      # Examples
+      #
+      #   require "minitest/autorun"
+      #   require "minitest/candy"
+      #
+      #   class AssertNotTest < Minitest::Test
+      #     test "assert not" do
+      #       assert_not nil    # => true
+      #       assert_not false  # => true
+      #       assert_not 'foo'  # => Expected "foo" to be nil or false
+      #     end
+      #   end
+      #
+      # An error message can be specified.
+      #
+      #   assert_not foo, 'foo should be false'
+      #
+      def assert_not(object, message = nil)
+        message ||= "Expected #{mu_pp(object)} to be nil or false"
+        assert !object, message
+      end
+
+      # Public: Asserts that the given block does not raise an exception.
+      #
+      # Examples
+      #
+      #   require "minitest/autorun"
+      #   require "minitest/candy"
+      #
+      #   class AssertNotTest < Minitest::Test
+      #     test "should not raise an exception" do
+      #       assert_nothing_raised do
+      #         perform_safe_operation()
+      #       end
+      #     end
+      #   end
+      #
+      def assert_nothing_raised
+        yield
+      rescue => error
+        raise Minitest::UnexpectedError.new(error)
+      end
+    end
+  end
+end

data/lib/minitest/candy/callbacks.rb

@@ -0,0 +1,59 @@
+module Minitest
+  module Candy
+    module Callbacks
+      # Public: Helper to define a +setup+ method.
+      #
+      # Examples
+      #
+      #   require "minitest/autorun"
+      #   require "minitest/candy"
+      #
+      #   class TruthTest < Minitest::Test
+      #     setup do
+      #       @truth = true
+      #     end
+      #
+      #     test "assert the truth" do
+      #       assert @truth
+      #     end
+      #   end
+      #
+      def setup(&block)
+        define_method(:setup) do
+          super()
+
+          instance_exec(&block)
+        end
+      end
+
+      # Public: Helper to define a +teardown+ method.
+      #
+      # Examples
+      #
+      #   require "minitest/autorun"
+      #   require "minitest/candy"
+      #
+      #   class TruthTest < Minitest::Test
+      #     setup do
+      #       @truth = true
+      #     end
+      #
+      #     teardown do
+      #       @truth = nil
+      #     end
+      #
+      #     test "assert the truth" do
+      #       assert @truth
+      #     end
+      #   end
+      #
+      def teardown(&block)
+        define_method(:teardown) do
+          instance_exec(&block)
+
+          super()
+        end
+      end
+    end
+  end
+end

data/lib/minitest/candy/declarative.rb

@@ -0,0 +1,28 @@
+module Minitest
+  module Candy
+    module Declarative
+      # Public: Helper to define a test method using a String.
+      #
+      # Examples
+      #
+      #   require "minitest/autorun"
+      #   require "minitest/candy"
+      #
+      #   class TruthTest < Minitest::Test
+      #     test "assert the truth" do
+      #       assert true
+      #     end
+      #   end
+      #
+      def test(name, &block)
+        test_name = sprintf("test_%s", name.gsub(/\s+/, "_"))
+
+        if method_defined?(test_name)
+          raise "#{ test_name } is already defined in #{ self }"
+        end
+
+        define_method(test_name, &block)
+      end
+    end
+  end
+end

data/lib/minitest/candy/version.rb

@@ -0,0 +1,5 @@
+module Minitest
+  module Candy
+    VERSION = "1.0.0"
+  end
+end

data/lib/minitest/candy.rb

@@ -0,0 +1,27 @@
+require_relative "candy/declarative"
+require_relative "candy/callbacks"
+require_relative "candy/assertions"
+
+module Minitest
+  class Test
+    extend Minitest::Candy::Declarative
+    extend Minitest::Candy::Callbacks
+    include Minitest::Candy::Assertions
+
+    # Prefer `assert_not_*`` than `refute_*``:
+    alias :assert_raise :assert_raises
+    alias :assert_not_empty :refute_empty
+    alias :assert_not_equal :refute_equal
+    alias :assert_not_in_delta :refute_in_delta
+    alias :assert_not_in_epsilon :refute_in_epsilon
+    alias :assert_not_includes :refute_includes
+    alias :assert_not_instance_of :refute_instance_of
+    alias :assert_not_kind_of :refute_kind_of
+    alias :assert_no_match :refute_match
+    alias :assert_not_nil :refute_nil
+    alias :assert_not_operator :refute_operator
+    alias :assert_not_predicate :refute_predicate
+    alias :assert_not_respond_to :refute_respond_to
+    alias :assert_not_same :refute_same
+  end
+end

data/minitest-candy.gemspec

@@ -0,0 +1,24 @@
+require_relative "lib/minitest/candy/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "minitest-candy"
+  spec.version = Minitest::Candy::VERSION
+  spec.authors = ["Francesco Rodriguez"]
+  spec.email = ["frodsan@me.com"]
+
+  spec.summary = "Enough sugar for your minitest diet"
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/frodsan/vipps"
+  spec.license = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  spec.files = `git ls-files`.split("\n")
+  spec.executables = spec.files.grep(%r{^exe/}).map { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "minitest", ">= 5.0"
+end

data/test/candy_test.rb

@@ -0,0 +1,31 @@
+require_relative "test_helper"
+
+class MinitestCandyTest < Minitest::Test
+  setup do
+    @bar = "bar"
+  end
+
+  test "defines a friendly human description" do
+    assert true
+  end
+
+  test "raises if the name is already taken" do
+    self.class.test("name") {}
+
+    assert_raises(RuntimeError) do
+      self.class.test("name") {}
+    end
+  end
+
+  test "assertions" do
+    assert_nothing_raised do
+      assert_not nil
+      assert_not false
+      assert_not_equal "1", "2"
+    end
+  end
+
+  teardown do
+    assert_equal("bar", @bar)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require "bundler/setup"
+require "minitest/autorun"
+require "minitest/pride"
+require_relative "../lib/minitest/candy"

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: minitest-candy
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Francesco Rodriguez
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Enough sugar for your minitest diet
+email:
+- frodsan@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/minitest/candy.rb
+- lib/minitest/candy/assertions.rb
+- lib/minitest/candy/callbacks.rb
+- lib/minitest/candy/declarative.rb
+- lib/minitest/candy/version.rb
+- minitest-candy.gemspec
+- test/candy_test.rb
+- test/test_helper.rb
+homepage: https://github.com/frodsan/vipps
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/frodsan/vipps
+  source_code_uri: https://github.com/frodsan/vipps
+  changelog_uri: https://github.com/frodsan/vipps
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.26
+signing_key:
+specification_version: 4
+summary: Enough sugar for your minitest diet
+test_files:
+- test/candy_test.rb
+- test/test_helper.rb