kitabu 1.0.6 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ef382447f8d4fb0eef52e1d9e6ffa6ffd9733d2
-  data.tar.gz: 77062a208f61b31f2a1b79575c094f5f8f64800a
+  metadata.gz: cc4c26926c9593f2b8e97479bafef553a97adad2
+  data.tar.gz: 388956fdff69380c6bc9d5698ab6b37851f92fba
 SHA512:
-  metadata.gz: 4f5737248a3a0fdf2aca5ee16c88e5484d5cc124aa2d86472c75fb21dfd47a6569a838e694e9d51091ffcd2c2952cb6755bb11b6af7763123c32cdfd518e78e4
-  data.tar.gz: 7c106d90e9d1c4a5d122b669dfb2f7c70d5a0234edeca6a0fa8c66e3653158f46be8d25f16b3728b3173c9a5241ee6a93de440c85879c17ca313c7c8eedfa16d
+  metadata.gz: 4f4bbbd287feb60d0c0a0ced3f1bf1a1d9945d51b217f137b2e65cb3c356a9a56117ed077a6e836a4b4af83f262bad8a0fcd712820d3770bd14d78ac0e8f6e1a
+  data.tar.gz: 34d1ae48a3b6071e9b63595c37724816e445ba22896d013d204fe3f7caae2f1936dfdbdf841410c0ff257d5a6d06740dd817944fb3e8676ffe8b8e54b820d078

data/.gitignore

@@ -1,4 +1,6 @@
 .DS_Store
-pkg
-tmp
-spec/support/mybook/output/mybook.*
+/pkg
+/tmp
+/spec/support/mybook/output
+/coverage
+.sass-cache

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+cache: bundler
+sudo: true
+script: bundle exec rspec
+before_install:
+- wget http://www.princexml.com/download/prince_9.0-5_ubuntu12.04_amd64.deb
+- sudo apt-get install -yqq fontconfig-config libfontconfig1 libgif4 libjpeg-turbo8 libjpeg8 libtiff4 ttf-dejavu-core html2text
+- sudo dpkg -i prince_9.0-5_ubuntu12.04_amd64.deb
+rvm:
+- '2.0'
+- '2.1'
+- '2.2'
+notifications:
+  email: false
+addons:
+  code_climate:
+    repo_token:
+      secure: "WvgB6WqwxgwLvNCR/dFtm9JkQfaLMLuqaFs2nKKsw92BL4qi3rk3m3GxVR+LoODWx0Tsdl9zCWF3fFBwmgiM7eFdqSJ4dmy3iTH7fHOu/iruP6yDV9+iyI6oNXLGlyx4kZdxGvjOh95AFBMQ1KQis/0ibzA5Ax2qg19JUcB3+ao="

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## Unreleased
+
+- Remove support for different markdown processors; now using Redcarpet.
+- Remove support for other file types like textile and html.
+- Remove support for pygments.rb highlighter; now using Rouge.
+- Add support for .erb files; helpers can be defined within the `Kitabu::Helpers` module.
+- Add support for media format stylesheets (print, pdf, html, epub).

data/Gemfile.lock

@@ -1,90 +1,107 @@
 PATH
   remote: .
   specs:
-    kitabu (1.0.6)
-      RedCloth
+    kitabu (2.0.0)
       activesupport
-      coderay
       eeepub-with-cover-support
       i18n
       nokogiri
       notifier
-      rdiscount
+      redcarpet
+      rouge
       rubyzip
+      sass
+      sass-globbing
       thor
       zip-zip
 
 GEM
   remote: https://rubygems.org/
   specs:
-    RedCloth (4.2.9)
-    activesupport (4.0.4)
-      i18n (~> 0.6, >= 0.6.9)
-      minitest (~> 4.2)
-      multi_json (~> 1.3)
-      thread_safe (~> 0.1)
-      tzinfo (~> 0.3.37)
-    atomic (1.1.16)
-    awesome_print (1.2.0)
+    activesupport (4.2.0)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    awesome_print (1.6.1)
     builder (3.2.2)
+    byebug (3.5.1)
+      columnize (~> 0.8)
+      debugger-linecache (~> 1.2)
+      slop (~> 3.6)
+    codeclimate-test-reporter (0.4.7)
+      simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.0)
-    columnize (0.3.6)
-    debugger (1.6.6)
-      columnize (>= 0.3.1)
-      debugger-linecache (~> 1.2.0)
-      debugger-ruby_core_source (~> 1.3.2)
+    columnize (0.9.0)
     debugger-linecache (1.2.0)
-    debugger-ruby_core_source (1.3.2)
     diff-lcs (1.2.5)
+    docile (1.1.5)
     eeepub-with-cover-support (0.8.8)
       builder
       rubyzip
-    i18n (0.6.9)
+    i18n (0.7.0)
+    json (1.8.2)
     method_source (0.8.2)
-    mini_portile (0.5.3)
-    minitest (4.7.5)
-    multi_json (1.9.2)
-    nokogiri (1.6.1)
-      mini_portile (~> 0.5.0)
-    notifier (0.4.1)
-    pry (0.9.12.6)
-      coderay (~> 1.0)
-      method_source (~> 0.8)
+    mini_portile (0.6.2)
+    minitest (5.5.1)
+    multi_json (1.11.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    notifier (0.5.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
       slop (~> 3.4)
-    pry-debugger (0.2.2)
-      debugger (~> 1.3)
-      pry (~> 0.9.10)
-    pry-meta (0.0.6)
+    pry-byebug (3.0.1)
+      byebug (~> 3.4)
+      pry (~> 0.10)
+    pry-meta (0.0.10)
       awesome_print
       pry
-      pry-debugger
+      pry-byebug
       pry-remote
     pry-remote (0.1.8)
       pry (~> 0.9)
       slop (~> 3.0)
-    rake (10.2.2)
-    rdiscount (2.1.7)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.8)
-    rspec-expectations (2.14.5)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.6)
-    rubyzip (1.1.2)
-    slop (3.5.0)
+    rake (10.4.2)
+    redcarpet (3.2.2)
+    rouge (1.8.0)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.2)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    rubyzip (1.1.7)
+    sass (3.4.13)
+    sass-globbing (1.1.1)
+      sass (>= 3.1)
+    simplecov (0.9.2)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.9.0)
+    simplecov-html (0.9.0)
+    slop (3.6.0)
     thor (0.19.1)
-    thread_safe (0.3.1)
-      atomic (>= 1.1.7, < 2)
-    tzinfo (0.3.39)
-    zip-zip (0.2)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    zip-zip (0.3)
       rubyzip (>= 1.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  codeclimate-test-reporter
   kitabu!
   pry-meta
   rake

data/README.md

@@ -0,0 +1,235 @@
+# 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)
+
+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.
+
+## 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
+
+## Installation
+
+To install Kitabu, 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 kitabu
+
+After installing Kitabu, run the following command to check your external
+dependencies.
+
+    $ kitabu 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 are no hard requirements here; just make sure you cleared the correct dependency based on the formats you want to export to.
+
+## Usage
+
+To create a new e-book, just run
+
+    $ kitabu new mybook
+
+This command creates a directory `mybook` with the following structure:
+
+    .
+    ├── Gemfile
+    ├── Gemfile.lock
+    ├── Guardfile
+    ├── config
+    │   ├── helper.rb
+    │   └── kitabu.yml
+    ├── images
+    │   ├── kitabu-icon.png
+    │   ├── kitabu-icon.svg
+    │   ├── kitabu-word.png
+    │   ├── kitabu-word.svg
+    │   ├── kitabu.png
+    │   └── kitabu.svg
+    ├── output
+    ├── templates
+    │   ├── epub
+    │   │   ├── cover.erb
+    │   │   ├── cover.png
+    │   │   └── page.erb
+    │   ├── html
+    │   │   └── layout.erb
+    │   └── styles
+    │       ├── epub.scss
+    │       ├── files
+    │       │   └── _normalize.scss
+    │       ├── html.scss
+    │       ├── pdf.scss
+    │       └── print.scss
+    └── text
+        ├── 01_Getting_Started.md
+        ├── 02_Creating_Chapters.md
+        ├── 03_Syntax_Highlighting.erb
+        ├── 04_Dynamic_Content.erb
+        └── 05_Exporting_Files.md
+
+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)
+
+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).
+
+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
+        * 01_introduction.md
+      * 02_What_is_Ruby_on_Rails
+        * 01_MVC.md
+        * 02_DRY.md
+        * 03_Convention_Over_Configuration.md
+      * 03_Installing_Ruby_on_Rails
+        * 01_Installing.md
+        * 02_Mac_OS_X_instructions.md
+        * 03_Windows_instructions.md
+        * 04_Ubuntu_Linux_instructions.md
+
+If you prefer, you can add a chapter per file:
+
+    * text
+      * 01_Introduction.md
+      * 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.
+
+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
+
+You can also have .erb files. You can mix Markdown and HTML, like the following:
+
+    ## This the chapter title
+
+    <% note do %>
+      Make sure you try .erb files!
+    <% end %>
+
+The above content must be placed in a `.erb` file. The generated content will be something like this:
+
+```html
+<div class="note info">
+  <p>
+    Make sure you try .erb files!
+  </p>
+</div>
+```
+
+The `note` helper is built-in and can accept a different note type.
+
+```erb
+<% note :warning do %>
+  Make sure you write valid ERB code.
+<% end %>
+```
+
+You can see available helpers on <https://github.com/fnando/kitabu/blob/master/lib/kitabu/markdown.rb>.
+
+### Syntax Highlighting
+
+To highlight code, use fenced code blocks.
+
+    ``` ruby
+    class User < ActiveRecord::Base
+      validates_presence_of :login, :password, :email
+      validates_uniqueness_of :login, :email
+    end
+    ```
+
+You can even provide options:
+
+    ```php?start_inline=1&line_numbers=1
+    echo "Hello World";
+    ```
+
+- 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`
+
+### References
+
+* 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/)
+
+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:
+
+```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
+```
+
+## Maintainer
+
+* [Nando Vieira](http://nandovieira.com.br)
+* [Jesse Storimer](http://jstorimer.com)
+
+## 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.