rpub 0.1.0

data/lib/rpub/chapter.rb

@@ -0,0 +1,84 @@
+module Rpub
+  # Representation of a chapter in the book, from a single input file from the
+  # project directory.  The Chapter object knows how to turn itself into HTML
+  # suitable for writing to the epub archive with the appropriate identifiers
+  # to be listed in the epub manifest files.
+  class Chapter
+    # @return [String] raw textual contents of this chapter
+    attr_reader :content
+
+    # @return [Fixnum] chapter number provided by its associated Book object
+    attr_reader :number
+
+    # @return [String] filename of the layout to use, to be passed directly to the Kramdown gem.
+    attr_reader :layout
+
+    def initialize(content, number, layout)
+      @content, @number, @layout = content, number, layout
+      @document = Kramdown::Document.new(content, KRAMDOWN_OPTIONS.merge(:template => layout))
+    end
+
+    # @return [String] Unique identifier for this chapter.
+    def uid
+      @uid ||= Digest::SHA1.hexdigest([content, id.to_s, layout].join)
+    end
+
+    # @return [String] XML-friendly slug for this chapter based on its number.
+    def id
+      @id ||= "chapter-#{number}"
+    end
+
+    # @return [String] content parsed to HTML by the markdown engine.
+    def to_html
+      @to_html ||= @document.to_html
+    end
+
+    # @return [String] name for the file in the zip to use, based on the title
+    def filename
+      @filename ||= id.to_s + '-' + title.gsub(/[^\w\.]/i, '-').squeeze('-').downcase.chomp('-') + '.html'
+    end
+
+    # Ordered headers for this chapter, each header as an object responding
+    # to #level and #text.
+    #
+    # @return [Array<#text,#level>] list of headers for this chapter
+    def outline
+      @outline ||= elements(:header).map do |element|
+        OpenStruct.new({
+          :level => element.options[:level],
+          :text  => element_text(element),
+          :id    => Kramdown::Converter::Html.send(:new, @document, { :auto_id_prefix => '' }).generate_id(element.options[:raw_text])
+        })
+      end
+    end
+
+    # @return [Array<String>] list of all image references
+    def images
+      @images ||= elements(:img).map { |e| e.attr['src'] }
+    end
+
+    # @return [String] Text of the first heading in this chapter
+    def title
+      @title ||= begin
+        (heading = outline.first) ? heading.text : 'untitled'
+      end
+    end
+
+  private
+
+    def element_text(element)
+      elements(:text, element).map { |e| e.value }.join
+    end
+
+    def elements(type, root = @document.root)
+      collector = lambda do |element|
+        element.children.select { |e|
+          e.type == type
+        } + element.children.map { |e|
+          collector.call(e)
+        }.flatten
+      end
+      collector.call(root)
+    end
+  end
+end

data/lib/rpub/commander.rb

@@ -0,0 +1,14 @@
+module Rpub
+  module Commander
+    def invoke(args = [])
+      subcommand, *options = args
+      Commands::Base.matching(subcommand).new(options).invoke
+    rescue SubclassTracker::NoSuchSubclass
+      Commands::Main.new(args).invoke
+    rescue NoConfiguration
+      abort 'The current directory does not look like an rpub project.'
+    end
+
+    extend self
+  end
+end

data/lib/rpub/commands/base.rb

@@ -0,0 +1,33 @@
+module Rpub
+  module Commands
+    class Base
+      extend SubclassTracker
+
+      attr_reader :options
+
+      def initialize(options = [], stdout = $stdout)
+        @options, @stdout = options, stdout
+      end
+
+      def invoke
+        parser.parse!(options)
+      end
+
+      def help
+        puts parser
+      end
+
+    protected
+
+      def parser
+        OptionParser.new
+      end
+
+    private
+
+      def puts(*args)
+        @stdout.puts(*args)
+      end
+    end
+  end
+end

data/lib/rpub/commands/clean.rb

@@ -0,0 +1,55 @@
+module Rpub
+  module Commands
+    class Clean < Base
+      include CompilationHelpers
+
+      identifier 'clean'
+
+      def invoke
+        super
+        remove create_book.filename
+        remove 'preview.html'
+      end
+
+    private
+
+      def parser
+        OptionParser.new do |opts|
+          opts.banner = <<-EOS
+Usage: rpub clean [-d]'
+
+Clean up all generated files, such as the standard generated .epub
+file, package files and preview files.
+
+Options:
+EOS
+
+          opts.separator ''
+
+          opts.on '-d', '--dry-run', 'Dry-run: only list files to be removed' do
+            @dry_run = true
+          end
+
+          opts.separator ''
+          opts.separator 'Generic options:'
+          opts.separator ''
+
+          opts.on_tail '-h', '--help', 'Display this message' do
+            puts opts
+            exit
+          end
+        end
+      end
+
+      def remove(filename)
+        if File.exist?(filename)
+          unless @dry_run
+            File.unlink(filename)
+          else
+            puts filename
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpub/commands/compile.rb

