author 1.1.6.alpha → 1.2.0.alpha

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjhjZGIwNmM5YWNhMzY0YmYwMjk3NjQ5MmM1NzZmZWQzNjVmNmIxZA==
+    ZTE5N2M2ZGMxNzRmMzE1ZDA5NDk5ODM5M2JhZmFhMmE4N2MwODk1Zg==
   data.tar.gz: !binary |-
-    NjgzYmIxNTYwYWFjODFjOGQxZWI4OThiOGNhYTE5MGE2YmZlMGIxNg==
+    YzNmYzQwZjhiZmJjNDg4ZGMzNjI5NGZiMWIyNjdmMTNiYTI2NmE4Ng==
 SHA512:
   metadata.gz: !binary |-
-    ZTdhNGYzYjcyMDlhM2QwNDBlOGFmNTFhZWM4YjRjNzViN2U1MTMwNzRkNjZi
-    YjIxN2QwOGRlNTNmYjhmNzk4ZmQ2MTM0MDExMWEwMmViNGYxMjQ5ODVlMGI0
-    NTQ2MzE3ZWIzMTc1NzEzZmVkMTEzNjc0MWRmNzQwMjIyZTg4YTM=
+    YWRhNTZiNmUxZTZiMmE2NGQ0MzIzMmM5NTdhOWFkYzVlMzFmYWQyMzI5ZTFm
+    YzljMGQyNTMyMjQzMmI1ZDgyNTYzMGQzODc3MDQ3ZDA1YThiNTM3YzcyMWE0
+    NzMwZGY5OWExOWFhYjIyZjczZWQwOGFiNDM2NmU2YmE2ODZiMzA=
   data.tar.gz: !binary |-
-    MWY3Y2YxMGU0YmM0MDgwMjc2YjQ1YTZmNzE0ZmJkN2FlMTc0OTQ3ZjY0MzFh
-    M2Q2MTMwODIyM2I3NDBlZDlkNjAwYTUwZGMxM2ZiNTViNTNhMDlkMWIzYzg5
-    NmEzNDczMGMxNGNkZWM3MWU2YzZmMWZhY2RmODA2NzdlNjAxNmQ=
+    YzdhMjhjNDU3ZThhODhlZTEzZDdmM2EyNTNhOTM2N2EwNGUwZDFlMGY1MzRl
+    MmExY2I5YmYzNzI4MDZiOTFiYWUwYTAxNTdlY2QyNWQxMGY2Njg4ZmQwMmQ4
+    OTU2NmFhNjc3ZGE4ZGRmZDkyMTE1ZmE4N2U5NzJiZDhmNjYxZjA=

data/README.md

@@ -1,8 +1,8 @@
-# Author [![GitHub version](https://badge.fury.io/gh/tschmidt%2Fauthor.svg)](http://badge.fury.io/gh/tschmidt%2Fauthor)
+# Author [![Gem Version](https://badge.fury.io/rb/author.svg)](http://badge.fury.io/rb/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.
+**ATTN:** Everything should be working, however, I am keeping the gem in alpha for a little while longer. The first official release should be coming soon.
 
 *[imho]: In my humble opinion
 
@@ -55,6 +55,8 @@ That's it!
 
 ## Extras
 
+### Table of Contents
+
 One of the nice things about using Kramdown is that it provides a way to generate a table
 of contents [TOC]. If you would like to add a TOC to your book, simply add a file to the
 `chapters/` folder - might I suggest `toc.md` - and include the following:
@@ -70,11 +72,26 @@ of contents [TOC]. If you would like to add a TOC to your book, simply add a fil
 Then, in the `outline.txt` file, just make sure the file with that information is
 the first one listed.
 
+### Codeblocks
+
 For anyone wanting to write books that involve a lot of code, I have built a plugin
 called `awesome_codeblock`. You can specify quite a few options that will make your
 codeblocks, well, more awesome. Check out `lib/author/plugins/awesome_codeblock.rb`
 for all the details.
 
