rake-builder 0.0.19 → 0.7.0

data/lib/rake/builder/{task_definer.rb → task_definers/builder_task_definer.rb}

@@ -4,7 +4,7 @@ require 'rake/local_config'
 include Rake::DSL
 
 class Rake::Builder
-  class TaskDefiner
+  class BuilderTaskDefiner
     def initialize(builder)
       @builder = builder
     end
@@ -35,13 +35,14 @@ class Rake::Builder
       end
 
       desc "Compile and build '#{@builder.target_basename}'"
-      Rake::FileTaskAlias.define_task(:build, @builder.target)
+      task :build => [:compile, @builder.target]
 
       desc "Build '#{@builder.target_basename}'"
       microsecond_file @builder.target => [
         scoped_task(:environment),
         scoped_task(:compile),
-        *@builder.target_prerequisites
+        *@builder.target_prerequisites,
+        *@builder.object_files,
       ] do
         @builder.build
       end
@@ -53,48 +54,51 @@ class Rake::Builder
         scoped_task(:environment),
         @builder.makedepend_file,
         scoped_task(:load_makedepend),
-        *@builder.object_files
+        *@builder.object_files,
       ]
 
-      @builder.source_files.each do |src|
-        define_compile_task(src)
+      @builder.source_files.each do |source|
+        file source
+        object = @builder.object_path(source)
+        @builder.generated_files << object
+        define_compile_task(source, object)
       end
 
       # TODO: Does this need to be microsecond?
       microsecond_directory @builder.objects_path
 
-      file scoped_task(@builder.local_config) do
+      file @builder.local_config do
         @builder.create_local_config
       end
 
-      microsecond_file @builder.makedepend_file => [
-          scoped_task(:load_local_config),
-          scoped_task(:missing_headers),
-          @builder.objects_path,
-          *@builder.project_files
-      ] do
-        @builder.create_makedepend_file
+      once_task :load_local_config => scoped_task(@builder.local_config) do
+        @builder.load_local_config
       end
 
-      once_task scoped_task(:load_local_config) => scoped_task(@builder.local_config) do
-        @builder.load_local_config
+      once_task :missing_headers => [*@builder.generated_headers] do
+        @builder.ensure_headers
       end
 
-      once_task scoped_task(:missing_headers) => [*@builder.generated_headers] do
-        @builder.missing_headers
+      microsecond_file @builder.makedepend_file => [
+        scoped_task(:load_local_config),
+        scoped_task(:missing_headers),
+        @builder.objects_path,
+        *@builder.source_files,
+      ] do
+        @builder.create_makedepend_file
       end
 
       # 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 => @builder.makedepend_file do
-        @builder.load_makedepend
-      end
-
-      desc "List generated files (which are removed with 'rake #{scoped_task(:clean)}')"
-      task :generated_files do
-        puts @builder.generated_files.to_json
+      once_task :load_makedepend => @builder.makedepend_file do
+        object_header_dependencies = @builder.load_makedepend
+        object_header_dependencies.each do |object_file, headers|
+          headers.each { |h| file h }
+          object_file_task = Rake.application[object_file]
+          object_file_task.enhance headers
+        end
       end
 
       # Re-implement :clean locally for project and within namespace
@@ -130,10 +134,8 @@ class Rake::Builder
       end
     end
 
-    def define_compile_task(source)
-      object = @builder.object_path(source)
-      @builder.generated_files << object
-      file object => [ source ] do |t|
+    def define_compile_task(source, object)
+      file object => [source] do
         @builder.compile(source, object)
       end
     end

data/lib/rake/builder/version.rb

@@ -1,17 +1,12 @@
-require 'rake/tasklib'
-
 module Rake
-  class Builder < TaskLib
-
+  class Builder
     module VERSION #:nodoc:
       MAJOR = 0
-      MINOR = 0
-      TINY  = 19
+      MINOR = 7
+      TINY  = 0
 
