buildr 1.3.3 → 1.3.4

data/lib/buildr/scala/tests.rb

@@ -21,33 +21,9 @@ require 'buildr/java/tests'
 
 
 module Buildr::Scala
-
-  # Scala::Specs is available when using Scala::Test
-  module ScalaSpecs
-    VERSION = '1.2.9'
-    
-    class << self
-      def version
-        Buildr.settings.build['scala.specs'] || VERSION
-      end
-      
-      def dependencies
-        ["org.specs:specs:jar:#{version}"]
-      end  
-
-    private
-      def const_missing(const)
-        return super unless const == :REQUIRES # TODO: remove in 1.5
-        Buildr.application.deprecated "Please use Scala::Specs.dependencies/.version instead of ScalaSpecs::REQUIRES/VERSION"
-        dependencies
-      end
-    end
-  end
-
-
-  # Scala::Check is available when using Scala::Test
-  module ScalaCheck
-    VERSION = '1.3'
+  # Scala::Check is available when using Scala::Test or Scala::Specs
+  module Check
+    VERSION = '1.5'
     
     class << self
       def version
@@ -74,9 +50,9 @@ module Buildr::Scala
   # * :properties  -- Hash of system properties available to the test case.
   # * :environment -- Hash of environment variables available to the test case.
   # * :java_args   -- Arguments passed as is to the JVM.
-  class ScalaTest < TestFramework::Java
+  class ScalaTest < Buildr::TestFramework::Java
 
-    VERSION = '0.9.3'
+    VERSION = '0.9.5'
 
     class << self
       def version
@@ -84,12 +60,12 @@ module Buildr::Scala
       end
       
       def dependencies
-        ["org.scalatest:scalatest:jar:#{version}"] + ScalaSpecs.dependencies +
-          ScalaCheck.dependencies + JMock.dependencies
+        ["org.scala-tools.testing:scalatest:jar:#{version}"] + Check.dependencies + 
+          JMock.dependencies + JUnit.dependencies
       end  
 
       def applies_to?(project) #:nodoc:
-        project.test.compile.language == :scala
+        !Dir[project.path_to(:source, :test, :scala, '**/*.scala')].empty?
       end 
       
     private
@@ -113,35 +89,13 @@ module Buildr::Scala
     end
 
     def tests(dependencies) #:nodoc:
-      suites = filter_classes(dependencies, :interfaces => %w{org.scalatest.Suite})
-      # we should really filter using :class => %w{org.specs.Specification} instead of naming convention
-      specs = filter_classes(dependencies, :class_names => [/Specs?$/])
-      [suites, specs].flatten
+      filter_classes(dependencies, :interfaces => %w{org.scalatest.Suite})
     end
 
-    def run(tests, dependencies) #:nodoc:
+    def run(scalatest, dependencies) #:nodoc:
       mkpath task.report_to.to_s
       success = []
-      scalatest = tests.select { |t| t !~ /Specs?$/ }
-      specs = tests.select { |t| t =~ /Specs?$/ }
-
-      # Specs
-      nostacktrace = (options[:nostacktrace]) ? "-ns" : ""
-      cmd_options = { :properties => options[:properties],
-                      :java_args => options[:java_args],
-                      :classpath => dependencies}
-      specs.each do |spec|
-        Java.load
-        begin
-          Java::Commands.java(spec, cmd_options)
-        rescue => e
-          print e.message
-        else
-          success << spec
-        end
-      end
 
-      # ScalaTest
       reporter_options = 'TFGBSAR' # testSucceeded, testFailed, testIgnored, suiteAborted, runStopped, runAborted, runCompleted
       scalatest.each do |suite|
         info "ScalaTest #{suite.inspect}"
@@ -195,9 +149,8 @@ end
 
 # Backwards compatibility stuff.  Remove in 1.5.
 module Buildr
-  ScalaSpecs = Scala::ScalaSpecs
-  ScalaCheck = Scala::ScalaCheck
+  ScalaCheck = Scala::Check
   ScalaTest = Scala::ScalaTest
 end
 
-Buildr::TestFramework << Buildr::Scala::ScalaTest
+Buildr::TestFramework << Buildr::Scala::ScalaTest

data/rakelib/checks.rake

