rpub 0.2.0 → 0.2.1

data/.gitignore

@@ -6,3 +6,5 @@ bin/*
 .DS_Store
 *~
 pkg
+coverage
+_site

data/.yardopts

@@ -1,5 +1,5 @@
 --no-private
---title "rPub, a simple ePub generator library in Ruby"
+--title "Rpub, a simple ePub generator library in Ruby"
 --readme README.md
 -
 HISTORY.md

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rpub (0.2.0)
+    rpub (0.2.1)
       builder
       kramdown
       rubyzip
@@ -20,6 +20,7 @@ GEM
     guard-rspec (0.7.0)
       guard (>= 0.10.0)
     kramdown (0.13.5)
+    multi_json (1.3.2)
     nokogiri (1.5.2)
     rake (0.9.2.2)
     rb-fsevent (0.9.1)
@@ -33,6 +34,10 @@ GEM
     rspec-mocks (2.9.0)
     rubypants (0.2.0)
     rubyzip (0.9.7)
+    simplecov (0.6.2)
+      multi_json (~> 1.3)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
     thor (0.14.6)
     typogruby (1.0.15)
       rubypants
@@ -50,4 +55,5 @@ DEPENDENCIES
   rb-fsevent
   rpub!
   rspec
+  simplecov
   yard

data/HISTORY.md

@@ -1,5 +1,14 @@
 # History
 
+## 0.2.1
+
+* Bugfix: allow multiple headings per chapters in outline
+* Bugfix: use correct id method, renamed to xml_id
+* Various documentation improvements
+* Added MIT license
+* Added code coverage reports (Ruby 1.9 only)
+* Improved test suite
+
 ## 0.2.0
 
 * Prefixed book query methods with `has_?`

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2012 Arjan van der Gaag
+
+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/README.md

@@ -1,21 +1,19 @@
-# rPub -- an ePub generator in Ruby [![Build Status](https://secure.travis-ci.org/avdgaag/rpub.png?branch=master)](http://travis-ci.org/avdgaag/rpub)
-
-**Note** this project is still in development and not yet ready for general use.
+# Rpub -- an ePub generator in Ruby [![Build Status](https://secure.travis-ci.org/avdgaag/rpub.png?branch=master)](http://travis-ci.org/avdgaag/rpub)
 
 ## Introduction
 
-rPub is a command-line tool that generates a collection of plain text input
+Rpub is a command-line tool that generates a collection of plain text input
 files into an eBook in ePub format. It provides several related functions to
 make working with ePub files a little easier:
 
 * Generation of table of contents
-* Tracking of references to tables or figures
-* Validation of output file
 * Packaging your eBook in an archive with additional README file
+* Embedding fonts
+* Easy previewing as you write
 
 ## Installation
 
-rPub is distributed as a Ruby gem, which should be installed on most Macs and
+Rpub is distributed as a Ruby gem, which should be installed on most Macs and
 Linux systems. Once you have ensured you have a working installation of Ruby
 and Ruby gems, install the gem as follows from the command line:
 
@@ -33,7 +31,7 @@ along the lines of `rpub 1.0.0`.
 ### Basics
 
 ePubs are basically collections of HTML files, combined in a single archive
-according to a set of predefined rules. rPub generates these files for you from
+according to a set of predefined rules. Rpub generates these files for you from
 simple text files written in [Markdown][], a very readable markup language created
 by [John Gruber][]. This very README file is an example of a Markdown document.
 
@@ -58,7 +56,7 @@ in a special configuration file called `config.yml`:
 This file is written in [YAML](http://yaml.org) and sets basic properties of your book project.
 
 Since regenerating your ePub file and opening it in a suitable reader
-application is cumbersome, rPub can generate a simple preview document for you:
+application is cumbersome, Rpub can generate a simple preview document for you:
 
     $ rpub preview
 
@@ -149,6 +147,10 @@ those files into your project using the `generate` subcommand:
 
 See the [examples directory](https://github.com/avdgaag/rpub/example) for two example projects.
 
+### Documentation
+
+See the inline [API docs](http://rubydoc.info/github/avdgaag/rpub/master/frames) for more information.
+
 ## Other
 
 ### Note on Patches/Pull Requests

data/lib/rpub.rb

@@ -44,6 +44,7 @@ module Rpub
     end
   end
 
+  # @return [String] full path to a file that was relative to the gem support directory
   def self.support_file(path)
     File.join(GEM_ROOT, 'support', path)
   end

data/lib/rpub/commander.rb

@@ -1,4 +1,13 @@
 module Rpub
+  # The +Commander+ module is responsible for invoking `Command` objects. This is
+  # the internal part of the library that is used by the CLI.
+  #
+  # The +Commander+ takes a list of arguments, which would typically come from the CLI,
+  # and tries to look up a +Command+ class. If it cannot find anything, it will invoke
+  # the {Rpub::Commands::Main} command.
+  #
+  # @see Rpub::Commands::Base
+  # @see Rpub::Commands
   module Commander
     def invoke(args = [])
       subcommand, *options = args

data/lib/rpub/commands/generate.rb

@@ -29,7 +29,7 @@ module Rpub
       def write_file(file)
         output_file = File.basename(file)
         if File.exist?(output_file)
-          warn "Not overriding #{output_file}"
+          puts "Not overriding #{output_file}"
           return
         end
         File.open(output_file, 'w') do |f|

data/lib/rpub/compilation_helpers.rb

@@ -1,23 +1,42 @@
 module Rpub
+  # Provide a set of helper methods that are used across various commands to
+  # simplify the compilation process. These methods mostly deal with loading files
+  # from the current project directory.
   module CompilationHelpers
+
+    # Factory method for {Rpub::Book} objects, loading every markdown file as a
+    # chapter.
+    #
+    # @see #markdown_files
+    # @return [Rpub::Book]
     def create_book
       book = Book.new(layout, config)
       markdown_files.each(&book.method(:<<))
       book
     end
 
+    # All chapter input files loaded into strings. This does not include any of
+    # the files listed in the +ignore+ configuration key.
+    #
+    # @return [Array<String>]
     def markdown_files
       @markdown_files ||= filter_exceptions(Dir['*.md']).sort.map(&File.method(:read))
     end
 
+    # @return [String] path to the current layout file (defaulting to built-in)
     def layout
       @layout ||= own_or_support_file('layout.html')
     end
 
+    # @return [String] path to the current stylesheet file (defaulting to built-in)
     def styles
       @styles ||= own_or_support_file('styles.css')
     end
 
+    # Load the contents of +config.yml+ into a +Hash+ object.
+    #
+    # @raise [NoConfiguration] when the config file cannot be found.
+    # @return [Hash] parsed configuration
     def config
       @config_file ||= begin
         raise NoConfiguration unless File.exist?('config.yml')

data/lib/rpub/compressor.rb

@@ -1,5 +1,5 @@
 module Rpub
-  # Wrapper around a `ZipOutputStream` object provided by the `rubyzip` gem.
+  # Wrapper around a +ZipOutputStream+ object provided by the +rubyzip+ gem.
   # This writes string contents straight into a zip file, without first saving
   # them to disk.
   class Compressor

data/lib/rpub/epub.rb

@@ -19,8 +19,10 @@ module Rpub
       if book.has_toc?
         target.compress_file 'OEBPS/toc.html', toc { HtmlToc.new(book).render }
       end
-      book.fonts.each do |font|
-        target.compress_file File.join('OEBPS', font), File.read(font)
+      if book.has_fonts?
+        book.fonts.each do |font|
+          target.compress_file File.join('OEBPS', font), File.read(font)
+        end
       end
       book.each do |chapter|
         target.compress_file File.join('OEBPS', chapter.filename), chapter.to_html

data/lib/rpub/epub/content.rb

@@ -58,7 +58,7 @@ module Rpub
             end
 
             book.chapters.each do |chapter|
-              xml.item 'id' => chapter.id, 'href' => chapter.filename, 'media-type' => 'application/xhtml+xml'
+              xml.item 'id' => chapter.xml_id, 'href' => chapter.filename, 'media-type' => 'application/xhtml+xml'
             end
           end
 
@@ -67,7 +67,7 @@ module Rpub
               xml.itemref 'idref' => 'cover', 'linear' => 'no'
             end
             book.chapters.each do |chapter|
-              xml.itemref 'idref' => chapter.id
+              xml.itemref 'idref' => chapter.xml_id
             end
           end
 

data/lib/rpub/epub/html_toc.rb

@@ -12,9 +12,11 @@ module Rpub
         xml.div :id => 'toc' do
           xml.h1 'Table of Contents'
           xml.div :class => 'toc' do
-            book.outline.each do |(filename, heading)|
-              xml.div :class => "level-#{heading.level}" do
-                xml.a heading.text, :href => [filename, heading.html_id].join('#')
+            book.outline.each do |(filename, headings)|
+              headings.each do |heading|
+                xml.div :class => "level-#{heading.level}" do
+                  xml.a heading.text, :href => [filename, heading.html_id].join('#')
+                end
               end
             end
           end

data/lib/rpub/epub/toc.rb

@@ -21,7 +21,7 @@ module Rpub
           xml.docTitle { xml.text book.title }
           xml.navMap do
             book.chapters.each_with_index do |chapter, n|
-              xml.navPoint :id => chapter.id, :playOrder => n do
+              xml.navPoint :id => chapter.xml_id, :playOrder => n do
                 xml.navLabel { xml.text chapter.title }
                 xml.content :src => chapter.filename
               end

data/lib/rpub/subclass_tracker.rb

@@ -2,7 +2,7 @@ module Rpub
   # Add tracking of subclasses to an existing class by extending it with
   # SubclassTracker.
   #
-  # This allows you to set an identifier in a subclass using the `identifier`
+  # This allows you to set an identifier in a subclass using the +identifier+
   # macro, and find subclasses based on that value.
   #
   # Example:
@@ -19,7 +19,7 @@ module Rpub
   #     ParentClass.matching('bar') # => raises SubclassTracker::NoSuchSubclass
   #
   # Note that you don't HAVE to set an identifier. If you don't, your child
-  # class will never be found by `#matching`.
+  # class will never be found by +#matching+.
   module SubclassTracker
     class NoSuchSubclass < StandardError
       def initialize(subcommand)

data/lib/rpub/version.rb

@@ -1,3 +1,3 @@
 module Rpub
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/lib/rpub/xml_file.rb

@@ -1,11 +1,13 @@
 module Rpub
   class XmlFile
+    # @return [Builder::XmlMarkup]
     attr_reader :xml
 
     def initialize
       @xml = Builder::XmlMarkup.new :indent => 2
     end
 
+    # @return [String] render this file and output as string
     def to_s
       render
       xml.target!

data/rpub.gemspec

@@ -48,5 +48,6 @@ EOS
   s.add_development_dependency 'guard-rspec'
   s.add_development_dependency 'rb-fsevent'
   s.add_development_dependency 'growl'
+  s.add_development_dependency 'simplecov'
 end
 

data/spec/fixtures/package/README.md

@@ -0,0 +1 @@
+test

data/spec/fixtures/package/config.yml

@@ -0,0 +1,15 @@
+
+---
+title:       'Untitled book'
+description: 'No description'
+creator:     'Anonymous'
+publisher:   'Untitled publisher'
+subject:     'General'
+language:    'en'
+rights:      'public comain'
+version:     '0.0.0'
+ignore:
+ - README.md
+package_file: package.zip
+package:
+ - README.md

data/spec/rpub/commands/generate_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Rpub::Commands::Generate do
+  let(:buffer) { StringIO.new }
+  before do
+    Dir.chdir File.join(FIXTURES_DIRECTORY, 'generate')
+  end
+
+  after do
+    File.unlink 'styles.css' if File.exist?('styles.css')
+    File.unlink 'layout.html' if File.exist?('layout.html')
+    File.unlink 'config.yml' if File.exist?('config.yml')
+  end
+
+  context 'given a specific option' do
+    let(:subject) { described_class.new(['--config'], buffer) }
+
+    it 'should generate one file' do
+      expect(&subject.method(:invoke)).to create_file('config.yml')
+    end
+
+    it 'should not generate stylesheet' do
+      expect(&subject.method(:invoke)).to_not create_file('layout.html', 'styles.css')
+    end
+  end
+
+  context 'given a no option' do
+    let(:subject) { described_class.new(['--no-styles'], buffer) }
+
+    it 'should generate two files' do
+      expect(&subject.method(:invoke)).to create_file('layout.html', 'config.yml')
+    end
+
+    it 'should not generate stylesheet' do
+      expect(&subject.method(:invoke)).to_not create_file('styles.css')
+    end
+  end
+
+  context 'given no options' do
+    let(:subject) { described_class.new([], buffer) }
+
+    it 'should generate three files' do
+      expect(&subject.method(:invoke)).to create_file('styles.css', 'layout.html', 'config.yml')
+    end
+
+    it 'should not generate existing files' do
+      File.open('styles.css', 'w') { |f| f.write 'foo' }
+      expect(&subject.method(:invoke)).to_not change { File.read('styles.css') }
+      buffer.string.should include('Not overriding styles.css')
+    end
+  end
+end

data/spec/rpub/commands/package_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Rpub::Commands::Package do
+  before do
+    Dir.chdir File.join(FIXTURES_DIRECTORY, 'package')
+  end
+
+  after do
+    File.unlink('package.zip') if File.exist?('package.zip')
+    File.unlink('untitled-book-0.0.0.epub') if File.exist?('untitled-book-0.0.0.epub')
+  end
+
+  it 'should generate an archive' do
+    expect(&subject.method(:invoke)).to create_file('package.zip')
+  end
+
+  context 'archive file' do
+    before { described_class.new.invoke }
+
+    let(:subject) do
+      [].tap do |files|
+        Zip::ZipInputStream.open('package.zip') do |io|
+          while entry = io.get_next_entry
+            files << entry.name
+          end
+        end
+      end
+    end
+
+    it { should include('README.md') }
+    it { should include('untitled-book-0.0.0.epub') }
+  end
+end

data/spec/rpub/epub/content_spec.rb

@@ -67,7 +67,7 @@ describe Rpub::Epub::Content do
   end
 
   context 'when the book has chapters' do
-    let(:chapter) { double('chapter', :filename => 'chapter.html', :id => 'chapter1') }
+    let(:chapter) { double('chapter', :filename => 'chapter.html', :xml_id => 'chapter1') }
     before { book.stub! :chapters => [chapter] }
     it { should have_xpath('/xmlns:package/xmlns:manifest/xmlns:item[@id="chapter1"][@href="chapter.html"][@media-type="application/xhtml+xml"]') }
     it { should have_xpath('/xmlns:package/xmlns:spine[@toc="ncx"]/xmlns:itemref[@idref="chapter1"]') }

data/spec/rpub/epub/html_toc_spec.rb

@@ -13,7 +13,7 @@ describe Rpub::Epub::HtmlToc do
   end
 
   context 'with heading in the outline' do
-    let(:outline) { [['foo.html', double('heading', :text => 'link', :html_id => 'bar', :level => 1)]] }
+    let(:outline) { [['foo.html', [double('heading', :text => 'link', :html_id => 'bar', :level => 1)]]] }
     it { should have_xpath('/div/div/div[@class="level-1"]/a[@href="foo.html#bar"][text()="link"]') }
   end
 end

data/spec/rpub/epub/toc_spec.rb

@@ -17,7 +17,7 @@ describe Rpub::Epub::Toc do
   end
 
   context 'with chapters' do
-    let(:chapters) { [double('chapter', :title => 'chapter title', :filename => 'filename', :id => 'id')] }
+    let(:chapters) { [double('chapter', :title => 'chapter title', :filename => 'filename', :xml_id => 'id')] }
     it { should have_xpath('/xmlns:ncx/xmlns:navMap/xmlns:navPoint[@id="id"]') }
     it { should have_xpath('/xmlns:ncx/xmlns:navMap/xmlns:navPoint/xmlns:navLabel/xmlns:text[text()="chapter title"]') }
     it { should have_xpath('/xmlns:ncx/xmlns:navMap/xmlns:navPoint/xmlns:content[@src="filename"]') }

data/spec/spec_helper.rb

@@ -1,3 +1,8 @@
+if RUBY_VERSION >= '1.9'
+  require 'simplecov'
+  SimpleCov.start
+end
+
 require 'rpub'
 require 'nokogiri'
 
@@ -12,11 +17,11 @@ RSpec::Matchers.define :remove_file do |filename|
   end
 end
 
-RSpec::Matchers.define :create_file do |filename|
+RSpec::Matchers.define :create_file do |*filenames|
   match do |block|
-    before = File.exist?(filename)
+    before = filenames.all?(&File.method(:exist?))
     block.call
-    after = File.exist?(filename)
+    after = filenames.all?(&File.method(:exist?))
     !before && after
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rpub
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -203,6 +203,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: an ePub generation library in Ruby
 email: arjan@arjanvandergaag.nl
 executables:
@@ -261,14 +277,19 @@ files:
 - spec/fixtures/clean/config.yml
 - spec/fixtures/clean/example.epub
 - spec/fixtures/clean/preview.html
+- spec/fixtures/generate/.gitkeep
 - spec/fixtures/no_files/config.yml
+- spec/fixtures/package/README.md
+- spec/fixtures/package/config.yml
 - spec/fixtures/preview/a.md
 - spec/fixtures/preview/b.md
 - spec/fixtures/preview/config.yml
 - spec/rpub/book_spec.rb
 - spec/rpub/chapter_spec.rb
 - spec/rpub/commands/clean_spec.rb
+- spec/rpub/commands/generate_spec.rb
 - spec/rpub/commands/main_spec.rb
+- spec/rpub/commands/package_spec.rb
 - spec/rpub/commands/preview_spec.rb
 - spec/rpub/epub/container_spec.rb
 - spec/rpub/epub/content_spec.rb
@@ -295,7 +316,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 976501169507100538
+      hash: -3544660265101418
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -304,7 +325,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 976501169507100538
+      hash: -3544660265101418
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.22
@@ -319,14 +340,19 @@ test_files:
 - spec/fixtures/clean/config.yml
 - spec/fixtures/clean/example.epub
 - spec/fixtures/clean/preview.html
+- spec/fixtures/generate/.gitkeep
 - spec/fixtures/no_files/config.yml
+- spec/fixtures/package/README.md
+- spec/fixtures/package/config.yml
 - spec/fixtures/preview/a.md
 - spec/fixtures/preview/b.md
 - spec/fixtures/preview/config.yml
 - spec/rpub/book_spec.rb
 - spec/rpub/chapter_spec.rb
 - spec/rpub/commands/clean_spec.rb
+- spec/rpub/commands/generate_spec.rb
 - spec/rpub/commands/main_spec.rb
+- spec/rpub/commands/package_spec.rb
 - spec/rpub/commands/preview_spec.rb
 - spec/rpub/epub/container_spec.rb
 - spec/rpub/epub/content_spec.rb