kitabu 2.0.2 → 3.0.0

data/README.md

@@ -1,25 +1,33 @@
 # kitabu
 
-[![Build Status](https://travis-ci.org/fnando/kitabu.svg)](https://travis-ci.org/fnando/kitabu)
-[![Code Climate](https://codeclimate.com/github/fnando/kitabu/badges/gpa.svg)](https://codeclimate.com/github/fnando/kitabu)
-[![Test Coverage](https://codeclimate.com/github/fnando/kitabu/badges/coverage.svg)](https://codeclimate.com/github/fnando/kitabu)
-
-Kitabu is a framework for creating e-books from Markdown using Ruby. Using Prince PDF generator, you'll be able to get high quality PDFs. Also supports EPUB, Mobi, Text and HTML generation.
-
-While Prince is too expensive (495USD for a single user license), the free version available at <http://www.princexml.com/download> generates a PDF with a small logo on the first page, which is removed when sent to a printer; you can use it locally for viewing the results immediately. When you're done writing your e-book, you can use [DocRaptor](http://docraptor.com), which have plans starting at $15/mo.
+[![Tests](https://github.com/fnando/kitabu/workflows/ruby-tests/badge.svg)](https://github.com/fnando/kitabu)
+[![Gem](https://img.shields.io/gem/v/kitabu.svg)](https://rubygems.org/gems/kitabu)
+[![Gem](https://img.shields.io/gem/dt/kitabu.svg)](https://rubygems.org/gems/kitabu)
+[![MIT License](https://img.shields.io/:License-MIT-blue.svg)](https://tldrlegal.com/license/mit-license)
+
+Kitabu is a framework for creating e-books from Markdown using Ruby. Using
+Prince PDF generator, you'll be able to get high quality PDFs. Also supports
+EPUB, Mobi, and HTML generation.
+
+While Prince is too expensive (495USD for a single user license), the free
+version available at <http://www.princexml.com/download> generates a PDF with a
+small logo on the first page, which is removed when sent to a printer; you can
+use it locally for viewing the results immediately. When you're done writing
+your e-book, you can use [DocRaptor](http://docraptor.com), which have plans
+starting at \$15/mo.
 
 ## Features
 
-* Write using Markdown
-* Book layout support
-* Syntax highlight
-* Generate HTML, PDF, e-Pub, Mobi and Text files
-* Table of Contents automatically generated from chapter titles
+- Write using Markdown
+- Book layout support
+- Syntax highlight
+- Generate HTML, PDF, e-Pub, and Mobi
+- Table of Contents automatically generated from chapter titles
 
 ## Installation
 
-To install Kitabu, you'll need a working Ruby 2.0+ installation.
-If you're cool with it, just run the following command to install it.
+To install Kitabu, you'll need a working Ruby 2.7+ installation. If you're cool
+with it, just run the following command to install it.
 
     gem install kitabu
 
@@ -31,13 +39,11 @@ dependencies.
     Prince XML: Converts HTML files into PDF files.
     Installed.
 
-    KindleGen: Converts ePub e-books into .mobi files.
+    Calibre's ebook-convert: Converts ePub e-books into .mobi files.
     Installed.
 
-    html2text: Converts HTML documents into plain text.
-    Not installed.
-
-There are no hard requirements here; just make sure you cleared the correct dependency based on the formats you want to export to.
+There are no hard requirements here; just make sure you cleared the correct
+dependency based on the formats you want to export to.
 
 ## Usage
 
@@ -70,32 +76,38 @@ This command creates a directory `mybook` with the following structure:
     │   ├── html
     │   │   └── layout.erb
     │   └── styles
-    │       ├── epub.scss
+    │       ├── epub.css
     │       ├── files
-    │       │   └── _normalize.scss
-    │       ├── html.scss
-    │       ├── pdf.scss
-    │       └── print.scss
+    │       │   └── _normalize.css
+    │       ├── html.css
+    │       ├── pdf.css
+    │       └── print.css
     └── text
         ├── 01_Getting_Started.md
         ├── 02_Creating_Chapters.md
-        ├── 03_Syntax_Highlighting.erb
-        ├── 04_Dynamic_Content.erb
+        ├── 03_Syntax_Highlighting.md.erb
+        ├── 04_Dynamic_Content.md.erb
         └── 05_Exporting_Files.md
 
-The `config/kitabu.yml` file holds some information about your book; so you'll always change it.
+The `config/kitabu.yml` file holds some information about your book; so you'll
+always change it.
 
 The generated structure is actually a good example. So make sure you try it!
 
-![Kitabu - Sample Book](https://github.com/fnando/kitabu/raw/master/attachments/cover.png)
+![Kitabu - Sample Book](https://github.com/fnando/kitabu/raw/main/attachments/cover.png)
 
-There's a generated sample available on the [attachments directory](https://github.com/fnando/kitabu/tree/master/attachments) •
-[PDF](https://github.com/fnando/kitabu/raw/master/attachments/kitabu.pdf) /
-[EPUB](https://github.com/fnando/kitabu/raw/master/attachments/kitabu.epub) /
-[MOBI](https://github.com/fnando/kitabu/raw/master/attachments/kitabu.mobi) /
-[HTML](https://github.com/fnando/kitabu/raw/master/attachments/browser-version.png).
+There's a generated sample available on the
+[attachments directory](https://github.com/fnando/kitabu/tree/main/attachments)
+• [PDF](https://github.com/fnando/kitabu/raw/main/attachments/kitabu.pdf) /
+[EPUB](https://github.com/fnando/kitabu/raw/main/attachments/kitabu.epub) /
+[MOBI](https://github.com/fnando/kitabu/raw/main/attachments/kitabu.mobi) /
+[HTML](https://github.com/fnando/kitabu/raw/main/attachments/browser-version.png).
 
-Now it's time to write your e-book. All your book content will be placed on the text directory. Kitabu requires you to separate your book into chapters. A chapter is nothing but a directory that holds lots of text files. The e-book will be generated using every folder/file alphabetically. So be sure to use a sequential numbering as the name. Here's a sample:
+Now it's time to write your e-book. All your book content will be placed on the
+text directory. Kitabu requires you to separate your book into chapters. A
+chapter is nothing but a directory that holds lots of text files. The e-book
+will be generated using every folder/file alphabetically. So be sure to use a
+sequential numbering as the name. Here's a sample:
 
     * text
       * 01_Introduction
@@ -117,31 +129,34 @@ If you prefer, you can add a chapter per file:
       * 02_What_is_Ruby_on_Rails.md
       * 03_Installing_Ruby_on_Rails.md
 
-You'll want to see your progress eventually; it's time for you to generate the book PDF. Just run the command `kitabu export` and your book will be created on the `output` directory.
+You'll want to see your progress eventually; it's time for you to generate the
+book PDF. Just run the command `kitabu export` and your book will be created on
+the `output` directory.
 
-Kitabu can generate a Table of Contents (TOC) based on your h2-h6 tags. The h1 tag is discarded because it's meant to be the book title.
+Kitabu can generate a Table of Contents (TOC) based on your h2-h6 tags. The h1
+tag is discarded because it's meant to be the book title.
 
 To print the TOC, you need to print a variable called `toc`, using the eRb tag.
 
     <%= toc %>
 
-#### Using ERB
+### Using ERB
 
-You can also have `.erb` files. You can mix Markdown and HTML, like the following:
+You can also have `.md.erb` files. You can mix Markdown and HTML, like the
+following:
 
     ## This the chapter title
 
     <% note do %>
-      Make sure you try .erb files!
+      Make sure you try .md.erb files!
     <% end %>
 
-The above content must be placed in a `.erb` file. The generated content will be something like this:
+The above content must be placed in a `.md.erb` file. The generated content will
+be something like this:
 
 ```html
 <div class="note info">
-  <p>
-    Make sure you try .erb files!
-  </p>
+  <p>Make sure you try .md.erb files!</p>
 </div>
 ```
 
@@ -153,7 +168,8 @@ The `note` helper is built-in and can accept a different note type.
 <% end %>
 ```
 
-You can see available helpers on <https://github.com/fnando/kitabu/blob/master/lib/kitabu/markdown.rb>.
+You can see available helpers on
+<https://github.com/fnando/kitabu/blob/main/lib/kitabu/markdown.rb>.
 
 ### Syntax Highlighting
 
@@ -172,37 +188,60 @@ You can even provide options:
     echo "Hello World";
     ```
 
-- We use [Redcarpet](https://rubygems.org/gems/redcarpet) for Markdown processing.
+- We use [Redcarpet](https://rubygems.org/gems/redcarpet) for Markdown
+  processing.
 - We use [Rouge](https://rubygems.org/gems/rouge) for syntax highlighting.
 
 The following Redcarpet options are enabled:
 
-* `autolink`
-* `fenced_code_blocks`
-* `footnotes`
-* `hard_wrap`
-* `highlight`
-* `no_intra_emphasis`
-* `safe_links_only`
-* `space_after_headers`
-* `strikethrough`
-* `superscript`
-* `tables`
+- `autolink`
+- `fenced_code_blocks`
+- `footnotes`
+- `hard_wrap`
+- `highlight`
+- `no_intra_emphasis`
+- `safe_links_only`
+- `space_after_headers`
+- `strikethrough`
+- `superscript`
+- `tables`
+
+### Using custom fonts
+
+You can use custom fonts for your PDF. Just add them to the `fonts` directory
+(you can create this directory on your book's root directory if it doesn't
+exist).
+
+Then, on `templates/styles/pdf.css` you can add the `@font-face` declaration.
+
+```css
+@font-face {
+  font-family: "Open Sans Condensed Bold";
+  src: url("../../fonts/OpenSans-CondBold.ttf");
+}
+```
+
+Finally, to use this font, do something like this:
+
+```css
+.chapter > h2 {
+  font-family: "Open Sans Condensed Bold";
+}
+```
 
-### References
+## References
 
-* Markdown: <http://daringfireball.net/projects/markdown/syntax>
-* Markdown PHP: <https://michelf.ca/projects/php-markdown/extra/>
+- Markdown: <http://daringfireball.net/projects/markdown/syntax>
+- Markdown PHP: <https://michelf.ca/projects/php-markdown/extra/>
 
 ## Legal Notes
 
-* KindleGen: [license](http://www.amazon.com/gp/feature.html?docId=1000599251).
-* PrinceXML: [license](http://www.princexml.com/license/)
+- PrinceXML: [license](http://www.princexml.com/license/)
 
 Alternatives:
 
-- If you're planning to to sell your e-book, consider using [Calibre](http://calibre-ebook.com/) to convert from `.epub` to `.mobi`.
-- If you're not planning to buy PrinceXML, consider using [DocRaptor](http://docraptor.com). Here's how you can easily do it:
+- If you're not planning to buy PrinceXML, consider using
+  [DocRaptor](http://docraptor.com). Here's how you can easily do it:
 
 ```bash
 curl -H "Content-Type:application/json" -d'{"user_credentials":"YOUR_CREDENTIALS_HERE", "doc":{"name":"kitabu.pdf", "document_type":"pdf", "test":"false", "document_url":"https://dl.dropboxusercontent.com/u/123456789/output/kitabu.pdf.html"}}' http://docraptor.com/docs > kitabu.pdf
@@ -210,28 +249,25 @@ curl -H "Content-Type:application/json" -d'{"user_credentials":"YOUR_CREDENTIALS
 
 ## Maintainer
 
-* [Nando Vieira](http://nandovieira.com.br)
-* [Jesse Storimer](http://jstorimer.com)
+- [Nando Vieira](https://github.com/fnando)
+
+## Contributors
+
+- https://github.com/fnando/kitabu/contributors
+
+## Contributing
+
+For more details about how to contribute, please read
+https://github.com/fnando/kitabu/blob/main/CONTRIBUTING.md.
 
 ## License
 
-(The MIT License)
-
-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, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-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.
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT). A copy of the license can be
+found at https://github.com/fnando/kitabu/blob/main/LICENSE.md.
+
+## Code of Conduct
+
+Everyone interacting in the kitabu project's codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/fnando/kitabu/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,5 +1,12 @@
+# frozen_string_literal: true
+
 require "bundler"
 Bundler::GemHelper.install_tasks
 
 require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/kitabu

@@ -1,5 +1,9 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 # -*- mode: ruby -*-
 
+$LOAD_PATH.unshift File.expand_path(File.join(__dir__, "../lib"))
+
 require "kitabu"
 Kitabu::Cli.start

data/kitabu.gemspec

@@ -1,39 +1,45 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path("lib", __dir__)
 require "kitabu/version"
 
 Gem::Specification.new do |s|
   s.name                  = "kitabu"
   s.version               = Kitabu::Version::STRING
   s.platform              = Gem::Platform::RUBY
-  s.required_ruby_version = ">= 2.0"
   s.authors               = ["Nando Vieira"]
   s.email                 = ["fnando.vieira@gmail.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, you'll be able to get high quality PDFs. Also supports EPUB, Mobi, Text and HTML generation."
+  s.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."
   s.description           = s.summary
   s.license               = "MIT"
+  s.required_ruby_version = ">= 2.7"
+  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{ |f| File.basename(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n").map do |f|
+    File.basename(f)
+  end
   s.require_paths = ["lib"]
 
   s.add_dependency "activesupport"
-  s.add_dependency "nokogiri"
+  s.add_dependency "eeepub-with-cover-support"
   s.add_dependency "i18n"
-  s.add_dependency "thor"
+  s.add_dependency "nokogiri"
   s.add_dependency "redcarpet"
-  s.add_dependency "eeepub-with-cover-support"
   s.add_dependency "rouge"
-  s.add_dependency "notifier"
   s.add_dependency "rubyzip"
+  s.add_dependency "thor"
   s.add_dependency "zip-zip"
-  s.add_dependency "sass"
-  s.add_dependency "sass-globbing"
 
-  s.add_development_dependency "rspec"
-  s.add_development_dependency "rake"
   s.add_development_dependency "pry-meta"
-  s.add_development_dependency "codeclimate-test-reporter"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rubocop"
+  s.add_development_dependency "rubocop-fnando"
+  s.add_development_dependency "simplecov"
 end

data/lib/kitabu/cli.rb

@@ -1,7 +1,8 @@
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
 module Kitabu
   class Cli < Thor
-    FORMATS = %w[pdf html epub mobi txt]
+    FORMATS = %w[pdf html epub mobi].freeze
     check_unknown_options!
 
     def self.exit_on_failure?
@@ -9,8 +10,14 @@ module Kitabu
     end
 
     def initialize(args = [], options = {}, config = {})
-      if (config[:current_task] || config[:current_command]).name == "new" && args.empty?
-        raise Error, "The e-Book path is required. For details run: kitabu help new"
+      has_no_args = (
+        config[:current_task] ||
+        config[:current_command]
+      ).name == "new" && args.empty?
+
+      if has_no_args
+        raise Error,
+              "The e-Book path is required. For details run: kitabu help new"
       end
 
       super
@@ -25,12 +32,16 @@ module Kitabu
     end
 
     desc "export [OPTIONS]", "Export e-book"
-    method_option :only, :type => :string, :desc => "Can be one of: #{FORMATS.join(", ")}"
-    method_option :open, :type => :boolean, :desc => "Automatically open PDF (Preview.app for Mac OS X and xdg-open for Linux)"
+    method_option :only, type: :string,
+                         desc: "Can be one of: #{FORMATS.join(', ')}"
+    method_option :open, type: :boolean,
+                         desc: "Automatically open PDF (Preview.app for " \
+                               "Mac OS X and xdg-open for Linux)"
 
     def export
       if options[:only] && !FORMATS.include?(options[:only])
-        raise Error, "The --only option need to be one of: #{FORMATS.join(", ")}"
+        raise Error,
+              "The --only option need to be one of: #{FORMATS.join(', ')}"
       end
 
       inside_ebook!
@@ -39,7 +50,7 @@ module Kitabu
     end
 
     desc "version", "Prints the Kitabu's version information"
-    map %w(-v --version) => :version
+    map %w[-v --version] => :version
 
     def version
       say "Kitabu version #{Version::STRING}"
@@ -51,24 +62,26 @@ module Kitabu
       result = []
 
       result << {
-        :description => "Prince XML: Converts HTML files into PDF files.",
-        :installed => Kitabu::Dependency.prince?
+        description: "Prince XML: Converts HTML files into PDF files.",
+        installed: Kitabu::Dependency.prince?
       }
 
       result << {
-        :description => "KindleGen: Converts ePub e-books into .mobi files.",
-        :installed => Kitabu::Dependency.kindlegen?
+        description: "Calibre's ebook-convert: Converts ePub e-books into " \
+                     ".mobi files.",
+        installed: Kitabu::Dependency.calibre?
       }
 
-      result << {
-        :description => "html2text: Converts HTML documents into plain text.",
-        :installed => Kitabu::Dependency.html2text?
-      }
+      result.each do |info|
+        state = if info[:installed]
+                  color("Installed.", :green)
+                else
+                  color("Not installed.", :red)
+                end
 
-      result.each do |result|
-        text = color(result[:name], :blue)
-        text << "\n" << result[:description]
-        text << "\n" << (result[:installed] ? color("Installed.", :green) : color("Not installed.", :red))
+        text = color(info[:name], :blue)
+        text << "\n" << info[:description]
+        text << "\n" << state
         text << "\n"
 
         say(text)
@@ -110,31 +123,33 @@ module Kitabu
       ].join("\n")
     end
 
-    private
-    def inside_ebook!
-      unless File.exist?(config_path)
-        raise Error, "You have to run this command from inside an e-book directory."
+    no_commands do
+      def inside_ebook!
+        return if File.exist?(config_path)
+
+        raise Error,
+              "You have to run this command from inside an e-book directory."
       end
-    end
 
-    def config
-      YAML.load_file(config_path).with_indifferent_access
-    end
+      def config
+        YAML.load_file(config_path).with_indifferent_access
+      end
 
-    def config_path
-      root_dir.join("config/kitabu.yml")
-    end
+      def config_path
+        root_dir.join("config/kitabu.yml")
+      end
 
-    def root_dir
-      @root ||= Pathname.new(Dir.pwd)
-    end
+      def root_dir
+        @root_dir ||= Pathname.new(Dir.pwd)
+      end
 
-    def color(text, color)
-      color? ? shell.set_color(text, color) : text
-    end
+      def color(text, color)
+        color? ? shell.set_color(text, color) : text
+      end
 
-    def color?
-      shell.instance_of?(Thor::Shell::Color)
+      def color?
+        shell.instance_of?(Thor::Shell::Color)
+      end
     end
   end
 end

data/lib/kitabu/dependency.rb

@@ -1,15 +1,21 @@
+# frozen_string_literal: true
+
 module Kitabu
   class Dependency
-    def self.kindlegen?
-      @kindlegen ||= `which kindlegen` && $?.success?
+    def self.calibre?
+      @calibre ||= `which ebook-convert` && $CHILD_STATUS.success?
     end
 
     def self.prince?
-      @prince ||= `which prince` && $?.success?
+      @prince ||= `which prince` && $CHILD_STATUS.success?
+    end
+
+    def self.linux?
+      RUBY_PLATFORM.include?("linux")
     end
 
-    def self.html2text?
-      @html2text ||= `which html2text` && $?.success?
+    def self.macos?
+      RUBY_PLATFORM.include?("darwin")
     end
   end
 end

data/lib/kitabu/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Kitabu
   class DirectoryAlreadyCreatedError < StandardError; end
 end

data/lib/kitabu/exporter/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Kitabu
   class Exporter
     class Base
@@ -18,8 +20,6 @@ module Kitabu
         @source = root_dir.join("text")
       end
 
-      #
-      #
       def source_list
         @source_list ||= SourceList.new(root_dir)
       end
@@ -40,18 +40,18 @@ module Kitabu
       #
       def render_template(file, locals = {})
         context = OpenStruct.new(locals).extend(Helpers)
-        ERB.new(File.read(file), 0, "%<>", "@_output").result context.instance_eval { binding }
+        data = context.instance_eval { binding }
+        ERB.new(File.read(file), trim_mode: "%<>",
+                                 eoutvar: "@_output").result(data)
       end
 
       def spawn_command(command)
-        begin
-          stdout_and_stderr, status = Open3.capture2e(*command)
-        rescue Errno::ENOENT => e
-          puts e.message
-        else
-          puts stdout_and_stderr unless status.success?
-          status.success?
-        end
+        stdout_and_stderr, status = Open3.capture2e(*command)
+      rescue Errno::ENOENT => error
+        puts error.message
+      else
+        puts stdout_and_stderr unless status.success?
+        status.success?
       end
 
       def ui
@@ -64,6 +64,8 @@ module Kitabu
       end
 
       def copy_directory(source, target)
+        return unless root_dir.join(source).directory?
+
         source = root_dir.join("#{source}/.")
         target = root_dir.join(target)
 

data/lib/kitabu/exporter/css.rb

@@ -1,23 +1,15 @@
+# frozen_string_literal: true
+
 module Kitabu
   class Exporter
     class CSS < Base
       attr_reader :root_dir
 
       def export
-        files = Dir[root_dir.join("templates/styles/*.{scss,sass}").to_s]
-        options = {
-          style: :expanded,
-          line_numbers: true,
-          load_paths: [root_dir.join("templates/styles")]
-        }
-
-        files.each do |file|
-          _, file_name, syntax = *File.basename(file).match(/(.*?)\.(.*?)$/)
-          engine = Sass::Engine.new(File.read(file), options.merge(syntax: syntax.to_sym))
-          target = root_dir.join("output/styles", "#{file_name}.css")
-          FileUtils.mkdir_p(File.dirname(target))
-          File.open(target, "w") {|io| io << engine.render }
-        end
+        FileUtils.cp_r(
+          root_dir.join("templates/styles").to_s,
+          root_dir.join("output/styles").to_s
+        )
       end
     end
   end