riffdiff 1.0.36 → 1.0.48

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bcb6d863874cfd88533c0efabba5b2b475fab716
-  data.tar.gz: 907345ad32b196b83ed2287cfe77e4c65b6747ce
+  metadata.gz: d95f2bec7e95f1926db693ed9995fc867fd387e3
+  data.tar.gz: 9863771e381648a0f786020691e77652948aa14b
 SHA512:
-  metadata.gz: 3f3ca9298aa7fbf023c80b5326b77911ca5dcc0c9d09b52bbd43d3d54ecd064c78ae9326ea42376f49415e0807ac0b549ab005f34e05c8c3fead907b252fcee8
-  data.tar.gz: 266d9594e38e8ec4254eddab4fc697a6f1a265d3b3e32a85260fef146a47b16b4c71fb179d55ff9b7993c52f3259b5529ab478c19dc2502edbd29c75b7c242f2
+  metadata.gz: 37ffcb842e39e386e019d56dff9bcefd5e6720aef94210fe6e325c5286923cdc27f2b70b327e654334697b0c323bf83b535b3399d453461e745f373285bdea4d
+  data.tar.gz: 6e8ff4707345cf558dd5495039dcd6096ad40c0c77ec0e613891a0eeb08da31a26143283be1918e634f76c89f6b979e5052f1b8de0c6d7dd9204b1c5335c22bf

data/.rubocop.yml

@@ -45,3 +45,6 @@ Metrics/CyclomaticComplexity:
 # Configuration parameters: CountKeywordArgs.
 Metrics/ParameterLists:
   CountKeywordArgs: false
+
+Metrics/ClassLength:
+  Max: 132

data/README.md

@@ -25,9 +25,10 @@ Optionally followed by...
 # TODO
 * Think about highlighting whitespace errors like Git does
  * OK: Make DiffString.add() take a color as well
- * Add a whitespace analysis pass to the Refiner
- * Let the Refiner highlight whitespace errors among the added lines in reverse
- red.
+ * OK: Add a trailing whitespace analysis pass to the Refiner
+ * OK: Let the Refiner highlight whitespace errors among the added lines in
+ reverse red.
+ * Add highlighting of non-leading tabs to the whitespace analysis
 * Think about how to visualize an added line break together with some
 indentation on the following line.
 * Do "git show 57f27da" and think about what rule we should use to get

data/lib/refiner.rb

@@ -2,6 +2,9 @@ require 'set'
 require 'diff/lcs'
 require 'diff_string'
 
+require 'colors'
+require 'whitespace_lint'
+
 # Compute longest common substring based diff between two strings.
 #
 # The diff format is first the old string:
@@ -15,6 +18,7 @@ require 'diff_string'
 # * added characters highlighted in inverse video
 class Refiner
   include Colors
+  include WhitespaceLint
 
   attr_reader :refined_old
   attr_reader :refined_new
@@ -33,7 +37,7 @@ class Refiner
         when '+'
           new_highlights << highlight.position
         else
-          fail("Unsupported diff type: <#{type}>")
+          fail("Unsupported diff action: <#{action}>")
         end
       end
     end
@@ -95,28 +99,44 @@ class Refiner
     return try_highlight(old, new)
   end
 
-  def render_refinement(prefix, color, string, highlights,
-                        base_index: 0, highlight_color: '')
-    return_me = DiffString.new(prefix, color)
+  # ws: a set containing the whitespace errors we want to highlight
+  def render_refinement(prefix, base_color, string, highlights,
+                        base_index: 0, highlight_color: '',
+                        ws: nil)
+    return_me = DiffString.new(prefix, base_color)
     string.each_char.with_index do |char, index|
       highlight = highlights.include?(index + base_index)
-      return_me.add(char, highlight, highlight ? highlight_color : '')
+      color = highlight ? highlight_color : ''
+
+      if !ws.nil? && ws.include?(index + base_index)
+        # Highlight whitespace error in inverse red
+        color = RED
+        highlight = true
+      end
+
+      return_me.add(char, highlight, color)
     end
     return return_me.to_s
   end
 
   # After returning from this method, both @refined_old and @refined_new must
   # have been set to reasonable values.
