super_diff 0.9.0 → 0.11.0

data/spec/unit/operation_tree_flatteners/multiline_string_spec.rb

@@ -12,110 +12,120 @@ RSpec.describe SuperDiff::OperationTreeFlatteners::MultilineString do
   context "given a tree of only noops" do
     it "returns a series of lines from printing each value" do
       collection = Array.new(3) { :some_value }
-      operation_tree = SuperDiff::OperationTrees::MultilineString.new([
-        double(
-          :operation,
-          name: :noop,
-          collection: collection,
-          value: "This is a line\n",
-          index: 0,
-        ),
-        double(
-          :operation,
-          name: :noop,
-          collection: collection,
-          value: "This is another line\n",
-          index: 1,
-        ),
-        double(
-          :operation,
-          name: :noop,
-          collection: collection,
-          value: "This is yet another line",
-          index: 2,
-        ),
-      ])
+      operation_tree =
+        SuperDiff::OperationTrees::MultilineString.new(
+          [
+            double(
+              :operation,
+              name: :noop,
+              collection: collection,
+              value: "This is a line\n",
+              index: 0
+            ),
+            double(
+              :operation,
+              name: :noop,
+              collection: collection,
+              value: "This is another line\n",
+              index: 1
+            ),
+            double(
+              :operation,
+              name: :noop,
+              collection: collection,
+              value: "This is yet another line",
+              index: 2
+            )
+          ]
+        )
 
       flattened_operation_tree = described_class.call(operation_tree)
 
-      expect(flattened_operation_tree).to match([
-        an_object_having_attributes(
-          type: :noop,
-          indentation_level: 0,
-          prefix: "",
-          value: %(This is a line\\n),
-          add_comma: false,
-        ),
-        an_object_having_attributes(
-          type: :noop,
-          indentation_level: 0,
-          prefix: "",
-          value: %(This is another line\\n),
-          add_comma: false,
-        ),
-        an_object_having_attributes(
-          type: :noop,
-          indentation_level: 0,
-          prefix: "",
-          value: %(This is yet another line),
-          add_comma: false,
-        ),
-      ])
+      expect(flattened_operation_tree).to match(
+        [
+          an_object_having_attributes(
+            type: :noop,
+            indentation_level: 0,
+            prefix: "",
+            value: %(This is a line\\n),
+            add_comma: false
+          ),
+          an_object_having_attributes(
+            type: :noop,
+            indentation_level: 0,
+            prefix: "",
+            value: %(This is another line\\n),
+            add_comma: false
+          ),
+          an_object_having_attributes(
+            type: :noop,
+            indentation_level: 0,
+            prefix: "",
+            value: "This is yet another line",
+            add_comma: false
+          )
+        ]
+      )
     end
   end
 
   context "given a tree of noops, inserts, and deletes" do
     it "returns a series of lines from printing each value" do
       collection = Array.new(3) { :some_value }
-      operation_tree = SuperDiff::OperationTrees::MultilineString.new([
-        double(
-          :operation,
-          name: :noop,
-          collection: collection,
-          value: "This is a line\n",
-          index: 0,
-        ),
-        double(
-          :operation,
-          name: :delete,
-          collection: collection,
-          value: "This is another line\n",
-          index: 1,
-        ),
-        double(
-          :operation,
-          name: :insert,
-          collection: collection,
-          value: "This is yet another line",
-          index: 1,
-        ),
-      ])
+      operation_tree =
+        SuperDiff::OperationTrees::MultilineString.new(
+          [
+            double(
+              :operation,
+              name: :noop,
+              collection: collection,
+              value: "This is a line\n",
+              index: 0
+            ),
+            double(
+              :operation,
+              name: :delete,
+              collection: collection,
+              value: "This is another line\n",
+              index: 1
+            ),
+            double(
+              :operation,
+              name: :insert,
+              collection: collection,
+              value: "This is yet another line",
+              index: 1
+            )
+          ]
+        )
 
       flattened_operation_tree = described_class.call(operation_tree)
 
-      expect(flattened_operation_tree).to match([
-        an_object_having_attributes(
-          type: :noop,
-          indentation_level: 0,
-          prefix: "",
-          value: %(This is a line\\n),
-          add_comma: false,
-        ),
-        an_object_having_attributes(
-          type: :delete,
-          indentation_level: 0,
-          prefix: "",
-          value: %(This is another line\\n),
-          add_comma: false,
-        ),
-        an_object_having_attributes(
-          type: :insert,
-          indentation_level: 0,
-          prefix: "",
-          value: %(This is yet another line),
-          add_comma: false,
-        ),
-      ])
+      expect(flattened_operation_tree).to match(
+        [
+          an_object_having_attributes(
+            type: :noop,
+            indentation_level: 0,
+            prefix: "",
+            value: %(This is a line\\n),
+            add_comma: false
+          ),
+          an_object_having_attributes(
+            type: :delete,
+            indentation_level: 0,
+            prefix: "",
+            value: %(This is another line\\n),
+            add_comma: false
+          ),
+          an_object_having_attributes(
+            type: :insert,
+            indentation_level: 0,
+            prefix: "",
+            value: "This is yet another line",
+            add_comma: false
+          )
+        ]
+      )
     end
   end
 end

