author 1.1.4.alpha → 1.1.5.alpha

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTU2OWU2NjFkNmU1YWRlYmUyMDQ0NDFkYjUwOWY3NzBkZmYyZTdiYw==
+    ZDE0ODkwNmFhODlhNDE2Njk1Mjc2Njk5NmZmMGM4ZTZjMjlkYWY3OA==
   data.tar.gz: !binary |-
-    NjE3MTA2NjVjOGI5OTZmODI0YTA1NjUxZmYxNTYyZWU3Njc3MTMxMA==
+    NTM4MzIyYTY5ZDI0ODk4ZWY5MmI0N2I3NDgzMTljZGM5Mjc2YWY2Yw==
 SHA512:
   metadata.gz: !binary |-
-    OTY2Zjc1NTQ4YmRmYmJjZjk1M2ZhMmQxZGVmNzIxYjkwZjRiNzRiNzhiNmI1
-    NGUxNzdkYjI3NzdiYmRhYzk4ODIxMjU4MzUzNmU2MGJlMWI5Mjg3MzQwNGU5
-    MjUyZGE0N2E4ZjdjODM3MTc5YzVjNzA4ZWIwM2Y4YjViZGFiOTY=
+    YmQ2MWY1OGQzMjczMmE0ODY0ZmI1YjFhNTVlNGZkYmE4NzUxODliZjk2Y2I4
+    MmYyMjIzMWFiMGFlNTA3YWIxMzgzZWVlNTk1ZWRhYTM3M2UzYzMxMjI3ZDhm
+    MTRiZjliZmUwNTRhZjk1YTBhZTIzN2Q3Y2YyNzdmMjAzZDRjNTY=
   data.tar.gz: !binary |-
-    MTEzZGMwNGRkZDMxMzI5ZGI1ZDZhZTAyNjY5YmRjMTYzYWQ4ZWIwZWQwNzZl
-    NTkzMmE4MzE1Y2Q0YmI2YTM2MDNkOTY4MDNiNDgxMjMzNWYzMzg2YzE2NTg2
-    MTFmZDY0ZWUzYTgwZTFiOWZhZDkyMWYwNDFkOWNhMzFhNTc0YTg=
+    YjAwODA1YzUxNGRmNjVhMzEzOTdiZGRkMjQzMzViMmRkNzQyMGUyMTgxZDA1
+    MmM0OGNhOWYyN2Y3MTgwOWMwMWNmODc5NTQyY2RkOTk5ZmFjZTQyM2U1ZWFh
+    Y2FhMDI3YWQ5Nzc3N2Q5ZTEzYzBjODYwY2E3MTc5MmVhYmM0MDk=

data/author.gemspec

@@ -27,4 +27,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "liquid"
   spec.add_dependency "coderay"
   spec.add_dependency "kramdown"
+  spec.add_dependency "safe_yaml"
+  spec.add_dependency "eeepub"
+  spec.add_dependency "rubyzip"
+  spec.add_dependency "zip-zip"
 end

data/lib/author.rb

@@ -15,13 +15,24 @@ require 'liquid'
 require 'coderay'
 require 'thor'
 require 'kramdown'
+require 'safe_yaml'
 
 # internals
 require 'author/version'
+require 'author/utils'
+require 'author/configuration'
 require_all 'author/commands'
 require_all 'author/plugins'
 require_all 'author/exporters'
 
 module Author
   
+  def self.configuration(override = nil)
+    config = Configuration[Configuration::DEFAULTS]
+    override = Configuration[override || config.load_override_file || {}].stringify_keys
+    config = Utils.deep_merge_hashes(config, override).stringify_keys
+    
+    config
+  end
+  
 end

data/lib/author/commands/builder.rb

@@ -26,6 +26,14 @@ module Author
         Author::Exporters::Mobi.export
       end
       
+      desc "epub", "Build ePub format"
+      def epub
+        say "Building the XHTML site"
+        Author::Exporters::XHTML.export
+        say "Building the epub file"
+        Author::Exporters::Epub.export
+      end
+      
     end
   end
 end

data/lib/author/commands/generator.rb

@@ -5,14 +5,14 @@ module Author
     class Generator < Thor::Group
       include Thor::Actions
       
-      argument :name
+      argument :title
       
       def set_destination_root
-        self.destination_root = File.join(self.destination_root, name)
+        self.destination_root = File.join(self.destination_root, title)
       end
       
       def create_project_structure
-        say "Creating directories for your new book, #{name}"
+        say "Creating directories for your new book, #{title}"
         empty_directory "chapters"
         empty_directory "export"
         empty_directory "templates"
@@ -44,6 +44,11 @@ module Author
         File.join(File.dirname(__FILE__), '..', 'templates')
       end
       
+      def creator
+        creator = `finger $USER 2> /dev/null | grep Login | colrm 1 46 2> /dev/null`.chomp
+        !creator.empty? ? creator : "John Doe"
+      end
+      
     end
   end
 end

data/lib/author/configuration.rb

@@ -0,0 +1,33 @@
+require 'safe_yaml/load'
+
+module Author
+  class Configuration < Hash
+    
+    DEFAULTS = {
+      'eeepub' => {
+        'title'       => nil,
+        'creator'     => nil,
+        'publisher'   => nil,
+        'date'        => nil,
+        'identifier'  => nil,
+        'uid'         => nil,
+        'files'       => [], 
+        'nav'         => []
+      }
+    }
+    
+    def stringify_keys
+      reduce({}) { |hsh, (k,v)| hsh.merge(k.to_s => v) }
+    end
+    
+    def override_config_path
+      filepath = File.join(Dir.pwd, 'config.yml')
+      File.file?(filepath) ? filepath : nil
+    end
+    
+    def load_override_file
+      SafeYAML.load_file(override_config_path) if override_config_path
+    end
+    
+  end
+end

data/lib/author/exporters/epub.rb

@@ -0,0 +1,46 @@
+require 'eeepub'
+
+module Author
+  module Exporters
+    class Epub < Base
+      # 1. check that xhtml file exists
+      # 2. check that css file exists
+      # 3. create epub
+      
+      def self.export
+        exporter = new
+        exporter.xhtml_exists?
+        exporter.css_exists?
+        exporter.export
+      end
+      
+      def xhtml_exists?
+        raise "No book.xhtml file found" unless File.file?(output_path)
+      end
+      
+      def css_exists?
+        raise "No book.css file found" unless File.file?(theme_path)
+      end
+      
+      def export
+        c = config
+        f = [output_path, theme_path]
+        epub = EeePub.make do
+          title       c['title']
+          creator     c['creator']
+          publisher   c['publisher']
+          date        c['date']
+          identifier  c['identifier'], :scheme => 'URL'
+          uid         c['uid']
+          files       f
+        end
+        epub.save(File.join(export_path, 'book.epub'))
+      end
+      
+      def config
+        Author.configuration.fetch('eeepub')
+      end
+      
+    end
+  end
+end

data/lib/author/exporters/mobi.rb

@@ -3,7 +3,7 @@ module Author
     class Mobi < Base
       # 1. check that kindlegen is installed
       # 2. check that xhtml file exists
-      # 4. run kindlegen command
+      # 3. run kindlegen command
       
       def self.export
         exporter = new

data/lib/author/templates/Gemfile

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

data/lib/author/templates/config.yml

@@ -1,4 +1,8 @@
 ---
-  title: <%= name %>
-  markdown: kramdown
-  highlighter: coderay
+  eeepub:
+    title: <%= title %>
+    creator: <%= creator %>
+    publisher: <%= creator %>
+    date: <%= Time.now %>
+    identifier: Fill me in
+    uid: Fill me in

data/lib/author/templates/layout.xhtml

@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title><%= name %></title>
+    <title><%= title %></title>
     <link rel="stylesheet" href="book.css" type="text/css" media="all" title="Default ebook theme" charset="utf-8" />
   </head>
   <body>

data/lib/author/templates/sample.md

@@ -1,3 +1,3 @@
-# <%= name %>
+# <%= title %>
 
 Congratulations! You just created a new ebook project. Now all you need to do is write your book.

data/lib/author/utils.rb

@@ -0,0 +1,29 @@
+module Author
+  class Utils
+    
+    # Merges a master hash with another hash, recursively.
+    #
+    # master_hash - the "parent" hash whose values will be overridden
+    # other_hash  - the other hash whose values will be persisted after the merge
+    #
+    # This code was lovingly stolen from some random gem:
+    # http://gemjack.com/gems/tartan-0.1.1/classes/Hash.html
+    #
+    # Thanks to whoever made it.
+    def self.deep_merge_hashes(master_hash, other_hash)
+      target = master_hash.dup
+
+      other_hash.keys.each do |key|
+        if other_hash[key].is_a? Hash and target[key].is_a? Hash
+          target[key] = Utils.deep_merge_hashes(target[key], other_hash[key])
+          next
+        end
+
+        target[key] = other_hash[key]
+      end
+
+      target
+    end
+    
+  end
+end

data/lib/author/version.rb

@@ -1,3 +1,3 @@
 module Author
-  VERSION = "1.1.4.alpha"
+  VERSION = "1.1.5.alpha"
 end

data/test/commands/builder_test.rb

@@ -18,4 +18,8 @@ describe Author::Commands::Builder do
     expect(output).to_include "mobi"
   end
   
+  it "should respond to epub" do
+    expect(output).to_include "epub"
+  end
+  
 end

data/test/commands/generator_test.rb

