gem-patch 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5669ae6006115b0c89acbbc4f98c9e761f041bd9
-  data.tar.gz: 19f8c702ec9ff3b55fc7c2da9a26b3ad53b9707e
+  metadata.gz: cccc1bd307891a4592e49f1206ab4beb21a221f4
+  data.tar.gz: ff5d1571ac0eeafea18baf915c22f3ab0f0e44a7
 SHA512:
-  metadata.gz: bffd06b0d82ecf682c0ad35f9bd91d2dbbb419d8f9600ee1bfb1c63baa335173cc07cc3e4d636217948c481199b3a80f69aeb3b6b86f743401e84d31fd28c1d0
-  data.tar.gz: 240d800db645308f36b8eeb37d7c7947c0701276bb353087813aecf0953ef29bcb3b1be5fd0966038adf221c5cdca0da081c79ce9ec6d3748e8283966829433e
+  metadata.gz: 684b0b96590e470851c0923b9f4e63add226b0de7767089b80630834d00f0cb606fea1ac5bc23a48c8363023535ef6b73767c47a86730df0efc56a6aef81dc81
+  data.tar.gz: a829e64b45b42710e63eed28b16407ea353b6962ec508664bc6bb3da66f6275a9f726f257f87a8c6dbd30f05d9af54f1410492b597421cdf929673619534d3f5

data/README.md

@@ -27,11 +27,16 @@ On Fedora you can use YUM:
 | -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. |
+| --patch-options=OPTIONS || Pass additional patch command options. |
+| -cPATHS | --copy-in=PATHS | Copy in files or folders (separated by comma) |
+| -rPATHS | --remove=PATHS | Remove files or folders before rebuild (separated by comma) |
 | --dry-run | | Print the results from patching, but do not change any files. |
 | --verbose | | Print additional info and STDOUT from `patch` command. |
 
 For versions higher than 0.1.4 `--dry-run` switch behaviour has been changed and it's not the same as in original `patch` command. Instead, `gem-patch` lets `patch` command modify files, but doesn't override the gem to be patched nor the output file at the end. This way we can easily use dry run also for patches involving more diffs changing each other.
 
+If you need to check patching files that are not part of .gem release (such as a separate test suite), you can do it with `--copy-in=test,folders` option. If you don't want to include those additional files then delete them with `--remove=test,folders`.
+
 ## Requirements
 
 This version is build for both RubyGems 1.8  and RubyGems 2.0.

data/lib/rubygems/commands/patch_command.rb

@@ -1,28 +1,43 @@
-require "rubygems/command"
-require "rubygems/patcher"
+require 'rubygems/command'
+require 'rubygems/patcher'
 
 class Gem::Commands::PatchCommand < Gem::Command
   def initialize
-    super "patch", "Patches the gem with the given patches and generates patched gem.",
+    super 'patch', 'Patch the gem with the given patches and generate the patched gem',
       :output => Dir.pwd, :strip => 0
 
     # Same as 'patch -pNUMBER' on Linux machines
-    add_option('-pNUMBER', '--strip=NUMBER', 'Set the file name strip count to NUMBER.') do |number, options|
+    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|
+    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
+
+    # Pass other options that are not directly implemented
+    add_option('--patch-options=OPTIONS', 'Pass additional OPTIONS to the patch command') do |opts, options|
+      options[:patch_options] = opts
+    end
+
+    # Copy additional files or dirs to the unpacked .gem file before patching
+    add_option('-cPATHS', '--copy-in=PATHS', 'Copy in additional files or dirs before patching separated by comma') do |paths, options|
+      options[:copy_in] = paths
+    end
+
+    # Remove files or dirs before rebuilt
+    add_option('-rPATHS', '--remove=PATHS', 'Remove files or dirs before repacking the patched gem') do |paths, options|
+      options[:remove] = paths
+    end
     
     # Set output file to FILE instead of overwritting
-    add_option('-oFILE', '--output=FILE', 'Set output FILE.') do |file, options|
+    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|
+    add_option('--dry-run', 'Print the results from patching, but do not change any files') do |file, options|
       options[:dry_run] = true
     end
   end
@@ -37,7 +52,7 @@ class Gem::Commands::PatchCommand < Gem::Command
 
   def description # :nodoc:
     desc = <<-EOF
-           `gem-patch` is a RubyGems plugin that helps to patch gems without manually opening and rebuilding them.
+           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
@@ -55,13 +70,13 @@ class Gem::Commands::PatchCommand < Gem::Command
     # No gem
     unless gemfile
       raise Gem::CommandLineError,
