rake-builder 0.0.8

data/CHANGES

@@ -0,0 +1,5 @@
+= Rake::Cpp Changelog
+
+== Version 0.0.1
+
+* Initial version

data/COPYING

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Joe Yates
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,105 @@
+= rake-builder - Rake for C/C++/Objective-C/Objective-C++ Projects
+
+rake-builder provides a simple interface for building C, C++,
+Objective-C and Objective-C++ projects.
+It uses rake, which was created as a make replacement,
+and specializes it for the specific purpose of compiling
+single projects. 
+
+Projects are managed and built via a 'Rakefile'.
+
+Here is a typical example:
+
+ require 'rubygems' if RUBY_VERSION < '1.9'
+ require 'rake'
+ require 'rake/builder'
+ 
+ Rake::Builder.new do |builder|
+   builder.target               = 'my_program'
+   builder.source_search_paths  = [ 'src' ]
+   builder.header_search_paths  = [ 'include' ]
+ end
+
+= Installation
+
+ $ sudo gem install rake-builder
+
+= Hello World! Example
+
+See the 'examples' directory.
+
+The Hello World! project should build and run:
+
+ $ cd examples/01_hello_world_cpp
+ $ rake run
+ Hello World!
+
+= Usage
+
+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
+
+= Tasks
+
+You can list tasks as follows:
+
+ $ 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'
+
+= Online
+
+* 'Source code'[http://github.com/joeyates/rake-builder]
+* Documentation[http://rdoc.info/projects/joeyates/rake-builder]
+* Gem[http://rubygems.org/gems/rake-builder]
+
+= Limitations
+
+== File Modification Times
+
+Rake's FileTask decides whether a file needs rebuilding by comparing on disk file
+modification times (see the private method <em>out_of_date?</em>, which returns true if the
+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*
+which is not the correct answer.
+
+This problem is mostly felt in testing, where file modification times are temporarily
+modified to test dependencies. Also, tests wait for second to complete after building.
+
+=== File Modification Time Resolutions
+
+* Ext3[http://en.wikipedia.org/wiki/Ext3] - resolution: 1s
+* Ext4[http://en.wikipedia.org/wiki/Ext4] - resolution: 1 microsecond
+* Hierarchical_File_System[http://en.wikipedia.org/wiki/Hierarchical_File_System] - resolution: 1s
+* HFS_Plus[http://en.wikipedia.org/wiki/HFS_Plus] - resolution: 1s
+
+== Source Files with the Same Name
+
+Currently, object files from all source files are placed in the same directory.
+So, if there are two source files with the same name, they will overwrite each other.
+
+= Status
+
+* Builds C and C++ projects using gcc
+
+= Alternatives
+
+* make
+* CMake
+* Boost.Build
+* rakepp - another take on using rake for c++ projects
+
+= TODO
+
+* Objective-C/Objective-C++ builds
+* pre-compiled headers
+* parallel builds

data/Rakefile

@@ -0,0 +1,60 @@
+require 'rubygems' if RUBY_VERSION < '1.9'
+require 'rake'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require 'rake/rdoctask'
+$:.unshift( File.dirname( __FILE__ ) + '/lib' )
+require 'rake/builder'
+
+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_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.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' ]
+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
+
+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

data/examples/01_hello_world_cpp/Rakefile

@@ -0,0 +1,13 @@
+=begin
+
+= A Minimal Example for Rake-Builder
+
+=end
+
+require 'rubygems' if RUBY_VERSION < '1.9'
+require 'rake'
+require 'rake/builder'
+
+Rake::Builder.new do |builder|
+  builder.target = 'hello_world_cpp'
+end

data/examples/01_hello_world_cpp/main.cpp

@@ -0,0 +1,7 @@
+#include <iostream>
+
+int main(int argc, char *argv[]) {
+  std::cout << "Hello World!\n";
+
+  return 0;
+}

data/examples/02_hello_world_c/Rakefile

@@ -0,0 +1,8 @@
+require 'rubygems' if RUBY_VERSION < '1.9'
+require 'rake'
+require 'rake/builder'
+
+Rake::Builder.new do |builder|
+  builder.target               = 'hello_world_c'
+  builder.programming_language = 'c'
+end

data/examples/02_hello_world_c/main.c

@@ -0,0 +1,7 @@
+#include <stdio.h>
+
+int main(int argc, char *argv[]) {
+  printf( "Hello World!\n" );
+
+  return 0;
+}

data/examples/03_search_paths/Rakefile

@@ -0,0 +1,10 @@
+require 'rubygems' if RUBY_VERSION < '1.9'
+require 'rake'
+require 'rake/builder'
+
+Rake::Builder.new do |builder|
+  builder.target               = 'search-paths'
+  builder.source_search_paths  = [ 'src' ]
+  builder.header_search_paths  = [ 'include' ]
+  builder.objects_path         = '.'
+end

data/examples/03_search_paths/include/main.h

@@ -0,0 +1,7 @@
+#ifndef __MAIN_H__
+#define __MAIN_H__
+
+#include <stdio.h>
+#include <dirent.h>
+
+#endif // ndef __MAIN_H__

data/examples/03_search_paths/src/main.cpp

@@ -0,0 +1,17 @@
+#include "main.h"
+
+int main( int argc, char *argv[] ) {
+  printf( "The complete contents of this directory:\n" );
+
+  DIR *directory = opendir( "." );
+  if( directory == NULL ) {
+    puts( "Can't read directory" );
+    return 1;
+  }
+  while( struct dirent * file = readdir( directory ) ) {
+    puts( file->d_name );
+  }
+  closedir( directory );
+
+  return 0;
+}

data/examples/04_zlib/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems' if RUBY_VERSION < '1.9'
+require 'rake'
+require 'rake/builder'
+
+Rake::Builder.new do |builder|
+  builder.target               = 'zlib'
+  builder.programming_language = 'c'
+  builder.source_search_paths  = [ 'src' ]
+  builder.header_search_paths  = [ 'include' ]
+  builder.objects_path         = '.'
+  builder.library_dependencies << 'z'
+  builder.generated_files      << 'rake.gz'
+end

data/examples/04_zlib/include/main.h

@@ -0,0 +1,7 @@
+#ifndef __MAIN_H__
+#define __MAIN_H__
+
+#include <stdio.h>
+#include <zlib.h>
+
+#endif // ndef __MAIN_H__

data/examples/04_zlib/src/main.c

@@ -0,0 +1,11 @@
+#include "main.h"
+
+int main( int argc, char *argv[] ) {
+  gzFile gzip;
+
+  gzip = gzopen("rake.gz", "w");
+  gzprintf( gzip, "Hello!" );
+  gzclose( gzip );
+
+  return 0;
+}

data/examples/05_tests/Rakefile

@@ -0,0 +1,19 @@
+require 'rubygems' if RUBY_VERSION < '1.9'
+require 'rake'
+require 'rake/builder'
+
+Rake::Builder.new do |builder|
+  builder.target               = 'unit'
+  builder.source_search_paths  = [ 'src' ]
+  builder.header_search_paths  = [ 'include' ]
+end
+
+Rake::Builder.new do |builder|
+  builder.task_namespace       = 'test'
+  builder.target               = 'test_unit'
+  builder.source_search_paths  = [ 'test', 'src/units.*' ]
+  builder.header_search_paths  = [ 'include' ]
+  builder.objects_path         = 'test'
+  builder.compilation_options  = '-DDEBUG'
+end
+

data/examples/05_tests/include/main.h

@@ -0,0 +1,7 @@
+#ifndef __MAIN_H__
+#define __MAIN_H__
+
+#include <iostream>
+using namespace std;
+
+#endif // ndef __MAIN_H__

data/examples/05_tests/include/units.h

@@ -0,0 +1,18 @@
+#ifndef __UNITS_H__
+#define __UNITS_H__
+
+#include <ostream>;
+#include <string>;
+using namespace std;
+
+class Unit
+{
+  friend ostream &operator<<( ostream &out, Unit &unit );
+ public:
+  Unit() : name( "Mile" ) {}
+  string to_string();
+ private:
+  string name;
+};
+
+#endif // ndef __UNITS_H__

data/examples/05_tests/src/main.cpp

@@ -0,0 +1,9 @@
+#include "main.h"
+#include "units.h"
+
+int main( int argc, char *argv[] ) {
+  Unit unit;
+  cout << unit << endl;
+
+  return 0;
+}

data/examples/05_tests/src/units.cpp

@@ -0,0 +1,13 @@
+#include "units.h"
+
+ostream &operator<<( ostream &out, Unit &unit )
+{
+  out << unit.name;
+  return out;
+}
+
+string Unit::to_string()
+{
+  return name;
+}
+

data/examples/05_tests/test/test_unit.cpp

@@ -0,0 +1,12 @@
+#include <assert.h>
+#include <iostream>
+#include "units.h"
+
+int main( int argc, char *argv[] ) {
+  Unit unit;
+  assert( unit.to_string() == "Mile" );
+  cout << "." << endl;
+  cout << "All tests passed" << endl;
+
+  return 0;
+}

data/examples/06_hello_world_objective_c/Rakefile

@@ -0,0 +1,9 @@
+require 'rubygems' if RUBY_VERSION < '1.9'
+require 'rake'
+require 'rake/builder'
+
+Rake::Builder.new do |builder|
+  builder.target               = 'hello_world_objective_c'
+  builder.programming_language = 'objective-c'
+  builder.library_dependencies = ''
+end

data/examples/06_hello_world_objective_c/main.m

@@ -0,0 +1,7 @@
+#import <Foundation/Foundation.h> 
+
+int main(void)
+{
+  // NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
+  NSString *hello = @"Hello World!";
+}

data/examples/README.rdoc

@@ -0,0 +1,33 @@
+= Examples
+
+== 1. Hello World! in C++
+
+The Hello World! project should build and run as follows:
+
+ $ cd 01_hello_world_cpp
+ $ rake run
+ Hello World!
+
+This is the simplest possible type of project:
+- Only one source file,
+- Rakefile and source file in the same directory,
+- no non-standard header or library dependencies.
+
+== 2. Hello World! in C
+
+Same as the above, but for C.
+
+== 3. Search Paths
+
+Source files and headers in different directories
+
+== 4. Zlib
+
+Library dependencies.
+
+== 5. Main Project and Tests
+
+In this case, there are two build projects,
+one for the main executable and one for tests.
+
+The tests are in the 'test' namespace.