inventory-rake 1.3.0 → 1.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 427df0935a6abb01a0c8d70412f8944533fa4371
+  data.tar.gz: 3baaf45912f54c59b4192ae5c2d79d8b58da9889
+SHA512:
+  metadata.gz: df48e44bec0ee151e62278e5027359d686dc860725755125704a031dfa446da90621566d2ab86d7179f1d052757dcd6a5e64883ec794f333b4e6d60ddf6e502c
+  data.tar.gz: 641d02cd7e50060226b28d54a9c8c6d4a190a399cca87f7272b75372a7da82e2c3a2447f6bd7ff8a16390044d00014d877bbb2f433876bd4e43246d3fb505880

data/README

@@ -1,10 +1,12 @@
                                 Inventory-Rake
 
-  Inventory-Rake provides Rake tasks for your Inventory¹.  This includes
-  cleaning tasks, gem generation, testing, installation, uninstallation, and
-  pushing, and inventory content checking.
+  Inventory-Rake provides Rake¹ tasks for your Inventory².  This includes tasks
+  for cleaning up our project, compiling extensions, installing dependencies,
+  installing and uninstalling the project itself, and creating and pushing
+  distribution files to distribution points.
 
-¹ Get information on Inventory at http://disu.se/software/inventory/
+¹ See http://rake.rubyforge.org/
+² See http://disu.se/software/inventory/
 
 § Installation
 
@@ -15,12 +17,121 @@
 § Usage
 
     Include the following code in your ‹Rakefile›, where ‹Package› is the
-    top-level module of your package:
+    top-level module of your project:
 
-      require 'inventory/rake-3.0'
+      require 'inventory-rake-3.0'
+
+      load File.expand_path('../lib/package/version.rb', __FILE__)
 
       Inventory::Rake::Tasks.define Package::Version, :gem => proc{ |_, s|
         s.author = 'Your Name'
-        s.email = 'your@email.com'
-        s.homepage = 'https://github.com/now/%s' % Package.name.downcase
+        s.email = 'you@example.com'
+        s.homepage = 'http://example.com/'
       }
+
+      Inventory::Rake::Tasks.unless_installing_dependencies do
+        # Any additional tasks that your project’s dependencies provide
+      end
+
+    ‹Inventory::Rake::Tasks.define› does the heavy lifting.  It takes our
+    inventory and sets up the tasks mentioned above.  We also do some
+    additional customization of the gem specification.
+
+    As we want to be able to use our Rakefile to install our dependencies for
+    us, the rest of the Rakefile is inside the conditional
+    #unless_installing_dependencies, which, as the name certainly implies,
+    executes its block unless the task being run is the one that installs our
+    dependencies.  This becomes relevant if we want to, for example, set up
+    Travis¹ integration.  To do so, simply add
+
+      before_script:
+        - gem install inventory-rake -v '~> VERSION' --no-rdoc --no-ri
+        - rake gem:deps:install
+
+    to your ‹.travis.yml› file.  This’ll make sure that Travis installs all
+    development, runtime, and optional dependencies that you’ve listed in your
+    inventory before running any tests.
+
+    There’s more information in the {API documentation}² that you’ll likely
+    want to read up on if anything is unclear.
+
+¹ See http://travis-ci.org/
+² See http://disu.se/software/inventory/api/inventory-rake/
+
+§ Tasks
+
+    The tasks that are created if you use Inventory-Rake are:
+
+  = check. = Check that the package meets its expectations.
+  = mostlyclean. = Delete targets built by rake that are ofter rebuilt.
+  = clean. = Delete targets built by rake; depends on mostlyclean.
+  = distclean. = Delete all files not meant for distribution; depends on clean.
+  = compile. = Compile all extensions; depends on each compile:name.
+  = compile:name. = Compile extension /name/; depends on
+      lib/path/so file.
+  = lib/path/so. = Installed dynamic library of extension /name/ inside
+      inventory path; depends on ext/name/so.
+  = ext/name/so. = Dynamic library of extension /name/; depends on
+      ext/name/Makefile and the source files of the extension.
+  = ext/name/Makefile. = Makefile for extension /name/; depends on inventory
+      path, ext/name/extconf.rb file, and ext/name/depend file.
+  = clean:name. = Clean files built for extension /name/; depended upon by
+      clean.
+  = spec. = Create specifications; depends on gem:spec.
+  = gem:spec. = Create gem specification; depends on gemspec.
+  = gemspec (file). = Gem specification file; depends on Rakefile, README, and
+      inventory path.
+  = dist. = Create files for distribution; depends on gem:dist.
+  = gem:dist. = Create gem for distribution; depends on inventory:check and gem
+      file.
+  = inventory:check. = Check that the inventory is correct by looking for files
+      not listed in the inventory that match the pattern and for files listed
+      in the inventory that don’t exist; depends on distclean.
+  = gem (file). = Gem file; depends on files included in gem.
+  = dist:check. = Check files before distribution; depends on dist and
+      gem:dist:check.
+  = gem:dist:check. = Check gem before distribution; depends on gem:dist.
+  = deps:install. = Install dependencies on the local system; depends on
+      gem:deps:install.
+  = gem:deps:install. = Install dependencies in ruby gem directory.
+  = deps:install:user. = Install dependencies for the current user; depends on
+      gem:deps:install:user.
+  = gem:deps:install:user. = Install dependencies in the user gem directory.
+  = install. = Install distribution files on the local system; depends on
+      gem:install.
+  = gem:install. = Install gem in ruby gem directory; depends on gem:dist.
+  = install:user. = Install distribution files for the current user; depends on
+      gem:install:user.
+  = gem:install:user. = Install gem in the user gem directory.
+  = uninstall. = Delete all files installed on the local system.
+  = gem:uninstall. = Uninstall gem from ruby gem directory.
+  = uninstall:user. = Delete all files installed for current user.
+  = gem:uninstall:user. = Uninstall gem from ruby gem directory.
+  = push. = Push distribution files to distribution hubs.
+  = gem:push. = Push gem to rubygems.org.
+
+§ 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/issues
+
+§ Authors
+
+    Nikolai Weibull wrote the code, the tests, the manual pages, and this
+    README.

data/Rakefile

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 $:.unshift File.expand_path('../lib', __FILE__)
-require 'inventory/rake-1.0'
+require 'inventory-rake-1.0'
 
 Inventory::Rake::Tasks.define Inventory::Rake::Version, :gem => proc{ |_, s|
   s.author = 'Nikolai Weibull'
@@ -10,6 +10,12 @@ Inventory::Rake::Tasks.define Inventory::Rake::Version, :gem => proc{ |_, s|
 }
 
 Inventory::Rake::Tasks.unless_installing_dependencies do
-  require 'lookout/rake-3.0'
+  require 'lookout-rake-3.0'
   Lookout::Rake::Tasks::Test.new
+
+  require 'inventory-rake-tasks-yard-1.0'
+  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
 end

data/lib/inventory-rake-1.0.rb

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+
+# Namespace for [Inventory](http://disu.se/software/inventory/).  The bulk of
+# the library is in {Rake::Tasks}.
+class Inventory; end
+
+# Namespace for [Rake](http://rake.rubyforge.org/) integration of Inventory.
+module Inventory::Rake
+  load File.expand_path('../inventory-rake-1.0/version.rb', __FILE__)
+  Version.load
+end

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

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+
+# Namespace for Rake tasks using an Inventory.
+module Inventory::Rake::Tasks
+  @mostlycleanfiles, @cleanfiles, @distcleanfiles = [], [], []
+
+  class << self
+    # @param [Inventory] value
+    # @return [Inventory] The default inventory to use for tasks
+    attr_accessor :inventory
+
+    # @return [Array<String>] The files to clean when running the “mostlyclean”
+    #   task
+    attr_reader :mostlycleanfiles
+
+    # @return [Array<String>] The files to clean when running the “clean” task
+    attr_reader :cleanfiles
+
+    # @return [Array<String>] The files to clean when running the “distclean”
+    #   task
+    attr_reader :distcleanfiles
+
+    # Sets the default {.inventory} to INVENTORY, then defines {Clean},
+    # {Compile}, {Inventory}, and {Gem} tasks.
+    #
+    # A task named “check” will already have been created.  This task is meant
+    # to depend on tasks that check the package before distribution.
+    #
+    # @param [Inventory] inventory
+    # @param [Hash] options
+    # @option options [#to_proc] :gem (proc{}) Block to pass to
+    #   {Gem#initialize}
+    # @return [self]
+    def define(inventory, options = {})
+      self.inventory = inventory
+      Clean.define
+      Compile.new :inventory => inventory
+      Inventory.new :inventory => inventory
+      Gem.new(:inventory => inventory, &options.fetch(:gem, proc{}))
+      self
+    end
+
+    # Yields if the top-level tasks that Rake’s running don’t include any of
+    #
+    # * deps:install
+    # * deps:install:user
+    # * gem:deps:install
+    # * gem:deps:install:user
+    #
+    # that is, Rake’s not being run to install the inventory’s dependencies.
+    #
+    # @yield [?]
+    # @return [self]
+    def unless_installing_dependencies
+      yield if (%w'deps:install
+                   deps:install:user
+                   gem:deps:install
+                   gem:deps:install:user' &
+                Rake.application.top_level_tasks).empty?
+      self
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# -*- coding: utf-8 -*-
+
+# Tasks for cleaning up a project directory.
+class Inventory::Rake::Tasks::Clean
+  include Rake::DSL
+
+  class << self
+    include Rake::DSL
+
+    def define
+      # Defines the following tasks:
+      #
+      # <dl>
+      #   <dt>mostlyclean</dt>
+      #   <dd>Delete targets built by rake that are ofter rebuilt.</dd>
+      #
+      #   <dt>clean</dt>
+      #   <dd>Delete targets builty by rake; depends on mostlyclean.</dd>
+      #
+      #   <dt>distclean</dt>
+      #   <dd>Delete all files not meant for distribution; depends on
+      #   clean.</dd>
+      # </dl>
+      desc 'Delete targets built by rake that are often rebuilt'
+      new :mostlyclean, Inventory::Rake::Tasks.mostlycleanfiles
+
+      desc 'Delete targets built by rake'
+      new :clean, Inventory::Rake::Tasks.cleanfiles
+      task :clean => :mostlyclean
+
+      desc 'Delete all files not meant for distribution'
+      new :distclean, Inventory::Rake::Tasks.distcleanfiles
+      task :distclean => :clean
+    end
+  end
+
+  # Sets up a cleaning task {#name} that’ll delete {#files}, optionally yields
+  # the task for further customization, then {#define}s the task.
+  #
+  # @param [Symbol] name
+  # @param [Array<String>] files
+  # @yield [?]
+  # @yieldparam [self] task
+  def initialize(name, files = [])
+    @name, @files = name, files
+    yield self if block_given?
+    define
+  end
+
+  # Defines the task {#name} that’ll delete {#files}.
+  def define
+    task name do
+      rm files, :force => true
+    end
+  end
+
+  # @param [Symbol] value
+  # @return [Symbol] The name of the task
+  attr_accessor :name
+
+  # @param [Array<String>] value
+  # @return [Array<String>] The files to delete
+  attr_accessor :files
+end

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

@@ -0,0 +1,99 @@
+# -*- coding: utf-8 -*-
+
+# Defines tasks for compiling and cleaning extensions.
+class Inventory::Rake::Tasks::Compile
+  include Rake::DSL
+
+  # Sets up tasks based on INVENTORY, optionally yields the task object for
+  # further customization, then {#define}s the tasks.
+  #
+  # @param [Hash] options
+  # @option options [Inventory] :inventory (Inventory::Rake::Tasks.inventory)
+  #   The inventory to use
+  # @yield [?]
+  # @yieldparam [self] task
+  def initialize(options = {})
+    self.inventory = options.fetch(:inventory, Inventory::Rake::Tasks.inventory)
+    yield self if block_given?
+    define
+  end
+
+  # Defines the following task:
+  #
+  # <dl>
+  #   <dt>compile</dt>
+  #   <dd>Compile all extensions; depends on each compile:<em>name</em>.</dd>
+  # </dl>
+  #
+  # Then, for each extension in the inventory, define the following tasks:
+  #
+  # <dl>
+  #   <dt>compile:<em>name</em></dt>
+  #   <dd>Compile extension <em>name</em>; depends on
+  #   lib/<em>path</em>/<em>so</em> file.</dd>
+  #
+  #   <dt>lib/<em>path</em>/<em>so</em></dt>
+  #   <dd>Installed dynamic library of extension <em>name</em> inside inventory
+  #   path; depends on ext/<em>name</em>/<em>so</em>.</dd>
+  #
+  #   <dt>ext/<em>name</em>/<em>so</em></dt>
+  #   <dd>Dynamic library of extension <em>name</em>; depends on
+  #   ext/<em>name</em>/Makefile and the source files of the extension.</dd>
+  #
+  #   <dt>ext/<em>name</em>/Makefile</dt>
+  #   <dd>Makefile for extension <em>name</em>; depends on inventory path,
+  #   ext/<em>name</em>/extconf.rb file, and ext/<em>name</em>/depend file.</dd>
+  #
+  #   <dt>clean:<em>name</em></dt>
+  #   <dd>Clean files built for extension <em>name</em>; depended upon by
+  #   clean.</dd>
+  # </dl>
+  #
+  # Finally, if defined, the test task is set to depend on the compile task.
+  def define
+    desc 'Compile extensions' unless Rake::Task.task_defined? :compile
+    task :compile
+
+    @inventory.extensions.each do |extension|
+      name = :"compile:#{extension}"
+      makefile = '%s/Makefile' % extension.directory
+      ext_so = '%s/%s.%s' % [extension.directory,
+                             extension.name.delete('-'),
+                             RbConfig::CONFIG['DLEXT']]
+      lib_so = 'lib/%s/%s' % [@inventory.package_path, File.basename(ext_so)]
+
+      task :compile => name
+
+      task name => lib_so
+
+      file lib_so => ext_so do
+        install ext_so, lib_so
+      end
+
+      file ext_so => [makefile] + extension.source_files do
+        sh 'make -C %s' % extension.directory
+      end
+
+      file makefile => [@inventory.path, extension.extconf, extension.depend] do
+        Dir.chdir extension.directory do
+          ENV['CFLAGS'] = '-Werror' unless ENV['CFLAGS']
+          ruby File.basename(extension.extconf)
+        end
+      end
+
+      clean_name = :"clean:#{extension}"
+      desc 'Clean files built for extension %s' % extension
+      task clean_name do
+        sh 'make -C %s %s' % [extension.directory, rule]
+      end
+
+      task :clean => clean_name
+    end
+
+    task :test => :compile if Rake::Task.task_defined? :test
+  end
+
+  # @param [Inventory] value
+  # @return [Inventory] The inventory to use: VALUE
+  attr_writer :inventory
+end

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

@@ -1,8 +1,30 @@
 # -*- coding: utf-8 -*-
 
+# Defines [RubyGems](http://rubygems.org/)-related tasks.  This includes tasks
+# for generating a gem specification, creating a gem file, checking the gem
+# file before distribution, installing gem dependencies, installing and
+# uninstalling the gem locally, and pushing the gem to a distribution point.
 class Inventory::Rake::Tasks::Gem
   include Rake::DSL
 
+  # Sets up tasks based on INVENTORY and SPECIFICATION, optionally yields the
+  # task object and the gem specification for further customization, then
+  # {#define}s the tasks.
+  #
+  # The default for SPECIFICATION is to use the name, version, and files of the
+  # inventory, use all of `README` as the description, set the summary to the
+  # first sentence of the description, set the require paths to “lib”, add each
+  # extension of the inventory’s extconf to the extensions, and finally add
+  # inventory’s dependencies.
+  #
+  # @param [Hash] options
+  # @option options [Inventory] :inventory (Inventory::Rake::Tasks.inventory)
+  #   The inventory to use
+  # @option options [Gem::Specification] :specification The specification to
+  #   use
+  # @yield [?]
+  # @yieldparam [self] task
+  # @yieldparam [Gem::Specification] specification
   def initialize(options = {})
     self.inventory = options.fetch(:inventory, Inventory::Rake::Tasks.inventory)
     self.specification = options.fetch(:specification,
@@ -19,12 +41,94 @@ class Inventory::Rake::Tasks::Gem
 
                                          s.require_paths = @inventory.lib_directories
 
+                                         s.extensions = @inventory.extensions.map(&:extconf)
+
                                          @inventory.dependencies.add_to_gem_specification s
                                        })
     yield self, @specification if block_given?
     define
   end
 
