Rakefile

require 'json'
require 'html-proofer'
require 'mdl'

Rake::TaskManager.record_task_metadata = true
SEARCH_JSON_PATH = "./_site/search/search.json"

desc "build site for production purposes"
task :build_for_prod => [] do |task|
  puts "rake> " + task.name + ": " + task.comment
  ENV["RAKE_BUILD_FOR"] = "prod"
  sh "bundle exec jekyll build --trace --config \"_config.yml\""
  puts "rake> " + task.name + ": OK!"
end

desc "rebuild generated search json"
task :rebuild_search_json => [] do |task|
  puts "rake> " + task.name + ": " + task.comment
  search_json_string = File.read(SEARCH_JSON_PATH)
  search_json = JSON.parse(search_json_string)
  search_json_string_again = JSON.pretty_generate(search_json, { :indent => ' ' })
  File.write(SEARCH_JSON_PATH, search_json_string_again)
  puts "rake> " + task.name + ": OK!"
end

desc "production build for deployment"
task :prod => [:build_for_prod, :rebuild_search_json] do |task|
  puts "rake> " + task.name + ": " + task.comment
  puts "rake> " + task.name + ": OK!"
end

desc "development mode where full site is rebuilt each time a file is saved"
task :dev => [] do |task|
  puts "rake> " + task.name + ": " + task.comment
  ENV["RAKE_BUILD_FOR"] = "dev"
  sh "bundle exec jekyll serve --trace --config \"_config.yml,_config.localhost.yml\""
end

desc "development mode where site is incrementally rebuilt each time a file is saved"
task :devi => [] do |task|
  puts "rake> " + task.name + ": " + task.comment
  ENV["RAKE_BUILD_FOR"] = "dev"
  sh "bundle exec jekyll serve --incremental --trace --config \"_config.yml,_config.localhost.yml\""
end

desc "build site for testing purposes"
task :build_for_test => [] do |task|
  puts "rake> " + task.name + ": " + task.comment
  ENV["RAKE_BUILD_FOR"] = "dev"
  sh "bundle exec jekyll build --config \"_config.yml,_config.localhost.yml\""
  puts "rake> " + task.name + ": OK!"
end

desc "check if generated search json file is ok"
task :test_search_json => [] do |task|
  puts "rake> " + task.name + ": " + task.comment
  search_json_string = File.read(SEARCH_JSON_PATH)
  # JSON.parse throws an error if file is invalid JSON
  JSON.parse(search_json_string)
  puts "rake> " + task.name + ": OK!"
end

desc "check if built html is ok, note that this is slow"
task :test_html_proofer => [] do |task|
  puts "rake> " + task.name + ": " + task.comment

  options = {
    # check external links no more often than this
    # disabled because of "ArgumentError: invalid byte sequence in UTF-8"
    # :cache => { :timeframe => "1w" },

    # re-enable external checks when we get caching working
    :disable_external => true,

    # redirect links specify the domain,
    # and thus by default get treated as an external links,
    # so override this to treat them as internal links as they should be
    :internal_domains => ["localhost:4000"],

    :allow_hash_href => true,

    :alt_ignore => true,

    :empty_alt_ignore => true,

    # this sie contains "share by email" links,
    # which use "mailto:" without a to-address,
    # thus override this check
    :url_ignore => [/^mailto:\?subject=/]
  }
  unless Gem.win_platform?
    # Process.fork is not suppported on some windows Rubies
    options.merge!({
      # run checks in parallel to speed up tests
      :parallel => { :in_processes => 8 },
    })
  end

  HTMLProofer.check_directory("./_site", options).run
  puts "rake> " + task.name + ": OK!"
end

desc "lint markdown"
task :lint_markdown => [] do |task|
  puts "rake> " + task.name + ": " + task.comment
  sh "bundle exec mdl --config \".mdlrc\" \"README.md\" \"_quick-start\""
  puts "rake> " + task.name + ": OK!"
end

desc "run all tasks related to testing"
task :test => [:lint_markdown, :rebuild_search_json, :test_search_json, :test_html_proofer] do |task|
  puts "rake> " + task.name + ": " + task.comment
  puts "rake> " + task.name + ": OK!"
end

desc "ci"
task :ci => [:lint_markdown, :prod, :test_search_json, :test_html_proofer] do |task|
  puts "rake> " + task.name + ": " + task.comment
  puts "rake> " + task.name + ": OK!"
end