rake-builder 0.0.14 → 0.0.15

data/README.rdoc

@@ -15,6 +15,12 @@ Here is a typical example:
    builder.header_search_paths  = [ 'include' ]
  end
 
+= Dependencies
+
+* makedepend
+** linux: package 'xutils-dev'
+** OS X: already installed
+
 = Installation
 
  $ sudo gem install rake-builder
@@ -57,6 +63,7 @@ The file should be a YAML structure, and must include a version.
 
 Currently, the following can be configured:
 * extra include paths: :include_paths
+* extra compilation options (e.g. defines): :compilation_options
 
 === Example '.rake-builder'
 

data/Rakefile

@@ -1,40 +1,20 @@
-require 'rubygems' if RUBY_VERSION < '1.9'
-require 'rake'
-require 'rake/rdoctask'
-require 'spec/rake/spectask'
-$:.unshift( File.dirname( __FILE__ ) + '/lib' )
-require 'rake/builder/version'
+require "bundler/gem_tasks"
+require 'rcov/rcovtask' if RUBY_VERSION < '1.9'
+require 'rspec/core/rake_task'
 
-RDOC_FILES           = FileList[ 'COPYING', 'README.rdoc' ] +
-                       FileList[ 'lib/**/*.rb' ] +
-                       FileList[ 'examples/README.rdoc' ] +
-                       FileList[ 'examples/**/Rakefile' ]
-RDOC_OPTS            = [ '--quiet', '--main', 'README.rdoc', '--inline-source' ]
+task :default => :spec
 
-Spec::Rake::SpecTask.new do |t|
-  t.spec_files       = FileList[ 'spec/**/*_spec.rb' ]
-  t.spec_opts        += [ '--color', '--format specdoc' ]
+RSpec::Core::RakeTask.new do | t |
+  t.pattern = 'spec/**/*_spec.rb'
 end
 
-Spec::Rake::SpecTask.new( 'spec:rcov' ) do |t|
-  t.spec_files       = FileList[ 'spec/**/*_spec.rb' ]
-  t.rcov             = true
-  t.rcov_opts        = [ '--exclude spec' ]
-end
+if RUBY_VERSION < '1.9'
 
-Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir      = 'html'
-  rdoc.options       += RDOC_OPTS
-  rdoc.title         = 'Rake for C/C++/Objective-C/Objective-C++ Projects'
-  rdoc.rdoc_files.add RDOC_FILES
-end
+  RSpec::Core::RakeTask.new( 'spec:rcov' ) do |t|
+    t.pattern   = 'spec/**/*_spec.rb'
+    t.rcov      = true
+    t.rcov_opts = [ '--exclude', 'spec/,/gems/' ]
+  end
 
-desc "Build the gem"
-task :build do
-  system "gem build rake-builder.gemspec"
 end
 
-desc "Publish gem version #{ Rake::Builder::VERSION::STRING }"
-task :release => :build do
-  system "gem push rake-builder-#{ Rake::Builder::VERSION::STRING }.gem"
-end

data/lib/rake/builder.rb

@@ -1,12 +1,17 @@
 require 'rubygems' if RUBY_VERSION < '1.9'
+require 'json'
 require 'logger'
 require 'rake'
 require 'rake/tasklib'
 require 'rake/path'
 require 'rake/local_config'
 require 'rake/file_task_alias'
+require 'rake/microsecond'
+require 'rake/once_task'
 require 'compiler'
 
+include Rake::DSL
+
 module Rake
 
   class Formatter < Logger::Formatter
@@ -17,14 +22,6 @@ module Rake
 
   class Builder < TaskLib
 
-    module VERSION #:nodoc:
-      MAJOR = 0
-      MINOR = 0
-      TINY  = 13
-
-      STRING = [ MAJOR, MINOR, TINY ].join('.')
-    end
-
     class BuilderError < StandardError
       attr_accessor :namespace
 
@@ -154,12 +151,190 @@ module Rake
     # Name of the generated file containing source - header dependencies
     attr_reader   :makedepend_file
 