+  # Defines the following tasks:
+  #
+  # <dl>
+  #   <dt>spec</dt>
+  #   <dd>Create specifications; depends on gem:spec.</dd>
+  #
+  #   <dt>gem:spec</dt>
+  #   <dd>Create gem specification; depends on <em>gemspec</em>.</dd>
+  #
+  #   <dt>gemspec (file)</dt>
+  #   <dd>Gem specification file; depends on Rakefile, README, and inventory
+  #   path.</dd>
+  #
+  #   <dt>dist</dt>
+  #   <dd>Create files for distribution; depends on gem:dist.</dd>
+  #
+  #   <dt>gem:dist</dt>
+  #   <dd>Create gem for distribution; depends on inventory:check and
+  #   <em>gem</em> file.</dd>
+  #
+  #   <dt>gem (file)</dt>
+  #   <dd>Gem file; depends on files included in gem.</dd>
+  #
+  #   <dt>dist:check</dt>
+  #   <dd>Check files before distribution; depends on dist and
+  #   gem:dist:check.</dd>
+  #
+  #   <dt>gem:dist:check</dt>
+  #   <dd>Check gem before distribution; depends on gem:dist.</dd>
+  #
+  #   <dt>deps:install</dt>
+  #   <dd>Install dependencies on the local system; depends on
+  #   gem:deps:install.</dd>
+  #
+  #   <dt>gem:deps:install</dt>
+  #   <dd>Install dependencies in ruby gem directory.</dd>
+  #
+  #   <dt>deps:install:user</dt>
+  #   <dd>Install dependencies for the current user; depends on
+  #   gem:deps:install:user.</dd>
+  #
+  #   <dt>gem:deps:install:user</dt>
+  #   <dd>Install dependencies in the user gem directory.</dd>
+  #
+  #   <dt>install</dt>
+  #   <dd>Install distribution files on the local system; depends on
+  #   gem:install.</dd>
+  #
+  #   <dt>gem:install</dt>
+  #   <dd>Install <em>gem</em> in ruby gem directory; depends on gem:dist.</dd>
+  #
+  #   <dt>install:user</dt>
+  #   <dd>Install distribution files for the current user; depends on
+  #   gem:install:user.</dd>
+  #
+  #   <dt>gem:install:user</dt>
+  #   <dd>Install <em>gem</em> in the user gem directory.</dd>
+  #
+  #   <dt>uninstall</dt>
+  #   <dd>Delete all files installed on the local system.</dd>
+  #
+  #   <dt>gem:uninstall</dt>
+  #   <dd>Uninstall <em>gem</em> from ruby gem directory.</dd>
+  #
+  #   <dt>uninstall:user</dt>
+  #   <dd>Delete all files installed for current user.</dd>
+  #
+  #   <dt>gem:uninstall:user</dt>
+  #   <dd>Uninstall <em>gem</em> from ruby gem directory.</dd>
+  #
+  #   <dt>push</dt>
+  #   <dd>Push distribution files to distribution hubs.</dd>
+  #
+  #   <dt>gem:push</dt>
+  #   <dd>Push <em>gem</em> to rubygems.org.</dd>
+  # </dl>
+  #
+  # The gemspec will be added to {Inventory::Rake::Tasks.cleanfiles}.
+  #
+  # @return [self]
   def define
     desc 'Create specifications' unless Rake::Task.task_defined? :spec
     task :spec => :'gem:spec'
@@ -54,8 +158,9 @@ class Inventory::Rake::Tasks::Gem
     task :'gem:dist' => [:'inventory:check', @specification.file_name]
     file @specification.file_name => @specification.files do
       require 'rubygems' unless defined? Gem
+      require 'rubygems/package' unless defined? Gem::Package
       rake_output_message 'gem build %s' % gemspec if verbose
-      Gem::Builder.new(@specification).build
+      Gem::Package.build @specification
     end
 
     desc 'Check files before distribution' unless
@@ -96,7 +201,7 @@ class Inventory::Rake::Tasks::Gem
       Rake::Task.task_defined? :'deps:install:user'
     task :'deps:install:user' => :'gem:deps:install:user'
 
-    desc 'Install dependencies for the current user'
+    desc 'Install dependencies in the current user’s ruby gem directory'
     task :'gem:deps:install:user' do
       require 'rubygems' unless defined? Gem
       require 'rubygems/dependency_installer' unless defined? Gem::DependencyInstaller
@@ -185,7 +290,15 @@ class Inventory::Rake::Tasks::Gem
     task :'gem:push' => :'gem:dist:check' do
       sh 'gem push -%s-verbose %s' % [verbose ? '' : '-no', @specification.file_name]
     end
+
+    self
   end
 
-  attr_writer :inventory, :specification
+  # @param [Inventory] value
+  # @return [Inventory] The inventory to use: VALUE
+  attr_writer :inventory
+
+  # @param [Gem::Specification] value
+  # @return [Gem::Specification] The specification to use: VALUE
+  attr_writer :specification
 end

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

