vagrant-dnsdock-hostupdater 0.0.10
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Rakefile +3 -0
- data/lib/client.rb +5 -0
- data/lib/event-watcher.rb +35 -0
- data/lib/host-manager.rb +193 -0
- data/lib/hosts/aef/hosts.rb +51 -0
- data/lib/hosts/aef/hosts/comment.rb +73 -0
- data/lib/hosts/aef/hosts/element.rb +108 -0
- data/lib/hosts/aef/hosts/empty_element.rb +50 -0
- data/lib/hosts/aef/hosts/entry.rb +123 -0
- data/lib/hosts/aef/hosts/file.rb +252 -0
- data/lib/hosts/aef/hosts/helpers.rb +121 -0
- data/lib/hosts/aef/hosts/section.rb +141 -0
- data/lib/hosts/aef/hosts/version.rb +29 -0
- data/lib/hosts/aef/linebreak/linebreak.rb +148 -0
- data/lib/hosts/hosts.rb +25 -0
- data/lib/hosts/hosts/bare.rb +23 -0
- data/lib/launch-control +46 -0
- data/lib/server.rb +3 -0
- data/lib/vagrant-dnsdock-hostupdater.rb +10 -0
- data/lib/vagrant-dnsdock-hostupdater/command.rb +12 -0
- data/lib/vagrant-dnsdock-hostupdater/plugin.rb +91 -0
- data/lib/version.rb +5 -0
- metadata +107 -0
@@ -0,0 +1,50 @@
|
|
1
|
+
# encoding: UTF-8
|
2
|
+
=begin
|
3
|
+
Copyright Alexander E. Fischer <aef@raxys.net>, 2012
|
4
|
+
|
5
|
+
This file is part of Hosts.
|
6
|
+
|
7
|
+
Permission to use, copy, modify, and/or distribute this software for any
|
8
|
+
purpose with or without fee is hereby granted, provided that the above
|
9
|
+
copyright notice and this permission notice appear in all copies.
|
10
|
+
|
11
|
+
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
12
|
+
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
|
13
|
+
FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
14
|
+
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
15
|
+
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
16
|
+
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
17
|
+
PERFORMANCE OF THIS SOFTWARE.
|
18
|
+
=end
|
19
|
+
|
20
|
+
require_relative '../hosts'
|
21
|
+
|
22
|
+
module Aef
|
23
|
+
module Hosts
|
24
|
+
|
25
|
+
# Represents an empty line as element of a hosts file
|
26
|
+
class EmptyElement < Element
|
27
|
+
|
28
|
+
# Initializes an empty Element
|
29
|
+
#
|
30
|
+
# @param [Hash] options
|
31
|
+
# @option options [String] :cache sets a cached String representation
|
32
|
+
def initialize(options = {})
|
33
|
+
validate_options(options, :cache)
|
34
|
+
|
35
|
+
@cache = options[:cache].to_s unless options[:cache].nil?
|
36
|
+
end
|
37
|
+
|
38
|
+
protected
|
39
|
+
|
40
|
+
# Defines the algorithm to generate a String representation from scratch.
|
41
|
+
#
|
42
|
+
# @return [String] a generated String representation
|
43
|
+
def generate_string(options = {})
|
44
|
+
"\n"
|
45
|
+
end
|
46
|
+
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
50
|
+
|
@@ -0,0 +1,123 @@
|
|
1
|
+
# encoding: UTF-8
|
2
|
+
=begin
|
3
|
+
Copyright Alexander E. Fischer <aef@raxys.net>, 2012
|
4
|
+
|
5
|
+
This file is part of Hosts.
|
6
|
+
|
7
|
+
Permission to use, copy, modify, and/or distribute this software for any
|
8
|
+
purpose with or without fee is hereby granted, provided that the above
|
9
|
+
copyright notice and this permission notice appear in all copies.
|
10
|
+
|
11
|
+
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
12
|
+
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
|
13
|
+
FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
14
|
+
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
15
|
+
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
16
|
+
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
17
|
+
PERFORMANCE OF THIS SOFTWARE.
|
18
|
+
=end
|
19
|
+
|
20
|
+
require_relative '../hosts'
|
21
|
+
|
22
|
+
module Aef
|
23
|
+
module Hosts
|
24
|
+
|
25
|
+
# Represents an entry line as element of a hosts file
|
26
|
+
class Entry < Element
|
27
|
+
|
28
|
+
# The network address
|
29
|
+
#
|
30
|
+
# @return [String]
|
31
|
+
attr_reader :address
|
32
|
+
|
33
|
+
# The primary hostname for the address
|
34
|
+
#
|
35
|
+
# @return [String]
|
36
|
+
attr_reader :name
|
37
|
+
|
38
|
+
# Optional comment
|
39
|
+
#
|
40
|
+
# @return [String]
|
41
|
+
attr_reader :comment
|
42
|
+
|
43
|
+
# Optional alias hostnames
|
44
|
+
#
|
45
|
+
# @return [Array<String>]
|
46
|
+
attr_reader :aliases
|
47
|
+
|
48
|
+
# Initializes an entry.
|
49
|
+
#
|
50
|
+
# @param [String] address the network address
|
51
|
+
# @param [String] name the primary hostname for the address
|
52
|
+
# @param [Hash] options
|
53
|
+
# @option options [Array<String>] :aliases a list of aliases for the
|
54
|
+
# address
|
55
|
+
# @option options [String] :comment a comment for the entry
|
56
|
+
# @option options [String] :cache a cached String representation
|
57
|
+
def initialize(address, name, options = {})
|
58
|
+
validate_options(options, :aliases, :comment, :cache)
|
59
|
+
|
60
|
+
raise ArgumentError, 'Address cannot be empty' unless address
|
61
|
+
raise ArgumentError, 'Name cannot be empty' unless name
|
62
|
+
|
63
|
+
@address = address.to_s
|
64
|
+
@name = name.to_s
|
65
|
+
@aliases = options[:aliases] || []
|
66
|
+
@comment = options[:comment].to_s unless options[:comment].nil?
|
67
|
+
@cache = options[:cache].to_s unless options[:cache].nil?
|
68
|
+
end
|
69
|
+
|
70
|
+
# Sets the network address
|
71
|
+
def address=(address)
|
72
|
+
set_if_changed(:address, address.to_s) do
|
73
|
+
invalidate_cache!
|
74
|
+
end
|
75
|
+
end
|
76
|
+
|
77
|
+
# Sets the primary hostname for the address
|
78
|
+
def name=(name)
|
79
|
+
set_if_changed(:name, name.to_s) do
|
80
|
+
invalidate_cache!
|
81
|
+
end
|
82
|
+
end
|
83
|
+
|
84
|
+
# Sets the optional comment
|
85
|
+
def comment=(comment)
|
86
|
+
set_if_changed(:comment, comment.to_s) do
|
87
|
+
invalidate_cache!
|
88
|
+
end
|
89
|
+
end
|
90
|
+
|
91
|
+
# Sets the optional alias hostnames
|
92
|
+
def aliases=(aliases)
|
93
|
+
set_if_changed(:aliases, [*aliases]) do
|
94
|
+
invalidate_cache!
|
95
|
+
end
|
96
|
+
end
|
97
|
+
|
98
|
+
# A String representation for debugging purposes
|
99
|
+
#
|
100
|
+
# @return [String]
|
101
|
+
def inspect
|
102
|
+
generate_inspect(self, :address, :name, :aliases, :comment, :cache)
|
103
|
+
end
|
104
|
+
|
105
|
+
protected
|
106
|
+
|
107
|
+
# Defines the algorithm to generate a String representation from scratch.
|
108
|
+
#
|
109
|
+
# @abstract This method needs to be implemented in descendant classes.
|
110
|
+
# @return [String] a generated String representation
|
111
|
+
def generate_string(options = nil)
|
112
|
+
if comment
|
113
|
+
suffix = " ##{comment}\n"
|
114
|
+
else
|
115
|
+
suffix = "\n"
|
116
|
+
end
|
117
|
+
|
118
|
+
[address, name, *aliases].join(' ') << suffix
|
119
|
+
end
|
120
|
+
|
121
|
+
end
|
122
|
+
end
|
123
|
+
end
|
@@ -0,0 +1,252 @@
|
|
1
|
+
# encoding: UTF-8
|
2
|
+
=begin
|
3
|
+
Copyright Alexander E. Fischer <aef@raxys.net>, 2012
|
4
|
+
|
5
|
+
This file is part of Hosts.
|
6
|
+
|
7
|
+
Permission to use, copy, modify, and/or distribute this software for any
|
8
|
+
purpose with or without fee is hereby granted, provided that the above
|
9
|
+
copyright notice and this permission notice appear in all copies.
|
10
|
+
|
11
|
+
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
12
|
+
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
|
13
|
+
FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
14
|
+
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
15
|
+
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
16
|
+
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
17
|
+
PERFORMANCE OF THIS SOFTWARE.
|
18
|
+
=end
|
19
|
+
|
20
|
+
require_relative '../hosts'
|
21
|
+
|
22
|
+
module Aef
|
23
|
+
module Hosts
|
24
|
+
|
25
|
+
# This class represents a hosts file and aggregates its elements.
|
26
|
+
#
|
27
|
+
# It is able to parse host files from file-system or String and can
|
28
|
+
# generate a String representation of itself to String or file-system.
|
29
|
+
class File
|
30
|
+
|
31
|
+
include Helpers
|
32
|
+
|
33
|
+
# Regular expression to extract a comment line.
|
34
|
+
#
|
35
|
+
# @private
|
36
|
+
COMMENT_LINE_PATTERN = /^\s*#(.*)$/
|
37
|
+
|
38
|
+
# Regular expression to extract section headers and footers.
|
39
|
+
#
|
40
|
+
# @private
|
41
|
+
SECTION_MARKER_PATTERN = /^ -----(BEGIN|END) SECTION (.*)-----(?:[\r])?$/
|
42
|
+
|
43
|
+
# Regular expression to extract entry lines.
|
44
|
+
#
|
45
|
+
# @private
|
46
|
+
ENTRY_LINE_PATTERN = /^([^#]*)(?:#(.*))?$/
|
47
|
+
|
48
|
+
# The hosts file's elements.
|
49
|
+
#
|
50
|
+
# @return [Array<Aef::Hosts::Element>]
|
51
|
+
attr_accessor :elements
|
52
|
+
|
53
|
+
# The filesystem path of the hosts file.
|
54
|
+
#
|
55
|
+
# @return [Pathname, nil]
|
56
|
+
attr_reader :path
|
57
|
+
|
58
|
+
class << self
|
59
|
+
# Parses a hosts file given as path.
|
60
|
+
#
|
61
|
+
# @param [Pathname] path the hosts file path
|
62
|
+
# @return [Aef::Hosts::File] a file
|
63
|
+
def read(path)
|
64
|
+
new(path).read
|
65
|
+
end
|
66
|
+
|
67
|
+
# Parses a hosts file given as String.
|
68
|
+
#
|
69
|
+
# @param [String] data a String representation of the hosts file
|
70
|
+
# @return [Aef::Hosts::File] a file
|
71
|
+
def parse(data)
|
72
|
+
new.parse(data)
|
73
|
+
end
|
74
|
+
end
|
75
|
+
|
76
|
+
# Initializes a file.
|
77
|
+
#
|
78
|
+
# @param [Pathname] path path to the hosts file
|
79
|
+
def initialize(path = nil)
|
80
|
+
reset
|
81
|
+
self.path = path
|
82
|
+
end
|
83
|
+
|
84
|
+
# Removes all elements.
|
85
|
+
#
|
86
|
+
# @return [Aef::Hosts::File] a self reference
|
87
|
+
def reset
|
88
|
+
@elements = []
|
89
|
+
|
90
|
+
self
|
91
|
+
end
|
92
|
+
|
93
|
+
# Deletes the cached String representations of all elements.
|
94
|
+
#
|
95
|
+
# @return [Aef::Hosts::File] a self reference
|
96
|
+
def invalidate_cache!
|
97
|
+
elements.each do |element|
|
98
|
+
element.invalidate_cache!
|
99
|
+
end
|
100
|
+
|
101
|
+
self
|
102
|
+
end
|
103
|
+
|
104
|
+
# Sets the filesystem path of the hosts file.
|
105
|
+
def path=(path)
|
106
|
+
@path = to_pathname(path)
|
107
|
+
end
|
108
|
+
|
109
|
+
# Parses a hosts file given as path.
|
110
|
+
#
|
111
|
+
# @param [Pathname] path override the path attribute for this operation
|
112
|
+
# @return [Aef::Hosts::File] a self reference
|
113
|
+
def read(path = nil)
|
114
|
+
path = path.nil? ? @path : to_pathname(path)
|
115
|
+
|
116
|
+
raise ArgumentError, 'No path given' unless path
|
117
|
+
|
118
|
+
parse(path.read)
|
119
|
+
|
120
|
+
self
|
121
|
+
end
|
122
|
+
|
123
|
+
# Parses a hosts file given as String.
|
124
|
+
#
|
125
|
+
# @param [String] data a String representation of the hosts file
|
126
|
+
# @return [Aef::Hosts::File] a self reference
|
127
|
+
def parse(data)
|
128
|
+
current_section = self
|
129
|
+
|
130
|
+
data.to_s.lines.each_with_index do |line, line_number|
|
131
|
+
line = Linebreak.encode(line, :unix)
|
132
|
+
|
133
|
+
if COMMENT_LINE_PATTERN =~ line
|
134
|
+
comment = $1
|
135
|
+
|
136
|
+
if SECTION_MARKER_PATTERN =~ comment
|
137
|
+
type = $1
|
138
|
+
name = $2
|
139
|
+
|
140
|
+
case type
|
141
|
+
when 'BEGIN'
|
142
|
+
unless current_section.is_a?(Section)
|
143
|
+
current_section = Section.new(
|
144
|
+
name,
|
145
|
+
:cache => {:header => line, :footer => nil}
|
146
|
+
)
|
147
|
+
else
|
148
|
+
raise ParserError, "Invalid cascading of sections. Cannot start new section '#{name}' without first closing section '#{current_section.name}' on line #{line_number + 1}."
|
149
|
+
end
|
150
|
+
when 'END'
|
151
|
+
if name == current_section.name
|
152
|
+
current_section.cache[:footer] = line
|
153
|
+
elements << current_section
|
154
|
+
current_section = self
|
155
|
+
else
|
156
|
+
raise ParserError, "Invalid closing of section. Found attempt to close section '#{name}' in body of section '#{current_section.name}' on line #{line_number + 1}."
|
157
|
+
end
|
158
|
+
end
|
159
|
+
else
|
160
|
+
current_section.elements << Comment.new(
|
161
|
+
comment,
|
162
|
+
:cache => line
|
163
|
+
)
|
164
|
+
end
|
165
|
+
else
|
166
|
+
ENTRY_LINE_PATTERN =~ line
|
167
|
+
|
168
|
+
entry = $1
|
169
|
+
comment = $2
|
170
|
+
|
171
|
+
if entry and not entry =~ /^\s+$/
|
172
|
+
|
173
|
+
split = entry.split(/\s+/)
|
174
|
+
split.shift if split.first == ''
|
175
|
+
|
176
|
+
address, name, *aliases = *split
|
177
|
+
|
178
|
+
current_section.elements << Entry.new(
|
179
|
+
address, name,
|
180
|
+
:aliases => aliases,
|
181
|
+
:comment => comment,
|
182
|
+
:cache => line
|
183
|
+
)
|
184
|
+
else
|
185
|
+
current_section.elements << EmptyElement.new(
|
186
|
+
:cache => line
|
187
|
+
)
|
188
|
+
end
|
189
|
+
end
|
190
|
+
end
|
191
|
+
|
192
|
+
self
|
193
|
+
end
|
194
|
+
|
195
|
+
# Generates a hosts file and writes it to a path.
|
196
|
+
#
|
197
|
+
# @param [Hash] options
|
198
|
+
# @option options [Pathname] :path overrides the path attribute for this
|
199
|
+
# operation
|
200
|
+
# @option options [true, false] :force_generation if set to true, the
|
201
|
+
# cache won't be used, even if it not empty
|
202
|
+
# @option options [:unix, :windows, :mac] :linebreak_encoding the
|
203
|
+
# linebreak encoding of the result. If nothing is specified the result
|
204
|
+
# will be encoded as if :unix was specified.
|
205
|
+
# @see Aef::Linebreak#encode
|
206
|
+
def write(options = {})
|
207
|
+
validate_options(options, :force_generation, :linebreak_encoding, :path)
|
208
|
+
|
209
|
+
path = options[:path].nil? ? @path : to_pathname(options[:path])
|
210
|
+
|
211
|
+
raise ArgumentError, 'No path given' unless path
|
212
|
+
|
213
|
+
options.delete(:path)
|
214
|
+
|
215
|
+
path.open('w') do |file|
|
216
|
+
file.write(to_s(options))
|
217
|
+
end
|
218
|
+
|
219
|
+
true
|
220
|
+
end
|
221
|
+
|
222
|
+
# A String representation for debugging purposes.
|
223
|
+
#
|
224
|
+
# @return [String]
|
225
|
+
def inspect
|
226
|
+
generate_inspect(self, :path, :elements)
|
227
|
+
end
|
228
|
+
|
229
|
+
# A String representation of the hosts file.
|
230
|
+
#
|
231
|
+
# @param [Hash] options
|
232
|
+
# @option options [true, false] :force_generation if set to true, the
|
233
|
+
# cache won't be used, even if it not empty
|
234
|
+
# @option options [:unix, :windows, :mac] :linebreak_encoding the
|
235
|
+
# linebreak encoding of the result. If nothing is specified the result
|
236
|
+
# will be encoded as if :unix was specified.
|
237
|
+
# @see Aef::Linebreak#encode
|
238
|
+
def to_s(options = {})
|
239
|
+
validate_options(options, :force_generation, :linebreak_encoding)
|
240
|
+
|
241
|
+
string = ''
|
242
|
+
|
243
|
+
@elements.each do |element|
|
244
|
+
string << element.to_s(options)
|
245
|
+
end
|
246
|
+
|
247
|
+
string
|
248
|
+
end
|
249
|
+
|
250
|
+
end
|
251
|
+
end
|
252
|
+
end
|
@@ -0,0 +1,121 @@
|
|
1
|
+
# encoding: UTF-8
|
2
|
+
=begin
|
3
|
+
Copyright Alexander E. Fischer <aef@raxys.net>, 2012
|
4
|
+
|
5
|
+
This file is part of Hosts.
|
6
|
+
|
7
|
+
Permission to use, copy, modify, and/or distribute this software for any
|
8
|
+
purpose with or without fee is hereby granted, provided that the above
|
9
|
+
copyright notice and this permission notice appear in all copies.
|
10
|
+
|
11
|
+
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
|
12
|
+
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
|
13
|
+
FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
|
14
|
+
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
|
15
|
+
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
16
|
+
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
17
|
+
PERFORMANCE OF THIS SOFTWARE.
|
18
|
+
=end
|
19
|
+
|
20
|
+
require_relative '../hosts'
|
21
|
+
|
22
|
+
module Aef
|
23
|
+
module Hosts
|
24
|
+
|
25
|
+
# Helper methods used internally in the hosts library
|
26
|
+
#
|
27
|
+
# @private
|
28
|
+
module Helpers
|
29
|
+
|
30
|
+
protected
|
31
|
+
|
32
|
+
# Ensures that an options Hash has includes only valid keys
|
33
|
+
#
|
34
|
+
# @param [Hash] options the options Hash to verify
|
35
|
+
# @param [Array<Symbol>] valid_keys a list of valid keys for the Hash
|
36
|
+
# @raise [ArgumentError] if Hash includes invalid keys
|
37
|
+
def validate_options(options, *valid_keys)
|
38
|
+
remainder = options.keys - valid_keys
|
39
|
+
|
40
|
+
unless remainder.empty?
|
41
|
+
raise ArgumentError, "Invalid option keys: #{remainder.map(&:inspect).join(',')}"
|
42
|
+
end
|
43
|
+
end
|
44
|
+
|
45
|
+
# Casts a given object to Pathname or passes through a given nil
|
46
|
+
#
|
47
|
+
# @param [String, Pathname, nil] path a filesystem path
|
48
|
+
# @return [Pathname, nil]
|
49
|
+
def to_pathname(path)
|
50
|
+
path.nil? ? nil : Pathname.new(path)
|
51
|
+
end
|
52
|
+
|
53
|
+
# Generates a String representation for debugging purposes.
|
54
|
+
#
|
55
|
+
# @param [Object] model a model for which the String is generated
|
56
|
+
# @param [Array<Symbol, String>] attributes Attributes to be displayed.
|
57
|
+
# If given as Symbol, the attribute's value will be presented by name
|
58
|
+
# and the inspect output of its value. If given as String, the String
|
59
|
+
# will represent it instead.
|
60
|
+
# @return [String] a string representation for debugging purposes
|
61
|
+
def generate_inspect(model, *attributes)
|
62
|
+
string = "#<#{model.class}"
|
63
|
+
|
64
|
+
components = []
|
65
|
+
|
66
|
+
attributes.each do |attribute|
|
67
|
+
if attribute == :cache
|
68
|
+
components << 'cached!' if model.send(:cache_filled?)
|
69
|
+
elsif attribute == :elements
|
70
|
+
components << generate_elements_partial(model.elements)
|
71
|
+
elsif attribute.is_a?(Symbol)
|
72
|
+
components << "#{attribute}=#{model.send(attribute).inspect}"
|
73
|
+
else
|
74
|
+
components << attribute
|
75
|
+
end
|
76
|
+
end
|
77
|
+
|
78
|
+
components.unshift(':') unless components.empty?
|
79
|
+
|
80
|
+
string << components.join(' ')
|
81
|
+
string << '>'
|
82
|
+
end
|
83
|
+
|
84
|
+
# Generate a partial String for an element listing in inspect output.
|
85
|
+
#
|
86
|
+
# @return [String] element partial
|
87
|
+
def generate_elements_partial(elements)
|
88
|
+
elements_string = 'elements=['
|
89
|
+
|
90
|
+
unless elements.empty?
|
91
|
+
elements_string << "\n"
|
92
|
+
elements_string << elements.map{|element|
|
93
|
+
element.inspect.lines.map{|line| " #{line}"}.join
|
94
|
+
}.join(",\n")
|
95
|
+
elements_string << "\n"
|
96
|
+
end
|
97
|
+
|
98
|
+
elements_string << "]"
|
99
|
+
end
|
100
|
+
|
101
|
+
# Sets a given attribute and executes the block if the current value
|
102
|
+
# differs from the given.
|
103
|
+
#
|
104
|
+
# @param [Symbol] attribute the attribute's name
|
105
|
+
# @param [Object] new_value the value to be assigned to the attribute if
|
106
|
+
# it differs from its current value
|
107
|
+
# @yield Executed if current value differs from the given
|
108
|
+
def set_if_changed(attribute, new_value)
|
109
|
+
variable_name = :"@#{attribute}"
|
110
|
+
old_value = instance_variable_get(variable_name)
|
111
|
+
|
112
|
+
if new_value != old_value
|
113
|
+
instance_variable_set(variable_name, new_value)
|
114
|
+
|
115
|
+
yield if block_given?
|
116
|
+
end
|
117
|
+
end
|
118
|
+
|
119
|
+
end
|
120
|
+
end
|
121
|
+
end
|