kitabu 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7373f8260e5946669b21df6e626ca0742e765b4078a6d739452580cf892cea0b
-  data.tar.gz: f440520e583e4955bd66903f7ca057c1abaccbf9e30868270ed595318bfb57eb
+  metadata.gz: 562752c6728b0fcaf670120941d9864612edf13375f482a0e129d61ceb487845
+  data.tar.gz: 42ae997787207adca50cd791df060181e5e2b37ee84647d20ac4ebbf0b105dd1
 SHA512:
-  metadata.gz: f506160c9264ea90b0dc7e42f8e9530c80376a7ec10dd4d0f1294b15803902ad584b9a3b61cb96b2639729472ed62d1b4030fa2915344014064dd7240d7b61eb
-  data.tar.gz: acfa26ae9ad539737948607617a424f1af733966b023f5e02dfa4706e9482001e594789eba9ffb6271e6eeb6eb6e53d982944ea16cddf80b1ffc3592a8f35941
+  metadata.gz: 7fc4d5ecaf3f24edbd3f04e1733aab2ca67017c8a91626b78df810727cb2fc843f6c885a591238a13542b3c6391fd5b3e0b088b3e348f2a1367063e3f9ca363c
+  data.tar.gz: 9a5b6367c443ed3343ac8b379af171c1fc6713aea6cc5d894858f2fad8bff8185283c6e6bc8c00e82abd5d77afd3df07bab2fcf4e97a60a4a15e24784e385738

data/.github/workflows/ruby-tests.yml

@@ -19,11 +19,14 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["2.7", "3.0", "3.1"]
+        ruby: ["3.2", "3.3"]
         gemfile:
           - Gemfile
 
     steps:
+      - name: Update deps
+        run: sudo apt update -y
+
       - name: Install deps
         run: sudo apt install -y calibre gdebi
 
@@ -32,9 +35,9 @@ jobs:
           wget https://www.princexml.com/download/prince_14.2-1_ubuntu20.04_amd64.deb
           sudo gdebi --non-interactive prince_14.2-1_ubuntu20.04_amd64.deb
 
-      - uses: actions/checkout@v2.4.0
+      - uses: actions/checkout@v4
 
-      - uses: actions/cache@v2
+      - uses: actions/cache@v3
         with:
           path: vendor/bundle
           key: >

data/.rubocop.yml

