autobuild 1.6.2.b11 → 1.6.2.b12

data/lib/autobuild/package.rb

@@ -101,7 +101,7 @@ module Autobuild
         # false.
         def updated?; !!@updated end
 
-	def initialize(spec)
+	def initialize(spec = Hash.new)
 	    @dependencies   = Array.new
 	    @provides       = Array.new
             @parallel_build_level = nil
@@ -374,27 +374,31 @@ module Autobuild
         # In general, specific package types define a meaningful #with_doc
         # method which calls this method internally.
         def doc_task
-            task "#{name}-doc" do
-                @installed_doc = false
-                catch(:doc_disabled) do
-                    begin
-                        yield if block_given?
-
-                        unless @installed_doc
-                            install_doc
-                        end
+            @doc_task = task "#{name}-doc" do
+                # This flag allows to disable documentation generation
+                # once doc_task has been called
+                if generates_doc?
+                    @installed_doc = false
+                    catch(:doc_disabled) do
+                        begin
+                            yield if block_given?
+
+                            unless @installed_doc
+                                install_doc
+                            end
 
-                    rescue Interrupt
-                        raise
-                    rescue ::Exception => e
-                        if Autobuild.doc_errors
+                        rescue Interrupt
                             raise
-                        else
-                            warn "%s: failed to generate documentation"
-                            if e.kind_of?(SubcommandFailed)
-                                warn "%s: see #{e.logfile} for more details"
+                        rescue ::Exception => e
+                            if Autobuild.doc_errors
+                                raise
                             else
-                                warn "%s: #{e.message}"
+                                warn "%s: failed to generate documentation"
+                                if e.kind_of?(SubcommandFailed)
+                                    warn "%s: see #{e.logfile} for more details"
+                                else
+                                    warn "%s: #{e.message}"
+                                end
                             end
                         end
                     end
@@ -404,6 +408,30 @@ module Autobuild
             task :doc => "#{name}-doc"
         end
 
+        # True if some documentation will be generated and false otherwise.
+        #
+        # This will return true only if a documentation task has been defined by
+        # calling #doc_task _and_ #disable_doc has not been called (or if
+        # #enable_doc has been called after the last call to #disable_doc).
+        def generates_doc?
+            if @doc_disabled
+                return false
+            else
+                return !!@doc_task
+            end
+        end
+
+        # Re-enables documentation generation after #disable_doc has been called
+        def enable_doc
+            @doc_disabled = false
+        end
+
+        # Disables any documentation generation, regardless of whether doc_task
+        # has been called or not.
+        def disable_doc
+            @doc_disabled = true
+        end
+
         def install_doc
             if !File.directory?(self.doc_dir)
                 raise "#{self.doc_dir} was expected to be a directory, but it is not. Check the package's documentation generation, the generated documentation should be in #{self.doc_dir}"

data/lib/autobuild/version.rb

@@ -1,5 +1,5 @@
 module Autobuild
-    VERSION = "1.6.2.b11" unless defined? Autobuild::VERSION
+    VERSION = "1.6.2.b12" unless defined? Autobuild::VERSION
 end
 
 

data/test/test_package.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift File.expand_path('..', File.dirname(__FILE__))
+$LOAD_PATH << File.expand_path('../lib', File.dirname(__FILE__))
+require 'test/unit'
+require 'test/tools'
+require 'autobuild'
+
+class TC_Package < Test::Unit::TestCase
+    include Autobuild
+
+    def test_generates_doc_p
+        pkg = Autobuild::Package.new
+        assert !pkg.generates_doc?
+        pkg.doc_task
+        assert pkg.generates_doc?
+        pkg.disable_doc
+        assert !pkg.generates_doc?
+        pkg.enable_doc
+        assert pkg.generates_doc?
+    end
+end
+

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: autobuild
 version: !ruby/object:Gem::Version 
-  hash: -3493996294
+  hash: 4225852661
   prerelease: 6
   segments: 
   - 1
   - 6
   - 2
   - b
-  - 11
-  version: 1.6.2.b11
+  - 12
+  version: 1.6.2.b12
 platform: ruby
 authors: 
 - Sylvain Joyeux
@@ -134,6 +134,7 @@ files:
 - test/test_import_tar.rb
 - test/test_subcommand.rb
 - test/tools.rb
+- test/test_package.rb
 - .gemtest
 homepage: http://rock-robotics.org/stable/documentation/autoproj
 licenses: []
@@ -175,4 +176,5 @@ test_files:
 - test/test_import_svn.rb
 - test/test_import_tar.rb
 - test/test_subcommand.rb
+- test/test_package.rb
 - test/test_import_cvs.rb