rake-builder 0.0.14 → 0.0.15

data/lib/rake/builder/version.rb

@@ -1,11 +1,12 @@
-module Rake
+require 'rake/tasklib'
 
-  class Builder
+module Rake
+  class Builder < TaskLib
 
     module VERSION #:nodoc:
-      MAJOR =  0
-      MINOR =  0
-      TINY  = 14
+      MAJOR = 0
+      MINOR = 0
+      TINY  = 15
 
       STRING = [ MAJOR, MINOR, TINY ].join('.')
     end
@@ -13,3 +14,4 @@ module Rake
   end
 
 end
+

data/lib/rake/local_config.rb

@@ -4,35 +4,38 @@ module Rake
 
   class LocalConfig
 
-    attr_accessor :config
+    VERSIONS = ['1.0', '1.1']
+
+    attr_accessor :include_paths
+    attr_accessor :compilation_options
 
     def initialize( file_name )
-      @file_name = file_name
-      @config    = { :rake_builder  => { :config_file => { :version=> '1.0' } },
-                     :include_paths => [] }
+      @file_name           = file_name
+      @include_paths       = []
+      @compilation_options = []
     end
 
     def load
-      @config = YAML.load_file( @file_name )
-
-      version = @config[ :rake_builder ][ :config_file ][ :version ]
-      raise Rake::Builder::BuilderError.new( 'Config file version missing' ) if version.nil?
+      config = YAML.load_file( @file_name )
 
-      @config[ :include_paths ] ||= []
+      version             = config[:rake_builder][:config_file][:version]
+      @include_paths       = config[:include_paths]
+      @compilation_options = config[:compilation_options]
+      if not VERSIONS.find_index(version)
+        raise Rake::Builder::BuilderError.new('Config file version incorrect') 
+      end
     end
 
     def save
       File.open( @file_name, 'w' ) do | file |
-        file.write @config.to_yaml
+        file.write config.to_yaml
       end
     end
 
-    def include_paths
-      @config[ :include_paths ]
-    end
-
-    def include_paths=( include_paths )
-      @config[ :include_paths ] = include_paths
+    def config
+      { :rake_builder        => { :config_file => { :version => VERSIONS[-1] } },
+        :include_paths       => @include_paths,
+        :compilation_options => @compilation_options }
     end
 
   end

data/lib/rake/microsecond.rb

@@ -0,0 +1,70 @@
+require 'rubygems' if RUBY_VERSION < '1.9'
+require 'rake/tasklib'
+require 'fileutils'
+
+module Rake
+
+  module Microsecond
+  # Compensate for file systems with 1s resolution
+
+    class FileTask < Task
+
+      attr_accessor :timestamp
+
+      def self.define_task( *args, &block )
+        task = super( *args, &block )
+        task.timestamp = nil
+        task
+      end
+
+      def needed?
+        return true if ! File.exist?( self.name )
+        @timestamp = File.stat( self.name ).mtime if @timestamp.nil?
+        return self.prerequisites.any? { | n | ! application[n].timestamp.nil? && application[n].timestamp > @timestamp }
+      end
+
+      def execute(*args)
+        @timestamp = Time.now
+        super(*args)
+      end
+
+    end
+
+    class DirectoryTask < Task
+
+      include FileUtils
+
+      attr_accessor :timestamp
+
+      def self.define_task( *args, &block )
+        task = super( *args, &block )
+        task.timestamp = nil
+        task
+      end
+
+      def needed?
+        exists = File.directory?( self.name )
+        @timestamp = File.stat( self.name ).mtime if exists
+        ! exists
+      end
+
+      def execute(*args)
+        mkdir_p self.name, :verbose => false
+        @timestamp = Time.now
+        super(*args)
+      end
+
+    end
+
+  end
+
+end
+
+def microsecond_file(*args, &block)
+  Rake::Microsecond::FileTask.define_task(*args, &block)
+end
+
+def microsecond_directory(*args, &block)
+  Rake::Microsecond::DirectoryTask.define_task(*args, &block)
+end
+

data/lib/rake/once_task.rb

@@ -0,0 +1,36 @@
+require 'rubygems' if RUBY_VERSION < '1.9'
+require 'rake/tasklib'
+
+module Rake
+
+  # A task whick is no longer needed after its first invocation
+  class OnceTask < Task
+
+    attr_accessor :invoked
+    attr_accessor :timestamp
+
+    def self.define_task( *args, &block )
+      task = super( *args, &block )
+      task.timestamp = nil
+      task.invoked = false
+      task
+    end
+
+    def execute(*args)
+      @timestamp = Time.now
+      @invoked = true
+      super(*args)
+    end
+
+    def needed?
+      ! @invoked
+    end
+
+  end
+
+end
+
+def once_task(*args, &block)
+  Rake::OnceTask.define_task(*args, &block)
+end
+

data/lib/rake/path.rb

@@ -32,8 +32,18 @@ module Rake
       paths.map{ |path| expand_with_root( path, root ) }
     end
 
-    def self.subtract_prefix( prefix, path )
-      path[ prefix.size .. -1 ]
+    def self.relative_path( path, prefix, options = {} )
+      return path if prefix.nil?
+      m = path.match( /^#{ prefix }\/?/ )
+      if ! m.nil?
+        if options[ :initial_dot_slash ]
+          "./#{ m.post_match }"
+        else
+          m.post_match
+        end
+      else
+        path
+      end
     end
 
   end

data/spec/c_project_spec.rb

@@ -1,17 +1,23 @@
-require File.dirname(__FILE__) + '/spec_helper.rb'
+load File.dirname(__FILE__) + '/spec_helper.rb'
 
 describe 'when building a C project' do
 
   include RakeBuilderHelper
 
   before( :all ) do
-    @test_output_file = Rake::Path.expand_with_root( 'rake-c-testfile.txt', SPEC_PATH )
+    @test_output_file = Rake::Path.expand_with_root( 'rake-c-testfile.txt', RakeBuilderHelper::SPEC_PATH )
   end
 
   before( :each ) do
     Rake::Task.clear
     @project = c_task( :executable )
-    @expected_generated = Rake::Path.expand_all_with_root( [ './main.o',  @project.makedepend_file, @project.target ], SPEC_PATH )
+    @expected_generated = Rake::Path.expand_all_with_root(
+      [
+      './main.o',
+      @project.makedepend_file, @project.target
+      ],
+      RakeBuilderHelper::SPEC_PATH
+    )
     `rm -f #{ @test_output_file }`
     `rm -f #{ @project.target }`
   end
@@ -19,14 +25,15 @@ describe 'when building a C project' do
   after( :each ) do
     Rake::Task[ 'clean' ].invoke
     `rm -f #{ @test_output_file }`
+    `rm -f '#{ @project.local_config }'`
   end
 
-  it 'builds the program with \'build\'' do
+  it "builds the program with 'build'" do
     Rake::Task[ 'build' ].invoke
     exist?( @project.target ).should be_true
   end
 
-  it 'runs the program with \'run\'' do
+  it "runs the program with 'run'" do
     Rake::Task[ 'run' ].invoke
     exist?( @test_output_file ).should be_true
   end

data/spec/cpp_project_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper.rb'
+load File.dirname(__FILE__) + '/spec_helper.rb'
 
 describe 'when building an executable' do
 
@@ -6,10 +6,10 @@ describe 'when building an executable' do
 
   before( :all ) do
     @test_output_file = Rake::Path.expand_with_root(
-                          'rake-builder-testfile.txt', SPEC_PATH )
+                          'rake-builder-testfile.txt', RakeBuilderHelper::SPEC_PATH )
     @expected_target  = Rake::Path.expand_with_root(
                           RakeBuilderHelper::TARGET[ :executable ],
-                          SPEC_PATH )
+                          RakeBuilderHelper::SPEC_PATH )
   end
 
   before( :each ) do
@@ -77,8 +77,8 @@ describe 'when using namespaces' do
   end
 
   it 'creates the correct tasks' do
-    expected_tasks = expected_tasks( [ @project.target ], 'my_namespace' )
-    missing_tasks = expected_tasks - task_names
+    expected = expected_tasks( scoped_tasks( [ @project.target ], 'my_namespace' ), 'my_namespace' )
+    missing_tasks = expected - task_names
     missing_tasks.should == []
   end
 
@@ -119,7 +119,9 @@ describe 'when building a shared library' do
 
   before( :each ) do
     Rake::Task.clear
-    @project = cpp_task( :shared_library )
+    @project = cpp_task( :shared_library ) do |builder|
+      builder.compilation_options += ['-fPIC']
+    end
     `rm -f #{ @project.target }`
   end
 

data/spec/dependencies_spec.rb

@@ -1,27 +1,141 @@
-require File.dirname(__FILE__) + '/spec_helper.rb'
+load File.dirname(__FILE__) + '/spec_helper.rb'
+require 'fileutils'
 
 describe 'the dependencies system' do
 
   include RakeBuilderHelper
+  include FileUtils
 
   before( :each ) do
     Rake::Task.clear
     @project = cpp_task( :executable )
     Rake::Task[ 'clean' ].execute
+    rm_f @project.local_config, :verbose => false
   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
+  context 'objects_path' do
+
+    it 'should not be needed after being called' do
+      Rake::Task[ @project.objects_path ].invoke
+
+      Rake::Task[ @project.objects_path ].needed?.should be_false
+    end
+
   end
 
