Class: LibGems::Requirement

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/libgems/requirement.rb

Overview

A Requirement is a set of one or more version restrictions. It supports a few (=, !=, >, <, >=, <=, ~>) different restriction operators.

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 = 
/\A\s*(#{quoted})?\s*(#{LibGems::Version::VERSION_PATTERN})\s*\z/

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*requirements) ⇒ Requirement

Constructs a requirement from requirements. Requirements can be Strings, LibGems::Versions, or Arrays of those. nil and duplicate requirements are ignored. An empty set of requirements is the same as ">= 0".



90
91
92
93
94
95
96
97
98
 
# File 'lib/libgems/requirement.rb', line 90

def initialize *requirements
  requirements = requirements.flatten
  requirements.compact!
  requirements.uniq!

  requirements << ">= 0" if requirements.empty?
  @none = (requirements == ">= 0")
  @requirements = requirements.map! { |r| self.class.parse r }
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 LibGems::Version.



82
83
84
 
# File 'lib/libgems/requirement.rb', line 82

def requirements
  @requirements
end

Class Method Details

.create(input) ⇒ Object

Factory method to create a LibGems::Requirement object. Input may be a Version, a String, or nil. Intended to simplify client code.

If the input is “weird”, the default version requirement is returned.



30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/libgems/requirement.rb', line 30

def self.create input
  case input
  when LibGems::Requirement then
    input
  when LibGems::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’. – This comment once said:

“A default ”version requirement“ can surely only be ‘> 0’.”



52
53
54
 
# File 'lib/libgems/requirement.rb', line 52

def self.default
  new '>= 0'
end

.parse(obj) ⇒ Object

Parse obj, returning an [op, version] pair. obj can be a String or a LibGems::Version.

If obj is a String, it can be either a full requirement specification, like ">= 1.2", or a simple version number, like "1.2".

parse("> 1.0")                 # => [">", "1.0"]
parse("1.0")                   # => ["=", "1.0"]
parse(LibGems::Version.new("1.0")) # => ["=,  "1.0"]



68
69
70
71
72
73
74
75
76
 
# File 'lib/libgems/requirement.rb', line 68

def self.parse obj
  return ["=", obj] if LibGems::Version === obj

  unless PATTERN =~ obj.to_s
    raise ArgumentError, "Illformed requirement [#{obj.inspect}]"
  end

  [$1 || "=", LibGems::Version.new($2)]
end

Instance Method Details

#<=>(other) ⇒ Object

:nodoc:



156
157
158
 
# File 'lib/libgems/requirement.rb', line 156

def <=> other # :nodoc:
  to_s <=> other.to_s
end

#as_list ⇒ Object

:nodoc:



108
109
110
 
# File 'lib/libgems/requirement.rb', line 108

def as_list # :nodoc:
  requirements.map { |op, version| "#{op} #{version}" }
end

#hash ⇒ Object

:nodoc:



112
113
114
 
# File 'lib/libgems/requirement.rb', line 112

def hash # :nodoc:
  requirements.hash
end

#marshal_dump ⇒ Object

:nodoc:



116
117
118
 
# File 'lib/libgems/requirement.rb', line 116

def marshal_dump # :nodoc:
  [@requirements]
end

#marshal_load(array) ⇒ Object

:nodoc:



120
121
122
123
124
125
126
127
128
129
 
# File 'lib/libgems/requirement.rb', line 120

def marshal_load array # :nodoc:
  @requirements = array[0]

  # Fixup the Syck DefaultKey bug
  @requirements.each do |r|
    if r[0].kind_of?(Syck::DefaultKey) || r[0].kind_of?(YAML::Syck::DefaultKey)
      r[0] = "="
    end
  end
end

#none? ⇒ Boolean

An array of requirement pairs. The first element of the pair is the op, and the second is the LibGems::Version.

Returns:

  • (Boolean) 


104
105
106
 
# File 'lib/libgems/requirement.rb', line 104

def none?
  @none ||= (to_s == ">= 0")
end

#prerelease? ⇒ Boolean

Returns:

  • (Boolean) 


131
132
133
 
# File 'lib/libgems/requirement.rb', line 131

def prerelease?
  requirements.any? { |r| r.last.prerelease? }
end

#pretty_print(q) ⇒ Object

:nodoc:



135
136
137
138
139
 
# File 'lib/libgems/requirement.rb', line 135

def pretty_print q # :nodoc:
  q.group 1, 'LibGems::Requirement.new(', ')' do
    q.pp as_list
  end
end

#satisfied_by?(version) ⇒ Boolean

True if version satisfies this Requirement.

Returns:

  • (Boolean) 


144
145
146
 
# File 'lib/libgems/requirement.rb', line 144

def satisfied_by? version
  requirements.all? { |op, rv| OPS[op].call version, rv }
end

#to_s ⇒ Object

:nodoc:



148
149
150
 
# File 'lib/libgems/requirement.rb', line 148

def to_s # :nodoc:
  as_list.join ", "
end

#to_yaml_type ⇒ Object 



152
153
154
 
# File 'lib/libgems/requirement.rb', line 152

def to_yaml_type
  "!ruby/object:Gem::Requirement"
end