1. parameter = value
2. parameter value
3. parameter min_value max_value step_value
三次是一个咒?/h3>在我们构建我们的堆叠文g的DSLӞ 我们把问题解决了三次?首先Q?我们写了自己的语法分析器Q然后发现那L话有太多的工作要l护。不仅仅是代码,而且q有文档。因为我们的DSL _复杂Q如果没有够文档,没有昄的方法去使用它的所有特性?br />
?
着Q在一个短旉内,我们?XML实现?DSL?q样Q我们不需要去写自q语法分析器,因ؓXML 有现成的分析器。但?
XML引入太多的噪壎ͼ模糊了文件的实际内容 。我们的工程师发现思维在理解堆叠文件的含义和理解XML之间q行切换很困难。由此我认识刎ͼXML
不适合人来阅读QXML可能不是用来创徏DSL 的好的选择Q?管我们有不用开发语法分析器QparserQ的好处?br />
最后,我们用Ruby实现了DSL?因ؓ利用?Ruby 解释器的分析功能Q实现v来是很快的。我们不需要写分析器(是RubyQ的文档Q因为它已经存在。而且Q最l的DSL 非常Ҏ被h理解Q也很简z灵zR?br />
好的?让我们用Ruby来创Z?DSLQ该DSL允许我们定义形如‘parameter = value’的语句。请考虑以下假想的DSL 文g?br />
% cat params_with_equal.dsl
name = fred
parameter = .55
q不是合法的Ruby代码Q我们需要稍微修改一下语法得Ruby可以接受它。让我们它改ؓQ?br />
% cat params_with_equal.dsl
name = "fred"
parameter = 0.55
一旦我们让DSL 遵@Ruby的语法,Ruby ׃ؓ我们做了所有的分析工作Qƈ且提供了一U方式访问分析的l果?现在Q让我们写一?Ruby 代码来读DSL?br />
首先Q我们想要将q些参数用某U方式封装v来?一个好的方法是它们放C个类中。我们称q个cMؓ MyDSL?br />
% cat mydsl.rb
class MyDSL
...
end#class MyDSL
从开发者的角度看,我们需要一个简单和直接的方式来分析DSL 文g。就如下面所C:
my_dsl = MyDSL.load(filename)
接着Q让我们来写cL?load:
def self.load(filename)
dsl = new
dsl.instance_eval(File.read(filename), filename)
dsl
end
c?
Ҏload 产生一个MyDSL对象Q?q且以DSL
文g的内容ؓ参数调用该对象的instance_eval。Instance_eval的第二个参数是可选的Q?它得Ruby
在出现语法分析错误时可以报告文g名?一个可选的W三个参敎ͼ没有使用Q可以Ruby 在出现分析错误时能提供错误开始的行号
q个代码能工作吗Q?让我们看看发生了什么?
% cat dsl-loader.rb
require 'mydsl'
my_dsl = MyDSL.load(ARGV.shift) # put the DSL filename on the command line
p my_dsl
p my_dsl.instance_variables
% ruby dsl-loader.rb params_with_equal.dsl
#
[]
?
生了什? name 和parameter到那里去了? q是因ؓname和parameter在等L左侧QRuby
认ؓ他们是局部变量。我们可以告诉Ruby它们是实例变量。有两种方式Q一U是使用 self.name = “fred?
self.parameter = 0.55 Q?另一U是使用@W号?br />
@name = "fred"
@parameter = 0.55
但是Ҏ来说Q这样很丑陋。写成下面的形式也是一栗?br />
$name = "fred"
$parameter = 0.55
q?
有一个办法让Ruby 知道q些ҎQmethodQ执行的上下文, 那就是利用块(block)?yield selfQMyDsl的对象实例)
来显式的声明作用域?Z做到q一点,我们加一个顶层方法来开始我们的DSLQ?q且实际内Ҏq所附的?block)中?修改q的 DSL
看v来是q样Q?br />
% cat params_with_equal2.dsl
define_parameters do |p|
p.name = "fred"
p.parameter = 0.55
end
define_parameter 已经被定义ؓ一个实例方法(instance methodQ?br />
% cat mydsl2.rb
class MyDSL
def define_parameters yield self
end
def self.load(filename) dsl = new
dsl.instance_eval(File.read(filename), filename)
dsl
end end#class MyDSL
修改dsl-loader中的requireQ让它用mydsl2.rb 中的新版本的MyDSL c:
% cat dsl-loader.rb
require 'mydsl2'
my_dsl = MyDSL.load(ARGV.shift)
p my_dsl
p my_dsl.instance_variables
理论上,q可以工作, 让我们测试一下?br />
% ruby dsl-loader.rb params_with_equal2.dsl
params_with_equal2.dsl:2:in `load': undefined method `name=' for # (NoMethodError)
噢,我们忘记了ؓname 和parameter 定义讉K函数QaccessorQ?让我们加上它们, 然后看一下完整的E序Q?br />
% cat mydsl2.rb
class MyDSL
attr_accessor :name, :parameter
def define_parameters
yield self
end
def self.load(filename)
# ... same as before
end end
现在Q?再测试一遍?br />
% ruby dsl-loader.rb params_with_equal2.dsl
#
["@name", "@parameter"]
?
功! 现在工作了。但是我们在DSL文g中加了额外的两行Q?q有额外?.p ,
q些都引入了噪声。这L记法QnotationQ更适合于当DSL文g中存在多个层ơ, q且需要显式指定上下文的情c?
在我们的单例子里Q我们应该隐式的定义上下文, 且让Ruby 知道name 和parameter 是方法(methodQ?让我们删???
Q?DSL 文g写成Q?br />
% cat params.dsl
name "fred"
parameter 0.55
?
在,我们需要ؓname ?parameter 定义新的讉KҎQaccessorQ。这里的H门是:不带参数的name
是@name的读ҎQreaderQ, 带一个或多个参数的name
是@name的写ҎQsetterQ。(注意Q用这个办法很方便Q即使是DSL文g有多个层ơ而且上下文是昑ּ声明的)?我们下面为name
和parameter 定义讉KҎ, 删除attr_accessor那一行,加入以下代码Q?br />
% cat mydsl3.rb
class MyDSL
def name(*val) if val.empty? @name
else @name = val.size == 1 ? val[0] : val
end end
def parameter(*val)
if val.empty? @parameter
else @parameters = val.size == 1 ? val[0] : val
end end
def self.load(filename) # ... same as before
end end#class MyDSL
如果 name 或parameter 不带参数Q它们将q回它们的倹{如果带参数Q?br />- 如果带一个参敎ͼ它们会被赋予该参数的?/li>
- 如果带多个参敎ͼ它们会被赋予一个数l,该数l包含所有的参数?/li>
让我们运行我们的分析器(现在是mydsl3.rbQ来试一下:
% ruby dsl-loader.rb params.dsl
#
["@parameter", "@name"]
又成功了。但是显式地定义讉KҎ( accessors) 很烦人。让我们定义一个定制的讉KҎQƈ且让所有的c都可以使用它?我们通过此Ҏ(method)攑ֈ Module class 中来做到q一炏V?br />
% cat dslhelper.rb
class Module
def dsl_accessor(*symbols) symbols.each { |sym| class_eval %{ def #{sym}(*val) if val.empty? @#{sym}
else @#{sym} = val.size == 1 ? val[0] : val
end end } } end end
上面的代码简单的定义了一?dsl_accessor ҎQ?它是我们的DSL特定的访问方法。现在我们用它取代attr_accessorQ?br />
% cat mydsl4.rb
require 'dslhelper'
class MyDSL
dsl_accessor :name, :parameter
def self.load(filename)
# ... same as before
end end#class MyDSL
再一ơ,我们更新dsl-loader.rb 中的require 语句Q加载mydsl4.rbQ?然后q行loader:
% ruby dsl-loader.rb params.dsl
#
["@parameter", "@name"]
一
切都很好。但是如果我不能事先知道参数的名字怎么办? 在实际用中Q参数名应该可以qh生成?别害怕。有Ruby 在, 我们可以使用
method_missing 的威力。给 MyDSL加一个两行的ҎQ?我们可以用dsl_accessor
Ҏ需要随时定义新的属?attribute)?也就是说Q如果一个D赋予一个不存在的参敎ͼmethod_missing 会定义一?
getter 和一个setter Qƈ且将该D予新生成的参数?br />
% cat mydsl5.rb
require 'dslhelper'
class MyDSL
def method_missing(sym, *args) self.class.dsl_accessor sym
send(sym, *args)
end
def self.load(filename)
# ... Same as before
end end
% head -1 dsl-loader.rb
require 'mydsl5'
% ruby dsl-loader.rb params.dsl
#
["@parameter", "@name"]
哇!是不是感觉很好? 仅仅写了一点代码,我们有了一个可以读和定义Q意数目参数的分析器。还可以吧。但是如果最l用户不知道RubyQ且使用了与现存的Ruby Ҏ冲突的名字,怎么办? 举例来说Q如果我们的DSL文g包含以下内容Q?br />
% cat params_with_keyword.dsl
methods %w(one two three)
id 12345
% ruby dsl-loader.rb params_with_keyword.dsl
params_with_keyword.dsl:2:in `id': wrong number of arguments (1 for 0) (ArgumentError)
噢,
真不好意思。不q我们可以迅速的解决q个问题?q里要用C个类叫BlankSlate, 它最初是?Jim Weirich构思出来的?
用在q的BlankSlate 和Jim 的有l微的差别,因ؓ我们惌多保留一些功能?我们留下七个方法?
你可以试一试看看那些是l对需要的Q那些是用来辅助我们看MyDSL 的对象实例的内容?br />
% cat mydsl6.rb
require 'dslhelper'
class BlankSlate
instance_methods.each { |m| undef_method(m) unless %w(
__send__ __id__ send class
inspect instance_eval instance_variables
).include?(m)
} end#class BlankSlate
# MyDSL now inherits from BlankSlate
class MyDSL < BlankSlate
# ... nothing new here, move along...
end#class MyDSL
现在我们试一下加载包含关键字(keyword)的DSL 文gQ?我们会看C些更合理的东ѝ?br />
% head -1 dsl-loader.rb
require 'mydsl6'
% ruby dsl-loader.rb params_with_keyword.dsl
#
["@id", "@methods"]
?
以确信, 我们成功了?q是一个好消息Q?
我们可以L那些没用的方法,l予我们的最l用h自由的用参数名字的权利。但是不怎样Q请注意Q我们终I不能让最l用户完全自q使用参数名。这?
使用通用~程语言创徏DSL的一个缺点, 但我认ؓQ禁止最l用户用’class’作为参数名Q应该不会给我们的品销路带来多大的风险?br />
更复杂的DSL
?
们现在来实现更复杂的DSL Ҏ?不仅仅操作数据,而且要执行更具体的行为?
惌一下我们厌烦了在每ơ开始一个新的项目的时候,手动的生成一个通用的目录集和文仉?
如果Ruby可以帮我们做q些好了。更q一步,如果我们有一个小的DSL使得我们可以直接修改目目录l构而不用去~写低的代码,岂不更好?br />
我们现在开始ؓq个问题定义一个DSL?下面的文件是q个DSL ?.01 版本Q?br />
% cat project_template.dsl
create_project do
dir "bin" do
create_from_template :exe, name
end
dir "lib" do
create_rb_file name
dir name do
create_rb_file name
end
end
dir "test"
touch :CHANGELOG, :README, :TODO
end
?
q个DSL文g里,我们生成了一个项目,在其中加了三个目录和三个文g。在’bin ?
目录中,我们使用?exe’模板生成了一个与目名字同名的可执行文g。在’lib’目录,我们生成了一?rb 文g和一个目录,
都与目名字同名。在q个内部子目录中Q又生成另一个与目名字同名的?rb?
文g。最后,在项目顶U目录下Q生成了一个’test’目录,和三个空文g?br />
q个DSL需要的Ҏ(method)是:create_project,dir,create_from_template,create_rb_file, 以及 touch?让我们逐个的看一下这些方法?br />
Ҏcreate_project是最外层的壳QwrapperQ?q个Ҏ提供了一个作用域让我们将所有的DSL代码都放在一个块(block)中。(完整的代码列表请看文章的最后)
def create_project()
yield
end
Ҏdir 完成实质性的工作。该Ҏ不仅仅生成目录,而且当前的工作目录保存在实例变?@cwd中?在这里,使用ensure 来保证@cwd 的始l有正确的倹{?br />
def dir(dir_name)
old_cwd = @cwd
@cwd = File.join(@cwd, dir_name)
FileUtils.mkdir_p(@cwd)
yield self if block_given?
ensure
@cwd = old_cwd
end
Ҏtouch ?create_rb_file 基本是一LQ除了后面一个给文g名加了一个后~’rb’以外?q些Ҏ可以接受一个或多个文g名,q些名字可以是字W串或符PsymbolsQ?br />
def touch(*file_names)
file_names.flatten.each { |file|
FileUtils.touch(File.join(@cwd, "#{file}"))
}
end
最后,Ҏcreate_from_template 是一个粗略的例子用于说明怎么样可以在一个DSL中实C些实际的功能?L代码的完整列?
Zq行q些代码Q我们构Z一个小的测试应用?br />
% cat create_project.rb
require 'project_builder'
project_name = ARGV.shift
proj = ProjectBuilder.load(project_name)
puts "== DIR TREE OF PROJECT '#{project_name}' =="
puts `find #{project_name}`
q行l果是:
% ruby create_project.rb fred
== DIR TREE OF PROJECT 'fred' ==
fred
fred/bin
fred/bin/fred
fred/CHANGELOG
fred/lib
fred/lib/fred
fred/lib/fred/fred.rb
fred/lib/fred.rb
fred/README
fred/test
fred/TODO
% cat fred/bin/fred
#!/usr/bin/env ruby
require 'rubygems'
require 'commandline
require 'fred'
class FredApp < CommandLine::Application
def initialize
end
def main
end
end#class FredApp
哇!工作得很好?q且没费多少力气?br />
ȝ
我做q的很多目要求一个非常详l的控制描q?在每个项目中Q这常常让我停下来ƈ思考怎么这些详l的配置数据引入到应用(applicationQ中?现在QRuby作ؓ一个DSLQ几乎是最适合的,而且常常可以非常高效和快速的解决问题?br />
?
培训Ruby
的时候,我会让整个班U用以下Ҏ来解决问题,我们先用p来描q问题,然后用伪代码Q然后用Ruby。但是,在某些情况下Q伪代码是合法?
Ruby 代码?我认为,Ruby的高度可L?Ruby是一个可用做DSL的理惌a?当Ruby 为更多的人所了解Q?用Ruby
写的DSL 成Z个与应用通信的流行的方式
目 ProjectBuilder DSL 的代码列表:
% cat project_builder.rb
require 'fileutils'
class ProjectBuilder
PROJECT_TEMPLATE_DSL = "project_template.dsl"
attr_reader :name
TEMPLATES = {
:exe =>
<<-EOT
#!/usr/bin/env ruby
require 'rubygems'
require 'commandline
require '%name%'
class %name.capitalize%App < CommandLine::Application
def initialize
end
def main
end
end#class %name.capitalize%App
EOT
}
def initialize(name)
@name = name
@top_level_dir = Dir.pwd
@project_dir = File.join(@top_level_dir, @name)
FileUtils.mkdir_p(@project_dir)
@cwd = @project_dir
end
def create_project
yield
end
def self.load(project_name, dsl=PROJECT_TEMPLATE_DSL)
proj = new(project_name)
proj = proj.instance_eval(File.read(dsl), dsl)
proj
end
def dir(dir_name)
old_cwd = @cwd
@cwd = File.join(@cwd, dir_name)
FileUtils.mkdir_p(@cwd)
yield self if block_given?
ensure
@cwd = old_cwd
end
def touch(*file_names)
file_names.flatten.each { |file|
FileUtils.touch(File.join(@cwd, "#{file}"))
}
end
def create_rb_file(file_names)
file_names.each { |file| touch(file + ".rb") }
end
def create_from_template(template_id, filename)
File.open(File.join(@cwd, filename), "w+") { |f|
str = TEMPLATES[template_id]
str.gsub!(/%[^%]+%/) { |m| instance_eval m[1..-2] }
f.puts str
}
end
end#class ProjectBuilder
# Execute as:
# ruby create-project.rb project_name
资源
1QBlankSlate 是一个Ruby class,用于产生没有Ҏ(method-free)的对象实例?参见Q?br />http://onestepback.org/index.cgi/Tech/Ruby/BlankSlate.rdoc
2QJimWeirich是BlankSlate 的创,也是很多著名的Ruby 工具和库的创?br />http://onestepback.org
关于作?/h3>
Jim Freeze ?001q初学习Ruby以来Q一直是 Ruby 的热p?br />Jim ?CommandLine and Stax gems 的作?img src ="http://www.aygfsteel.com/Vencent/aggbug/54086.html" width = "1" height = "1" />
]]>