@@ -3,7 +3,7 @@ inherit_gem:
   rubocop-fnando: .rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.2
   NewCops: enable
   Exclude:
     - db/schema.rb

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## v3.0.4
+
+- Add support for
+  [Github's alert syntax](https://github.com/orgs/community/discussions/16925).
+  Kitabu's implementation supports any arbitrary name, so you can use anything
+  (e.g. `[!ALERT]`).
+
+## v3.0.3
+
+- Fix Rouge options keys; symbols are required.
+
 ## v3.0.2
 
 - Fix `styles` directory copying.

data/README.md

@@ -26,7 +26,7 @@ starting at \$15/mo.
 
 ## Installation
 
-To install Kitabu, you'll need a working Ruby 2.7+ installation. If you're cool
+To install Kitabu, you'll need a working Ruby 3.2+ installation. If you're cool
 with it, just run the following command to install it.
 
     gem install kitabu

data/kitabu.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.version               = Kitabu::Version::STRING
   s.platform              = Gem::Platform::RUBY
   s.authors               = ["Nando Vieira"]
-  s.email                 = ["fnando.vieira@gmail.com"]
+  s.email                 = ["me@fnando.com"]
   s.homepage              = "http://rubygems.org/gems/kitabu"
   s.summary               = "A framework for creating e-books from Markdown " \
                             "using Ruby. Using the Prince PDF generator, " \
@@ -16,11 +16,10 @@ Gem::Specification.new do |s|
                             "supports EPUB, Mobi, Text and HTML generation."
   s.description           = s.summary
   s.license               = "MIT"
-  s.required_ruby_version = ">= 2.7"
+  s.required_ruby_version = ">= 3.2"
   s.metadata = {"rubygems_mfa_required" => "true"}
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map do |f|
     File.basename(f)
   end

data/lib/kitabu/exporter/base.rb

@@ -20,6 +20,10 @@ module Kitabu
         @source = root_dir.join("text")
       end
 
+      def export
+        FileUtils.mkdir_p(root_dir.join("output"))
+      end
+
       def source_list
         @source_list ||= SourceList.new(root_dir)
       end

data/lib/kitabu/exporter/css.rb

@@ -6,6 +6,8 @@ module Kitabu
       attr_reader :root_dir
 
       def export
+        super
+
         FileUtils.cp_r(
           root_dir.join("templates/styles").to_s,
           root_dir.join("output").to_s

data/lib/kitabu/exporter/epub.rb

@@ -7,7 +7,7 @@ module Kitabu
         @sections ||=
           html.css("div.chapter").each_with_index.map do |chapter, index|
             OpenStruct.new(
-              index: index,
+              index:,
               filename: "section_#{index}.html",
               filepath: tmp_dir.join("section_#{index}.html").to_s,
               html: Nokogiri::HTML(chapter.inner_html)
@@ -24,6 +24,7 @@ module Kitabu
       end
 
       def export
+        super
         copy_styles!
         copy_images!
         set_metadata!
@@ -113,7 +114,7 @@ module Kitabu
       end
 
       def render_chapter(content)
-        locals = config.merge(content: content)
+        locals = config.merge(content:)
         render_template(template_path, locals)
       end
 
@@ -129,7 +130,7 @@ module Kitabu
         path =
           Dir[root_dir.join("templates/epub/cover.{jpg,png,gif}").to_s].first
 
-        return path if path && File.exist?(path)
+        path if path && File.exist?(path)
       end
 
       def navigation

data/lib/kitabu/exporter/html.rb

@@ -14,6 +14,7 @@ module Kitabu
       # to <tt>output/book_name.html</tt>.
       #
       def export
+        super
         copy_images!
         copy_fonts!
         export_stylesheets!
@@ -72,7 +73,7 @@ module Kitabu
           Footnotes::HTML.process(toc.content).html.css("body").first.inner_html
 
         locals = config.merge(
-          content: content,
+          content:,
           toc: toc.to_html,
           changelog: render_changelog
         )

data/lib/kitabu/exporter/mobi.rb

@@ -4,6 +4,7 @@ module Kitabu
   class Exporter
     class Mobi < Base
       def export
+        super
         spawn_command ["ebook-convert", epub_file.to_s, mobi_file.to_s]
         true
       end

data/lib/kitabu/exporter/pdf.rb

@@ -4,6 +4,7 @@ module Kitabu
   class Exporter
     class PDF < Base
       def export
+        super
         apply_footnotes!
         spawn_command ["prince", html_for_pdf.to_s, "-o", pdf_file.to_s]
         spawn_command ["prince", html_for_print.to_s, "-o", print_file.to_s]

data/lib/kitabu/extensions/rouge.rb

@@ -5,6 +5,10 @@ module Rouge
     module Redcarpet
       def rouge_formatter(lexer)
         options = lexer.respond_to?(:options) ? lexer.options : {}
+        options = options.keys.map(&:to_sym).zip(options.values).to_h
+        options[:start_line] = options.fetch(:start_line, 1).to_i
+
+        options = options.keys.map(&:to_sym).zip(options.values).to_h
 
         Formatters::HTMLLegacy.new(
           {css_class: "highlight #{lexer.tag}"}.merge(options)

data/lib/kitabu/markdown.rb

@@ -5,6 +5,38 @@ module Kitabu
     class Renderer < Redcarpet::Render::HTML
       include Redcarpet::Render::SmartyPants
       include Rouge::Plugins::Redcarpet
+
+      # Be more flexible than github and support any arbitrary name.
+      ALERT_MARK = /^\[!(?<type>[A-Z]+)\]$/
+
+      # Support alert boxes just like github.
+      # https://github.com/orgs/community/discussions/16925
+      def block_quote(quote)
+        html = Nokogiri::HTML(quote)
+        element = html.css("body > :first-child").first
+
+        matches = element.text.match(ALERT_MARK)
+
+        return "<blockquote>#{quote}</blockquote>" unless matches
+
+        element.remove
+
+        type = matches[:type].downcase
+        type = "info" if type == "note"
+
+        title = I18n.t(
+          type,
+          scope: :notes,
+          default: type.titleize
+        )
+
+        <<~HTML.strip_heredoc
+          <div class="note #{type}">
+            <p class="note--title">#{title}</p>
+            #{html.css('body').inner_html}
+          </div>
+        HTML
+      end
     end
 
     class << self

data/lib/kitabu/source_list.rb

@@ -8,7 +8,7 @@ module Kitabu
 
     # Files that should be skipped.
     #
-    IGNORE_FILES = /^(CHANGELOG|TOC)\..*?$/.freeze
+    IGNORE_FILES = /^(CHANGELOG|TOC)\..*?$/
 
     # List of recognized extensions.
     #
@@ -37,7 +37,7 @@ module Kitabu
       if File.file?(entry)
         [entry]
       else
-        Dir["#{entry}/**/*.{#{EXTENSIONS.join(',')}}"].sort
+        Dir["#{entry}/**/*.{#{EXTENSIONS.join(',')}}"]
       end
     end
 

data/lib/kitabu/toc/epub.rb

@@ -10,7 +10,7 @@ module Kitabu
       end
 
       def to_html
-        data = OpenStruct.new(navigation: navigation).instance_eval { binding }
+        data = OpenStruct.new(navigation:).instance_eval { binding }
         ERB.new(template).result(data)
       end
 

data/lib/kitabu/toc/html.rb

@@ -61,9 +61,9 @@ module Kitabu
       #
       def to_hash
         {
-          content: content,
+          content:,
           html: to_html,
-          toc: toc
+          toc:
         }
       end
 

data/lib/kitabu/version.rb

@@ -3,8 +3,8 @@
 module Kitabu
   module Version
     MAJOR = 3
-    MINOR = 0
-    PATCH = 2
-    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+    MINOR = 1
+    PATCH = 0
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}".freeze
   end
 end

data/spec/kitabu/exporter/mobi_spec.rb

@@ -7,6 +7,7 @@ describe Kitabu::Exporter::Mobi, calibre: Kitabu::Dependency.calibre? do
     root = SPECDIR.join("support/mybook")
 
     Kitabu::Exporter::HTML.export(root)
+    Kitabu::Exporter::Epub.export(root)
     Kitabu::Exporter::Mobi.export(root)
 
     expect(root.join("output/mybook.mobi")).to be_file

data/spec/kitabu/markdown_spec.rb

@@ -24,6 +24,17 @@ describe Kitabu::Markdown do
     expect(html).to include('<span class="k">echo</span>')
   end
 
+  it "enables line numbers" do
+    html = Kitabu::Markdown.render <<-TEXT.strip_heredoc
+    ```ruby?line_numbers=true
+    class User
+    end
+    ```
+    TEXT
+
+    expect(html).to include(%[<table class="rouge-table">])
+  end
+
   it "does not raise with unknown lexers" do
     expect do
       Kitabu::Markdown.render <<-TEXT.strip_heredoc
@@ -33,4 +44,43 @@ describe Kitabu::Markdown do
       TEXT
     end.not_to raise_error
   end
+
+  it "renders alert boxes using block quotes" do
+    html = Kitabu::Markdown.render <<-TEXT.strip_heredoc
+    > [!NOTE]
+    >
+    > This is just a note
+    TEXT
+
+    html = Nokogiri::HTML(html)
+    selector = "div.note.info > .note--title"
+
+    expect(html.css(selector).text).to eql("Info")
+    expect(html.css("#{selector} + p").text).to eql("This is just a note")
+  end
+
+  it "renders arbitrary alert boxes using block quotes" do
+    html = Kitabu::Markdown.render <<-TEXT.strip_heredoc
+    > [!ALERT]
+    >
+    > This is just an alert
+    TEXT
+
+    html = Nokogiri::HTML(html)
+    selector = "div.note.alert > .note--title"
+
+    expect(html.css(selector).text).to eql("Alert")
+    expect(html.css("#{selector} + p").text).to eql("This is just an alert")
+  end
+
+  it "renders regular block quotes" do
+    html = Kitabu::Markdown.render <<-TEXT.strip_heredoc
+    > This is just a quote
+    TEXT
+
+    html = Nokogiri::HTML(html)
+
+    expect(html.css(".note").count).to eql(0)
+    expect(html.css("blockquote").text.chomp).to eql("This is just a quote")
+  end
 end

data/spec/spec_helper.rb

@@ -13,7 +13,7 @@ require "pathname"
 SPECDIR = Pathname.new(File.dirname(__FILE__))
 TMPDIR = SPECDIR.join("tmp")
 
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].sort.each {|r| require r }
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|r| require r }
 
 p [
   :filter_env,
@@ -46,8 +46,8 @@ RSpec.configure do |config|
   )
 
   cleaner = proc do
-    [TMPDIR].each do |i|
-      FileUtils.rm_rf(i) if File.exist?(i)
+    [TMPDIR, SPECDIR.join("support/mybook/output")].each do |i|
+      FileUtils.rm_rf(i)
     end
 
     Dir.chdir File.expand_path("..", __dir__)

data/spec/support/have_tag.rb

@@ -31,7 +31,7 @@ module Matchers
 
       if input.respond_to?(:body)
         engine.parse(input.body.to_s)
-      elsif Nokogiri::XML::Element == input
+      elsif input == Nokogiri::XML::Element
         input
       else
         engine.parse(input.to_s)

data/templates/config.erb

@@ -25,7 +25,7 @@ published_at: "<%= Date.today %>"
 subject: "This guide will help you understand how all of the pieces fit together on Kitabu."
 
 # Some keywords that identify this book.
-keywords: "kitabu, e-book, kindlegen, epub, mobi, pdf, prince"
+keywords: "kitabu, e-book, calibre, epub, mobi, pdf, prince"
 
 # Some unique identification. Works great with your domain
 # like `http://yourbook.example.com`.

data/templates/text/01_Getting_Started.md

@@ -4,10 +4,8 @@ This guide is designed for beginners who want to get started with Kitabu from
 scratch. However, to get the most out of it, you need to have some prerequisites
 installed:
 
-- The [Ruby](http://ruby-lang.org) interpreter version 2.0.0 or greater.
-- The [PrinceXML](http://princexml.com) converter version 9.0 or greater.
-- The [KindleGen](http://www.amazon.com/gp/feature.html?docId=1000765211)
-  converter.
+- The [Ruby](http://ruby-lang.org) interpreter version 3.2 or newer.
+- The [PrinceXML](http://princexml.com) converter version 14.0 or newer.
 
 ### Installing Ruby
 
@@ -29,16 +27,10 @@ user costs 495USD. If you don't like the price tag, consider using
 To install PrinceXML, go to the website and download the correct version for
 your platform; you can choose from Mac OSX, to Linux and Windows.
 
-### Installing KindleGen
+### Installing Calibre
 
-KindleGen is the command-line tool that allows you to convert e-pubs into
-`.mobi` files. You can't sell these files, though.[^1] So if that's the case,
-consider using [Calibre](http://calibre-ebook.com/) for this task.[^2]
+[Calibre](http://calibre-ebook.com/) is a e-book manager that, among other
+features, allows converting ePub files into .mobi files.
 
-If you're running [Homebrew](http://brew.sh) on the Mac OSX, you can install it
-with `brew install kindlegen`. Go to
-[KindleGen's website](http://www.amazon.com/gp/feature.html?docId=1000765211)
-and download the appropriate installer otherwise.
-
-[^1]: You can, but that would be a violation of Amazon's terms of use.
-[^2]: Calibre is not perfect, but does a good job.
+To install Calibre, go to the website and download the correct version for your
+platform; you can choose from Mac OSX, to Linux and Windows.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitabu
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - Nando Vieira
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-19 00:00:00.000000000 Z
+date: 2024-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -224,7 +224,7 @@ description: A framework for creating e-books from Markdown using Ruby. Using th
   Prince PDF generator, you'll be able to get high quality PDFs. Also supports EPUB,
   Mobi, Text and HTML generation.
 email:
-- fnando.vieira@gmail.com
+- me@fnando.com
 executables:
 - kitabu
 extensions: []
@@ -368,62 +368,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: A framework for creating e-books from Markdown using Ruby. Using the Prince
   PDF generator, you'll be able to get high quality PDFs. Also supports EPUB, Mobi,
   Text and HTML generation.
-test_files:
-- spec/kitabu/cli/export_spec.rb
-- spec/kitabu/cli/new_spec.rb
-- spec/kitabu/cli/permalinks_spec.rb
-- spec/kitabu/cli/stats_spec.rb
-- spec/kitabu/cli/version_spec.rb
-- spec/kitabu/exporter/css_spec.rb
-- spec/kitabu/exporter/epub_spec.rb
-- spec/kitabu/exporter/html_spec.rb
-- spec/kitabu/exporter/mobi_spec.rb
-- spec/kitabu/exporter/pdf_spec.rb
-- spec/kitabu/extensions/string_spec.rb
-- spec/kitabu/footnotes/html_spec.rb
-- spec/kitabu/generator_spec.rb
-- spec/kitabu/markdown_spec.rb
-- spec/kitabu/source_list_spec.rb
-- spec/kitabu/stats_spec.rb
-- spec/kitabu/toc/html_spec.rb
-- spec/spec_helper.rb
-- spec/support/exit_with_code.rb
-- spec/support/have_tag.rb
-- spec/support/helper.rb
-- spec/support/mybook/.gitignore
-- spec/support/mybook/code/.gitkeep
-- spec/support/mybook/code/code.rb
-- spec/support/mybook/config/helper.rb
-- spec/support/mybook/config/kitabu.yml
-- spec/support/mybook/fonts/OpenSans-CondBold.ttf
-- spec/support/mybook/images/.gitkeep
-- spec/support/mybook/images/logo.gif
-- spec/support/mybook/templates/epub/cover.erb
-- spec/support/mybook/templates/epub/cover.png
-- spec/support/mybook/templates/epub/page.erb
-- spec/support/mybook/templates/html/layout.erb
-- spec/support/mybook/templates/styles/epub.css
-- spec/support/mybook/templates/styles/html.css
-- spec/support/mybook/templates/styles/pdf.css
-- spec/support/mybook/templates/styles/print.css
-- spec/support/mybook/text/.gitkeep
-- spec/support/mybook/text/01_Markdown_Chapter.md
-- spec/support/mybook/text/02_ERB_Chapter.md.erb
-- spec/support/mybook/text/03_With_Directory/Some_Chapter.md
-- spec/support/mybook/text/CHANGELOG.md
-- spec/support/mybook/text/TOC.md
-- spec/support/mybook/text/_00_Introduction.md
-- spec/support/shared.rb
+test_files: []