Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://www.rubydoc.info/github/rubygems/rubygems/Gem/BasicSpecification below:

BasicSpecification – Documentation for rubygems/rubygems (master) – RubyDoc.info

Inherits:

Object

• Object
• Gem::BasicSpecification

show all

Extended by:

Deprecate

Defined in:

lib/rubygems/basic_specification.rb

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

• #base_dir ⇒ Object

  Returns the full path to the base gem directory.

• #extension_dir ⇒ Object

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

• #full_gem_path ⇒ Object

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

• #ignored ⇒ Object writeonly

  Is this specification ignored for activation purposes?.

• #loaded_from ⇒ Object

  The path this gemspec was loaded from.

• .default_specifications_dir ⇒ Object

• #activated? ⇒ Boolean

  True when the gem has been activated.

• #base_dir_priority(gem_path) ⇒ Object

  Gems higher up in gem_path take precedence.

• #contains_requirable_file?(file) ⇒ Boolean

  Return true if this spec can require file.

• #datadir ⇒ Object

  The path to the data directory for this gem.

• #default_gem? ⇒ Boolean
• #default_gem_priority ⇒ Object

  Regular gems take precedence over default gems.

• #extensions_dir ⇒ Object

  Returns path to the extensions directory.

• #full_name ⇒ Object

  Returns the full name (name-version) of this Gem.

• #full_name_with_location ⇒ Object

  Returns the full name of this Gem (see ‘Gem::BasicSpecification#full_name`).

• #full_require_paths ⇒ Object

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

• #gem_build_complete_path ⇒ Object

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

• #gem_dir ⇒ Object

  Returns the full path to this spec’s gem directory.

• #gems_dir ⇒ Object

  Returns the full path to the gems directory containing this spec’s gem directory.

• #ignored? ⇒ Boolean

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

• #initialize ⇒ BasicSpecification constructor

  A new instance of BasicSpecification.

• #installable_on_platform?(target_platform) ⇒ Boolean

  :nodoc:.

• #internal_init ⇒ Object

  :nodoc:.

• #lib_dirs_glob ⇒ Object

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

• #matches_for_glob(glob) ⇒ Object

  Return all files in this gem that match for glob.

• #name ⇒ Object

  Name of the gem.

• #platform ⇒ Object

  Platform of the gem.

• #plugins ⇒ Object

  Returns the list of plugins in this spec.

• #raw_require_paths ⇒ Object

  :nodoc:.

• #require_paths ⇒ Object

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

• #source_paths ⇒ Object

  Returns the paths to the source files for use with analysis and documentation tools.

• #stubbed? ⇒ Boolean

  Whether this specification is stubbed - i.e.

• #this ⇒ Object
• #to_fullpath(path) ⇒ Object

  Full path of the target library file.

• #to_spec ⇒ Object

  Return a Gem::Specification from this gem.

• #version ⇒ Object

  Version of the gem.

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

Returns a new instance of BasicSpecification.

33
34
35

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

def initialize
  internal_init
end

Returns the full path to the base gem directory.

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

66
67
68

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

def base_dir
  raise NotImplementedError
end

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

123
124
125

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

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

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

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

147
148
149

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

def full_gem_path
  @full_gem_path ||= find_full_gem_path
end

Is this specification ignored for activation purposes?

21
22
23

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

def ignored=(value)
  @ignored = value
end

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

True when the gem has been activated

57
58
59

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

def activated?
  raise NotImplementedError
end

Gems higher up in gem_path take precedence

116
117
118

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

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

Return true if this spec can require file.

73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

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

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

The path to the data directory for this gem.

197
198
199
200

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

def datadir
    File.expand_path(File.join(gems_dir, full_name, "data", name))
end

101
102
103
104

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

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

Regular gems take precedence over default gems

109
110
111

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

def default_gem_priority
  default_gem? ? 1 : -1
end

Returns path to the extensions directory.

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.

156
157
158
159
160
161
162

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

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

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.

169
170
171
172
173
174
175

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

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

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

181
182
183
184
185
186
187
188
189
190
191
192

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

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

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   File.join extension_dir, "gem.build_complete"
end

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.

226
227
228

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

def gem_dir
  @gem_dir ||= find_full_gem_path
end

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

234
235
236

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

def gems_dir
  raise NotImplementedError
end

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

95
96
97
98
99

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

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

  @ignored = missing_extensions?
end

259
260
261
262
263
264

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

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

  false
end

238
239
240
241
242
243

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

def internal_init   @extension_dir = nil
  @full_gem_path = nil
  @gem_dir = nil
  @ignored = nil
end

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

331
332
333
334
335
336
337
338
339
340
341
342
343

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

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"   end

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

Return all files in this gem that match for glob.

314
315
316
317
318

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

def matches_for_glob(glob)   glob = File.join(lib_dirs_glob, glob)

  Dir[glob]
end

248
249
250

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

def name
  raise NotImplementedError
end

255
256
257

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

def platform
  raise NotImplementedError
end

Returns the list of plugins in this spec.

323
324
325

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

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

266
267
268

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

def raw_require_paths   raise NotImplementedError
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:

spec.require_path = '.'

287
288
289
290
291

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

def require_paths
  return raw_require_paths unless have_extensions?

  [extension_dir].concat raw_require_paths
end

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

297
298
299
300
301
302
303
304
305
306
307
308
309

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

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

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.

363
364
365

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

def stubbed?
  raise NotImplementedError
end

367
368
369

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

def this
  self
end

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

206
207
208
209
210
211
212
213
214
215
216
217
218

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

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

Return a Gem::Specification from this gem

348
349
350

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

def to_spec
  raise NotImplementedError
end

355
356
357

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

def version
  raise NotImplementedError
end

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4