super_diff 0.9.0 → 0.10.0

data/lib/super_diff/configuration.rb

@@ -5,16 +5,18 @@ module SuperDiff
       :extra_differ_classes,
       :extra_inspection_tree_builder_classes,
       :extra_operation_tree_builder_classes,
-      :extra_operation_tree_classes,
+      :extra_operation_tree_classes
     )
     attr_accessor(
       :actual_color,
       :border_color,
+      :color_enabled,
       :diff_elision_enabled,
       :diff_elision_maximum,
       :elision_marker_color,
       :expected_color,
       :header_color,
+      :key_enabled
     )
 
     def initialize(options = {})
@@ -31,6 +33,7 @@ module SuperDiff
       @extra_operation_tree_builder_classes = [].freeze
       @extra_operation_tree_classes = [].freeze
       @header_color = :white
+      @key_enabled = true
 
       merge!(options)
     end
@@ -54,6 +57,10 @@ module SuperDiff
       @diff_elision_enabled
     end
 
+    def key_enabled?
+      @key_enabled
+    end
+
     def merge!(configuration_or_options)
       options =
         if configuration_or_options.is_a?(self.class)
@@ -62,9 +69,7 @@ module SuperDiff
           configuration_or_options
         end
 
-      options.each do |key, value|
-        instance_variable_set("@#{key}", value)
-      end
+      options.each { |key, value| instance_variable_set("@#{key}", value) }
 
       updated
     end
@@ -79,7 +84,7 @@ module SuperDiff
     end
     alias_method(
       :add_extra_diff_formatter_class,
-      :add_extra_diff_formatter_classes,
+      :add_extra_diff_formatter_classes
     )
 
     def add_extra_differ_classes(*classes)
@@ -93,7 +98,7 @@ module SuperDiff
     end
     alias_method(
       :add_extra_inspection_tree_builder_class,
-      :add_extra_inspection_tree_builder_classes,
+      :add_extra_inspection_tree_builder_classes
     )
 
     def add_extra_operation_tree_builder_classes(*classes)
@@ -102,7 +107,7 @@ module SuperDiff
     end
     alias_method(
       :add_extra_operation_tree_builder_class,
-      :add_extra_operation_tree_builder_classes,
+      :add_extra_operation_tree_builder_classes
     )
 
     def add_extra_operation_tree_classes(*classes)
@@ -111,7 +116,7 @@ module SuperDiff
     end
     alias_method(
       :add_extra_operation_tree_class,
-      :add_extra_operation_tree_classes,
+      :add_extra_operation_tree_classes
     )
 
     def to_h
@@ -131,6 +136,7 @@ module SuperDiff
           extra_operation_tree_builder_classes.dup,
         extra_operation_tree_classes: extra_operation_tree_classes.dup,
         header_color: header_color,
+        key_enabled: key_enabled?
       }
     end
 

data/lib/super_diff/csi/color.rb

@@ -48,13 +48,13 @@ module SuperDiff
       attr_reader :layer
 
       def interpret_layer!(layer)
-        if [:foreground, :background].include?(layer)
+        if %i[foreground background].include?(layer)
           layer
         else
           raise ArgumentError.new(
-            "Invalid layer #{layer.inspect}. " +
-            "Layer must be :foreground or :background.",
-          )
+                  "Invalid layer #{layer.inspect}. " +
+                    "Layer must be :foreground or :background."
+                )
         end
       end
     end

data/lib/super_diff/csi/colorized_document.rb

@@ -11,9 +11,7 @@ module SuperDiff
       def colorize_block(colors, opts, &block)
         color_sequence = build_initial_color_sequence_from(colors, opts)
 
-        if color_sequences_open_in_parent.any?
-          add_part(Csi.reset_sequence)
-        end
+        add_part(Csi.reset_sequence) if color_sequences_open_in_parent.any?
 
         add_part(color_sequence)
         color_sequences_open_in_parent << color_sequence
@@ -34,15 +32,11 @@ module SuperDiff
         contents.each do |content|
           if content.is_a?(self.class)
             content.each do |part|
-              if part.is_a?(ColorSequenceBlock)
-                add_part(Csi.reset_sequence)
-              end
+              add_part(Csi.reset_sequence) if part.is_a?(ColorSequenceBlock)
 
               add_part(part)
 
-              if part.is_a?(ResetSequence)
-                add_part(color_sequence)
-              end
+              add_part(color_sequence) if part.is_a?(ResetSequence)
             end
           else
             add_part(content)
@@ -57,15 +51,17 @@ module SuperDiff
       attr_reader :color_sequences_open_in_parent
 
       def build_initial_color_sequence_from(colors, opts)
