author 1.0.1.alpha → 1.1.0.alpha

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Yjc1MjM1Yzk0NjhhZmQ2MzRlNTBlZmQ5Mzc0NDVjZGZiOTIyZDgyYQ==
+    MTBlMzUwOWE0ZjQ3MWNjYmJmYmU2Y2JlNmQ0YmZhOWVkODJmZTA2NA==
   data.tar.gz: !binary |-
-    Mzk2ZjY2YzdlMDM4Y2I5MGM4YmZiOWZjZGM5MmNjZDlmYjk3YTg3Yw==
+    ZmRiMDRjZDlmMjdjZTUzM2Q1ZDhhZmY5ODg1YWE1NjU5YzQzZGQ1NA==
 SHA512:
   metadata.gz: !binary |-
-    ZTA1ZWE2ZDE1M2U0ZWFhMDkzYzJiZDZhMmU2YjE2NDQwNjM2ZjA5OGZiOGJh
-    NzAwYWU5YzljZmJmN2I5MWFiZjM4MzE2NzZhYzg2NmNiYTI5ZjE0NDMyOGE4
-    YTFlOTI4MTAwZTdlMTQxZTY1NWMwMTFlOTljNmM2YThkZDNlZGQ=
+    OWVkNjRiNDhmYWNkMjBlNTNhMGZhMGRkNjAyNzhiMDEwZmVjMzY5YWRmMmIw
+    MmIxMWY3N2RkMmJiOGIzOWM0NzY2MDcwNTc4NWU0MGNhNDgyOTMxMjA4NmUz
+    YTczY2UzNjYwMTJiOGRjYWViZTQwZDA3MTE2NWVmYzI3OWVhYTE=
   data.tar.gz: !binary |-
-    NDFmZGVhZWVhZDQ2YzMwOGUwNWRiMDM4MzYzYzhlYzRmYjIwZTNjNzRhZjI4
-    MzM4MjNkY2NjYmQ5MjRkNzdlOGE0MjUwYjQyMmY2NTRiYWNhNTU1OWUyYzlh
-    YWU0YWEyZmVkNGFkNTk2OTM0MmQyMzhmYTI4MDc1MjFjYjg1MGY=
+    ODgwZDBlYzhlOWE4YzQ5OTFkN2QyNDNkNTNiYzQxY2Q2ODYxZmViOWRjZTk4
+    ZTBkNzlhOWVjMDg5MzUwYzg2NjA5NDBhYTVlMzRiYjVlMTRhOWNhNDU1NzEy
+    NjZjYmMzODk3NDVjZTZhYjhiODA0YTg2MDI2MDJmZDE3ZGY0ZGQ=

data/README.md

@@ -1,21 +1,23 @@
-# Author
+# Author [![GitHub version](https://badge.fury.io/gh/tschmidt%2Fauthor.svg)](http://badge.fury.io/gh/tschmidt%2Fauthor)
 
