Convert {single,multi}_line to {single,multi}line where appropriate

mcmire · mcmire · commit 122115fbbf88 · 2019-09-09T19:09:31.000-06:00
* When "single line" is used as adjective, spell it as `singleline`. Same
  for "multi line".
* When "single line" is used as a noun, spell it as `single_line`. Same
  for "multi line".
diff --git a/lib/super_diff/diff_formatters.rb b/lib/super_diff/diff_formatters.rb
@@ -4,9 +4,9 @@ module DiffFormatters
     autoload :Base, "super_diff/diff_formatters/base"
     autoload :Collection, "super_diff/diff_formatters/collection"
     autoload :Hash, "super_diff/diff_formatters/hash"
-    autoload :MultiLineString, "super_diff/diff_formatters/multi_line_string"
+    autoload :MultilineString, "super_diff/diff_formatters/multiline_string"
     autoload :Object, "super_diff/diff_formatters/object"
 
-    DEFAULTS = [Array, Hash, MultiLineString].freeze
+    DEFAULTS = [Array, Hash, MultilineString].freeze
   end
 end
diff --git a/lib/super_diff/diff_formatters/collection.rb b/lib/super_diff/diff_formatters/collection.rb
@@ -63,7 +63,7 @@ def contents
       def build_chunk(value, prefix:, icon:)
         inspection = ObjectInspection.inspect(
           value,
-          single_line: false,
+          as_single_line: false,
         )
 
         inspection.split("\n").
diff --git a/lib/super_diff/diff_formatters/multiline_string.rb b/lib/super_diff/diff_formatters/multiline_string.rb
@@ -1,8 +1,8 @@
 module SuperDiff
   module DiffFormatters
-    class MultiLineString < Base
+    class MultilineString < Base
       def self.applies_to?(operations)
-        operations.is_a?(OperationSequences::MultiLineString)
+        operations.is_a?(OperationSequences::MultilineString)
       end
 
       def call
diff --git a/lib/super_diff/differs.rb b/lib/super_diff/differs.rb
@@ -4,9 +4,9 @@ module Differs
     autoload :Array, "super_diff/differs/array"
     autoload :Empty, "super_diff/differs/empty"
     autoload :Hash, "super_diff/differs/hash"
-    autoload :MultiLineString, "super_diff/differs/multi_line_string"
+    autoload :MultilineString, "super_diff/differs/multiline_string"
     autoload :Object, "super_diff/differs/object"
 
-    DEFAULTS = [Array, Hash, MultiLineString, Object, Empty].freeze
+    DEFAULTS = [Array, Hash, MultilineString, Object, Empty].freeze
   end
 end
diff --git a/lib/super_diff/differs/multiline_string.rb b/lib/super_diff/differs/multiline_string.rb
@@ -1,13 +1,13 @@
 module SuperDiff
   module Differs
-    class MultiLineString < Base
+    class MultilineString < Base
       def self.applies_to?(expected, actual)
         expected.is_a?(::String) && actual.is_a?(::String) &&
           (expected.include?("\n") || actual.include?("\n"))
       end
 
       def call