-        "Please specify a gem file on the command line (e.g. gem patch foo-0.1.0.gem PATCH [PATCH ...])"
+        'Please specify a gem file on the command line (e.g. gem patch foo-0.1.0.gem PATCH [PATCH ...])'
     end
 
     # No patches
     if patches.empty?
       raise Gem::CommandLineError,
-        "Please specify patches to apply (e.g. gem patch foo-0.1.0.gem foo.patch bar.patch ...)"
+        'Please specify patches to apply (e.g. gem patch foo-0.1.0.gem foo.patch bar.patch ...)'
     end
 
     patcher = Gem::Patcher.new(gemfile, options[:output])

data/lib/rubygems/package-1.8.rb

@@ -1,8 +1,9 @@
-require "rubygems/installer"
-require "rubygems/builder"
+require 'rubygems/installer'
+require 'rubygems/builder'
 
 ##
-# Simulate RubyGems 2.0 behavior to use master branch of gem-patch plugin with RubyGems 1.8
+# Simulate RubyGems 2.0 behavior to use master branch
+# of gem-patch plugin with RubyGems 1.8
 
 module Gem::Package
   def self.new gem

data/lib/rubygems/patcher.rb

@@ -1,12 +1,16 @@
-require "rbconfig"
-require "tmpdir"
-require "rubygems/package"
+require 'rbconfig'
+require 'tmpdir'
+require 'rubygems/package'
+
+##
+# Gem::Patcher is used to patch .gem files
+# by calling system patch command
 
 class Gem::Patcher
   include Gem::UserInteraction
 
   if Gem::VERSION < '2.0'
-    require "rubygems/package-1.8"
+    require 'rubygems/package-1.8'
   end
 
   class PatchCommandMissing < StandardError; end
@@ -22,21 +26,24 @@ class Gem::Patcher
   end
 
   ##
-  # Patch the gem, move the new patched gem to the working directory and return the path
+  # Patch the gem, move the new patched gem
+  # to +options[:outfile]+ and return the path
 
   def patch_with(patches, options)
-    @output = []
+    @std, @output = [], []
 
     check_patch_command_is_installed
     extract_gem
+    copy_in(options[:copy_in], @target_dir) if options[:copy_in]
 
     # Apply all patches
     patches.each do |patch|
       info 'Applying patch ' + patch
-      apply_patch(patch, options)
+      @std << apply_patch(patch, options)
     end
-
-    build_patched_gem
+    remove(options[:remove], @target_dir) if options[:remove]
+    # Rebuild only if there weren't any problems
+    build_patched_gem unless failed?
 
     options[:outfile] ||= File.join(@output_dir, @package.spec.file_name)
     FileUtils.mv((File.join @target_dir, @package.spec.file_name), options[:outfile]) unless options[:dry_run]
@@ -45,16 +52,25 @@ class Gem::Patcher
     options[:outfile]
   end
 
+  ##
+  # Apply one +patch+ at a time using +options+
+  #
+  # Default options:
+  #  options[:strip] = 1
+  #  options[:fuzz]  = 2
+
   def apply_patch(patch, options)
     options[:strip] ||= 1
     options[:fuzz]  ||= 2
     
     patch_path = File.expand_path(patch)
     info 'Path to the patch to apply: ' + patch_path
+    copy_in(options[:copy_in], @target_dir) if options[:copy_in]
 
     # Apply the patch by calling 'patch -pNUMBER < patch'
     Dir.chdir @target_dir do
-      IO.popen("patch --verbose -p#{options[:strip]} --fuzz=#{options[:fuzz]} < #{patch_path} 2>&1") do |out|
+      opts = ["--verbose",  "-p#{options[:strip]}", "--fuzz=#{options[:fuzz]}", "#{options[:patch_options]}"]
+      IO.popen("patch #{opts.join(' ')} < #{patch_path} 2>&1") do |out|
         std = out.readlines
         out.close
         info std
@@ -66,25 +82,47 @@ class Gem::Patcher
             @output << "Error: Unable to patch with #{patch}."
 
             unless Gem.configuration.really_verbose
-              @output << "Run gem patch with --verbose option to swich to verbose mode."
+              @output << 'Run gem patch with --verbose option to swich to verbose mode.'
             end
           end
         end
+	std
       end
     end
   end
 
+  ##
+  # Print results from patching if
+  # Gem.configuration.really_verbose
+
   def print_results
     @output.each do |msg|
       say msg 
     end
   end
 
+  ##
   # Return output lines
+
   def output
     @output
   end
 
+  ##
+  # Return standard output
+  # from patch command
+
+  def std
+    @std
+  end
+
+  ##
+  # Return false if any of the pathes failed
+
+  def failed?
+    @std.join(' ') =~ /.*Hunk #[0-9]+ (ignored|failed).*/
+  end
+
   private
 
   def extract_gem