+    # The file containing local settings such as include paths
+    attr_reader   :local_config
+
     # Temporary files generated during compilation and linking
     attr_accessor :generated_files
 
     # Each instance has its own logger
     attr_accessor :logger
 
+    # All Rake::Builder instaces that get defined
+    # This allows us to create scripts for configure
+    @instances = []
+
+    def self.instances
+      @instances
+    end
+
+    def self.define_global
+      desc "Create input files for configure script creation"
+      task :autoconf, [:project_title, :version] => [] do | task, args |
+        project_title = args.project_title or raise "Please supply a project_title parameter"
+        version       = decide_version( args.version )
+        if File.exist?( 'configure.ac' )
+          raise "The file 'configure.ac' already exists"
+        end
+        if File.exist?( 'Makefile.am' )
+          raise "The file 'Makefile.am' already exists"
+        end
+        create_configure_ac project_title, version
+        create_makefile_am
+      end
+
+      desc "A file containing the major.minor.revision version information"
+      file 'VERSION' do
+        raise <<-EOT
+        In order to create autoconf files, you need to create a file called VERSION in the root directory of the project.
+        The file should contain the version of the project, like this:
+            1.2.3
+        EOT
+      end
+    end
+
+    def self.create_configure_ac( project_title, version )
+      source = Rake::Path.relative_path( instances[ 0 ].source_files[ 0 ], instances[ 0 ].rakefile_path  )
+      File.open( 'configure.ac', 'w' ) do | f |
+        f.write <<EOT
+AC_PREREQ(2.61)
+AC_INIT(#{project_title}, #{ version })
+AC_CONFIG_SRCDIR([#{ source }])
+AC_CONFIG_HEADER([config.h])
+AM_INIT_AUTOMAKE([#{project_title}], [#{ version }])
+
+# Checks for programs.
+AC_PROG_CXX
+AC_PROG_CC
+AC_PROG_RANLIB
+
+# Checks for libraries.
+
+# Checks for header files.
+
+# Checks for typedefs, structures, and compiler characteristics.
+AC_HEADER_STDBOOL
+AC_C_CONST
+AC_C_INLINE
+AC_STRUCT_TM
+
+# Checks for library functions.
+AC_FUNC_LSTAT
+AC_FUNC_LSTAT_FOLLOWS_SLASHED_SYMLINK
+AC_FUNC_MEMCMP
+AC_HEADER_STDC
+AC_CHECK_FUNCS([memset strcasecmp])
+
+AC_CONFIG_FILES([Makefile])
+
+AC_OUTPUT
+EOT
+      end
+    end
+
+    def self.create_makefile_am
+      libraries = []
+      binaries  = []
+      instances.each do | instance |
+        entry = instance.makefile_am_entry
+        case entry[ :type ]
+        when :static_library, :shared_library
+          libraries << entry
+        else
+          binaries << entry
+        end
+      end
+
+      File.open( 'Makefile.am', 'w' ) do | f |
+        if libraries.size > 0
+          names = libraries.map { | lib | lib[ :name ] }.join( ' ' )
+          f.write "lib_LIBRARIES = #{ names }\n\n"
+          libraries.each do | lib |
+            f.write <<EOT
+#{ lib[ :label ] }_SOURCES = #{ lib[ :sources ] }
+#{ lib[ :label ] }_CPPFLAGS = #{ lib[ :compiler_flags ] }
+
+EOT
+          end
+        end
+        if binaries.size > 0
+          names = binaries.map { | bin | bin[ :name ] }.join( ' ' )
+          f.write "bin_PROGRAMS = #{ names }\n\n"
+          binaries.each do | bin |
+            f.write <<EOT
+#{ bin[ :label ] }_SOURCES = #{ bin[ :sources ] }
+#{ bin[ :label ] }_CPPFLAGS = #{ bin[ :compiler_flags ] }
+
+EOT
+          end
+        end
+
+      end
+    end
+
+    def makefile_am_entry
+      primary_name = Rake::Path.relative_path( target, rakefile_path, :initial_dot_slash => false )
+      sources      = source_files.map{ | file | Rake::Path.relative_path( file, rakefile_path) }.join( ' ' )
+      sources_label = primary_name.gsub( %r(\.), '_' )
+
+      {
+      :type         => @target_type,
+      :name         => primary_name, 
+      :label        => sources_label,
+      :sources      => sources,
+      :compiler_flags => compiler_flags
+      }
+    end
+
+    #########################################
+    # VERSION file
+
+    def self.decide_version( parameter_version )
+      acceptable_version_string = %r(^(\d+)\.(\d+)\.(\d+)$)
+      if parameter_version && parameter_version !~ acceptable_version_string
+        raise "The supplied version number '#{ parameter_version }' is badly formatted. It should consist of three numbers separated by ."
+      end
+      file_version = load_file_version
+      if file_version && file_version !~ acceptable_version_string
+        raise "Your VERSION file contains a version number '#{ parameter_version }' which is badly formatted. It should consist of three numbers separated by ."
+      end
+      case
+      when parameter_version.nil? && file_version.nil?
+        raise <<-EOT
+        This task requires a project version: major.minor.revision (e.g. 1.03.0567)
+        Please do one of the following:
+        - supply a version parameter: rake autoconf[project_name,version]
+        - create a VERSION file.
+        EOT
+      when file_version.nil?
+        save_file_version parameter_version
+        return parameter_version
+      when parameter_version.nil?
+        return file_version
+      when file_version != parameter_version
+        raise <<-EOT
+        The version parameter supplied is different to the value in the VERSION file
+        EOT
+      else
+        return file_version
+      end
+    end
+
+    def self.load_file_version
+      if File.exist?( 'VERSION' )
+        version = File.read( 'VERSION' )
+        version.strip!
+      else
+        nil
+      end
+    end
+
+    def self.save_file_version( version )
+      File.open( 'VERSION', 'w' ) { | f | f.write "#{ version }/n" }
+    end
+ 
+    self.define_global
+
     def initialize( &block )
       save_rakefile_info( block )
       initialize_attributes
@@ -167,22 +342,23 @@ module Rake
       configure
       define_tasks
       define_default
+      self.class.instances << self
     end
 
-    private
-
     # Source files found in source_search_paths
     def source_files
-      @source_files ||= find_files( @source_search_paths, @source_file_extension ).uniq
-      @source_files
+      return @source_files if @source_files
+      @source_files = find_files( @source_search_paths, @source_file_extension ).uniq
     end
 
     # Header files found in header_search_paths
     def header_files
-      @header_files ||= find_files( @header_search_paths, @header_file_extension ).uniq
-      @header_files
+      return @header_files if @header_files
+      @header_files = find_files( @header_search_paths, @header_file_extension ).uniq
     end
 
+    private
+
     def initialize_attributes
       @architecture          = 'i386'
       @compiler_data         = Compiler::Base.for( :gcc )
@@ -220,7 +396,7 @@ module Rake
       raise BuilderError.new( "The target name cannot be nil", task_namespace )             if @target.nil?
       raise BuilderError.new( "The target name cannot be an empty string", task_namespace ) if @target == ''
       @objects_path          = Rake::Path.expand_with_root( @objects_path, @rakefile_path )
-      @target                = @target
+      @target                = File.expand_path( @target, @rakefile_path )
       @target_type           ||= type( @target )
       raise BuilderError.new( "Building #{ @target_type } targets is not supported", task_namespace ) if ! TARGET_TYPES.include?( @target_type )
 
@@ -233,6 +409,7 @@ module Rake
 
       @default_task          ||= :build
       @target_prerequisites  << @rakefile
+      @local_config          = Rake::Path.expand_with_root( '.rake-builder', @rakefile_path )
 
       @makedepend_file       = @objects_path + '/.' + target_basename + '.depend.mf'
 
@@ -260,7 +437,7 @@ module Rake
     end
 
     def define
-      task :environment do
+      once_task :environment do
         logger.level = Logger::DEBUG if ENV[ 'DEBUG' ]
       end
 
@@ -276,7 +453,7 @@ module Rake
       FileTaskAlias.define_task( :build, @target )
 
       desc "Build '#{ target_basename }'"
-      file @target => [ scoped_task( :environment ),
+      microsecond_file @target => [ scoped_task( :environment ),
                         scoped_task( :compile ),
                         *@target_prerequisites ] do | t |
         shell "rm -f #{ t.name }"
@@ -289,7 +466,7 @@ module Rake
       desc "Compile all sources"
       # Only import dependencies when we're compiling
       # otherwise makedepend gets run on e.g. 'rake -T'
-      task :compile => [ scoped_task( :environment ),
+      once_task :compile => [ scoped_task( :environment ),
                          @makedepend_file,
                          scoped_task( :load_makedepend ),
                          *object_files ]
@@ -298,34 +475,35 @@ module Rake
         define_compile_task( src )
       end
 
-      directory @objects_path
+      microsecond_directory @objects_path
 
-      task :local_config do
-        if ! File.exist?( local_config )
-          @logger.add( 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
-          config.save
-        end
+      file scoped_task( local_config ) do
+        @logger.add( 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
+        config.save
       end
 
-      file @makedepend_file => [ scoped_task( :load_local_config ),
+      microsecond_file @makedepend_file => [ scoped_task( :load_local_config ),
                                  scoped_task( :missing_headers ),
                                  @objects_path,
                                  *project_files ] do
+        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
 
-      task :load_local_config => scoped_task( :local_config ) do
+      once_task scoped_task( :load_local_config ) => scoped_task( local_config ) do
         config = LocalConfig.new( local_config )
         config.load
-        @include_paths += Rake::Path.expand_all_with_root( config.include_paths, @rakefile_path )
+        @include_paths       += Rake::Path.expand_all_with_root( config.include_paths, @rakefile_path )
+        @compilation_options += config.compilation_options
       end
 
-      task :missing_headers => [ *generated_headers ] do
+      once_task scoped_task( :missing_headers ) => [ *generated_headers ] do
         missing_headers
       end
 
@@ -354,7 +532,7 @@ module Rake
 
       desc "List generated files (which are removed with 'rake #{ scoped_task( :clean ) }')"
       task :generated_files do
-        puts generated_files.inspect
+        puts generated_files.to_json
       end
 
       # Re-implement :clean locally for project and within namespace
@@ -513,7 +691,8 @@ EOT
     # Compiling and linking parameters
 
     def include_path
-      @include_paths.map { |p| "-I#{ p }" }.join( " " )
+      paths = @include_paths.map{ | file | Rake::Path.relative_path( file, rakefile_path) }
+      paths.map { |p| "-I#{ p }" }.join( ' ' )
     end
 
     def compiler_flags
@@ -534,11 +713,6 @@ EOT
 
     # Paths
 
-    def local_config
-      filename = '.rake-builder'
-      Rake::Path.expand_with_root( filename, @rakefile_path )
-    end
-
     def save_rakefile_info( block )
       if RUBY_VERSION < '1.9'
         # Hack the path from the block String representation
@@ -546,7 +720,8 @@ EOT
       else
         @rakefile = block.source_location[ 0 ]
       end
-      @rakefile_path = File.expand_path( File.dirname( @rakefile ) )
+      @rakefile      = File.expand_path( @rakefile )
+      @rakefile_path = File.dirname( @rakefile )
     end
 
     def object_path( source_path_name )
@@ -600,6 +775,7 @@ EOT
     def project_files
       source_files + header_files
     end
+    public :project_files
 
     def file_list( files, delimiter = ' ' )
       files.join( delimiter )
@@ -646,7 +822,7 @@ EOT
           FileList[ search ].each do | pathname |
             full_path = Rake::Path.expand_with_root( pathname, @rakefile_path )
             directory = File.dirname( full_path )
-            relative  = Rake::Path.subtract_prefix( non_glob_search, directory )
+            relative  = Rake::Path.relative_path( directory, non_glob_search )
             memo << { :source_file => pathname, :relative_path => relative }
           end
         else
@@ -666,10 +842,11 @@ EOT
     end
 
     def shell( command, log_level = Logger::DEBUG )
-      @logger.add( log_level, command )
-      `#{ command }`
+      @logger.add(log_level, command)
+      system command, {:out => '/dev/null', :err => '/dev/null'}
     end
 
   end
 
 end
+