RubyGems - rpub - Versions diffs - 0.4.0 → 0.5.0 - Mend

rpub 0.4.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (120) hide show

checksums.yaml +7 -0
data/.gitignore +1 -1
data/.rspec +0 -1
data/.travis.yml +3 -4
data/.yardopts +1 -0
data/Gemfile +1 -1
data/Gemfile.lock +70 -46
data/Guardfile +6 -0
data/HISTORY.md +10 -0
data/README.md +1 -1
data/Rakefile +7 -2
data/bin/rpub +64 -1
data/doc/.gitignore +8 -0
data/doc/api/Rpub.html +339 -0
data/doc/api/Rpub/Book.html +983 -0
data/doc/api/Rpub/Chapter.html +737 -0
data/doc/api/Rpub/Command.html +356 -0
data/doc/api/Rpub/Commands.html +117 -0
data/doc/api/Rpub/Commands/Clean.html +216 -0
data/doc/api/Rpub/Commands/Compile.html +218 -0
data/doc/api/Rpub/Commands/Generate.html +242 -0
data/doc/api/Rpub/Commands/Package.html +230 -0
data/doc/api/Rpub/Commands/Preview.html +216 -0
data/doc/api/Rpub/Commands/Stats.html +226 -0
data/doc/api/Rpub/Compressor.html +687 -0
data/doc/api/Rpub/Context.html +553 -0
data/doc/api/Rpub/Document.html +647 -0
data/doc/api/Rpub/Document/OutlineElement.html +388 -0
data/doc/api/Rpub/Epub.html +465 -0
data/doc/api/Rpub/Epub/Container.html +224 -0
data/doc/api/Rpub/Epub/Content.html +344 -0
data/doc/api/Rpub/Epub/Cover.html +236 -0
data/doc/api/Rpub/Epub/HtmlToc.html +240 -0
data/doc/api/Rpub/Epub/Toc.html +244 -0
data/doc/api/Rpub/FilesystemSource.html +544 -0
data/doc/api/Rpub/HashDelegation.html +281 -0
data/doc/api/Rpub/HashDelegation/ClassMethods.html +175 -0
data/doc/api/Rpub/MediaType.html +192 -0
data/doc/api/Rpub/Preview.html +464 -0
data/doc/api/Rpub/XmlFile.html +457 -0
data/doc/api/_index.html +405 -0
data/doc/api/class_list.html +54 -0
data/doc/api/css/common.css +1 -0
data/doc/api/css/full_list.css +57 -0
data/doc/api/css/style.css +339 -0
data/doc/api/file.HISTORY.html +131 -0
data/doc/api/file.LICENSE.html +92 -0
data/doc/api/file.README.html +337 -0
data/doc/api/file_list.html +62 -0
data/doc/api/frames.html +26 -0
data/doc/api/index.html +337 -0
data/doc/api/js/app.js +219 -0
data/doc/api/js/full_list.js +178 -0
data/doc/api/js/jquery.js +4 -0
data/doc/api/method_list.html +533 -0
data/doc/api/top-level-namespace.html +112 -0
data/doc/index.html +312 -0
data/doc/javascripts/scale.fix.js +17 -0
data/doc/params.json +1 -0
data/doc/stylesheets/pygment_trac.css +69 -0
data/doc/stylesheets/styles.css +255 -0
data/features/clean.feature +31 -0
data/features/compile.feature +49 -0
data/features/embedded_assets.feature +51 -0
data/features/generate.feature +63 -0
data/features/layout.feature +41 -0
data/features/package.feature +30 -0
data/features/previews.feature +66 -0
data/features/stats.feature +18 -0
data/features/step_definitions/general_steps.rb +60 -0
data/features/styles.feature +33 -0
data/features/support/env.rb +7 -0
data/features/table_of_contents.feature +35 -0
data/lib/rpub.rb +28 -31
data/lib/rpub/book.rb +9 -16
data/lib/rpub/chapter.rb +4 -54
data/lib/rpub/command.rb +32 -0
data/lib/rpub/commands/clean.rb +4 -49
data/lib/rpub/commands/compile.rb +4 -49
data/lib/rpub/commands/generate.rb +10 -67
data/lib/rpub/commands/package.rb +9 -37
data/lib/rpub/commands/preview.rb +4 -54
data/lib/rpub/commands/stats.rb +6 -10
data/lib/rpub/compressor.rb +3 -3
data/lib/rpub/context.rb +48 -0
data/lib/rpub/document.rb +68 -0
data/lib/rpub/epub.rb +8 -7
data/lib/rpub/epub/content.rb +9 -30
data/lib/rpub/epub/cover.rb +1 -8
data/lib/rpub/epub/html_toc.rb +4 -9
data/lib/rpub/epub/toc.rb +16 -13
data/lib/rpub/filesystem_source.rb +47 -0
data/lib/rpub/media_type.rb +16 -0
data/lib/rpub/preview.rb +29 -0
data/lib/rpub/version.rb +1 -1
data/lib/rpub/xml_file.rb +4 -1
data/rpub.gemspec +6 -7
data/spec/rpub/book_spec.rb +45 -45
data/spec/rpub/chapter_spec.rb +87 -22
data/spec/rpub/epub/container_spec.rb +3 -5
data/spec/rpub/epub/content_spec.rb +62 -41
data/spec/rpub/epub/cover_spec.rb +3 -5
data/spec/rpub/epub/html_toc_spec.rb +8 -8
data/spec/rpub/epub/toc_spec.rb +20 -22
data/spec/rpub_spec.rb +1 -3
data/spec/spec_helper.rb +28 -0
data/support/config.yml +1 -0
data/support/styles.css +3 -3
metadata +131 -120
data/lib/rpub/commander.rb +0 -23
data/lib/rpub/commands/base.rb +0 -33
data/lib/rpub/commands/help.rb +0 -37
data/lib/rpub/commands/main.rb +0 -45
data/lib/rpub/compilation_helpers.rb +0 -73
data/lib/rpub/subclass_tracker.rb +0 -53
data/spec/rpub/commands/clean_spec.rb +0 -46
data/spec/rpub/commands/generate_spec.rb +0 -52
data/spec/rpub/commands/main_spec.rb +0 -26
data/spec/rpub/commands/package_spec.rb +0 -33
data/spec/rpub/commands/preview_spec.rb +0 -43

data/features/layout.feature ADDED

@@ -0,0 +1,41 @@
+Feature: page layout
+    As an author
+    I want to wrap my content in a template file
+    In order to spice up my book's looks
+    Background:
+        Given a file named "chapter1.md" with:
+        """
+        # Hello, world
+        """
+    Scenario: default layout
+        When I successfully run `rpub compile`
+        And I successfully run `unzip untitled-book-0.0.0.epub`
+        Then the file "OEBPS/chapter-0-hello-world.html" should contain "<body>"
+    Scenario: overriding layout by filename
+        Given a file named "layout.html" with:
+        """
+        foo
+        <%= @body %>
+        bar
+        """
+        When I successfully run `rpub compile`
+        And I successfully run `unzip untitled-book-0.0.0.epub`
+        Then the file "OEBPS/chapter-0-hello-world.html" should contain "foo"
+        And the file "OEBPS/chapter-0-hello-world.html" should contain "bar"
+    Scenario: overriding layout by option
+        Given a file named "template.html" with:
+        """
+        foo
+        <%= @body %>
+        bar
+        """
+        When I successfully run `rpub compile -l template.html`
+        And I successfully run `unzip untitled-book-0.0.0.epub`
+        Then the file "OEBPS/chapter-0-hello-world.html" should contain "foo"
+        And the file "OEBPS/chapter-0-hello-world.html" should contain "bar"

data/features/package.feature ADDED

@@ -0,0 +1,30 @@
+Feature: packaging
+    As an author
+    I want to package my book and other files into a single archive
+    So I can easily distribute it over the internet
+    Background:
+        Given a basic project
+    Scenario: compressing book
+        When I successfully run `rpub package`
+        Then a file named "untitled_book.zip" should exist
+        And the archive "untitled_book.zip" should contain file "untitled-book-0.0.0.epub"
+    Scenario: custom package filename
+        Given the default "config.yml" file with "package_file" set to "my_book.zip"
+        When I successfully run `rpub package`
+        Then a file named "my_book.zip" should exist
+    Scenario: uncompiled book
+        When I successfully run `rpub package`
+        Then a file named "untitled-book-0.0.0.epub" should exist
+    Scenario: help
+        When I successfully run `rpub package -h`
+        Then the output should contain "Compile your ebook to an ePub file and package it into an archive"
+    Scenario: additional files
+        When I successfully run `rpub package`
+        Then a file named "untitled_book.zip" should exist
+        And the archive "untitled_book.zip" should contain file "README.md"

data/features/previews.feature ADDED

@@ -0,0 +1,66 @@
+Feature: previews
+    As an author
+    I want to quickly see my words in an HTML file with the final formatting
+    So I can see how my work will look without having to use a special e-reader
+    Scenario: when there is no content
+        Given the default "config.yml" file
+        When I successfully run `rpub preview`
+        Then a file named "preview.html" should not exist
+    Scenario: concatenating content and styles
+        Given the default "config.yml" file
+        And a file named "chapter1.md" with:
+            """
+            Content 1
+            """
+        And a file named "chapter2.md" with:
+            """
+            Content 2
+            """
+        When I successfully run `rpub preview`
+        Then a file named "preview.html" should exist
+        And the file "preview.html" should contain:
+            """
+            <?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">
+            """
+        And the file "preview.html" should contain "Content&nbsp;1"
+        And the file "preview.html" should contain "Content&nbsp;2"
+        And the file "preview.html" should contain:
+            """
+            body {
+                margin: 3%;
+                font-family: Georgia, serif;
+                line-height: 1.4em;
+            }
+            """
+    Scenario: given an explicit filename
+        Given the default "config.yml" file
+        And a file named "chapter1.md" with:
+            """
+            Content 1
+            """
+        When I successfully run `rpub preview -o output.html`
+        Then a file named "preview.html" should not exist
+        And a file named "output.html" should exist
+    Scenario: given an explicit layout
+        Given the default "config.yml" file
+        And a file named "chapter1.md" with:
+            """
+            Content 1
+            """
+        And a file named "layout.html" with:
+            """
+            Custom layout
+            <%= @body %>
+            """
+        When I successfully run `rpub preview -l layout.html`
+        Then the file "preview.html" should contain "Custom&nbsp;layout"
+    Scenario: getting help
+        When I successfully run `rpub preview -h`
+        Then the stdout should contain "Generate a single-page HTML file"

data/features/stats.feature ADDED

@@ -0,0 +1,18 @@
+Feature: text statistics
+    As an author
+    I want to see some stats about my work
+    In order to get a sense of progress
+    Scenario: Lorem ipsum
+        Given the default "config.yml" file
+        And a file named "chapter1.md" with:
+            """
+            Lorem ipsum dolor sit amet"
+            """
+        When I successfully run `rpub stats`
+        Then the output should contain "5 words"
+        And the output should contain "1 pages"
+        And the output should contain "1 sentences"
+        And the output should contain "5.0 avg sentence length"
+        And the output should contain "ari"
+        And the output should contain "clf"

data/features/step_definitions/general_steps.rb ADDED

@@ -0,0 +1,60 @@
+def read_support_file(filename)
+  File.read(File.join(SUPPORT_PATH, filename))
+end
+Given /^the default "(.*?)" file$/ do |filename|
+  write_file filename, read_support_file(filename)
+end
+Given /^the default "config.yml" file with "(.*?)" set to "(.*?)"$/ do |key, value|
+  config = YAML.load(read_support_file('config.yml'))
+  value = false if value == 'false'
+  value = value.to_i if value =~ /^\d+$/
+  config[key] = value
+  write_file 'config.yml', YAML.dump(config)
+end
+Given /^the default "config.yml" file with:$/ do |settings|
+  config = YAML.load(read_support_file('config.yml'))
+  config.merge! settings.rows_hash
+  write_file 'config.yml', YAML.dump(config)
+end
+Then /^the default file "(.*?)" should exist$/ do |filename|
+  step %Q{a file named "#{filename}" should exist}
+  step %Q{the file "#{filename}" should contain exactly:}, read_support_file(filename)
+end
+Then /^the archive "(.*?)" should contain file "(.*?)"$/ do |filename, entry|
+  in_current_dir do
+    Zip::File.open(filename, Zip::File::CREATE) do |zipfile|
+      zipfile.get_entry(entry)
+    end
+  end
+end
+Then /^the archive "(.*?)" should not contain file "(.*?)"$/ do |filename, entry|
+  in_current_dir do
+    Zip::File.open(filename, Zip::File::CREATE) do |zipfile|
+      expect(zipfile.find_entry(entry)).to be_nil
+    end
+  end
+end
+Given /^a basic project$/ do
+  steps %Q{
+    Given a file named "README.md" with:
+        """
+        README file
+        """
+    And the default "layout.html" file
+    And the default "styles.css" file
+    And the default "config.yml" file
+    And a file named "chapter1.md" with:
+        """
+        # Chapter 1
+        Hello, world
+        """
+  }
+end

data/features/styles.feature ADDED

@@ -0,0 +1,33 @@
+Feature: page layout
+    As an author
+    I want to format my text with CSS
+    In order to spice up my book's looks
+    Background:
+        Given a file named "chapter1.md" with:
+        """
+        Hello, world
+        """
+    Scenario: default styles
+        When I successfully run `rpub compile`
+        Then the archive "untitled-book-0.0.0.epub" should contain file "OEBPS/styles.css"
+    Scenario: overriding styles
+        Given a file named "styles.css" with:
+        """
+        foo bar
+        """
+        When I successfully run `rpub compile`
+        And I successfully run `unzip untitled-book-0.0.0.epub`
+        Then the file "OEBPS/styles.css" should contain "foo bar"
+    Scenario: custom styles
+        Given a file named "formatting.css" with:
+        """
+        foo bar
+        """
+        When I successfully run `rpub compile -s formatting.css`
+        And I successfully run `unzip untitled-book-0.0.0.epub`
+        Then the file "OEBPS/styles.css" should contain "foo bar"

data/features/support/env.rb ADDED

@@ -0,0 +1,7 @@
+require 'aruba/cucumber'
+require 'zip'
+SUPPORT_PATH = File.expand_path(File.join(*%w[.. .. .. support]), __FILE__)
+Before do
+  @aruba_timeout_seconds = 5
+end

data/features/table_of_contents.feature ADDED

@@ -0,0 +1,35 @@
+Feature: automatic table of contents
+    As an author
+    I want to have my table of contents automatically generated
+    So I don't have to do it manually
+    Background:
+        Given a file named "chapter1.md" with:
+        """
+        # Chapter 1
+        ## Subheading
+        Lorem ipsum
+        """
+    Scenario: skipping human-readable table of contents
+        When I successfully run `rpub compile`
+        And I run `unzip untitled-book-0.0.0.epub`
+        Then a file named "OEBPS/toc.html" should exist
+        And the file "OEBPS/toc.html" should contain "Chapter 1"
+        And the file "OEBPS/toc.html" should contain "Subheading"
+    Scenario: human-readable table of contents
+        Given the default "config.yml" file with "toc" set to "false"
+        When I successfully run `rpub compile`
+        And I run `unzip untitled-book-0.0.0.epub`
+        Then the file "OEBPS/toc.html" should not exist
+    Scenario: custom table of contents depth
+        Given the default "config.yml" file with "max_level" set to "1"
+        When I successfully run `rpub compile`
+        And I run `unzip untitled-book-0.0.0.epub`
+        Then the file "OEBPS/toc.html" should contain "Chapter 1"
+        And the file "OEBPS/toc.html" should not contain "Subheading"

data/lib/rpub.rb CHANGED

@@ -4,29 +4,45 @@ require 'yaml'
 require 'digest'
 require 'ostruct'
 require 'erb'
+require 'forwardable'
 require 'builder'
 require 'kramdown'
