buildrdeb 0.0.1

data/rakelib/setup.rake

@@ -0,0 +1,54 @@
+# 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 'jruby' if RUBY_PLATFORM[/java/]
+require 'rubygems/source_info_cache'
+
+RAKE_SUDO = case (ENV['RAKE_SUDO'] or 'yes').strip.downcase
+  when 'yes', 'true'
+    true
+  else
+    false
+end
+
+# Install the specified gem. Options include:
+# - :version -- Version requirement, e.g. '1.2' or '~> 1.2'
+# - :source  -- Gem repository, e.g. 'http://gems.github.com'
+def install_gem(name, options = {})
+  dep = Gem::Dependency.new(name, options[:version] || '>0')
+  if Gem::SourceIndex.from_installed_gems.search(dep).empty?
+    puts "Installing #{name} ..."
+    rb_bin = File.join(Config::CONFIG['bindir'], Config::CONFIG['ruby_install_name'])
+    args = []
+    args << 'sudo' << 'env' << "JAVA_HOME=#{ENV['JAVA_HOME']}" if sudo_needed? and RAKE_SUDO
+    args << rb_bin << '-S' << 'gem' << 'install' << name
+    args << '--version' << dep.version_requirements.to_s
+    args << '--source' << options[:source] if options[:source]
+    args << '--source' << 'http://gems.rubyforge.org'
+    args << '--install-dir' << ENV['GEM_HOME'] if ENV['GEM_HOME']
+    sh *args
+  end
+end
+
+
+# Setup environment for running this Rakefile (RSpec, Jekyll, etc).
+desc "If you're building from sources, run this task first to setup the necessary dependencies."
+task :setup do
+  missing = spec.dependencies.select { |dep| Gem::SourceIndex.from_installed_gems.search(dep).empty? }
+  missing.each do |dep|
+    install_gem dep.name, :version=>dep.version_requirements
+  end
+end

data/rakelib/stage.rake

