v3.0.1

CHANGELOG.md

@@ -1,3 +1,11 @@
+## v3.0.1
+
+### Fixes
+
+- #156 - Avoid running configure operation twice
+- #157 - Load configure task arguments before early configure operations
+- #158 - Do not configure for clean tasks when not yet configured
+
 ## v3.0.0
 
 - #136 - Move rsconscache into build directory

Rakefile.rb

@@ -35,7 +35,7 @@ task :dspec, [:example_string] => :build_dist do |task, args|
   FileUtils.mkdir_p("test")
   FileUtils.cp("dist/rscons", "test/rscons.rb")
   ENV["dist_specs"] = "1"
-  Rake::Task["spec"].execute(args.example_string)
+  Rake::Task["spec"].execute(args)
   ENV.delete("dist_specs")
   FileUtils.rm_f(Dir.glob(".rscons-*"))
 end

build_tests/configure/configure_with_top_level_env.rb

@@ -0,0 +1,6 @@
+configure do
+  check_c_compiler
+end
+env do |env|
+  puts "Prefix is #{Task["configure"]["prefix"]}"
+end

build_tests/simple/clean.rb

@@ -0,0 +1,7 @@
+env do |env|
+  env.Program('simple.exe', Dir['*.c'])
+end
+
+clean do
+  puts "custom clean action"
+end

doc/user_guide.md

