inventory-rake-tasks-yard 1.3.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16a9fcb604b34aa74bed4e4b5937a7c46d8426d4
-  data.tar.gz: 342a48ed2b75307412a5dd79c036d43830ae482d
+  metadata.gz: 7cfb2acd8a44a9e98e560b7961f4d6f605f36f74
+  data.tar.gz: 4499363058455509f5ca2fa4c67a8808f4b21c72
 SHA512:
-  metadata.gz: 31f86ce50a2120e3dc6e4a3ede88dda750dd38fcc20108aab2dbaf6968a922706d861b52f4fca7fa1fe8221c26fbeeef9db97efb8c142a3e4b623c7f602b03b4
-  data.tar.gz: 791d9f66a0586c6282cda612a13491c6f7cbe33b272f901e5581f2c1dee097381be61e4eb0f3904c91777c0edbf9ca079278baa4bdae6824dd18e4e01fbad830
+  metadata.gz: b732194c8fbf208e8e0914c140e9577c36c72c9cdc5b79b0a7963494a581cb7779eb6fb69c23f5bd696f2beaa9f8a5535cb1add8589f0612be54dfa273bdb13c
+  data.tar.gz: dbc0bc23550917b878ff907f154f14238c9db7748f884b1ba23885ac35b9706725c3f6192f397b83ff70f184738d0342323488c04c813255f645dde0983ac61e

data/README

@@ -3,9 +3,9 @@
   Inventory-Rake-Tasks-YARD provides Rake¹ tasks for YARD² using your
   Inventory³.
 
-¹ Read up on Ruby’s build tool Rake at http://rake.rubyforge.org/
-² Find out more about the YARD documentation tool at http://yardoc.org/
-³ Get information on Inventory at http://disu.se/software/inventory/
+¹ See http://rake.rubyforge.org/
+² See http://yardoc.org/
+³ See http://disu.se/software/inventory/
 
 § Installation
 
@@ -15,7 +15,63 @@
 
 § Usage
 
