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

#initialize ⇒ BasicSpecification

Returns a new instance of BasicSpecification.



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

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) 


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

def base_dir
  raise NotImplementedError
end

#extension_dir ⇒ Object

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



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

def extension_dir
  @extension_dir ||= File.expand_path(File.join(extensions_dir, full_name)).tap(&Gem::UNTAINT)
end

#full_gem_path ⇒ Object

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



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

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?



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

def ignored=(value)
  @ignored = value
end

#loaded_from ⇒ Object

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



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

def loaded_from
  @loaded_from
end

Class Method Details

.default_specifications_dir ⇒ Object 



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

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) 


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

def activated?
  raise NotImplementedError
end

#contains_requirable_file?(file) ⇒ Boolean

Return true if this spec can require file.

Returns:

  • (Boolean) 


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/rubygems/basic_specification.rb', line 72

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

#datadir ⇒ Object

The path to the data directory for this gem.



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

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

#default_gem? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#extensions_dir ⇒ Object

Returns path to the extensions directory.



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

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.



133
134
135
136
137
138
139
 
# File 'lib/rubygems/basic_specification.rb', line 133

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

#full_require_paths ⇒ Object

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



145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/rubygems/basic_specification.rb', line 145

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

#gem_build_complete_path ⇒ Object

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



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

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



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

def gem_dir
  @gem_dir ||= File.expand_path File.join(gems_dir, full_name)
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) 


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

def gems_dir
  raise NotImplementedError
end

#internal_init ⇒ Object

:nodoc:



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

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.



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

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

#matches_for_glob(glob) ⇒ Object

Return all files in this gem that match for glob.



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

def matches_for_glob(glob) # TODO: rename?
  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

#name ⇒ Object

Name of the gem

Raises:

  • (NotImplementedError) 


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

def name
  raise NotImplementedError
end

#platform ⇒ Object

Platform of the gem

Raises:

  • (NotImplementedError) 


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

def platform
  raise NotImplementedError
end

#plugins ⇒ Object

Returns the list of plugins in this spec.



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

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

#raw_require_paths ⇒ Object

:nodoc:

Raises:

  • (NotImplementedError) 


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

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



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

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.



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

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) 


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

def stubbed?
  raise NotImplementedError
end

#this ⇒ Object 



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

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.



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

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

#to_spec ⇒ Object

Return a Gem::Specification from this gem

Raises:

  • (NotImplementedError) 


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

def to_spec
  raise NotImplementedError
end

#version ⇒ Object

Version of the gem

Raises:

  • (NotImplementedError) 


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

def version
  raise NotImplementedError
end