v0.0.6

build_tests/custom_builder/build.rb

@@ -1,5 +1,5 @@
 class MySource < Rscons::Builder
-  def run(target, sources, cache, env)
+  def run(target, sources, cache, env, vars = {})
     File.open(target, 'w') do |fh|
       fh.puts <<EOF
 #define THE_VALUE 5678

build_tests/library/build.rb

@@ -0,0 +1,4 @@
+Rscons::Environment.new(echo: :command) do |env|
+  env.Program('library', ['lib.a', 'three.c'])
+  env.Library("lib.a", ['one.c', 'two.c'], 'CPPFLAGS' => ['-Dmake_lib'])
+end

build_tests/library/one.c

@@ -0,0 +1,8 @@
+#include <stdio.h>
+
+#ifdef make_lib
+int main(int argc, char *argv[])
+{
+    printf("Library\n");
+}
+#endif

build_tests/two_sources/build.rb

@@ -0,0 +1,4 @@
+Rscons::Environment.new(echo: :command) do |env|
+  env.Object("one.o", "one.c", 'CPPFLAGS' => ['-DONE'])
+  env.Program('two_sources', ['one.o', 'two.c'])
+end

build_tests/two_sources/one.c

@@ -0,0 +1,8 @@
+#include <stdio.h>
+
+#ifdef ONE
+int main(int argc, char *argv[])
+{
+    printf("This is a C program with two sources.\n");
+}
+#endif

build_tests/two_sources/two.c

@@ -0,0 +1,3 @@
+#ifdef ONE
+#error ONE should not be defined
+#endif

lib/rscons.rb

@@ -8,13 +8,18 @@ require "rscons/monkey/module"
 require "rscons/monkey/string"
 
 # default builders
+require "rscons/builders/library"
 require "rscons/builders/object"
 require "rscons/builders/program"
 
 # Namespace module for rscons classes
 module Rscons
   DEFAULT_BUILDERS = [
+    Library,
     Object,
     Program,
   ]
+
+  class BuildError < Exception
+  end
 end

lib/rscons/builders/library.rb

@@ -0,0 +1,33 @@
+require 'fileutils'
+
+module Rscons
+  # A default RScons builder that produces a static library archive.
+  class Library < Builder
+    def default_variables(env)
+      {
+        'AR' => 'ar',
+        'LIBSUFFIX' => '.a',
+        'ARFLAGS' => [],
+        'ARCOM' => ['$AR', 'rcs', '$ARFLAGS', '$TARGET', '$SOURCES']
+      }
+    end
+
+    def run(target, sources, cache, env, vars = {})
+      # build sources to linkable objects
+      objects = env.build_sources(sources, [env['OBJSUFFIX'], env['LIBSUFFIX']].flatten, cache, vars)
+      if objects
+        vars = vars.merge({
+          'TARGET' => target,
+          'SOURCES' => objects,
+        })
+        command = env.build_command(env['ARCOM'], vars)
+        unless cache.up_to_date?(target, command, objects)
+          FileUtils.rm_f(target)
+          return false unless env.execute("AR #{target}", command)
+          cache.register_build(target, command, objects)
+        end
+        target
+      end
+    end
+  end
+end

lib/rscons/builders/object.rb

@@ -38,12 +38,12 @@ module Rscons
         source.has_suffix?(env['CXXSUFFIX']))
     end
 
-    def run(target, sources, cache, env)
+    def run(target, sources, cache, env, vars = {})
-      vars = {
+      vars = vars.merge({
         'TARGET' => target,
         'SOURCES' => sources,
         'DEPFILE' => target.set_suffix('.mf'),
-      }
+      })
       com_prefix = if sources.first.has_suffix?(env['ASSUFFIX'])
                      'AS'
                    elsif sources.first.has_suffix?(env['CSUFFIX'])

lib/rscons/builders/program.rb

@@ -8,34 +8,25 @@ module Rscons
         'OBJSUFFIX' => '.o',
         'LIBSUFFIX' => '.a',
         'LDFLAGS' => [],
-        'LIBPATHS' => [],
+        'LIBPATH' => [],
         'LIBS' => [],
-        'LDCOM' => ['$LD', '-o', '$TARGET', '$LDFLAGS', '$SOURCES', '-L$[LIBPATHS]', '-l$[LIBS]']
+        'LDCOM' => ['$LD', '-o', '$TARGET', '$LDFLAGS', '$SOURCES', '-L$[LIBPATH]', '-l$[LIBS]']
       }
     end
 
-    def run(target, sources, cache, env)
+    def run(target, sources, cache, env, vars = {})
-      # convert sources to object file names
+      # build sources to linkable objects
-      objects = sources.map do |source|
+      objects = env.build_sources(sources, [env['OBJSUFFIX'], env['LIBSUFFIX']].flatten, cache, vars)
-        if source.has_suffix?([env['OBJSUFFIX'], env['LIBSUFFIX']])
-          source
-        else
-          o_file = env.get_build_fname(source, env['OBJSUFFIX', :string])
-          builder = env.builders.values.find { |b| b.produces?(o_file, source, env) }
-          builder or raise "No builder found to convert input source #{source.inspect} to an object file."
-          builder.run(o_file, [source], cache, env) or break
-        end
-      end
       if objects
         use_cxx = sources.map do |s|
           s.has_suffix?(env['CXXSUFFIX'])
         end.any?
         ld_alt = use_cxx ? env['CXX'] : env['CC']
