rake-builder 0.0.13 → 0.0.14

data/Rakefile

@@ -1,47 +1,16 @@
 require 'rubygems' if RUBY_VERSION < '1.9'
 require 'rake'
-require 'rake/gempackagetask'
-require 'spec/rake/spectask'
 require 'rake/rdoctask'
+require 'spec/rake/spectask'
 $:.unshift( File.dirname( __FILE__ ) + '/lib' )
-require 'rake/builder'
+require 'rake/builder/version'
 
-ADMIN_FILES          = FileList[ 'CHANGES', 'COPYING', 'Rakefile', 'README.rdoc' ]
-SOURCE_FILES         = FileList[ 'lib/**/*.rb' ]
-SPEC_FILES           = FileList[ 'spec/**/*' ]
-EXAMPLE_EXTRA_FILES  = FileList[ 'examples/README.rdoc' ] + FileList[ 'examples/**/Rakefile' ]
-EXAMPLE_SOURCE_FILES = FileList[ 'examples/**/*.{h,c,cpp,m}' ]
-RDOC_FILES           = FileList[ 'COPYING', 'README.rdoc' ] + SOURCE_FILES + EXAMPLE_EXTRA_FILES
+RDOC_FILES           = FileList[ 'COPYING', 'README.rdoc' ] +
+                       FileList[ 'lib/**/*.rb' ] +
+                       FileList[ 'examples/README.rdoc' ] +
+                       FileList[ 'examples/**/Rakefile' ]
 RDOC_OPTS            = [ '--quiet', '--main', 'README.rdoc', '--inline-source' ]
 
-spec = Gem::Specification.new do |s|
-  s.name             = 'rake-builder'
-  s.summary          = 'Rake for C/C++ Projects'
-  s.description      = 'Provides Rake:Builder, a specific rake TaskLib for building C, C++, Objective-C and Objective-C++ projects'
-  s.version          = Rake::Builder::VERSION::STRING
-
-  s.homepage         = 'http://github.com/joeyates/rake-builder'
-  s.author           = 'Joe Yates'
-  s.email            = 'joe.g.yates@gmail.com'
-  s.rubyforge_project = 'nowarning'
-
-  s.files            = ADMIN_FILES +
-                       SOURCE_FILES +
-                       EXAMPLE_SOURCE_FILES +
-                       EXAMPLE_EXTRA_FILES
-  s.require_paths    = [ 'lib' ]
-  s.add_dependency( 'rake', '>= 0.8.7' )
-
-  s.has_rdoc         = true
-  s.rdoc_options     += RDOC_OPTS
-  s.extra_rdoc_files = RDOC_FILES
-
-  s.test_files       = SPEC_FILES
-end
-
-Rake::GemPackageTask.new( spec ) do |pkg|
-end
-
 Spec::Rake::SpecTask.new do |t|
   t.spec_files       = FileList[ 'spec/**/*_spec.rb' ]
   t.spec_opts        += [ '--color', '--format specdoc' ]
@@ -59,3 +28,13 @@ Rake::RDocTask.new do |rdoc|
   rdoc.title         = 'Rake for C/C++/Objective-C/Objective-C++ Projects'
   rdoc.rdoc_files.add RDOC_FILES
 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,9 +1,9 @@
 require 'rubygems' if RUBY_VERSION < '1.9'
 require 'logger'
-require 'yaml'
 require 'rake'
 require 'rake/tasklib'
 require 'rake/path'
+require 'rake/local_config'
 require 'rake/file_task_alias'
 require 'compiler'
 
@@ -15,10 +15,6 @@ module Rake
     end
   end
 
-  # Error indicating that the project failed to build.
-  class BuildFailureError < StandardError
-  end
-
   class Builder < TaskLib
 
     module VERSION #:nodoc:
@@ -29,6 +25,25 @@ module Rake
       STRING = [ MAJOR, MINOR, TINY ].join('.')
     end
 
+    class BuilderError < StandardError
+      attr_accessor :namespace
+
+      def initialize( message, namespace = nil )
+        super( message )
+        @namespace = namespace
+      end
+
+      def to_s
+        message = super
+        message = "#{ @namespace }: #{ message }" if @namespace
+        message
+      end
+    end
+
+    # Error indicating that the project failed to build.
+    class BuildFailure < BuilderError
+    end
+
     # The file to be built
     attr_accessor :target
 
@@ -192,8 +207,8 @@ module Rake
       @compilation_options   += [ architecture_option ] if RUBY_PLATFORM =~ /apple/i
       @compilation_options.uniq!
 
-      @programming_language.downcase!
-      raise "Don't know how to build '#{ @programming_language }' programs" if KNOWN_LANGUAGES[ @programming_language ].nil?
+      @programming_language = @programming_language.to_s.downcase
+      raise BuilderError.new( "Don't know how to build '#{ @programming_language }' programs", task_namespace ) if KNOWN_LANGUAGES[ @programming_language ].nil?
       @compiler              ||= KNOWN_LANGUAGES[ @programming_language ][ :compiler ]
       @linker                ||= KNOWN_LANGUAGES[ @programming_language ][ :linker ]
       @source_file_extension ||= KNOWN_LANGUAGES[ @programming_language ][ :source_file_extension ]
@@ -202,12 +217,13 @@ module Rake
       @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 "The target name cannot be nil" if @target.nil?
-      raise "The target name cannot be an empty string" if @target == ''
+      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                = Rake::Path.expand_with_root( @target, @objects_path )
+      @target                = @target
       @target_type           ||= type( @target )
-      raise "Building #{ @target_type } targets is not supported" if ! TARGET_TYPES.include?( @target_type )
+      raise BuilderError.new( "Building #{ @target_type } targets is not supported", task_namespace ) if ! TARGET_TYPES.include?( @target_type )
+
       @install_path          ||= default_install_path( @target_type )
 
       @linker_options        ||= ''
@@ -220,7 +236,7 @@ module Rake
 
       @makedepend_file       = @objects_path + '/.' + target_basename + '.depend.mf'
 
-      raise "No source files found" if source_files.length == 0
+      raise BuilderError.new( "No source files found", task_namespace ) if source_files.length == 0
     end
 
     def define_tasks
@@ -244,10 +260,14 @@ module Rake
     end
 
     def define
+      task :environment do
+        logger.level = Logger::DEBUG if ENV[ 'DEBUG' ]
+      end
+
       if @target_type == :executable
         desc "Run '#{ target_basename }'"
         task :run => :build do
-          command = "cd #{ @rakefile_path } && #{ @target }" 
+          command = "cd #{ @rakefile_path } && #{ @target }"
           puts shell( command, Logger::INFO )
         end
       end
@@ -256,18 +276,23 @@ module Rake
       FileTaskAlias.define_task( :build, @target )
 
       desc "Build '#{ target_basename }'"
-      file @target => [ scoped_task( :compile ), *@target_prerequisites ] do |t|
+      file @target => [ scoped_task( :environment ),
+                        scoped_task( :compile ),
+                        *@target_prerequisites ] do | t |
         shell "rm -f #{ t.name }"
         build_commands.each do | command |
           shell command
         end
-        raise BuildFailureError if ! File.exist?( t.name )
+        raise BuildFailure.new( "The build command failed" ) if ! File.exist?( t.name )
       end
 
       desc "Compile all sources"
       # Only import dependencies when we're compiling
       # otherwise makedepend gets run on e.g. 'rake -T'
-      task :compile => [ @makedepend_file, scoped_task( :load_makedepend ), *object_files ]
+      task :compile => [ scoped_task( :environment ),
+                         @makedepend_file,
+                         scoped_task( :load_makedepend ),
+                         *object_files ]
 
       source_files.each do |src|
         define_compile_task( src )
@@ -275,12 +300,13 @@ module Rake
 
       directory @objects_path
 
-      file local_config => scoped_task( :missing_headers ) do
-        added_includes   = @compiler_data.include_paths( missing_headers )
-        config           = { :rake_builder  => { :config_file => { :version=> '1.0' } },
-                             :include_paths => added_includes }
-        File.open( local_config, 'w' ) do | file |
-          file.write config.to_yaml
+      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
       end
 
@@ -293,14 +319,10 @@ module Rake
         shell command
       end
 
-      task :load_local_config => local_config do
-        config = YAML.load_file( local_config )
-
-        version = config[ :rake_builder ][ :config_file ][ :version ]
-        raise "Config file version missing" if version.nil?
-
-        config[ :include_paths ] ||= []
-        @include_paths += Rake::Path.expand_all_with_root( config[ :include_paths ], @rakefile_path )
+      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 )
       end
 
       task :missing_headers => [ *generated_headers ] do
@@ -364,9 +386,74 @@ module Rake
         begin
           shell "rm '#{ destination }'", Logger::INFO
         rescue Errno::EACCES => e
-          raise "You do not have premission to uninstall '#{ destination }'\nTry\n $ sudo rake #{ scoped_task( :uninstall ) }"
+          raise BuilderError.new( "You do not have premission to uninstall '#{ destination }'\nTry\n $ sudo rake #{ scoped_task( :uninstall ) }", task_namespace )
         end
       end
