buildr 1.2.10 → 1.3.0

data/rakelib/apache.rake

@@ -0,0 +1,126 @@
+# 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 'md5'
+require 'sha1'
+
+
+# Tasks specific to Apache projects (license, release, etc).
+namespace 'apache' do
+
+  desc 'Check that source files contain the Apache license'
+  task 'license' do |task|
+    print '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+(.*?)$|<!--(.*?)-->/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 'OK'
+  end
+  task('license').prerequisites.exclude('.class', '.png', '.jar', '.tif', '.textile', '.haml',
+    'README', 'LICENSE', 'CHANGELOG', 'DISCLAIMER', 'NOTICE', 'KEYS', 'spec/spec.opts')
+
+  task 'check' do
+    ENV['GPG_USER'] or fail 'Please set GPG_USER (--local-user) environment variable so we know which key to use.'
+  end
+
+
+  file 'staged/distro'=>'package' do
+    puts 'Copying and signing release files ...'
+    mkpath 'staged/distro'
+    FileList['pkg/*.{gem,zip,tgz}'].each do |pkg|
+      cp pkg, pkg.pathmap('staged/distro/%n-incubating%x') 
+    end
+  end
+
+  task 'sign'=>['KEYS', 'staged/distro'] do
+    gpg_user = ENV['GPG_USER'] or fail 'Please set GPG_USER (--local-user) environment variable so we know which key to use.'
+    FileList['staged/distro/*.{gem,zip,tgz}'].each do |pkg|
+      bytes = File.open(pkg, 'rb') { |file| file.read }
+      File.open(pkg + '.md5', 'w') { |file| file.write MD5.hexdigest(bytes) << ' ' << File.basename(pkg) }
+      File.open(pkg + '.sha1', 'w') { |file| file.write SHA1.hexdigest(bytes) << ' ' << File.basename(pkg) }
+      sh 'gpg', '--local-user', gpg_user, '--armor', '--output', pkg + '.asc', '--detach-sig', pkg, :verbose=>true
+    end
+    cp 'KEYS', 'staged/distro'
+  end
+
+  # Publish prerequisites to distro server.
+  task 'publish:distro' do |task, args|
+    target = args.incubating ? "people.apache.org:/www/www.apache.org/dist/incubator/#{spec.name}/#{spec.version}-incubating" :
+      "people.apache.org:/www/www.apache.org/dist/#{spec.name}/#{spec.version}"
+    puts 'Uploading packages to Apache distro ...'
+    sh 'rsync', '--progress', 'published/distro/*', target
+    puts 'Done'
+  end
+
+
+  task 'distro-links'=>['staged/site', 'apache:sign'] do |task, args|
+    url = args.incubating ? "http://www.apache.org/dist/incubator/#{spec.name}/#{spec.version}-incubating" :
+      "http://www.apache.org/dist/#{spec.name}/#{spec.version}"
+    rows = FileList['staged/distro/*.{gem,tgz,zip}'].map { |pkg|
+      name, md5 = File.basename(pkg), File.read("#{pkg}.md5").split.first
+      <<-HTML
+      <tr>
+        <td><a href="#{url}/#{name}">#{name}</a></td>
+        <td><a href="#{url}/#{name}.md5">#{md5}</a></td>
+        <td><a href="#{url}/#{name}.asc">Sig</a></td>
+      </tr>
+      HTML
+    }
+    html = <<-HTML
+    <h3>#{spec.name} #{spec.version}#{args.incubating && "-incubating"} (#{Time.now.strftime('%Y-%m-%d')})</h3>
+    <table>
+      <thead><th>Package</th><th>MD5 Checksum</th><th>PGP</th></thead>
+    #{rows.join("\n")}
+    </table>
+    <p style="text-align:right"> (<a href="#{url}/KEYS">Release signing keys</a>)</p>
+    HTML
+    file_name = 'staged/site/download.html'
+    modified = File.read(file_name).sub(/<h2.*binaries.*source.*<\/h2>.*/i) { |header| "#{header}\n#{html}\n" }
+    File.open file_name, 'w' do |file|
+      file.write modified
+    end
+  end
+
+  file 'staged/site'=>'site' do
+    mkpath 'staged'
+    rm_rf 'staged/site'
+    cp_r 'site', 'staged'
+  end
+
+  # Publish prerequisites to Web site.
+  task 'publish:site' do |task, args|
+    target = args.incubating ? "people.apache.org:/www/incubator.apache.org/#{spec.name}" :
+      "people.apache.org:/www/#{spec.name}.apache.org"
+    puts 'Uploading Apache Web site ...'
+    sh 'rsync', '--progress', '--recursive', '--delete', 'published/distro/site/', target
+    puts 'Done'
+  end
+
+end
+
+
+task 'stage:check'=>['apache:license', 'apache:check']
+task 'stage:prepare'=>['staged/distro', 'staged/site', 'apache:distro-links'] do |task|
+  # Since this requires input (passphrase), do it at the very end.
+  task.enhance do
+    task('apache:sign').invoke
+  end
+end
+task 'release:publish'=>['apache:publish:distro', 'apache:publish:site']

