Merge pull request #2202 from basho/dpb/build_system_improvements

Misc Build System Improvements

Author: pyrrho

Rakefile

@@ -55,15 +55,19 @@ task      :clean => ['clean:js', 'clean:css']
 namespace :clean do
   desc "Clean dynamically generated JS"
   task :js do
-    js_file_list = Dir["#{$js_dest}/**/**"]
+    # The standalone/ directory may exist if we've extracted archived content
+    # (see deploy:fetch_archived_content). We don't want to remove those files.
+    js_file_list = Dir["#{$js_dest}/**/*"].reject {|f| /standalone/.match(f) }
     js_file_list.each do |f|
       log_deletion(f)
       FileUtils.rm(f)
     end
   end
   desc "Clean dynamically generated CSS"
   task :css do
-    css_file_list = Dir["#{$css_dest}/**/**"]
+    # The standalone/ directory may exist if we've extracted archived content
+    # (see deploy:fetch_archived_content). We don't want to remove those files.
+    css_file_list = Dir["#{$css_dest}/**/*"].reject {|f| /standalone/.match(f) }
     css_file_list.each do |f|
       log_deletion(f)
       FileUtils.rm(f)
@@ -88,13 +92,14 @@ namespace :build do
   ################
   # Build : Debug
   desc      "Compile human-readable JS and compile human-readable CSS"
-  task      :debug => ['clean', 'build:debug:js', 'build:debug:css']
+  task      :debug => ["#{$js_dest}", "#{$css_dest}",
+                       'build:debug:js', 'build:debug:css']
   namespace :debug do
     desc "Compile human-readable JS"
-    task :js  => ["#{$js_dest}", 'clean:js']   do compile_js(debug: true); end
+    task :js  => ["#{$js_dest}"]  do compile_js(debug: true); end
 
     desc "Compile human-readable CSS"
-    task :css => ["#{$css_dest}", 'clean:css'] do compile_css(debug: true); end
+    task :css => ["#{$css_dest}"] do compile_css(debug: true); end
   end
 end
 

dynamic/Guardfile

@@ -29,8 +29,8 @@ directories %w(dynamic data) \
 
 group :js do
   guard 'rake', :task => 'build:js' do
-    watch(%r{^dynamic/js/.*$})
-    watch(%r{^data/versions.yml})
+    watch(%r{^dynamic/js/.*\.js$})
+    watch(%r{^dynamic/js/.*\.coffee$})
   end
 end
 
@@ -44,8 +44,8 @@ end
 
 group :debug_js do
   guard 'rake', :task => 'build:debug:js' do
-    watch(%r{^dynamic/js/.*$})
-    watch(%r{^data/versions.yml})
+    watch(%r{^dynamic/js/.*\.js$})
+    watch(%r{^dynamic/js/.*\.coffee$})
   end
 end
 

rake_libs/s3_deploy.rb

@@ -6,7 +6,7 @@
 def do_fetch_archived_content()
   # Fetch and extract the archived content that we want to survive from the
   # Middleman website.
-  puts("Verifying archived content...")
+  puts("Verifying the archived tarball is present and correct...")
   # Verify that the tar.bz2 is present.
   if (not File.file?(File.join(Dir.pwd, "#{$archive_name}")))
     if (`which wget`.empty?)
@@ -57,32 +57,42 @@ def do_fetch_archived_content()
     end
   end
 
-  puts("Verifying archived content extraction...")
-  puts("    Please note, this only checks for directories.\n"\
-       "    If something went wrong with a previous extraction or if any "\
-       "of the extracted files were modified, please run \`git clean "\
-       "-xdf static/\` and re-run this deploy script.")
-  #TODO: Consider if this is a good idea or not. I'm leaning towards not.
-  should_extract = (
-    (not File.exist?("static/css/standalone")) ||
-    (not File.exist?("static/js/standalone"))  ||
-    (not File.exist?("static/riak"))           ||
-    (not File.exist?("static/riakcs"))         ||
-    (not File.exist?("static/riakee"))         ||
-    (not File.exist?("static/shared"))           )
-
-  if (should_extract)
+  puts("Verifying archived content extraction by checking direcotry tree...")
+  all_dirs_present = ( (File.exist?("static/css/standalone")) &&
+                       (File.exist?("static/js/standalone"))  &&
+                       (File.exist?("static/riak/1.4.12"))    &&
+                       (File.exist?("static/riakcs/1.5.4"))   &&
+                       (File.exist?("static/riakee"))         &&
+                       (File.exist?("static/shared"))           )
+  any_dirs_present = ( (File.exist?("static/css/standalone")) ||
+                       (File.exist?("static/js/standalone"))  ||
+                       (File.exist?("static/riak/1.4.12"))    ||
+                       (File.exist?("static/riakcs/1.5.4"))   ||
+                       (File.exist?("static/riakee"))         ||
+                       (File.exist?("static/shared"))           )
+  if (not all_dirs_present and any_dirs_present)
+    Kernel.abort("ERRPR: The static/ directory is verifiably corrupt.\n"\
+                 "       Please run \`git clean -xdf static/\` to clear out "\
+                 "the malformed files, and re-run this deploy script.")
+  elsif (not any_dirs_present)
     puts("Extracting #{$archive_name} (this may take a lot of time)...")
     successful = system("tar -xjf #{$archive_name} -C static")
-
     if (not successful)
       Kernel.abort("ERROR: #{$archive_name} failed to extract.\n"\
-                   "       I... actually don't know why. Not sure how to "\
-                   "extract error messages from this system call.")
+                   "       The failure message should have been printed to "\
+                   "stdout and be visible above.")
     end
+  else
+    puts("    Archived content directory tree verified.\n"\
+         "    NOTE: File integrity is NOT checked here.\n"\
+         "          As such, it is advisable to periodically clean out the "\
+         "static/ directory that this archive is extracted into.\n"\
+         "          To do so, please run \`git clean -xdf static/\`, and "\
+         "re-run this deploy script.")
   end
 end
 
+
 # Once the Hugo site has been fully and correctly generated, we can upload the
 # updated and new -- and delete the no longer generated -- files to/from our S3
 # bucket, and send out CloudFront invalidation requests to propagate those