diffy 3.0.7 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cd5d2b187c4063456f8a018845cfa199d09b345
-  data.tar.gz: 9e83a4e588db04b655db5c64c30e8fda39201b4b
+  metadata.gz: 926beeabce14fc2e5d5faa98b5ce2254d41fc9c4
+  data.tar.gz: 3d6f3d718606ab9d2a264b6e2d32285f164fd047
 SHA512:
-  metadata.gz: b031cbc1697f4334aa62df5eff024c51e89546225f386a38345feac5e73590bb7992862032c7fd99741a0c1e4fb47e7819c06348b72a7efbc70d88ce46172ec5
-  data.tar.gz: e524bece45facd115127d8f1a8814f0b8acc94b77e54caa87931312db00693d8ab55ebff76c00321733d13f04c8635d3d242c11389881f1ff83ad3a3748fe64a
+  metadata.gz: e2b63ca155a9eaa8360a2f17cb259aaf208ac1c7e84c36b1c7451a9bd0ebdbca4b110e12d286f7584018e011a6eed36eee520a2f5a44419300d0ba336acd8cb0
+  data.tar.gz: 6692ef85960a14e3e21e336760eb085991aa1bd480544146ec18241b3e2919807160f0e0e74cb60bda6c7f8bbab3de4b571379de79b80b8cff0759a5d8d84400

data/CHANGELOG

@@ -1,3 +1,6 @@
+== 3.1.0 ==
+Side by side diffs.  Thanks Runar Skaare Tveiten!
+
 == 3.0.5 ==
 Improve performance when generating html output (with inline highlighting) on
 long lines. Thanks Jason Barnabe!

data/README.md

