realityforge-buildr 1.5.9

data/spec/core/console_spec.rb

@@ -0,0 +1,65 @@
+# 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.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helpers'))
+
+describe Buildr::Console do
+
+  describe 'console_dimensions' do
+
+    it 'should return a value' do
+      Buildr::Console.console_dimensions.should_not be_nil if $stdout.isatty # have to ask again as stdout may be redirected.
+    end if $stdout.isatty && !ENV["TRAVIS"]
+  end
+
+  describe 'color' do
+
+    describe 'when use_color is true' do
+      before do
+        Buildr::Console.use_color = true
+      end
+
+      it 'should emit red code when asked' do
+        Buildr::Console.color('message', :red).should eql("\e[31mmessage\e[0m")
+      end
+
+      it 'should emit green code when asked' do
+        Buildr::Console.color('message', :green).should eql("\e[32mmessage\e[0m")
+      end
+
+      it 'should emit blue code when asked' do
+        Buildr::Console.color('message', :blue).should eql("\e[34mmessage\e[0m")
+      end
+    end if $stdout.isatty
+
+    describe ' use_color is false' do
+      before do
+        Buildr::Console.use_color = false
+      end
+
+      it 'should not emit red code when asked' do
+        Buildr::Console.color('message', :red).should eql("message")
+      end
+
+      it 'should not emit green code when asked' do
+        Buildr::Console.color('message', :green).should eql("message")
+      end
+
+      it 'should not emit blue code when asked' do
+        Buildr::Console.color('message', :blue).should eql("message")
+      end
+    end
+  end
+end

data/spec/core/doc_spec.rb

