rpub 0.1.0

data/.gitignore

@@ -0,0 +1,8 @@
+doc
+.yardoc
+bin/*
+!bin/rpub
+.bundle
+.DS_Store
+*~
+pkg

data/.rspec

@@ -0,0 +1,5 @@
+--format progress
+--color
+-Ilib
+-Ispec
+-r spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3

data/.yardopts

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

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    rpub (0.1.0)
+      builder
+      kramdown
+      rubyzip
+      typogruby
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    ffi (1.0.11)
+    growl (1.0.3)
+    guard (1.0.1)
+      ffi (>= 0.5.0)
+      thor (~> 0.14.6)
+    guard-rspec (0.7.0)
+      guard (>= 0.10.0)
+    kramdown (0.13.5)
+    rake (0.9.2.2)
+    rb-fsevent (0.9.1)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    rubypants (0.2.0)
+    rubyzip (0.9.7)
+    thor (0.14.6)
+    typogruby (1.0.15)
+      rubypants
+    yard (0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  growl
+  guard
+  guard-rspec
+  rake
+  rb-fsevent
+  rpub!
+  rspec
+  yard

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/HISTORY.md

@@ -0,0 +1,5 @@
+# History
+
+## 0.1.0
+
+* Initial gem release

data/README.md

@@ -0,0 +1,182 @@
+# 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.
+
+## Introduction
+
+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
+
+## Installation
+
+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:
+
+    $ gem install rpub
+
+You can verify the gem has installed correctly by checking its version number:
+
+    $ rpub -v
+
+If this generates an error, something has gone wrong. You should see something
+along the lines of `rpub 1.0.0`.
+
+## Usage
+
+### 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
+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.
+
+The idea is you write several Markdown files using your favourite text editor,
+and save them as plain text in your project directory. Usually you would write
+one file per chapter. By invoking the `rpub` program you convert those files to
+HTML and combine them in an ePub archive:
+
+    $ rpub compile
+    Generating my-new-book-0.1.0.epub... Done!
+
+After you have run the `rpub compile` command, you will find a new `.epub` file
+in your project directory. The name of this file depends on the title of your
+book, and its version number. You can set these values, as well as a few others,
+in a special configuration file called `config.yml`:
+
+    ---
+    author: Your Name
+    title: My new book
+    version: 0.1.0
+
+This file is written in [YAML](http://yaml.org) and sets basic properties of your book project.
+
+To make sure the book you generated is _valid_ -- meaning it is likely that most
+readers out there will be able to read it -- you can use the special `validate`
+command:
+
+    $ rpub validate
+
+rPub will report any errors it finds. No output means everything is alright.
+
+Since regenerating your ePub file and opening it in a suitable reader
+application is cumbersome, rPub can generate a simple preview document for you:
+
+    $ rpub preview
+
+This will generate a new HTML file in your project directory with a name similar
+to your ePub file. This is the entire text of your book as a single web page for
+easy viewing in any browser.
+
+[Markdown]: http://daringfireball.net/projects/markdown
+[John gruber]: http://daringfireball.net
+
+### Advanced features
+
+#### Packaging for distribution
+
+Often you want to distribute your ebook over the internet, along with some
+extra files. You'll probably want to include a README file, a license or
+references to extra online resources. A `package` task is defined to generate a
+single compressed archive file from your generated ebook along with such
+additional files.
+
+You list the files to include with your ebook in your `config.yml` file, along
+with the resulting packaged file name:
+
+    ---
+    package_file: mybook.zip
+    package:
+      - README
+      - license.txt
+      - code-samples.rb
+
+All the filenames listed under `package` are looked up in the root of your
+project directory. These files will be combined with the ebook in the
+`mybook.zip` file in your project directory.
+
+#### Automatic table of contents
+
+Rpub automatically generates a table of contents for you, if you want it to. It
+does this by scanning all your markdown files for headings and listing them on
+a single page in the ebook. Each entry in the table of contents is linked to
+its appropriate heading in the chapter, and has various hooks for your
+stylesheet to determine its formatting.
+
+To enable the automatic generation of a table of contents, add the following
+configuration to your `config.yml` file:
+
+    toc: true
+
+#### Custom layout and styles
+
+When you compile a set of Markdown files to an ePub file, rpub uses a default
+HTML layout and set of styles to determine the look and feel of the book. These
+will do fine for most cases, but you can provide your own, if you are so
+inclined.
+
+Simply define a `layout.html` and/or `styles.css` in your project directory.
+Your HTML file will be parsed with Erb, an so you can include your writing
+using the `yield` method:
+
+    <html>
+    <body>
+      <%= yield %>
+    </body>
+    </html>
+
+**Note**: despite the name 'html' and `.html` extension, your file actually has
+to be XHTML-compliant.
+
+You can also provide custom layouts or styles to use when invoking the `compile`
+or `preview` commands, using the `-l` or `-s` options:
+
+    $ rpub compile -l /tmp/my-layout.html
+
+### Command reference
+
+* `rpub compile` -- generate .epub file
+* `rpub package` -- create zip file with compiled book and other listed files
+* `rpub preview` -- generate preview HTML file
+* `rpub help` -- get help on subcommands
+* `rpub clean` -- remove generated files
+
+### Examples
+
+See the [examples directory](https://github.com/avdgaag/rpub/example) for two example projects.
+
+## Other
+
+### Note on Patches/Pull Requests
+
+1. Fork the project.
+2. Make your feature addition or bug fix.
+3. Add tests for it. This is important so I don't break it in a future version
+   unintentionally.
+4. Commit, do not mess with rakefile, version, or history. (if you want to have
+   your own version, that is fine but bump version in a commit by itself I can
+   ignore when I pull)
+5. Send me a pull request. Bonus points for topic branches.
+
+### Issues
+
+Please report any issues, defects or suggestions in the [Github issue
+tracker](https://github.com/avdgaag/rpub/issues).
+
+### What has changed?
+
+See the [HISTORY](https://github.com/avdgaag/rpub/HISTORY) file for a detailed changelog.
+
+### Credits
+
+Created by: Arjan van der Gaag  
+URL: [http://arjanvandergaag.nl](http://arjanvandergaag.nl)  
+Project homepage: [http://avdgaag.github.com/rpub](http://avdgaag.github.com/rpub)  
+Date: april 2012  
+License: [MIT-license](https://github.com/avdgaag/rpub/LICENSE) (same as Ruby)

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+Bundler.setup
+
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new

data/bin/rpub

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'rpub'
+
+Rpub::Commander.invoke(ARGV)

data/example/advanced/README

@@ -0,0 +1 @@
+Example readme file

data/example/advanced/config.yml

@@ -0,0 +1,11 @@
+---
+creator: Arjan van der Gaag
+language: en
+title: My awesome ebook
+publisher: Me!
+subject: Some subject
+rights: none
+description: foo bar
+package_file: 'ebook.zip'
+package:
+  - README

data/example/simple/01-introduction.md

@@ -0,0 +1,3 @@
+# Introduction
+
+Lorem ipsum dolor sit amet.

data/example/simple/02-foo.md

@@ -0,0 +1,4 @@
+# Introduction
+
+Lorem ipsum dolor sit amet.
+

data/example/simple/03-bar.md

@@ -0,0 +1,4 @@
+# Introduction
+
+Lorem ipsum dolor sit amet.
+

data/example/simple/config.yml

@@ -0,0 +1,8 @@
+---
+creator: Arjan van der Gaag
+language: en
+title: My awesome ebook
+publisher: Me!
+subject: Some subject
+rights: none
+description: foo bar

data/lib/rpub.rb

@@ -0,0 +1,53 @@
+require 'optparse'
+require 'fileutils'
+require 'yaml'
+require 'digest'
+require 'ostruct'
+require 'erb'
+
+require 'builder'
+require 'kramdown'
+require 'zip/zip'
+
+require 'rpub/version'
+require 'rpub/subclass_tracker'
+require 'rpub/commander'
+require 'rpub/compilation_helpers'
+require 'rpub/commands/base'
+require 'rpub/commands/main'
+require 'rpub/commands/compile'
+require 'rpub/commands/clean'
+require 'rpub/commands/preview'
+require 'rpub/commands/package'
+require 'rpub/commands/help'
+require 'rpub/hash_delegation'
+require 'rpub/book'
+require 'rpub/chapter'
+require 'rpub/compressor'
+require 'rpub/epub'
+require 'rpub/xml_file'
+require 'rpub/epub/container'
+require 'rpub/epub/toc'
+require 'rpub/epub/content'
+require 'rpub/epub/html_toc'
+require 'rpub/epub/cover'
+
+module Rpub
+  GEM_ROOT = File.expand_path('../../', __FILE__)
+
+  NoConfiguration = Class.new(StandardError)
+
+  class InvalidSubcommand < StandardError
+    def initialize(subcommand)
+      super "Unknown subcommand: #{subcommand}"
+    end
+  end
+
+  def self.support_file(path)
+    File.join(GEM_ROOT, 'support', path)
+  end
+
+  KRAMDOWN_OPTIONS = {
+    :coderay_line_numbers => nil
+  }
+end

data/lib/rpub/book.rb

@@ -0,0 +1,70 @@
+module Rpub
+  # The Book object wraps a collection of chapter objects and knows about its
+  # ordering, the book metadata from the configuration file and the book output
+  # filename.
+  class Book
+    include Enumerable
+    include HashDelegation
+
+    delegate_to_hash :config
+
+    # @return [Hash] The hash of configuration options read from the config.yml file.
+    attr_reader :config
+
+    # @return [Array] List of chapters, one for every input markdown file.
+    attr_reader :chapters
+
+    # @return [String] the path the layout HTML file to use to wrap the chapter in.
+    attr_reader :layout
+
+    def initialize(layout, config = {})
+      @chapters, @config, @layout = [], config, layout
+    end
+
+    def each(&block)
+      chapters.each(&block)
+    end
+
+    def toc?
+      !!config.fetch('toc') { false }
+    end
+
+    def cover?
+      !!config.fetch('cover_image') { false }
+    end
+
+    def outline
+      inject([]) { |all, chapter| all << [chapter.filename, chapter.outline] }
+    end
+
+    def images
+      map { |chapter| chapter.images }.flatten.uniq
+    end
+
+    # Add textual content as a new Chapter to this book.
+    #
+    # This method returns the `Book` object iself, so you can chain multiple calls:
+    #
+    # @example Chaining mutliple calls
+    #   book << 'foo' << 'bar'
+    #
+    # @param [String] content is chapter text to add
+    def add_chapter(content)
+      chapters << Chapter.new(content, chapters.size, layout)
+      self
+    end
+    alias_method :<<, :add_chapter
+
+    # @return [String] Unique identifier for this entire book to be used in the
+    #   epub manifest files.
+    def uid
+      @uid ||= Digest::SHA1.hexdigest [config.inspect, map(&:uid)].join
+    end
+
+    # @return [String] output filename for epub, based on the book title and
+    #   version number.
+    def filename
+      @filename ||= [config['title'], config['version']].join('-').gsub(/[^\w\.]/i, '-').squeeze('-').downcase.chomp('-') + '.epub'
+    end
+  end
+end