-  it 'says the build is up to date, if nothing changes' do
-    Rake::Task[ 'build' ].invoke
-    Rake::Task[ 'build' ].needed?.should be_false
+  context 'missing_headers' do
+
+    it 'should not be needed after being invoked' do
+      Rake::Task[ 'missing_headers' ].needed?.should be_true
+
+      Rake::Task[ 'missing_headers' ].invoke
+
+      Rake::Task[ 'missing_headers' ].needed?.should be_false
+    end
+
+  end
+
+  context 'makedepend_file' do
+
+    it 'should create the makedepend_file' do
+      exist?( @project.makedepend_file ).should be_false
+
+      Rake::Task[ @project.makedepend_file ].invoke
+
+      exist?( @project.makedepend_file ).should be_true
+    end
+
+    it 'should not be older than its prerequisites' do
+      t = Rake::Task[ @project.makedepend_file ]
+      
+      t.invoke
+
+      stamp = t.timestamp
+      t.prerequisites.any? { |n| t.application[n].timestamp > stamp }.should be_false
+    end
+
+    it 'should have all prerequisites satisfied' do
+      t = Rake::Task[ @project.makedepend_file ]
+      
+      t.invoke
+
+      t.prerequisites.any? { |n| t.application[n].needed? }.should be_false
+    end
+
+    it 'should not say the makedepend_file is needed' do
+      t = Rake::Task[ @project.makedepend_file ]
+
+      t.needed?.should be_true
+
+      t.invoke
+
+      t.needed?.should be_false
+    end
+
+  end
+
+  context 'build' do
+
+    before :each do
+      @task = Rake::Task[ 'build' ]
+    end
+
+    it 'should have all prerequisites satisfied' do
+      @task.invoke
+
+      @task.prerequisites.any? { |n| @task.application[n].needed? }.should be_false
+    end
+
+    it 'should create the makedepend_file' do
+      exist?( @project.makedepend_file ).should be_false
+
+      Rake::Task[ 'build' ].invoke
+
+      exist?( @project.makedepend_file ).should be_true
+    end
+
+    it 'should create the target' do
+      Rake::Task[ 'build' ].invoke
+
+      exist?( @project.target ).should be_true
+    end
+
+    it 'should say the compile task is up to date' do
+      Rake::Task[ 'build' ].invoke
+
+      Rake::Task[ 'compile' ].needed?.should be_false
+    end
+
+    it 'should say the build is up to date' do
+      Rake::Task[ 'build' ].invoke
+
+      Rake::Task[ 'build' ].needed?.should be_false
+    end
+
+    it 'should say the makedepend_file is up to date' do
+      exist?( @project.makedepend_file ).should be_false
+
+      isolating_seconds do
+        Rake::Task[ 'build' ].invoke
+      end
+
+      Rake::Task[ @project.makedepend_file ].needed?.should be_false
+    end
+
+    it 'should say the target is up to date' do
+      Rake::Task[ 'build' ].invoke
+
+      target_mtime = File.stat( @project.target ).mtime
+      @project.target_prerequisites.each do | prerequisite |
+        File.stat( prerequisite ).mtime.should be < target_mtime
+      end
+      Rake::Task[ @project.target ].needed?.should be_false
+    end
+
   end
 
   it 'doesn\'t recompile objects, if nothing changes' do
@@ -30,7 +144,7 @@ describe 'the dependencies system' do
     end
     Rake::Task.clear
     @project = cpp_task( :executable )
-    object_file_path = Rake::Path.expand_with_root( 'main.o', SPEC_PATH )
+    object_file_path = Rake::Path.expand_with_root( 'main.o', RakeBuilderHelper::SPEC_PATH )
     Rake::Task[ object_file_path ].needed?.should be_false
   end
 
@@ -40,16 +154,16 @@ describe 'the dependencies system' do
     end
     Rake::Task.clear
     @project = cpp_task( :executable )
-    source_file_path = Rake::Path.expand_with_root( 'cpp_project/main.cpp', SPEC_PATH )
-    object_file_path = Rake::Path.expand_with_root( 'main.o', SPEC_PATH )
+    source_file_path = Rake::Path.expand_with_root( 'cpp_project/main.cpp', RakeBuilderHelper::SPEC_PATH )
+    object_file_path = Rake::Path.expand_with_root( 'main.o', RakeBuilderHelper::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::Path.expand_with_root( 'cpp_project/main.h', SPEC_PATH )
-    object_file_path = Rake::Path.expand_with_root( 'main.o', SPEC_PATH )
+  it 'recompiles source files, if header dependencies are more recent' do
+    header_file_path = Rake::Path.expand_with_root( 'cpp_project/main.h', RakeBuilderHelper::SPEC_PATH )
+    object_file_path = Rake::Path.expand_with_root( 'main.o', RakeBuilderHelper::SPEC_PATH )
     isolating_seconds do
       Rake::Task[ 'compile' ].invoke
     end
@@ -57,8 +171,10 @@ describe 'the dependencies system' do
     @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
+      Rake::Task[ object_file_path ].needed?.
+                                  should be_true
     end
   end
 
@@ -82,11 +198,13 @@ describe 'Rakefile dependencies' 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
+
+    Rake::Task.clear
+    @project = cpp_task( :executable )
     touching_temporarily( @project.target, File.mtime( @project.rakefile ) - 1 ) do
       Rake::Task[ @project.target ].needed?.should be_true
     end
@@ -94,7 +212,11 @@ describe 'Rakefile dependencies' do
 
   it 'should indicate that a build is needed if the Rakefile changes' do
     Rake::Task[ 'build' ].invoke
+
     Rake::Task[ 'build' ].needed?.should be_false
+
+    Rake::Task.clear
+    @project = cpp_task( :executable )
     touching_temporarily( @project.target, File.mtime( @project.rakefile ) - 1 ) do
       Rake::Task[ 'build' ].needed?.should be_true
     end