+
+      desc "Create a '#{ makefile_name }' to build the project"
+      file "#{ makefile_name }" => [ @makedepend_file, scoped_task( :load_makedepend ) ] do | t |
+        objects       = object_files.collect { | f | f.sub( "#{ @objects_path }", '$(OBJECT_DIR)' ) }
+        objects_list  = objects.join( ' ' )
+        case @target_type
+        when :executable
+          target_name = 'EXECUTABLE_TARGET'
+          target_ref  = "$(#{ target_name })"
+          target_actions =
+"	$(LINKER) $(LINK_FLAGS) -o #{ target_ref } $(OBJECTS)
+"
+        when :static_library
+          target_name = 'LIB_TARGET'
+          target_ref  = "$(#{ target_name })"
+          target_actions =
+"	rm -f #{ target_ref }
+	ar -cq #{ target_ref } $(OBJECTS)
+	ranlib #{ target_ref }
+"
+        when :shared_library
+          target_name = 'LIB_TARGET'
+          target_ref  = "$(#{ target_name })"
+          target_actions =
+"	$(LINKER) -shared -o #{ target_ref } $(OBJECTS) $(LINK_FLAGS)
+"
+        end
+
+        variables = <<EOT
+COMPILER       = #{ @compiler }
+COMPILER_FLAGS = #{ compiler_flags }
+LINKER         = #{ @linker }
+LINK_FLAGS     = #{ link_flags }
+OBJECT_DIR     = #{ @objects_path }
+OBJECTS        = #{ objects_list }
+#{ target_name } = #{ @target }
+EOT
+        rules     = <<EOT
+
+all: #{ target_ref }
+
+clean:
+	rm -f $(OBJECTS)
+	rm -f #{ target_ref }
+
+#{ target_ref }: $(OBJECTS)
+#{ target_actions }
+EOT
+
+        source_groups = group_files_by_path( source_files )
+        source_groups.each.with_index do | gp, i |
+          variables << "SOURCE_#{ i + 1 } = #{ gp[ 0 ] }\n"
+          rules     << <<EOT
+
+$(OBJECT_DIR)/%.o: $(SOURCE_#{ i + 1 })/%.cpp
+	$(COMPILER) -c $(COMPILER_FLAGS) -o $@ $<
+EOT
+        end
+
+        File.open( t.name, 'w' ) do | file |
+          file.write variables
+          file.write rules
+        end
+      end
+
     end
 
     def generated_headers
@@ -385,7 +472,7 @@ module Rake
       object = object_path( source )
       @generated_files << object
       file object => [ source ] do |t|
-        @logger.add( Logger::INFO, "Compiling '#{ source }'" )
+        @logger.add( Logger::DEBUG, "Compiling '#{ source }'" )
         command = "#{ @compiler } -c #{ compiler_flags } -o #{ object } #{ source }"
         shell command
       end
@@ -394,7 +481,7 @@ module Rake
     def build_commands
       case @target_type
       when :executable
-        [ "#{ @linker } #{ link_flags } -o #{ @target } #{ file_list( object_files ) }" ]
+        [ "#{ @linker } -o #{ @target } #{ file_list( object_files ) } #{ link_flags }" ]
       when :static_library
         [ "ar -cq #{ @target } #{ file_list( object_files ) }",
           "ranlib #{ @target }" ]
@@ -440,7 +527,7 @@ module Rake
     end
 
     def link_flags
-      flags = [ @linker_options, architecture_option, library_paths_list, library_dependencies_list ]
+      flags = [ @linker_options, library_paths_list, library_dependencies_list ]
       flags << architecture_option if RUBY_PLATFORM =~ /darwin/i
       flags.join( " " )
     end
@@ -471,15 +558,33 @@ module Rake
       case target_type
       when :executable
         '/usr/local/bin'
-      else  
+      else
         '/usr/local/lib'
       end
     end
 
+    def group_files_by_path( files )
+      files.group_by do | f |
+        m = f.match( /(.*?)?\/?([^\/]+)$/ )
+        m[ 1 ]
+      end
+    end
+
+    # Files
+
     def target_basename
       File.basename( @target )
     end
 
+    def makefile_name
+      extension = if ! task_namespace.nil? && ! task_namespace.to_s.empty?
+                    '.' + task_namespace.to_s
+                  else
+                    ''
+                  end
+      "Makefile#{ extension }"
+    end
+
     # Lists of files
 
     def find_files( paths, extension )
@@ -517,7 +622,7 @@ module Rake
         begin
           `mkdir -p '#{ destination_path }'`
         rescue Errno::EACCES => e
-          raise "Permission denied to created directory '#{ destination_path }'"
+          raise BuilderError.new( "Permission denied to created directory '#{ destination_path }'", task_namespace )
         end
         install( installable_header[ :source_file ], destination_path )
       end
@@ -556,7 +661,7 @@ module Rake
         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"
+        raise BuilderError.new( "You do not have permission to install '#{ source_filename }' to '#{ destination_path }'\nTry\n $ sudo rake install", task_namespace )
       end
     end
 

data/lib/rake/builder/qt_builder.rb

@@ -34,7 +34,7 @@ module Rake
         @framework_paths       = [ '/Library/Frameworks' ]
         @moc_defines           = [ '-D__APPLE__',  '-D__GNUC__' ]
       else
-        raise "Unrecognised platform"
+        raise BuilderError.new( "Unrecognised platform" )
       end
       @compilation_defines   = [ '-DQT_GUI_LIB', '-DQT_CORE_LIB', '-DQT_SHARED' ]
       @resource_files        = []
@@ -42,8 +42,8 @@ module Rake
     end
 
     def configure
-      raise 'programming_language must be C++' if @programming_language.downcase != 'c++'
-      raise 'qt_version must be set'           if ! @qt_version
+      raise BuilderError.new( 'programming_language must be C++' ) if @programming_language.downcase != 'c++'
+      raise BuilderError.new( 'qt_version must be set' )           if ! @qt_version
 
       super
 

data/lib/rake/builder/version.rb

@@ -0,0 +1,15 @@
+module Rake
+
+  class Builder
+
+    module VERSION #:nodoc:
+      MAJOR =  0
+      MINOR =  0
+      TINY  = 14
+
+      STRING = [ MAJOR, MINOR, TINY ].join('.')
+    end
+
+  end
+
+end

data/lib/rake/local_config.rb

@@ -0,0 +1,40 @@
+require 'yaml'
+
+module Rake
+
+  class LocalConfig
+
+    attr_accessor :config
+
+    def initialize( file_name )
+      @file_name = file_name
+      @config    = { :rake_builder  => { :config_file => { :version=> '1.0' } },
+                     :include_paths => [] }
+    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[ :include_paths ] ||= []
+    end
+
+    def save
+      File.open( @file_name, 'w' ) do | file |
+        file.write @config.to_yaml
+      end
+    end
+
+    def include_paths
+      @config[ :include_paths ]
+    end
+
+    def include_paths=( include_paths )
+      @config[ :include_paths ] = include_paths
+    end
+
+  end
+
+end

data/spec/libraries_spec.rb

@@ -22,12 +22,12 @@ describe 'when using libraries' do
   end
 
   it 'fails to build if libraries are missing' do
-    lambda do
+    expect 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.to raise_error( Rake::Builder::BuildFailure )
   end
 
 end

data/spec/local_config_spec.rb

@@ -19,44 +19,21 @@ describe 'local config files' do
     end.should_not raise_error
   end
 
-  it 'loads the local config file' do
+  it 'loads config files' do
     save_config
-    @builder = cpp_task( :executable )
-    @builder.include_paths.should include( @expected_path )
+    config = Rake::LocalConfig.new( @local_config_file )
+    config.load
+
+    config.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 }'`
+      config = Rake::LocalConfig.new( @local_config_file )
+      config.load
+    end.should raise_error( Rake::Builder::BuilderError, 'Config file version missing' )
   end
 
   private

