standard_assert 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3316ab8f33b749374cc006c40658940915e7098c827fd20ca7b2229429b205d4
-  data.tar.gz: 6944543a4b9271ed2e7156d5f5f0bdd2d6a09842571e33dd3cdb8092013c6799
+  metadata.gz: 40f8957293fc716888d3893b998e99667ee02b8c2dfde688138eb921d19f4b84
+  data.tar.gz: 7cac84248babb63c2c0d9abfd9756820a8a8afd956360b2368edd3372cf3235f
 SHA512:
-  metadata.gz: 939984e99601d6dfb8ee2ef1a72cd0ac76e4a54c6f2437bdde9c0d8b7e8881b02942059de9fc3a705c434a6e13ad8c8855494d491afe2fd42df75788f18b795a
-  data.tar.gz: 045e55acb59fd7a97717b1776842cf8312d272b5a1c89f81424ae28d2069bacc4a8e3855677e86e2770f103fb71b693e1efd32ab182c4e5e5da56a7c380aea82
+  metadata.gz: 34e02026e2f5397ba6b9fea8728a2c95c65a741a314743a6d86bf7a558e9434e956158ac7ca99ecb729cdea9f5eb4040672043a9353ef017ed15a8dd09b8cf0a
+  data.tar.gz: 503ac256dbe5da0510e4b4a2e97469a11f9b2b2a98a8aeced91d08994ba6e5ecc9d11b5173e8d0797ef95b5875197f63093b638babd759c6d0527c3d1234a0b8

data/CHANGELOG.md

@@ -1,11 +1,19 @@
 # CHANGELOG
 