@@ -5,7 +5,7 @@ describe Author::Commands::Generator do
   
   it "should require a name" do
     output = capture(:stderr) { Author::Commands::Generator.start }
-    expect(output).to_include "No value provided for required arguments 'name'"
+    expect(output).to_include "No value provided for required arguments 'title'"
   end
   
   it "should create project structure" do

data/test/exporters/epub_test.rb

@@ -0,0 +1,37 @@
+require_relative '../helper'
+require 'author/exporters/base'
+require 'author/exporters/epub'
+
+describe Author::Exporters::Epub do
+  
+  let(:exporter) { Author::Exporters::Epub }
+  
+  it "should respond to #export" do
+    expect(exporter).to_respond_to :export
+  end
+  
+  it "should raise error if no book.xhtml file exists" do
+    expect { exporter.export }.to_raise RuntimeError
+  end
+  
+  it "should raise error if no book.css file exists" do
+    expect { exporter.export }.to_raise RuntimeError
+  end
+  
+  context "an instance" do
+    let(:exporter) { Author::Exporters::Epub.new }
+    
+    it "should respond to #xhtml_exists?" do
+      expect(exporter).to_respond_to :xhtml_exists?
+    end
+    
+    it "should respond to #css_exists?" do
+      expect(exporter).to_respond_to :css_exists?
+    end
+    
+    it "should respond to #export" do
+      expect(exporter).to_respond_to :export
+    end
+  end
+  
+end

data/test/sample_book/config.yml

@@ -1,4 +1,5 @@
 ---
-  title: test/sample_book
-  markdown: kramdown
-  highlighter: coderay
+  eeepub:
+    title: <%= title %>
+    creator: <%= creator %>
+    publisher: <%= creator %>

data/test/units/configuration_test.rb

@@ -0,0 +1,40 @@
+require_relative '../helper'
+require 'author/configuration'
+
+describe Author::Configuration do
+  
+  let(:config) { Author::Configuration }
+  
+  let(:mixed_keys) do
+    config[{
+      'foo' => 'bar',
+      :source => './'
+    }]
+  end
+  
+  let(:string_keys) do
+    config[{
+      'foo' => 'bar',
+      'source' => './'
+    }]
+  end
+  
+  it "should stringify keys" do
+    expect(mixed_keys.stringify_keys).to_equal string_keys
+  end
+  
+  it "should not mess with keys that are already strings" do
+    expect(string_keys.stringify_keys).to_equal string_keys
+  end
+  
+  it "should know about override config path" do
+    expect(string_keys).to_respond_to :override_config_path
+  end
+  
+  it "should load config file" do
+    inside_sample_book do
+      expect(string_keys.load_override_file).to_include "eeepub"
+    end
+  end
+  
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: author
 version: !ruby/object:Gem::Version
-  version: 1.1.4.alpha
+  version: 1.1.5.alpha
 platform: ruby
 authors:
 - Terry Schmidt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-25 00:00:00.000000000 Z
+date: 2014-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,62 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: safe_yaml
+  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'
+- !ruby/object:Gem::Dependency
+  name: eeepub
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  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'
+- !ruby/object:Gem::Dependency
+  name: zip-zip
+  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
@@ -144,7 +200,9 @@ files:
 - lib/author/commands/cli.rb
 - lib/author/commands/generator.rb
 - lib/author/commands/version.rb
+- lib/author/configuration.rb
 - lib/author/exporters/base.rb
+- lib/author/exporters/epub.rb
 - lib/author/exporters/mobi.rb
 - lib/author/exporters/pdf.rb
 - lib/author/exporters/xhtml.rb
@@ -154,12 +212,14 @@ files:
 - lib/author/templates/config.yml
 - lib/author/templates/layout.xhtml
 - lib/author/templates/sample.md
+- lib/author/utils.rb
 - 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/epub_test.rb
 - test/exporters/mobi_test.rb
 - test/exporters/pdf_test.rb
 - test/exporters/xhtml_test.rb
@@ -181,6 +241,7 @@ files:
 - test/sample_book/export/book.xhtml
 - test/sample_book/outline.txt
 - test/sample_book/templates/layout.xhtml
+- test/units/configuration_test.rb
 - test/utils/assertions.rb
 homepage: http://github.com/tschmidt/author
 licenses:
@@ -212,6 +273,7 @@ test_files:
 - test/commands/cli_test.rb
 - test/commands/generator_test.rb
 - test/commands/version_test.rb
+- test/exporters/epub_test.rb
 - test/exporters/mobi_test.rb
 - test/exporters/pdf_test.rb
 - test/exporters/xhtml_test.rb
@@ -233,4 +295,5 @@ test_files:
 - test/sample_book/export/book.xhtml
 - test/sample_book/outline.txt
 - test/sample_book/templates/layout.xhtml
+- test/units/configuration_test.rb
 - test/utils/assertions.rb