@@ -0,0 +1,53 @@
+# -*- coding: utf-8 -*-
+
+# Tasks related to the inventory.
+class Inventory::Rake::Tasks::Inventory
+  include Rake::DSL
+
+  # Sets up tasks based on INVENTORY, optionally yields the task object for
+  # further customization, then {#define}s the tasks.
+  #
+  # @param [Hash] options
+  # @option options [Inventory] :inventory (Inventory::Rake::Tasks.inventory)
+  #   The inventory to use
+  # @option options [String] :pattern
+  #   ('{ext/**/*.{[ch],rb},{lib/test}/**/*.rb}') The pattern to use when
+  #   looking for files not listed in inventory
+  # @yield [?]
+  # @yieldparam [self] task
+  def initialize(options = {})
+    self.inventory = options.fetch(:inventory, Inventory::Rake::Tasks.inventory)
+    self.pattern = options.fetch(:pattern, '{ext/**/*.{[ch],rb},{lib,test}/**/*.rb}')
+    yield self if block_given?
+    define
+  end
+
+  # Defines the following task:
+  #
+  # <dl>
+  #   <dt>inventory:check</dt>
+  #   <dd>Check that the inventory is correct by looking for files not listed
+  #   in the inventory that match the pattern and for files listed in the
+  #   inventory that don’t exist; depends on distclean.</dd>
+  # </dl>
+  def define
+    desc 'Check that the inventory is correct'
+    task :'inventory:check' => :distclean do
+      diff = ((Dir[@pattern] -
+               @inventory.extensions.map(&:source_files) -
+               @inventory.lib_files -
+               @inventory.unit_test_files).map{ |e| '%s: file not listed in inventory' % e } +
+              @inventory.files.reject{ |e| File.exist? e }.map{ |e| '%s: file listed in inventory does not exist' % e })
+      fail diff.join("\n") unless diff.empty?
+      # TODO: puts 'inventory checks out' if verbose
+    end
+  end
+
+  # @param [Inventory] value
+  # @return [Inventory] The inventory to use: VALUE
+  attr_writer :inventory
+
+  # @param [String] value
+  # @return [String] The pattern to use: VALUE
+  attr_writer :pattern
+end