-      STRING = [ MAJOR, MINOR, TINY ].join('.')
+      STRING = [MAJOR, MINOR, TINY].join('.')
     end
-
   end
-
 end
 

data/lib/rake/builder.rb

@@ -1,7 +1,5 @@
-require 'json'
 require 'logger'
 require 'rake'
-require 'rake/tasklib'
 
 require 'rake/builder/autoconf/version'
 require 'rake/builder/configure_ac'
@@ -10,14 +8,13 @@ require 'rake/builder/logger/formatter'
 require 'rake/builder/presenters/makefile/builder_presenter'
 require 'rake/builder/presenters/makefile_am/builder_presenter'
 require 'rake/builder/presenters/makefile_am/builder_collection_presenter'
-require 'rake/builder/task_definer'
+require 'rake/builder/task_definers/builder_task_definer'
+require 'rake/builder/task_definers/builder_collection_task_definer'
 require 'rake/path'
 require 'rake/microsecond'
 require 'rake/once_task'
 require 'compiler'
 
-include Rake::DSL
-
 module Rake
   class Builder
     # Error indicating that the project failed to build.
@@ -98,21 +95,31 @@ module Rake
     # Directories/file globs to search for project source files
     attr_accessor :source_search_paths
 
-    # Directories/file globs to search for header files
+    # Directories/file globs to search for header files to be installed with libraries.
     # When static libraries are installed,
     # headers are installed too.
     # During installation, the destination path is:
     #   /usr/local/include + the relative path
     # This 'relative path' is calculated as follows:
-    # 1. Any files named in header_search_paths are installed directly under /usr/local/include
-    # 2. The contents of any directory named in header_search_paths are also installed directly under /usr/local/include
+    # 1. Any files named in installable_headers are installed directly under /usr/local/include
+    # 2. The contents of any directory named in installable_headers 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
+    attr_accessor :installable_headers
+
+    def header_search_paths
+      warn 'Deprecation notice: Rake::Builder#header_search_paths has be replaced by Rake::Builder#installable_headers'
+      installable_headers
+    end
+
+    def header_search_paths=(paths)
+      warn 'Deprecation notice: Rake::Builder#header_search_paths has be replaced by Rake::Builder#installable_headers'
+      installable_headers = paths
+    end
 
     # (Optional) namespace for tasks
     attr_accessor :task_namespace
@@ -156,7 +163,7 @@ module Rake
     # Each instance has its own logger
     attr_accessor :logger
 
-    # All Rake::Builder instaces that get defined
+    # All Rake::Builder instances that get defined
     # This allows us to create scripts for configure
     @instances = []
 
@@ -166,7 +173,7 @@ module Rake
 
     def self.create_autoconf(project_title, version, source_file)
       raise "Please supply a project_title parameter" if project_title.nil?
-      version = Rake::Builder::Version.new(version).decide
+      version = Rake::Builder::Autoconf::Version.new(version).decide
       if File.exist?('configure.ac')
         raise "The file 'configure.ac' already exists"
       end
@@ -176,19 +183,15 @@ module Rake
       ConfigureAc.new(project_title, version, source_file).save
       Presenters::MakefileAm::BuilderCollectionPresenter.new(instances).save
     end
- 
-    desc "Create input files for configure script creation"
-    task :autoconf, [:project_title, :version] => [] do |task, args|
-      source = Rake::Path.relative_path(instances[0].source_files[0], instances[0].rakefile_path)
-      create_autoconf(args.project_title, args.version, source)
-    end
 
-    def initialize( &block )
-      save_rakefile_info( block )
+    Rake::Builder::BuilderCollectionTaskDefiner.new.run
+
+    def initialize(&block)
+      save_rakefile_info(block)
       set_defaults
-      block.call( self )
+      block.call(self)
       configure
-      TaskDefiner.new(self).run
+      BuilderTaskDefiner.new(self).run
       self.class.instances << self
     end
 
@@ -198,6 +201,7 @@ module Rake
     end
 
     def build
+      logger.debug "Building '#{target}'"
       system "rm -f #{target}"
       build_commands.each do |command|
         stdout, stderr = shell(command)
@@ -207,7 +211,7 @@ module Rake
     end
 
     def create_local_config
-      logger.add(Logger::DEBUG, "Creating file '#{local_config }'")
+      logger.debug "Creating file '#{local_config }'"
       added_includes = compiler_data.include_paths(missing_headers)
       config = Rake::LocalConfig.new(local_config)
       config.include_paths = added_includes
@@ -215,9 +219,9 @@ module Rake
     end
 
     def create_makedepend_file
+      logger.debug 'Creating makedepend file'
       system('which makedepend >/dev/null')
       raise 'makedepend not found' unless $?.success?
-      logger.add(Logger::DEBUG, "Analysing dependencies")
       command = "makedepend -f- -- #{include_path} -- #{file_list(source_files)} 2>/dev/null > #{makedepend_file}"
       shell command
     end
@@ -235,17 +239,17 @@ module Rake
         memo[mapped_object] = source
         memo
       end
+
+      object_header_dependencies = Hash.new { |h, v| h[v] = [] }
       File.open(makedepend_file).each_line do |line|
         next if line !~ /:\s/
         mapped_object_file = $`
         header_files = $'.chomp
-        # 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]
-        object_file_task.enhance(header_files.split(' '))
+        object_header_dependencies[object_file] += header_files.split(' ')
       end
+      object_header_dependencies
     end
 
     def clean
@@ -280,23 +284,12 @@ module Rake
       raise BuildFailure.new("Error: command '#{command}' failed: #{stderr} #{stdout}") if not $?.success?
     end
 
-    # TODO: make private
-    def file_list( files, delimiter = ' ' )
-      files.join( delimiter )
-    end
-
     # Source files found in source_search_paths
     def source_files
       return @source_files if @source_files
       @source_files = find_files( @source_search_paths, @source_file_extension ).uniq.sort
     end
 
-    # Header files found in header_search_paths
-    def header_files
-      return @header_files if @header_files
-      @header_files = find_files( @header_search_paths, @header_file_extension ).uniq
-    end
-
     def is_library?
       [:static_library, :shared_library].include?(target_type)
     end
@@ -331,7 +324,7 @@ module Rake
     end
 
     def library_dependencies_list
-      @library_dependencies.map { |lib| "-l#{ lib }"}.join('')
+      @library_dependencies.map { |lib| "-l#{lib}" }.join(' ')
     end
 
     def target_basename
@@ -347,16 +340,29 @@ module Rake
       "Makefile#{ extension }"
     end
 
-    def project_files
-      source_files + header_files
-    end
-
     def generated_headers
       []
     end
 
-    # Discovery
+    # Raises an error if there are missing headers
+    def ensure_headers
+      missing = missing_headers
+      return if missing.size == 0
 
+      message = "Compilation cannot proceed as the following header files are missing:\n" + missing.join("\n") 
+      raise Error.new(message)
+    end
+
+    def link_flags
+      flags = [ @linker_options, library_paths_list, library_dependencies_list ]
+      flags << architecture_option if RUBY_PLATFORM =~ /darwin/i
+      flags.join( " " )
+    end
+
+    private
+
+    # Lists headers referenced by the project's files or includes
+    # that can not be found on in any of the include paths
     def missing_headers
       return @missing_headers if @missing_headers
       default_includes = @compiler_data.default_include_paths( @programming_language )
@@ -364,8 +370,6 @@ module Rake
       @missing_headers = @compiler_data.missing_headers( all_includes, source_files )
     end
 
-    private
-
     def set_defaults
       @architecture          = 'i386'
       @compiler_data         = Compiler::Base.for(:gcc)
@@ -379,11 +383,11 @@ module Rake
       @library_dependencies  = []
       @target_prerequisites  = []
       @source_search_paths   = [@rakefile_path.dup]
-      @header_search_paths   = [@rakefile_path.dup]
       @target                = 'a.out'
       @generated_files       = []
       @compilation_options   = []
-      @include_paths         = []
+      @include_paths         = [File.join(@rakefile_path.dup, 'include')]
+      @installable_headers   = [@rakefile_path.dup]
     end
 
     def configure
@@ -399,7 +403,6 @@ module Rake
       @source_file_extension ||= KNOWN_LANGUAGES[ @programming_language ][ :source_file_extension ]
 
       @source_search_paths   = Rake::Path.expand_all_with_root( @source_search_paths, @rakefile_path )
-      @header_search_paths   = Rake::Path.expand_all_with_root( @header_search_paths, @rakefile_path )
       @library_paths         = Rake::Path.expand_all_with_root( @library_paths, @rakefile_path )
 
       raise Error.new( "The target name cannot be nil", task_namespace )             if @target.nil?
@@ -412,6 +415,7 @@ module Rake
       @generated_files << @target
 
       @install_path          ||= default_install_path( @target_type )
+      @installable_headers   = Rake::Path.expand_all_with_root( @installable_headers, @rakefile_path )
 
       @linker_options        ||= ''
       @include_paths         += []
@@ -429,10 +433,10 @@ module Rake
     end
 
     def to_target_type(target)
-      case target
-      when /\.a/
+      case
+      when target.end_with?('.a')
         :static_library
-      when /\.so/
+      when target.end_with?('.so')
         :shared_library
       else
         :executable
@@ -450,12 +454,6 @@ module Rake
       "-arch #{ @architecture }"
     end
 
-    def link_flags
-      flags = [ @linker_options, library_paths_list, library_dependencies_list ]
-      flags << architecture_option if RUBY_PLATFORM =~ /darwin/i
-      flags.join( " " )
-    end
-
     # Paths
 
     def save_rakefile_info( block )
@@ -478,17 +476,14 @@ module Rake
       end
     end
 
-    def group_files_by_path( files )
-      files.group_by do | f |
-        m = f.match( /(.*?)?\/?([^\/]+)$/ )
-        m[ 1 ]
-      end
-    end
-
     # Files
 
     # Lists of files
 
+    def file_list(files)
+      files.join(' ')
+    end
+
     def find_files( paths, extension )
       files = Rake::Path.find_files( paths, extension )
       Rake::Path.expand_all_with_root( files, @rakefile_path )
@@ -514,7 +509,7 @@ module Rake
     end
 
     def project_headers
-      @header_search_paths.reduce( [] ) do | memo, search |
+      @installable_headers.reduce( [] ) do | memo, search |
         non_glob_search = ( search.match( /^([^\*\?]*)/ ) )[ 1 ]
         case
         when ( non_glob_search !~ /#{ @rakefile_path }/ )

data/lib/rake/microsecond.rb

@@ -18,9 +18,17 @@ module Rake
       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 }
+        return true if not File.exist?(self.name)
+        @timestamp = File.stat(self.name).mtime if @timestamp.nil?
+        self.prerequisites.any? do |n|
+          task = application[n]
+          if task.is_a?(Rake::FileTask) or
+            task.is_a?(self.class)
+            task.timestamp > @timestamp
+          else
+            task.needed?
+          end
+        end
       end
 
       def execute(*args)

data/spec/generated_files_spec.rb

@@ -26,13 +26,6 @@ describe 'when handling generated files' do
     @project.generated_files.should =~ @expected_generated
   end
 
-  it 'lists generated files, via the task' do
-    stdout, _ = capturing_output do
-      Rake::Task[ 'generated_files' ].invoke
-    end
-    JSON.load(stdout).            should    =~ @expected_generated
-  end
-
   it 'removes generated files with \'clean\'' do
     Rake::Task[ 'run' ].invoke
     @expected_generated.each do |f|

data/spec/spec_helper.rb

@@ -16,7 +16,7 @@ module RakeBuilderHelper
       builder.target               = TARGET[ type ]
       builder.task_namespace       = namespace
       builder.source_search_paths  = [ 'cpp_project' ]
-      builder.header_search_paths  = [ 'cpp_project' ]
+      builder.include_paths        = [ 'cpp_project' ]
       builder.generated_files      << 'rake-builder-testfile.txt'
       yield builder if block_given?
     end
@@ -28,7 +28,7 @@ module RakeBuilderHelper
       builder.target               = TARGET[ type ]
       builder.task_namespace       = namespace
       builder.source_search_paths  = [ 'c_project' ]
-      builder.header_search_paths  = [ 'c_project' ]
+      builder.include_paths        = [ 'c_project' ]
       builder.generated_files      << 'rake-c-testfile.txt'
       yield builder if block_given?
     end
@@ -40,7 +40,7 @@ module RakeBuilderHelper
       builder.target               = TARGET[ type ]
       builder.task_namespace       = namespace
       builder.source_search_paths  = [ 'objective_c_project' ]
-      builder.header_search_paths  = [ 'objective_c_project' ]
+      builder.include_paths        = [ 'objective_c_project' ]
       builder.generated_files      << 'rake-builder-testfile.txt'
       builder.library_dependencies = [ 'objc' ]
       builder.linker_options       = '-framework CoreFoundation -framework Foundation'

data/spec/unit/rake/builder/autoconf/version_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Rake::Builder::Autoconf::Version do
+  context '.new' do
+    context 'with parameter' do
+      it 'fails if the version parameter is not nn.nn.nn' do
+        expect {
+          Rake::Builder::Autoconf::Version.new('hello')
+        }.to raise_error(RuntimeError, /badly formatted/)
+      end
+    end
+
+    context 'without parameter' do
+      it 'succeeds' do
+        Rake::Builder::Autoconf::Version.new
+      end
+    end
+
+    context 'VERSION file' do
+      before do
+        File.stub(:exist? => true)
+        File.stub(:read => '1.2.3')
+      end
+
+      it 'checks for a the file' do
+        File.should_receive(:exist?).
+          with('VERSION').
+          and_return(false)
+
+        Rake::Builder::Autoconf::Version.new
+      end
+
+      it 'loads the file' do
+        File.should_receive(:exist?).
+          with('VERSION').
+          and_return(true)
+        File.should_receive(:read).
+          with('VERSION').
+          and_return('1.2.3')
+
+        Rake::Builder::Autoconf::Version.new
+      end
+
+      it 'fails if the version is badly formed' do
+        File.should_receive(:read).
+          with('VERSION').
+          and_return('bad')
+
+        expect {
+          Rake::Builder::Autoconf::Version.new
+        }.to raise_error(RuntimeError, /file.*?version.*?badly formatted/)
+      end
+    end
+  end
+
+  context '#decide' do
+  end
+end
+

data/spec/unit/rake/builder/task_definers/builder_collection_task_definer_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Rake::Builder::BuilderCollectionTaskDefiner do
+  context '#run' do
+    subject { Rake::Builder::BuilderCollectionTaskDefiner.new }
+
+    before do
+      Rake::Task.clear
+    end
+
+    it 'defines an autoconf task' do
+      subject.run
+
+      expect(Rake::Task.task_defined?('autoconf')).to be_true
+    end
+
+    it 'calls create_autoconf' do
+      Rake::Builder.instances << stub(
+        'Rake::Builder',
+        :source_files => ['foo'],
+        :rakefile_path => '/path',
+      )
+
+      subject.run
+
+      Rake::Builder.should_receive(:create_autoconf)
+
+      Rake::Task['autoconf'].invoke
+    end
+
+    it 'fails if no builders have been instantiated' do
+      Rake::Builder.instances.clear
+
+      subject.run
+
+      expect {
+        Rake::Task['autoconf'].invoke
+      }.to raise_error(RuntimeError, 'No Rake::Builder projects have been defined')
+    end
+  end
+end
+