Class: Gem::Requirement
- Inherits:
-
Object
- Object
- Gem::Requirement
- Defined in:
- lib/rubygems/requirement.rb
Defined Under Namespace
Classes: BadRequirementError
Constant Summary collapse
- OPS =
:nodoc:
{ #:nodoc: "=" => lambda { |v, r| v == r }, "!=" => lambda { |v, r| v != r }, ">" => lambda { |v, r| v > r }, "<" => lambda { |v, r| v < r }, ">=" => lambda { |v, r| v >= r }, "<=" => lambda { |v, r| v <= r }, "~>" => lambda { |v, r| v >= r && v.release < r.bump } }
- PATTERN_RAW =
"\\s*(#{quoted})?\\s*(#{Gem::Version::VERSION_PATTERN})\\s*"
- PATTERN =
/\A#{PATTERN_RAW}\z/
- DefaultRequirement =
[">=", Gem::Version.new(0)]
Instance Attribute Summary collapse
-
#requirements ⇒ Object
readonly
An array of requirement pairs.
Class Method Summary collapse
-
.create(input) ⇒ Object
REFACTOR: There’s no reason that this can’t be unified with .new.
-
.default ⇒ Object
A default “version requirement” can surely only be ‘>= 0’.
-
.parse(obj) ⇒ Object
REFACTOR: Little two element arrays like this have no real semantic value.
Instance Method Summary collapse
-
#==(other) ⇒ Object
DOC: this should probably be :nodoc’d.
-
#as_list ⇒ Object
:nodoc:.
- #encode_with(coder) ⇒ Object
-
#hash ⇒ Object
:nodoc:.
-
#init_with(coder) ⇒ Object
:nodoc:.
-
#initialize(*requirements) ⇒ Requirement
constructor
Constructs a requirement from
requirements
. -
#marshal_dump ⇒ Object
:nodoc:.
-
#marshal_load(array) ⇒ Object
:nodoc:.
-
#none? ⇒ Boolean
FIX: maybe this should be using #default ?.
-
#prerelease? ⇒ Boolean
A requirement is a prerelease if any of the versions inside of it are prereleases.
-
#pretty_print(q) ⇒ Object
:nodoc:.
-
#satisfied_by?(version) ⇒ Boolean
(also: #===, #=~)
True if
version
satisfies this Requirement. -
#specific? ⇒ Boolean
True if the requirement will not always match the latest version.
-
#to_s ⇒ Object
:nodoc:.
- #to_yaml_properties ⇒ Object
-
#yaml_initialize(tag, vals) ⇒ Object
:nodoc:.
Constructor Details
#initialize(*requirements) ⇒ Requirement
Constructs a requirement from requirements
. Requirements can be Strings, Gem::Versions, or Arrays of those. nil
and duplicate requirements are ignored. An empty set of requirements
is the same as ">= 0"
.
112 113 114 115 116 117 118 119 120 121 122 |
# File 'lib/rubygems/requirement.rb', line 112 def initialize *requirements requirements = requirements.flatten requirements.compact! requirements.uniq! if requirements.empty? @requirements = [DefaultRequirement] else @requirements = requirements.map! { |r| self.class.parse r } end end |
Instance Attribute Details
#requirements ⇒ Object (readonly)
An array of requirement pairs. The first element of the pair is the op, and the second is the Gem::Version.
104 105 106 |
# File 'lib/rubygems/requirement.rb', line 104 def requirements @requirements end |
Class Method Details
.create(input) ⇒ Object
REFACTOR: There’s no reason that this can’t be unified with .new. .new is the standard Ruby factory method.
47 48 49 50 51 52 53 54 55 56 57 58 59 60 |
# File 'lib/rubygems/requirement.rb', line 47 def self.create input case input when Gem::Requirement then input when Gem::Version, Array then new input else if input.respond_to? :to_str then new [input.to_str] else default end end end |
.default ⇒ Object
A default “version requirement” can surely only be ‘>= 0’.
65 66 67 |
# File 'lib/rubygems/requirement.rb', line 65 def self.default new '>= 0' end |
.parse(obj) ⇒ Object
REFACTOR: Little two element arrays like this have no real semantic value. I’d love to see something like this: Constraint = Struct.new(:operator, :version); (or similar) and have a Requirement be a list of Constraints.
86 87 88 89 90 91 92 93 94 95 96 97 98 |
# File 'lib/rubygems/requirement.rb', line 86 def self.parse obj return ["=", obj] if Gem::Version === obj unless PATTERN =~ obj.to_s raise BadRequirementError, "Illformed requirement [#{obj.inspect}]" end if $1 == ">=" && $2 == "0" DefaultRequirement else [$1 || "=", Gem::Version.new($2)] end end |
Instance Method Details
#==(other) ⇒ Object
DOC: this should probably be :nodoc’d
218 219 220 |
# File 'lib/rubygems/requirement.rb', line 218 def == other Gem::Requirement === other and to_s == other.to_s end |
#as_list ⇒ Object
:nodoc:
136 137 138 |
# File 'lib/rubygems/requirement.rb', line 136 def as_list # :nodoc: requirements.map { |op, version| "#{op} #{version}" }.sort end |
#encode_with(coder) ⇒ Object
173 174 175 |
# File 'lib/rubygems/requirement.rb', line 173 def encode_with(coder) coder.add 'requirements', @requirements end |
#hash ⇒ Object
:nodoc:
140 141 142 |
# File 'lib/rubygems/requirement.rb', line 140 def hash # :nodoc: requirements.hash end |
#init_with(coder) ⇒ Object
:nodoc:
165 166 167 |
# File 'lib/rubygems/requirement.rb', line 165 def init_with coder # :nodoc: yaml_initialize coder.tag, coder.map end |
#marshal_dump ⇒ Object
:nodoc:
144 145 146 147 148 |
# File 'lib/rubygems/requirement.rb', line 144 def marshal_dump # :nodoc: fix_syck_default_key_in_requirements [@requirements] end |
#marshal_load(array) ⇒ Object
:nodoc:
150 151 152 153 154 |
# File 'lib/rubygems/requirement.rb', line 150 def marshal_load array # :nodoc: @requirements = array[0] fix_syck_default_key_in_requirements end |
#none? ⇒ Boolean
FIX: maybe this should be using #default ?
128 129 130 131 132 133 134 |
# File 'lib/rubygems/requirement.rb', line 128 def none? if @requirements.size == 1 @requirements[0] == DefaultRequirement else false end end |
#prerelease? ⇒ Boolean
A requirement is a prerelease if any of the versions inside of it are prereleases
181 182 183 |
# File 'lib/rubygems/requirement.rb', line 181 def prerelease? requirements.any? { |r| r.last.prerelease? } end |
#pretty_print(q) ⇒ Object
:nodoc:
185 186 187 188 189 |
# File 'lib/rubygems/requirement.rb', line 185 def pretty_print q # :nodoc: q.group 1, 'Gem::Requirement.new(', ')' do q.pp as_list end end |
#satisfied_by?(version) ⇒ Boolean Also known as: ===, =~
True if version
satisfies this Requirement.
194 195 196 197 198 199 |
# File 'lib/rubygems/requirement.rb', line 194 def satisfied_by? version raise ArgumentError, "Need a Gem::Version: #{version.inspect}" unless Gem::Version === version # #28965: syck has a bug with unquoted '=' YAML.loading as YAML::DefaultKey requirements.all? { |op, rv| (OPS[op] || OPS["="]).call version, rv } end |
#specific? ⇒ Boolean
True if the requirement will not always match the latest version.
207 208 209 210 211 |
# File 'lib/rubygems/requirement.rb', line 207 def specific? return true if @requirements.length > 1 # GIGO, > 1, > 2 is silly not %w[> >=].include? @requirements.first.first # grab the operator end |
#to_s ⇒ Object
:nodoc:
213 214 215 |
# File 'lib/rubygems/requirement.rb', line 213 def to_s # :nodoc: as_list.join ", " end |
#to_yaml_properties ⇒ Object
169 170 171 |
# File 'lib/rubygems/requirement.rb', line 169 def to_yaml_properties ["@requirements"] end |
#yaml_initialize(tag, vals) ⇒ Object
:nodoc:
156 157 158 159 160 161 162 163 |
# File 'lib/rubygems/requirement.rb', line 156 def yaml_initialize(tag, vals) # :nodoc: vals.each do |ivar, val| instance_variable_set "@#{ivar}", val end Gem.load_yaml fix_syck_default_key_in_requirements end |