diffy 3.1.0 → 3.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 926beeabce14fc2e5d5faa98b5ce2254d41fc9c4
-  data.tar.gz: 3d6f3d718606ab9d2a264b6e2d32285f164fd047
+SHA256:
+  metadata.gz: 107dc73001f2e00bccf4b4f89a15ba86d045511f125f33bc8ed8987e239b5079
+  data.tar.gz: 0a07b298ff5eec7bcbf83adb0e3fa3c59c122796693d75e18d81d9ccfcb131de
 SHA512:
-  metadata.gz: e2b63ca155a9eaa8360a2f17cb259aaf208ac1c7e84c36b1c7451a9bd0ebdbca4b110e12d286f7584018e011a6eed36eee520a2f5a44419300d0ba336acd8cb0
-  data.tar.gz: 6692ef85960a14e3e21e336760eb085991aa1bd480544146ec18241b3e2919807160f0e0e74cb60bda6c7f8bbab3de4b571379de79b80b8cff0759a5d8d84400
+  metadata.gz: 47df78d6118935280b9011a77bb0c888da50af9dfac81dd810ca522cf23ad0099b50411a27e2ca57eac0369cb9fd9d82b97ce56525093002f2845d5d8e2e8121
+  data.tar.gz: fca9f15d0cd9cca745caa12f59da048f6bd4c62a572abd9987530ef3acacbdf228c78140c3305f618b86dc57a2a50a25fb0336e325f33afd5261c0a47e28f73c

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,22 @@
+== 3.4.2 ==
+Silence warning from unused variable when using `ruby -w`.  Thanks
+@sambostock!
+
+== 3.4.1 ==
+Prevent remote code execution from user controlled diff file paths.  This
+issue was only present in Windows platforms. Thanks @tehryanx for reporting
+and testing the fix!
+
+== 3.4.0 ==
+Remove space between U diff option and context number. Thanks @tomas!
+Add option to ignore CRLF diffs in HTML comparisons. Thanks @ptyagi16!
+
+== 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!
 

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

@@ -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.
 
@@ -149,9 +149,9 @@ 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
+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
+the diff: `#left` and `#right`.  Using the earlier example, this is what they
 look like in action:
 
 ```
@@ -213,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:
@@ -270,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
 --------------------
 
@@ -285,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
@@ -315,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/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,20 +42,14 @@ module Diffy
 
     def diff
       @diff ||= begin
-        paths = case options[:source]
+        @paths = case options[:source]
           when 'strings'
             [tempfile(string1), tempfile(string2)]
           when 'files'
             [string1, string2]
           end
 
-        if WINDOWS
-          # don't use open3 on windows
-          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 }
-        end
+        diff, _stderr, _process_status = Open3.capture3(diff_bin, *(diff_options + @paths))
         diff.force_encoding('ASCII-8BIT') if diff.respond_to?(:valid_encoding?) && !diff.valid_encoding?
         if diff =~ /\A\s*\Z/ && !options[:allow_empty_diff]
           diff = case options[:source]
@@ -67,24 +61,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 +168,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/version.rb

@@ -1,3 +1,3 @@
 module Diffy
-  VERSION = '3.1.0'
+  VERSION = '3.4.2'
 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,12 +592,36 @@ 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 => '-U 10000')
+    ::Diffy::Diff.default_options.merge!(:diff => '-U10000')
   end
 
   it "should fail with invalid format" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: diffy
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.4.2
 platform: ruby
 authors:
 - Sam Goldstein
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-12-17 00:00:00.000000000 Z
+date: 2022-06-20 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
@@ -68,7 +68,7 @@ homepage: http://github.com/samg/diffy
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -83,9 +83,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: A convenient way to diff string in ruby
 test_files: