gem-patch 0.1.3 → 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8184438e8bca43220120c8d713c90c563bfcfd4
+  data.tar.gz: 7f0602aa71171948d2e6bfa09f037fd819406d9a
+SHA512:
+  metadata.gz: 5a4c0e65496e12db4179f0dccd295392f6ea96e16385fb6a8e9749e3f0513e34bcc8d3fafc4166078d6c0ca54dec0fcb3331d1fcb5d41a12ed288d9137c2e492
+  data.tar.gz: 302768e47f9212575d9830f2fb11d14313dc0658be3fb184038f074c41b0611ddac5046f5a2eb2a08e32f74cc3f0cf8ec6bc102267415e6e2f7cc6061bcf134a

data/README.md

@@ -4,21 +4,31 @@ A RubyGems plugin that patches gems.
 
 ## Description
 
-`gem-patch` is a RubyGems plugin that helps to patch gems without manually opening and rebuilding them. It opens a given .gem file, extracts it, patches it with system `patch` command, clones its spec, updates the file list and builds the patched gem.
+`gem-patch` is a RubyGems plugin that helps to patch gems without manually opening and rebuilding them. It opens a given `.gem` file, extracts it, patches it with system `patch` command, clones its spec, updates the file list and builds the patched gem.
 
 ## Installation
 
-Run:
-`gem install gem-patch`
+Run `gem install gem-patch` and you are done.
+
+### Fedora
+
+On Fedora you can use YUM:
+
+`sudo yum install rubygem-gem-patch`
 
 ## Usage
 
 `gem patch [options] name-version.gem PATCH [PATCH ...]`
 
-Options:
+### Supported options
 
-`-pNUMBER` or `--strip=NUMBER` sets the file name strip count to NUMBER (same options as for `patch` command on Linux machines).
-`--verbose` prints additional info and STDOUT from `patch` command
+| option | alternative syntax | description |
+| ------ | ------ | ------ |
+| -pNUMBER | --strip-numberNUMBER | Sets the file name strip count to NUMBER. |
+| -FNUMBER | --fuzz=NUMBER | Set NUMBER of lines to ignore in looking for places to install a hunk. |
+| -oFILE | --output=FILE | Set output FILE. |
+| --dry-run | | Print the results from patching, but do not change any files. |
+| --verbose | | Print additional info and STDOUT from `patch` command. |
 
 ## Requirements
 
@@ -26,4 +36,4 @@ This version is build for both RubyGems 1.8  and RubyGems 2.0.
 
 ## Copyright
 
-See LICENCE
+Released under the MIT license. Feel free to contribute!

data/lib/rubygems/commands/patch_command.rb

@@ -10,6 +10,21 @@ class Gem::Commands::PatchCommand < Gem::Command
     add_option('-pNUMBER', '--strip=NUMBER', 'Set the file name strip count to NUMBER.') do |number, options|
       options[:strip] = number
     end
+    
+    # Number of lines to ignore in looking for places to install a hunk
+    add_option('-FNUMBER', '--fuzz=NUMBER', 'Set NUMBER of lines to ignore in looking for places to install a hunk.') do |number, options|
+      options[:fuzz] = number
+    end
+    
+    # Set output file to FILE instead of overwritting
+    add_option('-oFILE', '--output=FILE', 'Set output FILE.') do |file, options|
+      options[:outfile] = file
+    end
+    
+    # Dry run only shows expected output from the patching process
+    add_option('--dry-run', 'Print the results from patching, but do not change any files.') do |file, options|
+      options[:dry_run] = true
+    end
   end
 
   def arguments # :nodoc:
@@ -21,11 +36,12 @@ class Gem::Commands::PatchCommand < Gem::Command
   end
 
   def description # :nodoc:
-    <<-EOF
-      `gem-patch` is a RubyGems plugin that helps to patch gems without manually opening and rebuilding them.
-      It opens a given .gem file, extracts it, patches it with system "patch" command,
-      clones its spec, updates the file list and builds the patched gem.
+    desc = <<-EOF
+           `gem-patch` is a RubyGems plugin that helps to patch gems without manually opening and rebuilding them.
+           It opens a given .gem file, extracts it, patches it with system `patch` command,
+           clones its spec, updates the file list and builds the patched gem.
     EOF
+    return desc.gsub(/^\s+/, '')
   end
 
   def usage # :nodoc:
@@ -49,7 +65,7 @@ class Gem::Commands::PatchCommand < Gem::Command
     end
 
     patcher = Gem::Patcher.new(gemfile, options[:output])
-    patcher.patch_with(patches, options[:strip]) 
+    patcher.patch_with(patches, options) 
     patcher.print_results
   end
-end
+end

data/lib/rubygems/patcher.rb

@@ -24,7 +24,7 @@ class Gem::Patcher
   ##
   # Patch the gem, move the new patched gem to the working directory and return the path
 
-  def patch_with(patches, strip_number)
+  def patch_with(patches, options)
     @output = []
 
     check_patch_command_is_installed
@@ -33,25 +33,29 @@ class Gem::Patcher
     # Apply all patches
     patches.each do |patch|
       info 'Applying patch ' + patch
-      apply_patch(patch, strip_number)
+      apply_patch(patch, options)
     end
 
     build_patched_gem
 
-    new_gem_path = File.join(@output_dir, @package.spec.file_name)
-    FileUtils.mv((File.join @target_dir, @package.spec.file_name), new_gem_path)
+    options[:outfile] ||= File.join(@output_dir, @package.spec.file_name)
+    FileUtils.mv((File.join @target_dir, @package.spec.file_name), options[:outfile])
 
     # Return the path to the patched gem
-    new_gem_path
+    options[:outfile]
   end
 
-  def apply_patch(patch, strip_number)
+  def apply_patch(patch, options)
+    options[:strip] ||= 1
+    options[:fuzz]  ||= 2
+    dry_run = '--dry-run' if options[:dry_run]
+    
     patch_path = File.expand_path(patch)
     info 'Path to the patch to apply: ' + patch_path
 
     # Apply the patch by calling 'patch -pNUMBER < patch'
     Dir.chdir @target_dir do
-      IO.popen("patch --verbose -p#{strip_number} < #{patch_path} 2>&1") do |out|
+      IO.popen("patch --verbose -p#{options[:strip]} --fuzz=#{options[:fuzz]} #{dry_run} < #{patch_path} 2>&1") do |out|
         std = out.readlines
         out.close
         info std

data/rakefile.rb

@@ -4,7 +4,7 @@ require 'rdoc/task'
 
 gemspec = Gem::Specification.new do |s|
   s.name     = "gem-patch"
-  s.version  = "0.1.3"
+  s.version  = "0.1.4"
   s.platform = Gem::Platform::RUBY
   s.summary     = "RubyGems plugin for patching gems."
   s.description = <<-EOF
@@ -18,7 +18,7 @@ gemspec = Gem::Specification.new do |s|
   s.email    = "jstribny@redhat.com"
   s.required_ruby_version     = ">= 1.8.7"
   s.required_rubygems_version = ">= 1.8.0"
