matchi 1.0.5 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcf4ea2585e0f28100e46fc43359e72a2144914c34b7054b8eefbbbf50554aeb
-  data.tar.gz: d4bd35c7e7d76bea0351970a5d298832f78df357b5609cbc14226691858e3933
+  metadata.gz: a9afc0e3e02c4150637f3d1080cf6eacd470ad7dec335417bda0e79ee60ecdea
+  data.tar.gz: d62e283556fc4f9d4a6d93bde1efb518861d482dba734786f00b57a166f4ade6
 SHA512:
-  metadata.gz: 98a4faa1e51f9c7e19628251f64eac732b793a0a85a7ee40f46294d92ed80c1b8b0590ad11282698a48a26edd048a53ef31305843bf1caac0921ccb2af47852e
-  data.tar.gz: 7d0cc22350a289c524c77ee67e972b05872c5d97d0e6e573278e3ba858d5b0583e7916d1a8f2e62e8358f192d8f7f5792846914fc5f3ca9788d8c6686c5ce005
+  metadata.gz: 50d45962387971730773221e8756fa543457ebd1375f7205538040d2fb115eb1fae0784c1e9949794e9c990efc7788fda49ce03f8096918005eae384ed460a13
+  data.tar.gz: 12071d2d5462243d42eac25ca3d70fc5a236cd79b8cbdd20a608e4d2ceeacdbdddbaeeba06f30218c30d1cbf0c6f16279be655eead7a42dcf6b9cecdf1c645cf

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2019 Cyril Kato
+Copyright (c) 2015-2021 Cyril Kato
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,30 +1,19 @@
 # Matchi
 
-[![Build Status](https://api.travis-ci.org/fixrb/matchi.svg?branch=master)][travis]
+[![Build Status](https://api.travis-ci.org/fixrb/matchi.svg?branch=main)][travis]
 [![Code Climate](https://codeclimate.com/github/fixrb/matchi/badges/gpa.svg)][codeclimate]
 [![Gem Version](https://badge.fury.io/rb/matchi.svg)][gem]
-[![Inline docs](https://inch-ci.org/github/fixrb/matchi.svg?branch=master)][inchpages]
+[![Inline docs](https://inch-ci.org/github/fixrb/matchi.svg?branch=main)][inchpages]
 [![Documentation](https://img.shields.io/:yard-docs-38c800.svg)][rubydoc]
 
 > Collection of expectation matchers for Ruby.
 
-## Contact
-
-* Home page: https://github.com/fixrb/matchi
-* Bugs/issues: https://github.com/fixrb/matchi/issues
-
-## Rubies
-
-* [MRI](https://www.ruby-lang.org/)
-* [Rubinius](https://rubinius.com/)
-* [JRuby](https://www.jruby.org/)
-
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'matchi'
+gem "matchi"
 ```
 
 And then execute:
@@ -42,49 +31,49 @@ Or install it yourself as:
 **Equivalence** matcher:
 
 ```ruby
-eql = Matchi::Matchers::Eql::Matcher.new('foo')
-eql.matches? { 'foo' } # => true
+eql = Matchi::Matcher::Eql.new("foo")
+eql.matches? { "foo" } # => true
 ```
 
 **Identity** matcher:
 
 ```ruby
-equal = Matchi::Matchers::Equal::Matcher.new(:foo)
+equal = Matchi::Matcher::Equal.new(:foo)
 equal.matches? { :foo } # => true
 ```
 
 **Regular expressions** matcher:
 
 ```ruby
-match = Matchi::Matchers::Match::Matcher.new(/^foo$/)
-match.matches? { 'foo' } # => true
+match = Matchi::Matcher::Match.new(/^foo$/)
+match.matches? { "foo" } # => true
 ```
 
 **Expecting errors** matcher:
 
 ```ruby
-raise_exception = Matchi::Matchers::RaiseException::Matcher.new(NameError)
+raise_exception = Matchi::Matcher::RaiseException.new(NameError)
 raise_exception.matches? { Boom } # => true
 ```
 
 **Truth** matcher:
 
 ```ruby
-be_true = Matchi::Matchers::BeTrue::Matcher.new
+be_true = Matchi::Matcher::BeTrue.new
 be_true.matches? { true } # => true
 ```
 
 **Untruth** matcher:
 
 ```ruby
-be_false = Matchi::Matchers::BeFalse::Matcher.new
+be_false = Matchi::Matcher::BeFalse.new
 be_false.matches? { false } # => true
 ```
 
 **Nil** matcher:
 
 ```ruby
-be_nil = Matchi::Matchers::BeNil::Matcher.new
+be_nil = Matchi::Matcher::BeNil.new
 be_nil.matches? { nil } # => true
 ```
 
@@ -96,55 +85,35 @@ A **Be the answer** matcher:
 
 ```ruby
 module Matchi
-  module Matchers
-    module BeTheAnswer
-      class Matcher
-        def matches?
-          42.equal? yield
-        end
-
-        def to_s
-          'be_the_answer'
-        end
-
-        def to_h
-          { BeTheAnswer: [] }
-        end
+  module Matcher
+    class BeTheAnswer < ::Matchi::Matcher::Base
+      def matches?
+        42.equal? yield
       end
     end
   end
 end
 
-be_the_answer = Matchi::Matchers::BeTheAnswer::Matcher.new
+be_the_answer = Matchi::Matcher::BeTheAnswer.new
 be_the_answer.matches? { 42 } # => true
 ```
 
 A **Be prime** matcher:
 
 ```ruby
-require 'prime'
+require "prime"
 
 module Matchi
-  module Matchers
-    module BePrime
-      class Matcher
-        def matches?
-          Prime.prime? yield
-        end
-
-        def to_s
-          'be_prime'
-        end
-
-        def to_h
-          { BePrime: [] }
-        end
+  module Matcher
+    class BePrime < ::Matchi::Matcher::Base
+      def matches?
+        Prime.prime? yield
       end
     end
   end
 end
 
-be_prime = Matchi::Matchers::BePrime::Matcher.new
+be_prime = Matchi::Matcher::BePrime.new
 be_prime.matches? { 42 } # => false
 ```
 
@@ -152,70 +121,54 @@ A **Start with** matcher:
 
 ```ruby
 module Matchi
-  module Matchers
-    module StartWith
-      class Matcher
-        def initialize(expected)
-          @expected = expected
-        end
-
-        def matches?
-          !Regexp.new("^#{@expected}").match(yield).nil?
-        end
-
-        def to_s
-          'start_with'
-        end
-
-        def to_h
-          { StartWith: [@expected] }
-        end
+  module Matcher
+    class StartWith < ::Matchi::Matcher::Base
+      def initialize(expected)
+        super()
+        @expected = expected
+      end
+
+      def matches?
+        !Regexp.new("^#{expected}").match(yield).nil?
       end
     end
   end
 end
 
-start_with = Matchi::Matchers::StartWith::Matcher.new('foo')
-start_with.matches? { 'foobar' } # => true
+start_with = Matchi::Matcher::StartWith.new("foo")
+start_with.matches? { "foobar" } # => true
 ```
 
-## Security
+## Contact
 
-As a basic form of security __Matchi__ provides a set of SHA512 checksums for
-every Gem release.  These checksums can be found in the `checksum/` directory.
-Although these checksums do not prevent malicious users from tampering with a
-built Gem they can be used for basic integrity verification purposes.
+* Home page: https://github.com/fixrb/matchi
+* Bugs/issues: https://github.com/fixrb/matchi/issues
 
-The checksum of a file can be checked using the `sha512sum` command.  For
-example:
+## Rubies
 
-    $ sha512sum pkg/matchi-0.0.1.gem
-    548d9f669ded4e622182791a5390aaceae0bf2e557b0864f05a842b0be2c65e10e1fb8499f49a3b9efd0e8eaeb691351b1c670d6316ce49965a99683b1071389  pkg/matchi-0.0.1.gem
+* [MRI](https://www.ruby-lang.org/)
+* [Rubinius](https://rubinius.com/)
+* [JRuby](https://www.jruby.org/)
 
 ## Versioning
 
 __Matchi__ follows [Semantic Versioning 2.0](https://semver.org/).
 
-## Contributing
+## License
 
-1. [Fork it](https://github.com/fixrb/matchi/fork)
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## License
+***
 
-See `LICENSE.md` file.
+<p>
+  This project is sponsored by:<br />
+  <a href="https://sashite.com/"><img
+    src="https://github.com/fixrb/matchi/raw/main/img/sashite.png"
+    alt="Sashite" /></a>
+</p>
 
 [gem]: https://rubygems.org/gems/matchi
 [travis]: https://travis-ci.org/fixrb/matchi
 [codeclimate]: https://codeclimate.com/github/fixrb/matchi
 [inchpages]: https://inch-ci.org/github/fixrb/matchi
 [rubydoc]: https://rubydoc.info/gems/matchi/frames
-
-***
-
-This project is sponsored by:
-
-[![Sashite](https://pbs.twimg.com/profile_images/618485028322975744/PZ9qPuI__400x400.png)](https://sashite.com/)

data/lib/matchi.rb

@@ -4,4 +4,4 @@
 module Matchi
 end
 
-require_relative ::File.join('matchi', 'matchers')
+require_relative File.join("matchi", "matcher")

data/lib/matchi/helper.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "matcher"
+
+module Matchi
+  # Collection of helper methods.
+  module Helper
+    ::Matchi::Matcher.constants.each do |matcher_const|
+      next if matcher_const.equal?(:Base)
+
+      matcher_klass = ::Matchi::Matcher.const_get(matcher_const)
+
+      # Define a method for the given matcher.
+      #
+      # @example Given the `Matchi::Matchers::Equal::Matcher` matcher, its
+      #   method would be:
+      #
+      #   def equal(expected)
+      #     Matchi::Matchers::Equal::Matcher.new(expected)
+      #   end
+      #
+      # @return [#matches?] The matcher.
+      define_method(matcher_klass.to_sym) do |*args|
+        matcher_klass.new(*args)
+      end
+    end
+  end
+end

data/lib/matchi/matcher.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Matchi
+  # Collection of matcher classes.
+  module Matcher
+  end
+end
+
+Dir[File.join(File.dirname(__FILE__), "matcher", "*.rb")].each do |fname|
+  require_relative fname
+end

data/lib/matchi/matcher/base.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Matchi
+  module Matcher
+    # Abstract matcher class.
+    class Base
+      # @return [Symbol] A symbol identifying the matcher.
+      def self.to_sym
+        name.delete_prefix("Matchi::Matcher::")
+            .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+            .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+            .downcase
+            .to_sym
+      end
+
+      # @return [#object_id] Any value to give to the matcher.
+      attr_reader :expected
+
+      # A string containing a human-readable representation of the matcher.
+      #
+      # @return [String] The human-readable representation of the matcher.
+      def inspect
+        "#{self.class}(#{expected&.inspect})"
+      end
+
+      # Abstract matcher class.
+      #
+      # @raise [NotImplementedError] Override me inside a matcher.
+      def matches?
+        raise ::NotImplementedError, "matcher MUST respond to this method."
+      end
+
+      # Returns a string representing the matcher.
+      #
+      # @example The readable definition of a FooBar matcher.
+      #   matcher = Matchi::Matcher::FooBar.new(42)
+      #   matcher.to_s # => "foo_bar 42"
+      #
+      # @return [String] A string representing the matcher.
+      def to_s
+        [self.class.to_sym, expected&.inspect].compact.join(" ")
+      end
+    end
+  end
+end

data/lib/matchi/matcher/be_false.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Matchi
+  module Matcher
+    # **Untruth** matcher.
+    class BeFalse < ::Matchi::Matcher::Base
+      # Boolean comparison between the actual value and the expected value.
+      #
+      # @example Is it false?
+      #   be_false = Matchi::Matcher::BeFalse.new
+      #   be_false.matches? { false } # => true
+      #
+      # @yieldreturn [#object_id] The actual value to compare to the expected
+      #   one.
+      #
+      # @return [Boolean] Comparison between actual and expected values.
+      def matches?(*, **)
+        false.equal?(yield)
+      end
+    end
+  end
+end

data/lib/matchi/matcher/be_nil.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Matchi
+  module Matcher
+    # **Nil** matcher.
+    class BeNil < ::Matchi::Matcher::Base
+      # Boolean comparison between the actual value and the expected value.
+      #
+      # @example Is it nil?
+      #   be_nil = Matchi::Matcher::BeNil.new
+      #   be_nil.matches? { nil } # => true
+      #
+      # @yieldreturn [#object_id] The actual value to compare to the expected
+      #   one.
+      #
+      # @return [Boolean] Comparison between actual and expected values.
+      def matches?(*, **)
+        nil.equal?(yield)
+      end
+    end
+  end
+end

data/lib/matchi/matcher/be_true.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Matchi
+  module Matcher
+    # **Truth** matcher.
+    class BeTrue < ::Matchi::Matcher::Base
+      # Boolean comparison between the actual value and the expected value.
+      #
+      # @example Is it true?
+      #   be_true = Matchi::Matcher::BeTrue.new
+      #   be_true.matches? { true } # => true
+      #
+      # @yieldreturn [#object_id] The actual value to compare to the expected
+      #   one.
+      #
+      # @return [Boolean] Comparison between actual and expected values.
+      def matches?(*, **)
+        true.equal?(yield)
+      end
+    end
+  end
+end