inventory-rake-tasks-yard 1.0.0

data/README

@@ -0,0 +1,21 @@
+                           Inventory-Rake-Tasks-YARD
+
+  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/
+
+§ Installation
+
+    Install Inventory-Rake-Tasks-YARD with
+
+    % gem install inventory-rake-tasks-yard
+
+§ Usage
+
+    Include the following code in your ‹Rakefile›:
+
+      require 'inventory/rake/tasks/yard-1.0'
+      Inventory::Rake::Tasks::YARD.new

data/Rakefile

@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+
+require 'inventory/rake-1.0'
+
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'inventory/rake/tasks/yard-1.0'
+
+Inventory::Rake::Tasks.define Inventory::Rake::Tasks::YARD::Version, :gem => proc{ |_, s|
+  s.author = 'Nikolai Weibull'
+  s.email = 'now@bitwi.se'
+  s.homepage = 'https://github.com/now/inventory-rake-tasks-yard'
+}
+
+Inventory::Rake::Tasks.unless_installing_dependencies do
+  require 'lookout/rake-3.0'
+  Lookout::Rake::Tasks::Test.new
+end

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

@@ -0,0 +1,53 @@
+# -*- 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, Shellwords.split('--no-private --protected --private --query "(!object.docstring.blank?&&!(YARD::CodeObjects::NamespaceObject===object.namespace&&(a=object.namespace.aliases[object])&&object.name==:eql?&&a==:==)&&!(object.visibility!=:public&&((@return.text==\'\'&&@return.types==%w\'Boolean\')||object.docstring.start_with?(\'Returns the value of attribute \', \'Sets the attribute \')||(@raise&&@raise.types=[]))))||object.root?" --markup markdown --no-stats'))
+    self.options += Shellwords.split(ENV['OPTIONS']) if ENV.include? 'OPTIONS'
+    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 name == :html ?
+      'Generate documentation in HTML format' :
+      'Generate documentation for %s in HTML format' % name
+    task name do
+      require 'yard'
+      yardoc = YARD::CLI::Yardoc.new
+      yardoc.parse_arguments(*arguments)
+      yardoc.options.merge! globals
+      Rake.rake_output_message 'yard doc %s' % Shellwords.join(arguments(yardoc.yardopts)) if verbose
+      yardoc.run(nil)
+    end
+  end
+
+  private
+
+  def arguments(additional = [])
+    options.dup.concat(additional).push('--').concat(files)
+  end
+end

data/lib/inventory/rake/tasks/yard/version.rb

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+
+require 'inventory-1.0'
+
+class Inventory::Rake::Tasks::YARD
+  Version = Inventory.new(1, 0, 0){
+    def dependencies
+      super + Inventory::Dependencies.new{
+        development 'lookout', 3, 0, 0
+        development 'lookout-rake', 3, 0, 0
+        runtime 'inventory-rake', 1, 3, 0
+        optional 'rake', 0, 9, 2
+        optional 'yard', 0, 7, 0
+      }
+    end
+
+    def requires
+      %w'
+        rake
+        shellwords
+      '
+    end
+  }
+end

data/test/unit/inventory/rake/tasks/yard-1.0.rb

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+
+Expectations do
+end

data/test/unit/inventory/rake/tasks/yard/version.rb

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+
+Expectations do
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: inventory-rake-tasks-yard
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Nikolai Weibull
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: inventory
+  requirement: &10881012 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *10881012
+- !ruby/object:Gem::Dependency
+  name: lookout
+  requirement: &10879944 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: *10879944
+- !ruby/object:Gem::Dependency
+  name: lookout-rake
+  requirement: &10879224 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: *10879224
+- !ruby/object:Gem::Dependency
+  name: inventory-rake
+  requirement: &14405448 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *14405448
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &14404260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *14404260
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &14402940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *14402940
+description: ! "                           Inventory-Rake-Tasks-YARD\n\n  Inventory-Rake-Tasks-YARD
+  provides Rake¹ tasks for YARD² using your\n  Inventory³.\n\n¹ Read up on Ruby’s
+  build tool Rake at http://rake.rubyforge.org/\n² Find out more about the YARD documentation
+  tool at http://yardoc.org/\n³ Get information on Inventory at http://disu.se/software/inventory/\n\n§
+  Installation\n\n    Install Inventory-Rake-Tasks-YARD with\n\n    % gem install
+  inventory-rake-tasks-yard\n\n§ Usage\n\n    Include the following code in your ‹Rakefile›:\n\n
+  \     require 'inventory/rake/tasks/yard-1.0'\n      Inventory::Rake::Tasks::YARD.new\n"
+email: now@bitwi.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- 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
+- README
+- Rakefile
+homepage: https://github.com/now/inventory-rake-tasks-yard
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 4
+summary: Inventory³.
+test_files: []