Class: Gem::Commands::PatchCommand

Inherits:
Gem::Command
  • Object
show all
Defined in:
lib/rubygems/commands/patch_command.rb

Instance Method Summary collapse

Constructor Details

#initialize ⇒ PatchCommand

Returns a new instance of PatchCommand.



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/rubygems/commands/patch_command.rb', line 5

def initialize
  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|
    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

  # 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|
    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

Instance Method Details

#arguments ⇒ Object

:nodoc:



45
46
47
48
49
50
51
 
# File 'lib/rubygems/commands/patch_command.rb', line 45

def arguments # :nodoc:
  args = <<-EOF
        GEMFILE           path to the gem file to patch
        PATCH [PATCH ...] list of patches to apply
  EOF
  return args.gsub(/^\s+/, '')
end

#description ⇒ Object

:nodoc:



53
54
55
56
57
58
59
60
 
# File 'lib/rubygems/commands/patch_command.rb', line 53

def description # :nodoc:
  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

#execute ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/rubygems/commands/patch_command.rb', line 66

def execute
  gemfile = options[:args].shift
  patches = options[:args]
  
  # 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 ...])'
  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 ...)'
  end

  patcher = Gem::Patcher.new(gemfile, options[:output])
  patcher.patch_with(patches, options) 
  patcher.print_results
end

#usage ⇒ Object

:nodoc:



62
63
64
 
# File 'lib/rubygems/commands/patch_command.rb', line 62

def usage # :nodoc:
  "#{program_name} GEMFILE PATCH [PATCH ...]"
end