data/spec/unit/rspec/matchers/be_compared_to_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 
 RSpec.describe "RSpec's `be` matcher used with an operator" do
   describe "#description" do
-    [:==, :===, :=~].each do |operator|
+    %i[== === =~].each do |operator|
       context "when the operator is #{operator}" do
         it "returns the correct output" do
           expect(be.public_send(operator, 2).description).to eq("#{operator} 2")
@@ -10,11 +10,11 @@ RSpec.describe "RSpec's `be` matcher used with an operator" do
       end
     end
 
-    [:<, :<=, :>=, :>].each do |operator|
+    %i[< <= >= >].each do |operator|
       context "when the operator is #{operator}" do
         it "returns the correct output" do
           expect(be.public_send(operator, 2).description).to eq(
-            "be #{operator} 2",
+            "be #{operator} 2"
           )
         end
       end

data/spec/unit/rspec/matchers/be_predicate_spec.rb

@@ -4,7 +4,7 @@ RSpec.describe "RSpec's `be_<predicate>` matcher" do
   describe "#description" do
     it "returns the correct output" do
       expect(be_famous.description).to eq(
-        "return true for `famous?` or `famouss?`",
+        "return true for `famous?` or `famouss?`"
       )
     end
   end
@@ -14,7 +14,7 @@ RSpec.describe "RSpec's `be_a_<predicate>` matcher" do
   describe "#description" do
     it "returns the correct output" do
       expect(be_a_big_big_star.description).to eq(
-        "return true for `big_big_star?` or `big_big_stars?`",
+        "return true for `big_big_star?` or `big_big_stars?`"
       )
     end
   end
@@ -24,7 +24,7 @@ RSpec.describe "RSpec's `be_an_<predicate>` matcher" do
   describe "#description" do
     it "returns the correct output" do
       expect(be_an_open_book.description).to eq(
-        "return true for `open_book?` or `open_books?`",
+        "return true for `open_book?` or `open_books?`"
       )
     end
   end

data/spec/unit/rspec/matchers/contain_exactly_spec.rb

@@ -4,7 +4,7 @@ RSpec.describe "RSpec's `contain_exactly` matcher" do
   describe "#description" do
     it "returns the correct output" do
       expect(contain_exactly(:foo, :bar, :baz).description).to eq(
-        "contain exactly :foo, :bar and :baz",
+        "contain exactly :foo, :bar and :baz"
       )
     end
   end

data/spec/unit/rspec/matchers/have_attributes_spec.rb

@@ -4,7 +4,7 @@ RSpec.describe "RSpec's `have_attributes` matcher" do
   describe "#description" do
     it "returns the correct output" do
       expect(have_attributes(foo: "bar", baz: "qux").description).to eq(
-        %|have attributes (foo: "bar", baz: "qux")|,
+        %|have attributes (foo: "bar", baz: "qux")|
       )
     end
   end

data/spec/unit/rspec/matchers/have_predicate_spec.rb

@@ -5,7 +5,7 @@ RSpec.describe "RSpec's `have_<predicate>` matcher" do
     context "given nothing" do
       it "returns the correct output" do
         expect(have_experience.description).to eq(
-          "return true for `has_experience?`",
+          "return true for `has_experience?`"
         )
       end
     end
@@ -13,7 +13,7 @@ RSpec.describe "RSpec's `have_<predicate>` matcher" do
     context "given an argument" do
       it "returns the correct output" do
         expect(have_ingredients(:sugar).description).to eq(
-          "return true for `has_ingredients?(:sugar)`",
+          "return true for `has_ingredients?(:sugar)`"
         )
       end
     end

data/spec/unit/rspec/matchers/include_spec.rb

@@ -5,7 +5,7 @@ RSpec.describe "RSpec's `include` matcher" do
     context "given a list of items" do
       it "returns the correct output" do
         expect(include(:foo, :bar, :baz).description).to eq(
-          "include :foo, :bar, and :baz",
+          "include :foo, :bar, and :baz"
         )
       end
     end
