1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
# ObjectBuilder is a class to help you build Ruby-based configuration syntaxes.
# You can use it to make "builder" classes to help build particular types
# of objects, typically translating simple command-based syntax to creating
# classes and setting attributes. e.g. here is a description of a day at
# the zoo:
#
# person "Alice"
# person "Matthew"
#
# zoo("London") {
# enclosure("Butterfly House") {
#
# has_roof
# allow_visitors
#
# animals("moth", 10) {
# wings 2
# legs 2
# }
#
# animals("butterfly", 200) {
# wings 2
# legs 2
# }
# }
#
# enclosure("Aquarium") {
# no_roof
#
# animal("killer whale") {
# called "Shamu"
# wings 0
# legs 0
# tail
# }
# }
# }
#
# Here is the basic builder class for a Zoo...
#
# TODO: finish this convoluted example, if it kills me
#
class ObjectBuilder
class BuildException < StandardError; end
attr_reader :result
attr_accessor :block_result
# Generates a new builder
#
# @param [ObjectBuidler] context The level of the builder
# @param [Array] args The arguments to pass on to the builder_setup
#
def initialize(context, *args)
@context = context
@result = nil
builder_setup(*args)
end
# Generates an anonymous name
#
# @return [String]
def anonymous_name
@@sequence ||= 0 # not inherited, don't want it to be
@@sequence += 1
"anon.#{Time.now.to_i}.#{@@sequence}"
end
#
# Merge a file into self. If the file is a relative path, it is relative to
# the file from which it has been included.
#
# @param [String] file The filename to include
#
# @raise [BuildException] When an expected exception is raised
# @raise [NameError]
# @raise [SyntaxError]
# @raise [ArgumentError]
#
# @returns [ObjectBuilder] self
def include_file(file)
#
# Share the current directory with all instances of this class.
#
@@directory ||= nil
#
# Do we have an absolute path?
#
file = File.join(@@directory, file) if !@@directory.nil? and '/' != file[0,1]
#
# Resolve the filename.
#
file = File.expand_path(file)
#
# Save the current wd
#
oldwd = @@directory
#
# Set the new one
#
@@directory = File.dirname(file)
#
# Read the file and eval it.
#
instance_eval(File.read(file), file)
#
# Reset back to where we were.
#
@@directory = oldwd
self
rescue NameError, NoMethodError => ex
#
# Ugh. Catch NameError and re-raise as a BuildException
#
if ex.backtrace.find{|l| l =~ /^#{file}:(\d+):/}
build_ex = BuildException.new "Unknown word `#{ex.name}' in #{file} at line #{$1}"
build_ex.set_backtrace ex.backtrace
raise build_ex
else
raise ex
end
rescue SyntaxError, ArgumentError => ex
if ex.backtrace.find{|l| l =~ /^#{file}:(\d+):/}
build_ex = BuildException.new "#{ex.message} in #{file} at line #{$1}"
build_ex.set_backtrace ex.backtrace
raise build_ex
else
raise ex
end
end
#
# Loads a stack of files in a directory, and merges them into the current object
#
# @params [String] dir Directory in which to search for files.
# @params [Regexp] regexp Regular expression for filename to include.
#
# @returns [ObjectBuilder] self
def include_directory(dir, regex = /^[a-zA-Z0-9_-]+\.conf$/)
files = []
#
# Exceptions are caught by #include_file
#
Dir.entries(dir).sort.each do |entry|
next unless entry =~ regex
file = File.join(dir,entry)
next unless File.file?(file)
include_file(file)
end
self
end
class << self
# Defines a new builder
#
# @param [String] word The builder's name
# @param [Class] clazz The Class the builder represents
#
# @macro [attach] is_builder
# @return The +$1+ builder.
#
# @return [NilClass]
def is_builder(word, clazz)
define_method(word.to_sym) do |*args, &block|
builder = clazz.new(*([@context] + args))
builder.instance_eval(&block) if block
["created_#{word}", "created"].each do |created_method|
created_method = created_method.to_sym
if respond_to?(created_method)
__send__(created_method, builder.result)
break
end
end
end
return nil
end
# FIXME: implement is_builder_deferred to create object at end of block?
# Defines a new block attribute
# @param [String] word The block attribute's name
# @macro [attach] is_block_attribute
# @return [NilClass] Allows use of the +$1+ word to define a block.
def is_block_attribute(word)
define_method(word.to_sym) do |*args, &block|
@result.__send__("#{word}=".to_sym, block)
end
end
# Defines a new attribute
# @param [String] word The attribute's name
# @macro [attach] is_attribute
# @return [NilClass] Allows use of the +$1+ word to set an attribute.
#
def is_attribute(word)
define_method(word.to_sym) do |*args, &block|
@result.__send__("#{word}=".to_sym, args[0])
end
end
# Defines a new boolean attribute
# @param [String] word The boolean attribute's name
# @macro [attach] is_flag_attribute
# @return [NilClass] Allows use of the +$1+ word to set an boolean attribute.
def is_flag_attribute(word)
define_method(word.to_sym) do |*args, &block|
@result.__send__("#{word}=".to_sym, true)
end
end
def parse(s)
builder = self.new
builder.instance_eval(s)
builder.result
end
def inherited(*args)
initialize_class
end
def initialize_class
@words = {}
end
end
initialize_class
end
|