-        DiffFormatters::MultiLineString.call(
+        DiffFormatters::MultilineString.call(
           operations,
           indent_level: indent_level,
         )
@@ -16,7 +16,7 @@ def call
       private
 
       def operations
-        OperationalSequencers::MultiLineString.call(
+        OperationalSequencers::MultilineString.call(
           expected: expected,
           actual: actual,
           extra_operational_sequencer_classes: extra_operational_sequencer_classes,
diff --git a/lib/super_diff/equality_matchers.rb b/lib/super_diff/equality_matchers.rb
@@ -3,19 +3,19 @@ module EqualityMatchers
     autoload :Array, "super_diff/equality_matchers/array"
     autoload :Base, "super_diff/equality_matchers/base"
     autoload :Hash, "super_diff/equality_matchers/hash"
-    autoload :MultiLineString, "super_diff/equality_matchers/multi_line_string"
+    autoload :MultilineString, "super_diff/equality_matchers/multiline_string"
     autoload :Object, "super_diff/equality_matchers/object"
     autoload :Primitive, "super_diff/equality_matchers/primitive"
     autoload(
-      :SingleLineString,
-      "super_diff/equality_matchers/single_line_string",
+      :SinglelineString,
+      "super_diff/equality_matchers/singleline_string",
     )
 
     DEFAULTS = [
       Array,
       Hash,
-      MultiLineString,
-      SingleLineString,
+      MultilineString,
+      SinglelineString,
       Object,
       Primitive,
     ].freeze
diff --git a/lib/super_diff/equality_matchers/array.rb b/lib/super_diff/equality_matchers/array.rb
@@ -13,14 +13,14 @@ def fail
             Helpers.style(
               :deleted,
               "Expected: " +
-              ObjectInspection.inspect(expected, single_line: true),
+              ObjectInspection.inspect(expected, as_single_line: true),
             )
           }
           #{
             Helpers.style(
               :inserted,
               "  Actual: " +
-              ObjectInspection.inspect(actual, single_line: true),
+              ObjectInspection.inspect(actual, as_single_line: true),
             )
           }
 
diff --git a/lib/super_diff/equality_matchers/hash.rb b/lib/super_diff/equality_matchers/hash.rb
@@ -13,14 +13,14 @@ def fail
             Helpers.style(
               :deleted,
               "Expected: " +
-              ObjectInspection.inspect(expected, single_line: true),
+              ObjectInspection.inspect(expected, as_single_line: true),
             )
           }
           #{
             Helpers.style(
               :inserted,
               "  Actual: " +
-              ObjectInspection.inspect(actual, single_line: true),
+              ObjectInspection.inspect(actual, as_single_line: true),
             )
           }
 
diff --git a/lib/super_diff/equality_matchers/multiline_string.rb b/lib/super_diff/equality_matchers/multiline_string.rb
@@ -1,6 +1,6 @@
 module SuperDiff
   module EqualityMatchers
-    class MultiLineString < Base
+    class MultilineString < Base
       def self.applies_to?(value)
         value.is_a?(::String) && value.include?("\n")
       end
@@ -14,14 +14,14 @@ def fail
             Helpers.style(
               :deleted,
               "Expected: " +
-              ObjectInspection.inspect(expected, single_line: true),
+              ObjectInspection.inspect(expected, as_single_line: true),
             )
           }
           #{
             Helpers.style(
               :inserted,
               "  Actual: " +
-              ObjectInspection.inspect(actual, single_line: true),
+              ObjectInspection.inspect(actual, as_single_line: true),
             )
           }
 
@@ -34,7 +34,7 @@ def fail
       private
 
       def diff
-        Differs::MultiLineString.call(
+        Differs::MultilineString.call(
           expected,
           actual,
           indent_level: 0,
diff --git a/lib/super_diff/equality_matchers/object.rb b/lib/super_diff/equality_matchers/object.rb
@@ -13,14 +13,14 @@ def fail
             Helpers.style(
               :deleted,
               "Expected: " +
-              ObjectInspection.inspect(expected, single_line: true),
+              ObjectInspection.inspect(expected, as_single_line: true),
             )
           }
           #{
             Helpers.style(
               :inserted,
               "  Actual: " +
-              ObjectInspection.inspect(actual, single_line: true),
+              ObjectInspection.inspect(actual, as_single_line: true),
             )
           }
 
diff --git a/lib/super_diff/equality_matchers/primitive.rb b/lib/super_diff/equality_matchers/primitive.rb
@@ -17,14 +17,14 @@ def fail
             Helpers.style(
               :deleted,
               "Expected: " +
-              ObjectInspection.inspect(expected, single_line: true),
+              ObjectInspection.inspect(expected, as_single_line: true),
             )
           }
           #{
             Helpers.style(
               :inserted,
               "  Actual: " +
-              ObjectInspection.inspect(actual, single_line: true),
+              ObjectInspection.inspect(actual, as_single_line: true),
             )
           }
         OUTPUT
diff --git a/lib/super_diff/equality_matchers/singleline_string.rb b/lib/super_diff/equality_matchers/singleline_string.rb
@@ -1,6 +1,6 @@
 module SuperDiff
   module EqualityMatchers
-    class SingleLineString < Base
+    class SinglelineString < Base
       def self.applies_to?(value)
         value.class == ::String
       end
@@ -13,14 +13,14 @@ def fail
             Helpers.style(
               :deleted,
               "Expected: " +
-              ObjectInspection.inspect(expected, single_line: true),
+              ObjectInspection.inspect(expected, as_single_line: true),
             )
           }
           #{
             Helpers.style(
               :inserted,
               "  Actual: " +
-              ObjectInspection.inspect(actual, single_line: true),
+              ObjectInspection.inspect(actual, as_single_line: true),
             )
           }
         OUTPUT
