riffdiff 1.0.0 → 1.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 210ce8cd2057687ae39b1fd6f93078acb85c578d
-  data.tar.gz: 90be3c51cad7ff1b544a5bdf70ca8f8057d531d2
+  metadata.gz: ab9270780987e9731750adac81951e66b7e0cf74
+  data.tar.gz: ae9e29dd801bf4502dcb651581ce99573946410b
 SHA512:
-  metadata.gz: 6e0d1fb16f8140c63c52ed73e39e50b88350b50cc74fdb0da898b51d127ddadaa35a1eab71e23d952e3c6c26c01162e63d268208ff37975367395d231cf6ec17
-  data.tar.gz: e34e17529688e520ae3638097805789a9c3a11a701f53e55ab9ec208079f173b40c3f07186d648ab6ec8800f3c97892c447d3fd106fcbe43b21d7592268be7ce
+  metadata.gz: eee0b5d29449d2fe3bb8201a6c8b68f8ee96b835518b8b18e6659b8657403387ae04dbe3ae767c1951dd42acaf68c2b31cb154e49e151a3700d77cb74690633b
+  data.tar.gz: 827c93ab1f9ea4217083d43823815390fb01397280370571e14fbd6e0f7a97daae94c9b8fb2b6f52c376b714617906c739088d80662d8f6f0ed6455991caaaa4

data/.rubocop.yml

@@ -24,3 +24,19 @@ Style/RedundantReturn:
 # Johan thinks these are OK as long as there aren't too many of them
 Style/PerlBackrefs:
   Enabled: false
+
+# Johan thinks "unless" is hard to read
+Style/NegatedIf:
+  Enabled: false
+
+# Johan finds the default method length limit of 10 silly
+Metrics/MethodLength:
+  Max: 20
+
+# Johan looked at some methods and concluded 21 is fine
+Metrics/AbcSize:
+  Max: 21
+
+# Johan looked at some methods and concluded 7 is fine
+Metrics/CyclomaticComplexity:
+  Max: 7

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+script: rake package

data/README.md

@@ -23,9 +23,6 @@ Optionally followed by...
 ... to make git show refined diffs by default.
 
 # TODO
-* When highlighting an added comma at the end of a line, followed by some added
-lines, remove the leading + from the first line and don't color it. We should
-still show the comma in reverse video though.
 * Think about highlighting whitespace errors like Git does
 * Think about how to visualize an added line break together with some
 indentation on the following line.
@@ -120,3 +117,8 @@ globally on the system.
   * test dirty sources
   * not package dirty sources
   * package clean sources, dependencies not verified
+* When highlighting an added comma at the end of a line, followed by some added
+  lines, remove the leading + from the first line and don't color it. We should
+  still show the comma in reverse video though. Do this when:
+    * One line is replaced by many
+    * The diff contains only additions

data/Rakefile

@@ -7,11 +7,18 @@ include Version
 
 task default: :spec
 desc 'Run the unit tests (default)'
-task spec: [:deps]
+task spec: [:deps, :lint]
 RSpec::Core::RakeTask.new do |t|
   t.pattern = FileList['spec/**/*_spec.rb']
 end
 
+desc 'Lint the source code'
+task :lint do
+  # Everything except bin/benchmark; it's not used in production and is unlikely
+  # to change anyway
+  sh 'rubocop lib spec bin/riff Rakefile riffdiff.gemspec'
+end
+
 desc 'Create a .gem package'
 task package: [:spec] do
   fail 'Cannot package when there are uncommitted sources' if dirty?

data/lib/diff_string.rb

@@ -7,6 +7,7 @@ require 'colors'
 class DiffString
   include Colors
 
+  # Note that the color argument can be the empty string
   def initialize(prefix, color)
     @reverse = false
     @prefix = prefix

data/lib/options.rb

@@ -5,9 +5,7 @@ require 'version'
 module Options
   include Version
 
