expected 1.0.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0954ddfccf5072455413c702650c98e39ccdbd72a1db7806463598e5c6c0e52b'
-  data.tar.gz: c41841fcb0cfcfde9dfff9c1c27445f88c10a168254c965ea681a0e62676ee0c
+  metadata.gz: bbca42d3e57b1a222b2e75768bba23ef79eceec10c59e25388d0234cdd5099c2
+  data.tar.gz: ff40dd47a526a18912391837d1346c89aa9c422d6c21d081c13959aac67a3975
 SHA512:
-  metadata.gz: a6cf5251016d8d3f9b36af9ac429a0e9c8f433ee4c03b687a438e339d84361c913df7b63f6779597b49f0fb675ca4998c9da8a066e1371458ad04c1dff3675b5
-  data.tar.gz: bb7461e7f4e02295962c7b52288e86a710bf72f93f7a6ab4129eb29a8f9b7d27a66c50c95eea4b0d8681d0ed620b95f0237cf02818b5c5fda5de1e30f81f82c7
+  metadata.gz: 93552e9c8c85b6291b02e82a687748d69122f8458e38a2504a2ab8a3babadb9a11e9ff97af33419241201ac303223bf8498f9e2d4635909fc61f98ff75e1a90d
+  data.tar.gz: 971093756132a91567d723e76abff892adfe71d8f31861a0c9962e8d482188907f469c4439e90f2cb93687a9494ea13826e3edf29c6e04d204d497e511eee05e

data/README.md

@@ -19,10 +19,9 @@ end
 ```
 
 ### Add to RSpec
-Add the following to your projects `spec/rails_helper.rb` for Rails apps, or `spec/spec_helper.rb for non-Rails apps.
+Add the following to your projects `spec/rails_helper.rb` for Rails apps, or `spec/spec_helper.rb` for non-Rails apps.
 ```ruby
-Expected.configure do |config|
-end
+Expected.configure
 ```
 
 
@@ -33,12 +32,22 @@ end
 
 
 
-### `inherit_from`
-Used to test inheritance
+### `be_a_concern`
+Used to test that a Module is an ActiveSupport::Concern
 
 ```ruby
-# Test if the subject inherits from the supplied Class
-it { is_expected.to inherit_from(SomeClass) }
+# Test if the subject is an ActiveSupport::Concern`
+it { is_expected.to be_a_concern }
+```
+
+
+
+### `extend_module`
+Used to test that a Class or Module extends the supplied Module
+
+```ruby
+# Test if the subject extends the supplied Module
+it { is_expected.to extend_module(SomeModule) }
 ```
 
 
@@ -89,6 +98,26 @@ it { is_expected.to have_attr_accessor(:attribute) }
 
 
 
+### `include_module`
+Used to test that a Class or Module includes the supplied Module
+
+```ruby
+# Test if the subject includes the supplied Module
+it { is_expected.to include_module(SomeModule) }
+```
+
+
+
+### `inherit_from`
+Used to test inheritance
+
+```ruby
+# Test if the subject inherits from the supplied Class
+it { is_expected.to inherit_from(SomeClass) }
+```
+
+
+
 ## License
 Expected is copyright © 2019-2020 Taylor Yelverton.
 It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

data/lib/expected/configuration.rb

@@ -7,7 +7,12 @@ module Expected
     # Configure the library
     # @yield [Configuration]
     def configure
-      yield configuration
+      yield configuration if block_given?
+      return unless defined?(::RSpec)
+      ::RSpec.configure do |config|
+        config.include(Matchers)
+      end
+      configuration
     end
 
     # Memoized {Configuration}

data/lib/expected/matchers.rb

@@ -6,8 +6,11 @@ module Expected
   end
 end
 
+require 'expected/matchers/be_a_concern'
+require 'expected/matchers/extend_module'
 require 'expected/matchers/have_constant'
-require 'expected/matchers/inherit_from'
+require 'expected/matchers/have_attr_accessor'
 require 'expected/matchers/have_attr_reader'
 require 'expected/matchers/have_attr_writer'
-require 'expected/matchers/have_attr_accessor'
+require 'expected/matchers/include_module'
+require 'expected/matchers/inherit_from'

data/lib/expected/matchers/be_a_concern.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'expected/matchers/extend_module'
+
+module Expected
+  # :nodoc:
+  module Matchers
+
+    # Used to test inheritance
+    # @return [BeAConcernMatcher]
+    #
+    # @example Test if the subject is an ActiveSupport::Concern
+    #   it { is_expected.to be_a_concern }
+    #
+    def be_a_concern
+      BeAConcernMatcher.new
+    end
+
+    # Class used by {#be_a_concern}
+    class BeAConcernMatcher
+      attr_reader :extend_module_matcher, :subject
+
+      def initialize
+        @extend_module_matcher = ExtendModuleMatcher.new(ActiveSupport::Concern)
+      end
+
+      # Run the test
+      # @param subject The thing to test against
+      # @return [True] If the test passes
+      # @return [False] if the test fails
+      def matches?(subject)
+        self.subject = subject
+        @extend_module_matcher.matches?(subject)
+      end
+
+      # @return [String]
+      def failure_message
+        "Expected #{expectation}"
+      end
+
+      # @return [String]
+      def failure_message_when_negated
+        "Did not expect #{expectation}"
+      end
+
+      # @return [String]
+      def description
+        'be_a_concern'
+      end
+
+      private
+
+        # The thing to test against
+        # @return [Module]
+        def subject=(subject)
+          unless subject.instance_of?(Module)
+            raise "The subject for BeAConcernMatcher must be a Module, but was: `#{subject.inspect}`"
+          end
+          @subject = subject
+        end
+
+        # @return String
+        def expectation
+          "<#{subject.inspect}> to be an ActiveSupport::Concern"
+        end
+
+    end
+
+  end
+end

data/lib/expected/matchers/extend_module.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Expected
+  # :nodoc:
+  module Matchers
+
+    # Used to test inheritance
+    # @param expected_module [Class]
+    # @return [ExtendModuleMatcher]
+    #
+    # @example Test if the subject extends the supplied Module
+    #   it { is_expected.to extend(SomeClass) }
+    #
+    def extend_module(expected_module)
+      ExtendModuleMatcher.new(expected_module)
+    end
+
+    # Class used by {#extend_module}
+    class ExtendModuleMatcher
+      attr_reader :expected_module, :subject
+
+      # @param expected_module [Class] The module the {#subject} is expected to include
+      def initialize(expected_module)
+        @expected_module = expected_module
+      end
+
+      # Run the test
+      # @param subject The thing to test against
+      # @return [True] If the test passes
+      # @return [False] if the test fails
+      def matches?(subject)
+        self.subject = subject
+        klass = self.subject.singleton_class
+        klass.included_modules.include? expected_module
+      end
+
+      # @return [String]
+      def failure_message
+        "Expected #{expectation}"
+      end
+
+      # @return [String]
+      def failure_message_when_negated
+        "Did not expect #{expectation}"
+      end
+
+      # @return [String]
+      def description
+        "extend_module: <#{expected_module.inspect}>"
+      end
+
+      private
+
+        # The thing to test against
+        # @return [Class, Module]
+        def subject=(subject)
+          @subject = subject.instance_of?(Class) || subject.is_a?(Module) ? subject : subject.class
+        end
+
+        # @return String
+        def expectation
+          "<#{subject.inspect}> to extend <#{expected_module.inspect}>"
+        end
+
+    end
+
+  end
+end

data/lib/expected/matchers/have_attr_accessor.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'securerandom'
+require 'expected/matchers/have_attr_reader'
+require 'expected/matchers/have_attr_writer'
 
 module Expected
   # :nodoc:

data/lib/expected/matchers/include_module.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Expected
+  # :nodoc:
+  module Matchers
+
+    # Used to test inheritance
+    # @param expected_module [Module]
+    # @return [IncludeModuleMatcher]
+    #
+    # @example Test if the subject includes the supplied Module
+    #   it { is_expected.to include_module(SomeModule) }
+    #
+    def include_module(expected_module)
+      IncludeModuleMatcher.new(expected_module)
+    end
+
+    # Class used by {#include_module}
+    class IncludeModuleMatcher
+      attr_reader :expected_module, :subject
+
+      # @param expected_module [Module] The module the {#subject} is expected to include
+      def initialize(expected_module)
+        @expected_module = expected_module
+      end
+
+      # Run the test
+      # @param subject The thing to test against
+      # @return [True] If the test passes
+      # @return [False] if the test fails
+      def matches?(subject)
+        self.subject = subject
+        self.subject.included_modules.include? expected_module
+      end
+
+      # @return [String]
+      def failure_message
+        "Expected #{expectation}"
+      end
+
+      # @return [String]
+      def failure_message_when_negated
+        "Did not expect #{expectation}"
+      end
+
+      # @return [String]
+      def description
+        "include_module: <#{expected_module.inspect}>"
+      end
+
+      private
+
+        # The thing to test against
+        # @return [Class, Module]
+        def subject=(subject)
+          @subject = subject.instance_of?(Class) || subject.is_a?(Module) ? subject : subject.class
+        end
+
+        # @return String
+        def expectation
+          "<#{subject.inspect}> to include <#{expected_module.inspect}>"
+        end
+
+    end
+
+  end
+end

data/lib/expected/matchers/inherit_from.rb

@@ -15,7 +15,7 @@ module Expected
       InheritFromMatcher.new(expected_ancestor)
     end
 
-    # Class used by {#have_constant}
+    # Class used by {#inherit_from}
     class InheritFromMatcher
       attr_reader :expected_ancestor, :subject
 

data/lib/expected/version.rb

@@ -5,8 +5,8 @@ module Expected
   # Contains version information
   module Version
     MAJOR = 1
-    MINOR = 0
-    PATCH = 0
+    MINOR = 1
+    PATCH = 2
 
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expected
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Taylor Yelverton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-07 00:00:00.000000000 Z
+date: 2021-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,9 +17,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.0
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.0
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
 description: RSpec's missing matchers
 email: rubygems@yelvert.io
 executables: []
@@ -41,10 +35,13 @@ files:
 - lib/expected.rb
 - lib/expected/configuration.rb
 - lib/expected/matchers.rb
+- lib/expected/matchers/be_a_concern.rb
+- lib/expected/matchers/extend_module.rb
 - lib/expected/matchers/have_attr_accessor.rb
 - lib/expected/matchers/have_attr_reader.rb
 - lib/expected/matchers/have_attr_writer.rb
 - lib/expected/matchers/have_constant.rb
+- lib/expected/matchers/include_module.rb
 - lib/expected/matchers/inherit_from.rb
 - lib/expected/version.rb
 homepage: https://github.com/yelvert/expected