BasicSpecification
is an abstract class which implements some common code used by both Specification and StubSpecification.
The path this gemspec was loaded from. This attribute is not persisted.
# File tmp/rubies/ruby-2.7.6/lib/rubygems/basic_specification.rb, line 37
def self.default_specifications_dir
Gem.default_specifications_dir
end
# File tmp/rubies/ruby-2.7.6/lib/rubygems/basic_specification.rb, line 33
def initialize
internal_init
end
# File tmp/rubies/ruby-2.7.6/lib/rubygems/basic_specification.rb, line 59
def activated?
raise NotImplementedError
end
True when the gem has been activated
# File tmp/rubies/ruby-2.7.6/lib/rubygems/basic_specification.rb, line 68
def base_dir
raise NotImplementedError
end
Returns the full path to the base gem directory.
eg: /usr/local/lib/ruby/gems/1.8
# File tmp/rubies/ruby-2.7.6/lib/rubygems/basic_specification.rb, line 75
def contains_requirable_file?(file)
if @ignored
return false
elsif missing_extensions?
@ignored = true
if Gem::Platform::RUBY == platform || Gem::Platform.local === platform
warn "Ignoring #{full_name} because its extensions are not built. " +
"Try: gem pristine #{name} --version #{version}"
end
return false
end
have_file? file, Gem.suffixes
end
Return true if this spec can require file
.
# File tmp/rubies/ruby-2.7.6/lib/rubygems/basic_specification.rb, line 164
def datadir
# TODO: drop the extra ", gem_name" which is uselessly redundant
File.expand_path(File.join(gems_dir, full_name, "data", name)).tap(&Gem::UNTAINT)
end
The path to the data directory for this gem.
# File tmp/rubies/ruby-2.7.6/lib/rubygems/basic_specification.rb, line 92
def default_gem?
loaded_from &&
File.dirname(loaded_from) == Gem.default_specifications_dir
end
# File tmp/rubies/ruby-2.7.6/lib/rubygems/basic_specification.rb, line 100
def extension_dir
@extension_dir ||= File.expand_path(File.join(extensions_dir, full_name)).tap(&Gem::UNTAINT)
end
Returns full path to the directory where gem’s extensions are installed.
# File tmp/rubies/ruby-2.7.6/lib/rubygems/basic_specification.rb, line 107
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
Returns path to the extensions directory.
# File tmp/rubies/ruby-2.7.6/lib/rubygems/basic_specification.rb, line 125
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
The full path to the gem (install path + full name).
# File tmp/rubies/ruby-2.7.6/lib/rubygems/basic_specification.rb, line 136
def full_name
if platform == Gem::Platform::RUBY or platform.nil?
"#{name}-#{version}".dup.tap(&Gem::UNTAINT)
else
"#{name}-#{version}-#{platform}".dup.tap(&Gem::UNTAINT)
end
end
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.
# File tmp/rubies/ruby-2.7.6/lib/rubygems/basic_specification.rb, line 148
def full_require_paths
@full_require_paths ||=
begin
full_paths = raw_require_paths.map do |path|
File.join full_gem_path, path.tap(&Gem::UNTAINT)
end
full_paths << extension_dir if have_extensions?
full_paths
end
end
Full paths in the gem to add to $LOAD_PATH
when this gem is activated.
# File tmp/rubies/ruby-2.7.6/lib/rubygems/basic_specification.rb, line 195
def gem_dir
@gem_dir ||= File.expand_path File.join(gems_dir, full_name)
end
Returns the full path to this spec’s gem directory. eg: /usr/local/lib/ruby/1.8/gems/mygem-1.0
# File tmp/rubies/ruby-2.7.6/lib/rubygems/basic_specification.rb, line 203
def gems_dir
raise NotImplementedError
end
Returns the full path to the gems directory containing this spec’s gem directory. eg: /usr/local/lib/ruby/1.8/gems
# File tmp/rubies/ruby-2.7.6/lib/rubygems/basic_specification.rb, line 327
def have_extensions?; !extensions.empty?; end
# File tmp/rubies/ruby-2.7.6/lib/rubygems/basic_specification.rb, line 329
def have_file?(file, suffixes)
return true if raw_require_paths.any? do |path|
base = File.join(gems_dir, full_name, path.tap(&Gem::UNTAINT), file).tap(&Gem::UNTAINT)
suffixes.any? { |suf| File.file? base + suf }
end
if have_extensions?
base = File.join extension_dir, file
suffixes.any? { |suf| File.file? base + suf }
else
false
end
end
# File tmp/rubies/ruby-2.7.6/lib/rubygems/basic_specification.rb, line 287
def lib_dirs_glob
dirs = if self.raw_require_paths
if self.raw_require_paths.size > 1
"{#{self.raw_require_paths.join(',')}}"
else
self.raw_require_paths.first
end
else
"lib" # default value for require_paths for bundler/inline
end
"#{self.full_gem_path}/#{dirs}".dup.tap(&Gem::UNTAINT)
end
Returns a string usable in Dir.glob
to match all requirable paths for this spec.
# File tmp/rubies/ruby-2.7.6/lib/rubygems/basic_specification.rb, line 276
def matches_for_glob(glob) # TODO: rename?
# TODO: do we need these?? Kill it
glob = File.join(self.lib_dirs_glob, glob)
Dir[glob].map { |f| f.tap(&Gem::UNTAINT) } # FIX our tests are broken, run w/ SAFE=1
end
Return all files in this gem that match for glob
.
# File tmp/rubies/ruby-2.7.6/lib/rubygems/basic_specification.rb, line 217
def name
raise NotImplementedError
end
Name of the gem
# File tmp/rubies/ruby-2.7.6/lib/rubygems/basic_specification.rb, line 224
def platform
raise NotImplementedError
end
Platform of the gem
# File tmp/rubies/ruby-2.7.6/lib/rubygems/basic_specification.rb, line 249
def require_paths
return raw_require_paths unless have_extensions?
[extension_dir].concat raw_require_paths
end
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 = '.'
# File tmp/rubies/ruby-2.7.6/lib/rubygems/basic_specification.rb, line 259
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
Returns the paths to the source files for use with analysis and documentation tools. These paths are relative to full_gem_path.
# File tmp/rubies/ruby-2.7.6/lib/rubygems/basic_specification.rb, line 319
def stubbed?
raise NotImplementedError
end
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.
# File tmp/rubies/ruby-2.7.6/lib/rubygems/basic_specification.rb, line 323
def this; self; end
# File tmp/rubies/ruby-2.7.6/lib/rubygems/basic_specification.rb, line 173
def to_fullpath(path)
if activated?
@paths_map ||= {}
@paths_map[path] ||=
begin
fullpath = nil
suffixes = Gem.suffixes
suffixes.find do |suf|
full_require_paths.find do |dir|
File.file?(fullpath = "#{dir}/#{path}#{suf}")
end
end ? fullpath : nil
end
else
nil
end
end
Full path of the target library file. If the file is not in this gem, return nil.
# File tmp/rubies/ruby-2.7.6/lib/rubygems/basic_specification.rb, line 304
def to_spec
raise NotImplementedError
end
Return a Gem::Specification
from this gem
# File tmp/rubies/ruby-2.7.6/lib/rubygems/basic_specification.rb, line 311
def version
raise NotImplementedError
end
Version of the gem