-  def handle_options
-    opts = Slop::Options.new do |o|
-      o.banner = <<-EOS
+  BANNER = <<-EOS
 Usage: diff ... | riff
 Colors diff and highlights what parts of changed lines have changed.
 
@@ -15,6 +13,10 @@ Git integration:
     git config --global pager.diff riff
     git config --global pager.show riff
 EOS
+
+  def create_opts
+    return Slop::Options.new do |o|
+      o.banner = BANNER
       o.separator 'Options:'
       o.on '--version', 'Print version information and exit' do
         puts "riff #{version}"
@@ -31,6 +33,10 @@ EOS
         exit
       end
     end
+  end
+
+  def handle_options
+    opts = create_opts()
 
     begin
       opts.parse(ARGV)

data/lib/refiner.rb

@@ -95,20 +95,62 @@ class Refiner
     return try_highlight(old, new)
   end
 
+  def render_refinement(prefix, color, string, highlights, base_index = 0)
+    return_me = DiffString.new(prefix, color)
+    string.each_char.with_index do |char, index|
+      return_me.add(char, highlights.include?(index + base_index))
+    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)
+    @refined_old = render_refinement('-', RED, old, old_highlights)
+    @refined_new = render_refinement('+', GREEN, new, new_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)
+    if old_highlights.count > 0
+      return false
+    end
+    if old.lines.count != 1
+      return false
+    end
+    lines = new.lines
+    if lines.count < 2
+      return false
+    end
+
+    @refined_old = ''
+
+    refined_line_1 = render_refinement(' ', '', lines[0], new_highlights)
+
+    line_2_index_0 = lines[0].length
+    refined_remaining_lines = render_refinement('+', GREEN,
+                                                lines[1..-1].join,
+                                                new_highlights,
+                                                line_2_index_0)
+
+    @refined_new = refined_line_1 + refined_remaining_lines
+
+    return true
+  end
+
   def initialize(old, new)
     old_highlights, new_highlights = try_highlight(old, new)
     if old_highlights.size == 0 && new_highlights.size == 0
       old_highlights, new_highlights = try_highlight_initial_lines(old, new)
     end
 
-    @refined_old = DiffString.new('-', RED)
-    old.each_char.with_index do |char, index|
-      @refined_old.add(char, old_highlights.include?(index))
-    end
-
-    @refined_new = DiffString.new('+', GREEN)
-    new.each_char.with_index do |char, index|
-      @refined_new.add(char, new_highlights.include?(index))
+    if !create_one_to_many_refinements(old, new,
+                                       old_highlights,
+                                       new_highlights)
+      create_refinements(old, new, old_highlights, new_highlights)
     end
   end
 end

data/lib/riff.rb

@@ -4,6 +4,8 @@ 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 = /^@@ /
@@ -107,8 +109,8 @@ class Riff
     return '' if @replace_old.empty? && @replace_new.empty?
 
     refiner = Refiner.new(@replace_old, @replace_new)
-    return_me = refiner.refined_old.to_s
-    return_me += refiner.refined_new.to_s
+    return_me = refiner.refined_old
+    return_me += refiner.refined_new
 
     @replace_old = ''
     @replace_new = ''

data/riffdiff.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.name        = 'riffdiff'
   s.version     = semantic_version
   s.summary     = 'A diff highlighter showing what parts of lines have changed'
-  s.description = %{== Riff
+  s.description = %(== Riff
 Riff is a wrapper around diff that highlights not only which lines have changed,
 but also which parts of the lines that have changed.
 
@@ -23,7 +23,7 @@ $ git config --global pager.show riff
 
 ... then all future 'git diff's and 'git show's will be
 refined.
-}
+)
   s.authors     = ['Johan Walles']
   s.email       = 'johan.walles@gmail.com'
   s.homepage    = 'http://github.com/walles/riff'
@@ -39,7 +39,9 @@ refined.
   s.required_ruby_version = '~> 2.0'
 
   s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'rubocop', '~> 0.29.1'
+  s.add_development_dependency 'rake', '~> 0.9'
 
