rpub 0.1.0

data/spec/fixtures/preview/config.yml

@@ -0,0 +1,2 @@
+---
+title: foo

data/spec/rpub/book_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Rpub::Book do
+  let(:subject) { described_class.new('some_file', 'title' => 'My "Awesome" Title!', 'version' => '1.0.3') }
+
+  it 'should start with an empty configuration' do
+    described_class.new('some_file').config.should == {}
+  end
+
+  it             { should respond_to(:title) }
+  its(:title)    { should == 'My "Awesome" Title!' }
+  its(:filename) { should == 'my-awesome-title-1.0.3.epub' }
+
+  describe 'chapters' do
+    before { subject.add_chapter 'foo' }
+
+    it { should have(1).chapters }
+
+    it { should be_kind_of(Enumerable) }
+
+    it 'should start with no chapters' do
+      described_class.new('foo').should have(0).chapters
+    end
+
+    it 'should allow chaining multiple calls' do
+      subject << 'foo' << 'bar'
+      subject.should have(3).chapters
+    end
+
+    it 'should yield chapters' do
+      yielded = false
+      subject.each { |c| yielded = true }
+      yielded.should be_true
+    end
+  end
+
+  describe '#uid' do
+    it 'should change when chapters change' do
+      Rpub::Book.new('bar').add_chapter('foo').should_not == subject.uid
+    end
+
+    it 'should change when config changes' do
+      Rpub::Book.new('bar', 'baz' => 'qux').should_not == subject.uid
+    end
+  end
+
+  describe '#images' do
+    before { subject << '![foo](bar)' << '![baz](qux)' << '![bla](qux)' }
+    it { should have(2).images }
+    its(:images) { should include('bar') }
+    its(:images) { should include('qux') }
+  end
+
+  describe '#outline' do
+    before { subject << '# foo' << '## bar' }
+    its(:outline) { should have(2).elements }
+    it 'should combine chapter outlines' do
+      subject.outline.first[0].should == 'chapter-0-foo.html'
+      subject.outline.first[1][0].text.should == 'foo'
+    end
+  end
+end

data/spec/rpub/chapter_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Rpub::Chapter do
+  let(:subject) { described_class.new('foo', 1, 'document') }
+
+  its(:content) { should == 'foo' }
+  its(:number)  { should == 1 }
+  its(:layout)  { should == 'document' }
+
+  describe '#uid' do
+    it 'should change when content changes' do
+      subject.uid.should_not == described_class.new('bar', 1, 'bar').uid
+    end
+
+    it 'should change when layout changes' do
+      subject.uid.should_not == described_class.new('foo', 1, 'qux').uid
+    end
+
+    it 'should change when content changes' do
+      subject.uid.should_not == described_class.new('foo', 2, 'bar').uid
+    end
+  end
+
+  describe '#id' do
+    its(:id) { should == 'chapter-1' }
+  end
+
+  describe '#filename' do
+    its(:filename) { should == 'chapter-1-untitled.html' }
+  end
+
+  describe '#title' do
+    context 'without a suitable markdown title' do
+      its(:title) { should == 'untitled' }
+    end
+
+    context 'with a markdown heading' do
+      let(:subject) { described_class.new('# My Title', 1, 'bar') }
+      its(:title) { should == 'My Title' }
+    end
+  end
+
+  describe 'markdown parsing' do
+    let(:subject) { described_class.new('foo', 1, nil) }
+    its(:to_html) { should == "<p>foo</p>\n" }
+  end
+
+  describe '#images' do
+    let(:subject) { described_class.new('![alt](foo.png)', 1, 'document') }
+
+    it { should have(1).images }
+    its('images.first') { should == 'foo.png' }
+  end
+
+  describe '#outline' do
+    let(:subject) { described_class.new("# foo\n\nbla bla bla \n\n## bar\n\n# baz", 1, nil) }
+    it 'should list headings in order' do
+      subject.outline.map(&:text).should == %w[foo bar baz]
+    end
+  end
+end

data/spec/rpub/commands/clean_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Rpub::Commands::Clean do
+  before do
+    Dir.chdir File.join(FIXTURES_DIRECTORY, 'clean')
+  end
+
+  after do
+    FileUtils.touch 'preview.html'
+    FileUtils.touch 'example.epub'
+  end
+
+  it 'should remove example.epub file' do
+    expect {
+      described_class.new.invoke
+    }.to remove_file('example.epub')
+  end
+
+  it 'should remove preview.html file' do
+    expect {
+      described_class.new.invoke
+    }.to remove_file('preview.html')
+  end
+
+  context 'when in dry run mode' do
+    let(:buffer) { StringIO.new }
+    let(:subject) { described_class.new(['-d'], buffer) }
+
+    it 'should print preview.html' do
+      subject.invoke
+      buffer.string.should include('preview.html')
+    end
+
+    it 'should not print non-existant files' do
+      FileUtils.rm 'preview.html'
+      subject.invoke
+      buffer.string.should_not include('preview.html')
+    end
+
+    it 'should not remove existing files' do
+      expect {
+        subject.invoke
+      }.to_not remove_file('preview.html')
+    end
+  end
+end

data/spec/rpub/commands/main_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Rpub::Commands::Main do
+  let(:buffer) { StringIO.new }
+
+  it 'should default to help text' do
+    described_class.new([], buffer).invoke
+    buffer.string.should =~ /Display command reference/
+  end
+
+  it 'should raise error when a subcommand remains' do
+    expect {
+      described_class.new(['foo'], buffer).invoke
+    }.should raise_error(Rpub::InvalidSubcommand)
+  end
+
+  it 'should print the version number' do
+    described_class.new(['-v'], buffer).invoke
+    buffer.string.should =~ /rpub \d+\.\d+\.\d+/
+  end
+
+  it 'should print help text' do
+    described_class.new(['-h'], buffer).invoke
+    buffer.string.should =~ /Display command reference/
+  end
+end

data/spec/rpub/commands/preview_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Rpub::Commands::Preview do
+  before do
+    Dir.chdir File.join(FIXTURES_DIRECTORY, 'preview')
+  end
+
+  after do
+    File.unlink 'preview.html' if File.exist?('preview.html')
+    File.unlink 'foo.bar' if File.exist?('foo.bar')
+  end
+
+  context 'generated content' do
+    before { Rpub::Commands::Preview.new.invoke }
+    let(:subject) { File.read('preview.html') }
+
+    it { should include('<p>foo</p>') }
+    it { should include('<p>bar</p>') }
+    it { should match(/foo.*bar/m) }
+    it { should match(/<head>/) }
+  end
+
+  it 'should create new preview file' do
+    expect {
+      Rpub::Commands::Preview.new.invoke
+    }.to create_file('preview.html')
+  end
+
+  it 'should do nothing when there are no files to preview' do
+    Dir.chdir File.join(FIXTURES_DIRECTORY, 'no_files')
+    expect {
+      Rpub::Commands::Preview.new.invoke
+    }.to_not create_file('preview.html')
+  end
+
+  it 'should allow overriding the filename' do
+    expect {
+      Rpub::Commands::Preview.new(['-o', 'foo.bar']).invoke
+    }.to create_file('foo.bar')
+  end
+
+end

data/spec/rpub_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Rpub do
+  it 'should define a version number' do
+    Rpub::VERSION.should =~ /\d+\.\d+\.\d+/
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'rpub'
+
+FIXTURES_DIRECTORY = File.expand_path('../fixtures', __FILE__)
+
+RSpec::Matchers.define :remove_file do |filename|
+  match do |block|
+    before = File.exist?(filename)
+    block.call
+    after = File.exist?(filename)
+    before && !after
+  end
+end
+
+RSpec::Matchers.define :create_file do |filename|
+  match do |block|
+    before = File.exist?(filename)
+    block.call
+    after = File.exist?(filename)
+    !before && after
+  end
+end

data/support/layout.html

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+    <head>
+<%
+extend ::Kramdown::Utils::Html
+title = ''
+if @converter
+  h = @converter.root.children.find {|c| c.type == :header}
+  if h
+    collector = lambda {|c| c.children.collect {|cc| cc.type == :text ? escape_html(cc.value, :text) : collector.call(cc)}.join('')}
+    title = collector.call(h)
+  end
+end
+%>
+		<title><%= title %></title>
+		<link rel="stylesheet" href="styles.css" type="text/css" />
+    </head>
+    <body>
+        <%= @body %>
+    </body>
+</html>

