rake-builder 0.0.9 → 0.0.10

data/README.rdoc

@@ -2,10 +2,6 @@
 
 rake-builder builds C, C++, Objective-C and Objective-C++
 projects.
-Project files are dicovered accoring to indicated paths
-and or flie globs.
-
-Projects are managed and built via a 'Rakefile'.
 
 Here is a typical example:
 
@@ -40,18 +36,49 @@ See the 'examples' directory.
 If you've installed the gem system-wide, type the following to go to
 the correct directory:
 
- $ cd `gem environment gemdir`/gems/rake-builder/examples
+ $ cd `gem environment gemdir`/gems/rake-builder-nnn
+ $ cd examples
+
+== Project Configuration
+
+In order to build on a specific computer, you will need
+to indicate information like non-standard
+include paths.
+
+Rake::Builder collects all such information in one file:
+'.rake-builder'
+
+This file should be created in the same
+directory as the Rakefile.
+
+The file should be a YAML structure, and must include a version.
+
+Currently, the following can be configured:
+* extra include paths: :include_paths
+
+=== Example '.rake-builder'
 
-= Tasks
+ ---
+ :rake_builder:
+   :config_file:
+     :version: "1.0"
+ :include_paths:
+ - /opt/local/include
+ - /usr/include/c++/4.2.1
 
-You can list tasks as follows:
+= Default Tasks
 
- $ rake -T
- rake build    # Compile and build 'hello-world'
- rake clean    # Remove temporary files
- rake compile  # Compile all sources
- rake default  # Equivalent to 'rake build'
- rake run      # Run 'hello-world'
+* compile
+* build
+* run - executables only
+* install
+* clean
+
+= Installing Headers
+
+If you install a static library, your headers will also be installed.
+Ensure that you use file globs, e.g. './include/**/*.h',
+as these will ensure that your headers are installed in the correct subdirectories.
 
 = Online
 
@@ -59,6 +86,12 @@ You can list tasks as follows:
 * Documentation[http://rdoc.info/projects/joeyates/rake-builder]
 * Gem[http://rubygems.org/gems/rake-builder]
 
+= Dependencies
+
+Task dependencies must ensure that out of date files are recreated as needed.
+
+http://github.com/downloads/joeyates/rake-builder/RakeBuilderDependencyStructure.png
+
 = Limitations
 
 == File Modification Times
@@ -68,7 +101,7 @@ modification times (see the private method <em>out_of_date?</em>, which returns
 dependency was modified *after* the dependent).
 Unfortunately, most modern file systems hold modification times in whole
 seconds. If a dependency and a dependent were modificed during the same second,
-<b>even if the dependency were modified later</b>, <em>out_of_date?</em> gives *false*
+<b>even if the dependency were modified later</b>, <em>out_of_date?</em> returns *false*
 which is not the correct answer.
 
 This problem is mostly felt in testing, where file modification times are temporarily
@@ -88,17 +121,11 @@ So, if there are two source files with the same name, they will overwrite each o
 
 = Status
 
-* Builds C and C++ projects using gcc
+* Builds C, C++ and Objective-C projects using GCC[http://gcc.gnu.org/].
 
 = Alternatives
 
 * make
 * CMake
 * Boost.Build
-* rakepp - another take on using rake for c++ projects
-
-= TODO
-
-* Objective-C++ projects
-* pre-compiled headers
-* parallel builds
+* rakepp - another customisation of Rake for C++ projects

data/lib/rake/builder.rb

@@ -2,7 +2,6 @@ require 'rubygems' if RUBY_VERSION < '1.9'
 require 'logger'
 require 'rake'
 require 'rake/tasklib'
-require 'rake/loaders/makefile'
 
 module Rake
 
@@ -33,7 +32,7 @@ module Rake
     module VERSION #:nodoc:
       MAJOR = 0
       MINOR = 0
-      TINY  = 9
+      TINY  = 10
  
       STRING = [ MAJOR, MINOR, TINY ].join('.')
     end
@@ -107,10 +106,23 @@ module Rake
     # It is the file which calls to Rake::Builder.new
     attr_reader   :rakefile
 
-    # Directories containing project source files
+    # Directories/file globs to search for project source files
     attr_accessor :source_search_paths
 
-    # Directories containing project header files
+    # Directories/file globs to search for header files
+    # When static libraries are installed,
+    # headers are install too.
+    # During installation, the destination path is:
+    #   /usr/local/include + the relative path
+    # This 'relative path' is calculated as follows:
+    # 1. Named files are installed directly under /usr/local/include
+    # 2. Files found by directory are also installed directly under /usr/local/include
+    # 3. Files found by glob have the fixed part of the glob removed and
+    #  the relative path calculated:
+    # E.g. files found with './include/**/*' will have './include' removed to calculate the
+    #  relative path.
+    # So, ./include/my_lib/foo.h' produces a relative path of 'my_lib'
+    # so the file will be installed as '/usr/local/include/my_lib/foo.h'
     attr_accessor :header_search_paths
 
     # (Optional) namespace for tasks
@@ -161,6 +173,8 @@ module Rake
       define_default
     end
 
+    private
+
     # Source files found in source_search_paths
     def source_files
       @source_fies ||= find_files( @source_search_paths, @source_file_extension )
@@ -171,15 +185,12 @@ module Rake
       @header_files ||= find_files( @header_search_paths, @header_file_extension )
     end
 
-    private
-
     def initialize_attributes
       @logger                = Logger.new( STDOUT )
       @logger.level          = Logger::UNKNOWN
       @programming_language  = 'c++'
       @header_file_extension = 'h'
       @objects_path          = @rakefile_path.dup
-      @generated_files       = []
       @library_paths         = []
       @library_dependencies  = []
       @target_prerequisites  = []
@@ -211,7 +222,6 @@ module Rake
       @compilation_options   ||= ''
       @linker_options        ||= ''
       @include_paths         ||= @header_search_paths.dup
-      @include_paths         = Rake::Builder.expand_paths_with_root( @include_paths, @rakefile_path )
       @generated_files       = Rake::Builder.expand_paths_with_root( @generated_files, @rakefile_path )
 
       @default_task          ||= :build
@@ -219,9 +229,32 @@ module Rake
 
       @makedepend_file       = @objects_path + '/.' + target_basename + '.depend.mf'
 
+      load_local_config
+
+      @include_paths         = Rake::Builder.expand_paths_with_root( @include_paths, @rakefile_path )
+
       raise "No source files found" if source_files.length == 0
     end
 
+    def local_config
+      filename = '.rake-builder'
+      filename += '.' + @task_namespace.to_s if @task_namespace
+      Rake::Builder.expand_path_with_root( filename, @rakefile_path )
+    end
+
+    def load_local_config
+      return if ! File.exist?( local_config )
+
+      config = YAML.load_file( local_config )
+
+      version = config[ :rake_builder ][ :config_file ][ :version ]
+      raise "Config file version missing" if version.nil?
+
+      @include_paths += config[ :include_paths ] if config[ :include_paths ]
+    rescue => e
+      raise "#{__FILE__}:#{__LINE__}: Failed to load local config file '#{ local_config }': #{ e.message }"
+    end
+
     def define_tasks
       if @task_namespace
         namespace @task_namespace do
@@ -255,7 +288,7 @@ module Rake
       FileTaskAlias.define_task( :build, @target )
 
       desc "Build '#{ target_basename }'"
-      file @target => [ scoped_task( :compile ), @target_prerequisites ] do |t|
+      file @target => [ scoped_task( :compile ), *@target_prerequisites ] do |t|
         shell "rm -f #{ t.name }"
         case @target_type
         when :executable
@@ -290,7 +323,11 @@ module Rake
         shell command
       end
 
-      task :load_makedepend => @makedepend_file do |t|
+      # Reimplemented mkdepend file loading to make objects depend on
+      # sources with the correct paths:
+      # the standard rake mkdepend loader doesn't do what we want,
+      # as it assumes files will be compiled in their own directory.
+      task :load_makedepend => @makedepend_file do
         object_to_source = source_files.inject( {} ) do |memo, source|
           mapped_object = source.gsub( '.' + @source_file_extension, '.o' )
           memo[ mapped_object ] = source
@@ -300,8 +337,8 @@ module Rake
           next if line !~ /:\s/
           mapped_object_file = $`
           header_file = $'.gsub( "\n", '' )
-          # Why does it work
-          # if I make the object (not the source) depend on the header
+          # TODO: Why does it work,
+          # if I make the object (not the source) depend on the header?
           source_file = object_to_source[ mapped_object_file ]
           object_file = object_path( source_file )
           object_file_task = Rake.application[ object_file ]
@@ -309,7 +346,7 @@ module Rake
         end
       end
 
-      desc 'List generated files (which are remove with \'rake clean\')'
+      desc "List generated files (which are removed with 'rake #{ scoped_task( :clean ) }')"
       task :generated_files do
         puts @generated_files.inspect
       end
@@ -329,11 +366,8 @@ module Rake
       desc "Install '#{ target_basename }' in '#{ @install_path }'"
       task :install, [] => [ scoped_task( :build ) ] do
         destination = File.join( @install_path, target_basename )
-        begin
-          shell "cp '#{ @target }' '#{ destination }'", Logger::INFO
-        rescue Errno::EACCES => e
-          raise "You do not have premission to install '#{ target_basename }' in '#{ @install_path }'\nTry\n $ sudo rake install"
-        end
+        install( @target, destination )
+        install_headers if @target_type == :static_library
       end
 
       desc "Uninstall '#{ target_basename }' from '#{ @install_path }'"
@@ -413,9 +447,16 @@ module Rake
     # Lists of files
 
     def find_files( paths, extension )
-      files = paths.reduce( [] ) do |memo, path|
-        glob = ( path =~ /[\*\?]/ ) ? path : path + '/*.' + extension
-        memo + FileList[ glob ]
+      files = paths.reduce( [] ) do | memo, path |
+        case
+        when File.file?( path )
+          files = FileList[ path ]
+        when ( path =~ /[\*\?]/ )
+          files = FileList[ path ]
+        else
+          files = FileList[ path + '/*.' + extension ]
+        end
+        memo + files
       end
       Rake::Builder.expand_paths_with_root( files, @rakefile_path )
     end
@@ -434,11 +475,67 @@ module Rake
     end
     
     def library_paths_list
-      @library_paths.map { |l| "-L#{ l }" }.join( " " )
+      @library_paths.map { | path | "-L#{ path }" }.join( " " )
     end
     
     def library_dependencies_list
-      @library_dependencies.map { |l| "-l#{ l }" }.join( " " )
+      @library_dependencies.map { | lib | "-l#{ lib }" }.join( " " )
+    end
+
+    def install_headers
+      # TODO: make install_headers_path a configuration option
+      install_headers_path = '/usr/local/include'
+
+      installable_headers.each do | installable_header |
+        destination_path = File.join( install_headers_path, installable_header[ :relative_path ] )
+        begin
+          `mkdir -p '#{ destination_path }'`
+        rescue Errno::EACCES => e
+          raise "Permission denied to created directory '#{ destination_path }'"
+        end
+        install( installable_header[ :source_file ], destination_path )
+      end
+    end
+
+    def subtract_path_prefix( prefix, path )
+      path[ prefix.size .. -1 ]
+    end
+
+    def installable_headers
+      @header_search_paths.reduce( [] ) do | memo, search |
+        non_glob_search = ( search.match( /^([^\*\?]*)/ ) )[ 1 ]
+        case
+        when ( non_glob_search !~ /#{ @rakefile_path }/ )
+          # Skip paths that are not inside the project
+        when File.file?( search )
+          full_path = Rake::Builder.expand_path_with_root( search, @rakefile_path )
+          memo << { :source_file => search, :relative_path => '' }
+        when File.directory?( search )
+          FileList[ search + '/*.' + @header_file_extension ].each do | pathname |
+            full_path = Rake::Builder.expand_path_with_root( pathname, @rakefile_path )
+            memo << { :source_file => pathname, :relative_path => '' }
+          end
+        when ( search =~ /[\*\?]/ )
+          FileList[ search ].each do | pathname |
+            full_path = Rake::Builder.expand_path_with_root( pathname, @rakefile_path )
+            directory = File.dirname( full_path )
+            relative = subtract_path_prefix( non_glob_search, directory )
+            memo << { :source_file => pathname, :relative_path => relative }
+          end
+        else
+          $stderr.puts "Bad search path: '${ search }'"
+        end
+        memo
+      end
+    end
+
+    def install( source_pathname, destination_path )
+      begin
+        shell "cp '#{ source_pathname }' '#{ destination_path }'", Logger::INFO
+      rescue Errno::EACCES => e
+        source_filename = File.basename( source_pathname ) rescue '????'
+        raise "You do not have permission to install '#{ source_filename }' to '#{ destination_path }'\nTry\n $ sudo rake install"
+      end
     end
 
     def shell( command, log_level = Logger::ERROR )

data/spec/cpp_project_spec.rb

@@ -5,11 +5,11 @@ describe 'when building an executable' do
   include RakeBuilderHelper
 
   before( :all ) do
-    @test_output_file = Rake::Builder.expand_path_with_root( 'rake-builder-testfile.txt', SPEC_PATH )
+    @test_output_file = Rake::Builder.expand_path_with_root(
+                          'rake-builder-testfile.txt', SPEC_PATH )
     @expected_target = Rake::Builder.expand_path_with_root(
-                        RakeBuilderHelper::TARGET[ :executable ],
-                        SPEC_PATH
-                      )
+                         RakeBuilderHelper::TARGET[ :executable ],
+                         SPEC_PATH )
   end
 
   before( :each ) do
@@ -43,12 +43,14 @@ describe 'when building an executable' do
   end
 
   it 'finds source files' do
-    expected_sources = Rake::Builder.expand_paths_with_root( [ 'cpp_project/main.cpp' ], SPEC_PATH )
+    expected_sources = Rake::Builder.expand_paths_with_root(
+                         [ 'cpp_project/main.cpp' ], SPEC_PATH )
     @project.source_files.should == expected_sources
   end
 
   it 'finds header files' do
-    expected_headers = Rake::Builder.expand_paths_with_root( [ 'cpp_project/main.h' ], SPEC_PATH )
+    expected_headers = Rake::Builder.expand_paths_with_root(
+                         [ 'cpp_project/main.h' ], SPEC_PATH )
     @project.header_files.should == expected_headers
   end
 

data/spec/generated_files_spec.rb

@@ -12,10 +12,8 @@ describe 'when handling generated files' do
                              'main.o',
                              'rake-builder-testfile.txt',
                              @project.makedepend_file,
-                             @project.target
-                            ],
-                            SPEC_PATH
-                          )
+                             @project.target ],
+                            SPEC_PATH )
   end
 
   after( :each ) do
@@ -28,7 +26,7 @@ describe 'when handling generated files' do
 
   it 'lists generated files, via the task' do
     output = capturing_output do
-      Rake::Task[ 'generated_files' ].execute
+      Rake::Task[ 'generated_files' ].invoke
     end
     eval( output ).should =~ @expected_generated
   end

data/spec/local_config_spec.rb

@@ -0,0 +1,70 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+LOCAL_CONFIG_SPEC_PATH = File.expand_path( File.dirname(__FILE__) )
+
+describe 'local config files' do
+
+  include RakeBuilderHelper
+
+  before( :each ) do
+    @local_config_file = Rake::Builder.expand_path_with_root( '.rake-builder', LOCAL_CONFIG_SPEC_PATH )
+    @expected_path     = "/some/special/path"
+    @config            = {:rake_builder=>{:config_file=>{:version=>"1.0"}}, :include_paths=>[ @expected_path ]}
+    `rm -f '#{ @local_config_file }'`
+  end
+
+  it 'works if the\'s no config file' do
+    lambda do
+      @builder = cpp_task( :executable )
+    end.should_not raise_error
+  end
+
+  it 'loads the local config file' do
+    save_config
+    @builder = cpp_task( :executable )
+    @builder.include_paths.should include( @expected_path )
+  end
+
+  it 'fails if there\'s no version' do
+    @config[ :rake_builder ][ :config_file ].delete( :version )
+    save_config
+    lambda do
+      @project = cpp_task( :executable )
+    end.should raise_error
+  end
+
+  it 'for the default namespace, loads only the \'.rake-builder\' config file' do
+    namespaced_config_path = @local_config_file + '.foo'
+    namespaced_config      = @config.dup
+    unexpected_path        = '/this/shouldnt/show/up'
+    namespaced_config[ :include_paths ] = [ unexpected_path ]
+    save_config
+    save_config( namespaced_config, namespaced_config_path )
+    @builder = cpp_task( :executable )
+    @builder.include_paths.should     include( @expected_path )
+    @builder.include_paths.should_not include( unexpected_path )
+    `rm -f '#{ namespaced_config_path }'`
+  end
+
+  it 'for a particular namespace, loads only that namespace\'s config file' do
+    namespaced_config_path = @local_config_file + '.foo'
+    namespaced_config      = @config.dup
+    unexpected_path        = '/this/shouldnt/show/up'
+    namespaced_config[ :include_paths ] = [ unexpected_path ]
+    save_config
+    save_config( namespaced_config, namespaced_config_path )
+    @builder = cpp_task( :executable, 'foo' )
+    @builder.include_paths.should_not include( @expected_path )
+    @builder.include_paths.should     include( unexpected_path )
+    `rm -f '#{ namespaced_config_path }'`
+  end
+
+  private
+
+  def save_config( config = @config, filename = @local_config_file )
+    File.open( filename, 'w' ) do | file |
+      file.write config.to_yaml
+    end
+  end
+
+end

data/spec/objective_c_project/main.h

@@ -0,0 +1 @@
+#import <Foundation/Foundation.h> 

data/spec/objective_c_project/main.m

@@ -0,0 +1,18 @@
+#import "main.h"
+
+int main(void)
+{
+  NSAutoreleasePool *pool    = [ [ NSAutoreleasePool alloc ] init ];
+  NSString *text             = @"Written by Objective-C";
+  NSString *filename         = @"./rake-builder-testfile.txt";
+  NSData *data               = [ text dataUsingEncoding: NSASCIIStringEncoding ];
+  NSFileManager *filemanager = [NSFileManager defaultManager];
+  BOOL written               = [ filemanager createFileAtPath: filename contents: data attributes: nil ];
+  if( ! written ) {
+    NSLog( @"Failed to write to file" );
+  }
+
+  [ pool release ];
+
+  return 0;
+}

data/spec/objective_c_project_spec.rb

@@ -0,0 +1,78 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe 'when building an Objective-C executable' do
+
+  include RakeBuilderHelper
+
+  before( :all ) do
+    @test_output_file = Rake::Builder.expand_path_with_root(
+                          'rake-builder-testfile.txt', SPEC_PATH )
+    @expected_target = Rake::Builder.expand_path_with_root(
+                         RakeBuilderHelper::TARGET[ :executable ],
+                         SPEC_PATH )
+  end
+
+  before( :each ) do
+    Rake::Task.clear
+    @project = objective_c_task( :executable )
+    `rm -f #{ @test_output_file }`
+    `rm -f #{ @project.target }`
+  end
+
+  after( :each ) do
+    Rake::Task[ 'clean' ].invoke
+    `rm -f #{ @test_output_file }`
+  end
+
+  it 'knows the target' do
+    @project.target.should == @expected_target
+  end
+
+  it 'builds the target in the objects directory' do
+    File.dirname( @project.target ).should == @project.objects_path
+  end
+
+  it 'knows the project type' do
+    @project.target_type.should == :executable
+  end
+
+  it 'creates the correct tasks' do
+    expected_tasks = expected_tasks( [ @project.target ] )
+    missing_tasks = expected_tasks - task_names
+    missing_tasks.should == []
+  end
+
+  it 'finds source files' do
+    expected_sources = Rake::Builder.expand_paths_with_root(
+                         [ 'objective_c_project/main.m' ], SPEC_PATH )
+    @project.source_files.should == expected_sources
+  end
+
+  it 'finds header files' do
+    expected_headers = Rake::Builder.expand_paths_with_root(
+                         [ 'objective_c_project/main.h' ], SPEC_PATH )
+    @project.header_files.should == expected_headers
+  end
+
+  it 'builds the program with \'build\'' do
+    Rake::Task[ 'build' ].invoke
+    exist?( @project.target ).should be_true
+  end
+
+  it 'has a \'run\' task' do
+    Rake::Task[ 'run' ].should_not be_nil
+  end
+
+  it 'builds the program with \'run\'' do
+    Rake::Task[ 'run' ].invoke
+    exist?( @project.target ).should be_true
+  end
+
+  it 'runs the program with \'run\'' do
+    lambda do
+      Rake::Task[ 'run' ].invoke
+    end.should_not raise_exception
+    exist?( @test_output_file ).should be_true
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 require 'spec'
-require File.dirname(__FILE__) + '/../lib/rake/builder'
+require File.expand_path( File.dirname(__FILE__) + '/../lib/rake/builder' )
 
 SPEC_PATH = File.expand_path( File.dirname(__FILE__) )
 
@@ -35,6 +35,20 @@ module RakeBuilderHelper
     end
   end
 
+  def objective_c_task( type, namespace = nil )
+    Rake::Builder.new do |builder|
+      builder.programming_language = 'objective-c'
+      builder.target               = TARGET[ type ]
+      builder.task_namespace       = namespace
+      builder.source_search_paths  = [ 'objective_c_project' ]
+      builder.header_search_paths  = [ 'objective_c_project' ]
+      builder.generated_files      << 'rake-builder-testfile.txt'
+      builder.library_dependencies = [ 'objc' ]
+      builder.linker_options       = '-framework CoreFoundation -framework Foundation'
+      yield builder if block_given?
+    end
+  end
+
   def touch( file )
     `touch #{file}`
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rake-builder
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: false
   segments: 
   - 0
   - 0
-  - 9
-  version: 0.0.9
+  - 10
+  version: 0.0.10
 platform: ruby
 authors: 
 - Joe Yates
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-20 00:00:00 +01:00
+date: 2010-08-25 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -85,7 +85,11 @@ files:
 - spec/dependencies_spec.rb
 - spec/generated_files_spec.rb
 - spec/libraries_spec.rb
+- spec/local_config_spec.rb
 - spec/logger_spec.rb
+- spec/objective_c_project/main.h
+- spec/objective_c_project/main.m
+- spec/objective_c_project_spec.rb
 - spec/paths_spec.rb
 - spec/spec_helper.rb
 - spec/target_spec.rb
@@ -136,7 +140,11 @@ test_files:
 - spec/dependencies_spec.rb
 - spec/generated_files_spec.rb
 - spec/libraries_spec.rb
+- spec/local_config_spec.rb
 - spec/logger_spec.rb
+- spec/objective_c_project/main.h
+- spec/objective_c_project/main.m
+- spec/objective_c_project_spec.rb
 - spec/paths_spec.rb
 - spec/spec_helper.rb
 - spec/target_spec.rb