Switch to yard

This commit is contained in:
Joe Ferris 2011-02-07 17:48:00 -05:00
parent 5aea0f4096
commit a7828ffff1
6 changed files with 18 additions and 20 deletions

5
.gitignore vendored
View File

@ -1,5 +1,6 @@
*.swp
test.db
factory_girl-*.gem
rdoc
coverage
doc
.yardoc
coverage

3
.yardopts Normal file
View File

@ -0,0 +1,3 @@
lib/**/*.rb
-
LICENSE

View File

@ -7,4 +7,6 @@ gem "activerecord", :require => false
gem "rr"
gem "sqlite3-ruby", :require => false
gem "appraisal"
gem "yard"
gem "bluecloth"

View File

@ -16,6 +16,7 @@ GEM
rake
arel (1.0.1)
activesupport (~> 3.0.0)
bluecloth (2.0.9)
builder (2.1.2)
cucumber (0.9.4)
builder (~> 2.1.2)
@ -43,6 +44,7 @@ GEM
sqlite3-ruby (1.3.2)
term-ansicolor (1.0.5)
tzinfo (0.3.23)
yard (0.6.4)
PLATFORMS
ruby
@ -50,9 +52,11 @@ PLATFORMS
DEPENDENCIES
activerecord
appraisal
bluecloth
cucumber
rake
rcov
rr
rspec (~> 2.0)
sqlite3-ruby
yard

View File

@ -1,13 +1,13 @@
require 'rubygems'
require 'bundler/setup'
require 'rake'
require 'rake/rdoctask'
require 'rcov/rcovtask'
require 'date'
require 'rake/gempackagetask'
require 'rspec/core/rake_task'
require 'cucumber/rake/task'
require 'appraisal'
require 'yard'
desc 'Default: run the specs and features.'
task :default => 'spec:unit' do
@ -35,23 +35,8 @@ Rcov::RcovTask.new do |t|
t.verbose = true
end
desc 'Generate documentation for the factory_girl plugin.'
Rake::RDocTask.new(:rdoc) do |rdoc|
rdoc.rdoc_dir = 'rdoc'
rdoc.title = 'Factory Girl'
rdoc.options << '--line-numbers' << "--main" << "README.rdoc"
rdoc.rdoc_files.include('README.rdoc')
rdoc.rdoc_files.include('CONTRIBUTION_GUIDELINES.rdoc')
rdoc.rdoc_files.include('lib/**/*.rb')
end
desc 'Update documentation on website'
task :sync_docs => 'rdoc' do
`rsync -ave ssh rdoc/ dev@dev.thoughtbot.com:/home/dev/www/dev.thoughtbot.com/factory_girl`
end
desc "Clean files generated by rake tasks"
task :clobber => [:clobber_rdoc, :clobber_rcov]
task :clobber => [:clobber_rcov]
Cucumber::Rake::Task.new(:features) do |t|
t.fork = true
@ -64,3 +49,6 @@ Rake::GemPackageTask.new($specification) do |package|
package.need_tar = true
end
YARD::Rake::YardocTask.new do |t|
end

View File

@ -22,7 +22,7 @@ module FactoryGirl
#
# Arguments:
# * name: +Symbol+ or +String+
# The name of this attribute. This will be assigned using :"#{name}=" for
# The name of this attribute. This will be assigned using "name=" for
# generated instances.
# * value: +Object+
# If no block is given, this value will be used for this attribute.