data/support/styles.css

@@ -0,0 +1,66 @@
+body {
+	margin: 3%;
+	font-family: Georgia, serif;
+    line-height: 1.4em;
+}
+
+h1, h2, h3, h4, h5, h6, p, ul, ol, dl, table, img, pre {
+    display: block;
+    margin: 1.4em 0;
+}
+
+h1, h2, h3, h4, h5, h6 {
+	font-family: sans-serif;
+    page-break-after: avoid;
+    page-break-inside: avoid;
+}
+
+h1 { 
+    margin-bottom: 2.8em;
+    page-break-before: always;
+}
+
+h2 {
+    margin-top: 2.8em;
+}
+
+abbr {
+    font-size: 86.5%;
+    letter-spacing: .1em;
+    cursor: help;
+}
+
+.footnotes {
+    font-family: sans-serif;
+    font-size: 86.5%;
+    color: #999;
+}
+
+.footnotes ol {
+    list-style-type: decimal-leading-zero;
+    margin: 2.8em 0 1.4em 0;
+    padding: 0 0 0 2.2em;
+}
+
+pre {
+    margin-left: 2em;
+}
+
+pre, code, kbd, var, tt, .codeRay, .code {
+    font-family: Menlo, monospace;
+    font-size: 86.5%;
+    color: #333;
+    page-break-inside: avoid;
+}
+
+.footnotes pre, .footnotes code, .footnotes kbd, .footnotes var, .footnotes tt, .footnotes .codeRay, .footnotes .code {
+    color: #888;
+}
+
+dt {
+    font-style: italic;
+}
+
+dd {
+    margin: 0 0 0 1.4em;
+}

metadata

@@ -0,0 +1,310 @@
+--- !ruby/object:Gem::Specification
+name: rpub
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Arjan van der Gaag
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typogruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  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'
+- !ruby/object:Gem::Dependency
+  name: growl
+  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:
+- rpub
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+- HISTORY.md
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- .yardopts
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- HISTORY.md
+- LICENSE
+- README.md
+- Rakefile
+- bin/rpub
+- example/advanced/README
+- example/advanced/config.yml
+- example/advanced/layout.html
+- example/advanced/styles.css
+- example/simple/01-introduction.md
+- example/simple/02-foo.md
+- example/simple/03-bar.md
+- example/simple/config.yml
+- lib/rpub.rb
+- lib/rpub/book.rb
+- lib/rpub/chapter.rb
+- lib/rpub/commander.rb
+- lib/rpub/commands/base.rb
+- lib/rpub/commands/clean.rb
+- lib/rpub/commands/compile.rb
+- lib/rpub/commands/help.rb
+- lib/rpub/commands/main.rb
+- lib/rpub/commands/package.rb
+- lib/rpub/commands/preview.rb
+- lib/rpub/compilation_helpers.rb
+- lib/rpub/compressor.rb
+- lib/rpub/epub.rb
+- lib/rpub/epub/container.rb
+- lib/rpub/epub/content.rb
+- lib/rpub/epub/cover.rb
+- lib/rpub/epub/html_toc.rb
+- lib/rpub/epub/toc.rb
+- lib/rpub/hash_delegation.rb
+- lib/rpub/subclass_tracker.rb
+- lib/rpub/version.rb
+- lib/rpub/xml_file.rb
+- rpub.gemspec
+- spec/fixtures/clean/config.yml
+- spec/fixtures/clean/example.epub
+- spec/fixtures/clean/preview.html
+- spec/fixtures/no_files/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/main_spec.rb
+- spec/rpub/commands/preview_spec.rb
+- spec/rpub_spec.rb
+- spec/spec_helper.rb
+- support/layout.html
+- support/styles.css
+homepage: http://avdgaag.github.com/rpub
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 756011084715788975
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 756011084715788975
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.22
+signing_key: 
+specification_version: 3
+summary: ! '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 * Very simple version control'
+test_files:
+- spec/fixtures/clean/config.yml
+- spec/fixtures/clean/example.epub
+- spec/fixtures/clean/preview.html
+- spec/fixtures/no_files/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/main_spec.rb
+- spec/rpub/commands/preview_spec.rb
+- spec/rpub_spec.rb
+- spec/spec_helper.rb
+has_rdoc: