Class: Gemma::RakeTasks

Inherits:
Object
  • Object
show all
Defined in:
lib/gemma/rake_tasks.rb,
lib/gemma/rake_tasks/plugin.rb,
lib/gemma/rake_tasks/gem_tasks.rb,
lib/gemma/rake_tasks/rdoc_tasks.rb,
lib/gemma/rake_tasks/yard_tasks.rb,
lib/gemma/rake_tasks/minitest_tasks.rb

Overview

Generate standard gem development tasks; the tasks are configured using the settings in the given gemspec file.

Examples:

To create the default tasks based on your mygem.gemspec file:

# At the top of Rakefile.rb.
require 'rubygems'
require 'bundler/setup'
require 'gemma'

Gemma::RakeTasks.with_gemspec_file 'mygem.gemspec'

# ... other tasks ...

Defined Under Namespace

Classes: GemTasks, MinitestTasks, Plugin, RDocTasks, YardTasks

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(gemspec) {|tasks| ... } ⇒ RakeTasks

Constructor mainly for internal use; you should usually use the with_gemspec_file alias (see examples in Gemma::RakeTasks).

file or a gemspec object; the latter is intended mainly for testing

Parameters:

  • gemspec (String, Gem::Specification) —

    either the name of a gemspec

Yields:

  • (tasks) —

    used to customize the tasks to be created

Yield Parameters:



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/gemma/rake_tasks.rb', line 39

def initialize(gemspec)
  # Load gemspec.
  if gemspec.is_a?(String)
    @gemspec_file_name = gemspec
    @gemspec = Gem::Specification.load(gemspec_file_name)
  elsif gemspec.is_a?(Gem::Specification)
    @gemspec_file_name = nil
    @gemspec = gemspec
  else
    raise ArgumentError, 'bad gemspec argument'
  end

  @plugins = {}
  create_default_plugins

  # Let the user add more plugins and alter settings.
  yield(self) if block_given?

  @plugins.each_value do |plugin|
    plugin.create_rake_tasks
  rescue StandardError
    warn "plugin #{plugin.class} failed: #{$ERROR_INFO}"
  end
end

Instance Attribute Details

#gemspec ⇒ Gem::Specification (readonly)

The specification used to configure the rake tasks.

(make the changes in the gemspec file instead).

Returns:

  • (Gem::Specification) —

    not nil; you should not modify this object



78
79
80
 
# File 'lib/gemma/rake_tasks.rb', line 78

def gemspec
  @gemspec
end

#gemspec_file_name ⇒ String (readonly)

File from which the #gemspec was loaded.

constructor; otherwise, nil

Returns:

  • (String) —

    not nil if a gemspec file name was passed to the



70
71
72
 
# File 'lib/gemma/rake_tasks.rb', line 70

def gemspec_file_name
  @gemspec_file_name
end

#plugins ⇒ Hash<Symbol, Plugin> (readonly)

Returns:



83
84
85
 
# File 'lib/gemma/rake_tasks.rb', line 83

def plugins
  @plugins
end

Instance Method Details

#gem ⇒ GemTasks

Returns:



109
110
111
 
# File 'lib/gemma/rake_tasks.rb', line 109

def gem
  @plugins[:gem]
end

#rdoc ⇒ RDocTasks

Returns:



88
89
90
 
# File 'lib/gemma/rake_tasks.rb', line 88

def rdoc
  @plugins[:rdoc]
end

#test ⇒ MinitestTasks

Returns:



95
96
97
 
# File 'lib/gemma/rake_tasks.rb', line 95

def test
  @plugins[:test]
end

#yard ⇒ YardTasks

Returns:



102
103
104
 
# File 'lib/gemma/rake_tasks.rb', line 102

def yard
  @plugins[:yard]
end