data/rakelib/changelog.rake

@@ -0,0 +1,56 @@
+# 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.
+
+
+# Handling of CHANGELOG.
+namespace 'changelog' do
+
+  task 'check'=>'CHANGELOG' do
+    print 'Checking that CHANGELOG indicates most recent version and today\'s date ... '
+    expecting = "#{spec.version} (#{Time.now.strftime('%Y-%m-%d')})"
+    header = File.readlines('CHANGELOG').first.chomp
+    fail "Expecting CHANGELOG to start with #{expecting}, but found #{header} instead" unless expecting == header
+    puts 'OK'
+  end
+
+  file 'staged/CHANGES'=>'CHANGELOG' do |task|
+    # Read the changes for this release.
+    print 'Looking for changes between this release and previous one ... '
+    pattern = /(^(\d+\.\d+(?:\.\d+)?)\s+\(\d{4}-\d{2}-\d{2}\)\s*((:?^[^\n]+\n)*))/
+    changes = File.read('CHANGELOG').scan(pattern).inject({}) { |hash, set| hash[set[1]] = set[2] ; hash }
+    current = changes[spec.version.to_s]
+    fail "No changeset found for version #{spec.version}" unless current
+    File.open task.name, 'w' do |file|
+      file.write "#{spec.version} (#{Time.now.strftime('%Y-%m-%d')})\n"
+      file.write current
+    end
+    puts 'OK'
+  end
+
+  task 'wrapup'=>'CHANGELOG' do
+    next_version = spec.version.to_ints.zip([0, 0, 1]).map { |a| a.inject(0) { |t,i| t + i } }.join('.')
+    print 'Adding new entry to CHANGELOG ... '
+    modified = "#{next_version} (Pending)\n\n" + File.read('CHANGELOG')
+    File.open 'CHANGELOG', 'w' do |file|
+      file.write modified
+    end
+    puts 'Done'
+  end
+
+end
+
+task 'stage:check'=>'changelog:check'
+task 'stage:prepare'=>'staged/CHANGES'
+task 'release:wrapup'=>'changelog:wrapup'

data/rakelib/doc.rake

@@ -0,0 +1,103 @@
+# 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/rdoctask'
+
+desc 'Generate RDoc documentation'
+rdoc = Rake::RDocTask.new('rdoc') do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = spec.name
+  rdoc.options  = spec.rdoc_options + ['--promiscuous']
+  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/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
+
+  Docter::Rake.generate 'print',
+    Docter.collection(spec.name).using('doc/print.toc.yaml').include('doc/pages', 'LICENSE'),
+    Docter.template('doc/print.haml').include('doc/css', 'doc/images'), :one_page
+
+  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
+    end
+  end
+  task 'site'=>'print/buildr.pdf' do
+    cp 'print/buildr.pdf', 'site'
+  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
+
+  task 'clobber' do
+    rm_rf 'print'
+    rm_rf 'site'
+  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
+end

data/rakelib/package.rake

@@ -0,0 +1,44 @@
+# 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/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|
+  print "Installing #{spec.name} ... "
+  args = [Config::CONFIG['ruby_install_name'], '-S', 'gem', 'install', "#{package.package_dir}/#{package.gem_file}"]
+  args.unshift('sudo') unless windows?
+  sh *args
+  puts 'Done'
+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]
+  args.unshift('sudo') unless windows?
+  sh *args
+  puts 'Done'
+end