-  def create_refinements(old, new, old_highlights, new_highlights)
+  def create_refinements(old, new,
+                         old_highlights, new_highlights,
+                         whitespace_highlights)
     @refined_old = render_refinement('-', RED, old, old_highlights)
-    @refined_new = render_refinement('+', GREEN, new, new_highlights)
+    @refined_new = render_refinement('+', GREEN,
+                                     new, new_highlights,
+                                     ws: whitespace_highlights)
   end
 
   # After returning from this method, both @refined_old and @refined_new must
   # have been set to reasonable values.
   #
   # Returns false if the preconditions for using this method aren't fulfilled
-  def create_one_to_many_refinements(old, new, old_highlights, new_highlights)
+  def create_one_to_many_refinements(old, new,
+                                     old_highlights, new_highlights,
+                                     whitespace_highlights)
     # If things have been removed from the first line, the specialized
     # highlighting won't work
     return false if old_highlights.count > 0
@@ -136,13 +156,15 @@ class Refiner
 
     refined_line_1 =
       render_refinement(' ', '', lines[0], new_highlights,
-                        highlight_color: GREEN)
+                        highlight_color: GREEN,
+                        ws: whitespace_highlights)
 
     line_2_index_0 = lines[0].length
     refined_remaining_lines = render_refinement('+', GREEN,
                                                 lines[1..-1].join,
                                                 new_highlights,
-                                                base_index: line_2_index_0)
+                                                base_index: line_2_index_0,
+                                                ws: whitespace_highlights)
 
     @refined_new = refined_line_1 + refined_remaining_lines
 
@@ -155,10 +177,15 @@ class Refiner
       old_highlights, new_highlights = try_highlight_initial_lines(old, new)
     end
 
+    whitespace_highlights = collect_ws_highlights(new)
+
     if !create_one_to_many_refinements(old, new,
                                        old_highlights,
-                                       new_highlights)
-      create_refinements(old, new, old_highlights, new_highlights)
+                                       new_highlights,
+                                       whitespace_highlights)
+      create_refinements(old, new,
+                         old_highlights, new_highlights,
+                         whitespace_highlights)
     end
   end
 end

data/lib/riff.rb

@@ -4,8 +4,6 @@ require 'diff_string'
 
 # Call do_stream() with the output of some diff-like tool (diff,
 # diff3, git diff, ...) and it will highlight that output for you.
-#
-# rubocop:disable Metrics/ClassLength
 class Riff
   DIFF_HEADER = /^diff /
   DIFF_HUNK_HEADER = /^@@ /

data/lib/whitespace_lint.rb

@@ -0,0 +1,34 @@
+# Whitespace error linter
+module WhitespaceLint
+  def add_line_highlights(line, base_index, highlights)
+    last_seen_whitespace = -1
+    last_seen_non_ws = -1
+    line.each_char.with_index do |char, index|
+      break if char == "\n"
+      break if char == "\r"
+
+      if char == ' ' || char == "\t"
+        last_seen_whitespace = index
+      else
+        last_seen_non_ws = index
+      end
+    end
+
+    if last_seen_non_ws < last_seen_whitespace
+      ((last_seen_non_ws + 1)..last_seen_whitespace).each do |index|
+        highlights << (base_index + index)
+      end
+    end
+  end
+
+  def collect_ws_highlights(string)
+    highlights = Set.new()
+    line_start_index = 0
+    string.each_line do |line|
+      add_line_highlights(line, line_start_index, highlights)
+
+      line_start_index += line.length
+    end
+    return highlights
+  end
+end

data/spec/refiner_spec.rb

@@ -65,6 +65,52 @@ RSpec.describe Refiner, '#new' do
     end
   end
 
