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

Class Method 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

#initializeBasicSpecification

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_dirObject

Returns the full path to the base gem directory.

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

Raises:

  • (NotImplementedError)


66
67
68
# File 'lib/rubygems/basic_specification.rb', line 66

def base_dir
  raise NotImplementedError
end

#extension_dirObject

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



104
105
106
# File 'lib/rubygems/basic_specification.rb', line 104

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

#full_gem_pathObject

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



127
128
129
130
131
# File 'lib/rubygems/basic_specification.rb', line 127

def full_gem_path
  # TODO: This is a heavily used method by gems, so we'll need
  # to aleast just alias it to #gem_dir rather than remove it.
  @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_fromObject

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

Class Method Details

.default_specifications_dirObject



37
38
39
# File 'lib/rubygems/basic_specification.rb', line 37

def self.default_specifications_dir
  Gem.default_specifications_dir
end

Instance Method Details

#activated?Boolean

True when the gem has been activated

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError)


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

def activated?
  raise NotImplementedError
end

#contains_requirable_file?(file) ⇒ Boolean

Return true if this spec can require file.

Returns:

  • (Boolean)


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# File 'lib/rubygems/basic_specification.rb', line 73

def contains_requirable_file?(file)
  if @ignored
    return false
  elsif missing_extensions?
    @ignored = true

    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

#datadirObject

The path to the data directory for this gem.



166
167
168
169
# File 'lib/rubygems/basic_specification.rb', line 166

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)


96
97
98
99
# File 'lib/rubygems/basic_specification.rb', line 96

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

#extensions_dirObject

Returns path to the extensions directory.



111
112
113
114
115
# File 'lib/rubygems/basic_specification.rb', line 111

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_nameObject

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.



138
139
140
141
142
143
144
# File 'lib/rubygems/basic_specification.rb', line 138

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

#full_require_pathsObject

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



150
151
152
153
154
155
156
157
158
159
160
161
# File 'lib/rubygems/basic_specification.rb', line 150

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_pathObject

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



50
51
52
# File 'lib/rubygems/basic_specification.rb', line 50

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

#gem_dirObject

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



193
194
195
# File 'lib/rubygems/basic_specification.rb', line 193

def gem_dir
  @gem_dir ||= File.expand_path File.join(gems_dir, full_name)
end

#gems_dirObject

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

Raises:

  • (NotImplementedError)


201
202
203
# File 'lib/rubygems/basic_specification.rb', line 201

def gems_dir
  raise NotImplementedError
end

#internal_initObject

:nodoc:



205
206
207
208
209
210
# File 'lib/rubygems/basic_specification.rb', line 205

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

#lib_dirs_globObject

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



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

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.



274
275
276
277
278
# File 'lib/rubygems/basic_specification.rb', line 274

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

  Dir[glob]
end

#nameObject

Name of the gem

Raises:

  • (NotImplementedError)


215
216
217
# File 'lib/rubygems/basic_specification.rb', line 215

def name
  raise NotImplementedError
end

#platformObject

Platform of the gem

Raises:

  • (NotImplementedError)


222
223
224
# File 'lib/rubygems/basic_specification.rb', line 222

def platform
  raise NotImplementedError
end

#pluginsObject

Returns the list of plugins in this spec.



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

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

#raw_require_pathsObject

:nodoc:

Raises:

  • (NotImplementedError)


226
227
228
# File 'lib/rubygems/basic_specification.rb', line 226

def raw_require_paths # :nodoc:
  raise NotImplementedError
end

#require_pathsObject

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 = '.'


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

def require_paths
  return raw_require_paths unless have_extensions?

  [extension_dir].concat raw_require_paths
end

#source_pathsObject

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



257
258
259
260
261
262
263
264
265
266
267
268
269
# File 'lib/rubygems/basic_specification.rb', line 257

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)


323
324
325
# File 'lib/rubygems/basic_specification.rb', line 323

def stubbed?
  raise NotImplementedError
end

#thisObject



327
328
329
# File 'lib/rubygems/basic_specification.rb', line 327

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.



175
176
177
178
179
180
181
182
183
184
185
186
187
# File 'lib/rubygems/basic_specification.rb', line 175

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_specObject

Return a Gem::Specification from this gem

Raises:

  • (NotImplementedError)


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

def to_spec
  raise NotImplementedError
end

#versionObject

Version of the gem

Raises:

  • (NotImplementedError)


315
316
317
# File 'lib/rubygems/basic_specification.rb', line 315

def version
  raise NotImplementedError
end