data/lib/inventory-rake-1.0/version.rb

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+
+require 'inventory-1.0'
+
+module Inventory::Rake
+  Version = Inventory.new(1, 4, 0){
+    def dependencies
+      super + Inventory::Dependencies.new{
+        development 'lookout', 3, 0, 0
+        development 'lookout-rake', 3, 0, 0
+        development 'yard', 0, 8, 0
+        development 'yard-heuristics', 1, 1, 0
+        runtime 'rake', 0, 9, 2, :feature => 'rake'
+      }
+    end
+
+    def package_libs
+      %w[tasks.rb
+         tasks/check.rb
+         tasks/clean.rb
+         tasks/compile.rb
+         tasks/gem.rb
+         tasks/inventory.rb]
+    end
+
+    def additional_libs
+      super + %w[inventory/rake-1.0.rb]
+    end
+
+    def unit_tests
+      super - %w[inventory/rake-1.0.rb]
+    end
+  }
+end

data/lib/inventory/rake-1.0.rb

@@ -1,10 +1,4 @@
 # -*- coding: utf-8 -*-
 
-# Namespace for Inventory, see {http://disu.se/software/inventory}.
-class Inventory; end
-
-# Namespace for Rake integration of Inventory.
-module Inventory::Rake
-  load File.expand_path('../rake/version.rb', __FILE__)
-  Version.load
-end
+warn "requiring 'inventory/rake-1.0' is deprecated; require 'inventory-rake-1.0' instead"
+require 'inventory-rake-1.0'

data/test/unit/inventory-rake-1.0/version.rb

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

metadata

@@ -1,89 +1,259 @@
 --- !ruby/object:Gem::Specification
 name: inventory-rake
 version: !ruby/object:Gem::Version
-  version: 1.3.0
-  prerelease: 
+  version: 1.4.0
 platform: ruby
 authors:
 - Nikolai Weibull
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-27 00:00:00.000000000 Z
+date: 2013-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inventory
-  requirement: &3960924 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.4'
   type: :runtime
   prerelease: false
-  version_requirements: *3960924
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: lookout
-  requirement: &3960240 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *3960240
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: lookout-rake
-  requirement: &3959652 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *3959652
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.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: rake
-  requirement: &3959232 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.2
   type: :runtime
   prerelease: false