-        ColorSequenceBlock.new(colors).tap do |sequence|
-          if opts[:fg]
-            sequence << Color.resolve(opts[:fg], layer: :foreground)
-          end
+        ColorSequenceBlock
+          .new(colors)
+          .tap do |sequence|
+            if opts[:fg]
+              sequence << Color.resolve(opts[:fg], layer: :foreground)
+            end
 
-          if opts[:bg]
-            sequence << Color.resolve(opts[:bg], layer: :background)
+            if opts[:bg]
+              sequence << Color.resolve(opts[:bg], layer: :background)
+            end
           end
-        end
       end
     end
   end

data/lib/super_diff/csi/document.rb

@@ -7,9 +7,7 @@ module SuperDiff
         @parts = []
         @indentation_stack = []
 
-        if block
-          evaluate_block(&block)
-        end
+        evaluate_block(&block) if block
       end
 
       def each(&block)
@@ -21,9 +19,8 @@ module SuperDiff
       end
 
       def colorize(*args, **opts, &block)
-        contents, colors = args.partition do |arg|
-          arg.is_a?(String) || arg.is_a?(self.class)
-        end
+        contents, colors =
+          args.partition { |arg| arg.is_a?(String) || arg.is_a?(self.class) }
 
         if colors[0].is_a?(Symbol)
           if colors[0] == :colorize
@@ -47,13 +44,9 @@ module SuperDiff
         if block
           evaluate_block(&block)
         elsif contents.any?
-          contents.each do |part|
-            add_part(part)
-          end
+          contents.each { |part| add_part(part) }
         else
-          raise ArgumentError.new(
-            "Must have something to add to the document!",
-          )
+          raise ArgumentError.new("Must have something to add to the document!")
         end
       end
       alias_method :plain, :text
@@ -68,8 +61,8 @@ module SuperDiff
             text(*contents)
           else
             raise ArgumentError.new(
-              "Must have something to add to the document!",
-            )
+                    "Must have something to add to the document!"
+                  )
           end
         end
 
@@ -155,11 +148,7 @@ module SuperDiff
         end
 
         def wrapper
-          if for_line?
-            :line
-          else
-            :text
-          end
+          for_line? ? :line : :text
         end
       end
 

data/lib/super_diff/csi/eight_bit_color.rb

@@ -19,18 +19,18 @@ module SuperDiff
         bright_blue: 12,
         bright_magenta: 13,
         bright_cyan: 14,
-        bright_white: 15,
+        bright_white: 15
       }.freeze
       STARTING_INDICES = {
         standard: 0,
         high_intensity: 8,
-        grayscale: 232,
+        grayscale: 232
       }.freeze
       VALID_PAIR_TYPES = STARTING_INDICES.keys
       VALID_PAIR_INDEX_RANGES = {
         standard: 0..7,
         high_intensity: 0..7,
-        grayscale: 0..23,
+        grayscale: 0..23
       }.freeze
       LEADING_CODES_BY_LAYER = { foreground: 38, background: 48 }.freeze
       LAYERS_BY_LEADING_CODE = LEADING_CODES_BY_LAYER.invert.freeze
@@ -93,10 +93,10 @@ module SuperDiff
       def interpret_triplet!(red:, green:, blue:)
         if invalid_triplet?(red, green, blue)
           raise ArgumentError.new(
-            "(#{red},#{green},#{blue}) is not a valid color " +
-            "specification. All components must be between " +
-            "#{VALID_COMPONENT_RANGE.begin} and #{VALID_COMPONENT_RANGE.end}.",
-          )
+                  "(#{red},#{green},#{blue}) is not a valid color " +
+                    "specification. All components must be between " +
+                    "#{VALID_COMPONENT_RANGE.begin} and #{VALID_COMPONENT_RANGE.end}."
+                )
         end
 
         16 + 36 * red + 6 * green + blue
@@ -110,7 +110,7 @@ module SuperDiff
         if !VALID_CODES_BY_NAME.include?(name)
           message =
             "#{name.inspect} is not a valid color name.\n" +
-            "Valid names are:\n"
+              "Valid names are:\n"
 
           VALID_CODES_BY_NAME.keys.each do |valid_name|
             message << "- #{valid_name}\n"
@@ -125,19 +125,19 @@ module SuperDiff
       def interpret_pair!(type:, index:)
         if !VALID_PAIR_TYPES.include?(type)
           raise ArgumentError.new(
-            "Given pair did not have a valid type. " +
-            "Type must be one of: #{VALID_PAIR_TYPES}",
-          )
+                  "Given pair did not have a valid type. " +
+                    "Type must be one of: #{VALID_PAIR_TYPES}"
+                )
         end
 
         valid_range = VALID_PAIR_INDEX_RANGES[type]
 
         if !valid_range.cover?(index)
           raise ArgumentError.new(
-            "Given pair did not have a valid index. " +
-            "For #{type}, index must be between #{valid_range.begin} and " +
-            "#{valid_range.end}.",
-          )
+                  "Given pair did not have a valid index. " +
+                    "For #{type}, index must be between #{valid_range.begin} and " +
+                    "#{valid_range.end}."
+                )
         end
 
         STARTING_INDICES[type] + index
@@ -149,7 +149,7 @@ module SuperDiff
         if match
           {
             layer: interpret_layer!(match[1]),
-            code: interpret_code!(match[2].to_i),
+            code: interpret_code!(match[2].to_i)
           }
         end
       end
@@ -165,9 +165,9 @@ module SuperDiff
       def interpret_code!(code)
         if !VALID_CODE_RANGE.cover?(code)
           raise ArgumentError.new(
-            "#{code.inspect} is not a valid color code " +
-            "(must be between 0 and 255).",
-          )
+                  "#{code.inspect} is not a valid color code " +
+                    "(must be between 0 and 255)."
+                )
         end
 
         code

data/lib/super_diff/csi/four_bit_color.rb

@@ -1,31 +1,86 @@
 module SuperDiff
   module Csi
     class FourBitColor < Color
-      VALID_TYPES = [:foreground, :background].freeze
+      VALID_TYPES = %i[foreground background].freeze
       VALID_CODES_BY_NAME = {
-        black: { foreground: 30, background: 40 },
-        red: { foreground: 31, background: 41 },
-        green: { foreground: 32, background: 42 },
-        yellow: { foreground: 33, background: 43 },
-        blue: { foreground: 34, background: 44 },
-        magenta: { foreground: 35, background: 45 },
-        cyan: { foreground: 36, background: 46 },
-        white: { foreground: 37, background: 47 },
-        bright_black: { foreground: 90, background: 100 },
-        bright_red: { foreground: 91, background: 101 },
-        bright_green: { foreground: 92, background: 102 },
-        bright_yellow: { foreground: 93, background: 103 },
-        bright_blue: { foreground: 94, background: 104 },
-        bright_magenta: { foreground: 95, background: 105 },
-        bright_cyan: { foreground: 96, background: 106 },
-        bright_white: { foreground: 97, background: 107 },
+        black: {
+          foreground: 30,
+          background: 40
+        },
+        red: {
+          foreground: 31,
+          background: 41
+        },
+        green: {
+          foreground: 32,
+          background: 42
+        },
+        yellow: {
+          foreground: 33,
+          background: 43
+        },
+        blue: {
+          foreground: 34,
+          background: 44
+        },
+        magenta: {
+          foreground: 35,
+          background: 45
+        },
+        cyan: {
+          foreground: 36,
+          background: 46
+        },
+        white: {
+          foreground: 37,
+          background: 47
+        },
+        bright_black: {
+          foreground: 90,
+          background: 100
+        },
+        bright_red: {
+          foreground: 91,
+          background: 101
+        },
+        bright_green: {
+          foreground: 92,
+          background: 102
+        },
+        bright_yellow: {
+          foreground: 93,
+          background: 103
+        },
+        bright_blue: {
+          foreground: 94,
+          background: 104
+        },
+        bright_magenta: {
+          foreground: 95,
+          background: 105
+        },
+        bright_cyan: {
+          foreground: 96,
+          background: 106
+        },
+        bright_white: {
+          foreground: 97,
+          background: 107
+        }
       }.freeze
-      COLORS_BY_CODE = VALID_CODES_BY_NAME.reduce({}) do |hash, (name, value)|
-        hash.merge(
-          value[:foreground] => { name: name, layer: :foreground },
-          value[:background] => { name: name, layer: :background },
-        )
-      end
+      COLORS_BY_CODE =
+        VALID_CODES_BY_NAME.reduce({}) do |hash, (name, value)|
+          hash.merge(
+            value[:foreground] => {
+              name: name,
+              layer: :foreground
+            },
+            value[:background] => {
+              name: name,
+              layer: :background
+            }
+          )
+        end
       VALID_NAMES = VALID_CODES_BY_NAME.keys
       VALID_CODE_RANGES = [30..37, 40..47, 90..97, 100..107].freeze
       OPENING_REGEX = /\e\[(\d+)m/.freeze
@@ -72,11 +127,9 @@ module SuperDiff
         if !VALID_NAMES.include?(name)
           message =
             "#{name.inspect} is not a valid color name.\n" +
-            "Valid names are:\n"
+              "Valid names are:\n"
 
-          VALID_NAMES.each do |valid_name|
-            message << "- #{valid_name}"
-          end
+          VALID_NAMES.each { |valid_name| message << "- #{valid_name}" }
 
           raise ArgumentError.new(message)
         end
@@ -87,16 +140,14 @@ module SuperDiff
       def interpret_sequence!(sequence)
         match = sequence.match(OPENING_REGEX)
 
-        if match
-          interpret_code!(match[1].to_i)
-        end
+        interpret_code!(match[1].to_i) if match
       end
 
       def interpret_code!(code)
         if VALID_CODE_RANGES.none? { |range| range.cover?(code) }
           message =
             "#{code.inspect} is not a valid color code.\n" +
-            "Valid codes are:\n"
+              "Valid codes are:\n"
 
           VALID_CODE_RANGES.each do |range|
             message << "- #{range.begin} through #{range.end}\n"

data/lib/super_diff/csi/twenty_four_bit_color.rb

@@ -28,7 +28,7 @@ module SuperDiff
           SERIAL_CODE,
           triplet.red,
           triplet.blue,
-          triplet.green,
+          triplet.green
         ].join(";") + "m"
       end
 
@@ -37,7 +37,7 @@ module SuperDiff
           red: triplet.red,
           green: triplet.green,
           blue: triplet.blue,
-          layer: :foreground,
+          layer: :foreground
         )
       end
 
@@ -55,11 +55,12 @@ module SuperDiff
         if match
           {
             layer: interpret_layer!(match[1]),
-            triplet: interpret_triplet!(
-              red: match[2].to_i,
-              green: match[3].to_i,
-              blue: match[4].to_i,
-            ),
+            triplet:
+              interpret_triplet!(
+                red: match[2].to_i,
+                green: match[3].to_i,
+                blue: match[4].to_i
+              )
           }
         end
       end
@@ -67,10 +68,10 @@ module SuperDiff
       def interpret_triplet!(red:, green:, blue:)
         if invalid_triplet?(red, green, blue)
           raise ArgumentError.new(
-            "(#{red},#{green},#{blue}) is not a valid color " +
-            "specification. All components must be between " +
-            "#{VALID_COMPONENT_RANGE.begin} and #{VALID_COMPONENT_RANGE.end}.",
-          )
+                  "(#{red},#{green},#{blue}) is not a valid color " +
+                    "specification. All components must be between " +
+                    "#{VALID_COMPONENT_RANGE.begin} and #{VALID_COMPONENT_RANGE.end}."
+                )
         end
 
         Triplet.new(red: red, green: green, blue: blue)

data/lib/super_diff/csi/uncolorized_document.rb

@@ -10,9 +10,7 @@ module SuperDiff
       def colorize_inline(contents, *)
         contents.each do |content|
           if content.is_a?(self.class)
-            content.each do |part|
-              add_part(part)
-            end
+            content.each { |part| add_part(part) }
           else
             add_part(content)
           end
@@ -20,9 +18,7 @@ module SuperDiff
       end
 
       def add_part(part)
-        if !part.is_a?(ResetSequence) && !part.is_a?(ColorSequenceBlock)
-          super
-        end
+        super if !part.is_a?(ResetSequence) && !part.is_a?(ColorSequenceBlock)
       end
     end
   end

data/lib/super_diff/csi.rb

@@ -41,21 +41,17 @@ module SuperDiff
     end
 
     def self.inspect_colors_in(text)
-      [FourBitColor, EightBitColor, TwentyFourBitColor].
-        reduce(text) do |str, klass|
-          klass.sub_colorized_areas_in(str) do |area, color|
-            color_block = colorize("◼︎", color.to_foreground)
-
-            layer_indicator =
-              if color.foreground?
-                "(fg)"
-              else
-                "(bg)"
-              end
-
-            "#{color_block} #{layer_indicator} ❮#{area}❯"
-          end
+      [FourBitColor, EightBitColor, TwentyFourBitColor].reduce(
+        text
+      ) do |str, klass|
+        klass.sub_colorized_areas_in(str) do |area, color|
+          color_block = colorize("◼︎", color.to_foreground)
+
+          layer_indicator = (color.foreground? ? "(fg)" : "(bg)")
+
+          "#{color_block} #{layer_indicator} ❮#{area}❯"
         end
+      end
     end
 
     self.color_enabled = false