Class: RDoc::RubygemsHook

Inherits:
Object
  • Object
show all
Defined in:
lib/rdoc/rubygems_hook.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(spec, generate_rdoc = false, generate_ri = true) ⇒ RubygemsHook

Returns a new instance of RubygemsHook.



274
275
276
277
278
279
 
# File 'lib/rdoc/rubygems_hook.rb', line 274

def initialize(spec, generate_rdoc = false, generate_ri = true)
  @spec = spec
  @generate_rdoc = generate_rdoc
  @generate_ri   = generate_ri
  @force = false
end

Instance Attribute Details

#force ⇒ Object

Returns the value of attribute force.



268
269
270
 
# File 'lib/rdoc/rubygems_hook.rb', line 268

def force
  @force
end

#generate_rdoc ⇒ Object

Returns the value of attribute generate_rdoc.



268
269
270
 
# File 'lib/rdoc/rubygems_hook.rb', line 268

def generate_rdoc
  @generate_rdoc
end

#generate_ri ⇒ Object

Returns the value of attribute generate_ri.



268
269
270
 
# File 'lib/rdoc/rubygems_hook.rb', line 268

def generate_ri
  @generate_ri
end

Class Method Details

.default_gem? ⇒ Boolean

Returns:

  • (Boolean) 


270
271
272
 
# File 'lib/rdoc/rubygems_hook.rb', line 270

def self.default_gem?
  !File.exist?(File.join(__dir__, "..", "rubygems_plugin.rb"))
end

.generation_hook(installer, specs) ⇒ Object 



300
301
302
303
304
305
306
 
# File 'lib/rdoc/rubygems_hook.rb', line 300

def self.generation_hook installer, specs
  # Do nothing if this is NOT a default gem.
  return unless default_gem?

  # Generate document for compatibility if this is a default gem.
  RubyGemsHook.generate(installer, specs)
end

.load_rdoc ⇒ Object 



308
309
310
 
# File 'lib/rdoc/rubygems_hook.rb', line 308

def self.load_rdoc
  RubyGemsHook.load_rdoc
end

.rdoc_version ⇒ Object 



312
313
314
 
# File 'lib/rdoc/rubygems_hook.rb', line 312

def self.rdoc_version
  RubyGemsHook.rdoc_version
end

Instance Method Details

#generate ⇒ Object 



281
282
283
284
285
286
287
288
289
 
# File 'lib/rdoc/rubygems_hook.rb', line 281

def generate
  # Do nothing if this is NOT a default gem.
  return unless self.class.default_gem?

  # Generate document for compatibility if this is a default gem.
  hook = RubyGemsHook.new(@spec, @generate_rdoc, @generate_ri)
  hook.force = @force
  hook.generate
end

#rdoc_installed? ⇒ Boolean

Returns:

  • (Boolean) 


316
317
318
 
# File 'lib/rdoc/rubygems_hook.rb', line 316

def rdoc_installed?
  RubyGemsHook.new(@spec).rdoc_installed?
end

#remove ⇒ Object 



291
292
293
294
295
296
297
298
 
# File 'lib/rdoc/rubygems_hook.rb', line 291

def remove
  # Do nothing if this is NOT a default gem.
  return unless self.class.default_gem?

  # Remove generated document for compatibility if this is a
  # default gem.
  RubyGemsHook.new(@spec).remove
end

#ri_installed? ⇒ Boolean

Returns:

  • (Boolean) 


320
321
322
 
# File 'lib/rdoc/rubygems_hook.rb', line 320

def ri_installed?
  RubyGemsHook.new(@spec).ri_installed?
end