Class: Travis::Client::Entity
- Inherits:
-
Object
- Object
- Travis::Client::Entity
show all
- Defined in:
- lib/travis/client/entity.rb
Direct Known Subclasses
Account, Annotation, Artifact, Broadcast, Build, Commit, EnvVar, Job, Repository, User, WeakEntity
Constant Summary
collapse
- MAP =
{}
Instance Attribute Summary collapse
Class Method Summary
collapse
Instance Method Summary
collapse
Constructor Details
#initialize(session, id) ⇒ Entity
Returns a new instance of Entity.
105
106
107
108
109
110
|
# File 'lib/travis/client/entity.rb', line 105
def initialize(session, id)
raise Travis::Client::Error, '%p is not a valid id' % id unless self.class.id? id
@attributes = {}
@session = session
@id = self.class.cast_id(id) if id
end
|
Instance Attribute Details
#attributes ⇒ Object
Returns the value of attribute attributes.
7
8
9
|
# File 'lib/travis/client/entity.rb', line 7
def attributes
@attributes
end
|
#curry ⇒ Object
Returns the value of attribute curry.
8
9
10
|
# File 'lib/travis/client/entity.rb', line 8
def curry
@curry
end
|
#id ⇒ Object
Returns the value of attribute id.
7
8
9
|
# File 'lib/travis/client/entity.rb', line 7
def id
@id
end
|
#session ⇒ Object
Returns the value of attribute session.
7
8
9
|
# File 'lib/travis/client/entity.rb', line 7
def session
@session
end
|
Class Method Details
.aka(*names) ⇒ Object
24
25
26
|
# File 'lib/travis/client/entity.rb', line 24
def self.aka(*names)
names.each { |n| MAP[n.to_s] = self }
end
|
.attributes(*list) ⇒ Object
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
|
# File 'lib/travis/client/entity.rb', line 46
def self.attributes(*list)
@attributes ||= []
list.each do |name|
name = name.to_s
fail "can't call an attribute id" if name == "id"
@attributes << name
define_method(name) { load_attribute(name) }
define_method("#{name}=") { |value| set_attribute(name, value) }
define_method("#{name}?") { !!send(name) }
end
@attributes
end
|
.base_path ⇒ Object
42
43
44
|
# File 'lib/travis/client/entity.rb', line 42
def self.base_path
many
end
|
.cast_id(id) ⇒ Object
80
81
82
|
# File 'lib/travis/client/entity.rb', line 80
def self.cast_id(id)
Integer(id)
end
|
.has(*list) ⇒ Object
68
69
70
71
72
73
|
# File 'lib/travis/client/entity.rb', line 68
def self.has(*list)
list.each do |name|
relations << name
define_method(name) { relation(name.to_s) }
end
end
|
.id?(object) ⇒ Boolean
84
85
86
|
# File 'lib/travis/client/entity.rb', line 84
def self.id?(object)
object.is_a? Integer
end
|
.id_field(key = nil) ⇒ Object
88
89
90
91
|
# File 'lib/travis/client/entity.rb', line 88
def self.id_field(key = nil)
@id_field = key.to_s if key
@id_field || superclass.id_field
end
|
.inspect_info(name) ⇒ Object
75
76
77
78
|
# File 'lib/travis/client/entity.rb', line 75
def self.inspect_info(name)
alias_method(:inspect_info, name)
private(:inspect_info)
end
|
.many(key = nil) ⇒ Object
37
38
39
40
|
# File 'lib/travis/client/entity.rb', line 37
def self.many(key = nil)
MAP[key.to_s] = self if key
@many ||= key.to_s
end
|
.one(key = nil) ⇒ Object
32
33
34
35
|
# File 'lib/travis/client/entity.rb', line 32
def self.one(key = nil)
MAP[key.to_s] = self if key
@one ||= key.to_s
end
|
.preloadable ⇒ Object
93
94
95
96
97
|
# File 'lib/travis/client/entity.rb', line 93
def self.preloadable
def self.preloadable?
true
end
end
|
.preloadable? ⇒ Boolean
94
95
96
|
# File 'lib/travis/client/entity.rb', line 94
def self.preloadable?
true
end
|
.relations ⇒ Object
12
13
14
|
# File 'lib/travis/client/entity.rb', line 12
def self.relations
@relations ||= []
end
|
.subclass_for(key) ⇒ Object
20
21
22
|
# File 'lib/travis/client/entity.rb', line 20
def self.subclass_for(key)
MAP.fetch(key.to_s)
end
|
.subclasses ⇒ Object
16
17
18
|
# File 'lib/travis/client/entity.rb', line 16
def self.subclasses
MAP.values.uniq
end
|
.time(*list) ⇒ Object
62
63
64
65
66
|
# File 'lib/travis/client/entity.rb', line 62
def self.time(*list)
list.each do |name|
define_method("#{name}=") { |value| set_attribute(name, time(value)) }
end
end
|
.weak? ⇒ Boolean
28
29
30
|
# File 'lib/travis/client/entity.rb', line 28
def self.weak?
false
end
|
Instance Method Details
#[](key) ⇒ Object
126
127
128
129
|
# File 'lib/travis/client/entity.rb', line 126
def [](key)
key = key.to_s
send(key) if include? key
end
|
#[]=(key, value) ⇒ Object
131
132
133
134
|
# File 'lib/travis/client/entity.rb', line 131
def []=(key, value)
key = key.to_s
send("#{key}=", value) if include? key
end
|
#attribute_names ⇒ Object
118
119
120
|
# File 'lib/travis/client/entity.rb', line 118
def attribute_names
self.class.attributes
end
|
#cancelable? ⇒ Boolean
172
173
174
|
# File 'lib/travis/client/entity.rb', line 172
def cancelable?
false
end
|
#complete? ⇒ Boolean
154
155
156
|
# File 'lib/travis/client/entity.rb', line 154
def complete?
attribute_names.all? { |key| attributes.include? key }
end
|
#include?(key) ⇒ Boolean
136
137
138
|
# File 'lib/travis/client/entity.rb', line 136
def include?(key)
attributes.include? key or attribute_names.include? key.to_s
end
|
#inspect ⇒ Object
158
159
160
161
162
|
# File 'lib/travis/client/entity.rb', line 158
def inspect
klass = self.class
klass = curry if curry and curry.name and curry.to_s.size < klass.to_s.size
"#<#{klass}: #{inspect_info}>"
end
|
#load ⇒ Object
145
146
147
|
# File 'lib/travis/client/entity.rb', line 145
def load
session.reload(self) unless complete?
end
|
#missing?(key) ⇒ Boolean
149
150
151
152
|
# File 'lib/travis/client/entity.rb', line 149
def missing?(key)
return false unless include? key
!attributes.include?(key.to_s)
end
|
#relations ⇒ Object
164
165
166
|
# File 'lib/travis/client/entity.rb', line 164
def relations
self.class.relations.map { |r| public_send(r) }.flatten(1)
end
|
#reload ⇒ Object
140
141
142
143
|
# File 'lib/travis/client/entity.rb', line 140
def reload
relations.each { |e| session.reset(e) }
session.reset(self)
end
|
#restartable? ⇒ Boolean
168
169
170
|
# File 'lib/travis/client/entity.rb', line 168
def restartable?
false
end
|
#to_h ⇒ Object
122
123
124
|
# File 'lib/travis/client/entity.rb', line 122
def to_h
Hash[attribute_names.map { |n| [n, self[n]] }]
end
|
#update_attributes(data) ⇒ Object
112
113
114
115
116
|
# File 'lib/travis/client/entity.rb', line 112
def update_attributes(data)
data.each_pair do |key, value|
self[key] = value
end
end
|