Permalink
Browse files

Switch to YARD.

  • Loading branch information...
1 parent f094da6 commit 03d8d13867b7fd2bb4e5ce53eabc8ab09fb2527d @MrJoy MrJoy committed Aug 22, 2012
Showing with 58 additions and 70 deletions.
  1. +6 −0 .document
  2. +7 −7 .gitignore
  3. +1 −0 .yardopts
  4. +11 −5 History.txt → CHANGELOG.rdoc
  5. +3 −1 Gemfile
  6. +3 −4 README.rdoc
  7. +13 −26 Rakefile
  8. +12 −0 TODO.rdoc
  9. +2 −2 annotate.gemspec
  10. +0 −25 todo.txt
View
@@ -0,0 +1,6 @@
+spec/**/*.rb
+lib/**/*.rb
+-
+README.rdoc
+CHANGELOG.rdoc
+TODO.rdoc
View
@@ -1,11 +1,11 @@
.DS_Store
-doc/*
-rdoc/*
-coverage/*
-spec/debug.log
-pkg/*
-dist
-Gemfile.lock
+/.yardoc/*
+/doc/*
+/coverage/*
+/spec/debug.log
+/pkg/*
+/dist
+/Gemfile.lock
*.gem
/.idea/
.rvmrc
View
@@ -0,0 +1 @@
+--no-private
@@ -6,11 +6,16 @@
* Recognize column+type, and don't change a file unless the column+type combination of the new schema are different than that of the old (i.e., don't regenerate if columns happen to be in a different order. That's just how life is sometimes.)
* Grab old specification even if it has \r\n as line endings rather than pure \ns
* Various warning and specification fixes
-* Fix "no such file to load -- annotate/annotate_models (MissingSourceFile)" error (require statements in tasks now use full path to lib files)
-* warn about macros, to mitigate when we're included during a production run, not just a rakefile run -- possibly at the expense of too much noise
+* Fix "no such file to load -- annotate/annotate_models (MissingSourceFile)"
+ error (require statements in tasks now use full path to lib files)
+* warn about macros, to mitigate when we're included during a production run,
+ not just a rakefile run -- possibly at the expense of too much noise
* Adding rake as a runtime dependency
-* If the schema is already in the model file, it will be replaced into the same location. If it didn't previously exist, it'll be placed according to the "position", as before.
-* Allow task loading from Rakefile for gems (plugin installation already auto-detects).
+* If the schema is already in the model file, it will be replaced into the same
+ location. If it didn't previously exist, it'll be placed according to the
+ "position", as before.
+* Allow task loading from Rakefile for gems (plugin installation already
+ auto-detects).
* Add skip_on_db_migrate option as well for people that don't want it
* Fix options parsing to convert strings to proper booleans
* Add support for Fabrication fabricators
@@ -72,7 +77,8 @@
== 2.4.0 2009-12-13
-* Incorporated lots of patches from the Github community, including support for Blueprints fixtures
+* Incorporated lots of patches from the Github community, including support for
+ Blueprints fixtures
* Several bug fixes
== 2.1 2009-10-18
View
@@ -6,8 +6,10 @@ group :development do
gem 'mg'
gem 'rspec'
gem 'wrong', '>=0.6.2'
- gem 'rdoc'
gem 'files', '>=0.2.1'
+ platforms :ruby do
+ gem 'yard', :require => false
+ end
end
gem 'activesupport', '>= 3.0.0', :require => nil
View
@@ -129,10 +129,9 @@ annotation are consistent regardless of what order migrations are executed in, u
== WARNING
-Note that this code will blow away the initial/final comment
-block in your models if it looks like it was previously added
-by annotate models, so you don't want to add additional text
-to an automatically created comment block.
+Note that this code will blow away the initial/final comment block in your
+models if it looks like it was previously added by this gem, so you don't want
+to add additional text to an automatically created comment block.
BACK UP YOUR MODELS BEFORE USING THIS TOOL!
View
@@ -19,38 +19,25 @@ require "#{here}/lib/annotate"
# want other tests/tasks run by default? Add them to the list
task :default => [:spec]
-# mg ("minimalist gems") defines rake tasks:
-#
-# rake gem
-# Build gem into dist/
-#
-# rake gem:publish
-# Push the gem to RubyGems.org
-#
-# rake gem:install
-# Build and install as local gem
-#
-# rake package
-# Build gem and tarball into dist/
-begin
- require 'mg'
-rescue LoadError
- abort "Please `gem install mg`"
-end
+require 'mg'
MG.new("annotate.gemspec")
-task :default => :spec
-
require "rspec/core/rake_task" # RSpec 2.0
RSpec::Core::RakeTask.new(:spec) do |t|
t.pattern = ['spec/*_spec.rb', 'spec/**/*_spec.rb']
t.rspec_opts = ['--backtrace', '--format d']
end
-require 'rdoc/task'
-RDoc::Task.new do |rdoc|
- rdoc.rdoc_dir = 'rdoc'
- rdoc.title = "annotated_models #{Annotate.version}"
- rdoc.rdoc_files.include('README*')
- rdoc.rdoc_files.include('lib/**/*.rb')
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+ # t.files = ['features/**/*.feature', 'features/**/*.rb', 'lib/**/*.rb']
+ # t.options = ['--any', '--extra', '--opts'] # optional
+end
+
+namespace :yard do
+ task :clobber do
+ FileUtils.rm_f(".yardoc")
+ FileUtils.rm_f("doc")
+ end
end
+task :clobber => :'yard:clobber'
View
@@ -0,0 +1,12 @@
+== TODO
+
+- clean up history
+- change default position back to "top" for all annotations
+- add "top" and "bottom" as synonyms for "before" and "after"
+- change 'exclude' to 'only' (double negatives are not unconfusing)
+
+== TODO (proposed)
+
+- push two identical gems, named 'annotate' and 'annotate_models'
+- supply two binaries, named 'annotate' and 'annotate_models', since there's already a unix tool named 'annotate'
+- test EVERYTHING
View
@@ -10,9 +10,9 @@ Gem::Specification.new do |s|
s.email = ["alex@stinky.com", "ctran@pragmaquest.com", "x@nofxx.com", "turadg@aleahmad.net"]
s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
- s.extra_rdoc_files = ["README.rdoc"]
+ s.extra_rdoc_files = ["README.rdoc", "CHANGELOG.rdoc", "TODO.rdoc"]
- s.files = %w( README.rdoc History.txt )
+ s.files = %w( README.rdoc CHANGELOG.rdoc TODO.rdoc )
s.files += Dir.glob("lib/**/*")
s.files += Dir.glob("tasks/**/*")
s.files += ["bin/annotate"] # todo: annotate_models
View
@@ -1,25 +0,0 @@
-TODO
------
-
-* clean up history
-* change default position back to "top" for all annotations
-* add "top" and "bottom" as synonyms for "before" and "after"
-* change 'exclude' to 'only' (double negatives are not unconfusing)
-
-TODO (proposed)
-----------------
-* make a mailing list
- alex@stinky.com
- ctran@pragmaquest.com
- x@nofxx.com
- turadg@aleahmad.net
- jfrisby@mrjoy.com
- Jack Danger Canty
- peterpunk
- Ian Duggan
- Bill Harding
-
-* push two identical gems, named 'annotate' and 'annotate_models'
-* supply two binaries, named 'annotate' and 'annotate_models', since there's already a unix tool named 'annotate'
-* test EVERYTHING
-

0 comments on commit 03d8d13

Please sign in to comment.