kitabu 2.1.0 → 3.0.0

data/spec/kitabu/footnotes/html_spec.rb

@@ -1,7 +1,9 @@
-require 'spec_helper'
+# frozen_string_literal: true
+
+require "spec_helper"
 
 describe Kitabu::Footnotes::HTML do
-  let(:footnotes) {
+  let(:footnotes) do
     Kitabu::Markdown.render <<-MARKDOWN.strip_heredoc
       ohai[^1] and kthxbai[^2]
 
@@ -10,9 +12,9 @@ describe Kitabu::Footnotes::HTML do
       [^1]: Hello
       [^2]: OK, thanks. Bye!
     MARKDOWN
-  }
+  end
 
-  let(:content) {
+  let(:content) do
     <<-HTML.strip_heredoc
       <div class="chapter">
         #{footnotes}
@@ -22,54 +24,54 @@ describe Kitabu::Footnotes::HTML do
         #{footnotes}
       </div>
     HTML
-  }
+  end
 
-  let(:html) {
+  let(:html) do
     Kitabu::Footnotes::HTML.process(content).html
-  }
+  end
 
-  let(:chapter1) { html.css('.chapter:first-of-type').first }
-  let(:chapter2) { html.css('.chapter:last-of-type').first }
+  let(:chapter1) { html.css(".chapter:first-of-type").first }
+  let(:chapter2) { html.css(".chapter:last-of-type").first }
 
-  it 'sets starting index' do
+  it "sets starting index" do
     expect(chapter1).to have_tag('.footnotes ol[start="1"]')
     expect(chapter2).to have_tag('.footnotes ol[start="3"]')
   end
 
-  it 'sets footnotes id' do
-    html.css('.footnotes li').to_enum(:each).with_index(1) do |footnote, index|
-      expect(footnote.get_attribute('id')).to eq("fn#{index}")
+  it "sets footnotes id" do
+    html.css(".footnotes li").to_enum(:each).with_index(1) do |footnote, index|
+      expect(footnote.get_attribute("id")).to eq("fn#{index}")
     end
   end
 
-  it 'removes id from existing <sup>' do
-    expect(chapter1).to have_tag('sup:not([id])', count: 1)
-    expect(chapter2).to have_tag('sup:not([id])', count: 1)
+  it "removes id from existing <sup>" do
+    expect(chapter1).to have_tag("sup:not([id])", count: 1)
+    expect(chapter2).to have_tag("sup:not([id])", count: 1)
   end
 
-  it 'sets <sup> id' do
-    expect(chapter1).to have_tag('sup', count: 3)
-    expect(chapter1).to have_tag('sup[id=fnref1]', count: 1)
-    expect(chapter1).to have_tag('sup[id=fnref2]', count: 1)
+  it "sets <sup> id" do
+    expect(chapter1).to have_tag("sup", count: 3)
+    expect(chapter1).to have_tag("sup[id=fnref1]", count: 1)
+    expect(chapter1).to have_tag("sup[id=fnref2]", count: 1)
 
-    expect(chapter2).to have_tag('sup', count: 3)
-    expect(chapter2).to have_tag('sup[id=fnref3]', count: 1)
-    expect(chapter2).to have_tag('sup[id=fnref4]', count: 1)
+    expect(chapter2).to have_tag("sup", count: 3)
+    expect(chapter2).to have_tag("sup[id=fnref3]", count: 1)
+    expect(chapter2).to have_tag("sup[id=fnref4]", count: 1)
   end
 
-  it 'updates link to footnote' do
-    expect(chapter1).to have_tag('sup:nth-child(1) > a', text: '1', count: 2)
-    expect(chapter1).to have_tag('sup:nth-child(2) > a', text: '2', count: 1)
+  it "updates link to footnote" do
+    expect(chapter1).to have_tag("sup:nth-child(1) > a", text: "1", count: 2)
+    expect(chapter1).to have_tag("sup:nth-child(2) > a", text: "2", count: 1)
 
-    expect(chapter2).to have_tag('sup:nth-child(1) > a', text: '3', count: 2)
-    expect(chapter2).to have_tag('sup:nth-child(2) > a', text: '4', count: 1)
+    expect(chapter2).to have_tag("sup:nth-child(1) > a", text: "3", count: 2)
+    expect(chapter2).to have_tag("sup:nth-child(2) > a", text: "4", count: 1)
   end
 
-  it 'sets footnote link-back' do
-    expect(chapter1).to have_tag('.footnotes li:nth-child(1) a[rev=footnote][href="#fnref1"]')
-    expect(chapter1).to have_tag('.footnotes li:nth-child(2) a[rev=footnote][href="#fnref2"]')
+  it "sets footnote link-back" do
+    expect(chapter1).to have_tag('.footnotes li:nth-child(1) a[href="#fnref1"]')
+    expect(chapter1).to have_tag('.footnotes li:nth-child(2) a[href="#fnref2"]')
 
-    expect(chapter2).to have_tag('.footnotes li:nth-child(1) a[rev=footnote][href="#fnref3"]')
-    expect(chapter2).to have_tag('.footnotes li:nth-child(2) a[rev=footnote][href="#fnref4"]')
+    expect(chapter2).to have_tag('.footnotes li:nth-child(1) a[href="#fnref3"]')
+    expect(chapter2).to have_tag('.footnotes li:nth-child(2) a[href="#fnref4"]')
   end
 end

data/spec/kitabu/generator_spec.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Kitabu::Generator do
   before do
     subject.destination_root = tmpdir.join("mybook")
-    capture(:stdout){ subject.invoke_all }
+    capture(:stdout) { subject.invoke_all }
   end
 
   it_behaves_like "e-book"

data/spec/kitabu/markdown_spec.rb

@@ -1,7 +1,9 @@
-require 'spec_helper'
+# frozen_string_literal: true
+
+require "spec_helper"
 
 describe Kitabu::Markdown do
-  it 'enables fenced code blocks' do
+  it "enables fenced code blocks" do
     html = Kitabu::Markdown.render <<-TEXT.strip_heredoc
       ```ruby
       class User
@@ -12,7 +14,7 @@ describe Kitabu::Markdown do
     expect(html).to include('<pre class="highlight ruby">')
   end
 
-  it 'enables options' do
+  it "enables options" do
     html = Kitabu::Markdown.render <<-TEXT.strip_heredoc
     ```php?start_inline=true
     echo 'Hello';
@@ -22,13 +24,13 @@ describe Kitabu::Markdown do
     expect(html).to include('<span class="k">echo</span>')
   end
 
-  it 'does not raise with unknown lexers' do
-    expect {
+  it "does not raise with unknown lexers" do
+    expect do
       Kitabu::Markdown.render <<-TEXT.strip_heredoc
       ```terminal
       Text plain.
       ```
       TEXT
-    }.not_to raise_error
+    end.not_to raise_error
   end
 end

data/spec/kitabu/source_list_spec.rb

@@ -1,11 +1,17 @@
-require 'spec_helper'
+# frozen_string_literal: true
+
+require "spec_helper"
 
 describe Kitabu::SourceList do
   let(:root) { SPECDIR.join("support/mybook") }
   let(:format) { Kitabu::Exporter::HTML.new(root) }
   let(:entries) { source_list.entries }
   let(:source) { root.join("text") }
-  let(:relative) { entries.collect {|e| e.to_s.gsub(/^#{Regexp.escape(source.to_s)}\//, "")} }
+  let(:relative) do
+    entries.collect do |e|
+      e.to_s.gsub(%r{^#{Regexp.escape(source.to_s)}/}, "")
+    end
+  end
   subject(:source_list) { Kitabu::SourceList.new(root) }
 
   context "when filtering entries" do

data/spec/kitabu/stats_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Kitabu::Stats do
@@ -6,9 +8,9 @@ describe Kitabu::Stats do
   let(:content) { "" }
   subject(:stats) { Kitabu::Stats.new(root_dir) }
 
-  before {
+  before do
     allow(stats).to receive_message_chain(:content).and_return(content)
-  }
+  end
 
   context "getting content" do
     it "generates content" do
@@ -21,8 +23,10 @@ describe Kitabu::Stats do
     end
 
     it "returns content" do
-      allow(Kitabu::Exporter::HTML).to receive_message_chain(:new).and_return(format)
-      allow(format).to receive_message_chain(:content).and_return("some content")
+      allow(Kitabu::Exporter::HTML).to receive_message_chain(:new)
+        .and_return(format)
+      allow(format).to receive_message_chain(:content)
+        .and_return("some content")
 
       expect(Kitabu::Stats.new(root_dir).content).to eql("some content")
     end
@@ -49,13 +53,13 @@ describe Kitabu::Stats do
   end
 
   context "external links counting" do
-    let(:content) {
+    let(:content) do
       <<-HTML
         <a href="http://example.org">example.org</a>
         <a href="http://subdomain.example.org">subdomain.example.org</a>
         <a href="#some-anchor">anchor</a>
       HTML
-    }
+    end
 
     it { expect(stats.links).to eql(2) }
   end

data/spec/kitabu/toc/html_spec.rb

@@ -1,4 +1,5 @@
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Kitabu::TOC::HTML do
@@ -6,25 +7,31 @@ describe Kitabu::TOC::HTML do
     /#{Regexp.escape(text)}/
   end
 
-  HTML = <<-HTML
-    <h1>Item 1</h1>
-    <h2>Item 1.2</h2>
-    <h3>Item 1.1.3</h3>
-    <h4>Item 1.1.1.4</h4>
-    <h5>Item 1.1.1.1.5</h5>
-    <h6>Item 1.1.1.1.1.6</h6>
-
-    <h2>Item 2.1</h2>
-    <h2>Item 2.1 again</h2>
-    <h2>Internacionalização</h2>
-  HTML
+  def input
+    (+<<-HTML).force_encoding("utf-8")
+      <h1>Item 1</h1>
+      <h2>Item 1.2</h2>
+      <h3>Item 1.1.3</h3>
+      <h4>Item 1.1.1.4</h4>
+      <h5>Item 1.1.1.1.5</h5>
+      <h6>Item 1.1.1.1.1.6</h6>
 
-  HTML.force_encoding("utf-8")
+      <h2>Item 2.1</h2>
+      <h2>Item 2.1 again</h2>
+      <h2>Internacionalização</h2>
+      <h2>Title</h2>
+      <h2>Title</h2>
+    HTML
+  end
 
-  let(:toc) { described_class.generate(HTML) }
+  let(:toc) { described_class.generate(input) }
   let(:html) { toc.to_html }
   let(:content) { toc.content }
 
+  it "returns hash" do
+    expect(toc.to_hash.keys).to eq(%i[content html toc])
+  end
+
   it "has no body tag" do
     expect(content).not_to match(/<body>/)
   end
@@ -34,13 +41,17 @@ describe Kitabu::TOC::HTML do
     expect(html).to have_tag("div.level2.item-1-2", regexp("Item 1.2"))
     expect(html).to have_tag("div.level3.item-1-1-3", regexp("Item 1.1.3"))
     expect(html).to have_tag("div.level4.item-1-1-1-4", regexp("Item 1.1.1.4"))
-    expect(html).to have_tag("div.level5.item-1-1-1-1-5", regexp("Item 1.1.1.1.5"))
-    expect(html).to have_tag("div.level6.item-1-1-1-1-1-6", regexp("Item 1.1.1.1.1.6"))
+    expect(html).to have_tag("div.level5.item-1-1-1-1-5",
+                             regexp("Item 1.1.1.1.5"))
+    expect(html).to have_tag("div.level6.item-1-1-1-1-1-6",
+                             regexp("Item 1.1.1.1.1.6"))
 
     expect(html).to have_tag("div.level2.item-2-1", regexp("Item 2.1"))
-    expect(html).to have_tag("div.level2.item-2-1-again", regexp("Item 2.1 again"))
+    expect(html).to have_tag("div.level2.item-2-1-again",
+                             regexp("Item 2.1 again"))
 
-    expect(html).to have_tag("div.level2.internacionalizacao", regexp("Internacionalização"))
+    expect(html).to have_tag("div.level2.internacionalizacao",
+                             regexp("Internacionalização"))
   end
 
   it "adds id attribute to content" do
@@ -49,11 +60,16 @@ describe Kitabu::TOC::HTML do
     expect(content).to have_tag("h3#item-1-1-3", regexp("Item 1.1.3"))
     expect(content).to have_tag("h4#item-1-1-1-4", regexp("Item 1.1.1.4"))
     expect(content).to have_tag("h5#item-1-1-1-1-5", regexp("Item 1.1.1.1.5"))
-    expect(content).to have_tag("h6#item-1-1-1-1-1-6", regexp("Item 1.1.1.1.1.6"))
+    expect(content).to have_tag("h6#item-1-1-1-1-1-6",
+                                regexp("Item 1.1.1.1.1.6"))
 
     expect(content).to have_tag("h2#item-2-1", regexp("Item 2.1"))
     expect(content).to have_tag("h2#item-2-1-again", regexp("Item 2.1 again"))
 
-    expect(content).to have_tag("h2#internacionalizacao", regexp("Internacionalização"))
+    expect(content).to have_tag("h2#internacionalizacao",
+                                regexp("Internacionalização"))
+
+    expect(content).to have_tag("h2#title", regexp("Title"))
+    expect(content).to have_tag("h2#title-2", regexp("Title"))
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,9 @@
-require "codeclimate-test-reporter"
-CodeClimate::TestReporter.start
+# frozen_string_literal: true
+
+require "simplecov"
+SimpleCov.start do
+  add_filter "spec"
+end
 
 require "bundler/setup"
 
@@ -9,12 +13,24 @@ require "pathname"
 SPECDIR = Pathname.new(File.dirname(__FILE__))
 TMPDIR = SPECDIR.join("tmp")
 
-Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|r| require r}
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].sort.each {|r| require r }
+
+p [
+  :filter_env,
+  {
+    calibre: Kitabu::Dependency.calibre?,
+    prince: Kitabu::Dependency.prince?,
+    macos: Kitabu::Dependency.macos?,
+    linux: Kitabu::Dependency.linux?
+  }
+]
 
 # Disable the bundle install command.
 # TODO: Figure out the best way of doing it so.
-class Kitabu::Generator < Thor::Group
-  def bundle_install
+module Kitabu
+  class Generator < Thor::Group
+    def bundle_install
+    end
   end
 end
 
@@ -23,8 +39,7 @@ RSpec.configure do |config|
   config.include(Matchers)
 
   config.filter_run_excluding(
-    html2text: false,
-    kindlegen: false,
+    calibre: false,
     prince: false,
     osx: false,
     linux: false
@@ -35,7 +50,7 @@ RSpec.configure do |config|
       FileUtils.rm_rf(i) if File.exist?(i)
     end
 
-    Dir.chdir File.expand_path('../..', __FILE__)
+    Dir.chdir File.expand_path("..", __dir__)
   end
 
   config.before(&cleaner)

data/spec/support/exit_with_code.rb

@@ -1,22 +1,24 @@
+# frozen_string_literal: true
+
 RSpec::Matchers.define :exit_with_code do |code|
   actual = nil
 
   match do |block|
     begin
       block.call
-    rescue SystemExit => e
-      actual = e.status
+    rescue SystemExit => error
+      actual = error.status
     end
 
     actual && actual == code
   end
 
-  failure_message do |block|
+  failure_message do |_block|
     "expected block to call exit(#{code}) but exit" +
-    (actual ? "(#{actual}) was called" : " not called")
+      (actual ? "(#{actual}) was called" : " not called")
   end
 
-  failure_message_when_negated do |block|
+  failure_message_when_negated do |_block|
     "expected block not to call exit(#{code})"
   end
 

data/spec/support/have_tag.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Matchers
   def have_tag(selector, options = {}, &block)
     HaveTag.new(:html, selector, options, &block)
@@ -10,18 +12,18 @@ module Matchers
   class HaveTag
     attr_reader :options, :selector, :actual, :actual_count, :doc, :type
 
-    def initialize(type, selector, options = {}, &block)
+    def initialize(type, selector, options = {})
       @selector = selector
       @type = type
 
-      case options
-      when Hash
-        @options = options
-      when Numeric
-        @options = {:count => options}
-      else
-        @options = {:text => options}
-      end
+      @options = case options
+                 when Hash
+                   options
+                 when Numeric
+                   {count: options}
+                 else
+                   {text: options}
+                 end
     end
 
     def doc_for(input)
@@ -29,7 +31,7 @@ module Matchers
 
       if input.respond_to?(:body)
         engine.parse(input.body.to_s)
-      elsif Nokogiri::XML::Element === input
+      elsif Nokogiri::XML::Element == input
         input
       else
         engine.parse(input.to_s)
@@ -43,12 +45,13 @@ module Matchers
       matches = doc.css(selector)
 
       return options[:count] == 0 if matches.empty?
+
       matches = filter_on_inner_text(matches) if options[:text]
       matches = filter_on_nested_expectations(matches, block) if block
 
       @actual_count = matches.size
 
-      return false if not acceptable_count?(actual_count)
+      return false unless acceptable_count?(actual_count)
 
       !matches.empty?
     end
@@ -59,57 +62,66 @@ module Matchers
 
     def failure_message
       explanation = actual_count ? "but found #{actual_count}" : "but did not"
-      "expected\n#{doc.to_s}\nto have #{failure_count_phrase} #{failure_selector_phrase}, #{explanation}"
+
+      "expected\n#{doc}\nto have #{failure_count_phrase} " \
+        "#{failure_selector_phrase}, #{explanation}"
     end
 
     def failure_message_when_negated
       explanation = actual_count ? "but found #{actual_count}" : "but did"
-      "expected\n#{doc.to_s}\nnot to have #{failure_count_phrase} #{failure_selector_phrase}, #{explanation}"
+
+      "expected\n#{doc}\nnot to have " \
+        "#{failure_count_phrase} #{failure_selector_phrase}, #{explanation}"
     end
 
-    private
-    def filter_on_inner_text(elements)
+    private def filter_on_inner_text(elements)
       elements.select do |el|
         next(el.inner_text =~ options[:text]) if options[:text].is_a?(Regexp)
+
         el.inner_text == options[:text]
       end
     end
 
-    def filter_on_nested_expectations(elements, block)
+    private def filter_on_nested_expectations(elements, block)
       elements.select do |el|
-        begin
-          block[el]
-        rescue RSpec::Expectations::ExpectationNotMetError
-          false
-        else
-          true
-        end
+        block[el]
+      rescue RSpec::Expectations::ExpectationNotMetError
+        false
+      else
+        true
       end
     end
 
-    def acceptable_count?(count)
-      return false unless options[:count] === count if options[:count]
-      return false unless count >= options[:minimum] if options[:minimum]
-      return false unless count <= options[:maximum] if options[:maximum]
+    private def acceptable_count?(count)
+      return false if options[:count] && options[:count] != count
+      return false if options[:minimum] && count < options[:minimum]
+      return false if options[:maximum] && count > options[:maximum]
+
       true
     end
 
-    def failure_count_phrase
+    private def failure_count_phrase
       if options[:count]
         "#{options[:count]} elements matching"
       elsif options[:minimum] || options[:maximum]
         count_explanations = []
-        count_explanations << "at least #{options[:minimum]}" if options[:minimum]
-        count_explanations << "at most #{options[:maximum]}"  if options[:maximum]
+        if options[:minimum]
+          count_explanations << "at least #{options[:minimum]}"
+        end
+        if options[:maximum]
+          count_explanations << "at most #{options[:maximum]}"
+        end
         "#{count_explanations.join(' and ')} elements matching"
       else
         "an element matching"
       end
     end
 
-    def failure_selector_phrase
+    private def failure_selector_phrase
       phrase = selector.inspect
-      phrase << (options[:text] ? " with inner text #{options[:text].inspect}" : "")
+      phrase << (
+        options[:text] ? " with inner text #{options[:text].inspect}" : ""
+      )
     end
   end
 end

data/spec/support/helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SpecHelper
   def tmpdir
     TMPDIR
@@ -6,11 +8,11 @@ module SpecHelper
   def capture(stream)
     begin
       stream = stream.to_s
-      eval "$#{stream} = StringIO.new"
+      eval "$#{stream} = StringIO.new" # rubocop:disable Security/Eval, Style/EvalWithLocation
       yield
-      result = eval("$#{stream}").string
+      result = eval("$#{stream}").string # rubocop:disable Security/Eval, Style/EvalWithLocation
     ensure
-      eval("$#{stream} = #{stream.upcase}")
+      eval "$#{stream} = #{stream.upcase}" # rubocop:disable Security/Eval, Style/EvalWithLocation
     end
 
     result

data/spec/support/mybook/code/code.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class HelloWorld
   # @begin: method
   def self.say

data/spec/support/mybook/config/helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Kitabu
   module Helpers
   end

data/spec/support/shared.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 shared_examples_for "e-book" do
   let(:mybook) { tmpdir.join("mybook") }
 
@@ -32,8 +34,8 @@ shared_examples_for "e-book" do
   it "copies sample texts" do
     expect(mybook.join("text/01_Getting_Started.md")).to be_file
     expect(mybook.join("text/02_Creating_Chapters.md")).to be_file
-    expect(mybook.join("text/03_Syntax_Highlighting.erb")).to be_file
-    expect(mybook.join("text/04_Dynamic_Content.erb")).to be_file
+    expect(mybook.join("text/03_Syntax_Highlighting.md.erb")).to be_file
+    expect(mybook.join("text/04_Dynamic_Content.md.erb")).to be_file
     expect(mybook.join("text/05_Exporting_Files.md")).to be_file
   end
 
@@ -43,10 +45,10 @@ shared_examples_for "e-book" do
 
   it "copies stylesheets" do
     expect(mybook.join("templates/styles")).to be_directory
-    expect(mybook.join("templates/styles/epub.scss")).to be_file
-    expect(mybook.join("templates/styles/print.scss")).to be_file
-    expect(mybook.join("templates/styles/pdf.scss")).to be_file
-    expect(mybook.join("templates/styles/html.scss")).to be_file
+    expect(mybook.join("templates/styles/epub.css")).to be_file
+    expect(mybook.join("templates/styles/print.css")).to be_file
+    expect(mybook.join("templates/styles/pdf.css")).to be_file
+    expect(mybook.join("templates/styles/html.css")).to be_file
   end
 
   it "copies Gemfile" do

data/templates/Gemfile

@@ -1,3 +1,5 @@
-source 'https://rubygems.org'
-gem 'kitabu'
-gem 'guard-shell'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gem "guard-shell"
+gem "kitabu"

data/templates/Guardfile

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 notification :off
 interactor :off
 
 guard :shell do
-  watch %r[^(?!output)] do |m|
+  watch(/^(?!output)/) do |_m|
     `kitabu export`
   end
 end