data/rakelib/release.rake

@@ -0,0 +1,53 @@
+# 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.
+
+# Released files are placed in this directory first, and from there published to various servers.
+file 'published' do |task, args|
+  mkpath task.name
+  puts "Populating published directory from #{args.staging} ..."
+  sh 'rsync', '--progress', '--recursive', "#{args.staging}/", 'published'
+  puts 'Done'
+end
+
+task 'clobber' do
+  rm_rf 'published'
+end
+
+namespace 'release' do
+  task 'prepare'=>['setup', 'clobber', 'published']
+
+  task 'publish'
+
+  task 'wrapup'
+end
+
+desc "Make a release using previously staged files"
+task 'release'=>['release:prepare', 'release:publish', 'release:wrapup']
+
+
+task 'next_version' do
+  ver_file = "lib/#{spec.name}.rb"
+  if File.exist?(ver_file)
+    next_version = spec.version.to_ints.zip([0, 0, 1]).map { |a| a.inject(0) { |t,i| t + i } }.join('.')
+    print "Updating #{ver_file} to next version number (#{next_version}) ... "
+    modified = File.read(ver_file).sub(/(VERSION\s*=\s*)(['"])(.*)\2/) { |line| "#{$1}#{$2}#{next_version}#{$2}" } 
+    File.open ver_file, 'w' do |file|
+      file.write modified
+    end
+    puts 'Done'
+  end
+end
+
+task 'release:wrapup'=>'next_version'

data/rakelib/rspec.rake

@@ -0,0 +1,81 @@
+# 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.
+
+
+begin
+  require 'spec/rake/spectask'
+
+  directory 'reports'
+  task 'clobber' do
+    rm 'failing' rescue nil
+    rm_rf 'reports'
+  end
+
+  desc 'Run all specs'
+  Spec::Rake::SpecTask.new('spec'=>'reports') do |task|
+    task.spec_files = FileList['spec/**/*_spec.rb']
+    task.spec_opts << '--options' << 'spec/spec.opts' << '--format' << 'failing_examples:failing' <<
+      '--format' << 'html:reports/specs.html' << '--backtrace'
+  end
+  file 'reports/specs.html'=>'spec'
+
+  desc 'Run all failing examples from previous run'
+  Spec::Rake::SpecTask.new('failing') do |task|
+    task.spec_files = FileList['spec/**/*_spec.rb']
+    task.spec_opts << '--options' << 'spec/spec.opts' << '--format' << 'failing_examples:failing' << '--example' << 'failing'
+  end
+
+  # Useful for testing with JRuby when using Ruby and vice versa.
+  namespace 'spec' do
+=begin
+    # TODO: Horribly broken!  Fix some other time.
+    desc 'Run RSpec and generate Spec and coverage reports (slow)'
+    Spec::Rake::SpecTask.new('rcov') do |task|
+      task.spec_files = FileList['spec/**/*spec.rb']
+      task.rcov = true
+      task.rcov_opts = '--exclude', 'spec,bin'
+      task.rcov_dir = 'coverage'
+    end
+=end
+
+    desc 'Run all specs specifically with Ruby'
+    task 'ruby' do
+      puts 'Running test suite using Ruby ...'
+      sh 'ruby -S rake spec'
+    end
+
+    desc 'Run all specs specifically with JRuby'
+    task 'jruby' do
+      puts 'Running test suite using JRuby ...'
+      sh 'jruby -S rake spec'
+    end
+
+  end
+
+  task 'setup' do
+    install_gem 'win32console' if Gem.win_platform? # Colors for RSpec, only on Windows platform.
+  end
+
+rescue LoadError
+  puts 'Please run rake setup to install RSpec'
+  task 'stage:check' do
+    fail 'Please run rake setup to install RSpec'
+  end
+end
+
+
+task 'stage:prepare'=>'spec'
+task 'stage:prepare'=>RUBY_PLATFORM =~ /java/ ? 'spec:ruby' : 'spec:jruby'
+# TODO:  Add Rcov when we get it working again.