@@ -1,4 +1,4 @@
-Diffy - Easy Diffing With Ruby [![Build Status](https://secure.travis-ci.org/samg/diffy.png)](http://travis-ci.org/samg/diffy)
+Diffy - Easy Diffing With Ruby [![Build Status](https://travis-ci.org/samg/diffy.svg?branch=master)](https://travis-ci.org/samg/diffy)
 ============================
 
 Need diffs in your ruby app?  Diffy has you covered.  It provides a convenient
@@ -126,6 +126,81 @@ There's some pretty nice css provided in `Diffy::CSS`.
     .diff li.diff-comment { display: none; }
     .diff li.diff-block-info { background: none repeat scroll 0 0 gray; }
 
+
+There's also a colorblind-safe version of the pallete provided in `Diffy::CSS_COLORBLIND_1`.
+
+
+Side-by-side comparisons
+------------------------
+
+Side-by-side comparisons, or split views as called by some, are supported by
+using the `Diffy::SplitDiff` class.  This class takes a diff returned from
+`Diffy::Diff` and splits it in two parts (or two sides): left and right.  The
+left side represents deletions while the right side represents insertions.
+
+The class is used as follows:
+
+```
+Diffy::SplitDiff.new(string1, string2, options = {})
+```
+
+The optional options hash is passed along to the main `Diff::Diff` class, so
+all default options such as full diff output are supported.  The output format
+may be changed by passing the format with the options hash (see below), and all
+default formats are supported.
+
+Unlinke `Diffy::Diff`, `Diffy::SplitDiff` does not use `#to_s` to output
+the resulting diff.  Instead, two self-explanatory methods are used to output
+the diff; `#left` and `#right`.  Using the earlier example, this is what they
+look like in action:
+
+```
+>> puts Diffy::SplitDiff.new(string1, string2).left
+-Hello how are you
+ I'm fine
+-That's great
+```
+
+```
+>> puts Diffy::SplitDiff.new(string1, string2).right
++Hello how are you?
+ I'm fine
++That's swell
+```
+
+### Changing the split view output format
+
+The output format may be changed by passing the format with the options hash:
+
+```
+Diffy::SplitDiff.new(string1, string2, :format => :html)
+```
+
+This will result in the following:
+
+```
+>> puts Diffy::SplitDiff.new(string1, string2, :format => :html).left
+<div class="diff">
+  <ul>
+    <li class="del"><del>Hello how are you</del></li>
+    <li class="unchanged"><span>I&#39;m fine</span></li>
+    <li class="del"><del>That&#39;s <strong>great</strong></del></li>
+  </ul>
+</div>
+```
+
+```
+>> puts Diffy::SplitDiff.new(string1, string2, :format => :html).right
+<div class="diff">
+  <ul>
+    <li class="ins"><ins>Hello how are you<strong>?</strong></ins></li>
+    <li class="unchanged"><span>I&#39;m fine</span></li>
+    <li class="ins"><ins>That&#39;s <strong>swell</strong></ins></li>
+  </ul>
+</div>
+```
+
+
 Other Diff Options
 ------------------
 

data/lib/diffy.rb

@@ -9,4 +9,5 @@ require 'open3' unless Diffy::WINDOWS
 require File.join(File.dirname(__FILE__), 'diffy', 'format')
 require File.join(File.dirname(__FILE__), 'diffy', 'html_formatter')
 require File.join(File.dirname(__FILE__), 'diffy', 'diff')
+require File.join(File.dirname(__FILE__), 'diffy', 'split_diff')
 require File.join(File.dirname(__FILE__), 'diffy', 'css')

data/lib/diffy/css.rb

@@ -14,4 +14,21 @@ module Diffy
 .diff li.diff-comment { display: none; }
 .diff li.diff-block-info { background: none repeat scroll 0 0 gray; }
   STYLE
+
+  CSS_COLORBLIND_1 = <<-STYLE
+.diff{overflow:auto;}
+.diff ul{background:#fff;overflow:auto;font-size:13px;list-style:none;margin:0;padding:0;display:table;width:100%;}
+.diff del, .diff ins{display:block;text-decoration:none;}
+.diff li{padding:0; display:table-row;margin: 0;height:1em;}
+.diff li.ins{background:#ddf; color:#008}
+.diff li.del{background:#fee; color:#b00}
+.diff li:hover{background:#ffc}
+/* try 'whitespace:pre;' if you don't want lines to wrap */
+.diff del, .diff ins, .diff span{white-space:pre-wrap;font-family:courier;}
+.diff del strong{font-weight:normal;background:#fcc;}
+.diff ins strong{font-weight:normal;background:#99f;}
+.diff li.diff-comment { display: none; }
+.diff li.diff-block-info { background: none repeat scroll 0 0 gray; }
+  STYLE
+
 end

data/lib/diffy/split_diff.rb

@@ -0,0 +1,49 @@
+module Diffy
+  class SplitDiff
+    def initialize(left, right, options = {})
+      @format = options[:format] || Diffy::Diff.default_format
+
+      formats = Format.instance_methods(false).map { |x| x.to_s }
+      unless formats.include?(@format.to_s)
+        fail ArgumentError, "Format #{format.inspect} is not a valid format"
+      end
+
+      @diff = Diffy::Diff.new(left, right, options).to_s(@format)
+      @left_diff, @right_diff = split
+    end
+
+    %w(left right).each do |direction|
+      define_method direction do
+        instance_variable_get("@#{direction}_diff")
+      end
+    end
+
+    private
+
+    def split
+      [split_left, split_right]
+    end
+
+    def split_left
+      case @format
+      when :color
+        @diff.gsub(/\033\[32m\+(.*)\033\[0m\n/, '')
+      when :html, :html_simple
+        @diff.gsub(%r{\s+<li class="ins"><ins>(.*)</ins></li>}, '')
+      when :text
+        @diff.gsub(/^\+(.*)\n/, '')
+      end
+    end
+
+    def split_right
+      case @format
+      when :color
+        @diff.gsub(/\033\[31m\-(.*)\033\[0m\n/, '')
+      when :html, :html_simple
+        @diff.gsub(%r{\s+<li class="del"><del>(.*)</del></li>}, '')
+      when :text
+        @diff.gsub(/^-(.*)\n/, '')
+      end
+    end
+  end
+end

data/lib/diffy/version.rb

@@ -1,3 +1,3 @@
 module Diffy
-  VERSION = '3.0.7'
+  VERSION = '3.1.0'
 end

data/spec/diffy_spec.rb

@@ -588,6 +588,73 @@ baz
   end
 end
 
+describe Diffy::SplitDiff do
+  before do
+    ::Diffy::Diff.default_options.merge!(:diff => '-U 10000')
+  end
+
+  it "should fail with invalid format" do
+    expected_fail = expect do
+      Diffy::SplitDiff.new("lorem\n", "ipsum\n", :format => :fail)
+    end
+    expected_fail.to raise_error(ArgumentError)
+  end
+
+  describe "#left" do
+    it "should only highlight deletions" do
+      string1 = "lorem\nipsum\ndolor\nsit amet\n"
+      string2 = "lorem\nipsumdolor\nsit amet\n"
+      expect(Diffy::SplitDiff.new(string1, string2).left).to eq <<-TEXT
+ lorem
+-ipsum
+-dolor
+ sit amet
+      TEXT
+    end
+
+    it "should also format left diff as html" do
+      string1 = "lorem\nipsum\ndolor\nsit amet\n"
+      string2 = "lorem\nipsumdolor\nsit amet\n"
+      expect(Diffy::SplitDiff.new(string1, string2, :format => :html).left).to eq <<-HTML
+<div class="diff">
+  <ul>
+    <li class="unchanged"><span>lorem</span></li>
+    <li class="del"><del>ipsum<strong></strong></del></li>
+    <li class="del"><del><strong></strong>dolor</del></li>
+    <li class="unchanged"><span>sit amet</span></li>
+  </ul>
+</div>
+      HTML
+    end
+  end
+
+  describe "#right" do
+    it "should only highlight insertions" do
+      string1 = "lorem\nipsum\ndolor\nsit amet\n"
+      string2 = "lorem\nipsumdolor\nsit amet\n"
+      expect(Diffy::SplitDiff.new(string1, string2).right).to eq <<-TEXT
+ lorem
++ipsumdolor
+ sit amet
+      TEXT
+    end
+
+    it "should also format right diff as html" do
+      string1 = "lorem\nipsum\ndolor\nsit amet\n"
+      string2 = "lorem\nipsumdolor\nsit amet\n"
+      expect(Diffy::SplitDiff.new(string1, string2, :format => :html).right).to eq <<-HTML
+<div class="diff">
+  <ul>
+    <li class="unchanged"><span>lorem</span></li>
+    <li class="ins"><ins>ipsumdolor</ins></li>
+    <li class="unchanged"><span>sit amet</span></li>
+  </ul>
+</div>
+      HTML
+    end
+  end
+end
+
 describe 'Diffy::CSS' do
   it "should be some css" do
     expect(Diffy::CSS).to include 'diff{overflow:auto;}'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: diffy
 version: !ruby/object:Gem::Version
-  version: 3.0.7
+  version: 3.1.0
 platform: ruby
 authors:
 - Sam Goldstein
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-12 00:00:00.000000000 Z
+date: 2015-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -60,6 +60,7 @@ files:
 - lib/diffy/diff.rb
 - lib/diffy/format.rb
 - lib/diffy/html_formatter.rb
+- lib/diffy/split_diff.rb
 - lib/diffy/version.rb
 - spec/demo_app.rb
 - spec/diffy_spec.rb
@@ -83,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A convenient way to diff string in ruby