我有一个典型的 OO 模式:一个基本抽象类(定义抽象方法)和几个以特定于类的方式实现这些抽象方法的类。
我习惯于在抽象方法中只编写一次文档，然后它会自动传播到几个具体类(至少它在 Javadoc、Scaladoc、Doxygen 中按以下方式工作)，即我不需要重复所有具体类中的相同描述。
但是，我找不到如何在 YARD 中进行此类传播。我试过，例如:
# Some description of abstract class.
# @abstract
class AbstractClass
# Some method description.
# @return [Symbol] some return description
# @abstract
def do_something
raise AbstractMethodException.new
end
end
class ConcreteClass < AbstractClass
def do_something
puts "Real implementation here"
return :foo
end
end
我得到的:
AbstractMethodException 在抽象类中调用，在具体类中完成工作AbstractClass明确定义为abstract，ConcreteClass为normalAbstractClass中很好AbstractClass 中抛出 AbstractMethodExceptionConcreteClass中完全没有描述和泛型Object返回类型，没有一条关于基类中存在抽象方法的通知。我期望得到的:
AbstractClass 的信息继承(即复制)到 ConcreteClassConcreteClass 描述的“继承”或“实现”部分指定，并带有从 ConcreteClass#do_something 到 AbstractMethod# 的一些引用链接做点什么。有可能吗？
最佳答案
我认为问题归结为您要执行的操作。看起来您正在尝试在 Ruby 中实现一个接口(interface)，如果您来自 Java 或 .NET，这很有意义，但实际上并不是 Ruby 开发人员的工作方式。
这里有一些关于 Ruby 接口(interface)的典型思想的信息:What is java interface equivalent in Ruby?
就是说，我明白你想做什么。如果您不希望直接实现您的 AbstractClass，但您想要定义可以在行为类似于 AbstractClass 规定的类中使用的方法(如 Design by Contract 中)，那么您可能想要使用模块。模块可以很好地保存您的代码 DRY , 但它们并不能完全解决与记录 overridden methods 相关的问题.因此，在这一点上，我认为您可以重新考虑处理文档的方式，或者至少以更像 Ruby 的方式处理它。
Ruby 中的继承实际上(根据我自己的经验一般而言)仅出于以下几个原因使用:
显然还有其他边缘情况，但老实说，这就是 Ruby 中倾向于使用继承的情况。这并不意味着您正在做的事情不会起作用或违反某些规则，这在 Ruby(或大多数动态类型语言)中并不典型。这种非典型行为可能是 YARD(和其他 Ruby 文档生成器)没有按照您的预期进行的原因。也就是说，创建一个仅定义子类中必须存在的方法的抽象类，从代码的角度来看确实对您没有什么好处。未定义的方法无论如何都会导致抛出 NoMethodError 异常，您可以使用 #respond_to?(: some_method) (或其他用于获取元内容的反射工具)。这一切都归结为 Ruby 对 Duck Typing 的使用.
对于纯文档，为什么要记录一个您实际上并不使用的方法？您不应该真正关心通过调用方法发送或接收的对象的类，只需关心那些对象响应。因此，如果它在这里没有增加任何实际值(value)，请不要首先创建您的 AbstractClass。如果它包含您实际上将直接调用而不覆盖的方法，则创建一个模块，在那里记录它们，然后运行 $ yardoc --embed-mixins 以包含在混合中定义的方法(及其描述)模块。否则，记录您实际实现它们的方法，因为每个实现应该不同(否则为什么要重新实现它)。
以下是我希望与您正在做的类似的事情:
# An awesome Module chock-full of reusable code
module Stuff
# A powerful method for doing things with stuff, mostly turning stuff into a Symbol
def do_stuff(thing)
if thing.kind_of?(String)
return thing.to_sym
else
return thing.to_s.to_sym
end
end
end
# Some description of the class
class ConcreteClass
include Stuff
# real (and only implementation)
def do_something
puts "Real implementation here"
return :foo
end
end
an_instance = ConcreteClass.new
an_instance.do_somthing # => :foo
# > Real implementation here
an_instance.do_stuff("bar") # => :bar
运行 YARD(使用 --embed-mixins)将包括从 Stuff 模块中混入的方法(以及它们的描述)，您现在知道包括 Stuff 模块在内的任何对象都将具有您期望的方法。
您可能还想看看 Ruby Contracts ，因为它可能更接近您正在寻找的绝对强制方法只接受和返回您想要的对象类型，但我不确定这将如何与 YARD 一起玩。
关于 ruby 场 : documenting abstract methods implementations，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/19379145/
我正在学习如何使用Nokogiri，根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div
总的来说，我对ruby还比较陌生，我正在为我正在创建的对象编写一些rspec测试用例。许多测试用例都非常基础，我只是想确保正确填充和返回值。我想知道是否有办法使用循环结构来执行此操作。不必为我要测试的每个方法都设置一个assertEquals。例如:describeitem,"TestingtheItem"doit"willhaveanullvaluetostart"doitem=Item.new#HereIcoulddotheitem.name.shouldbe_nil#thenIcoulddoitem.category.shouldbe_nilendend但我想要一些方法来使用
我有一个字符串input="maybe(thisis|thatwas)some((nice|ugly)(day|night)|(strange(weather|time)))"Ruby中解析该字符串的最佳方法是什么？我的意思是脚本应该能够像这样构建句子:maybethisissomeuglynightmaybethatwassomenicenightmaybethiswassomestrangetime等等，你明白了......我应该一个字符一个字符地读取字符串并构建一个带有堆栈的状态机来存储括号值以供以后计算，还是有更好的方法？也许为此目的准备了一个开箱即用的库？
我有一个Ruby程序，它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重，我想提高压缩级别，因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗？是否有另一个允许指定压缩级别的Ruby库？ 最佳答案 这是我通过查看rubyzip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d
类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc
很好奇，就使用rubyonrails自动化单元测试而言，你们正在做什么？您是否创建了一个脚本来在cron中运行rake作业并将结果邮寄给您？git中的预提交Hook？只是手动调用？我完全理解测试，但想知道在错误发生之前捕获错误的最佳实践是什么。让我们理所当然地认为测试本身是完美无缺的，并且可以正常工作。下一步是什么以确保他们在正确的时间将可能有害的结果传达给您？ 最佳答案 不确定您到底想听什么，但是有几个级别的自动代码库控制:在处理某项功能时，您可以使用类似autotest的内容获得关于哪些有效，哪些无效的即时反馈。要确保您的提
这似乎应该有一个直截了当的答案，但在Google上花了很多时间，所以我找不到它。这可能是缺少正确关键字的情况。在我的RoR应用程序中，我有几个模型共享一种特定类型的字符串属性，该属性具有特殊验证和其他功能。我能想到的最接近的类似示例是表示URL的字符串。这会导致模型中出现大量重复(甚至单元测试中会出现更多重复)，但我不确定如何让它更DRY。我能想到几个可能的方向...按照“validates_url_format_of”插件，但这只会让验证干给这个特殊的字符串它自己的模型，但这看起来很像重溶液为这个特殊的字符串创建一个ruby类，但是我如何得到ActiveRecord关联这个类模型
假设我做了一个模块如下:m=Module.newdoclassCendend三个问题:除了对m的引用之外，还有什么方法可以访问C和m中的其他内容？我可以在创建匿名模块后为其命名吗(就像我输入“module...”一样)？如何在使用完匿名模块后将其删除，使其定义的常量不再存在？ 最佳答案 三个答案:是的，使用ObjectSpace.此代码使c引用你的类(class)C不引用m:c=nilObjectSpace.each_object{|obj|c=objif(Class===objandobj.name=~/::C$/)}当然这取决于
我试图在一个项目中使用rake，如果我把所有东西都放到Rakefile中，它会很大并且很难读取/找到东西，所以我试着将每个命名空间放在lib/rake中它自己的文件中，我添加了这个到我的rake文件的顶部:Dir['#{File.dirname(__FILE__)}/lib/rake/*.rake'].map{|f|requiref}它加载文件没问题，但没有任务。我现在只有一个.rake文件作为测试，名为“servers.rake”，它看起来像这样:namespace:serverdotask:testdoputs"test"endend所以当我运行rakeserver:testid时
出于纯粹的兴趣，我很好奇如何按顺序创建PI，而不是在过程结果之后生成数字，而是让数字在过程本身生成时显示。如果是这种情况，那么数字可以自行产生，我可以对以前看到的数字实现垃圾收集，从而创建一个无限系列。结果只是在Pi系列之后每秒生成一个数字。这是我通过互联网筛选的结果:这是流行的计算机友好算法，类机器算法:defarccot(x,unity)xpow=unity/xn=1sign=1sum=0loopdoterm=xpow/nbreakifterm==0sum+=sign*(xpow/n)xpow/=x*xn+=2sign=-signendsumenddefcalc_pi(digits