diffy 3.0.7 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2cd5d2b187c4063456f8a018845cfa199d09b345
-  data.tar.gz: 9e83a4e588db04b655db5c64c30e8fda39201b4b
+SHA256:
+  metadata.gz: ce6a165c4ad246372cf5e6888ca531c55da86a43051895900df4e466cef6c940
+  data.tar.gz: 066c70ac2cbd41e1d34c2a9fc68f9ba9b4cc1ccea132e289638c5aeb927c0ad6
 SHA512:
-  metadata.gz: b031cbc1697f4334aa62df5eff024c51e89546225f386a38345feac5e73590bb7992862032c7fd99741a0c1e4fb47e7819c06348b72a7efbc70d88ce46172ec5
-  data.tar.gz: e524bece45facd115127d8f1a8814f0b8acc94b77e54caa87931312db00693d8ab55ebff76c00321733d13f04c8635d3d242c11389881f1ff83ad3a3748fe64a
+  metadata.gz: 911e04010bddf3a49726684822857ffdc1f05b62017367afef5e022f56b2eeecf618282bf40f381901bbded973c06f2273cecb1ada0292f94337cfc2690a3d4a
+  data.tar.gz: a41fa95586a3f16ddcc19e5f3bbd6682d492cb4b0b44b1e6c16fcbd2556cd453d931720458d842caf04610a83067fb4b4daa86eef6010aa0f9d4da9110307cbd

data/.travis.yml

@@ -1,8 +1,15 @@
 language: ruby
+sudo: false
+cache: bundler
 rvm:
   - 1.8.7
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - 2.1.1
+  - 1.9.3-p551
+  - 2.0.0-p648
+  - 2.1.9
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0
+  - jruby-9.1.12.0
+matrix:
+  allow_failures:
+    - rvm: 1.8.7

data/CHANGELOG

@@ -1,3 +1,12 @@
+== 3.3.0 ==
+Fix diff lines that begin with -- or ++. Thanks @dark-panda!
+
+== 3.2.1 ==
+Fix default options on alpine linux.  Thanks @evgen!
+
+== 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/CONTRIBUTORS

@@ -10,3 +10,6 @@
 * Bryan Ricker
 * JasonBarnabe
 * Skye Shaw
+* Abinoam P. Marques Jr.
+* evgen
+* J Smith @dark-panda

data/Gemfile

@@ -4,7 +4,4 @@ platforms :rbx do
   gem 'rubysl', '~> 2.0'
 end
 
-
-group :test, :development do
-  gemspec
-end
+gemspec

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
@@ -24,11 +24,11 @@ A default format can be set like so:
 Installation
 ------------
 
-###on Unix
+### on Unix
 
     gem install diffy
 
-###on Windows:
+### on Windows:
 
 1.  Ensure that you have a working `diff` on your machine and in your search path.
 
@@ -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.
+
+Unlike `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
 ------------------
 
@@ -138,7 +213,7 @@ You can diff files instead of strings by using the `:source` option.
 ### Full Diff Output
 
 By default Diffy removes the superfluous diff output.  This is because its
-default is to show the complete diff'ed file (`diff -U 10000` is the default).
+default is to show the complete diff'ed file (`diff -U10000` is the default).
 
 Diffy does support full output, just use the `:include_diff_info => true`
 option when initializing:
@@ -195,13 +270,22 @@ file).
 ### Overriding the command line options passed to diff.
 
 You can use the `:diff` option to override the command line options that are
-passed to unix diff. They default to `-U 10000`.  This option will noop if
+passed to unix diff. They default to `-U10000`.  This option will noop if
 combined with the `:context` option.
 
     >> puts Diffy::Diff.new(" foo\nbar\n", "foo\nbar\n", :diff => "-w")
       foo
      bar
 
+### `:ignore_crlf` when doing HTML compares
+
+You can make the HTML output ignore the CRLF by passing the `:ignore_crlf` option a truthy value.
+
+    >> puts Diffy::Diff.new(" foo\nbar\n", "foo\r\nbar\r\n", ignore_crlf: true).to_s(:html)
+      "<div class=\"diff\"></div>"
+
+
+
 Default Diff Options
 --------------------
 
@@ -210,9 +294,9 @@ You can set the default options for new `Diffy::Diff`s using the
 Options passed to `Diffy::Diff.new` will be merged into the default options.
 
     >> Diffy::Diff.default_options
-    => {:diff=>"-U 10000", :source=>"strings", :include_diff_info=>false, :include_plus_and_minus_in_html=>false}
+    => {:diff=>"-U10000", :source=>"strings", :include_diff_info=>false, :include_plus_and_minus_in_html=>false}
     >> Diffy::Diff.default_options.merge!(:source => 'files')
-    => {:diff=>"-U 10000", :source=>"files", :include_diff_info=>false, :include_plus_and_minus_in_html=>false}
+    => {:diff=>"-U10000", :source=>"files", :include_diff_info=>false, :include_plus_and_minus_in_html=>false}
 
 
 Custom Formats
@@ -240,16 +324,6 @@ deletions, and unchanged in a diff.
 Use `#map`, `#inject`, or any of Enumerable's methods.  Go crazy.
 
 
-Ruby Version Compatibility
--------------------------
-
-Support for Ruby 1.8.6 was dropped beginning at version 2.0 in order to support
-the chainable enumerators available in 1.8.7 and 1.9.
-
-If you want to use Diffy and Ruby 1.8.6 then:
-
-    $ gem install diffy -v1.1.0
-
 Testing
 ------------
 

data/Rakefile

@@ -3,6 +3,8 @@ require 'rspec/core/rake_task'
 task :default => :spec
 
 desc "Run all specs in spec directory"
+
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  t.ruby_opts = "-w"
 end

data/diffy.gemspec

@@ -19,5 +19,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", '~> 2.14'
+  spec.add_development_dependency "rspec"
 end

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/diff.rb

@@ -1,7 +1,7 @@
 module Diffy
   class Diff
     ORIGINAL_DEFAULT_OPTIONS = {
-      :diff => '-U 10000',
+      :diff => '-U10000',
       :source => 'strings',
       :include_diff_info => false,
       :include_plus_and_minus_in_html => false,
@@ -12,7 +12,7 @@ module Diffy
     class << self
       attr_writer :default_format
       def default_format
-        @default_format || :text
+        @default_format ||= :text
       end
 
       # default options passed to new Diff objects
@@ -23,7 +23,7 @@ module Diffy
 
     end
     include Enumerable
-    attr_reader :string1, :string2, :options, :diff
+    attr_reader :string1, :string2, :options
 
     # supported options
     # +:diff+::    A cli options string passed to diff
@@ -42,7 +42,7 @@ module Diffy
 
     def diff
       @diff ||= begin
-        paths = case options[:source]
+        @paths = case options[:source]
           when 'strings'
             [tempfile(string1), tempfile(string2)]
           when 'files'
@@ -51,10 +51,10 @@ module Diffy
 
         if WINDOWS
           # don't use open3 on windows
-          cmd = sprintf '"%s" %s %s', diff_bin, diff_options.join(' '), paths.map { |s| %("#{s}") }.join(' ')
+          cmd = sprintf '"%s" %s %s', diff_bin, diff_options.join(' '), @paths.map { |s| %("#{s}") }.join(' ')
           diff = `#{cmd}`
         else
-          diff = Open3.popen3(diff_bin, *(diff_options + paths)) { |i, o, e| o.read }
+          diff = Open3.popen3(diff_bin, *(diff_options + @paths)) { |i, o, e| o.read }
         end
         diff.force_encoding('ASCII-8BIT') if diff.respond_to?(:valid_encoding?) && !diff.valid_encoding?
         if diff =~ /\A\s*\Z/ && !options[:allow_empty_diff]
@@ -67,24 +67,37 @@ module Diffy
       end
     ensure
       # unlink the tempfiles explicitly now that the diff is generated
-      Array(@tempfiles).each do |t|
-        begin
-          # check that the path is not nil and file still exists.
-          # REE seems to be very agressive with when it magically removes
-          # tempfiles
-          t.unlink if t.path && File.exist?(t.path)
-        rescue => e
-          warn "#{e.class}: #{e}"
-          warn e.backtrace.join("\n")
+      if defined? @tempfiles # to avoid Ruby warnings about undefined ins var.
+        Array(@tempfiles).each do |t|
+          begin
+            # check that the path is not nil and file still exists.
+            # REE seems to be very agressive with when it magically removes
+            # tempfiles
+            t.unlink if t.path && File.exist?(t.path)
+          rescue => e
+            warn "#{e.class}: #{e}"
+            warn e.backtrace.join("\n")
+          end
         end
       end
     end
 
     def each
       lines = case @options[:include_diff_info]
-      when false then diff.split("\n").reject{|x| x =~ /^(---|\+\+\+|@@|\\\\)/ }.map {|line| line + "\n" }
-      when true then diff.split("\n").map {|line| line + "\n" }
+      when false
+        # this "primes" the diff and sets up the paths we'll reference below.
+        diff
+
+        # caching this regexp improves the performance of the loop by a
+        # considerable amount.
+        regexp = /^(--- "?#{@paths[0]}"?|\+\+\+ "?#{@paths[1]}"?|@@|\\\\)/
+
+        diff.split("\n").reject{|x| x =~ regexp }.map {|line| line + "\n" }
+
+      when true
+        diff.split("\n").map {|line| line + "\n" }
       end
+
       if block_given?
         lines.each{|line| yield line}
       else
@@ -161,7 +174,7 @@ module Diffy
 
     # options pass to diff program
     def diff_options
-      Array(options[:context] ? "-U #{options[:context]}" : options[:diff])
+      Array(options[:context] ? "-U#{options[:context]}" : options[:diff])
     end
 
   end

data/lib/diffy/format.rb

@@ -3,7 +3,7 @@ module Diffy
     # ANSI color output suitable for terminal output
     def color
       map do |line|
-        case line          
+        case line
         when /^(---|\+\+\+|\\\\)/
           "\033[90m#{line.chomp}\033[0m"
         when /^\+/

data/lib/diffy/html_formatter.rb

@@ -90,10 +90,14 @@ module Diffy
 
     def split_characters(chunk)
       chunk.gsub(/^./, '').each_line.map do |line|
-        chars = line.sub(/([\r\n]$)/, '').split('')
-        # add escaped newlines
-        chars << '\n'
-        chars.map{|chr| ERB::Util.h(chr) }
+        if @options[:ignore_crlf]
+          (line.chomp.split('') + ['\n']).map{|chr| ERB::Util.h(chr) }
+        else
+          chars = line.sub(/([\r\n]$)/, '').split('')
+          # add escaped newlines
+          chars << '\n'
+          chars.map{|chr| ERB::Util.h(chr) }
+        end
       end.flatten.join("\n") + "\n"
     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.4.0'
 end

data/spec/diffy_spec.rb

@@ -115,7 +115,7 @@ describe Diffy::Diff do
   describe "handling temp files" do
     it "should unlink tempfiles after generating the diff" do
       before_tmpfiles = Dir.entries(Dir.tmpdir)
-      d = ::Diffy::Diff.new("a", "b").to_s
+      ::Diffy::Diff.new("a", "b").to_s
       after_tmpfiles = Dir.entries(Dir.tmpdir)
       expect(before_tmpfiles).to match_array(after_tmpfiles)
     end
@@ -503,6 +503,13 @@ baz
         expect(@diff.to_s(:html)).to eq(html)
       end
 
+      it "should treat unix vs windows newlines as same if option :ignore_crlf" do
+        @diff = Diffy::Diff.new("one\ntwo\nthree\n", "one\r\ntwo\r\nthree\r\n",
+                               ignore_crlf: true)
+        empty_diff = "<div class=\"diff\"></div>"
+        expect(@diff.to_s(:html)).to eq(empty_diff)
+      end
+
       describe 'with lines that include \n' do
         before do
           string1 = 'a\nb'"\n"
@@ -585,6 +592,97 @@ baz
         line
       end).to eq([" foo\n", " bar\n", "+baz\n"])
     end
+
+    it "should handle lines that begin with --" do
+      string1 = "a a\n-- b\nc c\n"
+      string2 = "a a\nb b\nc c\n"
+
+      expect(Diffy::Diff.new(string1, string2).to_s).to eq <<-DIFF
+ a a
+--- b
++b b
+ c c
+      DIFF
+    end
+
+    it "should handle lines that begin with ++" do
+      string1 = "a a\nb b\nc c\n"
+      string2 = "a a\n++ b\nc c\n"
+
+      expect(Diffy::Diff.new(string1, string2).to_s).to eq <<-DIFF
+ a a
+-b b
++++ b
+ c c
+      DIFF
+    end
+  end
+end
+
+describe Diffy::SplitDiff do
+  before do
+    ::Diffy::Diff.default_options.merge!(:diff => '-U10000')
+  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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: diffy
 version: !ruby/object:Gem::Version
-  version: 3.0.7
+  version: 3.4.0
 platform: ruby
 authors:
 - Sam Goldstein
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-10-12 00:00:00.000000000 Z
+date: 2020-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -28,16 +28,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '0'
 description: Convenient diffing in ruby
 email:
 - sgrock@gmail.org
@@ -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
@@ -67,7 +68,7 @@ homepage: http://github.com/samg/diffy
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -82,9 +83,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: A convenient way to diff string in ruby
 test_files: