persie 0.0.1.alpha

data/lib/persie/builders/mobi.rb

@@ -0,0 +1,80 @@
+require_relative '../builder'
+
+module Persie
+  class Mobi < Builder
+
+    def initialize(book, options = {})
+      super
+    end
+
+    # Builds mobi.
+    def build
+      @ui.info '=== Build mobi ' << '=' * 57
+
+      self.check_dependency
+      check_sample
+      self.check_epub
+      self.generate_mobi
+
+      @ui.info END_LINE
+    end
+
+    def check_dependency
+      unless Dependency.kindlegen_installed?
+        @ui.error 'kindlegen not installed, termineted!'
+        @ui.info END_LINE
+        exit 41
+      end
+    end
+
+    # Checks if ePub file generated yet.
+    def check_epub
+      unless File.exist? self.epub_path
+        sample = sample? ? 'sample ' : nil
+        @ui.error "Please generate #{sample}ePub first"
+        @ui.info END_LINE
+        exit 42
+      end
+    end
+
+    # Generates mobi file.
+    def generate_mobi
+      FileUtils.chdir File.dirname(self.epub_path) do
+        @ui.info 'Converting to mobi...'
+
+        system "kindlegen -c2 #{self.epub_path(true)}"
+
+        mobi_file = File.basename(self.mobi_path)
+        if File.exist? mobi_file
+          prepare_directory(self.mobi_path)
+          FileUtils.mv(mobi_file, self.mobi_path)
+
+          @ui.confirm '    mobi file created'
+          @ui.info    "    Location: #{self.mobi_path(true)}"
+        else
+          @ui.error '    Can not create mobi'
+          @ui.info END_LINE
+          exit 43
+        end
+      end
+    end
+
+    # Gets ePub file path.
+    def epub_path(relative=false)
+      name = sample? ? "#{@book.slug}-sample" : @book.slug
+      return "#{name}.epub" if relative
+
+      File.join(@book.builds_dir, 'epub', "#{name}.epub")
+    end
+
+    # Gets mobi file path.
+    def mobi_path(relative = false)
+      name = sample? ? "#{@book.slug}-sample" : @book.slug
+      path = File.join('builds', 'mobi', "#{name}.mobi")
+      return path if relative
+
+      File.join(@book.base_dir, path)
+    end
+
+  end
+end

data/lib/persie/builders/pdf.rb

@@ -0,0 +1,113 @@
+require 'nokogiri'
+
+require_relative '../builder'
+
+module Persie
+  class PDF < Builder
+
+    def initialize(book, options = {})
+      super
+    end
+
+    # Builds PDF.
+    def build
+      @ui.info '=== Build PDF ' << '=' * 58
+
+      self.check_dependency
+      self.check_sample
+
+      self.convert_to_html
+      self.restart_page_number
+      self.convert_to_pdf
+
+      @ui.info END_LINE
+
+      nil
+    end
+
+    # Checks dependency.
+    def check_dependency
+      unless Dependency.prince_installed?
+        @ui.error 'Error: PrinceXML not installed'
+        @ui.info END_LINE
+        exit 22
+      end
+    end
+
+    # Gets HTML file path.
+    def html_path(relative = false)
+      name = sample? ? "#{@book.slug}-sample" : @book.slug
+      path = File.join('tmp', 'pdf', "#{name}.html")
+      return path if relative
+
+      File.join(@book.base_dir, path)
+    end
+
+    # Gets PDF file path.
+    def pdf_path(relative = false)
+      name = sample? ? "#{@book.slug}-sample" : @book.slug
+      path = File.join('builds', 'pdf', "#{name}.pdf")
+      return path if relative
+
+      File.join(@book.base_dir, path)
+    end
+
+    # Converts AsciiDoc document to HTML, and writes to a file.
+    def convert_to_html
+      @ui.info 'Converting to HTML...'
+      html = @document.convert
+      prepare_directory(self.html_path)
+      File.write(self.html_path, html)
+      @ui.confirm '    HTMl file created'
+      @ui.info    "    Location: #{self.html_path(true)}"
+      @ui.info '' # new line
+    end
+
+    # Restart PDF page number.
+    def restart_page_number
+      content = File.read(self.html_path)
+      root = ::Nokogiri::HTML(content)
+
+      # Has parts
+      if (parts = root.css('body > div[data-type="part"]')).size > 0
+        add_class(parts.first, 'restart_page_number')
+      # No parts, but has chapters
+      elsif (chapters = root.css('body > section[data-type="chapter"]')).size > 0
+        add_class(chapters.first, 'restart_page_number')
+      end
+
+      File.write(self.html_path, root.to_xhtml)
+    end
+
+    # Converts HTML to PDF with PrinceXML.
+    def convert_to_pdf
+      @ui.info 'Converting to PDF...'
+      prepare_directory(self.pdf_path)
+      system "prince #{self.html_path} -o #{self.pdf_path}"
+      if $?.to_i == 0
+        @ui.confirm '    PDF file created'
+        @ui.info    "    Location: #{self.pdf_path(true)}"
+      else
+        @ui.error '    Error: Cannot create PDF with PrinceXML'
+        @ui.info END_LINE
+        exit 23
+      end
+    end
+
+    private
+
+    def adoc_custom_attributes
+      {
+        'ebook-format' => 'pdf',
+        'outfilesuffix' => '.html'
+      }
+    end
+
+    # Add a class to a element.
+    def add_class(el, cls)
+      classes = el['class'].to_s.split(/\s+/)
+      el['class'] = classes.push(cls).uniq.join " "
+    end
+
+  end
+end

data/lib/persie/builders/site.rb

@@ -0,0 +1,110 @@
+require 'nokogiri'
+require 'liquid'
+require_relative '../builder'
+
+module Persie
+  class Site < Builder
+
+    def initialize(book, options = {})
+      super
+    end
+
+    # Builds a website.
+    def build
+      @ui.info '=== Build site ' << '=' * 57
+
+      if @options.multiple?
+        self.build_multiple
+        return nil
+      end
+
+      self.build_single
+
+      @ui.info END_LINE
+
+      nil
+    end
+
+    def build_multiple
+      @ui.warning "Multiple pages\n"
+
+      @ui.warning 'Not Implemented!'
+    end
+
+    # Builds single file website.
+    def build_single
+      @ui.warning "Single page\n"
+
+      html_path = File.join(@book.builds_dir, 'site', 'single' ,'index.html')
+      prepare_directory(html_path)
+
+      html = @document.convert
+      content = render_layout_of('single', assemble_payloads(html))
+
+      if content.nil?
+        File.write(html_path, html)
+      else
+        File.write(html_path, content)
+      end
+
+      if File.exist? html_path
+        @ui.confirm 'Site created'
+        @ui.info    "Location: site/single/index.html"
+      else
+        @ui.error 'Cannot create site'
+        @ui.info END_LINE
+        exit 52
+      end
+    end
+
+    private
+
+    def adoc_custom_attributes
+      {
+        'ebook-format' => 'site',
+        'single-page' => @options.multiple? ? false : true,
+        'outfilesuffix' => '.html'
+      }
+    end
+
+    # Assembles payloads for Liquid to render.
+    def assemble_payloads(html)
+      root = ::Nokogiri::HTML(html)
+      body = root.css('body')
+      body.css('> section[data-type="titlepage"]').unlink
+      toc = body.css('> nav[data-type="toc"]')
+      toc.unlink
+      footnotes = body.css('> div.footnotes')
+      footnotes.unlink
+
+      attrs = @document.attributes
+      custom = {
+        'title' => attrs['doctitle'],
+        'toc' => toc.to_xhtml,
+        'content' => body.to_xhtml,
+        'footnotes' => footnotes.to_xhtml,
+        'generator' => "persie ::Persie::VERSION"
+      }
+
+      attrs.merge(custom)
+    end
+
+    # Renders ERb layouts of `single' or `multiple'.
+    def render_layout_of(format, payloads)
+      unless ['single', 'multipe'].include? format
+        @ui.error "ONLY can render layout for `single' or `multiple'"
+        @ui.info END_LINE
+        exit 53
+      end
+
+      # Site templates stored in `themes/site/' folder
+      path = File.join @book.themes_dir, 'site', "#{format}.html.liquid"
+
+      return nil unless File.exist? path
+
+      tpl = ::Liquid::Template.parse File.read(path)
+      tpl.render(payloads)
+    end
+
+  end
+end

data/lib/persie/cli.rb

@@ -0,0 +1,106 @@
+require 'thor'
+require 'colorize'
+
+require_relative 'book'
+require_relative 'server'
+require_relative 'version'
+require_relative 'generator'
+
+module Persie
+  class Cli < ::Thor
+
+    desc 'check', 'Check dependencies'
+    def check
+      ok = 'installed'.colorize(:green)
+      ng = 'not installed'.colorize(:red)
+
+      output = '=== Check dependencies ' << '=' * 49
+      output << "\n"
+
+      output << 'PrinceXML: '
+      output << (Dependency.prince_installed? ? ok : ng)
+      output << "\n"
+
+      output << 'epubcheck: '
+      output << (Dependency.epubcheck_installed? ? ok : ng)
+      output << "\n"
+
+      output << 'kindlegen: '
+      output << (Dependency.kindlegen_installed? ? ok : ng)
+      output << "\n"
+
+      output << '=' * 72
+
+      $stdout.puts output
+    end
+
+    desc 'new PATH', 'Create a new book'
+    def new(path)
+      g = ::Persie::Generator.new
+      g.destination_root = path
+      g.invoke_all
+    end
+
+    desc 'build FORMAT', 'Build a ebook format, including pdf, epub, mobi and site'
+    method_option :debug, aliases: '-d',
+                          type: :boolean,
+                          desc: 'Debug mode'
+    method_option :sample, aliases: '-s',
+                           type: :boolean,
+                           desc: 'Build sample only'
+    method_option :validate, aliases: '-c',
+                             type: :boolean,
+                             desc: 'Validate epub with epubcheck'
+    method_option :baseurl, type: :string,
+                            desc: 'Base url for site'
+    method_option :multiple, aliases: '-m',
+                             type: :boolean,
+                             desc: 'Chunk site to multiple pages'
+    def build(format)
+      unless valid_book?
+        $stderr.puts 'Not a valid presie project.'.colorize(:red)
+        exit 11
+      end
+
+      book = ::Persie::Book.new root
+      case format
+      when 'pdf'
+        book.build_pdf(options)
+      when 'epub'
+        book.build_epub(options)
+      when 'mobi'
+        book.build_mobi(options)
+      when 'site'
+        book.build_site(options)
+      else
+        $stderr.puts 'Do not support build this formats.'.colorize(:red)
+      end
+    end
+
+    desc 'preview [FORMAT]', 'Preview site on a local server'
+    def preview(format)
+      unless ['single', 'multiple'].include? format
+        $stderr.puts 'Only supports preview "single" page or "multiple" pages site'.colorize(:red)
+        exit 51
+      end
+
+      Server.start(format)
+    end
+
+    desc 'version', 'Show the persie version'
+    def version
+      $stdout.puts "persie #{VERSION}"
+    end
+
+    private
+
+    def root
+      @root ||= Dir.pwd
+    end
+
+    def valid_book?
+      File.exist? File.join(root, 'book.adoc')
+    end
+
+  end
+end

data/lib/persie/dependency.rb

@@ -0,0 +1,26 @@
+module Persie
+  module Dependency
+
+    def self.prince_installed?
+      installed? 'prince'
+    end
+
+    def self.epubcheck_installed?
+      installed? 'epubcheck'
+    end
+
+    def self.kindlegen_installed?
+      installed? 'kindlegen'
+    end
+
+    def self.installed?(cmd)
+      return true if which(cmd)
+      false
+    end
+
+    # Finds the executable.
+    def self.which(cmd)
+      system "which #{cmd} > /dev/null 2>&1"
+    end
+  end
+end

data/lib/persie/generator.rb

@@ -0,0 +1,68 @@
+require 'thor'
+require 'uuid'
+
+require 'time'
+
+module Persie
+  class Generator < ::Thor::Group
+
+    include ::Thor::Actions
+
+    def self.source_root
+      File.join(::Persie::GEM_ROOT, 'templates')
+    end
+
+    def copy_master_file
+      template 'book.adoc.erb', 'book.adoc'
+    end
+
+    def copy_gitignore
+      copy_file 'gitignore.txt', '.gitignore'
+    end
+
+    def copy_gemfile
+      copy_file 'Gemfile.txt', 'Gemfile'
+    end
+
+    def copy_book_files
+      copy_file 'preface.adoc', 'manuscript/preface.adoc'
+      copy_file 'chapter1.adoc', 'manuscript/chapter1.adoc'
+      copy_file 'chapter2.adoc', 'manuscript/chapter2.adoc'
+    end
+
+    def create_theme_dirs
+      empty_directory 'themes/pdf'
+      empty_directory 'themes/epub'
+      empty_directory 'themes/mobi'
+      empty_directory 'themes/site/single'
+      empty_directory 'themes/site/multiple'
+    end
+
+    def create_build_dir
+      empty_directory 'builds'
+    end
+
+    def create_tmp_dir
+      empty_directory 'tmp'
+    end
+
+    def create_images_dir
+      empty_directory 'images'
+    end
+
+    def create_plugins_dir
+      empty_directory 'plugins'
+    end
+
+    private
+
+    def uuid
+      UUID.new.generate(:urn)
+    end
+
+    def time_now
+      Time.now.iso8601
+    end
+
+  end
+end

data/lib/persie/server.rb

@@ -0,0 +1,27 @@
+require 'webrick'
+
+module Persie
+  module Server
+
+    include WEBrick
+
+    def self.start(dir)
+      destination = File.join(Dir.pwd, 'builds', 'site', dir)
+
+      # recreate NondisclosureName under utf-8 circumstance
+      fh_option = WEBrick::Config::FileHandler
+      fh_option[:NondisclosureName] = ['.ht*','~*']
+
+      s = HTTPServer.new(
+        :Port => 9527,
+        :BindAddress => '0.0.0.0',
+      )
+
+      s.mount('/', HTTPServlet::FileHandler, destination, fh_option)
+      t = Thread.new { s.start }
+      trap("INT") { s.shutdown }
+      t.join()
+    end
+
+  end
+end

data/lib/persie/ui.rb

@@ -0,0 +1,27 @@
+require 'colorize'
+
+module Persie
+  class UI
+
+    def initialize(options= {})
+      @test_mode = options.has_key?(:test) && options[:test] === true
+    end
+
+    def info(msg)
+      $stdout.puts msg unless @test_mode
+    end
+
+    def confirm(msg)
+      $stdout.puts msg.colorize(:green) unless @test_mode
+    end
+
+    def error(msg)
+      $stderr.puts msg.colorize(:red) unless @test_mode
+    end
+
+    def warning(msg)
+      $stdout.puts msg.colorize(:yellow) unless @test_mode
+    end
+
+  end
+end

data/lib/persie/version.rb

@@ -0,0 +1,3 @@
+module Persie
+  VERSION = '0.0.1.alpha'
+end

data/lib/persie.rb

@@ -0,0 +1,32 @@
+require_relative 'persie/cli'
+
+Encoding.default_internal = 'utf-8'
+Encoding.default_external = 'utf-8'
+
+module Persie
+  GEM_ROOT      = File.expand_path('../../', __FILE__)
+  TEMPLATES_DIR = File.join(GEM_ROOT, 'templates')
+
+  def self.ruby_platform_warning
+    host = RbConfig::CONFIG['host_os']
+    if host =~ /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+      $stderr.puts 'Sorry, you cannot use persie on Windows.'
+      exit 1
+    end
+  end
+
+  def self.ruby_version_warning
+    if RUBY_VERSION < '1.9.3'
+      $stderr.puts "Your Ruby version(#{RUBY_VERSION}) is NOT supported, please upgrade!"
+      exit 2
+    end
+  end
+
+  def self.require_plugins
+    plugins = File.join(Dir.pwd, 'plugins', '*.rb')
+
+    Dir.glob(plugins) do |path|
+      require path
+    end
+  end
+end

data/persie.gemspec

@@ -0,0 +1,41 @@
+$:.unshift File.expand_path('../lib', __FILE__)
+
+require 'persie/version'
+
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+
+  s.name              = 'persie'
+  s.version           = ::Persie::VERSION
+  s.license           = 'MIT'
+  s.date              = '2014-06-18'
+
+  s.summary     = "电子书制作工具"
+  s.description = "使用 AsciiDoc 编写书籍内容，通过 persie 将其转换成 PDF，ePub 和 Mobi 格式电子书。"
+
+  s.authors  = ["Andor Chen"]
+  s.email    = 'andor.chen.27@gmail.com'
+  s.homepage = 'https://github.com/AndorChen/persie'
+
+  s.require_paths = %w[lib]
+  s.executables = ["persie"]
+  s.files = `git ls-files`.split($/)
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md LICENSE]
+
+  s.add_runtime_dependency('thor',         '0.19.1')
+  s.add_runtime_dependency('uuid',         '2.3.7')
+  s.add_runtime_dependency('rouge',        '1.7.1')
+  s.add_runtime_dependency('gepub',        '0.6.9.2')
+  s.add_runtime_dependency('liquid',       '2.6.1')
+  s.add_runtime_dependency('colorize',     '0.7.3')
+  s.add_runtime_dependency('nokogiri',     '1.6.3.1')
+  s.add_runtime_dependency('thread_safe',  '0.3.4')
+  s.add_runtime_dependency('asciidoctor',  '1.5.1')
+
+  s.add_development_dependency('rake',     '~> 10.3.2')
+  s.add_development_dependency('rspec', '~> 3.1.0')
+end

data/spec/build_pdf_command_spec.rb

@@ -0,0 +1,25 @@
+require_relative 'spec_helper'
+
+describe 'Cli#build(pdf)' do
+
+  it 'generates a pdf file' do
+    FileUtils.cd(A_BOOK_PATH) do
+      persie_command 'build pdf'
+      path = 'builds/pdf/a-book.pdf'
+      expect(File.exist?(path)).to be true
+      FileUtils.remove_dir('tmp/pdf')
+      FileUtils.remove_dir('builds/pdf')
+    end
+  end
+
+  it 'generates a sample pdf file' do
+    FileUtils.cd(A_BOOK_PATH) do
+      persie_command 'build pdf -s'
+      path = 'builds/pdf/a-book-sample.pdf'
+      expect(File.exist?(path)).to be true
+      FileUtils.remove_dir('tmp/pdf')
+      FileUtils.remove_dir('builds/pdf')
+    end
+  end
+
+end

data/spec/fixtures/a-book/.gitignore

@@ -0,0 +1,2 @@
+builds/
+tmp/

data/spec/fixtures/a-book/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'persie', '0.0.1.alpha'