+  context %(adding line with text + space) do
+    refiner = Refiner.new('', "text \n")
+
+    it %(highlights the final space in inverse red) do
+      expect(refiner.refined_new).to eq(
+        %(#{GREEN}+text#{reversed("#{RED} ")}#{GREEN}#{RESET}\n))
+    end
+  end
+
+  context %(adding two lines, second with text + space) do
+    refiner = Refiner.new('', "text\ntext \n")
+
+    it %(highlights the final space in inverse red) do
+      expect(refiner.refined_new).to eq(
+        %(#{GREEN}+text\n) +
+        %(#{GREEN}+text#{reversed("#{RED} ")}#{GREEN}#{RESET}\n))
+    end
+  end
+
+  context %(adding line with only a space) do
+    refiner = Refiner.new('', " \n")
+
+    it %(highlights the space in inverse red) do
+      expect(refiner.refined_new).to eq(
+        %(#{GREEN}+#{reversed("#{RED} ")}#{GREEN}#{RESET}\n))
+    end
+  end
+
+  context %(adding line with only a tab) do
+    refiner = Refiner.new('', "\t\n")
+
+    it %(highlights the tab in inverse red) do
+      expect(refiner.refined_new).to eq(
+        %(#{GREEN}+#{reversed("#{RED}\t")}#{GREEN}#{RESET}\n))
+    end
+  end
+
+  context %(replacing final char of line with a space) do
+    refiner = Refiner.new("text\n", "tex \n")
+
+    it %(highlights final space of added line in inverse red) do
+      expect(refiner.refined_new).to eq(
+        %(#{GREEN}+tex#{reversed("#{RED} ")}#{GREEN}#{RESET}\n))
+    end
+  end
+
   context %(with added ending newline) do
     refiner = Refiner.new('abcde',
                           "abcde\n")

data/spec/whitespace_lint_spec.rb

@@ -0,0 +1,47 @@
+require 'whitespace_lint'
+
+include WhitespaceLint
+
+RSpec.describe WhitespaceLint, '#collect_ws_highlights' do
+  context 'empty string' do
+    it 'returns an empty set' do
+      expect(collect_ws_highlights('')).to be_empty
+    end
+  end
+
+  context 'a line that is fine' do
+    it 'returns an empty set' do
+      expect(collect_ws_highlights("\t text\n")).to be_empty
+    end
+  end
+
+  context 'line with only a space' do
+    it 'highlights the space' do
+      expect(collect_ws_highlights(" \n")).to eq(Set.new [0])
+    end
+  end
+
+  context 'line with only a tab' do
+    it 'highlights the tab' do
+      expect(collect_ws_highlights("\t\n")).to eq(Set.new [0])
+    end
+  end
+
+  context 'line with text + space' do
+    it 'highlights the space' do
+      expect(collect_ws_highlights("012 \n")).to eq(Set.new [3])
+    end
+  end
+
+  context 'two lines, second ending in space' do
+    string = "012\n345 \n"
+
+    it 'highlights the space' do
+      highlights = collect_ws_highlights(string)
+      expect(highlights.size).to eq(1)
+
+      highlight = highlights.to_a()[0]
+      expect(string[highlight]).to eq(' ')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riffdiff
 version: !ruby/object:Gem::Version
-  version: 1.0.36
+  version: 1.0.48
 platform: ruby
 authors:
 - Johan Walles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-02 00:00:00.000000000 Z
+date: 2015-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -119,6 +119,7 @@ files:
 - lib/refiner.rb
 - lib/riff.rb
 - lib/version.rb
+- lib/whitespace_lint.rb
 - riffdiff.gemspec
 - spec/added-newline-at-eof.diff
 - spec/colors_spec.rb
@@ -129,6 +130,7 @@ files:
 - spec/removed-newline-at-eof.diff
 - spec/riff_spec.rb
 - spec/version_spec.rb
+- spec/whitespace_lint_spec.rb
 homepage: http://github.com/walles/riff
 licenses:
 - MIT
@@ -163,3 +165,4 @@ test_files:
 - spec/removed-newline-at-eof.diff
 - spec/riff_spec.rb
 - spec/version_spec.rb
+- spec/whitespace_lint_spec.rb