Use attr_extras for method objects

mcmire · mcmire · commit 7d9836b68c34 · 2019-09-09T18:36:38.000-06:00
diff --git a/lib/super_diff.rb b/lib/super_diff.rb
@@ -1,5 +1,6 @@
-require "patience_diff"
+require "attr_extras/explicit"
 require "diff-lcs"
+require "patience_diff"
 
 require_relative "super_diff/csi"
 
diff --git a/lib/super_diff/diff_formatter.rb b/lib/super_diff/diff_formatter.rb
@@ -1,32 +1,27 @@
 module SuperDiff
   class DiffFormatter
-    def self.call(*args)
-      new(*args).call
-    end
+    extend AttrExtras.mixin
 
-    def initialize(
-      operations,
-      indent_level:,
-      add_comma: false,
-      extra_classes: []
+    method_object(
+      :operations,
+      [
+        :indent_level!,
+        add_comma: false,
+        extra_classes: [],
+      ],
     )
-      @operations = operations
-      @indent_level = indent_level
-      @add_comma = add_comma
-      @extra_classes = extra_classes
-    end
 
     def call
       resolved_class.call(
         operations,
         indent_level: indent_level,
-        add_comma: add_comma,
+        add_comma: add_comma?,
       )
     end
 
     private
 
-    attr_reader :operations, :indent_level, :add_comma, :extra_classes
+    attr_query :add_comma?
 
     def resolved_class
       (DiffFormatters::DEFAULTS + extra_classes).find do |klass|
diff --git a/lib/super_diff/diff_formatters/base.rb b/lib/super_diff/diff_formatters/base.rb
@@ -5,33 +5,28 @@ def self.applies_to?(_operations)
         raise NotImplementedError
       end
 
-      def self.call(*args)
-        new(*args).call
-      end
+      extend AttrExtras.mixin
 
-      def initialize(
-        operations,
-        indent_level:,
-        collection_prefix: "",
-        add_comma: false
+      method_object(
+        :operations,
+        [
+          :indent_level!,
+          collection_prefix: "",
+          add_comma: false,
+        ],
       )
-        @operations = operations
-        @indent_level = indent_level
-        @collection_prefix = collection_prefix
-        @add_comma = add_comma
-      end
 
       def call
         raise NotImplementedError
       end
 
+      # rubocop:disable Lint/UselessAccessModifier
+
       private
 
-      attr_reader :operations, :indent_level, :collection_prefix
+      # rubocop:enable Lint/UselessAccessModifier
 
-      def add_comma?
-        @add_comma
-      end
+      attr_query :add_comma?
     end
   end
 end
diff --git a/lib/super_diff/diff_formatters/collection.rb b/lib/super_diff/diff_formatters/collection.rb
@@ -4,36 +4,27 @@ class Collection
       ICONS = { delete: "-", insert: "+" }.freeze
       STYLES = { insert: :inserted, delete: :deleted, noop: :normal }.freeze
 
-      def self.call(*args, &block)
-        new(*args, &block).call
-      end
+      extend AttrExtras.mixin
 
-      def initialize(
-        open_token:,
-        close_token:,
-        operations:,
-        indent_level:,
-        add_comma:,
-        collection_prefix:,
-        build_item_prefix:
+      method_object(
+        [
+          :open_token!,
+          :close_token!,
+          :operations!,
+          :indent_level!,
+          :add_comma!,
+          :collection_prefix!,
+          :build_item_prefix!,
+        ]
       )
-        @open_token = open_token
-        @close_token = close_token
-        @operations = operations
-        @indent_level = indent_level
-        @add_comma = add_comma
-        @collection_prefix = collection_prefix
-        @build_item_prefix = build_item_prefix
-      end
 
       def call
         lines.join("\n")
       end
 
       private
 
-      attr_reader :open_token, :close_token, :operations, :indent_level,
-        :add_comma, :collection_prefix, :build_item_prefix
+      attr_query :add_comma?
 
       def lines
         [
@@ -100,7 +91,7 @@ def indentation(offset: 0)
       end
 
       def comma
-        if add_comma
+        if add_comma?
           ","
         else
           ""
diff --git a/lib/super_diff/differ.rb b/lib/super_diff/differ.rb
@@ -1,26 +1,18 @@
 module SuperDiff
   class Differ
-    def self.call(*args)
-      new(*args).call
-    end
+    extend AttrExtras.mixin
 
-    def initialize(
-      expected,
-      actual,
-      indent_level: 0,
-      index_in_collection: nil,
-      extra_classes: [],
-      extra_operational_sequencer_classes: [],
-      extra_diff_formatter_classes: []
+    method_object(
+      :expected,
+      :actual,
+      [
+        indent_level: 0,
+        index_in_collection: nil,
+        extra_classes: [],
+        extra_operational_sequencer_classes: [],
+        extra_diff_formatter_classes: [],
+      ],
     )
-      @expected = expected
-      @actual = actual
-      @indent_level = indent_level
-      @index_in_collection = index_in_collection
-      @extra_classes = extra_classes
-      @extra_operational_sequencer_classes = extra_operational_sequencer_classes
-      @extra_diff_formatter_classes = extra_diff_formatter_classes
-    end
 
     def call
       resolved_class.call(
@@ -35,10 +27,6 @@ def call
 
     private
 
-    attr_reader :expected, :actual, :indent_level, :index_in_collection,
-      :extra_classes, :extra_operational_sequencer_classes,
-      :extra_diff_formatter_classes
-
     def resolved_class
       (extra_classes + Differs::DEFAULTS).find do |klass|
         klass.applies_to?(expected, actual)
diff --git a/lib/super_diff/differs/base.rb b/lib/super_diff/differs/base.rb
@@ -1,39 +1,29 @@
 module SuperDiff
   module Differs
     class Base
-      def self.applies_to?(_value)
+      def self.applies_to?(_expected, _actual)
         raise NotImplementedError
       end
 
-      def self.call(*args)
-        new(*args).call
-      end
+      extend AttrExtras.mixin
 
-      def initialize(
-        expected,
-        actual,
-        indent_level:,
-        index_in_collection: nil,
-        extra_operational_sequencer_classes: [],
-        extra_diff_formatter_classes: []
+      method_object(
+        :expected,
+        :actual,
+        [
+          :indent_level!,
+          index_in_collection: nil,
+          extra_operational_sequencer_classes: [],
+          extra_diff_formatter_classes: [],
+        ],
       )
-        @expected = expected
-        @actual = actual
-        @indent_level = indent_level
-        @index_in_collection = index_in_collection
-        @extra_operational_sequencer_classes = extra_operational_sequencer_classes
-        @extra_diff_formatter_classes = extra_diff_formatter_classes
-      end
 
       def call
         raise NotImplementedError
       end
 
       protected
 
-      attr_reader :expected, :actual, :indent_level, :index_in_collection,
-        :extra_operational_sequencer_classes, :extra_diff_formatter_classes
-
       def indentation
         " " * (indent_level * 2)
       end
diff --git a/lib/super_diff/equality_matcher.rb b/lib/super_diff/equality_matcher.rb
@@ -1,22 +1,16 @@
 module SuperDiff
   class EqualityMatcher
-    def self.call(*args)
-      new(*args).call
-    end
+    extend AttrExtras.mixin
 
-    def initialize(
-      expected:,
-      actual:,
-      extra_classes: [],
-      extra_operational_sequencer_classes: [],
-      extra_diff_formatter_classes: []
+    method_object(
+      [
+        :expected!,
+        :actual!,
+        extra_classes: [],
+        extra_operational_sequencer_classes: [],
+        extra_diff_formatter_classes: [],
+      ]
     )
-      @expected = expected
-      @actual = actual
-      @extra_classes = extra_classes
-      @extra_operational_sequencer_classes = extra_operational_sequencer_classes
-      @extra_diff_formatter_classes = extra_diff_formatter_classes
-    end
 
     def call
       resolved_class.call(
@@ -29,9 +23,6 @@ def call
 
     private
 
-    attr_reader :expected, :actual, :extra_classes,
-      :extra_operational_sequencer_classes, :extra_diff_formatter_classes
-
     def resolved_class
       matching_class || EqualityMatchers::Object
     end
diff --git a/lib/super_diff/equality_matchers/base.rb b/lib/super_diff/equality_matchers/base.rb
@@ -5,21 +5,16 @@ def self.applies_to?(_value)
         raise NotImplementedError
       end
 
-      def self.call(*args)
-        new(*args).call
-      end
+      extend AttrExtras.mixin
 
-      def initialize(
-        expected:,
-        actual:,
-        extra_operational_sequencer_classes: [],
-        extra_diff_formatter_classes: []
+      method_object(
+        [
+          :expected!,
+          :actual!,
+          extra_operational_sequencer_classes: [],
+          extra_diff_formatter_classes: [],
+        ]
       )
-        @expected = expected
-        @actual = actual
-        @extra_operational_sequencer_classes = extra_operational_sequencer_classes
-        @extra_diff_formatter_classes = extra_diff_formatter_classes
-      end
 
       def call
         if expected == actual
@@ -31,9 +26,6 @@ def call
 
       protected
 
-      attr_reader :expected, :actual, :extra_operational_sequencer_classes,
-        :extra_diff_formatter_classes
-
       def fail
         raise NotImplementedError
       end
diff --git a/lib/super_diff/operational_sequencer.rb b/lib/super_diff/operational_sequencer.rb
@@ -1,20 +1,15 @@
 module SuperDiff
   class OperationalSequencer
-    def self.call(*args)
-      new(*args).call
-    end
+    extend AttrExtras.mixin
 
-    def initialize(
-      expected:,
-      actual:,
-      extra_classes: [],
-      extra_diff_formatter_classes: []
+    method_object(
+      [
+        :expected!,
+        :actual!,
+        extra_classes: [],
+        extra_diff_formatter_classes: [],
+      ],
     )
-      @expected = expected
-      @actual = actual
-      @extra_classes = extra_classes
-      @extra_diff_formatter_classes = extra_diff_formatter_classes
-    end
 
     def call
       if resolved_class
@@ -31,9 +26,6 @@ def call
 
     private
 
-    attr_reader :expected, :actual, :extra_classes,
-      :extra_diff_formatter_classes
-
     def resolved_class
       (extra_classes + OperationalSequencers::DEFAULTS).find do |klass|
         klass.applies_to?(expected, actual)
diff --git a/lib/super_diff/operational_sequencers/base.rb b/lib/super_diff/operational_sequencers/base.rb
diff --git a/super_diff.gemspec b/super_diff.gemspec
