Refactor book:build task

progit/progit2#1598

Co-authored-by: Bagas Sanjaya <[email protected]>

Author: srgizh

README.asc

@@ -10,14 +10,13 @@ image:https://travis-ci.org/progit/progit2-ru.svg?branch=master["Build Status",
 
 С момента публикации первого издания многое изменилось.
 Для начала, мы перешли с Markdown на AsciiDoc -- вот краткий справочник по синтаксису https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/[AsciiDoc].
-К тому же мы теперь используем https://atlas.oreilly.com[Atlas] от О'Рейли для постоянной сборки книги, так что все основные форматы всегда в наличии.
 
 Еще мы убрали переводы из подразделов английского языка в отдельные репозитории.
 Подробнее в пункте про переводы.
 
 == Участие
 
-Чтобы исправить ошибку или добавить что-то новое в этот репозиторий, вам нужно открыть пулл-реквест на GitHub.
+Чтобы исправить ошибку или добавить что-то новое в этот репозиторий, вам нужно открыть запрос на изменение (Pull Request) на GitHub.
 
 Несмотря на то, что в английской версии просят воздержаться от стилистических изменений на больших участках текста, русский перевод профессиональные редакторы не просматривали, будем рады вашим правкам.
 
@@ -27,10 +26,11 @@ image:https://travis-ci.org/progit/progit2-ru.svg?branch=master["Build Status",
 
 Самый простой -- поручить это нам. Робот реагирует на изменения в ветке `master` репозитория и автоматически собирает книгу во всех форматах.
 
-Текущую сборку можно найти на https://git-scm.com/book/ru/v2.
+Текущую сборку можно найти по адресу https://git-scm.com/book/ru/v2.
 
-Другой способ получить кнугу -- собрать её самостоятельно с помощью Asciidoctor.
-Используя команды ниже, вы сможете получить HTML, Epub, Mobi и PDF файлы:
+Другой способ получить книгу -- собрать её самостоятельно с помощью Asciidoctor.
+Раньше мы могли собирать файлы .mobi (Kindle), но сейчас не можем, см. https://github.com/progit/progit2/issues/1496[#1496] для получения дополнительной информации.
+Используя команды ниже, вы сможете получить HTML, Epub и PDF-файлы:
 
 ----
 $ bundle install
@@ -39,14 +39,32 @@ Converting to HTML...
  -- HTML output at progit.html
 Converting to EPub...
  -- Epub output at progit.epub
-Converting to Mobi (kf8)...
- -- Mobi output at progit.mobi
 Converting to PDF...
- -- PDF  output at progit.pdf
+ -- PDF output at progit.pdf
 ----
 
 Здесь используются проекты `asciidoctor`, `asciidoctor-pdf` и `asciidoctor-epub`.
 
+Также возможно собрать отдельно в одном из поддерживаемых форматов (HTML, EPUB или PDF).
+
+Сборка только в HTML:
+
+----
+$ bundle exec rake book:build_html
+----
+
+Сборка только в EPUB:
+
+----
+$ bundle exec rake book:build_epub
+----
+
+Сборка только в PDF:
+
+----
+$ bundle exec rake book:build_pdf
+----
+
 По умолчанию, `bundle install` устанавливает зависимости глобально в систему.
 Чтобы этого избежать, следует сконфигурировать менеджер пакетов перед установкой зависимостей с помощью следующей команды:
 

Rakefile

@@ -8,51 +8,102 @@ namespace :book do
     end
   end
 
-  desc 'build basic book formats'
-  task :build do
+  lang = "ru"
+  begin
+    locale_file = "attributes-#{lang}.adoc"
+    locale_file_url = "https://raw.githubusercontent.com/asciidoctor/asciidoctor/master/data/locale/#{locale_file}"
 
-    begin
-      lang = "ru"
-      begin
-        locale_file = "attributes-#{lang}.adoc"
-        locale_file_url = "https://raw.githubusercontent.com/asciidoctor/asciidoctor/master/data/locale/#{locale_file}"
-
-        if not File.exist?(locale_file)
-          puts "Downloading locale attributes file #{locale_file_url} ..."
-          l10n_text = URI.open(locale_file_url).read
-          File.open(locale_file, 'w') { |file| file.puts l10n_text }
-        else
-          puts "Use existing file with locale attributes #{locale_file}"
-        end
-      rescue
-        puts "[ERROR] Can not download attributes list for language #{lang}"
-      end
+    if not File.exist?(locale_file)
+      puts "Downloading locale attributes file #{locale_file_url} ..."
+      l10n_text = URI.open(locale_file_url).read
+      File.open(locale_file, 'w') { |file| file.puts l10n_text }
+    else
+      puts "Use existing file with locale attributes #{locale_file}"
+    end
+  rescue
+    puts "[ERROR] Can not download attributes list for language #{lang}"
+  end
+
+  # Variables referenced for build
+  version_string = ENV['TRAVIS_TAG'] || `git describe --tags`.chomp
+  if version_string.empty?
+    version_string = '0'
+  end
+
+  date_string = Time.now.strftime("%d.%m.%Y")
+  params = "--attribute revnumber='#{version_string}' --attribute revdate='#{date_string}' --attribute lang='#{lang}'"
+
+  header_hash = `git rev-parse --short HEAD`.strip
+
+  # Check contributors list
+  # This checks commit hash stored in the header of list against current HEAD
+  def check_contrib
+    if File.exist?('book/contributors.txt')
+      current_head_hash = `git rev-parse --short HEAD`.strip
+      header = `head -n 1 book/contributors.txt`.strip
+      # Match regex, then coerce resulting array to string by join
+      header_hash = header.scan(/[a-f0-9]{7,}/).join
 
