The Specification class contains the information for a Gem. Typically defined in a .gemspec file or a Rakefile, and looks like this:
Gem::Specification.new do |s| s.name = 'example' s.version = '0.1.0' s.summary = "This is an example!" s.description = "Much longer explanation of the example!" s.authors = ["Ruby Coder"] s.email = 'rubycoder@example.com' s.files = ["lib/example.rb"] s.homepage = 'https://rubygems.org/gems/example' end
Starting in RubyGems 2.0, a Specification can hold arbitrary metadata. See metadata for restrictions on the format and size of metadata items you may add to a specification.
The specification version applied to any new Specification instances created. This should be bumped whenever something in the spec format changes.
Specification Version History:
spec ruby ver ver yyyy-mm-dd description -1 <0.8.0 pre-spec-version-history 1 0.8.0 2004-08-01 Deprecated "test_suite_file" for "test_files" "test_file=x" is a shortcut for "test_files=[x]" 2 0.9.5 2007-10-01 Added "required_rubygems_version" Now forward-compatible with future versions 3 1.3.2 2009-01-03 Added Fixnum validation to specification_version 4 1.9.0 2011-06-07 Added metadata
The version number of a specification that does not specify one (i.e. RubyGems 0.7 or earlier).
An informal list of changes to the specification. The highest-valued key should be equal to the CURRENT_SPECIFICATION_VERSION.
The path in the gem for executable scripts. Usually 'bin'
Usage:
spec.bindir = 'bin'
The certificate chain used to sign this gem. See Gem::Security for details.
A long description of this gem
The description should be more detailed than the summary.
Usage:
spec.description = <<-EOF Rake is a Make-like program implemented in Ruby. Tasks and dependencies are specified in standard Ruby syntax. EOF
A contact email address (or addresses) for this gem
Usage:
spec.email = 'john.jones@example.com' spec.email = ['jack@example.com', 'jill@example.com']
The URL of this gem's home page
Usage:
spec.homepage = 'http://rake.rubyforge.org'
:attr_accessor: metadata
The metadata holds extra data for this gem that may be useful to other consumers and is settable by gem authors without requiring an update to the rubygems software.
Metadata items have the following restrictions:
The metadata must be a Hash object
All keys and values must be Strings
Keys can be a maximum of 128 bytes and values can be a maximum of 1024 bytes
All strings must be UTF-8, no binary data is allowed
To add metadata for the location of a issue tracker:
s.metadata = { "issue_tracker" => "https://example/issues" }
A message that gets displayed after the gem is installed.
Usage:
spec.post_install_message = "Thanks for installing!"
The key used to sign this gem. See Gem::Security for details.
Adds a development dependency named gem
with
requirements
to this gem.
Usage:
spec.add_development_dependency 'example', '~> 1.1', '>= 1.1.4'
Development dependencies aren't installed by default and aren't activated when a gem is required.
# File lib/rubygems/specification.rb, line 421 def add_development_dependency(gem, *requirements) add_dependency_with_type(gem, :development, *requirements) end
Adds a runtime dependency named gem
with
requirements
to this gem.
Usage:
spec.add_runtime_dependency 'example', '~> 1.1', '>= 1.1.4'
# File lib/rubygems/specification.rb, line 432 def add_runtime_dependency(gem, *requirements) add_dependency_with_type(gem, :runtime, *requirements) end
Executables included in the gem.
For example, the rake gem has rake as an executable. You don’t specify the full path (as in bin/rake); all application-style files are expected to be found in bindir. These files must be executable Ruby files. Files that use bash or other interpreters will not work.
Usage:
spec.executables << 'rake'
# File lib/rubygems/specification.rb, line 470 def executables @executables ||= [] end
Extensions to build when installing the gem, specifically the paths to extconf.rb-style files used to compile extensions.
These files will be run when the gem is installed, causing the C (or whatever) code to be compiled on the user’s machine.
Usage:
spec.extensions << 'ext/rmagic/extconf.rb'
See Gem::Ext::Builder for information about writing extensions for gems.
# File lib/rubygems/specification.rb, line 487 def extensions @extensions ||= [] end
Extra files to add to RDoc such as README or doc/examples.txt
When the user elects to generate the RDoc documentation for a gem (typically at install time), all the library files are sent to RDoc for processing. This option allows you to have some non-code files included for a more complete set of documentation.
Usage:
spec.extra_rdoc_files = ['README', 'doc/user-guide.txt']
# File lib/rubygems/specification.rb, line 503 def extra_rdoc_files @extra_rdoc_files ||= [] end
The license for this gem.
The license must be a short name, no more than 64 characters.
This should just be the name of your license. The full text of the license should be inside of the gem when you build it.
See opensource.org/licenses/alphabetical for a list of licenses and their abbreviations (or short names).
You can set multiple licenses with licenses=
Usage:
spec.license = 'MIT'
# File lib/rubygems/specification.rb, line 523 def license=o self.licenses = [o] end
The license(s) for the library.
Each license must be a short name, no more than 64 characters.
This should just be the name of your license. The full text of the license should be inside of the gem when you build it.
See license= for more discussion
Usage:
spec.licenses = ['MIT', 'GPL-2']
# File lib/rubygems/specification.rb, line 540 def licenses= licenses @licenses = Array licenses end
Specifies the rdoc options to be used when generating API documentation.
Usage:
spec.rdoc_options << '--title' << 'Rake -- Ruby Make' << '--main' << 'README' << '--line-numbers'
# File lib/rubygems/specification.rb, line 553 def rdoc_options @rdoc_options ||= [] end
The version of Ruby required by this gem. The ruby version can be specified to the patch-level:
$ ruby -v -e 'p Gem.ruby_version' ruby 2.0.0p247 (2013-06-27 revision 41674) [x86_64-darwin12.4.0] #<Gem::Version "2.0.0.247">
Usage:
# This gem will work with 1.8.6 or greater... spec.required_ruby_version = '>= 1.8.6' # Only with ruby 2.0.x spec.required_ruby_version = '~> 2.0'
# File lib/rubygems/specification.rb, line 573 def required_ruby_version= req @required_ruby_version = Gem::Requirement.create req end
Lists the external (to RubyGems) requirements that must be met for this gem to work. It's simply information for the user.
Usage:
spec.requirements << 'libmagick, v6.0' spec.requirements << 'A good graphics card'
# File lib/rubygems/specification.rb, line 586 def requirements @requirements ||= [] end
A collection of unit test files. They will be loaded as unit tests when the user requests a gem to be unit tested.
Usage:
spec.test_files = Dir.glob('test/tc_*.rb') spec.test_files = ['tests/test-suite.rb']
# File lib/rubygems/specification.rb, line 598 def test_files= files @test_files = Array files end
This gem's name.
Usage:
spec.name = 'rake'
Paths in the gem to add to $LOAD_PATH
when this gem is
activated.
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 = '.'
The version of RubyGems used to create this gem.
Do not set this, it is set automatically when the gem is packaged.
A short summary of this gem's description. Displayed in `gem list -d`.
The description should be more detailed than the summary.
Usage:
spec.summary = "This is a small summary of my gem"
This gem's version.
The version string can contain numbers and periods, such as
1.0.0
. A gem is a 'prerelease' gem if the version has
a letter in it, such as 1.0.0.pre
.
Usage:
spec.version = '0.4.1'
Files included in this gem. You cannot append to this accessor, you must assign to it.
Only add files you can require to this list, not directories, etc.
Directories are automatically stripped from this list when building a gem, other non-files cause an error.
Usage:
require 'rake' spec.files = FileList['lib .rb', 'bin/*', '[A-Z]*', 'test/ *'].to_a # or without Rake... spec.files = Dir['lib/ *.rb'] + Dir['bin/*'] spec.files += Dir['[A-Z]*'] + Dir['test/**/*'] spec.files.reject! { |fn| fn.include? "CVS" }
# File lib/rubygems/specification.rb, line 313 def files # DO NOT CHANGE TO ||= ! This is not a normal accessor. (yes, it sucks) # DOC: Why isn't it normal? Why does it suck? How can we fix this? @files = [@files, @test_files, add_bindir(@executables), @extra_rdoc_files, @extensions, ].flatten.uniq.compact end
The platform this gem runs on.
This is usually Gem::Platform::RUBY or Gem::Platform::CURRENT.
Most gems contain pure Ruby code; they should simply leave the default value in place. Some gems contain C (or other) code to be compiled into a Ruby “extension”. The should leave the default value in place unless their code will only compile on a certain type of system. Some gems consist of pre-compiled code (“binary gems”). It's especially important that they set the platform attribute appropriately. A shortcut is to set the platform to Gem::Platform::CURRENT, which will cause the gem builder to set the platform to the appropriate value for the system on which the build is being performed.
If this attribute is set to a non-default value, it will be included in the filename of the gem when it is built such as: nokogiri-1.6.0-x86-mingw32.gem
Usage:
spec.platform = Gem::Platform.local
# File lib/rubygems/specification.rb, line 257 def platform= platform if @original_platform.nil? or @original_platform == Gem::Platform::RUBY then @original_platform = platform end case platform when Gem::Platform::CURRENT then @new_platform = Gem::Platform.local @original_platform = @new_platform.to_s when Gem::Platform then @new_platform = platform # legacy constants when nil, Gem::Platform::RUBY then @new_platform = Gem::Platform::RUBY when 'mswin32' then # was Gem::Platform::WIN32 @new_platform = Gem::Platform.new 'x86-mswin32' when 'i586-linux' then # was Gem::Platform::LINUX_586 @new_platform = Gem::Platform.new 'x86-linux' when 'powerpc-darwin' then # was Gem::Platform::DARWIN @new_platform = Gem::Platform.new 'ppc-darwin' else @new_platform = Gem::Platform.new platform end @platform = @new_platform.to_s invalidate_memoized_attributes @new_platform end
True when this gemspec has been activated. This attribute is not persisted.
True when this gemspec has been activated. This attribute is not persisted.
Sets the default executable for this gem.
Deprecated: You must now specify the executable name to Gem.bin_path.
The version of Ruby required by this gem
The RubyGems version required by this gem
The rubyforge project this gem lives under. i.e. RubyGems' #rubyforge_project is “rubygems”.
This option is deprecated.
The Gem::Specification version of this gemspec.
Do not set this, it is set automatically when the gem is packaged.
Specification constructor. Assigns the
default values to the attributes and yields itself for further
initialization. Optionally takes name
and
version
.
# File lib/rubygems/specification.rb, line 1750 def initialize name = nil, version = nil @loaded = false @activated = false self.loaded_from = nil @original_platform = nil @@nil_attributes.each do |key| instance_variable_set "@#{key}", nil end @@non_nil_attributes.each do |key| default = default_value(key) value = Dupable[key] ? default.dup : default instance_variable_set "@#{key}", value end @new_platform = Gem::Platform::RUBY self.name = name if name self.version = version if version yield self if block_given? end
Duplicates array_attributes from other_spec
so state isn't
shared.
# File lib/rubygems/specification.rb, line 1777 def initialize_copy other_spec self.class.array_attributes.each do |name| name = :"@#{name}" next unless other_spec.instance_variable_defined? name begin val = other_spec.instance_variable_get(name) if val then instance_variable_set name, val.dup elsif Gem.configuration.really_verbose warn "WARNING: #{full_name} has an invalid nil value for #{name}" end rescue TypeError e = Gem::FormatException.new "#{full_name} has an invalid value for #{name}" e.file_path = loaded_from raise e end end end
# File lib/rubygems/specification.rb, line 1810 def inspect if $DEBUG super else "#<#{self.class}:0x#{__id__.to_s(16)} #{full_name}>" end end
Returns a string usable in Dir.glob to match all requirable paths for this spec.
# File lib/rubygems/specification.rb, line 1822 def lib_dirs_glob dirs = if self.require_paths.size > 1 then "{#{self.require_paths.join(',')}}" else self.require_paths.first end "#{self.full_gem_path}/#{dirs}" end
Files in the Gem under one of the #require_paths
# File lib/rubygems/specification.rb, line 1835 def lib_files @files.select do |file| require_paths.any? do |path| file.start_with? path end end end
Singular accessor for licenses
# File lib/rubygems/specification.rb, line 1846 def license val = licenses and val.first end
Plural accessor for setting licenses
See license= for details
# File lib/rubygems/specification.rb, line 1855 def licenses @licenses ||= [] end
Sets the #rubygems_version to the current RubyGems version.
# File lib/rubygems/specification.rb, line 1875 def mark_version @rubygems_version = Gem::VERSION end
Return all files in this gem that match for glob
.
# File lib/rubygems/specification.rb, line 1882 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
Return a NameTuple that represents this Specification
# File lib/rubygems/specification.rb, line 1924 def name_tuple Gem::NameTuple.new name, version, original_platform end
Normalize the list of files so that:
All file lists have redundancies removed.
Files referenced in the #extra_rdoc_files are included in the package file list.
# File lib/rubygems/specification.rb, line 1907 def normalize if defined?(@extra_rdoc_files) and @extra_rdoc_files then @extra_rdoc_files.uniq! @files ||= [] @files.concat(@extra_rdoc_files) end @files = @files.uniq if @files @extensions = @extensions.uniq if @extensions @test_files = @test_files.uniq if @test_files @executables = @executables.uniq if @executables @extra_rdoc_files = @extra_rdoc_files.uniq if @extra_rdoc_files end
The platform this gem runs on. See Gem::Platform for details.
# File lib/rubygems/specification.rb, line 1950 def platform @new_platform ||= Gem::Platform::RUBY end
Check the spec for possible conflicts and freak out if there are any.
# File lib/rubygems/specification.rb, line 1983 def raise_if_conflicts other = Gem.loaded_specs[self.name] if other and self.version != other.version then # This gem is already loaded. If the currently loaded gem is not in the # list of candidate gems, then we have a version conflict. msg = "can't activate #{full_name}, already activated #{other.full_name}" e = Gem::LoadError.new msg e.name = self.name # TODO: e.requirement = dep.requirement raise e end conf = self.conflicts unless conf.empty? then y = conf.map { |act,con| "#{act.full_name} conflicts with #{con.join(", ")}" }.join ", " # TODO: improve message by saying who activated `con` raise Gem::LoadError, "Unable to activate #{self.full_name}, because #{y}" end end
Sets #rdoc_options
to value
, ensuring it is an array. Don't use this, push
onto the array instead.
# File lib/rubygems/specification.rb, line 2016 def rdoc_options= options # TODO: warn about setting instead of pushing @rdoc_options = Array options end
Singular accessor for require_paths
# File lib/rubygems/specification.rb, line 2024 def require_path val = require_paths and val.first end
Singular accessor for require_paths
# File lib/rubygems/specification.rb, line 2031 def require_path= path self.require_paths = [path] end
The RubyGems version required by this gem
# File lib/rubygems/specification.rb, line 2038 def required_rubygems_version= req @required_rubygems_version = Gem::Requirement.create req end
Set requirements to req
, ensuring it is an array. Don't
use this, push onto the array instead.
# File lib/rubygems/specification.rb, line 2046 def requirements= req # TODO: warn about setting instead of pushing @requirements = Array req end
Reset nil attributes to their default values to make the spec valid
# File lib/rubygems/specification.rb, line 2592 def reset_nil_attributes_to_default nil_attributes = self.class.non_nil_attributes.find_all do |name| !instance_variable_defined?("@#{name}") || instance_variable_get("@#{name}").nil? end nil_attributes.each do |attribute| default = self.default_value attribute value = case default when Time, Numeric, Symbol, true, false, nil then default else default.dup end instance_variable_set "@#{attribute}", value end @installed_by_version ||= nil end
Returns the full path to this spec's ri directory.
# File lib/rubygems/specification.rb, line 2058 def ri_dir @ri_dir ||= File.join base_dir, 'ri', full_name end
List of dependencies that will automatically be activated at runtime.
# File lib/rubygems/specification.rb, line 2091 def runtime_dependencies dependencies.select { |d| d.type == :runtime } end
Checks if this specification meets the requirement of
dependency
.
# File lib/rubygems/specification.rb, line 2107 def satisfies_requirement? dependency return @name == dependency.name && dependency.requirement.satisfied_by?(@version) end
Returns an object you can use to sort specifications in sort_by.
# File lib/rubygems/specification.rb, line 2115 def sort_obj [@name, @version, @new_platform == Gem::Platform::RUBY ? -1 : 1] end
Returns the full path to the directory containing this spec's gemspec file. eg: /usr/local/lib/ruby/gems/1.8/specifications
# File lib/rubygems/specification.rb, line 2130 def spec_dir @spec_dir ||= File.join base_dir, "specifications" end
Returns the full path to this spec's gemspec file. eg: /usr/local/lib/ruby/gems/1.8/specifications/mygem-1.0.gemspec
# File lib/rubygems/specification.rb, line 2138 def spec_file @spec_file ||= File.join spec_dir, "#{full_name}.gemspec" end
The default name of the gemspec. See also file_name
spec.spec_name # => "example-1.0.gemspec"
# File lib/rubygems/specification.rb, line 2147 def spec_name "#{full_name}.gemspec" end
A short summary of this gem's description.
# File lib/rubygems/specification.rb, line 2154 def summary= str @summary = str.to_s.strip. gsub(/(\w-)\n[ \t]*(\w)/, '\1\2').gsub(/\n[ \t]*/, " ") # so. weird. end
Singular accessor for test_files
# File lib/rubygems/specification.rb, line 2162 def test_file val = test_files and val.first end
Singular mutator for test_files
# File lib/rubygems/specification.rb, line 2169 def test_file= file self.test_files = [file] end
Test files included in this gem. You cannot append to this accessor, you must assign to it.
# File lib/rubygems/specification.rb, line 2177 def test_files # Handle the possibility that we have @test_suite_file but not # @test_files. This will happen when an old gem is loaded via # YAML. if defined? @test_suite_file then @test_files = [@test_suite_file].flatten @test_suite_file = nil end if defined?(@test_files) and @test_files then @test_files else @test_files = [] end end
Returns a Ruby code representation of this specification, such that it can be eval'ed and reconstruct the same specification later. Attributes that still have their default values are omitted.
REFACTOR: This, plus stuff like ruby_code and pretty_print, should probably be extracted out into some sort of separate class. SRP, do you speak it!??!
# File lib/rubygems/specification.rb, line 2201 def to_ruby mark_version result = [] result << "# -*- encoding: utf-8 -*-" result << "#{Gem::StubSpecification::PREFIX}#{name} #{version} #{platform} #{require_paths.join("\0")}" result << nil result << "Gem::Specification.new do |s|" result << " s.name = #{ruby_code name}" result << " s.version = #{ruby_code version}" unless platform.nil? or platform == Gem::Platform::RUBY then result << " s.platform = #{ruby_code original_platform}" end result << "" result << " s.required_rubygems_version = #{ruby_code required_rubygems_version} if s.respond_to? :required_rubygems_version=" if metadata and !metadata.empty? result << " s.metadata = #{ruby_code metadata} if s.respond_to? :metadata=" end handled = [ :dependencies, :name, :platform, :required_rubygems_version, :specification_version, :version, :has_rdoc, :default_executable, :metadata ] @@attributes.each do |attr_name| next if handled.include? attr_name current_value = self.send(attr_name) if current_value != default_value(attr_name) or self.class.required_attribute? attr_name then result << " s.#{attr_name} = #{ruby_code current_value}" end end unless dependencies.empty? then result << nil result << " if s.respond_to? :specification_version then" result << " s.specification_version = #{specification_version}" result << nil result << " if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then" dependencies.each do |dep| req = dep.requirements_list.inspect dep.instance_variable_set :@type, :runtime if dep.type.nil? # HACK result << " s.add_#{dep.type}_dependency(%q<#{dep.name}>, #{req})" end result << " else" dependencies.each do |dep| version_reqs_param = dep.requirements_list.inspect result << " s.add_dependency(%q<#{dep.name}>, #{version_reqs_param})" end result << ' end' result << " else" dependencies.each do |dep| version_reqs_param = dep.requirements_list.inspect result << " s.add_dependency(%q<#{dep.name}>, #{version_reqs_param})" end result << " end" end result << "end" result << nil result.join "\n" end
Returns a Ruby lighter-weight code representation of this specification, used for indexing only.
See to_ruby.
# File lib/rubygems/specification.rb, line 2285 def to_ruby_for_cache for_cache.to_ruby end
Returns self
# File lib/rubygems/specification.rb, line 2296 def to_spec self end
Recursively walk dependencies of this spec, executing the
block
for each hop.
# File lib/rubygems/specification.rb, line 2332 def traverse trail = [], &block trail = trail + [self] runtime_dependencies.each do |dep| dep.to_specs.each do |dep_spec| block[self, dep, dep_spec, trail + [dep_spec]] dep_spec.traverse(trail, &block) unless trail.map(&:name).include? dep_spec.name end end end
Checks that the specification contains all required fields, and does a very basic sanity check.
Raises InvalidSpecificationException if the spec does not pass the checks..
# File lib/rubygems/specification.rb, line 2350 def validate packaging = true require 'rubygems/user_interaction' extend Gem::UserInteraction normalize nil_attributes = self.class.non_nil_attributes.find_all do |name| instance_variable_get("@#{name}").nil? end unless nil_attributes.empty? then raise Gem::InvalidSpecificationException, "#{nil_attributes.join ', '} must not be nil" end if packaging and rubygems_version != Gem::VERSION then raise Gem::InvalidSpecificationException, "expected RubyGems version #{Gem::VERSION}, was #{rubygems_version}" end @@required_attributes.each do |symbol| unless self.send symbol then raise Gem::InvalidSpecificationException, "missing value for attribute #{symbol}" end end if !name.is_a?(String) then raise Gem::InvalidSpecificationException, "invalid value for attribute name: \"#{name.inspect}\" must be a string" elsif name !~ /[a-zA-Z]/ then raise Gem::InvalidSpecificationException, "invalid value for attribute name: #{name.dump} must include at least one letter" elsif name !~ VALID_NAME_PATTERN then raise Gem::InvalidSpecificationException, "invalid value for attribute name: #{name.dump} can only include letters, numbers, dashes, and underscores" end if require_paths.empty? then raise Gem::InvalidSpecificationException, 'specification must have at least one require_path' end @files.delete_if { |x| File.directory?(x) } @test_files.delete_if { |x| File.directory?(x) } @executables.delete_if { |x| File.directory?(File.join(@bindir, x)) } @extra_rdoc_files.delete_if { |x| File.directory?(x) } @extensions.delete_if { |x| File.directory?(x) } non_files = files.reject { |x| File.file?(x) } unless not packaging or non_files.empty? then raise Gem::InvalidSpecificationException, "[\"#{non_files.join "\", \""}\"] are not files" end unless specification_version.is_a?(Fixnum) raise Gem::InvalidSpecificationException, 'specification_version must be a Fixnum (did you mean version?)' end case platform when Gem::Platform, Gem::Platform::RUBY then # ok else raise Gem::InvalidSpecificationException, "invalid platform #{platform.inspect}, see Gem::Platform" end self.class.array_attributes.each do |field| val = self.send field klass = case field when :dependencies Gem::Dependency else String end unless Array === val and val.all? { |x| x.kind_of?(klass) } then raise(Gem::InvalidSpecificationException, "#{field} must be an Array of #{klass}") end end # FIX: uhhhh single element array.each? [:authors].each do |field| val = self.send field raise Gem::InvalidSpecificationException, "#{field} may not be empty" if val.empty? end unless Hash === metadata raise Gem::InvalidSpecificationException, 'metadata must be a hash' end metadata.keys.each do |k| if !k.kind_of?(String) raise Gem::InvalidSpecificationException, 'metadata keys must be a String' end if k.size > 128 raise Gem::InvalidSpecificationException, "metadata key too large (#{k.size} > 128)" end end metadata.values.each do |k| if !k.kind_of?(String) raise Gem::InvalidSpecificationException, 'metadata values must be a String' end if k.size > 1024 raise Gem::InvalidSpecificationException, "metadata value too large (#{k.size} > 1024)" end end licenses.each { |license| if license.length > 64 raise Gem::InvalidSpecificationException, "each license must be 64 characters or less" end } alert_warning "licenses is empty. Use a license abbreviation from: http://opensource.org/licenses/alphabetical " if licenses.empty? validate_permissions # reject lazy developers: # FIX: Doesn't this just evaluate to "FIXME" or "TODO"? lazy = '"FIxxxXME" or "TOxxxDO"'.gsub(/xxx/, '') unless authors.grep(/FI XME|TO DO/).empty? then raise Gem::InvalidSpecificationException, "#{lazy} is not an author" end unless Array(email).grep(/FI XME|TO DO/).empty? then raise Gem::InvalidSpecificationException, "#{lazy} is not an email" end if description =~ /FI XME|TO DO/ then raise Gem::InvalidSpecificationException, "#{lazy} is not a description" end if summary =~ /FI XME|TO DO/ then raise Gem::InvalidSpecificationException, "#{lazy} is not a summary" end if homepage and not homepage.empty? and homepage !~ /\A[a-z][a-z\d+.-]*:/ then raise Gem::InvalidSpecificationException, "\"#{homepage}\" is not a URI" end # Warnings %w[author description email homepage summary].each do |attribute| value = self.send attribute alert_warning "no #{attribute} specified" if value.nil? or value.empty? end if description == summary then alert_warning 'description and summary are identical' end # TODO: raise at some given date alert_warning "deprecated autorequire specified" if autorequire executables.each do |executable| executable_path = File.join(bindir, executable) shebang = File.read(executable_path, 2) == '#!' alert_warning "#{executable_path} is missing #! line" unless shebang end dependencies.each do |dep| prerelease_dep = dep.requirements_list.any? do |req| Gem::Requirement.new(req).prerelease? end alert_warning "prerelease dependency on #{dep} is not recommended" if prerelease_dep end true end
Checks to see if the files to be packaged are world-readable.
# File lib/rubygems/specification.rb, line 2545 def validate_permissions return if Gem.win_platform? files.each do |file| next if File.stat(file).mode & 0444 == 0444 alert_warning "#{file} is not world-readable" end executables.each do |name| exec = File.join @bindir, name next if File.stat(exec).executable? alert_warning "#{exec} is not executable" end end
Set the version to version
, potentially also setting #required_rubygems_version
if version
indicates it is a prerelease.
# File lib/rubygems/specification.rb, line 2565 def version= version @version = Gem::Version.create(version) self.required_rubygems_version = '> 1.3.1' if @version.prerelease? invalidate_memoized_attributes return @version end
Expire memoized instance variables that can incorrectly generate, replace or miss files due changes in certain attributes used to compute them.
# File lib/rubygems/specification.rb, line 1803 def invalidate_memoized_attributes @full_name = nil @cache_file = nil end
Return a string containing a Ruby code representation of the given object.
# File lib/rubygems/specification.rb, line 2066 def ruby_code(obj) case obj when String then obj.dump when Array then '[' + obj.map { |x| ruby_code x }.join(", ") + ']' when Hash then seg = obj.keys.sort.map { |k| "#{k.to_s.dump} => #{obj[k].to_s.dump}" } "{ #{seg.join(', ')} }" when Gem::Version then obj.to_s.dump when Date then obj.strftime('%Y-%m-%d').dump when Time then obj.strftime('%Y-%m-%d').dump when Numeric then obj.inspect when true, false, nil then obj.inspect when Gem::Platform then "Gem::Platform.new(#{obj.to_a.inspect})" when Gem::Requirement then list = obj.as_list "Gem::Requirement.new(#{ruby_code(list.size == 1 ? obj.to_s : list)})" else raise Gem::Exception, "ruby_code case not handled: #{obj.class}" end end
True if this gem has the same attributes as other
.
# File lib/rubygems/specification.rb, line 2098 def same_attributes? spec @@attributes.all? { |name, default| self.send(name) == spec.send(name) } end