hoe-yard 0.1.2 → 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1c08884cfdfa34fc9b0088bd4cbe442ca4432407
+  data.tar.gz: cd04a41bcb74a4fdfc3378a9e5ccf56bd9e1ed22
+SHA512:
+  metadata.gz: 819ece30dd5ddc196d8b63fd534dde523345bf1c63be035b75704483bf51baf90fba6c570c49c8d3fcd45ee5c95b7fb367d5196922c4628b62ff34b5deb47805
+  data.tar.gz: dfaf810a56104367838ad02652f84596387387518b8e779ed7338bf0085b523bffa7fb760b16bfdbc1d2bd25e651e346c18a321bf51d6d5bd355176995fbc38c

data/History.md

@@ -0,0 +1,32 @@
+=== 0.1.3 / 2017-03-01
+
+* Require [yard] ~> 0.8.
+* Add `asciidoc` as one of the allowed markup providers (@dsisnero).
+
+=== 0.1.2 / 2010-01-22
+
+* Renamed `yard_opts` to `yard_options`.
+* No longer automatically add `yard` to the development dependencies
+  of a Hoe project.
+
+=== 0.1.1 / 2010-01-10
+
+* Only add hoe-yard as a development dependency, if we are not in the
+  hoe-yard gem.
+* Have the `yard` task generate documentation only for the files listed in
+  Manifest.txt.
+* Have the `clobber_docs` task call `rm_r` when cleaning the `docs/`
+  directory.
+
+=== 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.
+
+[yard]: http://yardoc.org/

data/Manifest.txt

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

data/{README.rdoc → README.md}

@@ -1,10 +1,10 @@
-= hoe-yard
+# hoe-yard
 
-* http://github.com/postmodern/hoe-yard
+* http://github.com/postmodern/hoe-yard/
 * http://github.com/postmodern/hoe-yard/issues
 * Postmodern (postmodern.mod3 at gmail.com)
 
-== DESCRIPTION:
+## DESCRIPTION:
 
 A Hoe plugin for generating YARD documentation.
 
@@ -12,42 +12,42 @@ 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:
+## FEATURES:
 
 * Automatically find the README and History files, irregardless of file
   extension.
-* Sets +has_rdoc+ to +yard+.
-* Sets +rdoc_options+.
-* Sets +extra_rdoc_files+.
+* Sets `has_rdoc` to `yard`.
+* Sets `rdoc_options`.
+* Sets `extra_rdoc_files`.
 * Adds hoe-yard as a development dependency.
-* Adds the +yard+ and +docs+ Rake tasks.
+* Adds the `yard` and `docs` Rake tasks.
 
-== REQUIREMENTS:
+## REQUIREMENTS:
 
