buildr 1.3.5-java → 1.4.0-java

data/lib/buildr/java/commands.rb

@@ -27,6 +27,12 @@ module Java
       #
       # Runs Java with the specified arguments.
       #
+      # Each argument should be provided as separate array value, e.g.
+      #
+      #  java("-jar", "yuicompressor-2.4.2.jar", "--type","css",
+      #       "src/main/webapp/styles/styles-all.css",
+      #       "-o", "src/main/webapp/styles/styles-all-min.css")
+      #
       # The last argument may be a Hash with additional options:
       # * :classpath -- One or more file names, tasks or artifact specifications.
       #   These are all expanded into artifacts, and all tasks are invoked.
@@ -39,7 +45,11 @@ module Java
         options[:verbose] ||= Buildr.application.options.trace || false
         rake_check_options options, :classpath, :java_args, :properties, :name, :verbose
 
-        name = options[:name] || "java #{args.first}"
+        name = options[:name]
+        if name.nil?
+          name = "java #{args.first}"
+        end
+
         cmd_args = [path_to_bin('java')]
         classpath = classpath_from(options)
         cmd_args << '-classpath' << classpath.join(File::PATH_SEPARATOR) unless classpath.empty?
@@ -47,16 +57,15 @@ module Java
         cmd_args += (options[:java_args] || (ENV['JAVA_OPTS'] || ENV['JAVA_OPTIONS']).to_s.split).flatten
         cmd_args += args.flatten.compact
         unless Buildr.application.options.dryrun
-          info "Running #{name}"
+          info "Running #{name}" if name && options[:verbose]
           block = lambda { |ok, res| fail "Failed to execute #{name}, see errors above" unless ok } unless block
-          puts cmd_args.join(' ') if Buildr.application.options.trace
           cmd_args = cmd_args.map(&:inspect).join(' ') if Util.win_os?
           sh(*cmd_args) do |ok, ps|
             block.call ok, ps
           end
         end
       end
-  
+
       # :call-seq:
       #   apt(*files, options)
       #
@@ -127,7 +136,7 @@ module Java
           info "Compiling #{files.size} source files in #{name}"
           trace (['javac'] + cmd_args).join(' ')
           Java.load
-          Java.com.sun.tools.javac.Main.compile(cmd_args.to_java(Java.java.lang.String)) == 0 or 
+          Java.com.sun.tools.javac.Main.compile(cmd_args.to_java(Java.java.lang.String)) == 0 or
             fail 'Failed to compile, see errors above'
         end
       end

data/lib/buildr/java/compiler.rb

@@ -36,7 +36,7 @@ module Buildr
     # * :source      -- Source code compatibility.
     # * :target      -- Bytecode compatibility.
     # * :lint        -- Lint option is one of true, false (default), name (e.g. 'cast') or array.
-    # * :other       -- Array of options passed to the compiler 
+    # * :other       -- Array of options passed to the compiler
     # (e.g. ['-implicit:none', '-encoding', 'iso-8859-1'])
     class Javac < Base
 
@@ -47,7 +47,7 @@ module Buildr
       def initialize(project, options) #:nodoc:
         super
         options[:debug] = Buildr.options.debug if options[:debug].nil?
-        options[:warnings] = verbose if options[:warnings].nil?
+        options[:warnings] ||= false
         options[:deprecation] ||= false
         options[:lint] ||= false
       end
@@ -74,7 +74,7 @@ module Buildr
     private
 
       def javac_args #:nodoc:
-        args = []  
+        args = []
         args << '-nowarn' unless options[:warnings]
         args << '-verbose' if Buildr.application.options.trace
         args << '-g' if options[:debug]
@@ -90,219 +90,6 @@ module Buildr
       end
 
     end
