buildr 1.2.10 → 1.3.0

data/rakelib/rubyforge.rake

@@ -0,0 +1,45 @@
+# 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 'rubyforge'
+rescue LoadError
+  puts 'Please run rake setup to install the RubyForge gem'
+  task 'setup' do
+    install_gem 'rubyforge'
+  end
+  task 'release:check' do
+    fail 'Please run rake setup to install the RubyForge gem'
+  end
+end
+
+
+namespace 'rubyforge' do
+
+  task 'release'=>'published' do |task|
+    changes = FileList['published/CHANGES'].first
+    files = FileList['published/*.{gem,tgz,zip}'].exclude(changes).existing
+    print "Uploading #{spec.version} to RubyForge ... "
+    rubyforge = RubyForge.new
+    rubyforge.login 
+    rubyforge.userconfig.merge!('release_changes'=>changes,  'preformatted' => true) if changes
+    rubyforge.add_release spec.rubyforge_project.downcase, spec.name.downcase, spec.version, *files
+    puts 'Done'
+  end
+
+end
+
+task 'release:publish'=>'rubyforge:release'

data/rakelib/scm.rake

@@ -0,0 +1,49 @@
+# 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 source control.
+namespace 'scm' do
+
+  task 'check' do
+    print '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 'OK'
+  end
+
+  task 'tag' do
+    info = `svn info` + `git svn info` # Using either svn or git-svn
+    url = info[/^URL:/] && info.scan(/^URL: (.*)/)[0][0] 
+    break unless url
+    new_url = url.sub(/(trunk$)|(branches\/\w*)$/, "tags/#{spec.version}")
+    break if url == new_url
+    print "Tagging release as tags/#{spec.version} ... "
+    sh 'svn', 'copy', url, new_url, '-m', "Release #{spec.version}", :verbose=>false do |ok, res|
+      if ok
+        puts 'Done'
+      else
+        puts 'Could not create tag, please do it yourself!'
+        puts %{  svn copy #{url} #{new_url} -m "#{spec.version}"}
+      end
+    end
+  end
+
+end
+
+task 'stage:check'=>'scm:check'
+task 'release:wrapup'=>'scm:tag'

data/rakelib/setup.rake

@@ -0,0 +1,59 @@
+# 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.
+# True if running on the Windows operating sytem.  Different from Gem.win_platform?
+# which returns true if running on the Windows platform of MRI, false when using JRuby.
+
+
+require 'rubygems/source_info_cache'
+
+
+def windows?
+  Config::CONFIG['host_os'] =~ /windows|cygwin|bccwin|cygwin|djgpp|mingw|mswin|wince/i
+end
+
+
+# Finds and returns path to executable.  Consults PATH environment variable.
+# Returns nil if executable not found.
+def which(name)
+  if windows?
+    path = ENV['PATH'].split(File::PATH_SEPARATOR).map { |path| path.gsub('\\', '/') }.map { |path| "#{path}/#{name}.{exe,bat,com}" }
+  else
+    path = ENV['PATH'].split(File::PATH_SEPARATOR).map { |path| "#{path}/#{name}" }
+  end
+  FileList[path].existing.first
+end
+
+
+def install_gem(name, ver_requirement = nil)
+  dep = Gem::Dependency.new(name, ver_requirement)
+  if Gem::SourceIndex.from_installed_gems.search(dep).empty?
+    spec = Gem::SourceInfoCache.search(dep).last
+    fail "#{dep} not found in local or remote repository!" unless spec
+    puts "Installing #{spec} ..."
+    args = [Config::CONFIG['ruby_install_name'], '-S', 'gem', 'install', spec.name, '-v', spec.version.to_s]
+    args.unshift('sudo', 'env', 'JAVA_HOME=' + ENV['JAVA_HOME']) unless windows?
+    sh *args
+  end
+end
+
+# Setup environment for running this Rakefile (RSpec, Docter, etc).
+desc "If you're building from sources, run this task one to setup the necessary dependencies."
+missing = spec.dependencies.select { |dep| Gem::SourceIndex.from_installed_gems.search(dep).empty? }
+task 'setup' do
+  missing.each do |dep|
+    install_gem dep.name, dep.version_requirements
+  end
+end
+puts "Missing Gems #{missing.join(', ')}, please run rake setup first!" unless missing.empty?

data/rakelib/stage.rake

@@ -0,0 +1,45 @@
+# 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.
+
+
+# Staged files are copied to this directory first, and from there uploaded to the staging server.
+directory 'staged'
+
+task 'clobber' do
+  rm_rf 'staged'
+end
+
+namespace 'stage' do
+  # stage:check verifies that we're able to stage a release: check for a changelog,
+  # local changes, run all the test cases, etc.  You can add more actions, e.g.
+  # checking license files, spell checking documentation.
+  task 'check'=>['setup', 'clobber']
+
+  # stage:prepare prepares all the files necessary for making a successful release:
+  # binary and source packages, documentation, Web site, change file, checksums, etc.
+  # This task depends on stage:check, and also performs its own verification of the
+  # produced artifacts.  Staged files are placed in the staged directory.
+  task 'prepare'=>'staged'
+
+  # stage:upload moves the stage directory to the staging server.
+  task 'upload' do |task, args|
+    puts "Uploading staged directory to #{args.staging} ..."
+    sh 'rsync', '--progress', '--recursive', 'staged/', args.staging
+    puts 'Done'
+  end
+end
+
+desc 'Stage files for the release, upload them to staging server'
+task 'stage'=>['stage:check', 'stage:prepare', 'stage:upload']

data/spec/application_spec.rb

@@ -0,0 +1,316 @@
+# 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 Buildr::Application do
+
+  describe 'home_dir' do
+    it 'should point to ~/.buildr' do
+      Buildr.application.home_dir.should eql(File.expand_path('.buildr', ENV['HOME']))
+    end
+
+    it 'should point to existing directory' do
+      File.directory?(Buildr.application.home_dir).should be_true
+    end
+  end
+
+  describe 'environment' do
+    it 'should return value of BUILDR_ENV' do
+      ENV['BUILDR_ENV'] = 'qa'
+      Buildr::Application.new.environment.should eql('qa')
+    end
+
+    it 'should default to development' do
+      Buildr::Application.new.environment.should eql('development')
+    end
+
+    it 'should set environment name from -e argument' do
+      ARGV.push('-e', 'test')
+      Buildr::Application.new.environment.should eql('test')
+      ENV['BUILDR_ENV'].should eql('test')
+    end
+
+    after do
+      ENV['BUILDR_ENV'] = nil
+    end
+  end
+
+  describe 'gems' do
+
+    def load_with_yaml
+      write 'build.yaml', <<-YAML
+        gems:
+        - rspec
+        - rake >= 0.8
+      YAML
+      Buildr.application.load_gems
+    end
+
+    it 'should return empty array if no gems specified' do
+      Buildr.application.load_gems 
+      Buildr.application.gems.should be_empty
+    end
+
+    it 'should return one entry for each gem specified in buildr.yaml' do
+      load_with_yaml
+      Buildr.application.gems.size.should be(2)
+    end
+
+    it 'should return a Gem::Specification for each installed gem' do
+      load_with_yaml
+      Buildr.application.gems.each { |gem| gem.should be_kind_of(Gem::Specification) }
+    end
+
+    it 'should parse Gem name correctly' do
+      load_with_yaml
+      Buildr.application.gems.map(&:name).should include('rake', 'rspec')
+    end
+
+    it 'should find installed version of Gem' do
+      load_with_yaml
+      Buildr.application.gems.each { |gem| gem.version.should eql(Gem.loaded_specs[gem.name].version) }
+    end
+  end
+
+
+  describe 'load_gems' do
+    before do
+      @spec = Gem::Specification.new do |spec|
+        spec.name = 'foo'
+        spec.version = '1.2'
+      end
+    end
+
+    it 'should do nothing if no gems specified' do
+      lambda { Buildr.application.load_gems }.should_not raise_error
+    end
+
+    it 'should install nothing if specified gems already installed' do
+      Buildr.application.should_receive(:listed_gems).and_return([Gem.loaded_specs['rspec']])
+      Util.should_not_receive(:ruby)
+      lambda { Buildr.application.load_gems }.should_not raise_error
+    end
+
+    it 'should fail if required gem not found in remote repository' do
+      Buildr.application.should_receive(:listed_gems).and_return([Gem::Dependency.new('foo', '>=1.1')])
+      Gem::SourceInfoCache.should_receive(:search).and_return([])
+      lambda { Buildr.application.load_gems }.should raise_error(LoadError, /cannot be found/i)
+    end
+
+    it 'should fail if need to install gem and not running in interactive mode' do
+      Buildr.application.should_receive(:listed_gems).and_return([Gem::Dependency.new('foo', '>=1.1')])
+      Gem::SourceInfoCache.should_receive(:search).and_return([@spec])
+      $stdout.should_receive(:isatty).and_return(false)
+      lambda { Buildr.application.load_gems }.should raise_error(LoadError, /this build requires the gems/i)
+    end
+
+    it 'should ask permission before installing required gems' do
+      Buildr.application.should_receive(:listed_gems).and_return([Gem::Dependency.new('foo', '>=1.1')])
+      Gem::SourceInfoCache.should_receive(:search).and_return([@spec])
+      $terminal.should_receive(:agree).with(/install/, true)
+      lambda { Buildr.application.load_gems }.should raise_error
+    end
+
+    it 'should fail if permission not granted to install gem' do
+      Buildr.application.should_receive(:listed_gems).and_return([Gem::Dependency.new('foo', '>=1.1')])
+      Gem::SourceInfoCache.should_receive(:search).and_return([@spec])
+      $terminal.should_receive(:agree).and_return(false)
+      lambda { Buildr.application.load_gems }.should raise_error(LoadError, /cannot build without/i)
+    end
+
+    it 'should install gem if permission granted' do
+      Buildr.application.should_receive(:listed_gems).and_return([Gem::Dependency.new('foo', '>=1.1')])
+      Gem::SourceInfoCache.should_receive(:search).and_return([@spec])
+      $terminal.should_receive(:agree).and_return(true)
+      Util.should_receive(:ruby) do |*args|
+        args.should include('install', 'foo', '-v', '1.2')
+      end
+      Buildr.application.should_receive(:gem).and_return(false)
+      Buildr.application.load_gems
+    end
+
+    it 'should reload gem cache after installing required gems' do
+      Buildr.application.should_receive(:listed_gems).and_return([Gem::Dependency.new('foo', '>=1.1')])
+      Gem::SourceInfoCache.should_receive(:search).and_return([@spec])
+      $terminal.should_receive(:agree).and_return(true)
+      Util.should_receive(:ruby)
+      Gem.source_index.should_receive(:load_gems_in).with(Gem::SourceIndex.installed_spec_directories)
+      Buildr.application.should_receive(:gem).and_return(false)
+      Buildr.application.load_gems
+    end
+
+    it 'should load previously installed gems' do
+      Buildr.application.should_receive(:listed_gems).and_return([Gem.loaded_specs['rspec']])
+      Buildr.application.should_receive(:gem).with('rspec', Gem.loaded_specs['rspec'].version.to_s)
+      Buildr.application.load_gems
+    end
+
+    it 'should load newly installed gems' do
+      Buildr.application.should_receive(:listed_gems).and_return([Gem::Dependency.new('foo', '>=1.1')])
+      Gem::SourceInfoCache.should_receive(:search).and_return([@spec])
+      $terminal.should_receive(:agree).and_return(true)
+      Util.should_receive(:ruby)
+      Buildr.application.should_receive(:gem).with('foo', @spec.version.to_s)
+      Buildr.application.load_gems
+    end
+
+    it 'should default to >=0 version requirement if not specified' do
+      write 'build.yaml', 'gems: foo'
+      Gem::SourceInfoCache.should_receive(:search).with(Gem::Dependency.new('foo', '>=0')).and_return([])
+      lambda { Buildr.application.load_gems }.should raise_error
+    end
+
+    it 'should parse exact version requirement' do
+      write 'build.yaml', 'gems: foo 2.5'
+      Gem::SourceInfoCache.should_receive(:search).with(Gem::Dependency.new('foo', '=2.5')).and_return([])
+      lambda { Buildr.application.load_gems }.should raise_error
+    end
+
+    it 'should parse range version requirement' do
+      write 'build.yaml', 'gems: foo ~>2.3'
+      Gem::SourceInfoCache.should_receive(:search).with(Gem::Dependency.new('foo', '~>2.3')).and_return([])
+      lambda { Buildr.application.load_gems }.should raise_error
+    end
+
+    it 'should parse multiple version requirements' do
+      write 'build.yaml', 'gems: foo >=2.0 !=2.1'
+      Gem::SourceInfoCache.should_receive(:search).with(Gem::Dependency.new('foo', ['>=2.0', '!=2.1'])).and_return([])
+      lambda { Buildr.application.load_gems }.should raise_error
+    end
+  end
+
+end
+
+
+describe Buildr, 'settings' do
+
+  describe 'user' do
+
+    it 'should be empty hash if no settings.yaml file' do
+      Buildr.settings.user.should == {}
+    end
+
+    it 'should return loaded settings.yaml file' do
+      write 'home/.buildr/settings.yaml', 'foo: bar'
+      Buildr.settings.user.should == { 'foo'=>'bar' }
+    end
+
+    it 'should fail if settings.yaml file is not a hash' do
+      write 'home/.buildr/settings.yaml', 'foo bar'
+      lambda { Buildr.settings.user }.should raise_error(RuntimeError, /expecting.*settings.yaml/i)
+    end
+
+    it 'should be empty hash if settings.yaml file is empty' do
+      write 'home/.buildr/settings.yaml'
+      Buildr.settings.user.should == {}
+    end
+  end
+
+  describe 'configuration' do
+    it 'should be empty hash if no build.yaml file' do
+      Buildr.settings.build.should == {}
+    end
+
+    it 'should return loaded build.yaml file' do
+      write 'build.yaml', 'foo: bar'
+      Buildr.settings.build.should == { 'foo'=>'bar' }
+    end
+
+    it 'should fail if build.yaml file is not a hash' do
+      write 'build.yaml', 'foo bar'
+      lambda { Buildr.settings.build }.should raise_error(RuntimeError, /expecting.*build.yaml/i)
+    end
+
+    it 'should be empty hash if build.yaml file is empty' do
+      write 'build.yaml'
+      Buildr.settings.build.should == {}
+    end
+  end
+
+  describe 'profiles' do
+    it 'should be empty hash if no profiles.yaml file' do
+      Buildr.settings.profiles.should == {}
+    end
+
+    it 'should return loaded profiles.yaml file' do
+      write 'profiles.yaml', <<-YAML
+        development:
+          foo: bar
+      YAML
+      Buildr.settings.profiles.should == { 'development'=> { 'foo'=>'bar' } }
+    end
+
+    it 'should fail if profiles.yaml file is not a hash' do
+      write 'profiles.yaml', 'foo bar'
+      lambda { Buildr.settings.profiles }.should raise_error(RuntimeError, /expecting.*profiles.yaml/i)
+    end
+
+    it 'should be empty hash if profiles.yaml file is empty' do
+      write 'profiles.yaml'
+      Buildr.settings.profiles.should == {}
+    end
+  end
+
+  describe 'profile' do
+    it 'should be empty hash if no profiles.yaml' do
+      Buildr.settings.profile.should == {}
+    end
+
+    it 'should be empty hash if no matching profile' do
+      write 'profiles.yaml', <<-YAML
+        test:
+          foo: bar
+      YAML
+      Buildr.settings.profile.should == {}
+    end
+
+    it 'should return profile matching environment name' do
+      write 'profiles.yaml', <<-YAML
+        development:
+          foo: bar
+        test:
+          foo: baz
+      YAML
+      Buildr.settings.profile.should == { 'foo'=>'bar' }
+    end
+
+  end
+
+end
+
+
+describe Buildr do
+  
+  describe 'environment' do
+    it 'should be same as Buildr.application.environment' do
+      Buildr.environment.should eql(Buildr.application.environment)
+    end
+  end
+
+  describe 'application' do
+    it 'should be same as Rake.application' do
+      Buildr.application.should == Rake.application
+    end
+  end
+
+  describe 'settings' do
+    it 'should be same as Buildr.application.settings' do
+      Buildr.settings.should == Buildr.application.settings
+    end
+  end
+end