-        vars = {
+        vars = vars.merge({
           'TARGET' => target,
           'SOURCES' => objects,
           'LD' => env['LD'] || ld_alt,
-        }
+        })
         command = env.build_command(env['LDCOM'], vars)
         unless cache.up_to_date?(target, command, objects)
           return false unless env.execute("LD #{target}", command)

lib/rscons/cache.rb

@@ -80,6 +80,7 @@ module Rscons
     # @return true value if the target is up to date, meaning that:
     #   - the target exists on disk
     #   - the cache has information for the target
+    #   - the target's checksum matches its checksum when it was last built
     #   - the command used to build the target is the same as last time
     #   - all dependencies listed are also listed in the cache, or, if
     #     :strict_deps was given in options, the list of dependencies is
@@ -93,6 +94,9 @@ module Rscons
       # target must be registered in the cache
       return false unless @cache[:targets].has_key?(target)
 
+      # target must have the same checksum as when it was built last
+      return false unless @cache[:targets][target][:checksum] == lookup_checksum(target)
+
       # command used to build target must be identical
       return false unless @cache[:targets][target][:command] == command
 
@@ -141,7 +145,7 @@ module Rscons
     # Calculate and return a file's checksum
     # @param file [String] The file name.
     def calculate_checksum(file)
-      @lookup_checksums[file] = Digest::MD5.hexdigest(File.read(file)).encode(__ENCODING__) rescue ''
+      @lookup_checksums[file] = Digest::MD5.hexdigest(File.read(file, {mode: 'rb'})).encode(__ENCODING__) rescue ''
     end
   end
 end

lib/rscons/environment.rb

@@ -20,7 +20,7 @@ module Rscons
       @varset = VarSet.new(variables)
       @targets = {}
       @builders = {}
-      @build_dirs = {}
+      @build_dirs = []
       @varset[:exclude_builders] ||= []
       unless @varset[:exclude_builders] == :all
         exclude_builders = Set.new(@varset[:exclude_builders] || [])
@@ -52,9 +52,6 @@ module Rscons
       @builders.each do |builder_name, builder|
         env.add_builder(builder)
       end
-      @build_dirs.each do |src_dir, obj_dir|
-        env.build_dir(src_dir, obj_dir)
-      end
       env.append(@varset)
       env.append(variables)
 
@@ -79,7 +76,9 @@ module Rscons
     # Specify a build directory for this Environment.
     # Source files from src_dir will produce object files under obj_dir.
     def build_dir(src_dir, obj_dir)
-      @build_dirs[src_dir.gsub('\\', '/')] = obj_dir.gsub('\\', '/')
+      src_dir = src_dir.gsub('\\', '/') if src_dir.is_a?(String)
+      obj_dir = obj_dir.gsub('\\', '/')
+      @build_dirs << [src_dir, obj_dir]
     end
 
     # Return the file name to be built from source_fname with suffix suffix.
@@ -89,8 +88,13 @@ module Rscons
     def get_build_fname(source_fname, suffix)
       build_fname = source_fname.set_suffix(suffix).gsub('\\', '/')
       @build_dirs.each do |src_dir, obj_dir|
+        if src_dir.is_a?(Regexp)
+          build_fname.sub!(src_dir, obj_dir)
+        else
           build_fname.sub!(/^#{src_dir}\//, "#{obj_dir}/")
         end
+        build_fname.gsub!('\\', '/')
+      end
       FileUtils.mkdir_p(File.dirname(build_fname))
       build_fname
     end
@@ -137,7 +141,7 @@ module Rscons
                                          @targets[target][:source],
                                          cache,
                                          self,
-                                         *@targets[target][:args])
+                                         @targets[target][:vars] || {})
         else
           false
         end
@@ -145,8 +149,8 @@ module Rscons
       @targets.each do |target, info|
         next if targets_processed.include?(target)
         unless process_target.call(target)
-          $stderr.puts "Error: failed to build #{target}"
+          cache.write
-          break
+          raise BuildError.new("Failed to build #{target}")
         end
       end
       cache.write
@@ -189,11 +193,15 @@ module Rscons
     alias_method :orig_method_missing, :method_missing
     def method_missing(method, *args)
       if @builders.has_key?(method.to_s)
-        target, source, *rest = args
+        target, source, vars, *rest = args
+        unless vars.nil? or vars.is_a?(Hash) or vars.is_a?(VarSet)
+          raise "Unexpected construction variable set: #{vars.inspect}"
+        end
         source = [source] unless source.is_a?(Array)
         @targets[target] = {
           builder: @builders[method.to_s],
           source: source,
+          vars: vars,
           args: rest,
         }
       else
