kitabu 1.0.6 → 2.0.0

data/kitabu.gemspec

@@ -6,11 +6,11 @@ Gem::Specification.new do |s|
   s.name                  = "kitabu"
   s.version               = Kitabu::Version::STRING
   s.platform              = Gem::Platform::RUBY
-  s.required_ruby_version = ">= 1.9"
+  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 that generates PDF and e-Pub from Markdown, Textile, and HTML files."
+  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"
 
@@ -21,17 +21,19 @@ Gem::Specification.new do |s|
 
   s.add_dependency "activesupport"
   s.add_dependency "nokogiri"
-  s.add_dependency "RedCloth"
-  s.add_dependency "rdiscount"
   s.add_dependency "i18n"
   s.add_dependency "thor"
+  s.add_dependency "redcarpet"
   s.add_dependency "eeepub-with-cover-support"
-  s.add_dependency "coderay"
+  s.add_dependency "rouge"
   s.add_dependency "notifier"
   s.add_dependency "rubyzip"
   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"
 end

data/lib/kitabu.rb

@@ -8,32 +8,22 @@ require "notifier"
 require "open3"
 require "optparse"
 require "ostruct"
-require "RedCloth"
 require "tempfile"
 require "pathname"
 require "thor"
 require "thor/group"
 require "yaml"
 require "cgi"
+require "erb"
 
-I18n.enforce_available_locales = false
+require "redcarpet"
+require "rouge"
+require "rouge/plugins/redcarpet"
 
-%w[pygments.rb coderay].each do |lib|
-  begin
-    require lib
-  rescue LoadError => e
-    next
-  end
-end
+require "sass"
+require "sass-globbing"
 
-%w[maruku peg_markdown bluecloth redcarpet rdiscount].each do |lib|
-  begin
-    require lib
-    break
-  rescue LoadError => e
-    next
-  end
-end
+I18n.enforce_available_locales = false
 
 Encoding.default_internal = "utf-8"
 Encoding.default_external = "utf-8"
@@ -42,19 +32,19 @@ module Kitabu
   ROOT = Pathname.new(File.dirname(__FILE__) + "/..")
 
   require "kitabu/extensions/string"
-  require "kitabu/extensions/redcloth"
+  require "kitabu/extensions/rouge"
   require "kitabu/errors"
   require "kitabu/version"
   require "kitabu/generator"
   require "kitabu/toc"
   require "kitabu/cli"
-  require "kitabu/adapters/markdown"
+  require "kitabu/markdown"
   require "kitabu/parser"
   require "kitabu/exporter"
-  require "kitabu/syntax"
   require "kitabu/stream"
   require "kitabu/dependency"
   require "kitabu/stats"
+  require "kitabu/helpers"
 
   def self.config(root_dir = nil)
     root_dir ||= Pathname.new(Dir.pwd)

data/lib/kitabu/cli.rb

@@ -65,11 +65,6 @@ module Kitabu
         :installed => Kitabu::Dependency.html2text?
       }
 
-      result << {
-        :description => "pygments.rb: A generic syntax highlight. If installed, replaces CodeRay.",
-        :installed => Kitabu::Dependency.pygments_rb?
-      }
-
       result.each do |result|
         text = color(result[:name], :blue)
         text << "\n" << result[:description]

data/lib/kitabu/dependency.rb

@@ -11,9 +11,5 @@ module Kitabu
     def self.html2text?
       @html2text ||= `which html2text` && $?.success?
     end
-
-    def self.pygments_rb?
-      @pygments_rb ||= defined?(Pygments)
-    end
   end
 end

data/lib/kitabu/exporter.rb

@@ -21,6 +21,8 @@ module Kitabu
       helper = root_dir.join("config/helper.rb")
       load(helper) if helper.exist?
 
+      FileUtils.rm_rf root_dir.join("output").to_s
+
       export_pdf = [nil, "pdf"].include?(options[:only])
       export_epub = [nil, "mobi", "epub"].include?(options[:only])
       export_mobi = [nil, "mobi"].include?(options[:only])

data/lib/kitabu/extensions/rouge.rb

@@ -0,0 +1,9 @@
+module Rouge
+  module Plugins
+    module Redcarpet
+      def rouge_formatter(lexer)
+        Formatters::HTML.new({css_class: "highlight #{lexer.tag}"}.merge(lexer.options))
+      end
+    end
+  end
+end

data/lib/kitabu/generator.rb

@@ -14,22 +14,16 @@ module Kitabu
       File.dirname(__FILE__) + "/../../templates"
     end
 
-    def copy_html_templates
-      copy_file "layout.erb"  , "templates/html/layout.erb"
-      copy_file "layout.css"  , "templates/html/layout.css"
-      copy_file "user.css"    , "templates/html/user.css"
-      copy_file "syntax.css"  , "templates/html/syntax.css"
+    def copy_templates
+      directory "templates", "templates"
     end
 
-    def copy_epub_templates
-      copy_file "cover.erb"   , "templates/epub/cover.erb"
-      copy_file "epub.css"    , "templates/epub/user.css"
-      copy_file "epub.erb"    , "templates/epub/page.erb"
-      copy_file "cover.png"   , "templates/epub/cover.png"
+    def copy_sample_texts
+      directory "text", "text"
     end
 
-    def copy_sample_page
-      copy_file "sample.md"   , "text/01_Welcome.md"
+    def copy_images
+      directory "images", "images"
     end
 
     def copy_config_file
@@ -44,27 +38,21 @@ module Kitabu
     end
 
     def copy_gemfile
-      copy_file "Gemfile", "Gemfile"
+      copy_file "Gemfile"
     end
 
     def create_directories
       empty_directory "output"
-      empty_directory "images"
-      empty_directory "code"
     end
 
     def create_git_files
       create_file ".gitignore" do
-        "output/*.{html,epub,pdf}\noutput/tmp"
+        "/output"
       end
-
-      create_file "output/.gitkeep"
-      create_file "images/.gitkeep"
-      create_file "code/.gitkeep"
     end
 
     def copy_guardfile
-      copy_file "Guardfile", "Guardfile"
+      copy_file "Guardfile"
     end
 
     def bundle_install

data/lib/kitabu/helpers.rb

@@ -0,0 +1,47 @@
+module Kitabu
+  module Helpers
+    def highlight_theme(name = theme)
+      html = '<style type="text/css">'
+      html << Rouge::Theme.find(name).render(scope: '.highlight')
+      html << '</style>'
+      html
+    end
+
+    def image_tag(path, attributes = {})
+      html = %[<img src="images/#{path}" />]
+    end
+
+    def escape_html(content)
+      CGI.escape_html(content.to_s)
+    end
+
+    def note(class_name = :info, &block)
+      content = block_content(block)
+      output << '<div class="note %s">' % escape_html(class_name)
+      output << markdown(content)
+      output << '</div>'
+    end
+
+    def block_content(block)
+      output, @_output = @_output.dup, ''
+      content = block.call
+      @_output = output
+      content
+    end
+
+    def markdown(content, deindent_content = true)
+      content = deindent(content) if deindent_content
+      Markdown.render(content)
+    end
+
+    def deindent(content)
+      content = content.to_s
+      indent = (content.scan(/^[ \t]*(?=\S)/) || []).size
+      content.gsub(/^[ \t]{#{indent}}/, '')
+    end
+
+    def output
+      @_output
+    end
+  end
+end

data/lib/kitabu/markdown.rb

@@ -0,0 +1,31 @@
+module Kitabu
+  module Markdown
+    class Renderer < Redcarpet::Render::HTML
+      include Redcarpet::Render::SmartyPants
+      include Rouge::Plugins::Redcarpet
+    end
+
+    class << self
+      # Set markdown renderer
+      attr_accessor :processor
+    end
+
+    renderer = Renderer.new(hard_wrap: true, safe_links_only: true)
+
+    self.processor = Redcarpet::Markdown.new(renderer, {
+      tables: true,
+      footnotes: true,
+      space_after_headers: true,
+      superscript: true,
+      highlight: true,
+      strikethrough: true,
+      autolink: true,
+      fenced_code_blocks: true,
+      no_intra_emphasis: true
+    })
+
+    def self.render(text)
+      processor.render(text)
+    end
+  end
+end

data/lib/kitabu/parser.rb

@@ -41,12 +41,13 @@ module Kitabu
       # Render a eRb template using +locals+ as data seed.
       #
       def render_template(file, locals = {})
-        ERB.new(File.read(file)).result OpenStruct.new(locals).instance_eval{ binding }
+        context = OpenStruct.new(locals).extend(Helpers)
+        ERB.new(File.read(file), 0, "%<>", "@_output").result context.instance_eval { binding }
       end
 
-      def spawn_command(cmd)
+      def spawn_command(command)
         begin
-          stdout_and_stderr, status = Open3.capture2e(*cmd)
+          stdout_and_stderr, status = Open3.capture2e(*command)
         rescue Errno::ENOENT => e
           puts e.message
         else
@@ -54,6 +55,23 @@ module Kitabu
           status.success?
         end
       end
+
+      def ui
+        @ui ||= Thor::Base.shell.new
+      end
+
+      def handle_error(error)
+        ui.say "#{error.class}: #{error.message}", :red
+        ui.say error.backtrace.join("\n"), :white
+      end
+
+      def copy_directory(source, target)
+        source = root_dir.join("#{source}/.")
+        target = root_dir.join(target)
+
+        FileUtils.mkdir_p target
+        FileUtils.cp_r source, target, remove_destination: true
+      end
     end
   end
 end

data/lib/kitabu/parser/epub.rb

@@ -4,10 +4,10 @@ module Kitabu
       def sections
         @sections ||= html.css("div.chapter").each_with_index.map do |chapter, index|
           OpenStruct.new({
-            :index    => index,
-            :filename => "section_#{index}.html",
-            :filepath => tmp_dir.join("section_#{index}.html").to_s,
-            :html     => Nokogiri::HTML(chapter.inner_html)
+            index: index,
+            filename: "section_#{index}.html",
+            filepath: tmp_dir.join("section_#{index}.html").to_s,
+            html: Nokogiri::HTML(chapter.inner_html)
           })
         end
       end
@@ -21,15 +21,9 @@ module Kitabu
       end
 
       def parse
-        epub.title        config[:title]
-        epub.language     config[:language]
-        epub.creator      config[:authors].to_sentence
-        epub.publisher    config[:publisher]
-        epub.date         config[:published_at]
-        epub.uid          config[:uid]
-        epub.identifier   config[:identifier][:id], :scheme => config[:identifier][:type]
-        epub.cover_page   cover_image if cover_image && File.exist?(cover_image)
-
+        copy_styles!
+        copy_images!
+        set_metadata!
         write_sections!
         write_toc!
 
@@ -40,11 +34,30 @@ module Kitabu
         epub.save(epub_path)
 
         true
-      rescue Exception
-        p $!, $@
+      rescue Exception => error
+        handle_error(error)
         false
       end
 
+      def copy_styles!
+        copy_directory("output/styles", "output/epub/styles")
+      end
+
+      def copy_images!
+        copy_directory("output/images", "output/epub/images")
+      end
+
+      def set_metadata!
+        epub.title        config[:title]
+        epub.language     config[:language]
+        epub.creator      config[:authors].to_sentence
+        epub.publisher    config[:publisher]
+        epub.date         config[:published_at]
+        epub.uid          config[:uid]
+        epub.identifier   config[:identifier][:id], scheme: config[:identifier][:type]
+        epub.cover_page   cover_image if cover_image && File.exist?(cover_image)
+      end
+
       def write_toc!
         toc = TOC::Epub.new(navigation)
 
@@ -116,8 +129,8 @@ module Kitabu
       def navigation
         sections.map do |section|
           {
-            :label => section.html.css("h2:first-of-type").text,
-            :content => section.filename
+            label: section.html.css("h2:first-of-type").text,
+            content: section.filename
           }
         end
       end
@@ -135,7 +148,7 @@ module Kitabu
       end
 
       def tmp_dir
-        root_dir.join("output/tmp")
+        root_dir.join("output/epub")
       end
 
       def toc_path

data/lib/kitabu/parser/html.rb

@@ -11,7 +11,7 @@ module Kitabu
 
       # List of recognized extensions.
       #
-      EXTENSIONS = %w[md mkdn markdown textile html]
+      EXTENSIONS = %w[md erb]
 
       class << self
         # The footnote index control. We have to manipulate footnotes
@@ -25,12 +25,16 @@ module Kitabu
       #
       def parse
         reset_footnote_index!
+        copy_images!
+        export_stylesheets!
 
         File.open(root_dir.join("output/#{name}.html"), "w") do |file|
           file << parse_layout(content)
         end
+
         true
-      rescue Exception
+      rescue Exception => error
+        handle_error(error)
         false
       end
 
@@ -68,7 +72,7 @@ module Kitabu
         if File.file?(entry)
           [entry]
         else
-          Dir.glob("#{entry}/**/*.{#{EXTENSIONS.join(",")}}").sort
+          Dir["#{entry}/**/*.{#{EXTENSIONS.join(",")}}"].sort
         end
       end
 
@@ -94,24 +98,18 @@ module Kitabu
 
       # Render +file+ considering its extension.
       #
-      def render_file(file, plain_syntax = false)
-        file_format = format(file)
-
-        content = Kitabu::Syntax.render(root_dir, file_format, File.read(file), plain_syntax)
-
-        content = case file_format
-        when :markdown
-          Markdown.to_html(content)
-        when :textile
-          RedCloth.convert(content)
+      def render_file(file)
+        if format(file) == :erb
+          content = render_template(file, config)
         else
-          content
+          content = File.read(file)
         end
 
-        render_footnotes(content, plain_syntax)
+        content = Kitabu::Markdown.render(content)
+        render_footnotes(content)
       end
 
-      def render_footnotes(content, plain_syntax = false)
+      def render_footnotes(content)
         html = Nokogiri::HTML(content)
         footnotes = html.css("p[id^='fn']")
 
@@ -144,13 +142,10 @@ module Kitabu
       end
 
       def format(file)
-        case File.extname(file).downcase
-        when ".markdown", ".mkdn", ".md"
-          :markdown
-        when ".textile"
-          :textile
+        if File.extname(file) == '.erb'
+          :erb
         else
-          :html
+          :markdown
         end
       end
 
@@ -159,9 +154,9 @@ module Kitabu
       def parse_layout(html)
         toc = TOC::HTML.generate(html)
         locals = config.merge({
-          :content   => toc.content,
-          :toc       => toc.to_html,
-          :changelog => render_changelog
+          content: toc.content,
+          toc: toc.to_html,
+          changelog: render_changelog
         })
         render_template(root_dir.join("templates/html/layout.erb"), locals)
       end
@@ -171,19 +166,43 @@ module Kitabu
       #
       def render_changelog
         changelog = Dir[root_dir.join("text/CHANGELOG.*")].first
-        return render_file(changelog) if changelog
-        nil
+        render_file(changelog) if changelog
       end
 
       # Render all +files+ from a given chapter.
       #
-      def render_chapter(files, plain_syntax = false)
+      def render_chapter(files)
         String.new.tap do |chapter|
           files.each do |file|
-            chapter << render_file(file, plain_syntax) << "\n\n"
+            chapter << render_file(file) << "\n\n"
           end
         end
       end
+
+      # Copy images
+      #
+      def copy_images!
+        copy_directory("images", "output/images")
+      end
+
+      # Export all root stylesheets.
+      #
+      def export_stylesheets!
+        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
+      end
     end
   end
 end