rpub 0.4.0 → 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0251f7be52f4891eae2209f471dc5e5e5e16476e
+  data.tar.gz: 876b09bb922ec2ae31d5a9793c6448f504a739bc
+SHA512:
+  metadata.gz: c96ac8f8d9a5bc5f26383ddf94e387ec0572c6ff267c5f83a7716777798708a07abf65224e90b593d16dff89ecfca92bac1db38ee70dd0d4c7e7f71fdeb5f99f
+  data.tar.gz: 95c58f48494807c7a774b854fd3cb77e399ff69bfc85466bbef9d899c1a585d15555ba574cd179a660efe21f9c6898b56c44758048ec2d36ba679b6b21ee4995

data/.gitignore

@@ -1,4 +1,3 @@
-doc
 .yardoc
 bin/*
 !bin/rpub
@@ -8,3 +7,4 @@ bin/*
 pkg
 coverage
 _site
+tmp

data/.rspec

@@ -1,6 +1,5 @@
 --format progress
 --color
---order rand
 -Ilib
 -Ispec
 -r spec_helper

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
+cache: bundler
 rvm:
-  - 1.8.7
-  - 1.9.2
+  - 2.1.1
+  - 2.0.0
   - 1.9.3
-  - rbx-18mode
-  - rbx-19mode

data/.yardopts

@@ -3,6 +3,7 @@
 --readme README.md
 --markup markdown
 --markup-provider kramdown
+--output-dir doc/api
 -
 HISTORY.md
 LICENSE

data/Gemfile

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

data/Gemfile.lock

@@ -1,70 +1,94 @@
 PATH
   remote: .
   specs:
-    rpub (0.4.0)
+    rpub (0.5.0)
       builder
+      commander
       kramdown
       nokogiri
       rubyzip
       textstats
       typogruby
-      typogruby
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    builder (3.0.0)
-    diff-lcs (1.1.3)
-    ffi (1.0.11)
-    growl (1.0.3)
-    guard (1.1.1)
-      listen (>= 0.4.2)
-      thor (>= 0.14.6)
-    guard-rspec (1.0.0)
-      guard (>= 1.1)
-    kramdown (0.13.7)
-    listen (0.4.3)
-      rb-fchange (~> 0.0.5)
-      rb-fsevent (~> 0.9.1)
-      rb-inotify (~> 0.8.8)
-    multi_json (1.3.6)
-    nokogiri (1.5.3)
-    rake (0.9.2.2)
-    rb-fchange (0.0.5)
-      ffi
-    rb-fsevent (0.9.1)
-    rb-inotify (0.8.8)
-      ffi (>= 0.5.0)
-    rspec (2.10.0)
-      rspec-core (~> 2.10.0)
-      rspec-expectations (~> 2.10.0)
-      rspec-mocks (~> 2.10.0)
-    rspec-core (2.10.1)
-    rspec-expectations (2.10.0)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.10.1)
+    aruba (0.6.0)
+      childprocess (>= 0.3.6)
+      cucumber (>= 1.1.1)
+      rspec-expectations (>= 2.7.0)
+    builder (3.2.2)
+    childprocess (0.5.3)
+      ffi (~> 1.0, >= 1.0.11)
+    commander (4.2.1)
+      highline (~> 1.6.11)
+    coveralls (0.7.0)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    cucumber (1.3.16)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    ffi (1.9.3)
+    gherkin (2.12.2)
+      multi_json (~> 1.3)
+    highline (1.6.21)
+    kramdown (1.5.0)
+    mime-types (2.3)
+    mini_portile (0.6.1)
+    multi_json (1.10.1)
+    multi_test (0.1.1)
+    netrc (0.7.7)
+    nokogiri (1.6.4.1)
+      mini_portile (~> 0.6.0)
+    rake (10.3.2)
+    rest-client (1.7.2)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.4)
     rubypants (0.2.0)
-    rubyzip (0.9.8)
-    simplecov (0.6.4)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.5.3)
-    simplecov-html (0.5.3)
+    rubyzip (1.1.6)
+    simplecov (0.9.0)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
     textstats (0.0.2)
-    thor (0.15.2)
-    typogruby (1.0.15)
+    thor (0.19.1)
+    tins (1.3.1)
+    typogruby (1.0.17)
       rubypants
-    yard (0.8.2)
+    yard (0.8.7.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  growl
-  guard
-  guard-rspec
+  aruba
+  coveralls
+  cucumber
   rake
-  rb-fsevent
   rpub!
-  rspec
+  rspec (~> 3.0)
   simplecov
   yard

data/Guardfile

@@ -3,3 +3,9 @@ guard 'rspec', :version => 2 do
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }
 end
+
+guard 'cucumber' do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$})          { 'features' }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+end

data/HISTORY.md

@@ -1,5 +1,15 @@
 # History
 
+## (unreleased)
+
+* Respect `max_level` setting in human-readable table of contents
+* Use default configuration when no `config.yml` file can be found
+* Allow passing in custom configuration file in `compile` command with -c option
+* Bugfix: count ePub table of contents order from 1, not from 0
+* Output `clean` command warnings on stderr, not stdout
+* Round readability statistics from `stats` command
+* Bugfix: let `stats` command consider less than one page still one page, not 0 pages
+
 ## 0.4.0
 
 * Generate ePub table of contents from markdown headings

data/README.md

@@ -1,4 +1,4 @@
-# Rpub -- an ePub generator in Ruby [![Build Status](https://secure.travis-ci.org/avdgaag/rpub.png?branch=master)](http://travis-ci.org/avdgaag/rpub) [![Gemnasium dependency status](https://gemnasium.com/avdgaag/rpub.png)](https://gemnasium.com/avdgaag/rpub)
+# Rpub -- an ePub generator in Ruby [![Build Status](https://secure.travis-ci.org/avdgaag/rpub.png?branch=master)](http://travis-ci.org/avdgaag/rpub) [![Coverage Status](https://coveralls.io/repos/avdgaag/rpub/badge.png)](https://coveralls.io/r/avdgaag/rpub)
 
 ## Introduction
 

data/Rakefile

@@ -2,10 +2,15 @@ require 'bundler'
 Bundler::GemHelper.install_tasks
 Bundler.setup
 
-require 'rspec/core/rake_task'
 
 desc 'Default: run specs.'
-task :default => :spec
+task :default => [:spec, :cucumber]
 
+require 'rspec/core/rake_task'
 desc 'Run specs'
 RSpec::Core::RakeTask.new
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = '--format progress --tags ~@epubcheck'
+end

data/bin/rpub

@@ -3,4 +3,67 @@
 $:.unshift File.expand_path('../../lib', __FILE__)
 require 'rpub'
 
-Rpub::Commander.invoke(ARGV)
+gem = Gem::Specification.load(File.expand_path('../../rpub.gemspec', __FILE__))
+
+require 'commander/import'
+program :name,           gem.name
+program :version,        gem.version.to_s
+program :description,    gem.description
+program :help_formatter, :compact
+
+default_command :compile
+
+command :clean do |c|
+  c.syntax      = 'rpub clean [OPTIONS]'
+  c.summary     = 'Remove all generated files'
+  c.description = 'Clean up all generated files, such as the standard generated .epub file, package files and preview files.'
+  c.option '-d', '--[no-]dryrun', 'Only list files to be removed'
+  c.option '-c', '--config FILENAME', 'Specify an explicit configuration file to use'
+  c.when_called Rpub::Commands::Clean
+end
+
+command :generate do |c|
+  c.syntax      = 'rpub generate [OPTIONS]'
+  c.summary     = 'Generate default project files'
+  c.description = 'Generate one or more standard files to get started with a new project. By default an entire skeleton project is generated, but by passing the -s, -l, -c options you can generate just a single file.'
+  c.option '-s', '--[no-]styles', 'Generate default stylesheet'
+  c.option '-l', '--[no-]layout', 'Generate default HTML layout'
+  c.option '-c', '--[no-]config', 'Generate default configuration'
+  c.when_called Rpub::Commands::Generate
+end
+
+command :stats do |c|
+  c.syntax      = 'rpub stats'
+  c.summary     = 'Basic text statistics'
+  c.description = 'Display basic statistics of all the content in the current project'
+  c.option '-c', '--config FILENAME', 'Specify an explicit configuration file to use'
+  c.when_called Rpub::Commands::Stats
+end
+
+command :preview do |c|
+  c.syntax      = 'rpub preview [OPTIONS]'
+  c.summary     = 'Single-page HTML preview of entire book'
+  c.description = 'Generate a single-page HTML file for easy previewing of your content with the layout and styles used when generating .epub files. By default, the output file will be named "preview.html".'
+  c.option '-l', '--layout FILENAME', 'Specify an explicit layout file to use'
+  c.option '-o', '--output FILENAME', 'Specify an explicit output file'
+  c.option '-c', '--config FILENAME', 'Specify an explicit configuration file to use'
+  c.when_called Rpub::Commands::Preview
+end
+
+command :package do |c|
+  c.syntax      = 'rpub package [OPTIONS]'
+  c.summary     = 'Package book and support file for distribution'
+  c.description = 'Compile your ebook to an ePub file and package it into an archive together with optional other files for easy distibution. You might want to include a README file, a license or other promotion material.'
+  c.option '-c', '--config FILENAME', 'Specify an explicit configuration file to use'
+  c.when_called Rpub::Commands::Package
+end
+
+command :compile do |c|
+  c.syntax      = 'rpub compile [OPTIONS]'
+  c.summary     = 'Compile chapters into .epub file'
+  c.description = ' Compile your Markdown-formatted input files to a valid .epub output file using the options described in config.yml. This will use the layout.html and styles.css files in your project directory if present.'
+  c.option '-l', '--layout FILENAME', 'Specify an explicit layout file to use'
+  c.option '-s', '--styles FILENAME', 'Specify an explicit stylesheet file to use'
+  c.option '-c', '--config FILENAME', 'Specify an explicit configuration file to use'
+  c.when_called Rpub::Commands::Compile
+end

data/doc/.gitignore

@@ -0,0 +1,8 @@
+.bundle
+.yardoc
+bin
+doc
+TODO
+pkg
+coverage
+_site

data/doc/api/Rpub.html

@@ -0,0 +1,339 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Module: Rpub
+  
+    &mdash; Rpub, a simple ePub generator library in Ruby
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!Rpub.html";
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="_index.html">Index (R)</a> &raquo;
+    
+    
+    <span class="title">Rpub</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Module: Rpub
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/rpub.rb<span class="defines">,<br />
+  lib/rpub/epub.rb,<br /> lib/rpub/book.rb,<br /> lib/rpub/command.rb,<br /> lib/rpub/context.rb,<br /> lib/rpub/version.rb,<br /> lib/rpub/preview.rb,<br /> lib/rpub/chapter.rb,<br /> lib/rpub/xml_file.rb,<br /> lib/rpub/epub/toc.rb,<br /> lib/rpub/document.rb,<br /> lib/rpub/media_type.rb,<br /> lib/rpub/epub/cover.rb,<br /> lib/rpub/compressor.rb,<br /> lib/rpub/epub/content.rb,<br /> lib/rpub/epub/html_toc.rb,<br /> lib/rpub/commands/clean.rb,<br /> lib/rpub/commands/stats.rb,<br /> lib/rpub/epub/container.rb,<br /> lib/rpub/hash_delegation.rb,<br /> lib/rpub/commands/preview.rb,<br /> lib/rpub/commands/compile.rb,<br /> lib/rpub/commands/package.rb,<br /> lib/rpub/filesystem_source.rb,<br /> lib/rpub/commands/generate.rb</span>
+</dd>
+  
+</dl>
+<div class="clear"></div>
+
+<h2>Defined Under Namespace</h2>
+<p class="children">
+  
+    
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Rpub/Commands.html" title="Rpub::Commands (module)">Commands</a></span>, <span class='object_link'><a href="Rpub/FilesystemSource.html" title="Rpub::FilesystemSource (module)">FilesystemSource</a></span>, <span class='object_link'><a href="Rpub/HashDelegation.html" title="Rpub::HashDelegation (module)">HashDelegation</a></span>, <span class='object_link'><a href="Rpub/MediaType.html" title="Rpub::MediaType (module)">MediaType</a></span>
+    
+  
+    
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Rpub/Book.html" title="Rpub::Book (class)">Book</a></span>, <span class='object_link'><a href="Rpub/Chapter.html" title="Rpub::Chapter (class)">Chapter</a></span>, <span class='object_link'><a href="Rpub/Command.html" title="Rpub::Command (class)">Command</a></span>, <span class='object_link'><a href="Rpub/Compressor.html" title="Rpub::Compressor (class)">Compressor</a></span>, <span class='object_link'><a href="Rpub/Context.html" title="Rpub::Context (class)">Context</a></span>, <span class='object_link'><a href="Rpub/Document.html" title="Rpub::Document (class)">Document</a></span>, <span class='object_link'><a href="Rpub/Epub.html" title="Rpub::Epub (class)">Epub</a></span>, <span class='object_link'><a href="Rpub/Preview.html" title="Rpub::Preview (class)">Preview</a></span>, <span class='object_link'><a href="Rpub/XmlFile.html" title="Rpub::XmlFile (class)">XmlFile</a></span>
+    
+  
+</p>
+
+  <h2>Constant Summary</h2>
+  
+    <dl class="constants">
+      
+        <dt id="GEM_ROOT-constant" class="">GEM_ROOT =
+          
+        </dt>
+        <dd><pre class="code"><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_expand_path'>expand_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>../../</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='kw'>__FILE__</span><span class='rparen'>)</span></pre></dd>
+      
+        <dt id="VERSION-constant" class="">VERSION =
+          
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0.4.1</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+      
+    </dl>
+  
+
+
+
+
+
+
+
+  
+    <h2>
+      Class Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#document_factory-class_method" title="document_factory (class method)">+ (Object) <strong>document_factory</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#source-class_method" title="source (class method)">+ (Object) <strong>source</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#support_file-class_method" title="support_file (class method)">+ (String) <strong>support_file</strong>(path) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>Full path to a file that was relative to the gem support directory.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+
+
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="document_factory-class_method">
+  
+    + (<tt>Object</tt>) <strong>document_factory</strong> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+28
+29
+30</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/rpub.rb', line 28</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_document_factory'>document_factory</span>
+  <span class='const'>Rpub</span><span class='op'>::</span><span class='const'>Document</span><span class='period'>.</span><span class='id identifier rubyid_method'>method</span><span class='lparen'>(</span><span class='symbol'>:new</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="source-class_method">
+  
+    + (<tt>Object</tt>) <strong>source</strong> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+24
+25
+26</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/rpub.rb', line 24</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_source'>source</span>
+  <span class='const'>FilesystemSource</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="support_file-class_method">
+  
+    + (<tt>String</tt>) <strong>support_file</strong>(path) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns full path to a file that was relative to the gem support directory</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>full path to a file that was relative to the gem support directory</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+20
+21
+22</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/rpub.rb', line 20</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_support_file'>support_file</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
+  <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='const'>GEM_ROOT</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>support</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</div>
+
+    <div id="footer">
+  Generated on Thu Aug 14 19:54:32 2014 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.4 (ruby-2.1.2).
+</div>
+
+  </body>
+</html>