Rakefile

# frozen_string_literal: true

# Copyright (c) 2014-2024 Yegor Bugayenko
#
# 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. The Software doesn't include files with .md extension.
# That files you are not allowed to copy, distribute, modify, publish, or sell.
#
# 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.

require 'rubygems'
require 'rake'
require 'fileutils'
require 'tempfile'
require 'rake/clean'
require 'scss_lint/rake_task'
require 'w3c_validators'
require 'nokogiri'
require 'rubocop/rake_task'
require 'English'
require 'net/http'
require 'html-proofer'

VERBOSE = false

raise "Invalid encoding \"#{Encoding.default_external}\"" unless Encoding.default_external.to_s == 'UTF-8'

task default: [
  :build,
  :pages,
  :garbage,
  :scss_lint,
  :spell,
  :regex,
  :excerpts,
  :snippets,
  :orphans,
  :ping,
  :eslint,
  # :jslint,
  # :proofer,
  :rubocop
]

def done(msg)
  puts "#{msg}\n\n"
end

def all_html
  Dir['_site/**/*.html']
    .reject { |f| f.end_with?('.amp.html') }
    .reject { |f| f.start_with?('_site/en/') }
    .reject { |f| f.start_with?('_site/zh/') }
    .reject { |f| f.start_with?('_site/ru/') }
end

def all_links
  links = all_html.reduce([]) do |array, f|
    array + Nokogiri::HTML(File.read(f)).xpath(
      '//article//a/@href'
    ).to_a.map(&:to_s)
  end
  links.sort.map { |a| a.gsub(%r{^/}, 'https://www.yegor256.com/') }
end

desc 'Delete _site directory'
task :clean do
  rm_rf '_site'
  rm_rf 'uml'
  rm_rf '.sass-cache'
  rm_rf '.jekyll-metadata'
  rm_rf '_temp'
  rm_rf 'gnuplot'
  done 'Jekyll temporary files and directories deleted'
end

desc 'Lint SASS sources'
SCSSLint::RakeTask.new do |t|
  FileUtils.mkdir_p('_temp')
  paths = []
  Dir['css/**/*.scss'].each do |css|
    name = File.basename(css)
    f = File.open("_temp/#{name}", 'w')
    f << File.open(css).drop(2).join("\n")
    f.flush
    f.close
    paths << f.path
  end
  paths += Dir['_sass/**/*.scss']
  t.files = Dir.glob(paths)
end

desc 'Build Jekyll site'
task :build do
  if File.exist? '_site'
    done 'Jekyll site already exists in _site (run "rake clean" first)'
  else
    puts 'Building Jekyll site...'
    system('jekyll build --trace --future')
    raise "Jekyll failed with #{$CHILD_STATUS}" unless $CHILD_STATUS.success?
    done 'Jekyll site generated without issues'
  end
end

desc 'Check the existence of all critical pages'
task pages: [:build] do
  File.open('_rake/pages.txt').map(&:strip).each do |p|
    file = "_site/#{p}"
    raise "Page/directory #{file} is not found (try to run 'rake clean' and start over)" unless File.exist?(file)
    puts "#{file}: OK" if VERBOSE
  end
  done 'All files are in place'
end

desc 'Check the absence of garbage'
task garbage: [:build] do
  File.open('_rake/garbage.txt').map(&:strip).each do |p|
    file = "_site/#{p}"
    raise "Page #{file} is still there" if File.exist? file
    puts "#{file}: absent, OK" if VERBOSE
  end
  %w[_posts static].each do |p|
    garbage = Dir["#{p}/**/*"].reject { |f| f.end_with?('.md') || !File.file?(f) }
    raise "Suspicious files in #{p}: #{garbage}" unless garbage.empty?
  end
  done 'There is no garbage'
end

desc 'Validate a few pages for W3C compliance'
# It doesn't work now, because of: https://github.com/alexdunae/w3c_validators/issues/16
task w3c: [:build] do
  include W3CValidators
  validator = MarkupValidator.new
  [
    'index.html',
    '2014/04/06/introduction.html'
  ].each do |p|
    file = "_site/#{p}"
    results = validator.validate_file(file)
    if results.errors.length.positive?
      results.errors.each do |err|
        puts err
      end
      raise "Page #{file} is not W3C compliant"
    end
    puts "#{p}: OK" if VERBOSE
  end
  done 'HTML is W3C compliant'
end

desc 'Validate a few pages through HTML proofer'
task proofer: [:build] do
  HTMLProofer.check_directory(
    '_site',
    only_4xx: true,
    disable_external: true,
    log_level: :warn,
    validation: {
      report_invalid_tags: false,
      report_missing_names: true,
      report_script_embeds: true
    },
    parallel: {
      in_processes: 8
    },
    check_favicon: true,
    check_html: true,
    file_ignore: [
      '_site/2009/03/04/pdd.html',
      '_site/2017/05/02/unlimited-number-of-bugs.html'
    ]
  ).run
  done 'HTML passed through html-proofer'
end

desc 'Check spelling in all HTML pages'
task spell: [:build] do
  bad_pages = 0
  bad_words = []
  typos = all_html.reduce(0) do |total, f|
    html = Nokogiri::HTML(File.read(f))
    html.search('//code').remove
    html.search('//script').remove
    html.search('//pre').remove
    html.search('//div[@class="nospell"]').remove
    html.search('//header').remove
    html.search('//footer').remove
    tmp = Tempfile.new(['yegor256-', '.txt'])
    text = html.xpath('//article//p|//article//h2|//article//h3').to_a.join(' ')
      .gsub(/[\n\r\t ]+/, ' ')
      .gsub(/&[a-z]+;/, ' ')
      .gsub(/&#[0-9]+;/, ' ')
      .gsub(/n[’']t/, ' not')
      .gsub(/[’']ll/, ' will')
      .gsub(/[’']ve/, ' have')
      .gsub(/[’']s/, ' ')
      .gsub(/[,:;<>?!-#$%^&@]+/, ' ')
    tmp << text
    tmp.flush
    tmp.close
    stdout = `cat "#{tmp.path}" \
      | aspell -a --lang=en_US -W 3 --ignore-case --encoding=utf-8 -p ./_rake/aspell.en.pws \
      | grep ^\\&`
    found = 0
    if stdout.empty?
      puts "#{f}: OK (#{text.split.size} words)" if VERBOSE
    else
      lines = stdout.split("\n")
      found = lines.size
      words = lines.map { |t| t.split[1] }
      bad_words += words
      puts "#{found} typos in #{f}: #{words.join(', ')}"
      puts stdout
      puts text if VERBOSE
      bad_pages += 1
    end
    total + found
  end
  unless typos.zero?
    puts "All typos:\n  #{bad_words.uniq.join("\n  ")}"
    raise "#{typos.size} typo(s) in #{bad_pages} pages"
  end
  done 'No spelling errors'
end

desc 'Ping some foreign links'
task ping: [:build] do
  links = all_links.uniq
    .reject { |a| a.start_with? 'https://www.yegor256.com/' }
    .reject { |a| a.include? 'linkedin.com' }
    .select { |a| (a =~ %r{^https?://.*}) }
    .reject { |a| a.start_with? 'http://localhost' }
    .reject { |a| a.start_with? 'https://www.youtube.com/watch?v=' }
    .shuffle
    .take(128)
  tmp = Tempfile.new(['yegor256-', '.txt'])
  tmp << links.join("\n")
  tmp.flush
  tmp.close
  out = Tempfile.new(['yegor256-', '.txt'])
  out.close
  puts "#{links.size} links found, testing them..."
  system("./_rake/ping.sh #{tmp.path} #{out.path}")
  errors = File.read(out).split("\n").reduce(0) do |cnt, p|
    code, link = p.split
    next nil if link.nil?
    if code == '200'
      cnt
    else
      puts "#{link}: #{code}"
      cnt + 1
    end
  end
  total = links.size
  per = (100 * errors / total).to_i
  raise "#{errors} among #{total} links are broken (#{per}%)" unless per < 16
  done "#{total} links are found, #{errors} are broken, it's more or less OK (#{per}%)"
end

desc 'Run RuboCop on all Ruby files'
RuboCop::RakeTask.new do |t|
  t.fail_on_error = true
  t.requires << 'rubocop-rspec'
end

desc 'Test all JavaScript files with JSLint'
task :jslint do
  Dir['js/**/*.js'].each do |f|
    puts "jslint #{f}..."
    stdout = `jslint #{f}`
    raise "jslint failed at #{f}:\n#{stdout}" unless $CHILD_STATUS.success?
  end
  done 'JSLint says JavaScript files are clean'
end

desc 'Test all JavaScript files with ESLint'
task :eslint do
  Dir['js/**/*.js'].each do |f|
    puts "eslint #{f}..."
    if f.include?('min.js')
      puts '  skipped'
      next
    end
    stdout = `eslint #{f}`
    raise "eslint failed at #{f}:\n#{stdout}" unless $CHILD_STATUS.success?
  end
  done 'ESLint says JavaScript files are clean'
end

desc 'Make sure all pages have excerpts'
task :excerpts do
  Dir['_posts/**/*.md'].each do |f|
    raise "No excerpt in #{f}" unless File.read(f).include? '<!--more-->'
  end
  done 'All articles have excerpts'
end

desc 'Make sure there are no prohibited RegEx-es in generated HTMLs'
task regex: [:build] do
  ptns = [
    /\s—\s[a-zA-Z]/,
    /("|&quot;)[,.?!]/,
    /\s&mdash;/,
    /&mdash;\s/
  ]
  errors = 0
  pages = 0
  all_html.each do |f|
    html = Nokogiri::HTML(File.read(f))
    html.search('//code').remove
    html.search('//script').remove
    html.search('//pre').remove
    text = html.xpath('//article//p').to_a.join(' ')
    ptns.each do |re|
      if re.match text
        puts "#{f}: #{re} found and it's prohibited"
        errors += 1
      end
    end
    pages += 1
  end
  raise "#{errors} violations of RegEx prohibition" unless errors.zero?
  done "No prohibited regular expressions in #{pages} pages"
end

desc 'Make sure all snippets are compact enough'
task :snippets do
  all_html.each do |f|
    lines = Nokogiri::HTML(File.read(f)).xpath(
      '//article//figure[@class="highlight"]/pre/code[not(contains(@class,"text"))]'
    ).to_a.map(&:to_s)
      .join("\n")
      .gsub(/<code [^>]+>/, '')
      .gsub(/<span class="[A-Za-z0-9-]+">/, '')
      .gsub(/<a href="[^"]+">/, '')
      .gsub(%r{</a>}, '')
      .gsub(%r{</code>}, "\n")
      .gsub(%r{</span>}, '')
      .gsub('&lt;', '<')
      .gsub('&gt;', '>')
      .split("\n")
    long = lines.reject { |s| s.length < 81 }
    raise "Too wide snippet in #{f}: #{long}" unless long.empty?
    puts "#{f}: OK (#{lines.size} lines)" if VERBOSE
  end
  done 'All snippets are compact enough'
end

desc 'Make sure there are no orphan articles (nobody cites them)'
task orphans: [:build] do
  prefix = 'https://www.yegor256.com/'
  links = all_links
    .select { |a| a.start_with? prefix }
    .map { |a| a.gsub(/#.*/, '') }
  links += all_html.map { |f| f.gsub('_site', 'https://www.yegor256.com') }
  counts = {}
  links
    .select { |a| a.match %r{.*/[0-9]{4}/[0-9]{2}/[0-9]{2}/.*} }
    .reject { |a| a.end_with? '.amp.html' }
    .reject { |a| a.include? '2009/03/04/pdd' }
    .reject { |a| a.include? '2017/05/02/unl' }
    .group_by(&:itself)
    .each { |k, v| counts[k] = v.length }
  orphans = 0
  counts.each do |k, v|
    if v < 4
      puts "#{k} is an orphan (#{v})"
      orphans += 1
    else
      puts "#{k}: #{v}"
    end
  end
  raise "There are #{orphans} orphans" unless orphans.zero?
  done "There are no orphans in #{links.size} links"
end