-* {yard}[http://yardoc.org/] >= 0.2.3.1
+* [yard](http://yardoc.org/) >= 0.2.3.1
 
-== INSTALL:
+## INSTALL:
 
-  $ sudo gem install hoe-yard
+    $ sudo gem install hoe-yard
 
-== USAGE:
+## USAGE:
 
-  require 'rubygems'
-  require 'hoe'
+    require 'rubygems'
+    require 'hoe'
 
-  Hoe.plugin :yard
+    Hoe.plugin :yard
 
-  Hoe.spec('my_project') do
-    # ...
+    Hoe.spec('my_project') do
+      # ...
 
-    self.yard_title = 'My Project'
-    self.yard_markup = :markdown
-    self.yard_opts = ['--protected']
+      self.yard_title = 'My Project'
+      self.yard_markup = :markdown
+      self.yard_opts = ['--protected']
 
-    # ...
-  end
+      # ...
+    end
 
-== LICENSE:
+## LICENSE:
 
 (The MIT License)
 

data/Rakefile

@@ -3,19 +3,20 @@
 require 'rubygems'
 require 'hoe'
 require 'hoe/signing'
-require './lib/hoe/yard.rb'
+$LOAD_PATH.unshift(File.expand_path('../lib',__FILE__))
 
 Hoe.plugin :yard
 
 Hoe.spec('hoe-yard') do
   self.version = Hoe::Yard::PLUGIN_VERSION
-  self.developer('Postmodern', 'postmodern.mod3@gmail.com')
+  self.developer 'Postmodern', 'postmodern.mod3@gmail.com'
+  self.license 'MIT'
 
-  self.yard_options = ['--protected']
+  self.yard_options = ['--markup', 'markdown', '--protected']
   self.remote_yard_dir = '/'
 
   self.extra_deps = [
-    ['yard', '>=0.2.3.1']
+    ['yard', '~> 0.8']
   ]
 end
 

data/lib/hoe/yard.rb

@@ -5,17 +5,17 @@ gem 'yard'
 ##
 # YARD plugin for hoe.
 #
-# === Tasks Provided:
+# ### Tasks Provided:
 #
-# yard::              Generate YARD documentation
-# docs::              Generate YARD documentation
+# * yard: Generate YARD documentation
+# * docs: Generate YARD documentation
 #
 module Hoe::Yard
   # hoe-yard version
-  PLUGIN_VERSION = '0.1.2'
+  PLUGIN_VERSION = '0.1.3'
 
   # Supported markups
-  YARD_MARKUP = [:markdown, :texttile, :rdoc]
+  YARD_MARKUP = [:markdown, :texttile, :rdoc, :asciidoc]
 
   # File extensions indicating raw content
   YARD_RAW_EXTS = ['.txt', '.html']
@@ -24,14 +24,15 @@ module Hoe::Yard
   YARD_EXTS = {
     :markdown => ['.markdown', '.md'],
     :texttile => ['.texttile', '.tt'],
-    :rdoc => ['.rdoc']
+    :rdoc => ['.rdoc'],
+    :asciidoc => ['.adoc']
   }
 
   # Title for the YARD documentation
   attr_accessor :yard_title
 
   # Markup style used in documentation, like textile, markdown or rdoc.
-  # (default: +:rdoc+)
+  # (default: `:rdoc`)
   attr_accessor :yard_markup
 
   # Overrides the library used to process markup formatting
@@ -41,6 +42,9 @@ module Hoe::Yard
   # Options to pass to YARD
   attr_accessor :yard_options
 
+  #
+  # Initializes the hoe-yard plugin.
+  #
   def initialize_yard
     self.yard_title = Hoe.normalize_names(self.name).last + ' Documentation'
     self.yard_markup = nil
@@ -68,12 +72,12 @@ module Hoe::Yard
     end
   end
 
+  #
+  # Defines additional rake tasks.
+  #
   def define_yard_tasks
     require 'yard'
 
-    # generate the YARD options
-    opts = normalize_yard_opts
-
     desc "Remove YARD products"
     task :clobber_docs do
       if File.exists?(local_yard_dir)
@@ -81,6 +85,9 @@ module Hoe::Yard
       end
     end
 
+    # generate the YARD options
+    opts = normalize_yard_opts
+
     # define the yard task
     ::YARD::Rake::YardocTask.new do |t|
       t.files = self.spec.files.select { |path| path =~ /^lib\/.+\.rb$/ }
@@ -95,60 +102,84 @@ module Hoe::Yard
   protected
 
   #
-  # Alias to +yard_options+.
+  # Alias to `yard_options`.
   #
-  # @deprecated Use +yard_options+ instead.
+  # @deprecated Use `yard_options` instead.
   #
   def yard_opts
     self.yard_options
   end
 
   #
-  # Alias to +yard_options=+.
+  # Alias to `yard_options=`.
   #
-  # @deprecated Use +yard_options=+ instead.
+  # @deprecated Use `yard_options=` instead.
   #
   def yard_opts=(new_opts)
     self.yard_options = new_opts
   end
 
   #
-  # Alias to <tt>Hoe#extra_rdoc_files</tt>.
+  # Alias to `Hoe#extra_rdoc_files`.
+  #
+  # @return [Array<String>]
+  #   Additional files to include in the generated documentation.
   #
   def yard_files
     self.extra_rdoc_files
   end
 
   #
-  # Alias to <tt>Hoe#extra_rdoc_files=</tt>.
+  # Alias to `Hoe#extra_rdoc_files=`.
+  #
+  # @param [Array<String>] new_files
+  #   Additional files to include in the generated documentation.
+  #
+  # @return [Array<String>]
   #
   def yard_files=(new_files)
     self.extra_rdoc_files = new_files
   end
 
   #
-  # Alias to <tt>Hoe#local_rdoc_dir</tt>.
+  # Alias to `Hoe#local_rdoc_dir`.
+  #
+  # @return [String]
+  #   Relative path to the locally generated documentation directory.
   #
   def local_yard_dir
     self.local_rdoc_dir
   end
 
   #
-  # Alias to <tt>Hoe#local_yard_dir=</tt>.
+  # Alias to `Hoe#local_yard_dir=`.
+  #
+  # @param [String] new_dir
+  #   New relative path to the locally generated documentation directory.
+  #
+  # @return [String]
   #
   def local_yard_dir=(new_dir)
     self.local_rdoc_dir = new_dir
   end
 
   #
-  # Alias to <tt>Hoe#remote_rdoc_dir</tt>.
+  # Alias to `Hoe#remote_rdoc_dir`.
+  #
+  # @return [String]
+  #   Relative path to the desired remote documentation directory.
   #
   def remote_yard_dir
     self.remote_rdoc_dir
   end
 
   #
-  # Alias to <tt>Hoe#remote_rdoc_dir=</tt>.
+  # Alias to `Hoe#remote_rdoc_dir=`.
+  #
+  # @param [String] new_dir
+  #   New relative path to the desired remote documentation directory.
+  #
+  # @return [String]
   #
   def remote_yard_dir=(new_dir)
     self.remote_rdoc_dir = new_dir
@@ -158,6 +189,13 @@ module Hoe::Yard
   # Intuitively finds the file with the given _name_, using the current
   # YARD markup setting to guess the file extension.
   #
+  # @param [String] name
+  #   The given file name.
+  #
+  # @return [String]
+  #   The file sharing the same name, but ending with the appropriate markup
+  #   file extension.
+  #
   def intuit_file_name(name)
     name = name.gsub(/\.[^\.]+$/,'')
     paths = Dir["#{name}.*"]
@@ -183,19 +221,22 @@ module Hoe::Yard
   # Generates the minimal amount of YARD options based on the YARD
   # settings.
   #
+  # @return [Array<String>]
+  #
   def normalize_yard_opts
-    opts = self.yard_opts + ['--title', self.yard_title]
+    opts = self.yard_opts.dup
+    opts << '--title' << self.yard_title
 
     if self.yard_markup
-      opts += ['--markup', self.yard_markup]
+      opts << '--markup' << self.yard_markup
     end
 
     if self.yard_markup_provider
-      opts += ['--markup-provider', self.yard_markup_provider]
+      opts << '--markup-provider' << self.yard_markup_provider
     end
 
     unless (opts.include?('--quiet') || opts.include?('--verbose') || $DEBUG)
-      opts += ['--quiet']
+      opts << '--quiet'
     end
 
     return opts

metadata

@@ -1,129 +1,91 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: hoe-yard
-version: !ruby/object:Gem::Version 
-  version: 0.1.2
+version: !ruby/object:Gem::Version
+  version: 0.1.3
 platform: ruby
-authors: 
+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-22 00:00:00 -08:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+cert_chain: []
+date: 2017-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
   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 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
   name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.5.0
-    version: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
 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: 
+email:
 - postmodern.mod3@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
+- History.md
 - Manifest.txt
-- History.rdoc
-files: 
-- History.rdoc
+- README.md
+files:
+- History.md
 - Manifest.txt
-- README.rdoc
+- README.md
 - Rakefile
 - lib/hoe/yard.rb
-has_rdoc: yard
-homepage: http://github.com/postmodern/hoe-yard
-licenses: []
-
+homepage: http://github.com/postmodern/hoe-yard/
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
-rdoc_options: 
-- --protected
-- --title
-- HoeYard Documentation
-- --quiet
-require_paths: 
+rdoc_options:
+- "--markup"
+- markdown
+- "--protected"
+- "--title"
+- TestHoe::TestYard Documentation
+- "--quiet"
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: hoe-yard
-rubygems_version: 1.3.5
+rubyforge_project: 
+rubygems_version: 2.5.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Hoe plugin for generating YARD documentation
 test_files: []
-

data.tar.gz.sig

@@ -1,2 +0,0 @@
-q��o�HjY�h�Y=��\8���GLx'
-�pw���8������m+ߔ��Οے�6��H�1����o#v����
'�LjZ?\7?H������2�y5�hu

data/History.rdoc

@@ -1,26 +0,0 @@
-=== 0.1.2 / 2010-01-22
-
-* Renamed +yard_opts+ to +yard_options+.
-* No longer automatically add +yard+ to the development dependencies
-  of a Hoe project.
-
-=== 0.1.1 / 2010-01-10
-
-* Only add hoe-yard as a development dependency, if we're not in the
-  hoe-yard gem.
-* Have the +yard+ task generate documentation only for the files listed in
-  Manifest.txt.
-* Have the +clobber_docs+ task call +rm_r+ when cleaning the <tt>docs/</tt>
-  directory.
-
-=== 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.
-