kdiff3 0.9.1

data/README.md

@@ -0,0 +1,52 @@
+KDiff3
+========
+
+[![Gem Version](http://img.shields.io/gem/v/KDiff3.svg?style=flat-square)](http://badge.fury.io/rb/KDiff3)
+[![Build Status](http://img.shields.io/travis/NullVoxPopuli/kdiff3-rb.svg?style=flat-square)](https://travis-ci.org/NullVoxPopuli/kdiff3-rb)
+[![Code Climate](http://img.shields.io/codeclimate/github/NullVoxPopuli/kdiff3-rb.svg?style=flat-square)](https://codeclimate.com/github/NullVoxPopuli/kdiff3-rb)
+[![Test Coverage](http://img.shields.io/codeclimate/coverage/github/NullVoxPopuli/kdiff3-rb.svg?style=flat-square)](https://codeclimate.com/github/NullVoxPopuli/kdiff3-rb)
+[![Dependency Status](http://img.shields.io/gemnasium/NullVoxPopuli/kdiff3-rb.svg?style=flat-square)](https://gemnasium.com/NullVoxPopuli/kdiff3-rb)
+[![security](https://hakiri.io/github/NullVoxPopuli/kdiff3-rb/master.svg)](https://hakiri.io/github/NullVoxPopuli/kdiff3-rb/master)
+
+Provides a simple way to utilize the power of [kdiff3 by Joachim Eibl](http://kdiff3.sourceforge.net/) in ruby.
+
+## Installation
+
+    gem install KDiff3
+
+    or
+
+    gem 'KDiff3' # in your Gemfile
+
+## Examples
+
+Merging inline HTML
+
+    result = KDiff3.merge(
+      base: "<p>1,2,<p>1,<p>2,</p></p>3</p>",
+      yours: "<p>1,2,<p>1,</p>3</p>",
+      theirs: "<p>1,2,<p><p>2,</p></p>3</p>",
+      html: true
+    )
+
+    # => "<p>1,2,<p></p>3</p>"
+
+Merging files
+
+    result = KDiff3.merge(
+      base: "path/to/base",
+      yours: "path/to/yours",
+      theirs: "path/to/theirs"
+    )
+
+    # => (whatever merged output is from the files)
+
+
+## Development
+
+KDiff3 exists in ext/kdiff3 using a git subtree
+ - KDiff3 repo here: https://github.com/NullVoxPopuli/kdiff3
+ - More info on subtrees here: https://medium.com/@v/git-subtrees-a-tutorial-6ff568381844
+
+## Contributing
+ - Fork, Test, Pull Request :-)

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/kdiff3.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "kdiff3/version"
+
+Gem::Specification.new do |s|
+  s.name        = "kdiff3"
+  s.version     = KDiff3::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.license     = "GNU GPL v2"
+  s.authors     = ["L. Preston Sego III"]
+  s.email       = "LPSego3+dev@gmail.com"
+  s.homepage    = "https://github.com/NullVoxPopuli/kdiff3-rb"
+  s.summary     = "kdiff3-#{KDiff3::VERSION}"
+  s.description = "Ruby wrapper for the kdiff3 mergetool"
+
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.extensions    = ['ext/kdiff3/extconf.rb']
+
+  s.add_dependency 'activesupport', '>= 3.2'
+
+  s.add_development_dependency "bundler", '>= 1.6.0'
+  s.add_development_dependency "awesome_print", '>= 1.2'
+  s.add_development_dependency "rspec", '>= 3.1.0'
+  s.add_development_dependency "pry-byebug", '>= 2.0.0'
+  s.add_development_dependency "codeclimate-test-reporter", '>= 0.4.3'
+
+end

data/lib/kdiff3.rb

@@ -0,0 +1,173 @@
+# string.present?
+require 'active_support/core_ext/string'
+
+module KDiff3
+
+  # list of created Tempfiles
+  TEMPFILES = []
+  # so we don't accidentally mess up formatting when we remove these later,
+  # we need to have a weird, non-stand sequence of characters to search
+  # and replace
+  NEWLINE = "\n\-"
+
+
+  # performs a 3 way merge between base, a, and b
+  # a 2 way merge will be performed if either yours
+  # or theirs are left out
+  #
+  # @param [String] base string or file path for common ancestor
+  # @param [String] yours string or file path for your changes
+  # @param [String] theirs string or file path for their changes
+  # @param [Boolean] html whether or not use an HTML diffing technique
+  # @return [String] result of merge
+  def self.merge(base: nil, yours: nil, theirs: nil, html: false)
+    raise ArgumentError.new('base is required') unless base.present?
+    raise ArgumentError.new('yours and/or theirs required') unless yours || theirs
+
+    # since HTML is often compressed to conserve transfer space, and therefore
+    # has few lines, we need to split up the HTML in to a multi-lined document
+    if html
+      base = add_new_lines(base)
+      yours = add_new_lines(yours)
+      theirs = add_new_lines(theirs)
+    end
+
+    base_path = tempfile(text: base, name: 'base')
+    your_path = tempfile(text: yours, name: 'yours')
+    their_path = tempfile(text: theirs, name: 'theirs')
+    output_path = tempfile(name: 'output')
+
+    # we don't need these open for anything
+    close_tempfiles
+
+    # the heavy lifting, courtesy of kdiff3
+    exit_code = run("#{base_path} #{your_path} #{their_path} -m --auto --fail -o #{output_path}")
+    conflicts_exist = exit_code == 1
+
+    result = IO.read(output_path) unless conflicts_exist
+
+    # clean up
+    delete_tempfiles
+
+    raise RuntimeError.new("Conflicts exist and could not be resolved") if conflicts_exist
+
+    if html
+      # remove the NEWLINES
+      result.gsub!(NEWLINE, "")
+    end
+
+    result
+  end
+
+  private
+
+  # @param [String] name of the file
+  # @param [String] text content of file or path
+  # @return [String] path of the Tempfile or Pre-existing file
+  def self.tempfile(text: nil, name: nil)
+    result = ""
+
+    # if the file already exists,
+    # don't add it to the tempfile list,
+    # as we don't want it to be deleted
+    if text && is_file_path?(text)
+      result = text
+    else
+      t = Tempfile.new(name)
+      t << text if text
+      TEMPFILES << t
+      result = t.path
+    end
+
+    result
+  end
+
+  def self.close_tempfiles
+    TEMPFILES.map(&:close)
+  end
+
+  def self.delete_tempfiles
+    TEMPFILES.map(&:delete)
+  end
+
+  # @param [String] path can be a file path or arbitrary string
+  # @return [Boolean] if the given string is a path to a file
+  def self.is_file_path?(path)
+    File.exist?(path)
+  end
+
+  def self.run(args)
+    %x(
+      #{kdiff3_path} #{args}
+    )
+    $?.exitstatus
+  end
+
+  # ensures the local copy of kdiff3 is present, if not, download and compile it
+  def self.kdiff3_path
+    current_folder = File.dirname(__FILE__)
+    path = "#{current_folder}/../ext/kdiff3/releaseQt/kdiff3"
+
+    unless File.exist?(path)
+      build_kdiff3
+    end
+
+    path
+  end
+
+  def self.build_kdiff3
+    current_folder = File.dirname(__FILE__)
+    kdiff3_repo_path = "#{current_folder}/../ext/kdiff3"
+
+    if  File.exist?(kdiff3_repo_path)
+      %x(
+        git pull # origin optionally-fail-on-conflict
+      )
+    else
+      %x(
+        git clone git@github.com:NullVoxPopuli/kdiff3.git #{kdiff3_repo_path}
+        cd #{kdiff3_repo_path} && git checkout optionally-fail-on-conflict
+      )
+    end
+
+    # build
+    %x(
+      cd #{kdiff3_repo_path} && ./configure qt4
+    )
+  end
+
+  # add newlines after every tag, and every character
+  def self.add_new_lines(text)
+    text = self.add_new_lines_to_non_tags(text)
+    text = self.add_new_lines_after_tags(text)
+
+    # trim accidental blank lines
+    text.gsub!("#{NEWLINE}#{NEWLINE}", NEWLINE)
+
+    text
+  end
+
+  # http://www.rubular.com/r/N2AHZgpPum
+  # http://stackoverflow.com/questions/7540489/javascript-regex-match-text-not-part-of-a-html-tag
+  def self.add_new_lines_after_tags(text)
+    tag_selection_regex = /<[^>]*>/
+    text.gsub(tag_selection_regex) do |match|
+      match << NEWLINE
+    end
+  end
+
+  # http://www.rubular.com/r/mpX6Ee2r0k
+  # http://stackoverflow.com/questions/18621568/regex-replace-text-outside-html-tags
+  def self.add_new_lines_to_non_tags(text)
+    non_tags = /(?<=^|>)[^><]+?(?=<|$)/
+    # non_tags = /([^<>]+)(?![^<]*>|[^<>]*<\/)/
+    text.gsub(non_tags) do |match|
+      # consecutive words
+      match.gsub!(" ", " #{NEWLINE}")
+      # end with NEWLINE
+      match << NEWLINE
+    end
+  end
+
+
+end

data/lib/kdiff3/version.rb

@@ -0,0 +1,3 @@
+module KDiff3
+  VERSION = "0.9.1"
+end

data/spec/kdiff3_spec.rb

@@ -0,0 +1,121 @@
+require 'spec_helper'
+
+describe KDiff3 do
+  before(:each) do
+    if ENV['USE_BIN_KDIFF3']
+      current_folder = File.dirname(__FILE__)
+      # may only work on Ubuntu 14.04?
+      kdiff3_bin_path = "#{current_folder}/../bin/kdiff3"
+      allow(KDiff3).to receive(:kdiff3_path).and_return(kdiff3_bin_path)
+    end
+  end
+
+
+  describe 'merge' do
+    it { expect{KDiff3.merge}.to raise_error(ArgumentError) }
+    it { expect{KDiff3.merge(base: "base")}.to raise_error(ArgumentError) }
+    it { expect{KDiff3.merge(base: "base", yours: "base")}.to_not raise_error }
+    it { expect{KDiff3.merge(base: "base", yours: "base", theirs: "base")}.to_not raise_error }
+
+    describe 'by line' do
+      before(:all) do
+        @base = "#{File.dirname(__FILE__)}/support/base"
+        @a = "#{File.dirname(__FILE__)}/support/a"
+        @b = "#{File.dirname(__FILE__)}/support/b"
+        @expected = "#{File.dirname(__FILE__)}/support/expected"
+      end
+
+      it 'completes a 3-way merge' do
+        result = KDiff3.merge(
+          base: @base,
+          yours: @a,
+          theirs: @b
+        )
+        expected = IO.read(@expected)
+
+        expect(result).to eq expected
+      end
+    end
+
+    describe 'by word (the html option)' do
+      before(:all) do
+        @base = "<p>1,2,<p>1,<p>2,</p></p>3</p>"
+        @a = "<p>1,2,<p>1,</p>3</p>"
+        @b = "<p>1,2,<p><p>2,</p></p>3</p>"
+        @expected = "<p>1,2,<p></p>3</p>"
+      end
+
+      it 'completes a 3-way merge' do
+        result = KDiff3.merge(
+          base: @base,
+          yours: @a,
+          theirs: @b,
+          html: true
+        )
+        expect(result).to eq @expected
+      end
+    end
+
+    describe "raises an error if there are conflicts" do
+      it { expect{ KDiff3.merge(base: 'a b', yours: '1 b', theirs: '2 b', html: true) }.to raise_error }
+    end
+  end
+
+  describe 'private methods' do
+
+    describe 'is_file?' do
+      it { expect(KDiff3.send(:is_file_path?, __FILE__)).to eq true }
+      it { expect(KDiff3.send(:is_file_path?, "#{File.dirname(__FILE__)}/spec_helper.rb")).to eq true }
+      it { expect(KDiff3.send(:is_file_path?, "not a file")).to eq false }
+      it { expect(KDiff3.send(:is_file_path?, "not/a/file")).to eq false }
+    end
+
+    describe 'tempfile' do
+      it 'returns path when path is a file' do
+        expect(KDiff3.send(:tempfile, text: __FILE__, name: 'rspec')).to eq __FILE__
+      end
+
+      it 'creates a tempfile' do
+        expect{
+          KDiff3.send(:tempfile, name: 'base')
+        }.to change(KDiff3::TEMPFILES, :size).by 1
+      end
+
+      it 'creates a tempfile with content' do
+        path = KDiff3.send(:tempfile, name: 'base', text: 'content')
+        # file must be closed before reading
+        KDiff3.send(:close_tempfiles)
+        expect(IO.read(path)).to eq 'content'
+      end
+    end
+
+    describe 'kdiff3_path' do
+      it "hasn't compiled kdiff3 yet"
+      it "has compiled kdiff3"
+      it "updates the kdiff3 repo"
+    end
+
+    describe 'add_new_lines' do
+      after(:each) do
+        result = KDiff3.send(:add_new_lines, @text)
+        # remove special character
+        # - this determines our line breaks from pre-existing ones
+        result.gsub!(KDiff3::NEWLINE, "\n")
+        expect(result).to eq @expected
+      end
+
+      it 'adds new lines to text' do
+        @text = "something like this"
+        @expected = "something \nlike \nthis\n"
+      end
+
+      it 'adds new lines to html' do
+        @text = "<p>something maybe<p><span>like <a>this</a></span></p></p>"
+        @expected = "<p>\nsomething \nmaybe\n<p>\n<span>\nlike \n<a>\nthis\n</a>\n</span>\n</p>\n</p>\n"
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+
+require "rubygems"
+require "bundler/setup"
+
+require "pry-byebug" # binding.pry # to debug!
+require 'awesome_print' # ap object # to pretty print
+
+# Coverage
+require "codeclimate-test-reporter"
+# ENV['CODECLIMATE_REPO_TOKEN'] = ""
+CodeClimate::TestReporter.start
+
+# This Gem
+require "kdiff3"
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/a

@@ -0,0 +1,7 @@
+<p>
+  1,2,
+  <p>
+    1,
+  </p>
+  3
+</p>

data/spec/support/b

@@ -0,0 +1,9 @@
+<p>
+  1,2,
+  <p>
+    <p>
+      2,
+    </p>
+  </p>
+  3
+</p>

data/spec/support/base

@@ -0,0 +1,10 @@
+<p>
+  1,2,
+  <p>
+    1,
+    <p>
+      2,
+    </p>
+  </p>
+  3
+</p>