Class: Gem::BasicSpecification

Inherits:
Object
  • Object
show all
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

Constructor Details

#initializeBasicSpecification


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)

61
62
63
# File 'lib/rubygems/basic_specification.rb', line 61

def base_dir
  raise NotImplementedError
end

#extension_dirObject

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


90
91
92
# File 'lib/rubygems/basic_specification.rb', line 90

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

#full_gem_pathObject

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


115
116
117
118
119
# File 'lib/rubygems/basic_specification.rb', line 115

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
  File.join(Gem.default_dir, "specifications", "default")
end

Instance Method Details

#activated?Boolean

True when the gem has been activated

Raises:

  • (NotImplementedError)

52
53
54
# File 'lib/rubygems/basic_specification.rb', line 52

def activated?
  raise NotImplementedError
end

#contains_requirable_file?(file) ⇒ Boolean

Return true if this spec can require file.


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

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

    warn "Ignoring #{full_name} because its extensions are not built. " +
      "Try: gem pristine #{name} --version #{version}"
    return false
  end

  have_file? file, Gem.suffixes
end

#datadirObject

The path to the data directory for this gem.


154
155
156
157
# File 'lib/rubygems/basic_specification.rb', line 154

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

#default_gem?Boolean


82
83
84
85
# File 'lib/rubygems/basic_specification.rb', line 82

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

#extensions_dirObject

Returns path to the extensions directory.


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

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.


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

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

#full_require_pathsObject

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


138
139
140
141
142
143
144
145
146
147
148
149
# File 'lib/rubygems/basic_specification.rb', line 138

def full_require_paths
  @full_require_paths ||=
  begin
    full_paths = raw_require_paths.map do |path|
      File.join full_gem_path, path.untaint
    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.


45
46
47
# File 'lib/rubygems/basic_specification.rb', line 45

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


185
186
187
# File 'lib/rubygems/basic_specification.rb', line 185

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)

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

def gems_dir
  raise NotImplementedError
end

#internal_initObject

:nodoc:


197
198
199
200
201
202
# File 'lib/rubygems/basic_specification.rb', line 197

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.


277
278
279
280
281
282
283
284
285
286
287
288
289
# File 'lib/rubygems/basic_specification.rb', line 277

def lib_dirs_glob
  dirs = if self.raw_require_paths
           if self.raw_require_paths.size > 1 then
             "{#{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.untaint
end

#matches_for_glob(glob) ⇒ Object

Return all files in this gem that match for glob.


266
267
268
269
270
271
# File 'lib/rubygems/basic_specification.rb', line 266

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.untaint } # FIX our tests are broken, run w/ SAFE=1
end

#nameObject

Name of the gem

Raises:

  • (NotImplementedError)

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

def name
  raise NotImplementedError
end

#platformObject

Platform of the gem

Raises:

  • (NotImplementedError)

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

def platform
  raise NotImplementedError
end

#raw_require_pathsObject

:nodoc:

Raises:

  • (NotImplementedError)

218
219
220
# File 'lib/rubygems/basic_specification.rb', line 218

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

239
240
241
242
243
# File 'lib/rubygems/basic_specification.rb', line 239

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.


249
250
251
252
253
254
255
256
257
258
259
260
261
# File 'lib/rubygems/basic_specification.rb', line 249

def source_paths
  paths = raw_require_paths.dup

  if have_extensions? then
    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.

Raises:

  • (NotImplementedError)

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

def stubbed?
  raise NotImplementedError
end

#thisObject


313
# File 'lib/rubygems/basic_specification.rb', line 313

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.


163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
# File 'lib/rubygems/basic_specification.rb', line 163

def to_fullpath path
  if activated? then
    @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

#to_specObject

Return a Gem::Specification from this gem

Raises:

  • (NotImplementedError)

294
295
296
# File 'lib/rubygems/basic_specification.rb', line 294

def to_spec
  raise NotImplementedError
end

#versionObject

Version of the gem

Raises:

  • (NotImplementedError)

301
302
303
# File 'lib/rubygems/basic_specification.rb', line 301

def version
  raise NotImplementedError
end