@@ -0,0 +1,206 @@
+# 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 'digest/md5'
+require 'digest/sha1'
+
+begin # Releases upload Gems to RubyForge.
+  require 'rubyforge'
+rescue LoadError
+  task(:setup) { install_gem 'rubyforge' }
+end
+
+
+task :prepare do |task, args|
+  # Make sure we're doing a release from checked code.
+  lambda do
+    puts "Checking there are no local changes ... "
+    svn = `svn status`
+    fail "Cannot release unless all local changes are in SVN:\n#{svn}" unless svn.empty?
+    git = `git status`
+    fail "Cannot release unless all local changes are in Git:\n#{git}" if git[/^#\t/]
+    puts "[X] There are no local changes, everything is in source control"
+  end.call
+
+  # Make sure we have a valid CHANGELOG entry for this release.
+  lambda do
+    puts "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 "[x] CHANGELOG indicates most recent version and today's date"
+  end.call
+
+  # Need GPG to sign the packages.
+  lambda do
+    args.gpg or fail "Please run with gpg=<argument for gpg --local-user>"
+    fail "No GPG user #{args.gpg}" if `gpg2 --list-keys #{args.gpg}`.empty?
+  end.call
+
+  task(:license).invoke
+  task(:dependency).invoke
+
+  # Need JRuby, Scala and Groovy installed to run all the specs.
+  lambda do
+    puts "Checking that we have JRuby, Scala and Groovy available ... "
+    sh 'jruby --version'
+    sh 'scala -version'
+    sh 'groovy -version'
+    puts "[X] We have JRuby, Scala and Groovy"
+  end.call
+
+  # Need RubyForge to upload new release files.
+  lambda do
+    puts "[!] Make sure you have admin privileges to make a release on RubyForge"
+    rubyforge = RubyForge.new.configure
+    rubyforge.login 
+    rubyforge.scrape_project(spec.name)
+  end.call
+
+  # We will be speccing in one platform, so also spec the other one.
+  task(RUBY_PLATFORM =~ /java/ ? 'spec:ruby' : 'spec:jruby').invoke # Test the *other* platform
+end
+
+
+task :stage=>['setup', 'doc:setup', :clobber, :prepare] do |task, args|
+  mkpath '_staged'
+
+  # Start by figuring out what has changed.
+  lambda do
+    puts "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 '_staged/CHANGES', 'w' do |file|
+      file.write "#{spec.version} (#{Time.now.strftime('%Y-%m-%d')})\n"
+      file.write current
+    end
+    puts "[X] Listed most recent changed in _staged/CHANGES"
+  end.call
+
+  # Create the packages (gem, tarball) and sign them. This requires user
+  # intervention so the earlier we do it the better.
+  lambda do
+    puts "Creating and signing release packages ..."
+    task(:package).invoke
+    mkpath '_staged/dist'
+    FileList['pkg/*.{gem,zip,tgz}'].each do |source|
+      pkg = source.pathmap('_staged/dist/%n%x') 
+      cp source, pkg
+      bytes = File.open(pkg, 'rb') { |file| file.read }
+      File.open(pkg + '.md5', 'w') { |file| file.write Digest::MD5.hexdigest(bytes) << ' ' << File.basename(pkg) }
+      File.open(pkg + '.sha1', 'w') { |file| file.write Digest::SHA1.hexdigest(bytes) << ' ' << File.basename(pkg) }
+      sh 'gpg2', '--local-user', args.gpg, '--armor', '--output', pkg + '.asc', '--detach-sig', pkg, :verbose=>true
+    end
+    cp 'etc/KEYS', '_staged'
+    puts "[X] Created and signed release packages in _staged/dist"
+  end.call
+
+  # The download page should link to the new binaries/sources, and we
+  # want to do that before generating the site/documentation.
+  lambda do
+    puts "Updating download page with links to release packages ... "
+    url = "http://www.apache.org/dist/#{spec.name}/#{spec.version}"
+    rows = FileList['_staged/dist/*.{gem,tgz,zip}'].map { |pkg|
+      name, md5 = File.basename(pkg), Digest::MD5.file(pkg).to_s
+      %{| "#{name}":#{url}/#{name} | "#{md5}":#{url}/#{name}.md5 | "Sig":#{url}/#{name}.asc |}
+    }
+    textile = <<-TEXTILE
+h3. #{spec.name} #{spec.version} (#{Time.now.strftime('%Y-%m-%d')})
+
+|_. Package |_. MD5 Checksum |_. PGP |
+#{rows.join("\n")}
+
+p>. ("Release signing keys":#{url}/KEYS)
+    TEXTILE
+    file_name = 'doc/download.textile'
+    print "Adding download links to #{file_name} ... "
+    modified = File.read(file_name).sub(/^h2\(#dist\).*$/) { |header| "#{header}\n\n#{textile}" }
+    File.open file_name, 'w' do |file|
+      file.write modified
+    end
+    puts "[X] Updated #{file_name}"
+  end.call
+
+
+  # Now we can create the Web site, this includes running specs, coverage report, etc.
+  # This will take a while, so we want to do it as last step before upload.
+  lambda do
+    puts "Creating new Web site"
+    task(:site).invoke
+    cp_r '_site', '_staged/site'
+    puts "[X] Created new Web site in _staged/site"
+  end.call
+
+
+  # Move everything over to people.apache.org so we can vote on it.
+  lambda do
+    url = "people.apache.org:~/public_html/#{spec.name}/#{spec.version}"
+    puts "Uploading _staged directory to #{url} ..."
+    sh 'rsync', '--progress', '--recursive', '_staged/', url
+    puts "[X] Uploaded _staged directory to #{url}"
+  end.call
+  
+
+  # Prepare a release vote email. In the distant future this will also send the
+  # email for you and vote on it.
+  lambda do
+    # Need to know who you are on Apache, local user may be different (see .ssh/config).
+    whoami = `ssh people.apache.org whoami`.strip
+    base_url = "http://people.apache.org/~#{whoami}/buildr/#{spec.version}"
+    # Need changes for this release only.
+    changelog = File.read('CHANGELOG').scan(/(^(\d+\.\d+(?:\.\d+)?)\s+\(\d{4}-\d{2}-\d{2}\)\s*((:?^[^\n]+\n)*))/)
+    changes = changelog[0][2]
+    previous_version = changelog[1][1]
+
+    email = <<-EMAIL
+To: dev@buildr.apache.org
+Subject: [VOTE] Buildr #{spec.version} release
+
+We're voting on the source distributions available here:
+#{base_url}/dist/
+
+Specifically:
+#{base_url}/dist/buildr-#{spec.version}.tgz
+#{base_url}/dist/buildr-#{spec.version}.zip
+
+The documentation generated for this release is available here:
+#{base_url}/site/
+#{base_url}/site/buildr.pdf
+
+The official specification against which this release was tested:
+#{base_url}/site/specs.html
+
+Test coverage report:
+#{base_url}/site/coverage/index.html
+
+
+The following changes were made since #{previous_version}:
+
+#{changes.gsub(/^/, '  ')}
+    EMAIL
+    File.open 'vote-email.txt', 'w' do |file|
+      file.write email
+    end
+    puts "[X] Created release vote email template in 'vote-email.txt'"
+    puts email
+  end.call
+
+end
+
+
+task(:clobber) { rm_rf '_staged' }

data/spec/buildrdeb/package_spec.rb

@@ -0,0 +1,114 @@
+# 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 File.join(File.dirname(__FILE__), '../spec_helpers')
+
+describe BuildrDeb::DebTask do
+
+  def write_files
+    Buildr::write "control", <<-CONTROL
+Package: acme
+Version: 1.0
+Section: web 
+Priority: optional
+Architecture: all
+Essential: no
+Depends: libwww-perl, acme-base (>= 1.2)
+Pre-Depends: perl 
+Recommends: mozilla | netscape  
+Suggests: docbook 
+Installed-Size: 1024
+Maintainer: Joe Brockmeier <jzb@dissociatedpress.net>
+Conflicts: wile-e-coyote
+Replaces: sam-sheepdog
+Provides: acme
+Description: The description can contain free-form text
+             describing the function of the program, what
+             kind of features it has, and so on.
+             More descriptive text.
+CONTROL
+    Buildr::write "control2", ""
+    Buildr::write "postinst", ""
+    Buildr::write "prerm", ""
+  end
+
+  it "should throw an error if no control file is given" do
+    write_files
+    define("foo", :version => "1.0") do
+      
+      project.package(:deb).postinst = _("postinst")
+      project.package(:deb).prerm = _("prerm")
+    end
+    lambda { project("foo").package(:deb).invoke }.should raise_error(/no control file was defined when packaging foo as a deb file/)
+  end
+  
+  it "should raise an exception if the control is incorrectly formatted" do
+    write_files
+    define("foo", :version => "1.0") do
+      project.package(:deb).control = _("control2")
+      project.package(:deb).postinst = _("postinst")
+      project.package(:deb).prerm = _("prerm")
+    end
+    lambda { project("foo").package(:deb).invoke }.should raise_error(/dpkg failed with this error:/)
+    File.exists?("target/foo-1.0.deb").should be_false
+  end
+  
+  it "should give a project the ability to package as deb" do
+    write_files
+    define("foo", :version => "1.0") do
+      project.package(:deb).control = _("control")
+      project.package(:deb).postinst = _("postinst")
+      project.package(:deb).prerm = _("prerm")
+    end
+    lambda { project("foo").package(:deb).invoke }.should_not raise_error 
+    File.exists?("target/foo-1.0.deb").should be_true
+  end
+  
+  it "should let the user include files into the deb" do
+    write_files
+    Buildr::write "blah.class", "some class content"
+    Buildr::write "folder/file1.class", "some more content"
+    Buildr::write "folder/file2.class", "some other content"
+    define("foo", :version => "1.0") do
+      project.package(:deb).control = _("control")
+      project.package(:deb).postinst = _("postinst")
+      project.package(:deb).prerm = _("prerm")
+      project.package(:deb).include("blah.class", :path => "lib")
+      project.package(:deb).include("folder", :as => "otherlib")
+    end
+    lambda { project("foo").package(:deb).invoke }.should_not raise_error 
+    File.exists?("target/foo-1.0.deb").should be_true
+    #check the contents of the deb file:
+    entries = %x[ dpkg --contents target/foo-1.0.deb ].split("\n").collect { |string| /.* (.*)/.match(string)[1]}
+
+    entries.should include("./otherlib/file1.class")
+    entries.should include("./otherlib/file2.class")
+    entries.should include("./lib/blah.class")
+  end
+  
+  
+  it "should let the user override the package name" do
+    write_files
+    define("foo", :version => "1.0") do
+      project.package(:deb, :file => "bar-1.0.deb").tap do |deb|
+        deb.control = _("control")
+        deb.postinst = _("postinst")
+        deb.prerm = _("prerm")
+      end
+    end
+    project("foo").package(:deb, :file => "bar-1.0.deb").invoke
+    File.exists?("bar-1.0.deb").should be_true
+  end
+end

data/spec/spec_helpers.rb

@@ -0,0 +1,24 @@
+# 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.
+
+unless defined?(SpecHelpers)
+  require File.join(File.dirname(__FILE__), "/../buildr/spec/spec_helpers.rb")
+
+  # Make sure to load from these paths first, we don't want to load any
+  # code from Gem library.
+  $LOAD_PATH.unshift File.expand_path('../lib', File.dirname(__FILE__))
+  require 'buildrdeb'
+
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: buildrdeb
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Antoine Toulme
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-20 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: |
+  A buildr plugin contributing a new packaging method to package your project as a .deb file.
+
+email: antoine@lunar-ocean.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+- NOTICE
+files: 
+- lib/buildrdeb/package.rb
+- lib/buildrdeb.rb
+- rakelib/checks.rake
+- rakelib/doc.rake
+- rakelib/jekylltask.rb
+- rakelib/package.rake
+- rakelib/release.rake
+- rakelib/rspec.rake
+- rakelib/setup.rake
+- rakelib/stage.rake
+- spec/buildrdeb/package_spec.rb
+- spec/spec_helpers.rb
+- buildrdeb.gemspec
+- LICENSE
+- NOTICE
+- README.rdoc
+- Rakefile
+has_rdoc: true
+homepage: http://buildr.apache.org/
+licenses: []
+
+post_install_message: To get started run buildr --help
+rdoc_options: 
+- --title
+- Buildr4osgi
+- --main
+- README.rdoc
+- --webcvs
+- http://github.com/intalio/buildrdeb
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A buildr plugin for packaging projects as .deb files
+test_files: []
+