-  s.add_runtime_dependency 'diff-lcs', '~> 1.2.5'
-  s.add_runtime_dependency 'slop', '~> 4.1.0'
+  s.add_runtime_dependency 'diff-lcs', '~> 1.2'
+  s.add_runtime_dependency 'slop', '~> 4.1'
 end

data/spec/refiner_spec.rb

@@ -9,9 +9,9 @@ RSpec.describe Refiner, '#new' do
     refiner = Refiner.new(%('quoted'\n), %("quoted"\n))
 
     it 'highlights the quotes and nothing else' do
-      expect(refiner.refined_old.to_s).to eq(
+      expect(refiner.refined_old).to eq(
         %(#{RED}-#{reversed("'")}quoted#{reversed("'")}#{RESET}\n))
-      expect(refiner.refined_new.to_s).to eq(
+      expect(refiner.refined_new).to eq(
         %(#{GREEN}+#{reversed('"')}quoted#{reversed('"')}#{RESET}\n))
     end
   end
@@ -20,11 +20,11 @@ RSpec.describe Refiner, '#new' do
     refiner = Refiner.new('', "something\n")
 
     it 'refines old to the empty string' do
-      expect(refiner.refined_old.to_s).to eq('')
+      expect(refiner.refined_old).to eq('')
     end
 
     it 'does not highlight anything in new' do
-      expect(refiner.refined_new.to_s).to eq(
+      expect(refiner.refined_new).to eq(
         %(#{GREEN}+something#{RESET}\n))
     end
   end
@@ -33,12 +33,12 @@ RSpec.describe Refiner, '#new' do
     refiner = Refiner.new("something\n", '')
 
     it 'does not highlight anything in old' do
-      expect(refiner.refined_old.to_s).to eq(
+      expect(refiner.refined_old).to eq(
         %(#{RED}-something#{RESET}\n))
     end
 
     it 'refines new to the empty string' do
-      expect(refiner.refined_new.to_s).to eq('')
+      expect(refiner.refined_new).to eq('')
     end
   end
 
@@ -46,9 +46,9 @@ RSpec.describe Refiner, '#new' do
     refiner = Refiner.new(%(x "hej"\n), %(x 'hej'\n))
 
     it 'highlights the quotes and nothing else' do
-      expect(refiner.refined_old.to_s).to eq(
+      expect(refiner.refined_old).to eq(
         %(#{RED}-x #{reversed('"')}hej#{reversed('"')}#{RESET}\n))
-      expect(refiner.refined_new.to_s).to eq(
+      expect(refiner.refined_new).to eq(
         %(#{GREEN}+x #{reversed("'")}hej#{reversed("'")}#{RESET}\n))
     end
   end
@@ -58,9 +58,9 @@ RSpec.describe Refiner, '#new' do
                           "abcdefghij\n")
 
     it %(doesn't highlight anything) do
-      expect(refiner.refined_old.to_s).to eq(
+      expect(refiner.refined_old).to eq(
         %(#{RED}-0123456789#{RESET}\n))
-      expect(refiner.refined_new.to_s).to eq(
+      expect(refiner.refined_new).to eq(
         %(#{GREEN}+abcdefghij#{RESET}\n))
     end
   end
@@ -70,15 +70,15 @@ RSpec.describe Refiner, '#new' do
                           "abcde\n")
 
     it %(highlights the newline) do
-      expect(refiner.refined_old.to_s).to eq(
+      expect(refiner.refined_old).to eq(
         %(#{RED}-abcde#{RESET}\n))
-      expect(refiner.refined_new.to_s).to eq(
+      expect(refiner.refined_new).to eq(
         %(#{GREEN}+abcde#{reversed('↵')}#{RESET}\n))
     end
 
     it %(ends in a newline) do
-      expect(refiner.refined_old.to_s).to end_with("\n")
-      expect(refiner.refined_new.to_s).to end_with("\n")
+      expect(refiner.refined_old).to end_with("\n")
+      expect(refiner.refined_new).to end_with("\n")
     end
   end
 
@@ -87,15 +87,15 @@ RSpec.describe Refiner, '#new' do
                           'abcde')
 
     it %(highlights the newline) do
-      expect(refiner.refined_old.to_s).to eq(
+      expect(refiner.refined_old).to eq(
         %(#{RED}-abcde#{reversed('↵')}#{RESET}\n))
-      expect(refiner.refined_new.to_s).to eq(
+      expect(refiner.refined_new).to eq(
         %(#{GREEN}+abcde#{RESET}\n))
     end
 
     it %(ends in a newline) do
-      expect(refiner.refined_old.to_s).to end_with("\n")
-      expect(refiner.refined_new.to_s).to end_with("\n")
+      expect(refiner.refined_old).to end_with("\n")
+      expect(refiner.refined_new).to end_with("\n")
     end
   end
 
@@ -105,11 +105,44 @@ RSpec.describe Refiner, '#new' do
                           "fffff,\n" \
                           "ggggg\n")
 
-    it %(highlights the comma on the first line, but not the two extra lines) do
-      expect(refiner.refined_old.to_s).to eq(
-        %(#{RED}-abcde#{RESET}\n))
-      expect(refiner.refined_new.to_s).to eq(
+    it %(pretends first line is unchanged, but highlights comma) do
+      expect(refiner.refined_old).to eq('')
+      expect(refiner.refined_new).to eq(
+        %( abcde#{reversed(',')}\n) +
+        %(#{GREEN}+fffff,\n) +
+        %(#{GREEN}+ggggg#{RESET}\n))
+    end
+  end
+
+  context %(with two lines turning into many) do
+    refiner = Refiner.new("abcde\n" \
+                          "fffff\n",
+                          "abcde,\n" \
+                          "fffff,\n" \
+                          "ggggg\n")
+
+    it %(highlights the comma on the first two lines, but not the extra line) do
+      expect(refiner.refined_old).to eq(
+        %(#{RED}-abcde\n) +
+        %(#{RED}-fffff#{RESET}\n))
+      expect(refiner.refined_new).to eq(
         %(#{GREEN}+abcde#{reversed(',')}\n) +
+        %(#{GREEN}+fffff#{reversed(',')}\n) +
+        %(#{GREEN}+ggggg#{RESET}\n))
+    end
+  end
+
+  context %(with one line being replaced with many) do
+    refiner = Refiner.new("abcdx\n",
+                          "abcde,\n" \
+                          "fffff,\n" \
+                          "ggggg\n")
+
+    it %(highlights both adds and removes on the first line) do
+      expect(refiner.refined_old).to eq(
+        %(#{RED}-abcd#{reversed('x')}#{RESET}\n))
+      expect(refiner.refined_new).to eq(
+        %(#{GREEN}+abcd#{reversed('e,')}\n) +
         %(#{GREEN}+fffff,\n) +
         %(#{GREEN}+ggggg#{RESET}\n))
     end
@@ -122,11 +155,11 @@ RSpec.describe Refiner, '#new' do
                           "abcde\n")
 
     it %(highlights the first removed comma, but not the two removed lines) do
-      expect(refiner.refined_old.to_s).to eq(
+      expect(refiner.refined_old).to eq(
         %(#{RED}-abcde#{reversed(',')}\n) +
         %(#{RED}-fffff,\n) +
         %(#{RED}-ggggg#{RESET}\n))
-      expect(refiner.refined_new.to_s).to eq(
+      expect(refiner.refined_new).to eq(
         %(#{GREEN}+abcde#{RESET}\n))
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riffdiff
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.19
 platform: ruby
 authors:
 - Johan Walles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-07 00:00:00.000000000 Z
+date: 2015-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,34 +24,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.29.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.29.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: diff-lcs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.5
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.5
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: slop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '4.1'
 description: |
   == Riff
   Riff is a wrapper around diff that highlights not only which lines have changed,
@@ -77,6 +105,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md