-  version_requirements: *3959232
-description: ! "                                Inventory-Rake\n\n  Inventory-Rake
-  provides Rake tasks for your Inventory¹.  This includes\n  cleaning tasks, gem generation,
-  testing, installation, uninstallation, and\n  pushing, and inventory content checking.\n\n¹
-  Get information on Inventory at http://disu.se/software/inventory/\n\n§ Installation\n\n
-  \   Install Inventory-Rake with\n\n    % gem install inventory-rake\n\n§ Usage\n\n
-  \   Include the following code in your ‹Rakefile›, where ‹Package› is the\n    top-level
-  module of your package:\n\n      require 'inventory/rake-3.0'\n\n      Inventory::Rake::Tasks.define
-  Package::Version, :gem => proc{ |_, s|\n        s.author = 'Your Name'\n        s.email
-  = 'your@email.com'\n        s.homepage = 'https://github.com/now/%s' % Package.name.downcase\n
-  \     }\n"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+description: |2
+                                  Inventory-Rake
+
+    Inventory-Rake provides Rake¹ tasks for your Inventory².  This includes tasks
+    for cleaning up our project, compiling extensions, installing dependencies,
+    installing and uninstalling the project itself, and creating and pushing
+    distribution files to distribution points.
+
+  ¹ See http://rake.rubyforge.org/
+  ² See http://disu.se/software/inventory/
+
+  § Installation
+
+      Install Inventory-Rake with
+
+      % gem install inventory-rake
+
+  § Usage
+
+      Include the following code in your ‹Rakefile›, where ‹Package› is the
+      top-level module of your project:
+
+        require 'inventory-rake-3.0'
+
+        load File.expand_path('../lib/package/version.rb', __FILE__)
+
+        Inventory::Rake::Tasks.define Package::Version, :gem => proc{ |_, s|
+          s.author = 'Your Name'
+          s.email = 'you@example.com'
+          s.homepage = 'http://example.com/'
+        }
+
+        Inventory::Rake::Tasks.unless_installing_dependencies do
+          # Any additional tasks that your project’s dependencies provide
+        end
+
+      ‹Inventory::Rake::Tasks.define› does the heavy lifting.  It takes our
+      inventory and sets up the tasks mentioned above.  We also do some
+      additional customization of the gem specification.
+
+      As we want to be able to use our Rakefile to install our dependencies for
+      us, the rest of the Rakefile is inside the conditional
+      #unless_installing_dependencies, which, as the name certainly implies,
+      executes its block unless the task being run is the one that installs our
+      dependencies.  This becomes relevant if we want to, for example, set up
+      Travis¹ integration.  To do so, simply add
+
+        before_script:
+          - gem install inventory-rake -v '~> VERSION' --no-rdoc --no-ri
+          - rake gem:deps:install
+
+      to your ‹.travis.yml› file.  This’ll make sure that Travis installs all
+      development, runtime, and optional dependencies that you’ve listed in your
+      inventory before running any tests.
+
+      There’s more information in the {API documentation}² that you’ll likely
+      want to read up on if anything is unclear.
+
+  ¹ See http://travis-ci.org/
+  ² See http://disu.se/software/inventory/api/inventory-rake/
+
+  § Tasks
+
+      The tasks that are created if you use Inventory-Rake are:
+
+    = check. = Check that the package meets its expectations.
+    = mostlyclean. = Delete targets built by rake that are ofter rebuilt.
+    = clean. = Delete targets built by rake; depends on mostlyclean.
+    = distclean. = Delete all files not meant for distribution; depends on clean.
+    = compile. = Compile all extensions; depends on each compile:name.
+    = compile:name. = Compile extension /name/; depends on
+        lib/path/so file.
+    = lib/path/so. = Installed dynamic library of extension /name/ inside
+        inventory path; depends on ext/name/so.
+    = ext/name/so. = Dynamic library of extension /name/; depends on
+        ext/name/Makefile and the source files of the extension.
+    = ext/name/Makefile. = Makefile for extension /name/; depends on inventory
+        path, ext/name/extconf.rb file, and ext/name/depend file.
+    = clean:name. = Clean files built for extension /name/; depended upon by
+        clean.
+    = spec. = Create specifications; depends on gem:spec.
+    = gem:spec. = Create gem specification; depends on gemspec.
+    = gemspec (file). = Gem specification file; depends on Rakefile, README, and
+        inventory path.
+    = dist. = Create files for distribution; depends on gem:dist.
+    = gem:dist. = Create gem for distribution; depends on inventory:check and gem
+        file.
+    = inventory:check. = Check that the inventory is correct by looking for files
+        not listed in the inventory that match the pattern and for files listed
+        in the inventory that don’t exist; depends on distclean.
+    = gem (file). = Gem file; depends on files included in gem.
+    = dist:check. = Check files before distribution; depends on dist and
+        gem:dist:check.
+    = gem:dist:check. = Check gem before distribution; depends on gem:dist.
+    = deps:install. = Install dependencies on the local system; depends on
+        gem:deps:install.
+    = gem:deps:install. = Install dependencies in ruby gem directory.
+    = deps:install:user. = Install dependencies for the current user; depends on
+        gem:deps:install:user.
+    = gem:deps:install:user. = Install dependencies in the user gem directory.
+    = install. = Install distribution files on the local system; depends on
+        gem:install.
+    = gem:install. = Install gem in ruby gem directory; depends on gem:dist.
+    = install:user. = Install distribution files for the current user; depends on
+        gem:install:user.
+    = gem:install:user. = Install gem in the user gem directory.
+    = uninstall. = Delete all files installed on the local system.
+    = gem:uninstall. = Uninstall gem from ruby gem directory.
+    = uninstall:user. = Delete all files installed for current user.
+    = gem:uninstall:user. = Uninstall gem from ruby gem directory.
+    = push. = Push distribution files to distribution hubs.
+    = gem:push. = Push gem to rubygems.org.
+
+  § 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/issues
+
+  § Authors
+
+      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.rb
-- lib/inventory/rake/tasks/check.rb
-- lib/inventory/rake/tasks/clean.rb
-- lib/inventory/rake/tasks/gem.rb
-- lib/inventory/rake/tasks/inventory.rb
+- lib/inventory-rake-1.0/tasks.rb
+- lib/inventory-rake-1.0/tasks/check.rb
+- lib/inventory-rake-1.0/tasks/clean.rb
+- lib/inventory-rake-1.0/tasks/compile.rb
+- lib/inventory-rake-1.0/tasks/gem.rb
+- lib/inventory-rake-1.0/tasks/inventory.rb
+- lib/inventory-rake-1.0.rb
+- lib/inventory-rake-1.0/version.rb
 - lib/inventory/rake-1.0.rb
