rake-builder 0.0.8

data/spec/dependencies_spec.rb

@@ -0,0 +1,103 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe 'the dependencies system' do
+
+  include RakeBuilderHelper
+
+  before( :each ) do
+    Rake::Task.clear
+    @project = cpp_task( :executable )
+    Rake::Task[ 'clean' ].execute
+  end
+
+  after( :each ) do
+    Rake::Task[ 'clean' ].execute
+  end
+
+  it 'says the target is up to date, if nothing changes' do
+    Rake::Task[ 'build' ].invoke
+    Rake::Task[ @project.target ].needed?.should_not be_true
+  end
+
+  it 'says the build is up to date, if nothing changes' do
+    Rake::Task[ 'build' ].invoke
+    Rake::Task[ 'build' ].needed?.should be_false
+  end
+
+  it 'doesn\'t recompile objects, if nothing changes' do
+    isolating_seconds do
+      Rake::Task[ 'compile' ].invoke
+    end
+    Rake::Task.clear
+    @project = cpp_task( :executable )
+    object_file_path = Rake::Builder.expand_path_with_root( 'main.o', SPEC_PATH )
+    Rake::Task[ object_file_path ].needed?.should be_false
+  end
+
+  it 'recompiles objects, if a source file changes' do
+    isolating_seconds do
+      Rake::Task[ 'compile' ].invoke
+    end
+    Rake::Task.clear
+    @project = cpp_task( :executable )
+    source_file_path = Rake::Builder.expand_path_with_root( 'cpp_project/main.cpp', SPEC_PATH )
+    object_file_path = Rake::Builder.expand_path_with_root( 'main.o', SPEC_PATH )
+    touching_temporarily( source_file_path, File.mtime( object_file_path ) + 1 ) do
+      Rake::Task[ object_file_path ].needed?.should be_true
+    end
+  end
+
+  it 'recompiles source files, if header dependencies' do
+    header_file_path = Rake::Builder.expand_path_with_root( 'cpp_project/main.h', SPEC_PATH )
+    object_file_path = Rake::Builder.expand_path_with_root( 'main.o', SPEC_PATH )
+    isolating_seconds do
+      Rake::Task[ 'compile' ].invoke
+    end
+    Rake::Task.clear
+    @project = cpp_task( :executable )
+    # Header dependencies aren't loaded until we call :compile
+    Rake::Task[ :load_makedepend ].invoke
+    touching_temporarily( header_file_path, File.mtime( object_file_path ) + 1 ) do
+      Rake::Task[ object_file_path ].needed?.should be_true
+    end
+  end
+
+end
+
+describe 'Rakefile dependencies' do
+
+  include RakeBuilderHelper
+
+  before( :each ) do
+    Rake::Task.clear
+    @project = cpp_task( :executable )
+    Rake::Task[ 'clean' ].execute
+  end
+
+  after( :each ) do
+    Rake::Task[ 'clean' ].execute
+  end
+
+  it 'should make the target depend on the Rakefile' do
+    Rake::Task[ @project.target ].prerequisites.include?( @project.rakefile ).should be_true
+  end
+
+  # In our case this spec file is the spec_helper
+  # i.e., the file that calls Rake::Builder.new
+  it 'should indicate the target is out of date, if the Rakefile is newer' do
+    Rake::Task[ 'build' ].invoke
+    Rake::Task[ @project.target ].needed?.should be_false
+    touching_temporarily( @project.target, File.mtime( @project.rakefile ) - 1 ) do
+      Rake::Task[ @project.target ].needed?.should be_true
+    end
+  end
+
+  it 'should indicate that a build is needed if the Rakefile changes' do
+    Rake::Task[ 'build' ].invoke
+    Rake::Task[ 'build' ].needed?.should be_false
+    touching_temporarily( @project.target, File.mtime( @project.rakefile ) - 1 ) do
+      Rake::Task[ 'build' ].needed?.should be_true
+    end
+  end
+
+end

data/spec/generated_files_spec.rb

@@ -0,0 +1,72 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe 'when handling generated files' do
+
+  include RakeBuilderHelper
+
+  before( :each ) do
+    Rake::Task.clear
+    @project = cpp_task( :executable )
+    @expected_generated = Rake::Builder.expand_paths_with_root(
+                            [
+                             'main.o',
+                             'rake-builder-testfile.txt',
+                             @project.makedepend_file,
+                             @project.target
+                            ],
+                            SPEC_PATH
+                          )
+  end
+
+  after( :each ) do
+    Rake::Task[ 'clean' ].execute
+  end
+
+  it 'lists generated files, with a method' do
+    @project.generated_files.should =~ @expected_generated
+  end
+
+  it 'lists generated files, via the task' do
+    output = capturing_output do
+      Rake::Task[ 'generated_files' ].execute
+    end
+    eval( output ).should =~ @expected_generated
+  end
+
+  it 'removes generated files with \'clean\'' do
+    Rake::Task[ 'run' ].invoke
+    @expected_generated.each do |f|
+      exist?( f ).should be_true
+    end
+    Rake::Task[ 'clean' ].invoke
+    @expected_generated.each do |f|
+      exist?( f ).should be_false
+    end
+  end
+
+end
+
+describe 'when adding generated files' do
+
+  include RakeBuilderHelper
+
+  before( :each ) do
+    @file = 'foobar.txt'
+    @file_with_path = Rake::Builder.expand_path_with_root( @file, SPEC_PATH )
+  end
+
+  it 'includes added files' do
+    @project = cpp_task( :executable ) do |app|
+      app.generated_files << @file_with_path
+    end
+    @project.generated_files.include?( @file_with_path ).should be_true
+  end
+
+  it 'expands the paths of added files' do
+    @project = cpp_task( :executable ) do |app|
+      app.generated_files << @file
+    end
+    @project.generated_files.include?( @file_with_path ).should be_true
+  end
+
+end

data/spec/libraries_spec.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe 'when using libraries' do
+
+  include RakeBuilderHelper
+
+  before( :each ) do
+    Rake::Task.clear
+  end
+
+  after( :each ) do
+    Rake::Task[ 'clean' ].execute
+  end
+
+  it 'builds if libraries are found' do
+    lambda do
+      @project = cpp_task( :executable ) do |builder|
+        builder.library_dependencies = [ 'gcc' ] # As we're using GCC, libgcc.a should always be present
+      end
+      Rake::Task[ 'build' ].invoke
+    end.should_not raise_error
+  end
+
+  it 'fails to build if libraries are missing' do
+    lambda do
+      @project = cpp_task( :executable ) do |builder|
+        builder.library_dependencies = [ 'library_that_doesnt_exist' ]
+      end
+      Rake::Task[ 'build' ].invoke
+    end.should raise_error( Rake::BuildFailureError )
+  end
+
+end

data/spec/logger_spec.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe 'the logger' do
+
+  it 'can be read' do
+    builder = Rake::Builder.new do |builder|
+      builder.source_search_paths = [ 'cpp_project' ]
+    end
+    builder.logger.should_not be_nil
+  end
+
+  it 'can be set' do
+    builder = Rake::Builder.new do |builder|
+      builder.source_search_paths = [ 'cpp_project' ]
+    end
+    lambda do
+      builder.logger = Logger.new( STDOUT )
+    end.should_not raise_exception
+  end
+
+end

data/spec/paths_spec.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+PATHS_SPEC_PATH = File.expand_path( File.dirname(__FILE__) )
+
+describe 'when creating tasks' do
+
+  before( :each ) do
+    Rake::Task.clear
+  end
+
+  it 'remembers the Rakefile path' do
+    builder = Rake::Builder.new do |builder|
+      builder.source_search_paths = [ 'cpp_project' ]
+    end
+    builder.rakefile_path.should == PATHS_SPEC_PATH
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,99 @@
+require 'spec'
+require File.dirname(__FILE__) + '/../lib/rake/builder'
+
+SPEC_PATH = File.expand_path( File.dirname(__FILE__) )
+
+module RakeBuilderHelper
+
+  TARGET = {
+    :executable      => 'the_executable',
+    :static_library  => 'libthe_static_library.a',
+    :shared_library  => 'libthe_dynamic_library.so',
+  }
+
+  def cpp_task( type, namespace = nil )
+    Rake::Builder.new do |builder|
+      builder.programming_language = 'c++'
+      builder.target               = TARGET[ type ]
+      builder.task_namespace       = namespace
+      builder.source_search_paths  = [ 'cpp_project' ]
+      builder.header_search_paths  = [ 'cpp_project' ]
+      builder.generated_files      << 'rake-builder-testfile.txt'
+      yield builder if block_given?
+    end
+  end
+
+  def c_task( type, namespace = nil )
+    Rake::Builder.new do |builder|
+      builder.programming_language = 'c'
+      builder.target               = TARGET[ type ]
+      builder.task_namespace       = namespace
+      builder.source_search_paths  = [ 'c_project' ]
+      builder.header_search_paths  = [ 'c_project' ]
+      builder.generated_files      << 'rake-c-testfile.txt'
+      yield builder if block_given?
+    end
+  end
+
+  def touch( file )
+    `touch #{file}`
+  end
+
+  def exist?( file )
+    File.exist? file
+  end
+
+  def task_names
+    Rake::Task.tasks.map( &:to_s )
+  end
+
+  def default_tasks
+    [ 'build', 'clean', 'compile', 'load_makedepend' ]
+  end
+
+  def expected_tasks( extras, scope = nil )
+    t = scoped_tasks( default_tasks, scope )
+    t += extras
+    t << if scope.nil?
+           'default'
+         else
+           scope
+         end
+    t
+  end
+
+  def scoped_tasks( tasks, scope )
+    return tasks if scope.nil?
+    tasks.map{ |t| "#{scope}:#{t}" }
+  end
+
+  def capturing_output
+    output = StringIO.new
+    $stdout = output
+    yield
+    output.string
+  ensure
+    $stdout = STDOUT
+  end
+
+  # Most file systems have a 1s resolution
+  # Force a wait into the next second around a task
+  # So FileTask's out_of_date? will behave correctly
+  def isolating_seconds
+    sec = Time.now.sec
+    yield
+    while( Time.now.sec == sec ) do end
+  end
+
+  def touching_temporarily( file, touch_time )
+    begin
+      atime = File.atime( file )
+      mtime = File.mtime( file )
+      File.utime( atime, touch_time, file )
+      yield
+    ensure
+      File.utime( atime, mtime, file )
+    end
+  end
+
+end

data/spec/target_spec.rb

@@ -0,0 +1,44 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe 'when creating tasks' do
+
+  before( :each ) do
+    Rake::Task.clear
+  end
+
+  it 'raises an error when the target is an empty string' do
+    lambda do
+      Rake::Builder.new do |builder|
+        builder.target = ''
+        builder.source_search_paths = [ 'cpp_project' ]
+      end
+    end.should raise_error( RuntimeError )
+  end
+
+  it 'raises an error when the target is set to nil' do
+    lambda do
+      Rake::Builder.new do |builder|
+        builder.target = nil
+        builder.source_search_paths = [ 'cpp_project' ]
+      end
+    end.should raise_error( RuntimeError )
+  end
+
+  it 'sets the target to \'a.out\' if it is not set' do
+    builder = Rake::Builder.new do |builder|
+      builder.source_search_paths = [ 'cpp_project' ]
+    end
+    builder.target.should == Rake::Builder.expand_path_with_root( 'a.out', SPEC_PATH )
+  end
+
+  it 'raises an error when the supplied target_type is unknown' do
+    lambda do
+      project = Rake::Builder.new do |builder|
+        builder.target      = 'my_prog'
+        builder.target_type = :foo
+        builder.source_search_paths = [ 'cpp_project' ]
+      end
+    end.should raise_error
+  end
+
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification 
+name: rake-builder
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 8
+  version: 0.0.8
+platform: ruby
+authors: 
+- Joe Yates
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-20 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :runtime
+  version_requirements: *id001
+description: Provides Rake:Builder, a specific rake TaskLib for building C, C++, Objective-C and Objective-C++ projects
+email: joe.g.yates@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- COPYING
+- README.rdoc
+- lib/rake/builder.rb
+- examples/README.rdoc
+- examples/01_hello_world_cpp/Rakefile
+- examples/02_hello_world_c/Rakefile
+- examples/03_search_paths/Rakefile
+- examples/04_zlib/Rakefile
+- examples/05_tests/Rakefile
+- examples/06_hello_world_objective_c/Rakefile
+files: 
+- CHANGES
+- COPYING
+- Rakefile
+- README.rdoc
+- lib/rake/builder.rb
+- examples/03_search_paths/include/main.h
+- examples/04_zlib/include/main.h
+- examples/05_tests/include/main.h
+- examples/05_tests/include/units.h
+- examples/02_hello_world_c/main.c
+- examples/04_zlib/src/main.c
+- examples/01_hello_world_cpp/main.cpp
+- examples/03_search_paths/src/main.cpp
+- examples/05_tests/src/main.cpp
+- examples/05_tests/src/units.cpp
+- examples/05_tests/test/test_unit.cpp
+- examples/06_hello_world_objective_c/main.m
+- examples/README.rdoc
+- examples/01_hello_world_cpp/Rakefile
+- examples/02_hello_world_c/Rakefile
+- examples/03_search_paths/Rakefile
+- examples/04_zlib/Rakefile
+- examples/05_tests/Rakefile
+- examples/06_hello_world_objective_c/Rakefile
+- spec/c_project/main.c
+- spec/c_project/main.h
+- spec/c_project_spec.rb
+- spec/cpp_project/main.cpp
+- spec/cpp_project/main.h
+- spec/cpp_project_spec.rb
+- spec/dependencies_spec.rb
+- spec/generated_files_spec.rb
+- spec/libraries_spec.rb
+- spec/logger_spec.rb
+- spec/paths_spec.rb
+- spec/spec_helper.rb
+- spec/target_spec.rb
+has_rdoc: true
+homepage: http://github.com/joeyates/rake-builder
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --quiet
+- --main
+- README.rdoc
+- --inline-source
+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: Rake for C/C++ Projects
+test_files: 
+- spec/c_project/main.c
+- spec/c_project/main.h
+- spec/c_project_spec.rb
+- spec/cpp_project/main.cpp
+- spec/cpp_project/main.h
+- spec/cpp_project_spec.rb
+- spec/dependencies_spec.rb
+- spec/generated_files_spec.rb
+- spec/libraries_spec.rb
+- spec/logger_spec.rb
+- spec/paths_spec.rb
+- spec/spec_helper.rb
+- spec/target_spec.rb