-require 'zip/zip'
+require 'zip'
 require 'nokogiri'
 require 'textstats'
 require 'typogruby'
+module Rpub
+  GEM_ROOT = File.expand_path('../../', __FILE__)
+  # @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
+  def self.source
+    FilesystemSource
+  end
+  def self.document_factory
+    Rpub::Document.method(:new)
+  end
+end
 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/filesystem_source'
+require 'rpub/context'
+require 'rpub/command'
 require 'rpub/commands/clean'
-require 'rpub/commands/preview'
-require 'rpub/commands/package'
-require 'rpub/commands/help'
+require 'rpub/commands/compile'
 require 'rpub/commands/generate'
+require 'rpub/commands/package'
+require 'rpub/commands/preview'
 require 'rpub/commands/stats'
 require 'rpub/hash_delegation'
 require 'rpub/book'
+require 'rpub/preview'
 require 'rpub/chapter'
 require 'rpub/compressor'
 require 'rpub/epub'
@@ -36,24 +52,5 @@ 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
-  # @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
-  KRAMDOWN_OPTIONS = {
-    :coderay_line_numbers => nil
-  }
-end
+require 'rpub/media_type'
+require 'rpub/document'

data/lib/rpub/book.rb CHANGED

@@ -3,25 +3,18 @@ module Rpub
   # ordering, the book metadata from the configuration file and the book output
   # filename.
   class Book
+    extend Forwardable
     include Enumerable
-    include HashDelegation
-    delegate_to_hash :config
-    # @return [Hash] The hash of configuration options read from the config.yml file.
-    attr_reader :config
+    def_delegators :@context, :fonts, :config, :layout
     # @return [Array<Chapter>] List of chapters, one for every input markdown file.
     attr_reader :chapters
-    # @return [Array<String>] all the fonts referred to in the stylesheet
-    attr_reader :fonts
-    # @return [String] the path the layout HTML file to use to wrap the chapter in.
-    attr_reader :layout
-    def initialize(layout, config = {}, fonts = [])
-      @chapters, @config, @layout, @fonts = [], config, layout, fonts
+    def initialize(context)
+      @chapters = []
+      @context = context
+      @context.chapter_files.each(&method(:<<))
     end
     def each(&block)
@@ -33,11 +26,11 @@ module Rpub
     end
     def has_toc?
-      !!config.fetch('toc') { false }
+      !!config.toc
     end
     def has_cover?
-      !!config.fetch('cover_image') { false }
+      !!config.cover_image
     end
     def outline
@@ -71,7 +64,7 @@ module Rpub
     # @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'
+      @filename ||= [config.title, config.version].join('-').gsub(/[^\w\.]/i, '-').squeeze('-').downcase.chomp('-') + '.epub'
     end
   end
 end

data/lib/rpub/chapter.rb CHANGED

@@ -4,6 +4,9 @@ module Rpub
   # suitable for writing to the epub archive with the appropriate identifiers
   # to be listed in the epub manifest files.
   class Chapter
+    extend Forwardable
+    def_delegators :@document, :images, :outline, :toc, :title, :to_html
     # @return [String] raw textual contents of this chapter
     attr_reader :content
@@ -15,12 +18,7 @@ module Rpub
     def initialize(content, number, layout)
       @content, @number, @layout = content, number, layout
-      @document = Kramdown::Document.new(content, KRAMDOWN_OPTIONS.merge(:template => layout))
-    end
-    # @return [Kramdown::Element] Toc elements hierarchy
-    def toc
-      Kramdown::Converter::Toc.convert(@document.root).first
+      @document = Rpub.document_factory.call(content, layout)
     end
     # @return [String] Unique identifier for this chapter.
@@ -33,57 +31,9 @@ module Rpub
       @id ||= "chapter-#{number}"
     end
-    # @return [String] content parsed to HTML by the markdown engine.
-    def to_html
-      @to_html ||= Typogruby.improve(@document.to_html)
-    end
     # @return [String] name for the file in the zip to use, based on the title
     def filename
       @filename ||= xml_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),
-          :html_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