wdiff 0.1.2 → 0.2.0

data/README.rdoc

@@ -17,6 +17,9 @@ Simple wrapper around GNU wdiff (http://www.gnu.org/software/wdiff/)
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
+== Contributors
+- Richard Livsey
+
 == Copyright
 
 Copyright (c) 2010 Jerome Riga. See LICENSE.txt for

data/Rakefile

@@ -13,7 +13,7 @@ require 'jeweler'
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
   gem.name = "wdiff"
-  gem.homepage = "http://github.com/jriga/wdiff"
+  gem.homepage = "http://github.com/zemis/wdiff"
   gem.license = "MIT"
   gem.summary = %Q{adds the wdiff method to String instance}
   gem.description = %Q{string word diff with other string; Wdiff::Helper.to_html transforms diff string in html snippet}

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/lib/wdiff.rb

@@ -4,27 +4,54 @@ module Wdiff
     def included(target)
       verify_wdiff_in_path
     end
+
     def verify_wdiff_in_path
       path = %x{which #{bin_path}}
       raise "GNU wdiff (http://www.gnu.org/software/wdiff/) not found in $PATH" if path.empty?
     end
+
     def bin_path
       'wdiff'
     end
+
+    # TODO - this will fail if option strings include quotes, need to escape quotes automagically
+    def options_string_from_hash(options={})
+      parts = []
+
+      options[:inserts].each_with_index do |token, index|
+        token.gsub!(/^\"$/,'\"') if token == '"'
+        parts << ( index.even? ?  %Q(--start-insert="#{token}")  :  %Q(--end-insert="#{token}") )
+        break if index >= 1
+      end if options[:inserts]
+
+      
+      options[:deletes].each_with_index do |token, index|
+        token.gsub!(/^\"$/,'\"') if token == '"'
+        parts << ( index.even? ?  %Q(--start-delete="#{token}")  :  %Q(--end-delete="#{token}") )
+        break if index >= 1
+      end if options[:deletes]
+      
+      parts.join(" ")
+    end
+
+    def diff(old_str, new_str, options={})
+      f1, f2 = Tempfile.new('f1'), Tempfile.new('f2')
+      f1.write(old_str); f1.flush
+      f2.write(new_str); f2.flush
+      opt_str = options_string_from_hash(options)
+      raw = %x{#{bin_path} #{opt_str} #{f1.path} #{f2.path}}
+      f1.close; f2.close
+      raw
+    end
   end
 
-  def wdiff(str_new)
-    f1, f2 = Tempfile.new('f1'), Tempfile.new('f2')
-    f1.write(self); f1.flush
-    f2.write(str_new); f2.flush
-    raw = %x{#{Wdiff::bin_path} #{f1.path} #{f2.path}}
-    f1.close; f2.close
-    raw
+  def wdiff(str_new, options={})
+    Wdiff::diff(self, str_new, options)
   end
-  
+
   module Helper
-    def self.to_html(str)
-      str.gsub(/\[\-/,'<del>').gsub(/\-\]/,'</del>').gsub(/\{\+/,'<ins>').gsub(/\+\}/,'</ins>')
+    def self.to_html(old_str,new_str)
+      Wdiff::diff(old_str, new_str, :inserts => ["<ins>", "</ins>"], :deletes => ["<del>", "</del>"])
     end
   end
 end

data/spec/wdiff_spec.rb

@@ -1,12 +1,50 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "Wdiff" do
-  it "should return the string diff of two strings" do
-    'this is a test'.wdiff('this is another test').should == 'this is [-a-] {+another+} test'
+  context "On String Instance" do
+    it "should return the diff with another string" do
+      'this is a test'.wdiff('this is another test').should == 'this is [-a-] {+another+} test'
+    end
+    
+    it "should allow overriding the delete regions" do
+      'this is a test'.wdiff('this is another test', :deletes => ["<del>", "</del>"]).should == 'this is <del>a</del> {+another+} test'
+    end
+    
+    it "should allow overriding the insert regions" do
+      'this is a test'.wdiff('this is another test', :inserts => ["<ins>", "</ins>"]).should == 'this is [-a-] <ins>another</ins> test'
+    end
+
   end
 
-  it "should return the HTML diff of two strings" do
-    Wdiff::Helper.to_html('this is a test'.wdiff('this is another test')).should == 'this is <del>a</del> <ins>another</ins> test'
+  context "Library" do
+    it "should cope with nil strings" do
+      Wdiff.diff(nil, nil).should == ""
+    end
+    
+    it "should not fail when double quote are entered for inserts" do
+      'this is a test'.wdiff('this is another test', :inserts => ["\"", "\""]).should == 'this is [-a-] "another" test'
+      'this is a test'.wdiff('this is another test', :inserts => ['"', '"']).should == 'this is [-a-] "another" test'
+    end
+    
+    it "should ignore unnecessary tokens for inserts" do
+      'this is a test'.wdiff('this is another test', :inserts => ['"', "'", 'dddd']).should == "this is [-a-] \"another' test"
+    end
+
+
+    it "should not fail when double quote are entered for deletes"  do
+      'this is a test'.wdiff('this is another test', :deletes => ["\"", "\""]).should == 'this is "a" {+another+} test'
+      'this is a test'.wdiff('this is another test', :deletes => ['"', '"']).should == 'this is "a" {+another+} test'
+    end
+    
+    it "should ignore unnecessary tokens for deletes" do
+      'this is a test'.wdiff('this is another test', :deletes => ['"', "'", 'dddd']).should == "this is \"a' {+another+} test"
+    end
+  end
+  
+  context "Helper" do
+    it "should return the HTML diff of two strings" do
+      Wdiff::Helper.to_html('this is a test','this is another test').should == 'this is <del>a</del> <ins>another</ins> test'
+    end
   end
 
   it "should raise error if xdiff is not in $PATH" do

data/wdiff.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{wdiff}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Jerome Riga}]
+  s.date = %q{2011-09-28}
+  s.description = %q{string word diff with other string; Wdiff::Helper.to_html transforms diff string in html snippet}
+  s.email = %q{jriga@zemis.co.uk}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/wdiff.rb",
+    "spec/spec_helper.rb",
+    "spec/wdiff_spec.rb",
+    "wdiff.gemspec"
+  ]
+  s.homepage = %q{http://github.com/zemis/wdiff}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
+  s.summary = %q{adds the wdiff method to String instance}
+  s.test_files = [
+    "spec/spec_helper.rb",
+    "spec/wdiff_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+  end
+end
+

metadata

@@ -1,81 +1,58 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: wdiff
-version: !ruby/object:Gem::Version 
-  hash: 31
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 2
-  version: 0.1.2
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Jerome Riga
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-11-23 00:00:00 +00:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  type: :development
-  prerelease: false
+date: 2011-09-28 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2154020660 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 2
-        - 1
-        - 0
+      - !ruby/object:Gem::Version
         version: 2.1.0
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
   type: :development
   prerelease: false
+  version_requirements: *2154020660
+- !ruby/object:Gem::Dependency
   name: bundler
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: &2154020180 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
+      - !ruby/object:Gem::Version
         version: 1.0.0
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
   type: :development
   prerelease: false
+  version_requirements: *2154020180
+- !ruby/object:Gem::Dependency
   name: jeweler
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &2154019700 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 1
-        - 5
-        - 1
+      - !ruby/object:Gem::Version
         version: 1.5.1
-  requirement: *id003
-description: string word diff with other string; Wdiff::Helper.to_html transforms diff string in html snippet
+  type: :development
+  prerelease: false
+  version_requirements: *2154019700
+description: string word diff with other string; Wdiff::Helper.to_html transforms
+  diff string in html snippet
 email: jriga@zemis.co.uk
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
 - README.rdoc
-files: 
+files:
 - .document
 - .rspec
 - Gemfile
@@ -86,40 +63,35 @@ files:
 - lib/wdiff.rb
 - spec/spec_helper.rb
 - spec/wdiff_spec.rb
-has_rdoc: true
-homepage: http://github.com/jriga/wdiff
-licenses: 
+- wdiff.gemspec
+homepage: http://github.com/zemis/wdiff
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 1527886557485215717
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: adds the wdiff method to String instance
-test_files: 
+test_files:
 - spec/spec_helper.rb
 - spec/wdiff_spec.rb