expected 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 481afa189341a25a777d285269283587aa86b747be059e23a57e143f904757d7
-  data.tar.gz: 96d327a39fb91d96d44332affceb3f806b9ebbe52b3833ff25fa4bfb86b06a32
+  metadata.gz: 66f6dcc60d13674d39514a6681853892400394ac704427369b587cd8f790c3fa
+  data.tar.gz: fce7d948542985fa557398625de1c64e0411a8d98789a5a62edbc19ff7a6093a
 SHA512:
-  metadata.gz: 7aafb11ac42e9e72102d68bec3ea16ba654df89945114f35710f0f5f620062d8601d1ba71c379b89ab706c848f8257b36a8fb75870d4049733d467e122b81c28
-  data.tar.gz: fc1b339b191a525bb4a1907f55c05ee54ef6584c34306a14d868ae3f66d3a2c5b8e4466810d9841d565e4efe2ab038ef015952742a715af96deb0694bfdf83f9
+  metadata.gz: 89b1776f9c5ce6730cc148adcd86243c4cd802043f0f87cf7bab8e913dd47a5013b9ceb918047af01c2ae9d635e80cd2c759489904e26a73d3d1a7beeaf42181
+  data.tar.gz: d34e29d614a038109302e5d00e2b2257529af933853c267c8e31f05b69694bfb607d97961a5c3ff6551d9b19ad2168c9c8cc4da0c140afdded25e2b48ca8fb5a

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 = 2
+    MINOR = 1
+    PATCH = 0
 
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expected
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 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
@@ -35,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