data/spec/target_spec.rb

@@ -6,13 +6,17 @@ describe 'when creating tasks' do
     Rake::Task.clear
   end
 
+  after( :each ) do
+    `rm -f spec/.rake-builder.foo`
+  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.should raise_error( Rake::Builder::BuilderError, 'The target name cannot be an empty string' )
   end
 
   it 'raises an error when the target is set to nil' do
@@ -21,7 +25,7 @@ describe 'when creating tasks' do
         builder.target = nil
         builder.source_search_paths = [ 'cpp_project' ]
       end
-    end.should raise_error( RuntimeError )
+    end.should raise_error( Rake::Builder::BuilderError, 'The target name cannot be nil' )
   end
 
   it 'sets the target to \'a.out\' if it is not set' do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rake-builder
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 3
   prerelease: false
   segments: 
   - 0
   - 0
-  - 13
-  version: 0.0.13
+  - 14
+  version: 0.0.14
 platform: ruby
 authors: 
 - Joe Yates
@@ -15,46 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-20 00:00:00 +00:00
+date: 2011-04-04 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
+dependencies: []
+
 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/compiler.rb
-- lib/rake/builder/qt_builder.rb
-- lib/rake/builder.rb
-- lib/rake/file_task_alias.rb
-- lib/rake/path.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
+extra_rdoc_files: []
+
 files: 
 - CHANGES
 - COPYING
@@ -62,8 +34,10 @@ files:
 - README.rdoc
 - lib/compiler.rb
 - lib/rake/builder/qt_builder.rb
+- lib/rake/builder/version.rb
 - lib/rake/builder.rb
 - lib/rake/file_task_alias.rb
+- lib/rake/local_config.rb
 - lib/rake/path.rb
 - examples/03_search_paths/include/main.h
 - examples/04_zlib/include/main.h
@@ -106,11 +80,8 @@ homepage: http://github.com/joeyates/rake-builder
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --quiet
-- --main
-- README.rdoc
-- --inline-source
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement