Class: Gem::BasicSpecification

Inherits:
Object
  • Object
show all
Extended by:
Deprecate
Defined in:
lib/rubygems/basic_specification.rb

Overview

BasicSpecification is an abstract class which implements some common code used by both Specification and StubSpecification.

Direct Known Subclasses

Specification, StubSpecification

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Deprecate

deprecate, next_rubygems_major_version, rubygems_deprecate, rubygems_deprecate_command, skip, skip=, skip_during

Constructor Details

#initialize ⇒ BasicSpecification

Returns a new instance of BasicSpecification.



33
34
35
 
# File 'lib/rubygems/basic_specification.rb', line 33

def initialize
  internal_init
end

Instance Attribute Details

#base_dir ⇒ Object

Returns the full path to the base gem directory.

eg: /usr/local/lib/ruby/gems/1.8

Raises:

  • (NotImplementedError) 


57
58
59
 
# File 'lib/rubygems/basic_specification.rb', line 57

def base_dir
  raise NotImplementedError
end

#extension_dir ⇒ Object

Returns full path to the directory where gem’s extensions are installed.



114
115
116
 
# File 'lib/rubygems/basic_specification.rb', line 114

def extension_dir
  @extension_dir ||= File.expand_path(File.join(extensions_dir, full_name))
end

#full_gem_path ⇒ Object

The full path to the gem (install path + full name).

TODO: This is duplicated with #gem_dir. Eventually either of them should be deprecated.



138
139
140
 
# File 'lib/rubygems/basic_specification.rb', line 138

def full_gem_path
  @full_gem_path ||= find_full_gem_path
end

#ignored=(value) ⇒ Object (writeonly)

Is this specification ignored for activation purposes?



21
22
23
 
# File 'lib/rubygems/basic_specification.rb', line 21

def ignored=(value)
  @ignored = value
end

#loaded_from ⇒ Object

The path this gemspec was loaded from. This attribute is not persisted.



26
27
28
 
# File 'lib/rubygems/basic_specification.rb', line 26

def loaded_from
  @loaded_from
end

Instance Method Details

#activated? ⇒ Boolean

True when the gem has been activated

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


48
49
50
 
# File 'lib/rubygems/basic_specification.rb', line 48

def activated?
  raise NotImplementedError
end

#base_dir_priority(gem_path) ⇒ Object

Gems higher up in gem_path take precedence



107
108
109
 
# File 'lib/rubygems/basic_specification.rb', line 107

def base_dir_priority(gem_path)
  gem_path.index(base_dir) || gem_path.size
end

#contains_requirable_file?(file) ⇒ Boolean

Return true if this spec can require file.

Returns:

  • (Boolean) 


64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/rubygems/basic_specification.rb', line 64

def contains_requirable_file?(file)
  if ignored?
    if platform == Gem::Platform::RUBY || Gem::Platform.local === platform
      warn "Ignoring #{full_name} because its extensions are not built. " \
           "Try: gem pristine #{name} --version #{version}"
    end

    return false
  end

  is_soext = file.end_with?(".so", ".o")

  if is_soext
    have_file? file.delete_suffix(File.extname(file)), Gem.dynamic_library_suffixes
  else
    have_file? file, Gem.suffixes
  end
end

#datadir ⇒ Object

The path to the data directory for this gem.



188
189
190
191
 
# File 'lib/rubygems/basic_specification.rb', line 188

def datadir
  # TODO: drop the extra ", gem_name" which is uselessly redundant
  File.expand_path(File.join(gems_dir, full_name, "data", name))
end

#default_gem? ⇒ Boolean

Returns:

  • (Boolean) 


92
93
94
95
 
# File 'lib/rubygems/basic_specification.rb', line 92

def default_gem?
  !loaded_from.nil? &&
    File.dirname(loaded_from) == Gem.default_specifications_dir
end

#default_gem_priority ⇒ Object

Regular gems take precedence over default gems



100
101
102
 
# File 'lib/rubygems/basic_specification.rb', line 100

def default_gem_priority
  default_gem? ? 1 : -1
end

#extensions_dir ⇒ Object

Returns path to the extensions directory.



121
122
123
124
125
 
# File 'lib/rubygems/basic_specification.rb', line 121

def extensions_dir
  Gem.default_ext_dir_for(base_dir) ||
    File.join(base_dir, "extensions", Gem::Platform.local.to_s,
              Gem.extension_api_version)
end

#full_name ⇒ Object

Returns the full name (name-version) of this Gem. Platform information is included (name-version-platform) if it is specified and not the default Ruby platform.



147
148
149
150
151
152
153
 
# File 'lib/rubygems/basic_specification.rb', line 147

def full_name
  if platform == Gem::Platform::RUBY || platform.nil?
    "#{name}-#{version}"
  else
    "#{name}-#{version}-#{platform}"
  end
end

#full_name_with_location ⇒ Object

Returns the full name of this Gem (see ‘Gem::BasicSpecification#full_name`). Information about where the gem is installed is also included if not installed in the default GEM_HOME.



160
161
162
163
164
165
166
 
# File 'lib/rubygems/basic_specification.rb', line 160

def full_name_with_location
  if base_dir != Gem.dir
    "#{full_name} in #{base_dir}"
  else
    full_name
  end
end

#full_require_paths ⇒ Object

Full paths in the gem to add to $LOAD_PATH when this gem is activated.



172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/rubygems/basic_specification.rb', line 172

def full_require_paths
  @full_require_paths ||=
    begin
      full_paths = raw_require_paths.map do |path|
        File.join full_gem_path, path
      end

      full_paths << extension_dir if have_extensions?

      full_paths
    end
end

#gem_build_complete_path ⇒ Object

The path to the gem.build_complete file within the extension install directory.



41
42
43
 
# File 'lib/rubygems/basic_specification.rb', line 41

def gem_build_complete_path # :nodoc:
  File.join extension_dir, "gem.build_complete"
end

#gem_dir ⇒ Object

Returns the full path to this spec’s gem directory. eg: /usr/local/lib/ruby/1.8/gems/mygem-1.0

TODO: This is duplicated with #full_gem_path. Eventually either of them should be deprecated.



220
221
222
 
# File 'lib/rubygems/basic_specification.rb', line 220

def gem_dir
  @gem_dir ||= find_full_gem_path
end

#gems_dir ⇒ Object

Returns the full path to the gems directory containing this spec’s gem directory. eg: /usr/local/lib/ruby/1.8/gems

Raises:

  • (NotImplementedError) 


228
229
230
 
# File 'lib/rubygems/basic_specification.rb', line 228

def gems_dir
  raise NotImplementedError
end

#ignored? ⇒ Boolean

Return true if this spec should be ignored because it’s missing extensions.

Returns:

  • (Boolean) 


86
87
88
89
90
 
# File 'lib/rubygems/basic_specification.rb', line 86

def ignored?
  return @ignored unless @ignored.nil?

  @ignored = missing_extensions?
end

#installable_on_platform?(target_platform) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


253
254
255
256
257
258
 
# File 'lib/rubygems/basic_specification.rb', line 253

def installable_on_platform?(target_platform) # :nodoc:
  return true if [Gem::Platform::RUBY, nil, target_platform].include?(platform)
  return true if Gem::Platform.new(platform) === target_platform

  false
end

#internal_init ⇒ Object

:nodoc:



232
233
234
235
236
237
 
# File 'lib/rubygems/basic_specification.rb', line 232

def internal_init # :nodoc:
  @extension_dir = nil
  @full_gem_path = nil
  @gem_dir = nil
  @ignored = nil
end

#lib_dirs_glob ⇒ Object

Returns a string usable in Dir.glob to match all requirable paths for this spec.



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/rubygems/basic_specification.rb', line 325

def lib_dirs_glob
  dirs = if raw_require_paths
    if raw_require_paths.size > 1
      "{#{raw_require_paths.join(",")}}"
    else
      raw_require_paths.first
    end
  else
    "lib" # default value for require_paths for bundler/inline
  end

  "#{full_gem_path}/#{dirs}"
end

#matches_for_glob(glob) ⇒ Object

Return all files in this gem that match for glob.



308
309
310
311
312
 
# File 'lib/rubygems/basic_specification.rb', line 308

def matches_for_glob(glob) # TODO: rename?
  glob = File.join(lib_dirs_glob, glob)

  Dir[glob]
end

#name ⇒ Object

Name of the gem

Raises:

  • (NotImplementedError) 


242
243
244
 
# File 'lib/rubygems/basic_specification.rb', line 242

def name
  raise NotImplementedError
end

#platform ⇒ Object

Platform of the gem

Raises:

  • (NotImplementedError) 


249
250
251
 
# File 'lib/rubygems/basic_specification.rb', line 249

def platform
  raise NotImplementedError
end

#plugins ⇒ Object

Returns the list of plugins in this spec.



317
318
319
 
# File 'lib/rubygems/basic_specification.rb', line 317

def plugins
  matches_for_glob("rubygems#{Gem.plugin_suffix_pattern}")
end

#raw_require_paths ⇒ Object

:nodoc:

Raises:

  • (NotImplementedError) 


260
261
262
 
# File 'lib/rubygems/basic_specification.rb', line 260

def raw_require_paths # :nodoc:
  raise NotImplementedError
end

#require_paths ⇒ Object

Paths in the gem to add to $LOAD_PATH when this gem is activated.

See also #require_paths=

If you have an extension you do not need to add "ext" to the require path, the extension build process will copy the extension files into “lib” for you.

The default value is "lib"

Usage:

# If all library files are in the root directory...
spec.require_path = '.'



281
282
283
284
285
 
# File 'lib/rubygems/basic_specification.rb', line 281

def require_paths
  return raw_require_paths unless have_extensions?

  [extension_dir].concat raw_require_paths
end

#source_paths ⇒ Object

Returns the paths to the source files for use with analysis and documentation tools. These paths are relative to full_gem_path.



291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/rubygems/basic_specification.rb', line 291

def source_paths
  paths = raw_require_paths.dup

  if have_extensions?
    ext_dirs = extensions.map do |extension|
      extension.split(File::SEPARATOR, 2).first
    end.uniq

    paths.concat ext_dirs
  end

  paths.uniq
end

#stubbed? ⇒ Boolean

Whether this specification is stubbed - i.e. we have information about the gem from a stub line, without having to evaluate the entire gemspec file.

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


357
358
359
 
# File 'lib/rubygems/basic_specification.rb', line 357

def stubbed?
  raise NotImplementedError
end

#this ⇒ Object 



361
362
363
 
# File 'lib/rubygems/basic_specification.rb', line 361

def this
  self
end

#to_fullpath(path) ⇒ Object

Full path of the target library file. If the file is not in this gem, return nil.



200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/rubygems/basic_specification.rb', line 200

def to_fullpath(path)
  if activated?
    @paths_map ||= {}
    Gem.suffixes.each do |suf|
      full_require_paths.each do |dir|
        fullpath = "#{dir}/#{path}#{suf}"
        next unless File.file?(fullpath)
        @paths_map[path] ||= fullpath
      end
    end
    @paths_map[path]
  end
end

#to_spec ⇒ Object

Return a Gem::Specification from this gem

Raises:

  • (NotImplementedError) 


342
343
344
 
# File 'lib/rubygems/basic_specification.rb', line 342

def to_spec
  raise NotImplementedError
end

#version ⇒ Object

Version of the gem

Raises:

  • (NotImplementedError) 


349
350
351
 
# File 'lib/rubygems/basic_specification.rb', line 349

def version
  raise NotImplementedError
end