@@ -212,10 +220,11 @@ module Rscons
         if line =~ /^(.*)\\\s*$/
           buildup += ' ' + $1
         else
-          if line =~ /^(.*): (.*)$/
+          buildup += ' ' + line
-            target, tdeps = $1.strip, $2
+          if buildup =~ /^(.*): (.*)$/
-            if target == target
+            mf_target, mf_deps = $1.strip, $2
-              deps += tdeps.split(' ').map(&:strip)
+            if mf_target == target
+              deps += mf_deps.split(' ').map(&:strip)
             end
           end
           buildup = ''
@@ -223,5 +232,32 @@ module Rscons
       end
       deps
     end
+
+    # Build a list of source files into files containing one of the suffixes
+    # given by suffixes.
+    # This method is used internally by RScons builders.
+    # @param sources [Array] List of source files to build.
+    # @param suffixes [Array] List of suffixes to try to convert source files into.
+    # @param cache [Cache] The Cache.
+    # Return a list of the converted file names.
+    def build_sources(sources, suffixes, cache, vars = {})
+      sources.map do |source|
+        if source.has_suffix?(suffixes)
+          source
+        else
+          converted = nil
+          suffixes.each do |suffix|
+            converted_fname = get_build_fname(source, suffix)
+            builder = @builders.values.find { |b| b.produces?(converted_fname, source, self) }
+            if builder
+              converted = builder.run(converted_fname, [source], cache, self, vars)
+              return nil unless converted
+              break
+            end
+          end
+          converted or raise "Could not find a builder to handle #{source.inspect}."
+        end
+      end
+    end
   end
 end

lib/rscons/monkey/string.rb

@@ -6,6 +6,7 @@ class String
   def has_suffix?(suffix)
     if suffix
       suffix = [suffix] if suffix.is_a?(String)
+      suffix = suffix.flatten
       suffix.find {|s| self.end_with?(s)}
     end
   end

lib/rscons/varset.rb

@@ -8,8 +8,12 @@ module Rscons
     # Create a VarSet
     # @param vars [Hash] Optional initial variables.
     def initialize(vars = {})
+      if vars.is_a?(VarSet)
+        @vars = vars.clone.vars
+      else
         @vars = vars
       end
+    end
 
     # Access the value of variable as a particular type
     # @param key [String, Symbol] The variable name.

lib/rscons/version.rb

@@ -1,4 +1,4 @@
 module Rscons
   # gem version
-  VERSION = "0.0.1"
+  VERSION = "0.0.6"
 end

rscons.gemspec

@@ -10,7 +10,8 @@ Gem::Specification.new do |gem|
   gem.email         = ["jholtrop@gmail.com"]
   gem.description   = %q{Software construction library inspired by SCons and implemented in Ruby}
   gem.summary       = %q{Software construction library inspired by SCons and implemented in Ruby}
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/holtrop/rscons"
+  gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

spec/build_tests_spec.rb

@@ -143,4 +143,27 @@ describe Rscons do
     `./simple`.should == "This is a simple C++ program\n"
   end
 
+  it 'allows overriding construction variables for individual builder calls' do
+    lines = test_dir('two_sources')
+    lines.should == [
+      'gcc -c -o one.o -MMD -MF one.mf -DONE one.c',
+      'gcc -c -o two.o -MMD -MF two.mf two.c',
+      'gcc -o two_sources one.o two.o',
+    ]
+    File.exists?('two_sources').should be_true
+    `./two_sources`.should == "This is a C program with two sources.\n"
+  end
+
+  it 'builds a static library archive' do
+    lines = test_dir('library')
+    lines.should == [
+      'gcc -c -o one.o -MMD -MF one.mf -Dmake_lib one.c',
+      'gcc -c -o two.o -MMD -MF two.mf -Dmake_lib two.c',
+      'ar rcs lib.a one.o two.o',
+      'gcc -c -o three.o -MMD -MF three.mf three.c',
+      'gcc -o library lib.a three.o',
+    ]
+    File.exists?('library').should be_true
+    `ar t lib.a`.should == "one.o\ntwo.o\n"
+  end
 end

spec/rscons/environment_spec.rb

@@ -0,0 +1,24 @@
+module Rscons
+  describe Environment do
+    describe '.parse_makefile_deps' do
+      it 'handles dependencies on one line' do
+        File.should_receive(:read).with('makefile').and_return(<<EOS)
+module.o: source.cc
+EOS
+        env = Environment.new
+        env.parse_makefile_deps('makefile', 'module.o').should == ['source.cc']
+      end
+
+      it 'handles dependencies split across many lines' do
+        File.should_receive(:read).with('makefile').and_return(<<EOS)
+module.o: module.c \\
+  module.h \\
+  other.h
+EOS
+        env = Environment.new
+        env.parse_makefile_deps('makefile', 'module.o').should == [
+          'module.c', 'module.h', 'other.h']
+      end
+    end
+  end
+end