@@ -0,0 +1,56 @@
+module Rpub
+  module Commands
+    class Compile < Base
+      include CompilationHelpers
+
+      identifier 'compile'
+
+      def invoke
+        super
+        book = create_book
+        Compressor.open(book.filename) do |zip|
+          Epub.new(book, File.read(styles)).manifest_in(zip)
+        end
+      end
+
+    private
+
+      def parser
+        OptionParser.new do |opts|
+          opts.banner = <<-EOS
+Usage: rpub compile [options]
+
+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.
+
+Options:
+EOS
+          opts.separator ''
+
+          opts.on '-l', '--layout FILENAME', 'Specify an explicit layout file to use' do |filename|
+            @layout = filename
+          end
+
+          opts.on '-s', '--styles FILENAME', 'Specify an explicit stylesheet file to use' do |filename|
+            @styles = filename
+          end
+
+          opts.on '-c', '--config FILENAME', 'Specify an explicit configuration file to use' do |filename|
+            @config_file = filename
+          end
+
+          opts.separator ''
+          opts.separator 'Generic options:'
+          opts.separator ''
+
+          opts.on_tail '-h', '--help', 'Display this message' do
+            puts opts
+            exit
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpub/commands/help.rb

@@ -0,0 +1,37 @@
+module Rpub
+  module Commands
+    class Help < Base
+      identifier 'help'
+
+      def invoke
+        if options.empty?
+          Main.new.invoke
+        else
+          Base.matching(options.shift).new.help
+        end
+      end
+
+    private
+
+      def parser
+        OptionParser.new do |opts|
+          opts.banner = <<-EOS
+Usage: rpub help subcommand
+
+Describe the usage and options for rpub subcommands.
+
+Options:
+EOS
+          opts.separator ''
+          opts.separator 'Generic options:'
+          opts.separator ''
+
+          opts.on_tail '-h', '--help', 'Display this message' do
+            puts opts
+            exit
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpub/commands/main.rb

@@ -0,0 +1,45 @@
+module Rpub
+  module Commands
+    class Main < Base
+
+      def invoke
+        options << '-h' if options.empty?
+        super
+        raise InvalidSubcommand, options[0] unless options.empty?
+      end
+
+    protected
+
+      def parser
+        OptionParser.new do |opts|
+          opts.banner = <<-EOS
+Usage: rpub [subcommand] [options]
+
+Compile multiple Markdown-formatted input files into a machine-readable epub
+file for distribution as an ebook.
+
+Available subcommands:
+
+  compile
+  preview
+  clean
+  package
+  help
+EOS
+
+          opts.separator ''
+          opts.separator 'Generic options:'
+          opts.separator ''
+
+          opts.on_tail '-v', '--version', 'Display version information' do
+            puts "rpub #{Rpub::VERSION}"
+          end
+
+          opts.on_tail '-h', '--help', 'Display command reference' do
+            puts opts
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpub/commands/package.rb

@@ -0,0 +1,45 @@
+module Rpub
+  module Commands
+    class Package < Base
+      include CompilationHelpers
+
+      identifier 'package'
+
+      def invoke
+        super
+        Compile.new(options).invoke
+        return unless config.has_key?('package_file')
+        Compressor.open(config.fetch('package_file')) do |zip|
+          zip.store_file create_book.filename, File.read(create_book.filename)
+          config.fetch('package') { [] }.each do |file|
+            zip.compress_file file, File.read(file)
+          end
+        end
+      end
+
+    private
+
+      def parser
+        OptionParser.new do |opts|
+          opts.banner = <<-EOS
+Usage: rpub package
+
+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.
+
+Options:
+EOS
+          opts.separator ''
+          opts.separator 'Generic options:'
+          opts.separator ''
+
+          opts.on_tail '-h', '--help', 'Display this message' do
+            puts opts
+            exit
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpub/commands/preview.rb

@@ -0,0 +1,56 @@
+module Rpub
+  module Commands
+    class Preview < Base
+      include CompilationHelpers
+
+      identifier 'preview'
+
+      def initialize(*args)
+        super
+        @filename = 'preview.html'
+      end
+
+      def invoke
+        super
+        return unless markdown_files.any?
+        concatenation = markdown_files.join("\n")
+        File.open(@filename, 'w') do |f|
+          f.write Kramdown::Document.new(concatenation, KRAMDOWN_OPTIONS.merge(:template => layout)).to_html
+        end
+      end
+
+    private
+
+      def parser
+        OptionParser.new do |opts|
+          opts.banner = <<-EOS
+Usage: rpub preview [options]
+
+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".
+
+Options:
+EOS
+          opts.separator ''
+          opts.on '-l', '--layout FILENAME', 'Specify an explicit layout file to use' do |filename|
+            @layout = filename
+          end
+
+          opts.on '-o', '--output FILENAME', 'Specify an explicit output file' do |filename|
+            @filename = filename
+          end
+
+          opts.separator ''
+          opts.separator 'Generic options:'
+          opts.separator ''
+
+          opts.on_tail '-h', '--help', 'Display this message' do
+            puts opts
+            exit
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpub/compilation_helpers.rb

@@ -0,0 +1,43 @@
+module Rpub
+  module CompilationHelpers
+    def create_book
+      book = Book.new(layout, config)
+      markdown_files.each(&book.method(:<<))
+      book
+    end
+
+    def markdown_files
+      @markdown_files ||= filter_exceptions(Dir['*.md']).sort.map(&File.method(:read))
+    end
+
+    def layout
+      @layout ||= own_or_support_file('layout.html')
+    end
+
+    def styles
+      @styles ||= own_or_support_file('styles.css')
+    end
+
+    def config
+      @config_file ||= begin
+        raise NoConfiguration unless File.exist?('config.yml')
+        YAML.load_file('config.yml') || {}
+      end
+    end
+
+  private
+
+    def filter_exceptions(filenames)
+      return filenames unless config.has_key?('ignore')
+      filenames.reject(&config['ignore'].method(:include?))
+    end
+
+    def own_or_support_file(filename)
+      if File.exists?(filename)
+        filename
+      else
+        Rpub.support_file(filename)
+      end
+    end
+  end
+end