diff --git a/lib/super_diff/object_inspection.rb b/lib/super_diff/object_inspection.rb
@@ -12,10 +12,10 @@ class << self
       attr_accessor :inspector_finder
     end
 
-    def self.inspect(object, single_line:, indent_level: 0)
+    def self.inspect(object, as_single_line:, indent_level: 0)
       inspector_finder.call(object).evaluate(
         object,
-        single_line: single_line,
+        as_single_line: as_single_line,
         indent_level: indent_level,
       )
     end
diff --git a/lib/super_diff/object_inspection/inspection_tree.rb b/lib/super_diff/object_inspection/inspection_tree.rb
@@ -19,11 +19,11 @@ def before_each_callbacks
         @_before_each_callbacks ||= Hash.new { |h, k| h[k] = [] }
       end
 
-      def evaluate(object, single_line:, indent_level:)
+      def evaluate(object, as_single_line:, indent_level:)
         nodes.reduce("") do |str, node|
           str << node.evaluate(
             object,
-            single_line: single_line,
+            as_single_line: as_single_line,
             indent_level: indent_level,
           )
         end
@@ -128,13 +128,13 @@ def build_node(type, *args, &block)
       class BlockArgument
         attr_reader :object
 
-        def initialize(object:, single_line:)
+        def initialize(object:, as_single_line:)
           @object = object
-          @single_line = single_line
+          @as_single_line = as_single_line
         end
 
-        def single_line?
-          @single_line
+        def as_single_line?
+          @as_single_line
         end
       end
     end
diff --git a/lib/super_diff/object_inspection/nodes/base.rb b/lib/super_diff/object_inspection/nodes/base.rb
@@ -36,7 +36,7 @@ def type
         end
 
         # rubocop:disable Lint/UnusedMethodArgument