-[![Build Status](https://travis-ci.org/tschmidt/author.svg?branch=master)](https://travis-ci.org/tschmidt/author)
+[![Build Status](https://travis-ci.org/tschmidt/author.svg?branch=master)](https://travis-ci.org/tschmidt/author) [![Dependency Status](https://gemnasium.com/tschmidt/author.svg)](https://gemnasium.com/tschmidt/author)
 
 **ATTN:** This is still **very** alpha. Not everything is working. Use at your own risk.
 
+*[imho]: In my humble opinion
+
 A simple tool to help you write your next ebook.
 
 I had a major itch and this is what I used to scratch it. I wanted to write an ebook, but
-just could not find a toolset that had everything I wanted. Leanpub was too limited on the
+couldn't find a toolset that had everything I wanted. Leanpub was too limited on the
 styling of the book. Kitabu drove me nuts with the hoops I had to jump through with
 nokogiri. Wordsmith didn't do it for me either.
 
 What was I looking for?
 
-- Simple way to write my chapters in Markdown
+- A simple way to write my chapters in Markdown
 - Generate PDFs and ePubs that were pretty to look at
-- Have better looking codeblocks
+- Have better looking code blocks
 - Not have to do a ton of configuration!!!!
 
 Thus, Author was born.
@@ -34,7 +36,7 @@ Or install it yourself with:
 
     $ gem install author
 
-## Usage
+## Quick Start Guide
 
     $ author new mybook
     $ cd mybook
@@ -50,15 +52,26 @@ finished book:
 
 Once you've done that, just run one of the following commands:
 
-    author build xhtml # Generates the finalized XHTML site used for the other commands
-    author build pdf   # Generates a PDF of your book
-    author build epub  # Generates a fixed layout ePub that your eyeballs will love
+    author build xhtml
+    author build pdf
+    author build epub
+    author build mobi
     author build all   # Builds everything in one go
 
 That's it!
 
-Okay, there are a few other things you can do, like add a book cover image and include
-images in your book. But, for the most part, that is all there is to it.
+## Full Tutorial
+
+Coming soon.
+
+## Dependencies
+
+There are a couple of executables that Author requires to do its job.
+
+- [Prince XML](http://www.princexml.com): This is the tool used to create PDFs of your book. The free version of Prince XML is fully functional and adds a small icon to the first page of your PDF. I've looked at other solutions and this - imho - is the best one.
+- [KindleGen](http://www.amazon.com/gp/feature.html?docId=1000765211): This is a tool from Amazon that will generate a `.mobi` file.
+
+You can run `author check` to find out if you have these dependencies installed on your system.
 
 ## Contributing
 

data/author.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "thor"
   spec.add_dependency "liquid"
   spec.add_dependency "coderay"
+  spec.add_dependency "kramdown"
 end

data/lib/author/commands/builder.rb

@@ -0,0 +1,15 @@
+require 'thor'
+
+module Author
+  module Commands
+    class Builder < Thor
+      
+      desc "xhtml", "Build the XHTML site"
+      def xhtml
+        say "Building the XHTML site"
+        Author::Exporters::XHTML.export
+      end
+      
+    end
+  end
+end

data/lib/author/commands/cli.rb

@@ -13,6 +13,8 @@ module Author
       register Author::Commands::Check, 'check', 'check', 'Check that all dependencies are installed'
       register Author::Commands::Generator, 'new', 'new <book-name>', 'Create a new book project'
       
+      register Author::Commands::Builder, 'build', 'build', 'Build the specified format'
+      
     end
   end
 end

data/lib/author/commands/generator.rb

@@ -24,6 +24,9 @@ module Author
         copy_file   'Gemfile', 'Gemfile'
         create_file 'outline.txt'
         template    'sample.md', 'chapters/sample.md'
+        template    'layout.xhtml', 'templates/layout.xhtml'
+        
+        gsub_file 'templates/layout.xhtml', '<!-- insert @body -->', '<%= @body %>'
       end
       
       def bundle_gems

data/lib/author/exporters/xhtml.rb

@@ -0,0 +1,92 @@
+require 'liquid'
+require 'kramdown'
+require 'author/plugins/awesome_codeblock'
+
+module Author
+  module Exporters
+    class XHTML
+      # step 1: get file names from the outline.txt file
+      # step 2: create a new file called all.md
+      # step 3: concatenate all files and output to all.md
+      # step 4: run all.md through liquid
+      # step 5: run all.md through kramdown with template specified in config
+      # step 6: output result of step 5 to `export/book.xhtml`
+      # step 7: handle css and images
+      
+      def self.export
+        exporter = new
+        exporter.combine_all_files
+        exporter.liquify
+        exporter.kramdownify
+      end
+      
+      def root_dir
+        Dir.pwd
+      end
+      
+      def source_dir
+        File.join(root_dir, 'chapters')
+      end
+      
+      def outline_path
+        filepath = File.join(root_dir, 'outline.txt')
+        raise "No outline.txt file found. Make sure you are in an author project." unless File.file?(filepath)
+        filepath
+      end
+      
+      def file_names
+        [].tap do |array|
+          File.readlines(outline_path).each do |line|
+            array << line.gsub(/\n/, '')
+          end
+        end
+      end
+      
+      def combined_file_path
+        File.join(source_dir, 'all.md')
+      end
+      
+      def output_path
+        File.join(source_dir, '..', 'export', 'book.xhtml')
+      end
+      
+      def layout_path
+        File.join(source_dir, '..', 'templates', 'layout.xhtml')
+      end
+      
+      def combine_all_files
+        File.open(combined_file_path, 'w') do |file|
+          file.puts concatenate_files
+        end
+      end
+      
+      def concatenate_files
+        ''.tap do |output|
+          file_names.each do |file_name|
+            filepath = File.join(source_dir, file_name)
+            next unless File.file?(filepath)
+            output += IO.read(filepath)
+            output += "\n\n" unless file_name == file_names.last
+          end
+          return output
+        end
+      end
+      
+      def liquify(assigns = {})
+        @assigns = assigns
+        liquified_output = Liquid::Template.parse(IO.read(combined_file_path)).render(@assigns)
+        File.open(combined_file_path, 'w') do |file|
+          file.puts liquified_output
+        end
+      end
+      
+      def kramdownify
+        kramified_output = Kramdown::Document.new(IO.read(combined_file_path), template: layout_path).to_html
+        File.open(output_path, 'w') do |file|
+          file.puts kramified_output
+        end
+      end
+      
+    end
+  end
+end

data/lib/author/templates/layout.xhtml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta charset="utf-8" />
+    <title><%= name %></title>
+  </head>
+  <body>
+    <div id="contents">
+      <!-- insert @body -->
+    </div>
+  </body>
+</html>

data/lib/author/version.rb

@@ -1,3 +1,3 @@
 module Author
-  VERSION = "1.0.1.alpha"
+  VERSION = "1.1.0.alpha"
 end

data/lib/author.rb

@@ -11,11 +11,16 @@ end
 # stdlib
 
 # 3rd party
+require 'liquid'
+require 'coderay'
+require 'thor'
+require 'kramdown'
 
 # internals
 require 'author/version'
 require_all 'author/commands'
 require_all 'author/plugins'
+require_all 'author/exporters'
 
 module Author
   

data/test/commands/builder_test.rb

@@ -0,0 +1,13 @@
+require_relative '../helper'
+require 'author/commands/builder'
+
+describe Author::Commands::Builder do
+  
+  let(:builder) { Author::Commands::Builder }
+  
+  it "should respond to xhtml" do
+    output = capture { builder.start }
+    expect(output).to_include "xhtml"
+  end
+  
+end

data/test/commands/cli_test.rb

@@ -18,5 +18,9 @@ describe Author::Commands::Cli do
   it "should respond to new" do
     expect(output).to_include "new"
   end
+  
+  it "should respond to build" do
+    expect(output).to_include "build"
+  end
 
 end

data/test/commands/generator_test.rb

@@ -15,6 +15,7 @@ describe Author::Commands::Generator do
       'abook'.must_be_a_directory
       'abook/chapters'.must_be_a_directory
       'abook/export'.must_be_a_directory
+      'abook/templates'.must_be_a_directory
     end
   end
   
@@ -26,6 +27,7 @@ describe Author::Commands::Generator do
       'ihazfiles/Gemfile'.must_be_a_file
       'ihazfiles/outline.txt'.must_be_a_file
       'ihazfiles/chapters/sample.md'.must_be_a_file
+      'ihazfiles/templates/layout.xhtml'.must_be_a_file
     end
   end
   

data/test/exporters/xhtml_test.rb

@@ -0,0 +1,58 @@
+require_relative '../helper'
+require 'author/exporters/xhtml'
+
+describe Author::Exporters::XHTML do
+  
+  let(:exporter) { Author::Exporters::XHTML.new }
+  
+  it "should return a list of files" do
+    inside_sample_book do
+      expect(exporter.file_names).to_equal ['one.md', 'two.md', 'three.md']
+    end
+  end
+  
+  it "should combine the files" do
+    inside_sample_book do
+      expect(exporter.concatenate_files).to_include %q[## This is chapter one]
+      expect(exporter.concatenate_files).to_include %q[## This is chapter two]
+      expect(exporter.concatenate_files).to_include %q[## This is chapter three]
+    end
+  end
+  
+  it "should create a file called all.md" do
+    inside_sample_book do
+      exporter.combine_all_files
+      'chapters/all.md'.must_be_a_file
+      output = IO.read('chapters/all.md')
+      expect(exporter.concatenate_files).to_include %q[## This is chapter one]
+      expect(exporter.concatenate_files).to_include %q[## This is chapter two]
+      expect(exporter.concatenate_files).to_include %q[## This is chapter three]
+    end
+  end
+  
+  it "should parse liquid" do
+    inside_sample_book do
+      exporter.combine_all_files
+      exporter.liquify({"foo" => "foo output"})
+      output = IO.read('chapters/all.md')
+      expect(output).to_include "Liquid test foo output"
+    end
+  end
+  
+  it "should parse kramdown" do
+    inside_sample_book do
+      exporter.combine_all_files
+      exporter.kramdownify
+      output = IO.read('export/book.xhtml')
+      expect(output).to_include %q[<h2 id="this-is-chapter-one">This is chapter one</h2>]
+    end
+  end
+  
+  it "should create book.xhtml" do
+    inside_sample_book do
+      Author::Exporters::XHTML.export
+      'export/book.xhtml'.must_be_a_file
+    end
+  end
+  
+end

data/test/helper.rb

@@ -50,6 +50,23 @@ module AuthorHelpers
     end
   end
   
+  def sample_book_path
+    File.join(File.dirname(__FILE__), 'sample_book')
+  end
+  
+  def ensure_clean_book
+    rm_f File.join(sample_book_path, 'chapters', 'all.md')
+    rm_f File.join(sample_book_path, 'export', 'book.xhtml')
+  end
+  
+  def inside_sample_book
+    ensure_clean_book
+    cd(sample_book_path) do
+      yield
+    end
+    ensure_clean_book
+  end
+  
 end
 MiniTest::Test.send :include, AuthorHelpers
 

data/test/sample_book/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# gem 'author' # Uncomment this once the gem is published.
+gem 'kramdown'
+gem 'coderay'
+gem 'eeepub'

data/test/sample_book/chapters/one.md

@@ -0,0 +1,3 @@
+## This is chapter one
+
+Liquid test {{ foo }}

data/test/sample_book/chapters/three.md

@@ -0,0 +1 @@
+## This is chapter three

data/test/sample_book/chapters/two.md

@@ -0,0 +1 @@
+## This is chapter two

data/test/sample_book/config.yml

@@ -0,0 +1,4 @@
+---
+  title: test/sample_book
+  markdown: kramdown
+  highlighter: coderay

data/test/sample_book/outline.txt

@@ -0,0 +1,3 @@
+one.md
+two.md
+three.md

data/test/sample_book/templates/layout.xhtml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta charset="utf-8" />
+    <title>Sample Book</title>
+  </head>
+  <body>
+    <div id="contents">
+      <%= @body %>
+    </div>
+  </body>
+</html>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: author
 version: !ruby/object:Gem::Version
-  version: 1.0.1.alpha
+  version: 1.1.0.alpha
 platform: ruby
 authors:
 - Terry Schmidt
@@ -108,6 +108,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Quickly create ebooks using Markdown
 email:
 - terry.m.schmidt@gmail.com
@@ -125,19 +139,24 @@ files:
 - author.gemspec
 - bin/author
 - lib/author.rb
+- lib/author/commands/builder.rb
 - lib/author/commands/check.rb
 - lib/author/commands/cli.rb
 - lib/author/commands/generator.rb
 - lib/author/commands/version.rb
+- lib/author/exporters/xhtml.rb
 - lib/author/plugins/awesome_codeblock.rb
 - lib/author/templates/Gemfile
 - lib/author/templates/config.yml
+- lib/author/templates/layout.xhtml
 - lib/author/templates/sample.md
 - lib/author/version.rb
+- test/commands/builder_test.rb
 - test/commands/check_test.rb
 - test/commands/cli_test.rb
 - test/commands/generator_test.rb
 - test/commands/version_test.rb
+- test/exporters/xhtml_test.rb
 - test/helper.rb
 - test/liquids/highlight_lines.md
 - test/liquids/language_set.md
@@ -148,6 +167,13 @@ files:
 - test/liquids/title_as_filepath.md
 - test/liquids/title_as_string.md
 - test/plugins/awesome_codeblock_test.rb
+- test/sample_book/Gemfile
+- test/sample_book/chapters/one.md
+- test/sample_book/chapters/three.md
+- test/sample_book/chapters/two.md
+- test/sample_book/config.yml
+- test/sample_book/outline.txt
+- test/sample_book/templates/layout.xhtml
 - test/utils/assertions.rb
 homepage: http://github.com/tschmidt/author
 licenses:
@@ -174,10 +200,12 @@ signing_key:
 specification_version: 4
 summary: Quickly create ebooks using Markdown
 test_files:
+- test/commands/builder_test.rb
 - test/commands/check_test.rb
 - test/commands/cli_test.rb
 - test/commands/generator_test.rb
 - test/commands/version_test.rb
+- test/exporters/xhtml_test.rb
 - test/helper.rb
 - test/liquids/highlight_lines.md
 - test/liquids/language_set.md
@@ -188,4 +216,11 @@ test_files:
 - test/liquids/title_as_filepath.md
 - test/liquids/title_as_string.md
 - test/plugins/awesome_codeblock_test.rb
+- test/sample_book/Gemfile
+- test/sample_book/chapters/one.md
+- test/sample_book/chapters/three.md
+- test/sample_book/chapters/two.md
+- test/sample_book/config.yml
+- test/sample_book/outline.txt
+- test/sample_book/templates/layout.xhtml
 - test/utils/assertions.rb