-- lib/inventory/rake/version.rb
-- test/unit/inventory/rake/tasks.rb
-- test/unit/inventory/rake/tasks/check.rb
-- test/unit/inventory/rake/tasks/clean.rb
-- test/unit/inventory/rake/tasks/gem.rb
-- test/unit/inventory/rake/tasks/inventory.rb
-- test/unit/inventory/rake-1.0.rb
-- test/unit/inventory/rake/version.rb
+- test/unit/inventory-rake-1.0/tasks.rb
+- test/unit/inventory-rake-1.0/tasks/check.rb
+- test/unit/inventory-rake-1.0/tasks/clean.rb
+- test/unit/inventory-rake-1.0/tasks/compile.rb
+- test/unit/inventory-rake-1.0/tasks/gem.rb
+- test/unit/inventory-rake-1.0/tasks/inventory.rb
+- test/unit/inventory-rake-1.0.rb
+- test/unit/inventory-rake-1.0/version.rb
 - README
 - Rakefile
 homepage: https://github.com/now/inventory-rake
@@ -94,21 +264,19 @@ 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
+rubygems_version: 2.0.0
 signing_key: 
 specification_version: 4
-summary: Inventory-Rake provides Rake tasks for your Inventory¹.
+summary: Inventory-Rake provides Rake¹ tasks for your Inventory².
 test_files: []

data/lib/inventory/rake/tasks.rb

@@ -1,27 +0,0 @@
-# -*- coding: utf-8 -*-
-
-# Namespace for Rake tasks.
-module Inventory::Rake::Tasks
-  @mostlycleanfiles, @cleanfiles, @distcleanfiles = [], [], []
-
-  class << self
-    attr_accessor :inventory
-
-    attr_reader :mostlycleanfiles, :cleanfiles, :distcleanfiles
-
-    def define(inventory, options = {})
-      self.inventory = inventory
-      Clean.define
-      Inventory.new(:inventory => inventory)
-      Gem.new(:inventory => inventory, &(options.fetch(:gem, proc{ })))
-    end
-
-    def unless_installing_dependencies
-      yield if (%w'deps:install
-                   deps:install:user
-                   gem:deps:install
-                   gem:deps:install:user' &
-                Rake.application.top_level_tasks).empty?
-    end
-  end
-end

data/lib/inventory/rake/tasks/clean.rb

@@ -1,35 +0,0 @@
-# -*- coding: utf-8 -*-
-
-class Inventory::Rake::Tasks::Clean
-  include Rake::DSL
-
-  class << self
-    include Rake::DSL
-
-    def define
-      desc 'Delete targets built by rake that are often rebuilt'
-      new :mostlyclean, Inventory::Rake::Tasks.mostlycleanfiles
-
-      desc 'Delete targets built by rake'
-      new :clean, Inventory::Rake::Tasks.cleanfiles
-      task :clean => :mostlyclean
-
-      desc 'Delete targets built by extconf.rb'
-      new :distclean, Inventory::Rake::Tasks.distcleanfiles
-      task :distclean => :clean
-    end
-  end
-
-  def initialize(name, files = [])
-    @name, @files = name, files
-    define
-  end
-
-  def define
-    task name do
-      rm files, :force => true
-    end
-  end
-
-  attr_accessor :name, :files
-end

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

@@ -1,27 +0,0 @@
-# -*- coding: utf-8 -*-
-
-class Inventory::Rake::Tasks::Inventory
-  include Rake::DSL
-
-  def initialize(options = {})
-    self.inventory = options.fetch(:inventory, Inventory::Rake::Tasks.inventory)
-    yield self if block_given?
-    define
-  end
-
-  def define
-    desc 'Check that the inventory is correct'
-    task :'inventory:check' do
-      # TODO: Use directories from Inventory instead of hard-coding lib and
-      # test/unit.  We want to check ext too?
-      diff = ((Dir['{lib,test/unit}/**/*.rb'] -
-               @inventory.lib_files -
-               @inventory.unit_test_files).map{ |e| 'file not listed in inventory: %s' % e } +
-              @inventory.files.reject{ |e| File.exist? e }.map{ |e| 'file listed in inventory does not exist: %s' % e })
-      fail diff.join("\n") unless diff.empty?
-      # TODO: puts 'inventory checks out' if verbose
-    end
-  end
-
-  attr_writer :inventory
-end

data/lib/inventory/rake/version.rb

@@ -1,31 +0,0 @@
-# -*- coding: utf-8 -*-
-
-require 'inventory-1.0'
-
-module Inventory::Rake
-  Version = Inventory.new(1, 3, 0){
-    def dependencies
-      super + Inventory::Dependencies.new{
-        development 'lookout', 3, 0, 0
-        development 'lookout-rake', 3, 0, 0
-        optional 'rake', 0, 9, 2
-      }
-    end
-
-    def requires
-      %w'
-        rake
-      '
-    end
-
-    def libs
-      %w'
-        inventory/rake/tasks.rb
-        inventory/rake/tasks/check.rb
-        inventory/rake/tasks/clean.rb
-        inventory/rake/tasks/gem.rb
-        inventory/rake/tasks/inventory.rb
-      '
-    end
-  }
-end