@@ -446,6 +446,9 @@ end
 See ${#Configuring the Project} for more details on how to make use of the
 configuration functionality that Rscons provides.
 
+Configure blocks must be defined in the Rsconscript file before any
+environments are created.
+
 ####> Default Task
 
 The `default` task is special in that Rscons will execute it if no other task

lib/rscons/application.rb

@@ -73,6 +73,7 @@ module Rscons
     #   Process exit code (0 on success).
     def run(rsconscript, tasks_and_params, show_tasks, all_tasks, enabled_variants)
       Cache.instance["failed_commands"] = []
+      @tasks_and_params = tasks_and_params
       @enabled_variants = enabled_variants
       if enabled_variants == "" && !tasks_and_params.include?("configure")
         if cache_enabled_variants = Cache.instance["configuration_data"]["enabled_variants"]
@@ -80,13 +81,15 @@ module Rscons
         end
       end
       @script = Script.new
+      if should_load_script
         @script.load(rsconscript)
         enable_variants
+      end
       if show_tasks
         show_script_tasks(all_tasks)
         return 0
       end
-      apply_task_params(tasks_and_params)
+      apply_task_params(false)
       @task_execution_phase = true
       if tasks_and_params.empty?
         check_process_environments
@@ -169,8 +172,8 @@ module Rscons
     def distclean
       cache = Cache.instance
       clean
-      FileUtils.rm_rf(@build_dir)
       cache.clear
+      FileUtils.rm_rf(@build_dir)
     end
 
     # Check if the project needs to be configured.
@@ -179,6 +182,7 @@ module Rscons
     #
     # @return [void]
     def check_configure
+      apply_task_params(true)
       enable_variants
       unless Cache.instance["configuration_data"]["configured"]
         if @script.autoconf
@@ -207,6 +211,8 @@ module Rscons
     #
     # @return [void]
     def configure
+      unless @_configured
+        @_configured = true
         co = ConfigureOp.new(@script)
         begin
           @script.configure(co)
@@ -217,6 +223,7 @@ module Rscons
         Cache.instance["configuration_data"]["enabled_variants"] = @enabled_variants
         co.close(true)
       end
+    end
 
     # Remove installed files.
     #
@@ -375,8 +382,9 @@ module Rscons
       end
     end
 
-    def apply_task_params(tasks_and_params)
-      tasks_and_params.each do |task_name, task_params|
+    def apply_task_params(only_configure)
+      @tasks_and_params.each do |task_name, task_params|
+        unless only_configure && task_name != "configure"
           task_params.each do |param_name, param_value|
             if param = Task[task_name].params[param_name]
               Task[task_name].set_param_value(param_name, param_value)
@@ -386,6 +394,14 @@ module Rscons
           end
         end
       end
+    end
+
+    def should_load_script
+      return true if @tasks_and_params.empty?
+      return true if Cache.instance["configuration_data"]["configured"]
+      return false if (@tasks_and_params.keys - %w[distclean clean uninstall]).empty?
+      true
+    end
 
   end
 

lib/rscons/cache.rb

@@ -101,6 +101,7 @@ module Rscons
     #
     # @return [void]
     def write
+      return unless Dir.exist?(File.dirname(cache_file))
       @cache["version"] = VERSION
       File.open(cache_file, "w") do |fh|
         fh.puts(JSON.dump(@cache))

lib/rscons/version.rb

@@ -1,4 +1,4 @@
 module Rscons
   # Project version.
-  VERSION = "3.0.0"
+  VERSION = "3.0.1"
 end

rb/build_dist.rb

@@ -60,7 +60,13 @@ combined_file.each do |line|
   end
 end
 
-license = File.read("LICENSE.txt").gsub(/^/, "# ")
+license = File.read("LICENSE.txt").gsub(/^(.*?)$/) do |line|
+  if line.size > 0
+    "# #{line}"
+  else
+    "#"
+  end
+end
 
 require "zlib"
 require "base64"

spec/build_tests_spec.rb

@@ -372,6 +372,17 @@ EOF
       expect(File.exists?('simple.c')).to be_truthy
     end
 
+    it "executes custom clean action blocks" do
+      test_dir("simple")
+      result = run_rscons(args: %w[-f clean.rb])
+      expect(result.stderr).to eq ""
+      expect(File.exists?("build/e.1/simple.c.o")).to be_truthy
+      result = run_rscons(args: %w[-f clean.rb clean])
+      expect(result.stderr).to eq ""
+      expect(result.stdout).to match %r{custom clean action}
+      expect(File.exists?("build/e.1/simple.c.o")).to be_falsey
+    end
+
     it "does not process environments" do
       test_dir("simple")
       result = run_rscons(args: %w[clean])
@@ -1825,6 +1836,51 @@ EOF
       expect(result.status).to_not eq 0
     end
 
+    it "only runs the configure operation once" do
+      test_dir "configure"
+
+      result = run_rscons(args: %w[-f configure_with_top_level_env.rb configure])
+      expect(result.stderr).to eq ""
+      expect(result.status).to eq 0
+      expect(result.stdout).to_not match %r{Configuring project.*Configuring project}m
+    end
+
+    it "loads configure parameters before invoking configure" do
+      test_dir "configure"
+
+      result = run_rscons(args: %w[-f configure_with_top_level_env.rb configure --prefix=/yodabob])
+      expect(result.stderr).to eq ""
+      expect(result.status).to eq 0
+      expect(result.stdout).to match "Prefix is /yodabob"
+    end
+
+    it "does not configure for distclean operation" do
+      test_dir "configure"
+
+      result = run_rscons(args: %w[-f configure_with_top_level_env.rb distclean])
+      expect(result.stderr).to eq ""
+      expect(result.status).to eq 0
+      expect(result.stdout).to_not match %r{Configuring project}
+    end
+
+    it "does not configure for clean operation" do
+      test_dir "configure"
+
+      result = run_rscons(args: %w[-f configure_with_top_level_env.rb clean])
+      expect(result.stderr).to eq ""
+      expect(result.status).to eq 0
+      expect(result.stdout).to_not match %r{Configuring project}
+    end
+
+    it "does not configure for uninstall operation" do
+      test_dir "configure"
+
+      result = run_rscons(args: %w[-f configure_with_top_level_env.rb uninstall])
+      expect(result.stderr).to eq ""
+      expect(result.status).to eq 0
+      expect(result.stdout).to_not match %r{Configuring project}
+    end
+
     it "automatically runs the configure task if the project is not yet configured in the given build directory" do
       test_dir "configure"