123456789_123456789_123456789_123456789_123456789_

Class: Gem::BasicSpecification

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Subclasses:
Specification, StubSpecification
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Deprecate
Inherits: Object
Defined in: lib/rubygems/basic_specification.rb

Overview

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

Class Method Summary

Deprecate - Extended

deprecate

Simple deprecation method that deprecates #name by wrapping it up in a dummy method.
rubygems_deprecate

Simple deprecation method that deprecates #name by wrapping it up in a dummy method.
rubygems_deprecate_command

Deprecation method to deprecate Rubygems commands.
skip_during

Temporarily turn off warnings.

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new ⇒ BasicSpecification

[ GitHub ] 

  


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



def initialize
  internal_init
end


  







Class Method Details



  

    .default_specifications_dir  
  

  [ GitHub ]


  

  


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



def self.default_specifications_dir
  Gem.default_specifications_dir
end


  







Instance Attribute Details



  

    #activated?  ⇒ Boolean  (readonly)
  



  

    

True when the gem has been activated


  





  
Raises:


    
  
  • 
    (NotImplementedError)
  
    • 





  [ GitHub ]


  

  


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



def activated?
  raise NotImplementedError
end


  








  

    #base_dir   (rw)
  



  

    

Returns the full path to the base gem directory.



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


  





  
Raises:


    
  
  • 
    (NotImplementedError)
  
    • 





  [ GitHub ]


  

  


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



def base_dir
  raise NotImplementedError
end


  








  

    #base_dir=(value)   (rw)
  

  

    This method is for internal use only.
  



  

    

Allows installation of extensions for git: gems.


  



  [ GitHub ]


  

  


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



attr_writer :base_dir # :nodoc:


  








  

    #default_gem?  ⇒ Boolean  (readonly)
  

  [ GitHub ]


  

  


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



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


  








  

    #extension_dir   (rw)
  



  

    

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


  



  [ GitHub ]


  

  


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



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


  








  

    #extension_dir=(value)   (rw)
  

  

    This method is for internal use only.
  



  

    

Sets the directory where extensions for this gem will be installed.


  



  [ GitHub ]


  

  


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



attr_writer :extension_dir # :nodoc:


  








  

    #full_gem_path   (rw)
  



  

    

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


  



  [ GitHub ]


  

  


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



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


  








  

    #full_gem_path=(value)   (rw)
  

  

    This method is for internal use only.
  



  

    

Allows correct activation of git: and path: gems.


  



  [ GitHub ]


  

  


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



attr_writer :full_gem_path # :nodoc:


  








  

    #have_extensions?  ⇒ Boolean  (readonly, private)
  

  [ GitHub ]


  

  


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



def have_extensions?
  !extensions.empty?
end


  








  

    #ignored=(value)   (rw)
  

  

    This method is for internal use only.
  



  

    

Is this specification ignored for activation purposes?


  



  [ GitHub ]


  

  


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



attr_writer :ignored # :nodoc:


  








  

    #ignored?  ⇒ Boolean  (rw)
  



  

    

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


  





  


  [ GitHub ]


  

  


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



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

  @ignored = missing_extensions?
end


  








  

    #loaded_from   (rw)
  



  

    

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


  



  [ GitHub ]


  

  


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



attr_accessor :loaded_from


  








  

    #stubbed?  ⇒ Boolean  (readonly)
  



  

    

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)
  
    • 





  [ GitHub ]


  

  


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



def stubbed?
  raise NotImplementedError
end


  







Instance Method Details



  

    #base_dir_priority(gem_path)  
  



  

    

Gems higher up in gem_path take precedence


  



  [ GitHub ]


  

  


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



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


  








  

    #contains_requirable_file?(file)  ⇒ Boolean 
  



  

    

Return true if this spec can require file.


  





  


  [ GitHub ]


  

  


# 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


  








  

    #datadir  
  



  

    

The path to the data directory for this gem.


  



  [ GitHub ]


  

  


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



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_priority  
  



  

    

Regular gems take precedence over default gems


  



  [ GitHub ]


  

  


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



def default_gem_priority
  default_gem? ? 1 : -1
end


  








  

    #extensions_dir  
  



  

    

Returns path to the extensions directory.


  



  [ GitHub ]


  

  


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



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


  








  

    #find_full_gem_path   (private)
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


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



def find_full_gem_path # :nodoc:
  # TODO: also, shouldn't it default to full_name if it hasn't been written?
  File.expand_path File.join(gems_dir, full_name)
end


  








  

    #full_name  
  



  

    

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.


  



  [ GitHub ]


  

  


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



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


  








  

    #full_name_with_location  
  



  

    

Returns the full name of this ::Gem (see #full_name). Information about where the gem is installed is also included if not installed in the default GEM_HOME.


  



  [ GitHub ]


  

  


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



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


  








  

    #full_require_paths  
  



  

    

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


  



  [ GitHub ]


  

  


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



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_path  
  

  

    This method is for internal use only.
  



  

    

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


  



  [ GitHub ]


  

  


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



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


  








  

    #gem_dir  
  



  

    

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


  



  [ GitHub ]


  

  


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



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


  








  

    #gems_dir  
  



  

    

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


  





  
Raises:


    
  
  • 
    (NotImplementedError)
  
    • 





  [ GitHub ]


  

  


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



def gems_dir
  raise NotImplementedError
end


  








  

    #have_file?(file, suffixes)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


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



def have_file?(file, suffixes)
  return true if raw_require_paths.any? do |path|
    base = File.join(gems_dir, full_name, path, file)
    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


  








  

    #internal_init  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


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



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


  








  

    #lib_dirs_glob  
  



  

    

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


  



  [ GitHub ]


  

  


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



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)  
  



  

    

Return all files in this gem that match for glob.


  



  [ GitHub ]


  

  


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



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

  Dir[glob]
end


  








  

    #name  
  



  

    

Name of the gem


  





  
Raises:


    
  
  • 
    (NotImplementedError)
  
    • 





  [ GitHub ]


  

  


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



def name
  raise NotImplementedError
end


  








  

    #platform  
  



  

    

Platform of the gem


  





  
Raises:


    
  
  • 
    (NotImplementedError)
  
    • 





  [ GitHub ]


  

  


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



def platform
  raise NotImplementedError
end


  








  

    #plugins  
  



  

    

Returns the list of plugins in this spec.


  



  [ GitHub ]


  

  


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



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


  








  

    #raw_require_paths  
  

  

    This method is for internal use only.
  



  

    
  





  
Raises:


    
  
  • 
    (NotImplementedError)
  
    • 





  [ GitHub ]


  

  


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



def raw_require_paths # :nodoc:
  raise NotImplementedError
end


  








  

    #require_paths  
  



  

    

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


  



  [ GitHub ]


  

  


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



def require_paths
  return raw_require_paths unless have_extensions?

  [extension_dir].concat raw_require_paths
end


  








  

    #source_paths  
  



  

    

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


  



  [ GitHub ]


  

  


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



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


  








  

    #this  
  

  [ GitHub ]


  

  


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



def this
  self
end


  








  

    #to_fullpath(path)  
  



  

    

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


  



  [ GitHub ]


  

  


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



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_spec  
  



  

    

Return a Specification from this gem


  





  
Raises:


    
  
  • 
    (NotImplementedError)
  
    • 





  [ GitHub ]


  

  


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



def to_spec
  raise NotImplementedError
end


  








  

    #version  
  



  

    

Version of the gem


  





  
Raises:


    
  
  • 
    (NotImplementedError)
  
    • 





  [ GitHub ]


  

  


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



def version
  raise NotImplementedError
end