bones-yard 1.0.0

data/History.txt

@@ -0,0 +1,4 @@
+== 1.0.0 / 2010-10-17
+
+* 1 major enhancement
+  * Birthday!

data/README.txt

@@ -0,0 +1,37 @@
+bones-yard
+    by Tim Pease
+    http://rubygems.org/gems/bones-yard
+
+== DESCRIPTION:
+
+The yard package for Mr Bones provides tasks to incorporate Yard based
+documentation into bones based projects.
+
+== INSTALL:
+
+  gem install bones-yard
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,20 @@
+
+begin
+  require 'bones'
+rescue LoadError
+  abort '### Please install the "bones" gem ###'
+end
+
+Bones {
+  name         'bones-yard'
+  authors      'Tim Pease'
+  email        'tim.pease@gmail.com'
+  url          'http://github.com/TwP/bones-yard'
+  ignore_file  '.gitignore'
+
+  depend_on    'bones'
+  depend_on    'yard', '>= 0.5.8'
+
+  use_gmail
+}
+

data/lib/bones/plugins/rubyforge.rb

@@ -0,0 +1,87 @@
+
+module Bones::Plugins::Rubyforge
+  include ::Bones::Helpers
+  extend self
+
+  def initialize_rubyforge
+    require 'rubyforge'
+    require 'rake/contrib/sshpublisher'
+    have?(:rubyforge) { true }
+
+    ::Bones.config {
+      desc 'Configuration settings for RubyForge publishing.'
+      rubyforge {
+        name nil, :desc => <<-__
+          The RubyForge project name where your code will be published. If not
+          supplied, the RubyForge name will default to the base 'name' of your
+          gem. The RubyForge name is used when your gem name differs from the
+          registered project name; for example if you release multiple gems
+          under the same project.
+        __
+      }
+
+      rdoc {
+        remote_dir nil, :desc => <<-__
+          This is the remote directory to use when publishing RDoc HTML
+          documentation to your RubyForge project page. If not specified, this
+          defaults to the root of the project page.
+        __
+      }
+    }
+  rescue LoadError
+    have?(:rubyforge) { false }
+  end
+
+  def post_load
+    return unless have? :rubyforge
+    config = ::Bones.config
+    config.rubyforge.name ||= config.name
+  end
+
+  def define_tasks
+    return unless have? :rubyforge
+    config = ::Bones.config
+
+    namespace :rubyforge do
+      desc 'Package gem and upload to RubyForge'
+      task :release => ['gem:clobber_package', 'gem:package'] do |t|
+        v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
+        abort "Versions don't match #{v} vs #{config.version}" if v != config.version
+        pkg = "pkg/#{config.gem._spec.full_name}"
+
+        rf = RubyForge.new
+        rf.configure rescue nil
+        puts 'Logging in'
+        rf.login
+
+        c = rf.userconfig
+        c['release_notes'] = config.description if config.description
+        c['release_changes'] = config.changes if config.changes
+        c['preformatted'] = true
+
+        files = Dir.glob("#{pkg}*.*")
+
+        puts "Releasing #{config.name} v. #{config.version}"
+        rf.add_release config.rubyforge.name, config.name, config.version, *files
+      end
+
+      desc 'Publish RDoc to RubyForge'
+      task :doc_release => %w(doc:clobber_rdoc doc:rdoc) do
+        rubyforge_config = YAML.load(
+          File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{rubyforge_config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/#{config.rubyforge.name}/"
+        remote_dir << config.rdoc.remote_dir if config.rdoc.remote_dir
+        local_dir = config.rdoc.dir
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+
+  end
+
+end  # module Bones::Plugins::Rubyforge
+
+# EOF

data/lib/bones/plugins/yard.rb

@@ -0,0 +1,86 @@
+
+module Bones::Plugins::Yard
+  include ::Bones::Helpers
+  extend self
+
+  def initialize_yard
+    require 'yard'
+    require 'yard/rake/yardoc_task'
+    have?(:yard) { true }
+
+    ::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

data/version.txt

@@ -0,0 +1 @@
+1.0.0

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification 
+name: bones-yard
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Tim Pease
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-17 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bones
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 3
+        - 5
+        - 0
+        version: 3.5.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 5
+        - 8
+        version: 0.5.8
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bones
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 3
+        - 5
+        - 0
+        version: 3.5.0
+  type: :development
+  version_requirements: *id003
+description: |-
+  The yard package for Mr Bones provides tasks to incorporate Yard based
+  documentation into bones based projects.
+email: tim.pease@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- README.txt
+- version.txt
+files: 
+- History.txt
+- README.txt
+- Rakefile
+- lib/bones/plugins/rubyforge.rb
+- lib/bones/plugins/yard.rb
+- version.txt
+has_rdoc: true
+homepage: http://github.com/TwP/bones-yard
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: bones-yard
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: The yard package for Mr Bones provides tasks to incorporate Yard based documentation into bones based projects
+test_files: []
+