+## [0.3.0](https://github.com/yasaichi/standard_assert/releases/tag/v0.3.0) (December 21, 2019)
+
+### Breaking changes
+
+- [Publish only `assert` and `assert_*` methods](https://github.com/yasaichi/standard_assert/pull/3)
+- [Publish the assertion methods as module functions](https://github.com/yasaichi/standard_assert/pull/4)
+- [Migrate the assertion methods' backend to `minitest`](https://github.com/yasaichi/standard_assert/pull/5)
+
 ## [0.2.1](https://github.com/yasaichi/standard_assert/releases/tag/v0.2.1) (December 14, 2019)
 
 ### Compatible changes
 
-- [Migration testing framework](https://github.com/yasaichi/standard_assert/commit/7d7f692234a099a85a9d79a0cd9b15047963eefc)
 - [Apply RuboCop autofix](https://github.com/yasaichi/standard_assert/commit/a7f0ddf984250fcec588a41b84c380b932af2a5f)
+- [Migration testing framework](https://github.com/yasaichi/standard_assert/commit/7d7f692234a099a85a9d79a0cd9b15047963eefc)
 
 ## [0.2.0](https://github.com/yasaichi/standard_assert/releases/tag/v0.2.0) (December 14, 2019)
 

data/README.md

@@ -24,28 +24,51 @@ $ bundle
 
 ## Usage
 
-Use `Assert` module with `extend` or `include` in classes or modules where you want to use assertion methods:
+Since assertion methods are defined as module functions of `Assert`, you can use them as instance methods
+to any classes that mix in the module:
 
 ```ruby
 require 'standard_assert'
 
-module MyMath
-  extend ::Assert
+class Stack
+  include ::Assert
 
-  module_function
+  def initialize
+    @store = []
+  end
+
+  def pop
+    assert(!@store.empty?)
+    @store.pop
+  end
+
+  def push(element)
+    @store.push(element)
+    self
+  end
+end
 
-  def abs(num)
-    assert_instance_of([::Float, ::Integer, ::Rational], num)
-    num.positive? ? num : -num
+Stack.new.pop #=> AssertionError (Expected false to be truthy.)
+```
+
+Or just call them with the module as a receiver:
+
+```ruby
+class Stack
+  def peek
+    ::Assert.assert(!@store.empty?)
+    @store.last
   end
 end
 
-MyMath.abs('42')
-#=> AssertionError: <"42"> was expected to be instance_of?
-#   [<Float>, <Integer>, <Rational>] but was
-#   <String>.
+Stack.new.peek #=> AssertionError (Expected false to be truthy.)
 ```
 
+Note that `Assert` provides `aseert` and `assert_*` methods same as in `Minitest::Assertions`
+except they throw not `Minitest::Assertion` but `AssertionError` when an assertion fails.
+
+See also: http://docs.seattlerb.org/minitest/Minitest/Assertions.html
+
 ## Contributing
 
 You should follow the steps below.

data/lib/standard_assert.rb

@@ -1,5 +1,22 @@
 # frozen_string_literal: true
 
-require_relative "standard_assert/core_ext/assert"
-require_relative "standard_assert/core_ext/assertion_error"
+require_relative "standard_assert/assertions"
 require_relative "standard_assert/version"
+
+module StandardAssert
+  assertion_method_pattern = /\Aassert(?:_\w+)?\z/
+
+  ::StandardAssert::Assertions.instance
+                              .public_methods
+                              .select(&assertion_method_pattern.method(:match?))
+                              .each do |name|
+    class_eval <<~CODE, __FILE__, __LINE__ + 1
+      module_function def #{name}(*args, &block)
+        ::StandardAssert::Assertions.instance.public_send(:#{name}, *args, &block)
+      end
+    CODE
+  end
+end
+
+# HACK: Call `dup` to make `inspect`, `name`, `to_s` and so on return `"Assert"`
+Assert = StandardAssert.dup

data/lib/standard_assert/assertion_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module StandardAssert
+  class AssertionError < ::StandardError; end
+end
+
+# HACK: Call `dup` to make `inspect`, `name`, `to_s` and so on return `"AssertionError"`
+AssertionError = StandardAssert::AssertionError.dup

data/lib/standard_assert/assertions.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "minitest"
+require "singleton"
+require_relative "assertion_error"
+
+module StandardAssert
+  class Assertions # :nodoc:
+    include ::Minitest::Assertions
+    include ::Singleton
+
+    def initialize
+      @assertions = 0
+    end
+
+    # Override
+    def assert(test, msg = nil)
+      super
+    rescue ::Minitest::Assertion => e
+      raise ::AssertionError, e.message
+    end
+
+    protected # rubocop:disable Style/AccessModifierDeclarations
+
+    attr_reader :assertions
+
+    # NOTE: `Minitest::Assertions` expects to be able to increment an instance accessor named
+    # `assertions`, but we don't need the accessor because it's used for reporting test results.
+    # So define a writer that does nothing and always returns the same value.
+    def assertions=(_val)
+      @assertions
+    end
+  end
+end

data/lib/standard_assert/version.rb

@@ -1,7 +1,7 @@
 # rubocop:disable Style/FrozenStringLiteralComment
 
 module StandardAssert
-  VERSION = "0.2.1".freeze
+  VERSION = "0.3.0".freeze
 end
 
 # rubocop:enable Style/FrozenStringLiteralComment

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standard_assert
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - yasaichi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-14 00:00:00.000000000 Z
+date: 2019-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,19 +95,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
 description: "`standard_assert` is a Standard Library-like library for assertions
   in Ruby. It is aimed at encouraging us to use assertion methods anywhere; Not only
   testing but also production."
@@ -122,8 +122,8 @@ files:
 - README.md
 - Rakefile
 - lib/standard_assert.rb
-- lib/standard_assert/core_ext/assert.rb
-- lib/standard_assert/core_ext/assertion_error.rb
+- lib/standard_assert/assertion_error.rb
+- lib/standard_assert/assertions.rb
 - lib/standard_assert/version.rb
 homepage: https://github.com/yasaichi/standard_assert
 licenses:

data/lib/standard_assert/core_ext/assert.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require "test/unit/assertions"
-
-module Assert
-  %i[public protected private].each do |visibility|
-    ::Test::Unit::Assertions.public_send("#{visibility}_instance_methods").each do |name|
-      define_method name, ::Test::Unit::Assertions.instance_method(name)
-      __send__(visibility, name)
-    end
-  end
-end

data/lib/standard_assert/core_ext/assertion_error.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require "forwardable"
-require "test/unit/assertion-failed-error"
-
-class AssertionError < StandardError
-  extend ::Forwardable
-
-  OriginalError = ::Test::Unit::AssertionFailedError
-  private_constant :OriginalError
-
-  def_delegators(
-    :@original_error,
-    *(OriginalError.instance_methods - superclass.instance_methods)
-  )
-
-  def initialize(message = nil, options = nil)
-    @original_error = OriginalError.new(message, options)
-    super(@original_error.message)
-  end
-end
-
-Test::Unit.class_exec do
-  remove_const :AssertionFailedError
-  const_set :AssertionFailedError, AssertionError
-end