bones 3.0.1 → 3.1.0

data/History.txt

@@ -1,3 +1,8 @@
+== 3.1.0 / 2009-10-21
+
+* 1 minor enhancements
+  - Adding YARD documentaiton generating task
+
 == 3.0.1 / 2009-10-08
 
 * 2 bug fixes

data/Rakefile

@@ -14,6 +14,7 @@ Bones {
   ruby_opts    %w[-W0]
   readme_file  'README.rdoc'
   ignore_file  '.gitignore'
+  rubyforge.name 'codeforpeople'
 
   spec.opts << '--color'
   notes.exclude %w[^README\.rdoc$ ^data/]

data/lib/bones.rb

@@ -13,7 +13,7 @@ module Bones
   extend LittlePlugger
 
   # :stopdoc:
-  VERSION = '3.0.1'
+  VERSION = '3.1.0'
   PATH = File.expand_path(File.join(File.dirname(__FILE__), '..'))
   LIBPATH = File.expand_path(File.join(PATH, 'lib'))
   HOME = File.expand_path(ENV['HOME'] || ENV['USERPROFILE'])

data/lib/bones/plugins/rdoc.rb

@@ -79,8 +79,10 @@ module Bones::Plugins::Rdoc
       end
     end  # namespace :doc
 
-    desc 'Alias to doc:rdoc'
-    task :doc => 'doc:rdoc'
+    unless have? :yard
+      desc 'Alias to doc:rdoc'
+      task :doc => 'doc:rdoc'
+    end
 
     desc 'Remove all build products'
     task :clobber => %w(doc:clobber_rdoc doc:clobber_ri)

data/lib/bones/plugins/yard.rb

@@ -0,0 +1,90 @@
+
+module Bones::Plugins::Yard
+  include ::Bones::Helpers
+  extend self
+
+  def initialize_yard
+    require 'yard'
+    require 'yard/rake/yardoc_task'
+    have?(:yard) { true }
+
+    # FIXME This is a monkey-patch till yard fixes the namespace method collision
+    Module.class_eval 'remove_method :namespace'
+
+    ::Bones.config {
+      desc 'Configuration settings for yard'
+      yard {
+
+        opts  [], :desc => 'Array of yard options to use when generating documentation.'
+
+        include  %w(^lib/ ^bin/ ^ext/ \.txt$ \.rdoc$), :desc => <<-__
+          An array of patterns that will be used to find the files for which
+          documentation should be generated. This is an array of strings that
+          will be converted in regular expressions.
+        __
+
+        exclude  %w(extconf\.rb$), :desc => <<-__
+          An array of patterns that will be used to exclude files from yard
+          processing. This is an array of strings that will be converted in
+          regular expressions.
+        __
+
+        main  nil, :desc => <<-__
+          The main yard file for the project. This defaults to the project's
+          README file.
+        __
+
+        dir  'doc', :desc => 'Output directory for generated documentation.'
+      }
+    }
+  rescue LoadError
+    have?(:yard) { false }
+  end
+
+  def post_load
+    return unless have? :yard
+    config = ::Bones.config
+
+    config.exclude << "^#{Regexp.escape(config.yard.dir)}/"
+    config.yard.main ||= config.readme_file
+  end
+
+  def define_tasks
+    return unless have?(:yard)
+    config = ::Bones.config
+
+    namespace :doc do
+      desc 'Generate Yard documentation'
+      YARD::Rake::YardocTask.new(:yard) do |yd|
+        yard = config.yard
+
+        incl = Regexp.new(yard.include.join('|'))
+        excl = Regexp.new(yard.exclude.join('|'))
+        yd.files = config.gem.files.find_all do |fn|
+                     case fn
+                     when excl; false
+                     when incl; true
+                     else false end
+                   end
+
+        yd.options << '--main' << yard.main
+        yd.options << '--output-dir' << yard.dir
+        yd.options << '--title' << "#{config.name}-#{config.version} Documentation"
+
+        yd.options.concat(yard.opts)
+      end
+
+      task :clobber_yard do
+        rm_r config.yard.dir rescue nil
+      end
+    end  # namespace :doc
+
+    desc 'Alias to doc:yard'
+    task :doc => 'doc:yard'
+
+    task :clobber => %w(doc:clobber_yard)
+  end
+
+end
+
+# EOF

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bones
 version: !ruby/object:Gem::Version 
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors: 
 - Tim Pease
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-08 00:00:00 -07:00
+date: 2009-11-21 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,7 +50,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.2.8
+        version: 1.2.9
     version: 
 - !ruby/object:Gem::Dependency 
   name: bones-git
@@ -60,7 +60,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.0.0
+        version: 1.1.1
     version: 
 - !ruby/object:Gem::Dependency 
   name: bones-extras
@@ -70,7 +70,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.0.1
+        version: 1.1.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: bones
@@ -80,7 +80,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 3.0.1
+        version: 3.1.0
     version: 
 description: |-
   Mr Bones is a handy tool that creates new Ruby projects from a code
@@ -131,6 +131,7 @@ files:
 - lib/bones/plugins/notes.rb
 - lib/bones/plugins/rdoc.rb
 - lib/bones/plugins/test.rb
+- lib/bones/plugins/yard.rb
 - lib/bones/smtp_tls.rb
 - spec/bones/app/file_manager_spec.rb
 - spec/bones/app_spec.rb
@@ -172,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: bones
+rubyforge_project: codeforpeople
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3