@@ -106,6 +144,24 @@ class Gem::Patcher
     end
   end
 
+  def copy_in(paths, target)
+    origins = paths.split(',')
+    origins.each do |p|
+      if Dir.exists?(p) || File.exists?(p)
+        FileUtils.cp_r(p, File.join(target, File.basename(p)))
+      else
+        FileUtils.cp_r(File.join(Dir.pwd, p), File.join(target, p))
+      end
+    end
+  end
+
+  def remove(paths, target)
+    removals = paths.split(',')
+    removals.each do |r|
+      FileUtils.rm_r File.join(target, r)
+    end
+  end
+
   def info(msg)
     say msg if Gem.configuration.really_verbose
   end
@@ -148,7 +204,8 @@ class Gem::Patcher
     begin 
       IO.popen('patch --version') 
     rescue Exception
-      raise PatchCommandMissing, 'Calling `patch` command failed. Do you have it installed?'
+      raise PatchCommandMissing, \
+        'Calling `patch` command failed. Do you have it installed?'
     end
   end
 end

data/lib/rubygems_plugin.rb

@@ -1,2 +1,2 @@
-require "rubygems/command_manager"
+require 'rubygems/command_manager'
 Gem::CommandManager.instance.register_command :patch

data/test/rubygems/test_gem_commands_patch_command.rb

@@ -1,5 +1,5 @@
-require "rubygems/test_case"
-require "rubygems/commands/patch_command"
+require 'rubygems/test_case'
+require 'rubygems/commands/patch_command'
 
 class TestGemCommandsPatchCommand < Gem::TestCase
   def setup
@@ -31,4 +31,4 @@ class TestGemCommandsPatchCommand < Gem::TestCase
 
     assert_match 'Please specify patches to apply (e.g. gem patch foo-0.1.0.gem foo.patch bar.patch ...)', e.message
   end
-end
+end

data/test/rubygems/test_gem_patch.rb

@@ -1,5 +1,5 @@
-require "rubygems/test_case"
-require "rubygems/patcher"
+require 'rubygems/test_case'
+require 'rubygems/patcher'
 
 class TestGemPatch < Gem::TestCase
   def setup
@@ -81,6 +81,25 @@ class TestGemPatch < Gem::TestCase
     assert_equal patched_file, file_contents('foo.rb')
   end
   
+  ##
+  # Test passing additional options
+
+  def test_use_outfile_for_output
+    @options[:patch_options] = '--help'
+    
+    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 0, /.*Usage: patch \[OPTION\].*/ =~ patcher.std.join(' ')
+  end
+
+  
   ##
   # Test changing a file in a gem with -F0 option
 

metadata

@@ -1,27 +1,26 @@
 --- !ruby/object:Gem::Specification
 name: gem-patch
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Josef Stribny
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-06 00:00:00.000000000 Z
+date: 2015-06-22 00:00:00.000000000 Z
 dependencies: []
 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,
+                      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
+email: strzibny@strzibny.name
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- README.md
 - LICENCE
-- rakefile.rb
+- README.md
 - lib/rubygems/commands/patch_command.rb
 - lib/rubygems/package-1.8.rb
 - lib/rubygems/patcher.rb
@@ -38,18 +37,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.8.0
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.9
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: RubyGems plugin for patching gems.
 test_files: []
+has_rdoc: 

data/rakefile.rb

@@ -1,39 +0,0 @@
-require 'rubygems/package_task'
-require 'rake/testtask' 
-require 'rdoc/task'
-
-gemspec = Gem::Specification.new do |s|
-  s.name     = "gem-patch"
-  s.version  = "0.1.5"
-  s.platform = Gem::Platform::RUBY
-  s.summary     = "RubyGems plugin for patching gems."
-  s.description = <<-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
-  s.homepage = "http://github.com/strzibny/gem-patch"
-  s.licenses = ["MIT"]
-  s.author   = "Josef Stribny"
-  s.email    = "jstribny@redhat.com"
-  s.required_ruby_version     = ">= 1.8.7"
-  s.required_rubygems_version = ">= 1.8.0"
-  s.files = FileList["README.md", "LICENCE", "rakefile.rb",
-                      "lib/**/*.rb", "test/**/test*.rb"]
-end
-
-Gem::PackageTask.new gemspec do |pkg|
-end
-
-Rake::RDocTask.new do |rd|
-  rd.main = "README.md"
-  rd.rdoc_files.include("README.md", "lib/**/*.rb")
-end
-
-Rake::TestTask.new('test') do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/test*.rb'
-  t.verbose = true
-end
-
-task :default => [:test]