-    
-  end
-
-
-  # Methods added to Project for creating JavaDoc documentation.
-  module Javadoc
-
-    # A convenient task for creating Javadocs from the project's compile task. Minimizes all
-    # the hard work to calling #from and #using.
-    #
-    # For example:
-    #   javadoc.from(projects('myapp:foo', 'myapp:bar')).using(:windowtitle=>'My App')
-    # Or, short and sweet:
-    #   desc 'My App'
-    #   define 'myapp' do
-    #     . . .
-    #     javadoc projects('myapp:foo', 'myapp:bar')
-    #   end
-    class JavadocTask < Rake::Task
-
-      def initialize(*args) #:nodoc:
-        super
-        @options = {}
-        @classpath = []
-        @sourcepath = []
-        @files = FileList[]
-        enhance do |task|
-          rm_rf target.to_s
-          generate source_files, File.expand_path(target.to_s), options.merge(:classpath=>classpath, :sourcepath=>sourcepath)
-          touch target.to_s
-        end
-      end
-
-      # The target directory for the generated Javadoc files.
-      attr_reader :target
-
-      # :call-seq:
-      #   into(path) => self
-      #
-      # Sets the target directory and returns self. This will also set the Javadoc task
-      # as a prerequisite to a file task on the target directory.
-      #
-      # For example:
-      #   package :zip, :classifier=>'docs', :include=>javadoc.target
-      def into(path)
-        @target = file(path.to_s).enhance([self]) unless @target && @target.to_s == path.to_s
-        self
-      end
-
-      # :call-seq:
-      #   include(*files) => self
-      #
-      # Includes additional source files and directories when generating the documentation
-      # and returns self. When specifying a directory, includes all .java files in that directory.
-      def include(*files)
-        @files.include *files.flatten.compact
-        self
-      end
-
-      # :call-seq:
-      #   exclude(*files) => self
-      #
-      # Excludes source files and directories from generating the documentation.
-      def exclude(*files)
-        @files.exclude *files
-        self
-      end
-
-      # Classpath dependencies.
-      attr_accessor :classpath
-
-      # :call-seq:
-      #   with(*artifacts) => self
-      #
-      # Adds files and artifacts as classpath dependencies, and returns self.
-      def with(*specs)
-        @classpath |= Buildr.artifacts(specs.flatten).uniq
-        self
-      end
-
-      # Additional sourcepaths that are not part of the documented files.
-      attr_accessor :sourcepath
-        
-      # Returns the Javadoc options.
-      attr_reader :options
-
-      # :call-seq:
-      #   using(options) => self
-      #
-      # Sets the Javadoc options from a hash and returns self.
-      #
-      # For example:
-      #   javadoc.using :windowtitle=>'My application'
-      def using(*args)
-        args.pop.each { |key, value| @options[key.to_sym] = value } if Hash === args.last
-        args.each { |key| @options[key.to_sym] = true }
-        self
-      end
-
-      # :call-seq:
-      #   from(*sources) => self
-      #
-      # Includes files, directories and projects in the Javadoc documentation and returns self.
-      #
-      # You can call this method with Java source files and directories containing Java source files
-      # to include these files in the Javadoc documentation, similar to #include. You can also call
-      # this method with projects. When called with a project, it includes all the source files compiled
-      # by that project and classpath dependencies used when compiling.
-      #
-      # For example:
-      #   javadoc.from projects('myapp:foo', 'myapp:bar')
-      def from(*sources)
-        sources.flatten.each do |source|
-          case source
-          when Project
-            self.enhance source.prerequisites
-            self.include source.compile.sources
-            self.with source.compile.dependencies 
-          when Rake::Task, String
-            self.include source
-          else
-            fail "Don't know how to generate Javadocs from #{source || 'nil'}"
-          end
-        end
-        self
-      end
-
-      def prerequisites() #:nodoc:
-        super + @files + classpath + sourcepath
-      end
-
-      def source_files() #:nodoc:
-        @source_files ||= @files.map(&:to_s).
-          map { |file| File.directory?(file) ? FileList[File.join(file, "**/*.java")] : file }.
-          flatten.reject { |file| @files.exclude?(file) }
-      end
-
-      def needed?() #:nodoc:
-        return false if source_files.empty?
-        return true unless File.exist?(target.to_s)
-        source_files.map { |src| File.stat(src.to_s).mtime }.max > File.stat(target.to_s).mtime
-      end
-
-    private
-
-      def generate(sources, target, options = {})
-        cmd_args = [ '-d', target, Buildr.application.options.trace ? '-verbose' : '-quiet' ]
-        options.reject { |key, value| [:sourcepath, :classpath].include?(key) }.
-          each { |key, value| value.invoke if value.respond_to?(:invoke) }.
-          each do |key, value|
-            case value
-            when true, nil
-              cmd_args << "-#{key}"
-            when false
-              cmd_args << "-no#{key}"
-            when Hash
-              value.each { |k,v| cmd_args << "-#{key}" << k.to_s << v.to_s }
-            else
-              cmd_args += Array(value).map { |item| ["-#{key}", item.to_s] }.flatten
-            end
-          end
-        [:sourcepath, :classpath].each do |option|
-          Array(options[option]).flatten.tap do |paths|
-            cmd_args << "-#{option}" << paths.flatten.map(&:to_s).join(File::PATH_SEPARATOR) unless paths.empty?
-          end
-        end
-        cmd_args += sources.flatten.uniq
-        unless Buildr.application.options.dryrun
-          info "Generating Javadoc for #{name}"
-          trace (['javadoc'] + cmd_args).join(' ')
-          Java.load
-          Java.com.sun.tools.javadoc.Main.execute(cmd_args.to_java(Java.java.lang.String)) == 0 or
-            fail 'Failed to generate Javadocs, see errors above'
-        end
-      end
-
-    end
-
-
-    include Extension
-
-    first_time do
-      desc 'Create the Javadocs for this project'
-      Project.local_task('javadoc')
-    end
-
-    before_define do |project|
-      JavadocTask.define_task('javadoc').tap do |javadoc|
-        javadoc.into project.path_to(:target, :javadoc)
-        javadoc.using :windowtitle=>project.comment || project.name
-      end
-    end
-
-    after_define do |project|
-      project.javadoc.from project
-    end
-
-    # :call-seq:
-    #   javadoc(*sources) => JavadocTask
-    #
-    # This method returns the project's Javadoc task. It also accepts a list of source files,
-    # directories and projects to include when generating the Javadocs.
-    #
-    # By default the Javadoc task uses all the source directories from compile.sources and generates
-    # Javadocs in the target/javadoc directory. This method accepts sources and adds them by calling
-    # JavadocsTask#from.
-    #
-    # For example, if you want to generate Javadocs for a given project that includes all source files
-    # in two of its sub-projects:
-    #   javadoc projects('myapp:foo', 'myapp:bar').using(:windowtitle=>'Docs for foo and bar')
-    def javadoc(*sources, &block)
-      task('javadoc').from(*sources).enhance &block
-    end
 
   end
 
@@ -344,6 +131,5 @@ end
 
 Buildr::Compiler << Buildr::Compiler::Javac
 class Buildr::Project
-  include Buildr::Javadoc
   include Buildr::Apt
 end

data/lib/buildr/java/deprecated.rb

@@ -44,7 +44,7 @@ module Java
       Buildr.application.deprecated 'See documentation for new way to access Java code.'
       yield self if block_given?
     end
-    
+
     # *Deprecated:* Use Java.load instead.
     def load
       Buildr.application.deprecated 'Use Java.load instead.'
@@ -66,19 +66,19 @@ module Java
     # *Deprecated*: Use Java::Commands.java instead.
     def java(*args, &block)
       return send(:method_missing, :java) if args.empty?
-      Buildr.application.deprecated 'Use Java::Commands.javadoc instead.'
+      Buildr.application.deprecated 'Use Java::Commands.java instead.'
       Commands.java(*args, &block)
     end
 
     # *Deprecated*: Use Java::Commands.apt instead.
     def apt(*args)
-      Buildr.application.deprecated 'Use Java::Commands.javadoc instead.'
+      Buildr.application.deprecated 'Use Java::Commands.apt instead.'
       Commands.apt(*args)
     end
 
     # *Deprecated*: Use Java::Commands.javac instead.
     def javac(*args)
-      Buildr.application.deprecated 'Use Java::Commands.javadoc instead.'
+      Buildr.application.deprecated 'Use Java::Commands.javac instead.'
       Commands.javac(*args)
     end
 

data/lib/buildr/java/doc.rb

@@ -0,0 +1,70 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership.  The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+require 'buildr/core/doc'
+
+module Buildr
+  module Doc
+
+    # A convenient task for creating Javadocs from the project's compile task. Minimizes all
+    # the hard work to calling #from and #using.
+    #
+    # For example:
+    #   doc.from(projects('myapp:foo', 'myapp:bar')).using(:windowtitle=>'My App')
+    # Or, short and sweet:
+    #   desc 'My App'
+    #   define 'myapp' do
+    #     . . .
+    #     doc projects('myapp:foo', 'myapp:bar')
+    #   end
+    class Javadoc < Base
+
+      specify :language => :java, :source_ext => 'java'
+
+      def generate(sources, target, options = {})
+        cmd_args = [ '-d', target, Buildr.application.options.trace ? '-verbose' : '-quiet' ]
+        options.reject { |key, value| [:sourcepath, :classpath].include?(key) }.
+          each { |key, value| value.invoke if value.respond_to?(:invoke) }.
+          each do |key, value|
+            case value
+            when true, nil
+              cmd_args << "-#{key}"
+            when false
+              cmd_args << "-no#{key}"
+            when Hash
+              value.each { |k,v| cmd_args << "-#{key}" << k.to_s << v.to_s }
+            else
+              cmd_args += Array(value).map { |item| ["-#{key}", item.to_s] }.flatten
+            end
+          end
+        [:sourcepath, :classpath].each do |option|
+          Array(options[option]).flatten.tap do |paths|
+            cmd_args << "-#{option}" << paths.flatten.map(&:to_s).join(File::PATH_SEPARATOR) unless paths.empty?
+          end
+        end
+        cmd_args += sources.flatten.uniq
+        unless Buildr.application.options.dryrun
+          info "Generating Javadoc for #{project.name}"
+          trace (['javadoc'] + cmd_args).join(' ')
+          Java.load
+          Java.com.sun.tools.javadoc.Main.execute(cmd_args.to_java(Java.java.lang.String)) == 0 or
+            fail 'Failed to generate Javadocs, see errors above'
+        end
+      end
+    end
+  end
+end
+
+Buildr::Doc.engines << Buildr::Doc::Javadoc

data/lib/buildr/java/emma.rb

@@ -22,16 +22,16 @@ module Buildr
   # Provides the <code>emma:html</code> and <code>emma:xml</code> tasks.
   # Require explicitly using <code>require "buildr/emma"</code>.
   #
-  # You can generate emma reports for a single project 
+  # You can generate emma reports for a single project
   # using the project name as prefix:
   #
   #   project_name:emma:html
   #
-  # You can also specify which classes to include/exclude from instrumentation by 
-  # passing a class name regexp to the <code>emma.include</code> or 
-  # <code>emma.exclude</code> methods. 
-  # 
-  #   define 'someModule' do 
+  # You can also specify which classes to include/exclude from instrumentation by
+  # passing a class name regexp to the <code>emma.include</code> or
+  # <code>emma.exclude</code> methods.
+  #
+  #   define 'someModule' do
   #      emma.include 'some.package.*'
   #      emma.exclude 'some.foo.util.SimpleUtil'
   #   end
@@ -58,7 +58,7 @@ module Buildr
       end
 
       def ant
-        
+
         Buildr.ant 'emma' do |ant|
           ant.taskdef :resource=>'emma_ant.properties',
             :classpath=>Buildr.artifacts(dependencies).each(&:invoke).map(&:to_s).join(File::PATH_SEPARATOR)
@@ -68,18 +68,18 @@ module Buildr
         end
       end
     end
-    
+
     class EmmaConfig # :nodoc:
-      
+
       def initialize(project)
         @project = project
       end
-      
+
       attr_reader :project
       private :project
 
       attr_writer :metadata_file, :coverage_file, :instrumented_dir, :report_dir
-      
+
       def coverage_file
         @coverage_file ||= File.join(report_dir, 'coverage.ec')
       end
@@ -95,7 +95,7 @@ module Buildr
       def report_dir
         @report_dir ||= project.path_to(:reports, :emma)
       end
-      
+
       def report_to format
         report_dir
       end
@@ -107,7 +107,7 @@ module Buildr
         includes.push(*classPatterns)
         self
       end
-      
+
       def includes
         @includeClasses ||= []
       end
@@ -138,7 +138,7 @@ module Buildr
 
       after_define do |project|
         emma = project.emma
-        
+
         namespace 'emma' do
           unless project.compile.target.nil?
             # Instrumented bytecode goes in a different directory. This task creates before running the test
@@ -155,14 +155,14 @@ module Buildr
                 touch task.to_s
               end
             end
-            
+
             task 'instrument' => instrumented
-            
+
             # We now have two target directories with bytecode.
             project.test.dependencies.unshift emma.instrumented_dir
             project.test.with Emma.dependencies
             project.test.options[:properties]["emma.coverage.out.file"] = emma.coverage_file
-            
+
             [:xml, :html].each do |format|
               task format => ['instrument', 'test'] do
                 missing_required_files = [emma.metadata_file, emma.coverage_file].reject { |f| File.exist?(f) }
@@ -192,9 +192,9 @@ module Buildr
         project.clean do
           rm_rf [emma.report_dir, emma.coverage_file, emma.metadata_file, emma.instrumented_dir]
         end
-        
+
       end
-      
+
     end
 
     class Buildr::Project
@@ -204,7 +204,7 @@ module Buildr
     namespace "emma" do
 
       Project.local_task('instrument') { |name| "Instrumenting #{name}" }
-      
+
       [:xml, :html].each do |format|
         desc "Run the test cases and produce code coverage reports in #{format}"
         task format => ['instrument', 'test'] do
@@ -224,13 +224,13 @@ module Buildr
               ant.sourcepath do
                 Buildr.projects.map(&:emma).map(&:sources).flatten.map(&:to_s).each do |src|
                   ant.dirset :dir=>src if File.exist?(src)
-                end    
+                end
               end
             end
           end
         end
       end
-      
+
       task :clean do
         rm_rf [report_to, data_file]
       end