@@ -13,7 +13,7 @@ RSpec.describe "RSpec's `include` matcher" do
     context "given a hash" do
       it "returns the correct output" do
         expect(include(foo: "bar", baz: "qux").description).to eq(
-          'include (foo: "bar", baz: "qux")',
+          'include (foo: "bar", baz: "qux")'
         )
       end
     end

data/spec/unit/rspec/matchers/match_array_spec.rb

@@ -3,8 +3,8 @@ require "spec_helper"
 RSpec.describe "RSpec's `match_array` matcher" do
   describe "#description" do
     it "returns the correct output" do
-      expect(match_array([:foo, :bar, :baz]).description).to eq(
-        "match array with :foo, :bar and :baz",
+      expect(match_array(%i[foo bar baz]).description).to eq(
+        "match array with :foo, :bar and :baz"
       )
     end
   end

data/spec/unit/rspec/matchers/raise_error_spec.rb

@@ -5,39 +5,71 @@ RSpec.describe "RSpec's `raise_error` matcher" do
     context "given only an exception class" do
       it "returns the correct output" do
         expect(raise_error(RuntimeError).description).to eq(
-          %|raise error #<RuntimeError>|,
+          "raise a kind of RuntimeError"
         )
       end
     end
 
-    context "with only a message (and assuming a RuntimeError)" do
+    context "given only a string message" do
       it "returns the correct output" do
         expect(raise_error("hell").description).to eq(
-          %|raise error #<Exception "hell">|,
+          %|raise a kind of Exception with message "hell"|
         )
       end
     end
 
-    context "with regular expression as message (and assuming a RuntimeError)" do
+    context "given only a regexp message" do
       it "returns the correct output" do
-        expect(raise_error(/hell/).description).to eq(
-          %|raise error #<Exception /hell/>|,
+        expect(raise_error(/hell/i).description).to eq(
+          "raise a kind of Exception with message matching /hell/i"
         )
       end
     end
 
-    context "with both an exception and a message" do
+    context "given both an exception and string message" do
       it "returns the correct output" do
         expect(raise_error(RuntimeError, "hell").description).to eq(
-          %|raise error #<RuntimeError "hell">|,
+          %|raise a kind of RuntimeError with message "hell"|
         )
       end
     end
 
-    context "with an exception and a regular expression as message" do
+    context "given both an exception and regexp message" do
       it "returns the correct output" do
-        expect(raise_error(RuntimeError, /hell/).description).to eq(
-          %|raise error #<RuntimeError /hell/>|,
+        expect(raise_error(RuntimeError, /hell/i).description).to eq(
+          "raise a kind of RuntimeError with message matching /hell/i"
+        )
+      end
+    end
+
+    context "given a simple RSpec matcher" do
+      it "returns the correct output" do
+        expect(raise_error(a_kind_of(RuntimeError)).description).to eq(
+          "raise #<a kind of RuntimeError>"
+        )
+      end
+    end
+
+    context "given a simple RSpec matcher and string message" do
+      it "returns the correct output" do
+        expect(raise_error(a_kind_of(RuntimeError), "boo").description).to eq(
+          'raise #<a kind of RuntimeError> with message "boo"'
+        )
+      end
+    end
+
+    context "given a simple RSpec matcher and regexp message" do
+      it "returns the correct output" do
+        expect(raise_error(a_kind_of(RuntimeError), /boo/i).description).to eq(
+          "raise #<a kind of RuntimeError> with message matching /boo/i"
+        )
+      end
+    end
+
+    context "given a compound RSpec matcher" do
+      it "returns the correct output" do
+        expect(raise_error(a_kind_of(Array).or eq(true)).description).to eq(
+          "raise #<a kind of Array or eq true>"
         )
       end
     end

data/spec/unit/rspec/matchers/respond_to_spec.rb

@@ -5,26 +5,27 @@ RSpec.describe "RSpec's `respond_to` matcher" do
     context "without any qualifiers" do
       it "returns the correct output" do
         expect(respond_to(:foo, :bar, :baz).description).to eq(
-          "respond to :foo, :bar and :baz",
+          "respond to :foo, :bar and :baz"
         )
       end
     end
 
     context "qualified with #with + #arguments" do
       it "returns the correct output" do
-        expect(respond_to(:foo, :bar, :baz).with(3).arguments.description).
-          to eq("respond to :foo, :bar and :baz with 3 arguments")
+        expect(
+          respond_to(:foo, :bar, :baz).with(3).arguments.description
+        ).to eq("respond to :foo, :bar and :baz with 3 arguments")
       end
     end
 
     context "qualified with #with_keywords" do
       it "returns the correct output" do
-        matcher = respond_to(:foo, :bar, :baz).
-          with_keywords(:qux, :blargh, :fizz)
+        matcher =
+          respond_to(:foo, :bar, :baz).with_keywords(:qux, :blargh, :fizz)
 
         expect(matcher.description).to eq(
           "respond to :foo, :bar and :baz with keywords :qux, :blargh " +
-          "and :fizz",
+            "and :fizz"
         )
       end
     end
@@ -34,7 +35,7 @@ RSpec.describe "RSpec's `respond_to` matcher" do
         matcher = respond_to(:foo, :bar, :baz).with_any_keywords
 
         expect(matcher.description).to eq(
-          "respond to :foo, :bar and :baz with any keywords",
+          "respond to :foo, :bar and :baz with any keywords"
         )
       end
     end
@@ -44,33 +45,39 @@ RSpec.describe "RSpec's `respond_to` matcher" do
         matcher = respond_to(:foo, :bar, :baz).with_unlimited_arguments
 
         expect(matcher.description).to eq(
-          "respond to :foo, :bar and :baz with unlimited arguments",
+          "respond to :foo, :bar and :baz with unlimited arguments"
         )
       end
     end
 
     context "qualified with #with_any_keywords + #with_unlimited_arguments" do
       it "returns the correct output" do
-        matcher = respond_to(:foo, :bar, :baz).
-          with_any_keywords.
-          with_unlimited_arguments
+        matcher =
+          respond_to(
+            :foo,
+            :bar,
+            :baz
+          ).with_any_keywords.with_unlimited_arguments
 
         expect(matcher.description).to eq(
           "respond to :foo, :bar and :baz with any keywords and unlimited " +
-          "arguments",
+            "arguments"
         )
       end
     end
 
     context "qualified with #with_keywords + #with_unlimited_arguments" do
       it "returns the correct output" do
-        matcher = respond_to(:foo, :bar, :baz).
-          with_keywords(:qux, :blargh, :fizz).
-          with_unlimited_arguments
+        matcher =
+          respond_to(:foo, :bar, :baz).with_keywords(
+            :qux,
+            :blargh,
+            :fizz
+          ).with_unlimited_arguments
 
         expect(matcher.description).to eq(
           "respond to :foo, :bar and :baz with keywords :qux, :blargh and " +
-          ":fizz and unlimited arguments",
+            ":fizz and unlimited arguments"
         )
       end
     end

data/spec/unit/rspec/object_inspection/rspec_matcher_spec.rb

@@ -0,0 +1,91 @@
+require "spec_helper"
+
+RSpec.describe SuperDiff, type: :unit do
+  describe ".inspect_object", "for RSpec matchers" do
+    context "given a custom matcher" do
+      let(:custom_matcher) do
+        proc do |expected, &block_arg|
+          declarations =
+            proc do
+              match do |actual|
+                actual.is_a?(Integer) && actual >= 0 &&
+                  (Math.sqrt(actual) % 1).zero?
+              end
+              description { "be a perfect square" }
+            end
+          RSpec::Matchers::DSL::Matcher.new(
+            :be_a_square,
+            declarations,
+            RSpec::Matchers::DSL,
+            *expected,
+            &block_arg
+          )
+        end
+      end
+
+      context "given as_lines: false" do
+        it "returns the matcher's description string" do
+          string =
+            described_class.inspect_object(
+              custom_matcher.call(4),
+              as_lines: false
+            )
+          expect(string).to eq("#<be a perfect square>")
+        end
+      end
+
+      context "given as_lines: true" do
+        it "returns an inspected version of the matcher as multiple lines" do
+          tiered_lines =
+            described_class.inspect_object(
+              custom_matcher.call(4),
+              as_lines: true,
+              type: :delete,
+              indentation_level: 1
+            )
+          expect(tiered_lines).to match(
+            [
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 1,
+                value: "#<be a perfect square>"
+              )
+            ]
+          )
+        end
+      end
+    end
+
+    context "given a built-in matcher" do
+      let(:matcher) { be_a(Numeric) }
+
+      context "given as_lines: false" do
+        it "returns the matcher's description string" do
+          string = described_class.inspect_object(matcher, as_lines: false)
+          expect(string).to eq("#<be a kind of Numeric>")
+        end
+      end
+
+      context "given as_lines: true" do
+        it "returns an inspected version of the matcher as multiple lines" do
+          tiered_lines =
+            described_class.inspect_object(
+              matcher,
+              as_lines: true,
+              type: :delete,
+              indentation_level: 1
+            )
+          expect(tiered_lines).to match(
+            [
+              an_object_having_attributes(
+                type: :delete,
+                indentation_level: 1,
+                value: "#<be a kind of Numeric>"
+              )
+            ]
+          )
+        end
+      end
+    end
+  end
+end