@@ -0,0 +1,57 @@
+# 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.
+
+
+desc "Check that source files contain the Apache license"
+task :license=>FileList["**/*.{rb,rake,java,gemspec,buildfile}", 'Rakefile'] do |task|
+  puts "Checking that files contain the Apache license ... "
+  required = task.prerequisites.select { |fn| File.file?(fn) }
+  missing = required.reject { |fn| 
+    comments = File.read(fn).scan(/(\/\*(.*?)\*\/)|^#\s+(.*?)$|^-#\s+(.*?)$|<!--(.*?)-->/m).
+      map { |match| match.compact }.flatten.join("\n")
+    comments =~ /Licensed to the Apache Software Foundation/ && comments =~ /http:\/\/www.apache.org\/licenses\/LICENSE-2.0/
+  }
+  fail "#{missing.join(', ')} missing Apache License, please add it before making a release!" unless missing.empty?
+  puts "[x] Source files contain the Apache license"
+end
+
+
+desc "Look for new dependencies, check transitive dependencies"
+task :dependency do
+  puts "Checking that all dependencies are up to date ..."
+  # Find if anything has a more recent dependency.  These are not errors, just reports.
+  spec.dependencies.each do |dep|
+    current = Gem::SourceInfoCache.search(dep).last
+    latest = Gem::SourceInfoCache.search(Gem::Dependency.new(dep.name, '>0')).last
+    puts "A new version of #{dep.name} is available, #{latest.version} replaces #{current.version}" if (current && latest && latest.version > current.version)
+  end
+
+  # Returns orderd list of transitive dependencies for the given dependency.
+  transitive = lambda { |depend|
+    dep_spec = Gem::SourceIndex.from_installed_gems.search(depend).last
+    fail "No specification for dependency #{depend}" unless dep_spec
+    dep_spec.runtime_dependencies.map { |trans| transitive[trans].push(trans) }.flatten.uniq }
+  # For each dependency, make sure *all* its transitive dependencies are listed
+  # as a Buildr dependency, and order is preserved.
+  spec.dependencies.each_with_index do |dep, index|
+    puts "checking #{dep.name}"
+    transitive[dep].each do |trans|
+      matching = spec.dependencies.find { |existing| trans =~ existing }
+      fail "#{trans} required by #{dep} and missing from spec" unless matching
+      fail "#{trans} must come before #{dep} in dependency list" unless spec.dependencies.index(matching) < index
+    end
+  end
+  puts "[X] Checked all dependencies are up to date and transitive dependencies are correctly ordered"
+end

data/rakelib/doc.rake

@@ -14,90 +14,80 @@
 # the License.
 
 
+task 'doc:setup'
+begin # For the Web site, we use the SDoc RDoc generator/theme (http://github.com/voloko/sdoc/)
+  require 'sdoc'
+rescue LoadError
+  puts "Buildr uses the SDoc RDoc generator/theme. You can install it by running rake doc:setup"
+  task('doc:setup') { install_gem 'voloko-sdoc', :source=>'http://gems.github.com' }
+end
+
+
 require 'rake/rdoctask'
 
-desc 'Generate RDoc documentation'
-rdoc = Rake::RDocTask.new('rdoc') do |rdoc|
+desc "Generate RDoc documentation in rdoc/"
+Rake::RDocTask.new :rdoc do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = spec.name
-  rdoc.options  = spec.rdoc_options + ['--promiscuous']
+  rdoc.options  = spec.rdoc_options.clone
   rdoc.rdoc_files.include('lib/**/*.rb')
   rdoc.rdoc_files.include spec.extra_rdoc_files
 end
 
 
 begin
-  gem 'allison'
-  rdoc.template = File.expand_path('lib/allison.rb', Gem.loaded_specs['allison'].full_gem_path)
-rescue LoadError
-  puts 'Please run rake setup to install the Allison RDoc template'
-  task 'setup' do
-    install_gem 'allison'
-  end
-  task 'stage:check' do
-    fail 'Please run rake setup to install the Allison RDoc template'
-  end
-end
-
-
-begin
-  require 'docter'
-  require 'docter/server'
-
-  #Docter.filter_for(:footnote) do |html|
-  #  html.gsub(/<p id="fn(\d+)">(.*?)<\/p>/, %{<p id="fn\\1" class="footnote">\\2</p>})
-  #end
-
-  collection = Docter.collection(spec.name).using('doc/site.toc.yaml').include('doc/pages', 'LICENSE', 'CHANGELOG')
-  # TODO:  Add coverage reports when we get them to run.
-  template   = Docter.template('doc/site.haml').
-    include('doc/css', 'doc/images', 'doc/scripts', 'reports/coverage', 'reports/specs.html', 'rdoc', 'print/buildr.pdf')
-
-  desc 'Run Docter server on port 3000'
-  Docter::Rake.serve 'docter', collection, template, :port=>3000
-
-  desc 'Generate Web site in directory site'
-  Docter::Rake.generate 'site', collection, template
+  require 'rakelib/jekylltask'
 
-  Docter::Rake.generate 'print',
-    Docter.collection(spec.name).using('doc/print.toc.yaml').include('doc/pages'),
-    Docter.template('doc/print.haml').include('doc/css', 'doc/images'), :one_page
+  desc "Generate Buildr documentation in _site/"
+  JekyllTask.new :jekyll do |task|
+    task.source = 'doc'
+    task.target = '_site'
+    task.pygments = true
+  end
 
-  file('print/buildr.pdf'=>'print') do |task|
-    mkpath 'site'
-    sh 'prince', 'print/index.html', '-o', task.name, '--media=print' do |ok, res|
-      fail 'Failed to create PDF, see errors above' unless ok
+rescue LoadError
+  puts "Buildr uses the mojombo-jekyll to generate the Web site. You can install it by running rake doc:setup"
+  task 'doc:setup' do
+    install_gem 'mojombo-jekyll', :source=>'http://gems.github.com', :version=>'0.4.1'
+    if `pygmentize -V`.empty?
+      args = %w{easy_install Pygments}
+      args.unshift 'sudo' unless Config::CONFIG['host_os'] =~ /windows/
+      sh *args
     end
   end
-  task 'site'=>'print/buildr.pdf' do
-    cp 'print/buildr.pdf', 'site'
-  end
+end
 
-  task 'site' do
-    print 'Checking that we have site documentation, RDoc and PDF ... '
-    fail 'No PDF generated, you need to install PrinceXML!' unless File.exist?('site/buildr.pdf')
-    fail 'No RDocs in site directory' unless File.exist?('site/rdoc/files/lib/buildr_rb.html')
-    fail 'No site documentation in site directory' unless File.exist?('site/index.html')
-    fail 'No specifications site directory' unless File.exist?('site/specs.html')
-    puts 'OK'
-  end
 
-  desc 'Produce PDF'
-  task 'pdf'=>'print/buildr.pdf' do |task|
-    sh 'open', 'print/buildr.pdf'
-  end
+desc "Generate Buildr documentation as buildr.pdf"
+file 'buildr.pdf'=>'_site' do |task|
+  pages = File.read('doc/preface.textile').scan(/^#.*":(\S*)$/).flatten.map { |f| "_site/#{f}" }
+  sh 'prince', '--input=html', '--no-network', '--log=prince_errors.log', "--output=#{task.name}", '_site/preface.html', *pages
+end
 
-  task 'clobber' do
-    rm_rf 'print'
-    rm_rf 'site'
-  end
+desc "Build a copy of the Web site in the ./_site"
+task :site=>['_site', :rdoc, '_reports/specs.html', '_reports/coverage', 'buildr.pdf'] do
+  cp_r 'rdoc', '_site'
+  fail 'No RDocs in site directory' unless File.exist?('_site/rdoc/files/lib/buildr_rb.html')
+  cp '_reports/specs.html', '_site'
+  cp_r '_reports/coverage', '_site'
+  fail 'No coverage report in site directory' unless File.exist?('_site/coverage/index.html')
+  cp 'CHANGELOG', '_site'
+  cp 'buildr.pdf', '_site'
+  fail 'No PDF in site directory' unless File.exist?('_site/buildr.pdf')
+  puts 'OK'
+end
 
-rescue LoadError
-  puts 'Please run rake setup to install the Docter document generation library'
-  task 'setup' do
-    install_gem 'docter', '~>1.1.3'
-  end
-  task 'stage:check' do
-    fail 'Please run rake setup to install the Docter document generation library'
-  end
+# Publish prerequisites to Web site.
+task 'publish'=>:site do
+  target = "people.apache.org:/www/#{spec.name}.apache.org/"
+  puts "Uploading new site to #{target} ..."
+  sh 'rsync', '--progress', '--recursive', '--delete', '_site/', target
+  sh 'ssh', 'people.apache.org', 'chmod', '-R', 'g+w', "/www/#{spec.name}.apache.org/*"
+  puts "Done"
+end
+
+task :clobber do
+  rm_rf '_site'
+  rm_f 'buildr.pdf'
+  rm_f 'prince_errors.log'
 end

data/rakelib/jekylltask.rb

@@ -0,0 +1,110 @@
+# 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 'rake/tasklib'
+require 'jekyll'
+
+
+class JekyllTask < Rake::TaskLib
+  def initialize(name=:jekyll)  # :yield: self
+    @name = name
+    @source = name
+    @target = name
+    yield self if block_given?
+    task name, :auto, :needs=>[@source] do |task, args|
+      generate args.auto
+    end
+    if @source != @target
+      file @target=>FileList["#{@source}/**/*"] do
+        generate
+      end
+      task 'clobber' do
+        rm_rf @target
+      end
+    end
+  end
+
+  attr_accessor :source
+  attr_accessor :target
+  attr_accessor :pygments
+
+  def generate(auto = false)
+    process = lambda do
+      Jekyll.pygments = @pygments
+      Jekyll.process source, target
+      touch target
+    end
+
+    if auto
+      require 'directory_watcher'
+      puts "Auto generating: just edit a page and save, watch the console to see when we're done regenerating pages"
+      dw = DirectoryWatcher.new(source)
+      dw.interval = 1
+      dw.glob = Dir.chdir(source) do
+        dirs = Dir['*'].select { |x| File.directory?(x) }
+        dirs -= [target]
+        dirs = dirs.map { |x| "#{x}/**/*" }
+        dirs += ['*']
+      end
+      dw.start
+      dw.add_observer do |*args|
+        t = Time.now.strftime("%Y-%m-%d %H:%M:%S")
+        puts "[#{t}] regeneration: #{args.size} files changed"
+        process.call
+        puts "Done"
+      end
+      loop { sleep 1 }
+    else
+      puts "Generating documentation in #{target}"
+      process.call
+    end
+  end
+end
+
+
+# TODO: Worked around bug in Jekyll 0.4.1. Removed when 0.4.2 is out.
+# http://github.com/mojombo/jekyll/commit/c180bc47bf2f63db1bff9f6600cccbe5ad69077e#diff-0
+class Albino
+  def execute(command)
+    output = ''
+    Open4.popen4(command) do |pid, stdin, stdout, stderr|
+      stdin.puts @target
+      stdin.close
+      output = stdout.read.strip
+      [stdout, stderr].each { |io| io.close }
+    end
+    output
+  end
+end
+
+class Jekyll::Page
+  def render(layouts, site_payload)
+    puts "... #{@name}"
+    payload = {"page" => self.data}.deep_merge(site_payload)
+    do_layout(payload, layouts)
+  end
+end
+
+module TocFilter
+  def toc(input)
+    input.scan(/<(h2)(?:>|\s+(.*?)>)(.*?)<\/\1\s*>/mi).inject(%{<ol class="toc">}) { |toc, entry|
+      id = entry[1][/^id=(['"])(.*)\1$/, 2]
+      title = entry[2].gsub(/<(\w*).*?>(.*?)<\/\1\s*>/m, '\2').strip
+      toc << %{<li><a href="##{id}">#{title}</a></li>}
+    } << "</ol>"
+  end
+end
+Liquid::Template.register_filter(TocFilter)

data/rakelib/package.rake

@@ -17,57 +17,55 @@
 require 'rake/gempackagetask'
 
 
-desc 'Clean up all temporary directories used for running tests, creating documentation, packaging, etc.'
-task 'clobber'
-
 package = Rake::GemPackageTask.new(spec) do |pkg|
   pkg.need_tar = true
   pkg.need_zip = true
 end
 
-desc 'Install the package locally'
-task 'install'=>['setup', "#{package.package_dir}/#{package.gem_file}"] do |task|
+desc "Install Buildr from source"
+task :install=>["#{package.package_dir}/#{package.gem_file}"] do |task|
   print "Installing #{spec.name} ... "
-  args = [Config::CONFIG['ruby_install_name'], '-S', 'gem', 'install', "#{package.package_dir}/#{package.gem_file}"]
+  args = Config::CONFIG['ruby_install_name'], '-S', 'gem', 'install', "#{package.package_dir}/#{package.gem_file}"
   args.unshift('sudo') if sudo_needed?
   sh *args
-  puts 'Done'
+  puts "[x] Installed Buildr #{spec.version}"
 end
 
-desc 'Uninstall previously installed packaged'
-task 'uninstall' do |task|
-  print "Uninstalling #{spec.name} ... "
-  args = [Config::CONFIG['ruby_install_name'], '-S', 'gem', 'uninstall', spec.name, '--version', spec.version.to_s]
+desc "Uninstall previous rake install"
+task :uninstall do |task|
+  puts "Uninstalling #{spec.name} ... "
+  args = Config::CONFIG['ruby_install_name'], '-S', 'gem', 'uninstall', spec.name, '--version', spec.version.to_s
   args.unshift('sudo') if sudo_needed?
   sh *args
-  puts 'Done'
+  puts "[x] Uninstalled Buildr #{spec.version}"
 end
 
 
-desc 'Look for new dependencies, check transitive dependencies'
-task 'dependency' do
-  puts "Checking that all dependencies are up to date ..."
-  # Find if anything has a more recent dependency.  These are not errors, just reports.
-  for dep in spec.dependencies
-    current = Gem::SourceInfoCache.search(dep, true, true).last
-    latest = Gem::SourceInfoCache.search(Gem::Dependency.new(dep.name, '>0'), true, true).last
-    puts "A new version of #{dep.name} is available, #{latest.version} replaces #{current.version}" if latest.version > current.version
-  end
-
-  # Returns orderd list of transitive dependencies for the given dependency.
-  transitive = lambda { |depend|
-    dep_spec = Gem::SourceIndex.from_installed_gems.search(depend).last
-    dep_spec.dependencies.map { |trans| transitive[trans].push(trans) }.flatten.uniq }
-  # For each dependency, make sure *all* its transitive dependencies are listed
-  # as a Buildr dependency, and order is preserved.
-  spec.dependencies.each_with_index do |dep, index|
-    puts "checking #{dep.name}"
-    for trans in transitive[dep]
-      matching = spec.dependencies.find { |existing| trans =~ existing }
-      fail "#{trans} required by #{dep} and missing from spec" unless matching
-      fail "#{trans} must come before #{dep} in dependency list" unless spec.dependencies.index(matching) < index
-    end
-  end
+desc "Compile Java libraries used by Buildr"
+task :compile do
+  puts "Compiling Java libraries ..."
+  args = Config::CONFIG['ruby_install_name'], File.expand_path(RUBY_PLATFORM[/java/] ? '_jbuildr' : '_buildr'), '--buildfile', 'buildr.buildfile', 'compile'
+  args << '--trace' if Rake.application.options.trace
+  sh *args
 end
+file Rake::GemPackageTask.new(spec).package_dir=>:compile
+file Rake::GemPackageTask.new(spec).package_dir_path=>:compile
 
-task 'stage:check'=>'dependency'
+# We also need the other package (JRuby if building on Ruby, and vice versa)
+# Must call new with block, even if block does nothing, otherwise bad things happen.
+Rake::GemPackageTask.new(spec(RUBY_PLATFORM[/java/] ? 'ruby' : 'java')) { |task| }
+
+
+desc "Upload snapshot packages over to people.apache.org"
+task :snapshot=>[:package] do
+  rm_rf '_snapshot' # Always start with empty directory
+  puts "Copying existing gems from Apache"
+  sh 'rsync', '--progress', '--recursive', 'people.apache.org:public_html/buildr/snapshot/', '_snapshot/'
+  puts "Copying new gems over"
+  cp FileList['pkg/{*.gem,*.tgz,*.zip}'], '_snapshot/gems'
+  puts "Generating gem index ..."
+  sh 'gem', 'generate_index', '--directory', '_snapshot'
+  puts "Copying gem and index back to Apache" 
+  sh 'rsync', '--progress', '--recursive', '_snapshot/', 'people.apache.org:public_html/buildr/snapshot/'
+end
+task(:clobber) { rm_rf '_snapshot' }