bookshelf 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+pkg
+tmp
+spec/support/mybook/output/mybook.*

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "lib/bookshelf/vendor/colorize"]
+	path = lib/bookshelf/vendor/colorize
+	url = git://github.com/fnando/colorize.git

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    bookshelf (1.0.4)
+      RedCloth
+      activesupport
+      coderay
+      eeepub-with-cover-support
+      i18n
+      nokogiri
+      notifier
+      rdiscount
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    RedCloth (4.2.9)
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    awesome_print (1.1.0)
+    builder (3.2.0)
+    coderay (1.0.9)
+    diff-lcs (1.2.2)
+    eeepub-with-cover-support (0.8.7)
+      builder
+      rubyzip
+    i18n (0.6.4)
+    method_source (0.8.1)
+    multi_json (1.7.2)
+    nokogiri (1.5.9)
+    notifier (0.4.1)
+    pry (0.9.12)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry-nav (0.2.3)
+      pry (~> 0.9.10)
+    rake (10.0.4)
+    rdiscount (2.0.7.1)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+    rubyzip (0.9.9)
+    slop (3.4.4)
+    test_notifier (1.0.1)
+      notifier
+    thor (0.18.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  bookshelf!
+  pry
+  pry-nav
+  rake
+  rspec
+  test_notifier

data/README.md

@@ -0,0 +1,162 @@
+# Bookshelf
+
+Bookshelf is a tool for the self-publishing of books. It is inspired by (and heavily based off) the excellent Kitabu gem [https://github.com/fnando/kitabu]().
+
+## Features
+* Generate HTML, PDF, e-Pub, Mobi and Text files
+* Multi book support
+* Write using Markdown, Textile or plain HTML
+* Book layout support
+* Custom font support
+* SCSS support
+* Table of Contents generation
+
+## Installation
+
+To install Bookshelf, you’ll need a working Ruby 1.9+ installation.
+If you’re cool with it, just run the following command to install it.
+
+    gem install bookshelf
+
+After installing Bookshelf, run the following command to check your external
+dependencies.
+
+    $ bookshelf check
+
+    Prince XML: Converts HTML files into PDF files.
+    Installed.
+
+    KindleGen: Converts ePub e-books into .mobi files.
+    Installed.
+
+    html2text: Converts HTML documents into plain text.
+    Not installed.
+
+There's no requirements here; just make sure you cleared the correct dependency based
+on the formats you want to export to.
+
+## Getting Started
+
+We first need to generate a new bookshelf project
+
+    $ bookshelf new my_bookshelf
+
+This command creates a directory `my_bookshelf` with the following structure:
+
+    my_bookshelf
+    ├── assets  
+    │   ├── fonts
+    │   ├── images
+    │   └── styles
+    │       ├── _fonts.scss
+    │       ├── epub.scss
+    │       └── html.scss
+    ├── books
+    ├── config
+    │   ├── config.yml
+    │   └── helper.rb
+    ├── output
+    └── templates
+        ├── epub
+        │   ├── cover.erb
+        │   ├── page.erb
+        └── html
+            └── layout.erb
+            
+## Creating a new Book
+
+To add a book create a folder under the `books` directory, named as per the title.
+
+    my_bookshelf
+    └── books
+        └── my_book
+
+Copy the `config.yml` file from `my_bookshelf/config/config.yml` into `my_bookshelf/books/my_book`
+
+Update `my_bookshelf/config/config.yml` to reflect the books title, author and other attributes.
+
+## Authoring
+
+Now, create the content for your book by creating markdown or textile files into the `my_bookshelf/books/my_book` directory. You have two options here but both are dependent on the numeric prefix assigned to the file to determine their order.
+
+*Option 1 - Directories for chapters:*
+
+    my_bookshelf
+    └── books
+        └── my_book
+            ├── 01_introduction
+            │   ├── 01_section_1.markdown
+            │   ├── 02_section_2.markdown
+            │   └── ...
+            ├── 02_chapter_1
+            │   ├── 01_section_1.markdown
+            │   ├── 02_section_2.markdown
+            │   └── ...
+            ├── 03_chapter_2
+            ├── 04_chapter_3
+            └── ...
+
+*Option 2 - Files for chapters:*
+
+    my_bookshelf
+    └── books
+        └── my_book
+            ├── 01_introduction.markdown
+            ├── 02_chapter_1.markdown
+            ├── 03_chapter_2.markdown
+            ├── 04_chapter_3.markdown
+            └── ...
+
+Note that you if the number of chapters in your book is likely to exceed 10, you should add an extra 0 to the front of the chapter directory/file names
+
+Note that you can use any format you want at the same time. Just use one of the following extensions: `.html`, `.markdown`, `.mkdn` or `.textile`.
+
+## Exporting
+
+You'll want to see your progress eventually; it's time for you to generate the book PDF. Just run the command `bookshelf export` and your book will be created in the `output` directory.
+
+Bookshelf 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 %>
+
+## Markdown Processors
+
+By default, RDiscount[http://github.com/rtomayko/rdiscount/tree/master] is the Markdown processor. However, you can switch to different implementations by simply installing any of the following processors:
+
+* Maruku: https://rubygems.org/gems/maruku
+* PEGMarkdown: https://rubygems.org/gems/rpeg-markdown
+* BlueCloth: https://rubygems.org/gems/bluecloth
+* Redcarpet: https://rubygems.org/gems/redcarpet
+
+Note: RDiscount will always be installed as Bookshelf's dependency but only used when no
+alternative library is available.
+
+## References
+
+* Textile: http://hobix.com/textile
+* Markdown: http://daringfireball.net/projects/markdown/syntax
+
+## 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.

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new

data/bin/bookshelf

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+
+require "bookshelf"
+Bookshelf::Cli.start

data/bookshelf.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "bookshelf/version"
+
+Gem::Specification.new do |s|
+  s.name                  = "bookshelf"
+  s.version               = Bookshelf::Version::STRING
+  s.platform              = Gem::Platform::RUBY
+  s.required_ruby_version = ">= 1.9"
+  s.authors               = ["Brad Crawford"]
+  s.email                 = ["brad.robert.crawford@gmail.com"]
+  s.homepage              = "https://bitbucket.org/bradcrawford/bookshelf"
+  s.summary               = "A framework that generates PDF and e-Pub from Markdown, Textile, and HTML files."
+  s.description           = s.summary
+  s.license               = "MIT"
+
+  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.require_paths = ["lib"]
+
+  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 "eeepub-with-cover-support"
+  s.add_dependency "notifier"
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "test_notifier"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "pry-nav"
+  s.add_development_dependency "awesome_print"
+end

data/lib/bookshelf.rb

@@ -0,0 +1,64 @@
+require "active_support/all"
+require "digest/md5"
+require "eeepub"
+require "erb"
+require "logger"
+require "nokogiri"
+require "notifier"
+require "open3"
+require "optparse"
+require "ostruct"
+require "RedCloth"
+require "tempfile"
+require "pathname"
+require "thor"
+require "thor/group"
+require "yaml"
+require "cgi"
+
+%w[maruku peg_markdown bluecloth redcarpet rdiscount].each do |lib|
+  begin
+    require lib
+    break
+  rescue LoadError => e
+    next
+  end
+end
+
+Encoding.default_internal = "utf-8"
+Encoding.default_external = "utf-8"
+
+module Bookshelf
+  require "bookshelf/extensions/string"
+  require "bookshelf/extensions/redcloth"
+  require "bookshelf/errors"
+
+  ROOT = Pathname.new(File.dirname(__FILE__) + "/..")
+
+  autoload :Version,    "bookshelf/version"
+  autoload :Generator,  "bookshelf/generator"
+  autoload :TOC,        "bookshelf/toc"
+  autoload :Cli,        "bookshelf/cli"
+  autoload :Markdown,   "bookshelf/adapters/markdown"
+  autoload :Parser,     "bookshelf/parser"
+  autoload :Exporter,   "bookshelf/exporter"
+  autoload :Syntax,     "bookshelf/syntax"
+  autoload :Stream,     "bookshelf/stream"
+  autoload :Dependency, "bookshelf/dependency"
+  autoload :Stats,      "bookshelf/stats"
+
+  def self.config(book_dir = nil)
+    path = book_dir.join("config.yml")
+    content = File.read(path)
+    erb = ERB.new(content).result
+    YAML.load(erb).with_indifferent_access
+  end
+
+  def self.logger
+    @logger ||= Logger.new(File.open("/tmp/bookshelf.log", "a"))
+  end
+
+  def self.root_dir
+    @root_dir ||= Pathname.new(Dir.pwd)
+  end
+end

data/lib/bookshelf/adapters/markdown.rb

@@ -0,0 +1,34 @@
+module Bookshelf
+  class Markdown
+    # Supported Markdown libraries
+    #
+    MARKDOWN_LIBRARIES = %w[Maruku BlueCloth PEGMarkdown Redcarpet RDiscount]
+
+    # Retrieve preferred Markdown processor.
+    # You'll need one of the following libraries:
+    #
+    # # RDiscount: https://rubygems.org/gems/rdiscount
+    # # Maruku: https://rubygems.org/gems/maruku
+    # # PEGMarkdown: https://rubygems.org/gems/rpeg-markdown
+    # # BlueCloth: https://rubygems.org/gems/bluecloth
+    # # Redcarpet: https://rubygems.org/gems/redcarpet
+    #
+    # Note: RDiscount will always be installed as Bookshelf's dependency but only used when no
+    # alternative library is available.
+    #
+    def self.engine
+      @engine ||= Object.const_get(MARKDOWN_LIBRARIES.find {|lib| Object.const_defined?(lib)})
+    end
+
+    # Convert Markdown to HTML.
+    def self.to_html(content)
+      case engine.name
+      when "Redcarpet"
+        render = Redcarpet::Render::HTML.new(:hard_wrap => true, :xhtml => true)
+        Redcarpet::Markdown.new(render).render(content)
+      else
+        engine.new(content).to_html
+      end
+    end
+  end
+end

data/lib/bookshelf/cli.rb

@@ -0,0 +1,125 @@
+# -*- encoding: utf-8 -*-
+module Bookshelf
+  class Cli < Thor
+    FORMATS = %w[pdf html epub mobi txt]
+    check_unknown_options!
+
+    def self.exit_on_failure?
+      true
+    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: bookshelf help new"
+      end
+
+      super
+    end
+
+    desc "new EBOOK_PATH", "Generate a new e-book structure"
+
+    def new(path)
+      generator = Generator.new
+      generator.destination_root = path
+      generator.invoke_all
+    end
+
+    desc "export [OPTIONS]", "Export e-book"
+    method_option :only, :type => :string, :desc => "Can be one of: #{FORMATS.join(", ")}"
+
+    def export
+      if options[:only] && !FORMATS.include?(options[:only])
+        raise Error, "The --only option need to be one of: #{FORMATS.join(", ")}"
+      end
+
+      book_dirs = if options[:book]
+        [Bookshelf.root_dir.join("books/#{options[:book]}")]
+      else
+        Dir.glob(Bookshelf.root_dir.join("books/*")).map{|book_dir| Pathname.new(book_dir) }
+      end
+
+      book_dirs.each do |book_dir|
+        Bookshelf::Exporter.run(book_dir, options)        
+      end
+    end
+
+    desc "version", "Prints the Bookshelf's version information"
+    map %w(-v --version) => :version
+
+    def version
+      say "Bookshelf version #{Version::STRING}"
+    end
+
+    desc "check", "Check if all external dependencies are installed"
+
+    def check
+      result = []
+
+      result << {
+        :description => "Prince XML: Converts HTML files into PDF files.",
+        :installed => Bookshelf::Dependency.prince?
+      }
+
+      result << {
+        :description => "KindleGen: Converts ePub e-books into .mobi files.",
+        :installed => Bookshelf::Dependency.kindlegen?
+      }
+
+      result << {
+        :description => "html2text: Converts HTML documents into plain text.",
+        :installed => Bookshelf::Dependency.html2text?
+      }
+
+      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 << "\n"
+
+        say(text)
+      end
+    end
+
+    desc "permalinks", "List title permalinks"
+
+    def permalinks
+      html = Bookshelf::Parser::HTML.new(Bookshelf.root_dir).content
+      toc = Bookshelf::TOC::HTML.generate(html)
+
+      toc.toc.each do |options|
+        level = options[:level] - 1
+        title = " #{options[:text]}: "
+        permalink = "##{options[:permalink]}"
+
+        text = "*" * level
+        text << color(title, :blue)
+        text << color(permalink, :yellow)
+        say(text)
+      end
+    end
+
+    desc "stats", "Display some stats about your e-book"
+    def stats
+      stats = Bookshelf::Stats.new(Bookshelf.root_dir)
+
+      say [
+        "Chapters: #{stats.chapters}",
+        "Words: #{stats.words}",
+        "Images: #{stats.images}",
+        "Links: #{stats.links}",
+        "Footnotes: #{stats.footnotes}",
+        "Code blocks: #{stats.code_blocks}"
+      ].join("\n")
+    end
+
+    private
+
+    def color(text, color)
+      color? ? shell.set_color(text, color) : text
+    end
+
+    def color?
+      shell.instance_of?(Thor::Shell::Color)
+    end
+  end
+end