-    Include the following code in your ‹Rakefile›:
+    Include the following code in your ‹Rakefile› (assuming that you’ve already
+    set up Inventory-Rake¹:
 
-      require 'inventory/rake/tasks/yard-1.0'
-      Inventory::Rake::Tasks::YARD.new
+      Inventory::Rake::Tasks.unless_installing_dependencies do
+        require 'inventory-rake-tasks-yard-1.0'
+        Inventory::Rake::Tasks::YARD.new
+      end
+
+    This’ll define the following tasks:
+
+  = .yardopts (file). = Create .yardopts file; depends on the file defining
+      this task and Rakefile.
+  = html. = Generate documentation in HTML format for all lib files in the
+      inventory; depends on .yardopts file.
+
+    ‹Inventory::Rake::Tasks::YARD› takes a couple of options, but the ones you
+    might want to adjust are
+
+  = :options. = The options to pass to YARD; will be passed to
+      `Shellwords.shelljoin`.
+  = :globals. = The globals to pass to YARD.
+  = :files. = The files to process; mainly used if you want to add additional
+      files to process beyond the lib files in the inventory.
+
+    The options passed to YARD will be augmented with any options you list in a
+    file named ‹.yardopts.task›, where ‹task› is the name of the Rake task
+    invoking YARD, for example, ‹.yardopts.html› for the default
+    HTML-generating task.  You can use this to add options that are local to
+    your installation and should thus not be listed in the Rakefile itself.
+
+    See the {API documentation}² for more information.
+
+¹ See http://disu.se/software/inventory-rake/
+² See http://disu.se/software/inventory-rake-tasks-yard/api/Inventory/Rake/Tasks/YARD/
+
+§ Financing
+
+    Currently, most of my time is spent at my day job and in my rather busy
+    private life.  Please motivate me to spend time on this piece of software
+    by donating some of your money to this project.  Yeah, I realize that
+    requesting money to develop software is a bit, well, capitalistic of me.
+    But please realize that I live in a capitalistic society and I need money
+    to have other people give me the things that I need to continue living
+    under the rules of said society.  So, if you feel that this piece of
+    software has helped you out enough to warrant a reward, please PayPal a
+    donation to now@disu.se¹.  Thanks!  Your support won’t go unnoticed!
+
+¹ Send a donation:
+  https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=now%40disu%2ese&item_name=Nikolai%20Weibull%20Software%20Services
+
+§ Reporting Bugs
+
+    Please report any bugs that you encounter to the {issue tracker}¹.
+
+  ¹ See https://github.com/now/inventory-rake-tasks-yard/issues
+
+§ Authors
+
+    Nikolai Weibull wrote the code, the tests, the manual pages, and this
+    README.

data/Rakefile

@@ -1,9 +1,9 @@
 # -*- coding: utf-8 -*-
 
-require 'inventory/rake-1.0'
+require 'inventory-rake-1.0'
 
 $:.unshift File.expand_path('../lib', __FILE__)
-require 'inventory/rake/tasks/yard-1.0'
+require 'inventory-rake-tasks-yard-1.0'
 
 Inventory::Rake::Tasks.define Inventory::Rake::Tasks::YARD::Version, :gem => proc{ |_, s|
   s.author = 'Nikolai Weibull'
@@ -12,6 +12,11 @@ Inventory::Rake::Tasks.define Inventory::Rake::Tasks::YARD::Version, :gem => pro
 }
 
 Inventory::Rake::Tasks.unless_installing_dependencies do
-  require 'lookout/rake-3.0'
+  require 'lookout-rake-3.0'
   Lookout::Rake::Tasks::Test.new
 end
+
+Inventory::Rake::Tasks::YARD.new do |t|
+  t.options += %w'--plugin yard-heuristics-1.0'
+  t.globals[:source_code_url] = 'https://github.com/now/%s/blob/v%s/%%s#L%%d' % [t.inventory.package, t.inventory]
+end

data/lib/inventory-rake-tasks-yard-1.0.rb

@@ -0,0 +1,149 @@
+# -*- coding: utf-8 -*-
+
+# Namespace for [Inventory](http://disu.se/software/inventory/).  The bulk of
+# the library is in {Rake::Tasks::YARD}.
+class Inventory; end
+
+# Namespace for [Rake](http://rake.rubyforge.org/) integration of Inventory.
+module Inventory::Rake
+end
+
+# Namespace for [Inventory Rake](http://disu.se/software/inventory-rake) tasks.
+module Inventory::Rake::Tasks
+end
+
+# Defines a task that invokes [YARD](http://yardoc.org/) to process embedded
+# documentation.
+class Inventory::Rake::Tasks::YARD
+  load File.expand_path('../inventory-rake-tasks-yard-1.0/version.rb', __FILE__)
+  Version.load
+
+  include Rake::DSL
+
+  # Sets up a YARD task NAME, passing OPTIONS, on the files listed in INVENTORY
+  # or FILES, with GLOBALS set, optionally yields the task object for further
+  # customization, then {#define}s NAME.
+  #
+  # The default for OPTIONS is:
+  #
+  #     --no-private --protected --private --query \
+  #       "(!object.docstring.blank?&&object.docstring.line)||object.root?" \
+  #     --markup markdown --no-stats
+  #
+  # This’ll make YARD output documentation for all public, protected, and
+  # private objects not markes as `@private` that have documentation that
+  # hasn’t been automatically generated or is the top-level namespace using
+  # Markdown as the markup format and not outputting any statistics at the end
+  # of execution.
+  #
+  # @param [Hash] options
+  # @option options [Symbol] :name (:html) The name of the task to define
+  # @option options [Array<String, Array<String>>] :options (…) The options to
+  #   pass to YARD; will be passed to `Shellwords.shelljoin`
+  # @option options [Inventory] :inventory (Inventory::Rake::Tasks.inventory)
+  #   The inventory to use for FILES default
+  # @option options [Array<String>] :files (FileList[ENV['FILES']] or
+  #   inventory.lib_files) The files to process
+  # @option options [Hash] :globals ({}) The globals to pass to YARD
+  # @yield [?]
+  # @yieldparam [self] task
+  def initialize(options = {})
+    self.name = options.fetch(:name, :html)
+    self.options = options.fetch(:options,
+                                 ['--no-private',
+                                  '--protected',
+                                  '--private',
+                                  ['--query', %w{'(!object.docstring.blank?&&object.docstring.line)||object.root?'}],
+                                  ['--markup', 'markdown'],
+                                  '--no-stats'])
+    self.inventory = options.fetch(:inventory, Inventory::Rake::Tasks.inventory)
+    self.files = options.fetch(:files){ ENV.include?('FILES') ? FileList[ENV['FILES']] : inventory.lib_files }
+    self.globals = options.fetch(:globals, {})
+    yield self if block_given?
+    define
+  end
+
+  # Defines the following tasks (html is actually whatever {#name} has been set
+  # to):
+  #
+  # <dl>
+  #   <dt>.yardopts (file)</dt>
+  #   <dd>Create .yardopts file based on {#options}; depends on the file
+  #   defining this task and Rakefile.</dd>
+  #
+  #   <dt>html</dt>
+  #   <dd>Generate documentation in HTML format for all {#files}, passing
+  #   {#globals} to YARD; depends on .yardopts file.</dd>
+  # </dl>
+  def define
+    desc 'Create .yardopts file'
+    file '.yardopts' => [__FILE__, 'Rakefile'] do |t|
+      tmp = '%s.tmp' % t.name
+      rm([t.name, tmp], :force => true)
+      rake_output_message 'echo %s > %s' % [options.join(' '), tmp] if verbose
+      File.open(tmp, 'wb') do |f|
+        f.write options.join(' ')
+      end
+      chmod File.stat(tmp).mode & ~0222, tmp
+      mv tmp, t.name
+    end
+
+    desc name == :html ?
+      'Generate documentation in HTML format' :
+      'Generate documentation for %s in HTML format' % name
+    task name => '.yardopts' do
+      require 'yard'
+      yardoc = YARD::CLI::Yardoc.new
+      yardoc.parse_arguments(*arguments)
+      globals.each do |key, value|
+        yardoc.options.globals.send '%s=' % key, value
+      end
+      rake_output_message 'yard doc %s' % Shellwords.shelljoin(arguments(yardopts(yardoc))) if verbose
+      yardoc.run(nil)
+    end
+  end
+
+  # @param [Symbol] value
+  # @return [Symbol] The name to use for the task: VALUE
+  attr_accessor :name
+
+  # @param [Array<String, Array<String>>] value
+  # @return [Array<String, Array<String>>] The options to pass to YARD: VALUE
+  attr_accessor :options
+
+  # @param [Inventory] value
+  # @return [Inventory] The inventory to use: VALUE
+  attr_accessor :inventory
+
+  # @param [Array<String>] value
+  # @return [Array<String>] The files to process: VALUE
+  attr_accessor :files
+
+  # @param [Hash] value
+  # @return [Hash] The globals to pass to YARD: VALUE
+  attr_accessor :globals
+
+  private
+
+  def read(type)
+    File.open('.yardopts.%s' % type, 'rb', &:read)
+  rescue Errno::ENOENT
+    nil
+  end
+
+  def arguments(additional = [])
+    additional.
+      concat(Shellwords.split(read('html') || '')).
+      concat(Shellwords.split(ENV['OPTIONS'] || '')).
+      push('--').
+      concat(files)
+  end
+
+  def yardopts(yardoc)
+    yardoc.use_yardopts_file ?
+      Shellwords.split(File.open(yardoc.options_file, 'rb', &:read)) :
+      []
+  rescue Errno::ENOENT
+    []
+  end
+end

data/lib/{inventory/rake/tasks/yard → inventory-rake-tasks-yard-1.0}/version.rb

@@ -3,21 +3,28 @@
 require 'inventory-1.0'
 
 class Inventory::Rake::Tasks::YARD
-  Version = Inventory.new(1, 3, 2){
+  Version = Inventory.new(1, 3, 3){
     def dependencies
       super + Inventory::Dependencies.new{
         development 'lookout', 3, 0, 0
         development 'lookout-rake', 3, 0, 0
-        runtime 'inventory-rake', 1, 3, 0
+        development 'yard-heuristics', 1, 1, 0
+        runtime 'inventory-rake', 1, 4, 0
         runtime 'rake', 0, 9, 2, :feature => 'rake'
         optional 'yard', 0, 8, 0
       }
     end
 
     def requires
-      %w'
-        shellwords
-      '
+      %w[shellwords]
+    end
+
+    def additional_libs
+      super + %w[inventory/rake/tasks/yard-1.0.rb]
+    end
+
+    def unit_tests
+      super - %w[inventory/rake/tasks/yard-1.0.rb]
     end
   }
 end

data/lib/inventory/rake/tasks/yard-1.0.rb

@@ -1,90 +1,4 @@
 # -*- coding: utf-8 -*-
 
-# Namespace for Inventory, see {http://disu.se/software/inventory}.
-class Inventory; end
-
-# Namespace for Rake integration of Inventory, see
-# {http://disu.se/software/inventory-rake}.
-module Inventory::Rake
-end
-
-# Namespace for Rake tasks.
-module Inventory::Rake::Tasks
-end
-
-class Inventory::Rake::Tasks::YARD
-  load File.expand_path('../yard/version.rb', __FILE__)
-  Version.load
-
-  include Rake::DSL
-
-  def initialize(options = {})
-    self.name = options.fetch(:name, :html)
-    self.options = options.fetch(:options,
-                                 ['--no-private',
-                                  '--protected',
-                                  '--private',
-                                  ['--query', %w{'(!object.docstring.blank?&&object.docstring.line)||object.root?'}],
-                                  ['--markup', 'markdown'],
-                                  '--no-stats'])
-    self.inventory = options.fetch(:inventory, Inventory::Rake::Tasks.inventory)
-    self.files = options.fetch(:files){ ENV.include?('FILES') ? FileList[ENV['FILES']] : inventory.lib_files }
-    self.globals = options.fetch(:globals, {})
-    yield self if block_given?
-    define
-  end
-
-  attr_accessor :name, :options, :files, :inventory, :globals
-
-  def define
-    desc 'Create .yardopts file'
-    file '.yardopts' => [__FILE__, 'Rakefile'] do |t|
-      tmp = '%s.tmp' % t.name
-      rm([t.name, tmp], :force => true)
-      rake_output_message 'echo %s > %s' % [options.join(' '), tmp] if verbose
-      File.open(tmp, 'wb') do |f|
-        f.write options.join(' ')
-      end
-      chmod File.stat(tmp).mode & ~0222, tmp
-      mv tmp, t.name
-    end
-
-    desc name == :html ?
-      'Generate documentation in HTML format' :
-      'Generate documentation for %s in HTML format' % name
-    task name => '.yardopts' do
-      require 'yard'
-      yardoc = YARD::CLI::Yardoc.new
-      yardoc.parse_arguments(*arguments)
-      globals.each do |key, value|
-        yardoc.options.globals.send '%s=' % key, value
-      end
-      rake_output_message 'yard doc %s' % Shellwords.shelljoin(arguments(yardopts(yardoc))) if verbose
-      yardoc.run(nil)
-    end
-  end
-
-  private
-
-  def read(type)
-    File.open('.yardopts.%s' % type, 'rb', &:read)
-  rescue Errno::ENOENT
-    nil
-  end
-
-  def arguments(additional = [])
-    additional.
-      concat(Shellwords.split(read('html') || '')).
-      concat(Shellwords.split(ENV['OPTIONS'] || '')).
-      push('--').
-      concat(files)
-  end
-
-  def yardopts(yardoc)
-    yardoc.use_yardopts_file ?
-      Shellwords.split(File.open(yardoc.options_file, 'rb', &:read)) :
-      []
-  rescue Errno::ENOENT
-    []
-  end
-end
+warn "requiring 'inventory/rake/tasks/yard-1.0' is deprecated; require 'inventory-rake-tasks-yard-1.0' instead"
+require 'inventory-rake-tasks-yard-1.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inventory-rake-tasks-yard
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.3
 platform: ruby
 authors:
 - Nikolai Weibull
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-10 00:00:00.000000000 Z
+date: 2013-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inventory
@@ -52,20 +52,34 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard-heuristics
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: inventory-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -100,9 +114,9 @@ description: |2
     Inventory-Rake-Tasks-YARD provides Rake¹ tasks for YARD² using your
     Inventory³.
 
-  ¹ Read up on Ruby’s build tool Rake at http://rake.rubyforge.org/
-  ² Find out more about the YARD documentation tool at http://yardoc.org/
-  ³ Get information on Inventory at http://disu.se/software/inventory/
+  ¹ See http://rake.rubyforge.org/
+  ² See http://yardoc.org/
+  ³ See http://disu.se/software/inventory/
 
   § Installation
 
@@ -112,19 +126,76 @@ description: |2
 
   § Usage
 
-      Include the following code in your ‹Rakefile›:
+      Include the following code in your ‹Rakefile› (assuming that you’ve already
+      set up Inventory-Rake¹:
+
+        Inventory::Rake::Tasks.unless_installing_dependencies do
+          require 'inventory-rake-tasks-yard-1.0'
+          Inventory::Rake::Tasks::YARD.new
+        end
+
+      This’ll define the following tasks:
+
+    = .yardopts (file). = Create .yardopts file; depends on the file defining
+        this task and Rakefile.
+    = html. = Generate documentation in HTML format for all lib files in the
+        inventory; depends on .yardopts file.
+
+      ‹Inventory::Rake::Tasks::YARD› takes a couple of options, but the ones you
+      might want to adjust are
+
+    = :options. = The options to pass to YARD; will be passed to
+        `Shellwords.shelljoin`.
+    = :globals. = The globals to pass to YARD.
+    = :files. = The files to process; mainly used if you want to add additional
+        files to process beyond the lib files in the inventory.
+
+      The options passed to YARD will be augmented with any options you list in a
+      file named ‹.yardopts.task›, where ‹task› is the name of the Rake task
+      invoking YARD, for example, ‹.yardopts.html› for the default
+      HTML-generating task.  You can use this to add options that are local to
+      your installation and should thus not be listed in the Rakefile itself.
+
+      See the {API documentation}² for more information.
+
+  ¹ See http://disu.se/software/inventory-rake/
+  ² See http://disu.se/software/inventory-rake-tasks-yard/api/Inventory/Rake/Tasks/YARD/
+
+  § Financing
+
+      Currently, most of my time is spent at my day job and in my rather busy
+      private life.  Please motivate me to spend time on this piece of software
+      by donating some of your money to this project.  Yeah, I realize that
+      requesting money to develop software is a bit, well, capitalistic of me.
+      But please realize that I live in a capitalistic society and I need money
+      to have other people give me the things that I need to continue living
+      under the rules of said society.  So, if you feel that this piece of
+      software has helped you out enough to warrant a reward, please PayPal a
+      donation to now@disu.se¹.  Thanks!  Your support won’t go unnoticed!
+
+  ¹ Send a donation:
+    https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=now%40disu%2ese&item_name=Nikolai%20Weibull%20Software%20Services
+
+  § Reporting Bugs
+
+      Please report any bugs that you encounter to the {issue tracker}¹.
+
+    ¹ See https://github.com/now/inventory-rake-tasks-yard/issues
+
+  § Authors
 
-        require 'inventory/rake/tasks/yard-1.0'
-        Inventory::Rake::Tasks::YARD.new
+      Nikolai Weibull wrote the code, the tests, the manual pages, and this
+      README.
 email: now@bitwi.se
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/inventory-rake-tasks-yard-1.0.rb
+- lib/inventory-rake-tasks-yard-1.0/version.rb
 - lib/inventory/rake/tasks/yard-1.0.rb
-- lib/inventory/rake/tasks/yard/version.rb
-- test/unit/inventory/rake/tasks/yard-1.0.rb
-- test/unit/inventory/rake/tasks/yard/version.rb
+- test/unit/inventory-rake-tasks-yard-1.0.rb
+- test/unit/inventory-rake-tasks-yard-1.0/version.rb
 - README
 - Rakefile
 homepage: https://github.com/now/inventory-rake-tasks-yard