Class: Inventory::Rake::Tasks::Gem

Inherits:
Object
  • Object
show all
Includes:
Rake::DSL
Defined in:
lib/inventory-rake-1.0/tasks/gem.rb

Overview

Defines [RubyGems](rubygems.org/)-related tasks. This includes tasks for generating a gem specification, creating a gem file, checking the gem file before distribution, installing gem dependencies, installing and uninstalling the gem locally, and pushing the gem to a distribution point.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) {|?| ... } ⇒ Gem

Sets up tasks based on INVENTORY and SPECIFICATION, optionally yields the task object and the gem specification for further customization, then #defines the tasks.

The default for SPECIFICATION is to use the name, version, authors, email, homepage, licenses, and files of the inventory, use all of ‘README` as the description, set the summary to the first sentence of the description, set the require paths to “lib”, add each extension of the inventory’s extconf to the extensions, and finally add inventory’s dependencies.

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :inventory (Inventory) — default: Inventory::Rake::Tasks.inventory —

    The inventory to use

  • :specification (Gem::Specification) —

    The specification to use

Yields:

  • (?)

Yield Parameters:

  • task (self)
  • specification (Gem::Specification) 

28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/inventory-rake-1.0/tasks/gem.rb', line 28

def initialize(options = {})
  self.inventory = options.fetch(:inventory, Inventory::Rake::Tasks.inventory)
  self.specification = options.fetch(:specification,
                                     Gem::Specification.new{ |s|
                                       next unless @inventory

                                       s.name = @inventory.package
                                       s.version = @inventory.to_s # TODO: We could probably skip #to_s

                                       s.description = IO.read('README')
                                       s.summary = s.description[/^.*?\./].lstrip

                                       s.authors = @inventory.authors.map(&:name)
                                       s.email = @inventory.authors.map(&:email)
                                       s.homepage = @inventory.homepage

                                       s.licenses = @inventory.licenses.map(&:abbreviation)

                                       s.files = @inventory.files # TODO: We can skip #files and rely on #to_a

                                       s.require_paths = @inventory.lib_directories

                                       s.extensions = @inventory.extensions.map(&:extconf)

                                       @inventory.dependencies.add_to_gem_specification s
                                     })
  yield self, @specification if block_given?
  define
end

Instance Attribute Details

#inventory=(value) ⇒ Inventory (writeonly)

Returns The inventory to use: VALUE.

Parameters:

Returns:

  • (Inventory) —

    The inventory to use: VALUE


310
311
312
 
# File 'lib/inventory-rake-1.0/tasks/gem.rb', line 310

def inventory=(value)
  @inventory = value
end

#specification=(value) ⇒ Gem::Specification (writeonly)

Returns The specification to use: VALUE.

Parameters:

  • value (Gem::Specification)

Returns:

  • (Gem::Specification) —

    The specification to use: VALUE


314
315
316
 
# File 'lib/inventory-rake-1.0/tasks/gem.rb', line 314

def specification=(value)
  @specification = value
end

Instance Method Details

#define ⇒ self

Defines the following tasks:

<dl>

<dt>spec</dt>
<dd>Create specifications; depends on gem:spec.</dd>

<dt>gem:spec</dt>
<dd>Create gem specification; depends on <em>gemspec</em>.</dd>

<dt>gemspec (file)</dt>
<dd>Gem specification file; depends on Rakefile, README, and inventory
path.</dd>

<dt>dist</dt>
<dd>Create files for distribution; depends on gem:dist.</dd>

<dt>gem:dist</dt>
<dd>Create gem for distribution; depends on inventory:check and
<em>gem</em> file.</dd>

<dt>gem (file)</dt>
<dd>Gem file; depends on files included in gem.</dd>

<dt>dist:check</dt>
<dd>Check files before distribution; depends on dist and
gem:dist:check.</dd>

<dt>gem:dist:check</dt>
<dd>Check gem before distribution; depends on gem:dist.</dd>

<dt>deps:install</dt>
<dd>Install dependencies on the local system; depends on
gem:deps:install.</dd>

<dt>gem:deps:install</dt>
<dd>Install dependencies in ruby gem directory.</dd>

<dt>deps:install:user</dt>
<dd>Install dependencies for the current user; depends on
gem:deps:install:user.</dd>

<dt>gem:deps:install:user</dt>
<dd>Install dependencies in the user gem directory.</dd>

<dt>install</dt>
<dd>Install distribution files on the local system; depends on
gem:install.</dd>

<dt>gem:install</dt>
<dd>Install <em>gem</em> in ruby gem directory; depends on gem:dist.</dd>

<dt>install:user</dt>
<dd>Install distribution files for the current user; depends on
gem:install:user.</dd>

<dt>gem:install:user</dt>
<dd>Install <em>gem</em> in the user gem directory.</dd>

<dt>uninstall</dt>
<dd>Delete all files installed on the local system.</dd>

<dt>gem:uninstall</dt>
<dd>Uninstall <em>gem</em> from ruby gem directory.</dd>

<dt>uninstall:user</dt>
<dd>Delete all files installed for current user.</dd>

<dt>gem:uninstall:user</dt>
<dd>Uninstall <em>gem</em> from ruby gem directory.</dd>

<dt>push</dt>
<dd>Push distribution files to distribution hubs.</dd>

<dt>gem:push</dt>
<dd>Push <em>gem</em> to rubygems.org.</dd>

</dl>

The gemspec will be added to Inventory::Rake::Tasks.cleanfiles.

Returns:

  • (self) 

138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/inventory-rake-1.0/tasks/gem.rb', line 138

def define
  desc 'Create specifications' unless Rake::Task.task_defined? :spec
  task :spec => :'gem:spec'

  gemspec = '%s.gemspec' % @specification.name
  Inventory::Rake::Tasks.cleanfiles << gemspec

  desc 'Create gem specification' unless Rake::Task.task_defined? :'gem:spec'
  task :'gem:spec' => gemspec

  file gemspec => %w'Rakefile README' + [@inventory.path] do |t|
    tmp = '%s.tmp' % t.name
    rm([t.name, tmp], :force => true)
    rake_output_message 'gem specification --ruby %s > %s' %
      [@specification.name, tmp] if verbose
    File.open(tmp, 'wb') do |f|
      f.write @specification.to_ruby
    end
    chmod File.stat(tmp).mode & ~0222, tmp
    mv tmp, t.name
   end

  desc 'Create files for distribution' unless Rake::Task.task_defined? :dist
  task :dist => :'gem:dist'

  desc 'Create %s for distribution' % @specification.file_name
  task :'gem:dist' => [:'inventory:check', @specification.file_name]
  file @specification.file_name => @specification.files do
    require 'rubygems' unless defined? Gem
    require 'rubygems/package' unless defined? Gem::Package
    rake_output_message 'gem build %s' % gemspec if verbose
    Gem::Package.build @specification
  end

  desc 'Check files before distribution' unless
    Rake::Task.task_defined? :'dist:check'
  task :'dist:check' => [:dist, :'gem:dist:check']

  desc 'Check %s before distribution' % @specification.file_name
  task :'gem:dist:check' => :'gem:dist' do
    require 'rubygems' unless defined? Gem
    require 'rubygems/installer' unless defined? Gem::Installer
    checkdir = @specification.full_name
    rake_output_message 'gem unpack %s --target %s' %
      [@specification.file_name, checkdir] if verbose
    Gem::Installer.new(@specification.file_name, :unpack => true).
      unpack File.expand_path(checkdir)
    chdir checkdir do
      sh '%s %sinventory:check check' %
        [Rake.application.name, Rake.application.options.silent ? '-s ' : '']
    end
    rm_r checkdir
  end

  desc 'Install dependencies on the local system' unless
    Rake::Task.task_defined? :'deps:install'
  task :'deps:install' => :'gem:deps:install'

  desc 'Install dependencies in ruby gem directory'
  task :'gem:deps:install' do
    require 'rubygems' unless defined? Gem
    require 'rubygems/dependency_installer' unless defined? Gem::DependencyInstaller
    @specification.dependencies.each do |dependency|
      next unless Gem::Dependency.new(dependency.name,
                                      dependency.requirement).matching_specs.empty?
      rake_output_message "gem install %s -v '%s'" %
                          [dependency.name, dependency.requirement] if verbose
      Gem::DependencyInstaller.new.install dependency.name, dependency.requirement
    end
  end

  desc 'Install dependencies for the current user' unless
    Rake::Task.task_defined? :'deps:install:user'
  task :'deps:install:user' => :'gem:deps:install:user'

  desc 'Install dependencies in the current user’s ruby gem directory'
  task :'gem:deps:install:user' do
    require 'rubygems' unless defined? Gem
    require 'rubygems/dependency_installer' unless defined? Gem::DependencyInstaller
    @specification.dependencies.each do |dependency|
      next unless Gem::Dependency.new(dependency.name,
                                      dependency.requirement).matching_specs.empty?
      rake_output_message "gem install --user-install --bindir %s %s -v '%s'" %
        [Gem.bindir(Gem.user_dir), dependency.name, dependency.requirement] if verbose
      Gem::DependencyInstaller.
        new(:user_install => true,
            :bindir => Gem.bindir(Gem.user_dir)).
        install dependency.name, dependency.requirement
    end
  end

  desc 'Install distribution files on the local system' unless
    Rake::Task.task_defined? :install
  task :install => :'gem:install'

  desc 'Install %s in ruby gem directory' %
    @specification.file_name
  task :'gem:install' => :'gem:dist' do |t|
    require 'rubygems' unless defined? Gem
    require 'rubygems/dependency_installer' unless defined? Gem::DependencyInstaller
    rake_output_message 'gem install %s' % @specification.file_name if verbose
    Gem::DependencyInstaller.
      new(:ignore_dependencies => true).
      install @specification.file_name
  end

  desc 'Install distribution files for the current user' unless
    Rake::Task.task_defined? :'install:user'
  task :'install:user' => :'gem:install:user'

  desc 'Install %s in user gem directory' %
    @specification.file_name
  task :'gem:install:user' => :'gem:dist' do
    require 'rubygems' unless defined? Gem
    require 'rubygems/dependency_installer' unless defined? Gem::DependencyInstaller
    rake_output_message 'gem install --user-install --bindir %s %s' %
      [Gem.bindir(Gem.user_dir), @specification.file_name] if verbose
    Gem::DependencyInstaller.
      new(:ignore_dependencies => true,
          :user_install => true,
          :bindir => Gem.bindir(Gem.user_dir)).
      install @specification.file_name
  end

  desc 'Delete all files installed on the local system' unless
    Rake::Task.task_defined? :uninstall
  task :uninstall => :'gem:uninstall'

  desc 'Uninstall %s from ruby gem directory' % @specification.file_name
  task :'gem:uninstall' do
    require 'rubygems' unless defined? Gem
    # TODO: I have absolutely no idea why this is needed, but it is.
    require 'rubygems/user_interaction' unless defined? Gem::UserInteraction
    require 'rubygems/uninstaller' unless defined? Gem::Uninstaller
    rake_output_message 'gem uninstall --executables %s' % @specification.name if verbose
    Gem::Uninstaller.new(@specification.name,
                         :executables => true,
                         :version => @specification.version).uninstall
  end

  desc 'Delete all files installed for current user' unless
    Rake::Task.task_defined? :'uninstall:user'
  task :'uninstall:user' => :'gem:uninstall:user'

  desc 'Uninstall %s from user gem directory' % @specification.file_name
  task :'gem:uninstall:user' do
    require 'rubygems' unless defined? Gem
    # TODO: I have absolutely no idea why this is needed, but it is.
    require 'rubygems/user_interaction' unless defined? Gem::UserInteraction
    require 'rubygems/uninstaller' unless defined? Gem::Uninstaller
    rake_output_message 'gem uninstall --executables --install-dir %s %s' %
      [Gem.user_dir, @specification.name] if verbose
    Gem::Uninstaller.new(@specification.name,
                         :executables => true,
                         :install_dir => Gem.user_dir,
                         :version => @specification.version).uninstall
  end

  desc 'Push distribution files to distribution hubs' unless
    Rake::Task.task_defined? :push
  task :push => :'gem:push'

  desc 'Push %s to rubygems.org' % @specification.file_name
  task :'gem:push' => :'gem:dist:check' do
    sh 'gem push -%s-verbose %s' % [verbose ? '' : '-no', @specification.file_name]
  end

  self
end