-  s.files = FileList["README.md", "README.rdoc", "LICENCE", "rakefile.rb",
+  s.files = FileList["README.md", "LICENCE", "rakefile.rb",
                       "lib/**/*.rb", "test/**/test*.rb"]
 end
 
@@ -26,8 +26,8 @@ Gem::PackageTask.new gemspec do |pkg|
 end
 
 Rake::RDocTask.new do |rd|
-  rd.main = "README.rdoc"
-  rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+  rd.main = "README.md"
+  rd.rdoc_files.include("README.md", "lib/**/*.rb")
 end
 
 Rake::TestTask.new('test') do |t|

data/test/rubygems/test_gem_patch.rb

@@ -8,6 +8,102 @@ class TestGemPatch < Gem::TestCase
     @gems_dir  = File.join @tempdir, 'gems'
     @lib_dir = File.join @tempdir, 'gems', 'lib'
     FileUtils.mkdir_p @lib_dir
+    
+    # Defaults
+    @options         = {}
+    @options[:strip] = 1
+    @options[:fuzz]  = 2
+  end
+  
+  ##
+  # Test dry run is not supposed to change anything
+
+  def test_dry_run
+    @options[:dry_run] = true
+    
+    gemfile = bake_testing_gem
+
+    patches = []
+    patches << bake_change_file_patch
+
+    # Creates new patched gem in @gems_dir
+    patcher = Gem::Patcher.new(gemfile, @gems_dir)
+    patched_gem = patcher.patch_with(patches, @options)
+
+    # Unpack
+    package = Gem::Package.new patched_gem
+    package.extract_files @gems_dir
+
+    # Still the same
+    assert_equal original_file, file_contents('foo.rb')
+  end
+  
+  ##
+  # Test using outfile for output
+
+  def test_use_outfile_for_output
+    @options[:outfile] = 'outfile.gem'
+    
+    gemfile = bake_testing_gem
+
+    patches = []
+    patches << bake_change_file_patch
+
+    # Creates new patched gem in @gems_dir
+    patcher = Gem::Patcher.new(gemfile, @gems_dir)
+    patched_gem = patcher.patch_with(patches, @options)
+    
+    assert_equal patched_gem, 'outfile.gem'
+
+    # Unpack
+    package = Gem::Package.new patched_gem
+    package.extract_files @gems_dir
+
+    assert_equal patched_file, file_contents('foo.rb')
+  end
+  
+  ##
+  # Test changing a file in a gem with -F0 option
+
+  def test_should_not_patch_without_fuzz
+    @options[:fuzz] = 0
+    
+    gemfile = bake_testing_gem
+
+    patches = []
+    patches << bake_change_file_with_fuzz_patch
+
+    # Creates new patched gem in @gems_dir
+    patcher = Gem::Patcher.new(gemfile, @gems_dir)
+    patched_gem = patcher.patch_with(patches, @options)
+
+    # Unpack
+    package = Gem::Package.new patched_gem
+    package.extract_files @gems_dir
+
+    assert_equal (patched_file == file_contents('foo.rb')), false
+  end
+  
+  ##
+  # Test changing a file in a gem with -F2 option
+
+  def test_change_file_with_fuzz_patch
+    @options[:fuzz] = 2
+    
+    gemfile = bake_testing_gem
+
+    patches = []
+    patches << bake_change_file_with_fuzz_patch
+
+    # Creates new patched gem in @gems_dir
+    patcher = Gem::Patcher.new(gemfile, @gems_dir)
+    patched_gem = patcher.patch_with(patches, @options)
+
+    # Unpack
+    package = Gem::Package.new patched_gem
+    package.extract_files @gems_dir
+
+    assert_equal patched_file, file_contents('foo.rb')
   end
 
   ##
@@ -21,7 +117,7 @@ class TestGemPatch < Gem::TestCase
 
     # Creates new patched gem in @gems_dir
     patcher = Gem::Patcher.new(gemfile, @gems_dir)
-    patched_gem = patcher.patch_with(patches, 1)
+    patched_gem = patcher.patch_with(patches, @options)
 
     # Unpack
     package = Gem::Package.new patched_gem
@@ -34,14 +130,16 @@ class TestGemPatch < Gem::TestCase
   # Test adding a file into a gem with -p0 option
 
   def test_new_file_patch
+    @options[:strip] = 0
+    
     gemfile = bake_testing_gem
 
     patches = []
     patches << bake_new_file_patch
 
-    # Create a new patched gem in @gems_fir
+    # Create a new patched gem in @gems_dir
     patcher = Gem::Patcher.new(gemfile, @gems_dir)
-    patched_gem = patcher.patch_with(patches, 0)
+    patched_gem = patcher.patch_with(patches, @options)
 
     # Unpack
     package = Gem::Package.new patched_gem
@@ -54,15 +152,17 @@ class TestGemPatch < Gem::TestCase
   # Test adding and deleting a file in a gem with -p0 option
 
   def test_delete_file_patch
+    @options[:strip] = 0
+    
     gemfile = bake_testing_gem
 
     patches = []
     patches << bake_new_file_patch
     patches << bake_delete_file_patch
 
-    # Create a new patched gem in @gems_fir
+    # Create a new patched gem in @gems_dir
     patcher = Gem::Patcher.new(gemfile, @gems_dir)
-    patched_gem = patcher.patch_with(patches, 0)
+    patched_gem = patcher.patch_with(patches, @options)
 
     # Unpack
     package = Gem::Package.new patched_gem
@@ -83,9 +183,9 @@ class TestGemPatch < Gem::TestCase
     patches = []
     patches << bake_incorrect_patch
 
-    # Create a new patched gem in @gems_fir
+    # Create a new patched gem in @gems_dir
     patcher = Gem::Patcher.new(gemfile, @gems_dir)
-    patched_gem = patcher.patch_with(patches, 0)
+    patched_gem = patcher.patch_with(patches, @options)
 
     # Unpack
     package = Gem::Package.new patched_gem
@@ -104,6 +204,16 @@ class TestGemPatch < Gem::TestCase
 
     patch_path
   end
+  
+  def bake_change_file_with_fuzz_patch
+    patch_path = File.join(@gems_dir, 'change_file_with_fuzz.patch')
+
+    File.open(patch_path, 'w') do |f|
+      f.write change_file_patch
+    end
+
+    patch_path
+  end
 
   def bake_new_file_patch
     patch_path = File.join(@gems_dir, 'new_file.patch')
@@ -241,6 +351,24 @@ class TestGemPatch < Gem::TestCase
             end
     EOF
   end
+  
+  def change_file_with_fuzz_patch
+    <<-EOF
+      diff -u a/lib/foo.rb b/lib/foo.rb
+      --- a/lib/foo.rb 
+      +++ b/lib/foo.rb
+      @@ -1,6 +1,8 @@
+             module FooBar
+      -        def bar
+      -          'Original'
+      +        class Bar
+      +          def foo_bar
+      +            'Patched'
+      +          end
+               end
+            end
+    EOF
+  end
 
   def new_file_patch
     <<-EOF

metadata

@@ -1,59 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: gem-patch
 version: !ruby/object:Gem::Version
-  version: 0.1.3
-  prerelease: 
+  version: 0.1.4
 platform: ruby
 authors:
 - Josef Stribny
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-22 00:00:00.000000000 Z
+date: 2013-04-22 00:00:00.000000000 Z
 dependencies: []
-description: ! "                    `gem-patch` is a RubyGems plugin that helps to
-  patch gems without manually opening and rebuilding them.\n                    It
-  opens a given .gem file, extracts it, patches it with system `patch` command,\n
-  \                   clones its spec, updates the file list and builds the patched
-  gem.\n"
+description: |2
+                      `gem-patch` is a RubyGems plugin that helps to patch gems without manually opening and rebuilding them.
+                      It opens a given .gem file, extracts it, patches it with system `patch` command,
+                      clones its spec, updates the file list and builds the patched gem.
 email: jstribny@redhat.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- README.rdoc
 - LICENCE
 - rakefile.rb
-- lib/rubygems_plugin.rb
+- lib/rubygems/commands/patch_command.rb
 - lib/rubygems/package-1.8.rb
 - lib/rubygems/patcher.rb
-- lib/rubygems/commands/patch_command.rb
-- test/rubygems/test_gem_patch.rb
+- lib/rubygems_plugin.rb
 - test/rubygems/test_gem_commands_patch_command.rb
+- test/rubygems/test_gem_patch.rb
 homepage: http://github.com/strzibny/gem-patch
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.8.0
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.0
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: RubyGems plugin for patching gems.
 test_files: []

data/README.rdoc

@@ -1,25 +0,0 @@
-= gem-patch
-
-A RubyGems plugin that patches gems.
-
-== Description
-
-`gem-patch` is a RubyGems plugin that helps to patch gems without manually opening and rebuilding them. It opens a given .gem file, extracts it, patches it with system `patch` command, clones its spec, updates the file list and builds the patched gem.
-
-== Installation
-
-Run:
-`gem install gem-patch`
-
-== Usage
-
-`gem patch [options] name-version.gem PATCH [PATCH ...]`
-
-Options:
-
-`-pNUMBER` or `--strip=NUMBER` sets the file name strip count to NUMBER (same options as for `patch` command on Linux machines).
-`--verbose` prints additional info and STDOUT from `patch` command
-
-== Requirements
-
-This version is build for RubyGems 2.0.a, a branch for RubyGems 1.8 is also available.