-        def evaluate(object, indent_level:, single_line:)
+        def evaluate(object, indent_level:, as_single_line:)
         # rubocop:enable Lint/UnusedMethodArgument
           raise NotImplementedError.new(
             "Your node must provide an #evaluate method. " +
@@ -71,13 +71,13 @@ def pretty_print_variables
           end
         end
 
-        def evaluate_in_subtree(object, indent_level:, single_line:)
+        def evaluate_in_subtree(object, indent_level:, as_single_line:)
           subtree = InspectionTree.new
           subtree.evaluate_block(object, &block)
           subtree.evaluate(
             object,
             indent_level: indent_level,
-            single_line: single_line,
+            as_single_line: as_single_line,
           )
         end
       end
diff --git a/lib/super_diff/object_inspection/nodes/break.rb b/lib/super_diff/object_inspection/nodes/break.rb
@@ -2,8 +2,8 @@ module SuperDiff
   module ObjectInspection
     module Nodes
       class Break < Base
-        def evaluate(_object, indent_level:, single_line:)
-          if single_line
+        def evaluate(_object, indent_level:, as_single_line:)
+          if as_single_line
             immediate_value.to_s
           else
             "\n#{"  " * indent_level}"
diff --git a/lib/super_diff/object_inspection/nodes/inspection.rb b/lib/super_diff/object_inspection/nodes/inspection.rb
@@ -2,11 +2,11 @@ module SuperDiff
   module ObjectInspection
     module Nodes
       class Inspection < Base
-        def evaluate(_object, indent_level:, single_line:)
+        def evaluate(_object, indent_level:, as_single_line:)
           SuperDiff::ObjectInspection.inspect(
             immediate_value,
             indent_level: indent_level,
-            single_line: single_line,
+            as_single_line: as_single_line,
           )
         end
       end
diff --git a/lib/super_diff/object_inspection/nodes/nesting.rb b/lib/super_diff/object_inspection/nodes/nesting.rb
@@ -2,11 +2,11 @@ module SuperDiff
   module ObjectInspection
     module Nodes
       class Nesting < Base
-        def evaluate(object, indent_level:, single_line:)
+        def evaluate(object, indent_level:, as_single_line:)
           evaluate_in_subtree(
             object,
             indent_level: indent_level + 1,
-            single_line: single_line,
+            as_single_line: as_single_line,
             &block
           )
         end
diff --git a/lib/super_diff/object_inspection/nodes/when_multiline.rb b/lib/super_diff/object_inspection/nodes/when_multiline.rb
@@ -2,14 +2,14 @@ module SuperDiff
   module ObjectInspection
     module Nodes
       class WhenMultiline < Base
-        def evaluate(object, indent_level:, single_line:)
-          if single_line
+        def evaluate(object, indent_level:, as_single_line:)
+          if as_single_line
             ""
           elsif block
             evaluate_in_subtree(
               object,
               indent_level: indent_level,
-              single_line: single_line,
+              as_single_line: as_single_line,
               &block
             )
           else
diff --git a/lib/super_diff/object_inspection/nodes/when_singleline.rb b/lib/super_diff/object_inspection/nodes/when_singleline.rb
@@ -2,15 +2,15 @@ module SuperDiff
   module ObjectInspection
     module Nodes
       class WhenSingleline < Base
-        def evaluate(object, indent_level:, single_line:)
-          if single_line
+        def evaluate(object, indent_level:, as_single_line:)
+          if as_single_line
             if immediate_value
               immediate_value
             else
               evaluate_in_subtree(
                 object,
                 indent_level: indent_level,
-                single_line: single_line,
+                as_single_line: as_single_line,
                 &block
               )
             end
diff --git a/lib/super_diff/operational_sequencers.rb b/lib/super_diff/operational_sequencers.rb
@@ -4,8 +4,8 @@ module OperationalSequencers
     autoload :Base, "super_diff/operational_sequencers/base"
     autoload :Hash, "super_diff/operational_sequencers/hash"
     autoload(
-      :MultiLineString,
-      "super_diff/operational_sequencers/multi_line_string",
+      :MultilineString,
+      "super_diff/operational_sequencers/multiline_string",
     )
     autoload :Object, "super_diff/operational_sequencers/object"
 
diff --git a/lib/super_diff/operational_sequencers/multiline_string.rb b/lib/super_diff/operational_sequencers/multiline_string.rb
@@ -1,6 +1,6 @@
 module SuperDiff
   module OperationalSequencers
-    class MultiLineString < Base
+    class MultilineString < Base
       def self.applies_to?(expected, actual)
         expected.is_a?(::String) && actual.is_a?(::String) &&
           (expected.include?("\n") || actual.include?("\n"))
diff --git a/lib/super_diff/rspec/failure_message_builders/base.rb b/lib/super_diff/rspec/failure_message_builders/base.rb
@@ -18,7 +18,7 @@ def call(negated:)
         end
 
         def matcher_description
-          Csi.decolorize(expected_section.to_s(singleline: true))
+          Csi.decolorize(expected_section.to_s(as_single_line: true))
         end
 
         protected
diff --git a/lib/super_diff/rspec/failure_message_template.rb b/lib/super_diff/rspec/failure_message_template.rb
diff --git a/lib/super_diff/rspec/monkey_patches.rb b/lib/super_diff/rspec/monkey_patches.rb
diff --git a/spec/unit/object_inspection_spec.rb b/spec/unit/object_inspection_spec.rb

Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ def contents`
`63`	`63`	`def build_chunk(value, prefix:, icon:)`
`64`	`64`	`inspection = ObjectInspection.inspect(`
`65`	`65`	`value,`
`66`		`- single_line: false,`
	`66`	`+ as_single_line: false,`
`67`	`67`	`)`
`68`	`68`
`69`	`69`	`inspection.split("\n").`
Original file line number	Diff line number	Diff line change
`@@ -13,14 +13,14 @@ def fail`
`13`	`13`	`Helpers.style(`
`14`	`14`	`:deleted,`
`15`	`15`	`"Expected: " +`
`16`		`- ObjectInspection.inspect(expected, single_line: true),`
	`16`	`+ ObjectInspection.inspect(expected, as_single_line: true),`
`17`	`17`	`)`
`18`	`18`	`}`
`19`	`19`	`#{`
`20`	`20`	`Helpers.style(`
`21`	`21`	`:inserted,`
`22`	`22`	`" Actual: " +`
`23`		`- ObjectInspection.inspect(actual, single_line: true),`
	`23`	`+ ObjectInspection.inspect(actual, as_single_line: true),`
`24`	`24`	`)`
`25`	`25`	`}`
`26`	`26`