bookshelf 1.2.1 → 1.2.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ca72a0bb5534f5505ce7a5a4ae4c20711b083ec7
+  data.tar.gz: c979a59886cf912e078431ef202da4256c03d7bc
+SHA512:
+  metadata.gz: 378336cfdd6f6658858b0a03c8a29efac014a33b6812ab3aa868c230e0ad572f6baa4b4df5357381f94803b37825ca1c5f83226d994bc1c2820889880dae6d63
+  data.tar.gz: e4094652e1759e850c1e14a79f89bc8e798e6c9ab28f74642c2ff2b65d030ab0a1735a1f76f7dd9b06460e29a14c3308e68d02309436ef717849282029da5187

data/Gemfile.lock

@@ -1,35 +1,36 @@
 PATH
   remote: .
   specs:
-    bookshelf (1.0.4)
-      RedCloth
+    bookshelf (1.2.3)
       activesupport
-      coderay
-      eeepub-with-cover-support
       i18n
+      maruku
       nokogiri
       notifier
-      rdiscount
+      rubyzip
+      sass
       thor
 
 GEM
   remote: https://rubygems.org/
   specs:
-    RedCloth (4.2.9)
-    activesupport (3.2.12)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
+    activesupport (4.1.0)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
     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)
+    i18n (0.6.9)
+    json (1.8.1)
+    maruku (0.7.0)
     method_source (0.8.1)
-    multi_json (1.7.2)
-    nokogiri (1.5.9)
+    mini_portile (0.5.3)
+    minitest (5.3.2)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
     notifier (0.4.1)
     pry (0.9.12)
       coderay (~> 1.0.5)
@@ -38,7 +39,6 @@ GEM
     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)
@@ -47,11 +47,15 @@ GEM
     rspec-expectations (2.13.0)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.13.0)
-    rubyzip (0.9.9)
+    rubyzip (1.1.3)
+    sass (3.3.4)
     slop (3.4.4)
     test_notifier (1.0.1)
       notifier
-    thor (0.18.1)
+    thor (0.19.1)
+    thread_safe (0.3.3)
+    tzinfo (1.1.0)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -3,9 +3,9 @@
 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
+* Generate HTML, PDF and ePub files
 * Multi book support
-* Write using Markdown, Textile or plain HTML
+* Write using Markdown or plain HTML
 * Book layout support
 * Custom font support
 * SCSS support
@@ -26,12 +26,6 @@ dependencies.
     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.
 
@@ -60,31 +54,13 @@ This command creates a directory `my_book` with the following structure:
         │   ├── page.erb
         └── html
             └── layout.erb
-            
+
 
 Update `my_book/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_book
-    └── text
-        ├── 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:*
+Now, create the content for your book by creating markdown or html files into the `my_book/text` directory. The order is determined by the numeric prefix assigned to the file.
 
     my_book
     └── text
@@ -96,33 +72,20 @@ Now, create the content for your book by creating markdown or textile files into
 
 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`.
+Note that you can use any format you want at the same time. Just use one of the following extensions: `.html`, `.markdown`, `.mkdn` or `.md`
 
 ## 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.
+Bookshelf can generate a Table of Contents (TOC) based on your `h2` tags.
 
 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

data/bookshelf.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   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.summary               = "A framework that generates PDF and e-Pub from Markdown, and HTML files."
   s.description           = s.summary
   s.license               = "MIT"
 
@@ -21,13 +21,12 @@ Gem::Specification.new do |s|
 
   s.add_dependency "activesupport"
   s.add_dependency "nokogiri"
-  s.add_dependency "RedCloth"
-  s.add_dependency "rdiscount"
+  s.add_dependency "maruku"
   s.add_dependency "i18n"
   s.add_dependency "thor"
-  s.add_dependency "eeepub-with-cover-support"
   s.add_dependency "notifier"
   s.add_dependency "sass"
+  s.add_dependency "rubyzip"
 
   s.add_development_dependency "rspec"
   s.add_development_dependency "test_notifier"

data/lib/bookshelf.rb

@@ -1,6 +1,5 @@
 require "active_support/all"
 require "digest/md5"
-require "eeepub"
 require "erb"
 require "logger"
 require "nokogiri"
@@ -8,42 +7,26 @@ 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
+require "maruku"
 
 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"
 
@@ -61,4 +44,8 @@ module Bookshelf
   def self.root_dir
     @root_dir ||= Pathname.new(Dir.pwd)
   end
+
+  def self.render_template(file, locals = {})
+    ERB.new(File.read(file)).result OpenStruct.new(locals).instance_eval{ binding }
+  end
 end

data/lib/bookshelf/adapters/markdown.rb