-      version_string = ENV['TRAVIS_TAG'] || `git describe --tags`.chomp
-      if version_string.empty?
-        version_string = '0'
+      if header_hash == current_head_hash
+        puts "Hash on header of contributors list (#{header_hash}) matches the current HEAD (#{current_head_hash})"
+      else
+        puts "Hash on header of contributors list (#{header_hash}) does not match the current HEAD (#{current_head_hash}), refreshing"
+        `rm book/contributors.txt`
+        # Reenable and invoke task again
+        Rake::Task['book/contributors.txt'].reenable
+        Rake::Task['book/contributors.txt'].invoke
       end
+    end
+  end
+
+  desc 'build basic book formats'
+  task :build => [:build_html, :build_epub, :build_pdf] do
+    begin
+        # Run check
+        Rake::Task['book:check'].invoke
 
-      date_string = Time.now.strftime("%d.%m.%Y")
-      params = "--attribute revnumber='#{version_string}' --attribute revdate='#{date_string}' --attribute lang=#{lang} "
+        # Rescue to ignore checking errors
+        rescue => e
+        puts e.message
+        puts "Error when checking books (ignored)"
+    end
+  end
 
+  desc 'build basic book formats (for ci)'
+  task :ci => [:build_html, :build_epub, :build_pdf] do
+      # Run check, but don't ignore any errors
+      Rake::Task['book:check'].invoke
+  end
+
+  desc 'generate contributors list'
+  file 'book/contributors.txt' do
       puts "Generating contributors list"
-      `git shortlog -s | grep -v -E "(Straub|Chacon|dependabot)" | cut -f 2- | column -c 96 > book/contributors.txt`
+      `echo "Contributors as of #{header_hash}:\n" > book/contributors.txt`
+      `git shortlog -s | grep -v -E "(Straub|Chacon|dependabot)" | cut -f 2- | column -x -c 48 >> book/contributors.txt`
+  end
+
+  desc 'build HTML format'
+  task :build_html => 'book/contributors.txt' do
+      check_contrib()
 
       puts "Converting to HTML..."
       `bundle exec asciidoctor #{params} -a data-uri progit.asc`
       puts " -- HTML output at progit.html"
 
-      puts " -- Validate HTML file progit.html"
-      exec_or_raise('htmlproofer --check-html progit.html')
+  end
+
+  desc 'build Epub format'
+  task :build_epub => 'book/contributors.txt' do
+      check_contrib()
 
       puts "Converting to EPub..."
       `bundle exec asciidoctor-epub3 #{params} progit.asc`
       puts " -- Epub output at progit.epub"
 
-      puts " -- Validate Epub output file progit.epub"
-      exec_or_raise('epubcheck progit.epub')
-      
+  end
+
+  desc 'build Mobi format'
+  task :build_mobi => 'book/contributors.txt' do
       # Commented out the .mobi file creation because the kindlegen dependency is not available.
       # For more information on this see: #1496.
       # This is a (hopefully) temporary fix until upstream asciidoctor-epub3 is fixed and we can offer .mobi files again.
@@ -61,9 +112,44 @@ namespace :book do
       # `bundle exec asciidoctor-epub3 #{params} -a ebook-format=kf8 progit.asc`
       # puts " -- Mobi output at progit.mobi"
 
+      # FIXME: If asciidoctor-epub3 supports Mobi again, uncomment these lines below
+      puts "Converting to Mobi isn't supported yet."
+      puts "For more information see issue #1496 at https://github.com/progit/progit2/issues/1496."
+      exit(127)
+  end
+
+  desc 'build PDF format'
+  task :build_pdf => 'book/contributors.txt' do
+      check_contrib()
+
       puts "Converting to PDF... (this one takes a while)"
       `bundle exec asciidoctor-pdf #{params} progit.asc 2>/dev/null`
       puts " -- PDF output at progit.pdf"
+  end
+
+  desc 'Check generated books'
+  task :check => [:build_html, :build_epub] do
+      puts "Checking generated books"
+
+      exec_or_raise('htmlproofer --check-html progit.html')
+      exec_or_raise('epubcheck progit.epub')
+  end
+
+  desc 'Clean all generated files'
+  task :clean do
+    begin
+        puts "Removing generated files"
+
+        FileList['book/contributors.txt', 'progit.html', 'progit.epub', 'progit.pdf'].each do |file|
+            rm file
+
+            # Rescue if file not found
+            rescue Errno::ENOENT => e
+              begin
+                  puts e.message
+                  puts "Error removing files (ignored)"
+              end
+        end
     end
   end
 end