@@ -0,0 +1,194 @@
+# 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.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helpers'))
+
+
+describe Project, '#doc' do
+  def sources
+    @sources ||= (1..3).map { |i| "Test#{i}" }.
+      each { |name| write "src/main/java/foo/#{name}.java", "package foo; public class #{name}{}" }.
+      map { |name| "src/main/java/foo/#{name}.java" }
+  end
+
+  it 'should return the project\'s Javadoc task' do
+    define('foo') { compile.using(:javac) }
+    project('foo').doc.name.should eql('foo:doc')
+  end
+
+  it 'should return a DocTask' do
+    define('foo') { compile.using(:javac) }
+    project('foo').doc.should be_kind_of(Doc::DocTask)
+  end
+
+  it 'should set target directory to target/doc' do
+    define 'foo' do
+      compile.using(:javac)
+      doc.target.to_s.should point_to_path('target/doc')
+    end
+  end
+
+  it 'should create file task for target directory' do
+    define 'foo' do
+      compile.using(:javac)
+      doc.should_receive(:invoke_prerequisites)
+    end
+    project('foo').file('target/doc').invoke
+  end
+
+  it 'should respond to into() and return self' do
+    define 'foo' do
+      compile.using(:javac)
+      doc.into('docs').should be(doc)
+    end
+  end
+
+  it 'should respond to into() and change target directory' do
+    define 'foo' do
+      compile.using(:javac)
+      doc.into('docs')
+      doc.should_receive(:invoke_prerequisites)
+    end
+    file('docs').invoke
+  end
+
+  it 'should respond to from() and return self' do
+    task = nil
+    define('foo') do
+      compile.using(:javac)
+      task = doc.from('srcs')
+    end
+    task.should be(project('foo').doc)
+  end
+
+  it 'should respond to from() and add sources' do
+    define 'foo' do
+      compile.using(:javac)
+      doc.from('srcs').should be(doc)
+    end
+  end
+
+  it 'should respond to from() and add file task' do
+    define 'foo' do
+      compile.using(:javac)
+      doc.from('srcs').should be(doc)
+    end
+    project('foo').doc.source_files.first.should point_to_path('srcs')
+  end
+
+  it 'should respond to from() and add project\'s sources and dependencies' do
+    write 'bar/src/main/java/Test.java'
+    define 'foo' do
+      compile.using(:javac)
+      define('bar') { compile.using(:javac).with 'group:id:jar:1.0' }
+      doc.from project('foo:bar')
+    end
+    project('foo').doc.source_files.first.should point_to_path('bar/src/main/java/Test.java')
+    project('foo').doc.classpath.map(&:to_spec).should include('group:id:jar:1.0')
+  end
+
+  it 'should generate docs from project' do
+    sources
+    define('foo') { compile.using(:javac) }
+    project('foo').doc.source_files.sort.should == sources.sort.map { |f| File.expand_path(f) }
+  end
+
+  it 'should include compile dependencies' do
+    define('foo') { compile.using(:javac).with 'group:id:jar:1.0' }
+    project('foo').doc.classpath.map(&:to_spec).should include('group:id:jar:1.0')
+  end
+
+  it 'should respond to include() and return self' do
+    define 'foo' do
+      compile.using(:javac)
+      doc.include('srcs').should be(doc)
+    end
+  end
+
+  it 'should respond to include() and add files' do
+    included = sources.first
+    define 'foo' do
+      compile.using(:javac)
+      doc.include included
+    end
+    project('foo').doc.source_files.should include(File.expand_path(included))
+  end
+
+  it 'should respond to exclude() and return self' do
+    define 'foo' do
+      compile.using(:javac)
+      doc.exclude('srcs').should be(doc)
+    end
+  end
+
+  it 'should respond to exclude() and ignore files' do
+    excluded = sources.first
+    define 'foo' do
+      compile.using(:javac)
+      doc.exclude excluded
+    end
+    sources
+    project('foo').doc.source_files.sort.should == sources[1..-1].map { |f| File.expand_path(f) }
+  end
+
+  it 'should respond to using() and return self' do
+    define 'foo' do
+      compile.using(:javac)
+      doc.using(:foo=>'Fooing').should be(doc)
+    end
+  end
+
+  it 'should respond to using() and accept options' do
+    define 'foo' do
+      compile.using(:javac)
+      doc.using :foo=>'Fooing'
+    end
+    project('foo').doc.options[:foo].should eql('Fooing')
+  end
+
+  it 'should produce documentation' do
+    sources
+    define('foo') { compile.using(:javac) }
+    project('foo').doc.invoke
+    (1..3).map { |i| "target/doc/foo/Test#{i}.html" }.each { |f| file(f).should exist }
+  end
+
+  it 'should fail on error' do
+    write 'Test.java', 'class Test {}'
+    define 'foo' do
+      compile.using(:javac)
+      doc.include 'Test.java'
+    end
+    lambda { project('foo').doc.invoke }.should raise_error(RuntimeError, /Failed to generate Javadocs/)
+  end
+
+  it 'should be local task' do
+    define 'foo' do
+      define('bar') { compile.using(:javac) }
+    end
+    project('foo:bar').doc.should_receive(:invoke_prerequisites)
+    in_original_dir(project('foo:bar').base_dir) { task('doc').invoke }
+  end
+
+  it 'should not recurse' do
+    define 'foo' do
+      compile.using(:javac)
+      define('bar') { compile.using(:javac) }
+    end
+    project('foo:bar').doc.should_not_receive(:invoke_prerequisites)
+    project('foo').doc.invoke
+  end
+end

data/spec/core/extension_spec.rb

@@ -0,0 +1,200 @@
+# 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.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helpers'))
+
+
+describe Extension do
+
+  before do
+    @saved_modules   = Project.class_eval { @extension_modules }.dup
+    @saved_callbacks = Project.class_eval { @global_callbacks }.dup
+  end
+
+  after do
+    modules   = @saved_modules
+    callbacks = @saved_callbacks
+    Project.class_eval do
+      @global_callbacks  = callbacks
+      @extension_modules = modules
+    end
+  end
+
+  it 'should call Extension.first_time during include' do
+    TestExtension.should_receive(:first_time_called).once
+    class Buildr::Project
+      include TestExtension
+    end
+  end
+
+  it 'should call before_define and after_define in order when project is defined' do
+    begin
+      TestExtension.callback do |extension|
+        extension.should_receive(:before_define_called).once.ordered
+        extension.should_receive(:after_define_called).once.ordered
+      end
+      class Buildr::Project
+        include TestExtension
+      end
+      define('foo')
+    ensure
+      TestExtension.callback { |ignore| }
+    end
+  end
+
+  it 'should call before_define and after_define for each project defined' do
+    begin
+      extensions = 0
+      TestExtension.callback do |extension|
+        extensions += 1
+        extension.should_receive(:before_define_called).once.ordered
+        extension.should_receive(:after_define_called).once.ordered
+      end
+      class Buildr::Project
+        include TestExtension
+      end
+      define('foo')
+      define('bar')
+      extensions.should equal(2)
+    ensure
+      TestExtension.callback { |ignore| }
+    end
+  end
+
+  it 'should call before_define callbacks in dependency order' do
+    class Buildr::Project
+      include ExtensionOneTwo
+      include ExtensionThreeFour
+    end
+    define('foo')
+    project('foo').before_order.should == [ :one, :two, :three, :four ]
+    project('foo').after_order.should  == [ :four, :three, :two, :one ]
+  end
+
+  it 'should call before_define callbacks when extending project' do
+    define('foo') do
+      extend ExtensionOneTwo
+      extend ExtensionThreeFour
+    end
+    project('foo').before_order.should == [ :two, :one, :four, :three ]
+    project('foo').after_order.should  == [ :four, :three, :two, :one ]
+  end
+
+  it 'should raise error when including if callback dependencies cannot be satisfied' do
+    class Buildr::Project
+      include ExtensionOneTwo # missing ExtensionThreeFour
+    end
+    lambda { define('foo') }.should raise_error
+  end
+
+  it 'should raise error when extending if callback dependencies cannot be satisfied' do
+    lambda {
+      define('foo') do |project|
+        extend ExtensionOneTwo # missing ExtensionThreeFour
+      end
+    }.should raise_error
+  end
+
+  it 'should ignore dependencies when extending project' do
+    define('bar') do |project|
+      extend ExtensionThreeFour # missing ExtensionOneTwo
+    end
+    project('bar').before_order.should == [:four, :three]
+    project('bar').after_order.should == [:four, :three]
+  end
+end
+
+module TestExtension
+  include Extension
+
+  def initialize(*args)
+    super
+    # callback is used to obtain extension instance created by buildr
+    @@callback.call(self) if @@callback
+  end
+
+  def self.callback(&block)
+    @@callback = block
+  end
+
+  first_time do
+    self.first_time_called()
+  end
+
+  before_define do |project|
+    project.before_define_called()
+  end
+
+  after_define do |project|
+    project.after_define_called()
+  end
+
+  def self.first_time_called()
+  end
+
+end
+
+module BeforeAfter
+  def before_order
+    @before_order ||= []
+  end
+
+  def after_order
+    @after_order ||= []
+  end
+end
+
+module ExtensionOneTwo
+  include Extension, BeforeAfter
+
+  before_define(:two => :one) do |project|
+    project.before_order << :two
+  end
+
+  before_define(:one) do |project|
+    project.before_order << :one
+  end
+
+  after_define(:one => :two) do |project|
+    project.after_order << :one
+  end
+
+  after_define(:two => :three) do |project|
+    project.after_order << :two
+  end
+end
+
+module ExtensionThreeFour
+  include Extension, BeforeAfter
+
+  before_define(:three => :two)
+
+  before_define(:four => :three) do |project|
+    project.before_order << :four
+  end
+
+  before_define(:three) do |project|
+    project.before_order << :three
+  end
+
+  after_define(:three => :four) do |project|
+    project.after_order << :three
+  end
+
+  after_define(:four) do |project|
+    project.after_order << :four
+  end
+end