hoe-yard 0.1.0

data/History.rdoc

@@ -0,0 +1,11 @@
+=== 0.1.0 / 2010-01-08
+
+* Initial release:
+  * Automatically find the README and History files, irregardless of file
+    extension.
+  * Sets +has_rdoc+ to +yard+.
+  * Sets +rdoc_options+.
+  * Sets +extra_rdoc_files+.
+  * Adds YARD and hoe-yard as development dependencies.
+  * Adds the +yard+ and +docs+ Rake tasks.
+

data/Manifest.txt

@@ -0,0 +1,5 @@
+History.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+lib/hoe/yard.rb

data/README.rdoc

@@ -0,0 +1,73 @@
+= hoe-yard
+
+* http://github.com/postmodern/hoe-yard
+* http://github.com/postmodern/hoe-yard/issues
+* Postmodern (postmodern.mod3 at gmail.com)
+
+== DESCRIPTION:
+
+A Hoe plugin for generating YARD documentation.
+
+Using the Hoe YARD plugin, projects can begin generating YARD documentation
+instantly. Additionally, any resulting RubyGems will be properly configured
+to automatically generate YARD documentation upon installation.
+
+== FEATURES:
+
+* Automatically find the README and History files, irregardless of file
+  extension.
+* Sets +has_rdoc+ to +yard+.
+* Sets +rdoc_options+.
+* Sets +extra_rdoc_files+.
+* Adds YARD and hoe-yard as development dependencies.
+* Adds the +yard+ and +docs+ Rake tasks.
+
+== REQUIREMENTS:
+
+* {yard}[http://yardoc.org/] >= 0.2.3.1
+
+== INSTALL:
+
+  $ sudo gem install hoe-yard
+
+== USAGE:
+
+  require 'rubygems'
+  require 'hoe'
+
+  Hoe.plugin :yard
+
+  Hoe.spec('my_project') do
+    # ...
+
+    self.yard_title = 'My Project'
+    self.yard_markup = :markdown
+    self.yard_opts = ['--protected']
+
+    # ...
+  end
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Hal Brodigan
+
+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,22 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require 'hoe/signing'
+require './lib/hoe/yard.rb'
+
+Hoe.plugin :yard
+
+Hoe.spec('hoe-yard') do
+  self.version = Hoe::Yard::PLUGIN_VERSION
+  self.developer('Postmodern', 'postmodern.mod3@gmail.com')
+
+  self.remote_yard_dir = '/'
+  self.yard_opts = ['--protected']
+
+  self.extra_deps = [
+    ['yard', '>=0.2.3.1']
+  ]
+end
+
+# vim: syntax=ruby

data/lib/hoe/yard.rb

@@ -0,0 +1,194 @@
+require 'hoe'
+
+gem 'yard'
+
+##
+# YARD plugin for hoe.
+#
+# === Tasks Provided:
+#
+# yard::              Generate YARD documentation
+# docs::              Generate YARD documentation
+#
+module Hoe::Yard
+  # hoe-yard version
+  PLUGIN_VERSION = '0.1.0'
+
+  # Supported markups
+  YARD_MARKUP = [:markdown, :texttile, :rdoc]
+
+  # File extensions indicating raw content
+  YARD_RAW_EXTS = ['.txt', '.html']
+
+  # File extensions for various markups
+  YARD_EXTS = {
+    :markdown => ['.markdown', '.md'],
+    :texttile => ['.texttile', '.tt'],
+    :rdoc => ['.rdoc']
+  }
+
+  # The default YARD template
+  YARD_DEFAULT_TEMPLATE = 'default'
+
+  # The default YARD format
+  YARD_DEFAULT_FORMAT = :html
+
+  # The default return-type for documented methods.
+  YARD_DEFAULT_RETURN_TYPE = 'Object'
+
+  # Title for the YARD documentation
+  attr_accessor :yard_title
+
+  # Markup style used in documentation, like textile, markdown or rdoc.
+  # (default: +:rdoc+)
+  attr_accessor :yard_markup
+
+  # Overrides the library used to process markup formatting
+  # (specify the gem name)
+  attr_accessor :yard_markup_provider
+
+  # Options to pass to YARD
+  attr_accessor :yard_opts
+
+  def initialize_yard
+    self.yard_title = Hoe.normalize_names(self.name).last + ' Documentation'
+    self.yard_markup = nil
+    self.yard_markup_provider = nil
+    self.yard_opts = []
+
+    # find the README.* and History.* files
+    self.readme_file = intuit_file_name(File.basename(self.readme_file))
+    self.history_file = intuit_file_name(File.basename(self.history_file))
+
+    # disable RDoc and ri tasks
+    self.need_rdoc = false
+
+    # add YARD as a development dependency
+    yard_version = Gem.loaded_specs['yard'].version
+    self.extra_dev_deps << ['yard', ">=#{yard_version}"]
+
+    # add hoe-yard as a development dependency
+    self.extra_dev_deps << ['hoe-yard', ">=#{PLUGIN_VERSION}"]
+
+    # we have YARD docs
+    self.spec_extras.merge!(:has_rdoc => 'yard')
+
+    if self.history_file
+      # include the history file
+      self.yard_files << self.history_file
+    end
+  end
+
+  def define_yard_tasks
+    require 'yard'
+
+    # generate the YARD options
+    opts = normalize_yard_opts
+
+    desc "Remove YARD products"
+    task :clobber_docs do
+      rm_rf local_yard_dir
+    end
+
+    # define the yard task
+    ::YARD::Rake::YardocTask.new do |t|
+      t.files = ['lib/**/*.rb']
+      t.options = opts + ['--files'] + self.yard_files
+    end
+    task :docs => :yard
+
+    # override the RDoc options
+    self.spec.rdoc_options = opts
+  end
+
+  protected
+
+  #
+  # Alias to <tt>Hoe#extra_rdoc_files</tt>.
+  #
+  def yard_files
+    self.extra_rdoc_files
+  end
+
+  #
+  # Alias to <tt>Hoe#extra_rdoc_files=</tt>.
+  #
+  def yard_files=(new_files)
+    self.extra_rdoc_files = new_files
+  end
+
+  #
+  # Alias to <tt>Hoe#local_rdoc_dir</tt>.
+  #
+  def local_yard_dir
+    self.local_rdoc_dir
+  end
+
+  #
+  # Alias to <tt>Hoe#local_yard_dir=</tt>.
+  #
+  def local_yard_dir=(new_dir)
+    self.local_rdoc_dir = new_dir
+  end
+
+  #
+  # Alias to <tt>Hoe#remote_rdoc_dir</tt>.
+  #
+  def remote_yard_dir
+    self.remote_rdoc_dir
+  end
+
+  #
+  # Alias to <tt>Hoe#remote_rdoc_dir=</tt>.
+  #
+  def remote_yard_dir=(new_dir)
+    self.remote_rdoc_dir = new_dir
+  end
+
+  #
+  # Intuitively finds the file with the given _name_, using the current
+  # YARD markup setting to guess the file extension.
+  #
+  def intuit_file_name(name)
+    name = name.gsub(/\.[^\.]+$/,'')
+    paths = Dir["#{name}.*"]
+
+    exts = if self.yard_markup
+             YARD_EXTS[self.yard_markup]
+           else
+             YARD_EXTS.values.flatten.uniq
+           end
+
+    # append the other raw extensions
+    exts += YARD_RAW_EXTS
+
+    paths.each do |path|
+      return path if exts.include?(File.extname(path))
+    end
+
+    warn "Could not intuitively find the #{name} file" if $DEBUG
+    return nil
+  end
+
+  #
+  # Generates the minimal amount of YARD options based on the YARD
+  # settings.
+  #
+  def normalize_yard_opts
+    opts = self.yard_opts + ['--title', self.yard_title]
+
+    if self.yard_markup
+      opts += ['--markup', self.yard_markup]
+    end
+
+    if self.yard_markup_provider
+      opts += ['--markup-provider', self.yard_markup_provider]
+    end
+
+    unless (opts.include?('--quiet') || opts.include?('--verbose') || $DEBUG)
+      opts += ['--quiet']
+    end
+
+    return opts
+  end
+end unless defined? Hoe::Yard

data.tar.gz.sig

@@ -0,0 +1 @@
+���~��u�[�K��l}��d�S�丘r6L|�إg}v�aG��,�莻a6xGz��%7	8;�ӑ߫�)}9�J��l���(?m󧷵翦լ>�K� ����!W[H��>��"<�Q �Bo��<\�!{�7�\��%�n���}p�3��δ�8l

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification 
+name: hoe-yard
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Postmodern
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDQDCCAiigAwIBAgIBADANBgkqhkiG9w0BAQUFADBGMRgwFgYDVQQDDA9wb3N0
+  bW9kZXJuLm1vZDMxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixk
+  ARkWA2NvbTAeFw0wOTA2MDMwNDU5MDNaFw0xMDA2MDMwNDU5MDNaMEYxGDAWBgNV
+  BAMMD3Bvc3Rtb2Rlcm4ubW9kMzEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYK
+  CZImiZPyLGQBGRYDY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA
+  1wvANkTDHFgVih5XLjuTwTZjgBq1lBGybXJiH6Id1lY2JOMqM5FB1DDHVvvij94i
+  mJabN0zkzu6VKWC70y0IwOxY7CPokr0eFdK/D0y7mCq1P8QITv76i2YqAl0eYqIt
+  W+IhIkANQ7E6uMZIZcdnfadC6lPAtlKkqtd9crvRbFgr6e3kyflmohbRnTEJHoRd
+  7SHHsybE6DSn7oTDs6XBTNrNIn5VfZA0z01eeos/+zBm1zKJOK2+/7xtLLDuDU9G
+  +Rd+ltUBbvxUrMNZmDG29pnmN2xTRH+Q8HxD2AxlvM5SRpK6OeZaHV7PaCCAVZ4L
+  T9BFl1sfMvRlABeGEkSyuQIDAQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIE
+  sDAdBgNVHQ4EFgQUKwsd+PqEYmBvyaTyoL+uRuk+PhEwDQYJKoZIhvcNAQEFBQAD
+  ggEBAB4TvHsrlbcXcKg6gX5BIb9tI+zGkpzo0Z7jnxMEcNO7NGGwmzafDBI/xZYv
+  xkRH3/HXbGGYDOi6Q6gWt5GujSx0bOImDtYTJTH8jnzN92HzEK5WdScm1QpZKF1e
+  cezArMbxbSPaosxTCtG6LQTkE28lFQsmFZ5xzouugS4h5+LVJiVMmiP+l3EfkjFa
+  GOURU+rNEMPWo8MCWivGW7jes6BMzWHcW7DQ0scNVmIcCIgdyMmpscuAEOSeghy9
+  /fFs57Ey2OXBL55nDOyvN/ZQ2Vab05UH4t+GCxjAPeirzL/29FBtePT6VD44c38j
+  pDj+ws7QjtH/Qcrr1l9jfN0ehDs=
+  -----END CERTIFICATE-----
+
+date: 2010-01-08 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.3.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: gemcutter
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe-yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.5.0
+    version: 
+description: |-
+  A Hoe plugin for generating YARD documentation.
+  
+  Using the Hoe YARD plugin, projects can begin generating YARD documentation
+  instantly. Additionally, any resulting RubyGems will be properly configured
+  to automatically generate YARD documentation upon installation.
+email: 
+- postmodern.mod3@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Manifest.txt
+- History.rdoc
+files: 
+- History.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/hoe/yard.rb
+has_rdoc: yard
+homepage: http://github.com/postmodern/hoe-yard
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --protected
+- --title
+- HoeYard Documentation
+- --quiet
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: hoe-yard
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Hoe plugin for generating YARD documentation
+test_files: []
+

metadata.gz.sig

@@ -0,0 +1,3 @@
+�ț?v�h��O"IEE��
���p�C���c���88:a��eؾ�����n�'1k�f���R�1�b�3�w9KT�p�D:6�,�����\Y
+7.�u��e�%�R�P�ʴ8�Al�
+6Ii�N�
��+2ֻhE~�3?�Yak���3�N��-Uv�4���Q�
5�FVP�٥}���:�G��޶IF.CiI6{V!����u��O����+&wb}Q�P�d:��>:5ؒq�N���)�N�N��F���T