+### Sidebars
+
+If you have a need for a sidebar, there is a Liquid plugin I created called `sidebar`. It takes an optional argument called `type` which can be anything you want and will be a class added to the resulting code.
+
+There are 3 types which come with predefined styles though. They are `info`, `warning`, and `tip`. `info` is the default and will be used if the `type` is not set. Here is an example:
+
+```
+{% sidebar type:tip %}
+#### I am a sidebar!
+
+You can put any code supported by Kramdown in this block. Yippee!
+{% endsidebar %}
+
 ## Dependencies
 
 There are a couple of executables that Author requires to do its job.

data/TODO.md

@@ -1,4 +1,8 @@
 # TODO
 
-- Add the ability to include a cover image.
-- Add the ability to include images in the finished book formats.
+- [ ] Add the ability to include a cover image.
+- [ ] Add the ability to include images in the finished book formats.
+- [ ] Add additional themes
+- [ ] Find fonts to include with book
+- [ ] Update book.css to fix spacing between back-to-back codeblocks
+- [ ] Add a plugin that will allow for Leanpub style aside boxes

data/author.gemspec

@@ -23,12 +23,12 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "minitest-spec-expect"
   
-  spec.add_dependency "thor"
-  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"
+  spec.add_dependency "thor",     "~> 0.19"
+  spec.add_dependency "liquid",   "~> 2.6"
+  spec.add_dependency "coderay",  "~> 1.1"
+  spec.add_dependency "kramdown", "~> 1.3"
+  spec.add_dependency "safe_yaml","~> 1.0"
+  spec.add_dependency "eeepub",   "~> 0.8"
+  spec.add_dependency "rubyzip",  "~> 1.1"
+  spec.add_dependency "zip-zip",  "~> 0.3"
 end

data/lib/author/exporters/xhtml.rb

@@ -1,6 +1,7 @@
 require 'liquid'
 require 'kramdown'
 require 'author/plugins/awesome_codeblock'
+require 'author/plugins/sidebar'
 
 module Author
   module Exporters

data/lib/author/plugins/awesome_codeblock.rb

@@ -1,6 +1,6 @@
 # = AwesomeCodeblock
 #
-# This is a CodeRay plugin that allows you to output more awesome codeblocks.
+# This is a Liquid plugin that allows you to output more awesome codeblocks.
 # It was inspired by the code_ray_block plugin by git@codebykat.
 #
 # == Usage

data/lib/author/plugins/sidebar.rb

@@ -0,0 +1,71 @@
+# = Sidebar
+#
+# This is a Liquid plugin that allows you to include sidebars into your text.
+#
+# == Options
+#
+# There are several sidebar types you can use:
+#
+# - :info # this is the default
+# - :warning
+# - :tip
+#
+# == Usage
+#
+# All of the types use the same format. All you need to do is supply the `type` you want the
+# sidebar to be. This will control the styling of the sidbar box.
+#
+#  {% sidebar %}
+#  This is the text that will appear in the sidebar
+#  {% endsidebar %}
+#
+# Here is an example where you specify the type.
+#
+#  {% sidebar type:warning %}
+#  This is now a warning sidebar
+#  {% endsidebar %}
+#
+# Author: Terry Schmidt
+# Date: 27 May 2014
+# License: [WTFPL](http://www.wtfpl.net/about/)
+#
+require 'liquid'
+require 'kramdown'
+
+module Author
+  module Plugins
+    class Sidebar < Liquid::Block
+      
+      attr_accessor :markup
+      
+      def initialize(tag_name, markup, tokens)
+        @markup = markup
+        super
+      end
+      
+      def render(context)
+        sidebar_content = super
+        output = ''
+        output += header
+        output += Kramdown::Document.new(sidebar_content, auto_ids: false).to_html
+        output += footer
+        output
+      end
+      
+      def header
+        %Q[<table class="sidebar sidebar-#{sidebar_type}"><tbody><tr><td class="sidebar-icon"></td><td>]
+      end
+      
+      def footer
+        %q[</td></tr></tbody></table>]
+      end
+      
+      def sidebar_type
+        markup =~ /\s*type:"?([^"\s]+)"?/i ?  $1 : 'info'
+      end
+      
+    end
+  end
+end
+
+Liquid::Template.register_tag('sidebar', Author::Plugins::Sidebar)

data/lib/author/templates/book.css

@@ -529,8 +529,9 @@ th {
 .CodeRay .head .head { color: #f4f; }
 
 figure.code {
+  background: #fff;
   border: 1px solid #d5d5d5;
-  margin: 0 20px;
+  margin: 30px 20px;
   border-radius: 2px;
 }
 
@@ -580,6 +581,40 @@ figure.code figcaption {
 }
 
 
+/*****************************************
+  Sidebar Styles
+*****************************************/
+
+.sidebar {
+  background: #e5ffe5;
+  border: 1px solid #44d544;
+  border-left: 8px solid #44d544;
+  margin: 30px 0;
+  width: 100%;
+}
+
+.sidebar td {
+  padding: 20px;
+}
+
+.sidebar .sidebar-icon {
+  padding: 0;
+  text-align: center;
+  width: 5px;
+}
+
+.sidebar-warning {
+  background: #ffe5e5;
+  border-color: #d54444;
+}
+
+.sidebar-tip {
+  background: #d5efff;
+  border-color: #0099d5;
+}
+
+
+
 /*****************************************
   Book Styles
 *****************************************/

data/lib/author/version.rb

@@ -1,3 +1,3 @@
 module Author
-  VERSION = "1.1.6.alpha"
+  VERSION = "1.2.0.alpha"
 end

data/test/liquids/sidebar-info.txt

@@ -0,0 +1,3 @@
+{% sidebar type:info %}
+I am an info sidebar
+{% endsidebar %}

data/test/liquids/sidebar-no-type.txt

@@ -0,0 +1,3 @@
+{% sidebar %}
+I am an info sidebar
+{% endsidebar %}

data/test/liquids/sidebar-tip.txt

@@ -0,0 +1,3 @@
+{% sidebar type:tip %}
+I am a tip sidebar
+{% endsidebar %}

data/test/liquids/sidebar-warning.txt

@@ -0,0 +1,3 @@
+{% sidebar type:warning %}
+I am a warning sidebar
+{% endsidebar %}

data/test/plugins/sidebar_test.rb

@@ -0,0 +1,30 @@
+require_relative '../helper'
+require 'liquid'
+require 'author/plugins/sidebar'
+
+describe Author::Plugins::Sidebar do
+  
+  let(:liquid) { Liquid::Template }
+  
+  context "no type specified" do
+    it "should process the block into an info sidebar" do
+      using_liquid_templates do
+        output = liquid.parse(IO.read('sidebar-no-type.txt')).render
+        expect(output).to_include %q[<table class="sidebar sidebar-info">]
+      end
+    end
+  end
+  
+  context "type is specified" do
+    %w[info warning tip].each do |type|
+      it "should process the block into the correct sidebar" do
+        using_liquid_templates do
+          output = liquid.parse(IO.read("sidebar-#{type}.txt")).render
+          expect(output).to_include %Q[<table class="sidebar sidebar-#{type}">]
+          expect(output).to_match %r[I am an? #{type} sidebar]
+        end
+      end
+    end
+  end
+  
+end

data/test/sample_book/export/book.xhtml

@@ -8,7 +8,7 @@
     <div id="contents">
       <h2 id="this-is-chapter-one">This is chapter one</h2>
 
-<p>Liquid test {{ foo }}</p>
+<p>Liquid test </p>
 
 <h2 id="this-is-chapter-two">This is chapter two</h2>
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: author
 version: !ruby/object:Gem::Version
-  version: 1.1.6.alpha
+  version: 1.2.0.alpha
 platform: ruby
 authors:
 - Terry Schmidt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-26 00:00:00.000000000 Z
+date: 2014-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,114 +70,114 @@ dependencies:
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.19'
 - !ruby/object:Gem::Dependency
   name: liquid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: coderay
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: safe_yaml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: eeepub
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: zip-zip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
 description: Quickly create ebooks using Markdown
 email:
 - terry.m.schmidt@gmail.com
@@ -208,6 +208,7 @@ files:
 - lib/author/exporters/pdf.rb
 - lib/author/exporters/xhtml.rb
 - lib/author/plugins/awesome_codeblock.rb
+- lib/author/plugins/sidebar.rb
 - lib/author/templates/Gemfile
 - lib/author/templates/book.css
 - lib/author/templates/config.yml
@@ -229,11 +230,16 @@ files:
 - test/liquids/language_set.md
 - test/liquids/no_options.md
 - test/liquids/show_line_numbers.md
+- test/liquids/sidebar-info.txt
+- test/liquids/sidebar-no-type.txt
+- test/liquids/sidebar-tip.txt
+- test/liquids/sidebar-warning.txt
 - test/liquids/starting_line_number.md
 - test/liquids/title_as_filename.md
 - test/liquids/title_as_filepath.md
 - test/liquids/title_as_string.md
 - test/plugins/awesome_codeblock_test.rb
+- test/plugins/sidebar_test.rb
 - test/sample_book/Gemfile
 - test/sample_book/chapters/one.md
 - test/sample_book/chapters/three.md
@@ -283,11 +289,16 @@ test_files:
 - test/liquids/language_set.md
 - test/liquids/no_options.md
 - test/liquids/show_line_numbers.md
+- test/liquids/sidebar-info.txt
+- test/liquids/sidebar-no-type.txt
+- test/liquids/sidebar-tip.txt
+- test/liquids/sidebar-warning.txt
 - test/liquids/starting_line_number.md
 - test/liquids/title_as_filename.md
 - test/liquids/title_as_filepath.md
 - test/liquids/title_as_string.md
 - test/plugins/awesome_codeblock_test.rb
+- test/plugins/sidebar_test.rb
 - test/sample_book/Gemfile
 - test/sample_book/chapters/one.md
 - test/sample_book/chapters/three.md