@@ -1,34 +1,16 @@
 module Bookshelf
   class Markdown
     # Supported Markdown libraries
-    #
-    MARKDOWN_LIBRARIES = %w[Maruku BlueCloth PEGMarkdown Redcarpet RDiscount]
+    MARKDOWN_LIBRARIES = %w[Maruku]
 
     # 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
+      engine.new(content).to_html
     end
   end
 end

data/lib/bookshelf/cli.rb

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 module Bookshelf
   class Cli < Thor
-    FORMATS = %w[pdf html epub mobi txt]
+    FORMATS = %w[pdf html epub]
     check_unknown_options!
 
     def self.exit_on_failure?
@@ -53,16 +53,6 @@ module Bookshelf
         :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]
@@ -73,24 +63,6 @@ module Bookshelf
       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)
@@ -99,9 +71,7 @@ module Bookshelf
         "Chapters: #{stats.chapters}",
         "Words: #{stats.words}",
         "Images: #{stats.images}",
-        "Links: #{stats.links}",
-        "Footnotes: #{stats.footnotes}",
-        "Code blocks: #{stats.code_blocks}"
+        "Links: #{stats.links}"
       ].join("\n")
     end
 

data/lib/bookshelf/dependency.rb

@@ -1,15 +1,7 @@
 module Bookshelf
   class Dependency
-    def self.kindlegen?
-      @kindlegen ||= `which kindlegen` && $?.success?
-    end
-
     def self.prince?
       @prince ||= `which prince` && $?.success?
     end
-
-    def self.html2text?
-      @html2text ||= `which html2text` && $?.success?
-    end
   end
 end

data/lib/bookshelf/exporter.rb

@@ -34,16 +34,12 @@ module Bookshelf
 
       export_assets
       export_pdf = [nil, "pdf"].include?(options[:only])
-      export_epub = [nil, "mobi", "epub"].include?(options[:only])
-      export_mobi = [nil, "mobi"].include?(options[:only])
-      export_txt = [nil, "txt"].include?(options[:only])
+      export_epub = [nil, "epub"].include?(options[:only])
 
       exported = []
       exported << Parser::HTML.parse(book_dir)
       exported << Parser::PDF.parse(book_dir) if export_pdf && Dependency.prince?
       exported << Parser::Epub.parse(book_dir) if export_epub
-      exported << Parser::Mobi.parse(book_dir) if export_mobi && Dependency.kindlegen?
-      exported << Parser::Txt.parse(book_dir) if export_txt && Dependency.html2text?
 
       if exported.all?
         color = :green

data/lib/bookshelf/generator.rb

@@ -20,9 +20,9 @@ module Bookshelf
     end
 
     def copy_assets
-      copy_file "epub.scss"    , "assets/styles/epub.scss"
-      copy_file "html.scss"    , "assets/styles/html.scss"
-      copy_file "html.scss"    , "assets/styles/_fonts.scss"
+      copy_file "epub.scss", "assets/styles/epub.scss"
+      copy_file "html.scss", "assets/styles/html.scss"
+      copy_file "_fonts.scss", "assets/styles/_fonts.scss"
       empty_directory "assets/fonts"
       empty_directory "assets/images"
     end
@@ -36,9 +36,10 @@ module Bookshelf
     end
 
     def copy_templates
-      copy_file "layout.erb"  , "templates/html/layout.erb"
-      copy_file "cover.erb"   , "templates/epub/cover.erb"
-      copy_file "epub.erb"    , "templates/epub/page.erb"
+      copy_file "layout.erb", "templates/html/layout.erb"
+      copy_file "cover.erb", "templates/epub/cover.erb"
+      copy_file "epub.erb", "templates/epub/page.erb"
+      copy_file "toc.erb", "templates/epub/toc.erb"
     end
 
     def create_empty_directories

data/lib/bookshelf/parser.rb

@@ -5,14 +5,12 @@ module Bookshelf
     autoload :HTML  , "bookshelf/parser/html"
     autoload :PDF   , "bookshelf/parser/pdf"
     autoload :Epub  , "bookshelf/parser/epub"
-    autoload :Mobi  , "bookshelf/parser/mobi"
-    autoload :Txt   , "bookshelf/parser/txt"
 
     class Base
       # The e-book directory.
       #
       attr_accessor :book_dir
-      
+
       def self.parse(book_dir)
         new(book_dir).parse
       end
@@ -33,12 +31,6 @@ module Bookshelf
         Bookshelf.config
       end
 
-      # 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 }
-      end
-
       def spawn_command(cmd)
         begin
           stdout_and_stderr, status = Open3.capture2e(*cmd)