bookshop 0.0.14 → 0.0.15

data/CHANGELOG

@@ -1,62 +1,66 @@
+0.0.15:
+	Features
+		Added ERB functionality to the book source
+
 0.0.14:
-		Moved repository to blueheadpublishing and modified gem source
-			to update all links
+	Moved repository to blueheadpublishing and modified gem source
+		to update all links
 			
-		Features
-				Added CHANGELOG into project template to provide users with a
-					best-practices in documenting version changes.
+	Features
+		Added CHANGELOG into project template to provide users with a
+			best-practices in documenting version changes
 
 0.0.13:
-		Bug fixes
-				Fixed build pdf command so it doesn't try to build epub
+	Bug fixes
+		Fixed build pdf command so it doesn't try to build epub
 
 0.0.12:
-		Doc fixes
-				Added new post-install message to alert users to install wkhtmltopdf
-				
-				Removed old POST_INSTALL file
+	Doc fixes
+		Added new post-install message to alert users to install wkhtmltopdf
+		
+		Removed old POST_INSTALL file
 
 0.0.11:
-		Complete rewrite
-				Switched from docbook toolchain to html/css/javascript toolchain
-				
-				Removed all XML/XSLT/FOP dependencies since no longer using docbook
-				
-				Added wkhtmltopdf as the html-to-pdf processor
-				
-				Added Boom(.css) microformat to replace structural markup previously
-				 		available via docbook
-				
-				Moved copyright to BlueHead Inc
+	Complete rewrite
+		Switched from docbook toolchain to html/css/javascript toolchain
+		
+		Removed all XML/XSLT/FOP dependencies since no longer using docbook
+		
+		Added wkhtmltopdf as the html-to-pdf processor
+		
+		Added Boom(.css) microformat to replace structural markup previously
+		 	available via docbook
+		
+		Moved copyright to BlueHead Inc
 
 0.0.4:
-		Core Changes
-				Added new mobi build
-				
-				Branding around World Uniting Press
-				
-				Added epubcheck for epub validations, v1.2
-				
-				Added kindlegen for generating mobi
+	Core Changes
+		Added new mobi build
+		
+		Branding around World Uniting Press
+		
+		Added epubcheck for epub validations, v1.2
+		
+		Added kindlegen for generating mobi
 
 
 0.0.3:
-    Core Changes
-				Added Java toolsets, including all necessary .jars for working with Docbook and
-						bookshop
-
-				Updated documentation to include information on how to setup java tools and Classpaths on various systems
-				
-				Added MIT-LICENSE
-				
-				Application Generator now has dynamically generated dates and content
-				
-				Added epub build command
-				
-				Added pdf build command
-				
-				Significant rework of Command Line Interface and 'help' dialogues
-				
-				
-		Bug Fixes
-				(none as this was a substantial rework)
+  Core Changes
+		Added Java toolsets, including all necessary .jars for working with 
+			Docbook and bookshop
+
+		Updated documentation to include information on how to setup java tools
+			and Classpaths on various systems
+		
+		Added MIT-LICENSE
+		
+		Application Generator now has dynamically generated dates and content
+		
+		Added epub build command
+		
+		Added pdf build command
+		
+		Significant rework of Command Line Interface and 'help' dialogues
+		
+Bug Fixes
+		(none as this was a substantial rework)

data/README.rdoc

@@ -3,6 +3,7 @@
 bookShop is a publishing framework for html-to-(e)book toolchain happiness and sustainable productivity. The framework is optimized to help developers quickly ramp-up, allowing them to more rapidly jump in and develop their html-to-(e)book (print-pdf, epub, mobi, etc.) flows, by favoring convention over configuration, setting them up with best practices, standards and tools from the start.
 
 bookshop hopes to simplify the process by:
+* using common developer tools like HTML, CSS, etc. to make the creation of your book comfortable and familiar, greatly reducing the learning curve for your developers, authors, agents, and other team members
 * providing a Ruby Gem to make building a book from HTML as easy as 'sudo gem install bookshop'
 * pulling all the html-to-(e)book tools together into one place (wkhtmltopdf, kindlegen, epubcheck)
 * sticking with open-source tools
@@ -51,38 +52,38 @@ bookshop hopes to simplify the process by:
   PATH="$PATH:/var/lib/gems/1.8/bin"
   export PATH
 
-=== Building Your First Book
+=== Editing Your New Book
 
-To build a pdf format of your book from the html source:
+All of the source documents/code/assets (yay... HTML/CSS) for your book are stored in the +book/+ folder. The master file, from which everything is built is +book/book.html.erb+. Since this is an ERB file, you can do all kinds of things like:
 
-    $ bookshop build pdf
+* embed ruby functions and calls
 
-== Getting Help
+    <p>Today is <%= Time.now.strftime('%A') %>.</p>
 
-* bookshop comes with a built in help feature. Simply run 'bookshop --help' from the command line to get list of possible commands to issue including possible options. You can also run 'bookshop COMMAND --help' (where COMMAND is the command you want) to get a list of possible options for that particular command
+  or
 
-== Thanks
+    <ul>
+      <% for @item in @shopping_list %>
+        <li><%= @item %></li>
+      <% end %>
+    </ul>
+    
+* include other files or template structures
+* explore other creative ways to structure and enhance your book (we'd love to see how you are doing it)
 
-We would like to thank:
+When the book is built, your master +book/book.html.erb+ file will be compiled into the final HTML which will be used to build the book types.
 
-* The Ruby/Rubygems Team www.ruby-lang.org/
-* The Thor Team - https://github.com/wycats/thor
-* Hakon Wium Lie and Bert Bos for developing the book microformat http://www.alistapart.com/articles/boom
-* The WKHTMLTOPDF team http://code.google.com/p/wkhtmltopdf/
-* The EPUBCHECK team http://code.google.com/p/epubcheck/
+When you are finished editing your source you can build whichever type of your book that you would like. Currently the only supported builds are pdf and html (and soon epub and mobi).
 
-== Description of Gem Contents
+=== Building Your First Book
 
-The basic bookshop gem architecture:
+To build a pdf format of your book from the html source:
 
-  |-- bin
-  |-- lib
+    $ bookshop build pdf
 
-bin
-  command file copied to /usr/bin upon installation (which is then called from the command line)
+== Getting Help
 
-lib
-  bookshop gem library files
+* bookshop comes with a built in help feature. Simply run 'bookshop --help' from the command line to get list of possible commands to issue including possible options. You can also run 'bookshop COMMAND --help' (where COMMAND is the command you want) to get a list of possible options for that particular command
 
 == Description of bookshop app contents
 
@@ -154,4 +155,14 @@ THE SOFTWARE.
 
   Sample style sheet for boom!, the book microformat
   written  by Hakon Wium Lie and Bert Bos, November 2005
-  You may reuse this style sheet for any purpose without any fees
+  You may reuse this style sheet for any purpose without any fees
+
+== Thanks
+
+We would like to thank:
+
+* The Ruby/Rubygems Team www.ruby-lang.org/
+* The Thor Team - https://github.com/wycats/thor
+* Hakon Wium Lie and Bert Bos for developing the book microformat http://www.alistapart.com/articles/boom
+* The WKHTMLTOPDF team http://code.google.com/p/wkhtmltopdf/
+* The EPUBCHECK team http://code.google.com/p/epubcheck/

data/lib/bookshop/commands/build.rb

@@ -1,4 +1,6 @@
 require 'thor/group'
+require 'erb'
+require 'fileutils'
 
 module Bookshop
   module Commands
@@ -14,9 +16,11 @@ module Bookshop
 
       build = ARGV.shift
       build = aliases[build] || build
+      
+      erb = ERB.new(File.read('book/book.html.erb'))
 
       # Define arguments and options
-      argument :type,                   :type => :string
+      argument :type
 
       # Define source root of application
       def self.source_root
@@ -24,13 +28,41 @@ module Bookshop
       end
       
       case build
+      
+      # 'build html' creates a html version of the book
+      when 'html'
+        # Clean up any old builds
+        puts "Deleting any old builds"
+        FileUtils.rm_r Dir.glob('builds/html/*')
+        
+        puts "Generating new html from erb"
+        File.open('builds/html/book.html', 'a') do |f|
+          f << erb.result
+        end
+        
+        FileUtils.cp_r('book/css/', 'builds/html/', :verbose => true)
+        FileUtils.cp_r('book/images/', 'builds/html/', :verbose => true)
+        
+      # 'build pdf' creates a pdf version of the book
       when 'pdf'
+        # Clean up any old builds
         puts "Deleting any old builds"
-        File.delete("builds/pdf/book.pdf") if File::exists?( "builds/pdf/book.pdf" )
-        puts "File Deleted"
-        puts "Building new pdf at builds/pdf/book.pdf"
-        cmd = %x[wkhtmltopdf book/book.html builds/pdf/book.pdf]
-        # cmd = %x[wkhtmltopdf #{SRC_FILE} #{OUT_FILE}]
+        FileUtils.rm_r Dir.glob('builds/pdf/*')
+        FileUtils.rm_r Dir.glob('builds/html/*')
+        
+        # Generate the html from ERB
+        puts "Generating new html from erb"
+        File.open('builds/html/book.html', 'a') do |f|
+          f << erb.result
+        end
+
+        # Copy over html assets
+        FileUtils.cp_r('book/css/', 'builds/html/', :verbose => true)
+        FileUtils.cp_r('book/images/', 'builds/html/', :verbose => true)
+
+        # Build the pdf
+        puts "Building new pdf at builds/pdf/book.pdf from new html build"
+        cmd = %x[wkhtmltopdf builds/html/book.html builds/pdf/book.pdf]
         
       else
         puts "Error: Command not recognized" unless %w(-h --help).include?(build)
@@ -39,9 +71,7 @@ module Bookshop
 
       The most common build commands are:
        pdf          Builds a new pdf at /builds/pdf/book.pdf
-       epub         Builds a new epub at /builds/epub/book.epub
        html         Builds a new html at /builds/html/book.html
-       all          Builds all possible builds in their respective locations
 
       All commands can be run with -h for more information.
         EOT

data/lib/bookshop/commands.rb

@@ -8,9 +8,12 @@ command = ARGV.shift
 command = aliases[command] || command
 
 case command
+
+# command for calling a build of a book (e.g. pdf, epub)
 when 'build'
   require 'bookshop/commands/build'
 
+# command for generating a new book project
 when 'new'
   puts "Can't create a new Bookshop application within the directory of another, please change to a non-Bookshop directory first.\n"
   puts "Type 'bookshop' for help."

data/lib/bookshop/generators/bookshop/app/templates/README.rdoc

@@ -3,6 +3,7 @@
 bookShop is a publishing framework for html-to-(e)book toolchain happiness and sustainable productivity. The framework is optimized to help developers quickly ramp-up, allowing them to more rapidly jump in and develop their html-to-(e)book (print-pdf, epub, mobi, etc.) flows, by favoring convention over configuration, setting them up with best practices, standards and tools from the start.
 
 bookshop hopes to simplify the process by:
+* using common developer tools like HTML, CSS, etc. to make the creation of your book comfortable and familiar, greatly reducing the learning curve for your developers, authors, agents, and other team members
 * providing a Ruby Gem to make building a book from HTML as easy as 'sudo gem install bookshop'
 * pulling all the html-to-(e)book tools together into one place (wkhtmltopdf, kindlegen, epubcheck)
 * sticking with open-source tools
@@ -51,38 +52,38 @@ bookshop hopes to simplify the process by:
   PATH="$PATH:/var/lib/gems/1.8/bin"
   export PATH
 
-=== Building Your First Book
+=== Editing Your New Book
 
-To build a pdf format of your book from the html source:
+All of the source documents/code/assets (yay... HTML/CSS) for your book are stored in the +book/+ folder. The master file, from which everything is built is +book/book.html.erb+. Since this is an ERB file, you can do all kinds of things like:
 
-    $ bookshop build pdf
+* embed ruby functions and calls
 
-== Getting Help
+    <p>Today is <%= Time.now.strftime('%A') %>.</p>
 
-* bookshop comes with a built in help feature. Simply run 'bookshop --help' from the command line to get list of possible commands to issue including possible options. You can also run 'bookshop COMMAND --help' (where COMMAND is the command you want) to get a list of possible options for that particular command
+  or
 
-== Thanks
+    <ul>
+      <% for @item in @shopping_list %>
+        <li><%= @item %></li>
+      <% end %>
+    </ul>
+    
+* include other files or template structures
+* explore other creative ways to structure and enhance your book (we'd love to see how you are doing it)
 
-We would like to thank:
+When the book is built, your master +book/book.html.erb+ file will be compiled into the final HTML which will be used to build the book types.
 
-* The Ruby/Rubygems Team www.ruby-lang.org/
-* The Thor Team - https://github.com/wycats/thor
-* Hakon Wium Lie and Bert Bos for developing the book microformat http://www.alistapart.com/articles/boom
-* The WKHTMLTOPDF team http://code.google.com/p/wkhtmltopdf/
-* The EPUBCHECK team http://code.google.com/p/epubcheck/
+When you are finished editing your source you can build whichever type of your book that you would like. Currently the only supported builds are pdf and html (and soon epub and mobi).
 
-== Description of Gem Contents
+=== Building Your First Book
 
-The basic bookshop gem architecture:
+To build a pdf format of your book from the html source:
 
-  |-- bin
-  |-- lib
+    $ bookshop build pdf
 
-bin
-  command file copied to /usr/bin upon installation (which is then called from the command line)
+== Getting Help
 
-lib
-  bookshop gem library files
+* bookshop comes with a built in help feature. Simply run 'bookshop --help' from the command line to get list of possible commands to issue including possible options. You can also run 'bookshop COMMAND --help' (where COMMAND is the command you want) to get a list of possible options for that particular command
 
 == Description of bookshop app contents
 
@@ -154,4 +155,14 @@ THE SOFTWARE.
 
   Sample style sheet for boom!, the book microformat
   written  by Hakon Wium Lie and Bert Bos, November 2005
-  You may reuse this style sheet for any purpose without any fees
+  You may reuse this style sheet for any purpose without any fees
+
+== Thanks
+
+We would like to thank:
+
+* The Ruby/Rubygems Team www.ruby-lang.org/
+* The Thor Team - https://github.com/wycats/thor
+* Hakon Wium Lie and Bert Bos for developing the book microformat http://www.alistapart.com/articles/boom
+* The WKHTMLTOPDF team http://code.google.com/p/wkhtmltopdf/
+* The EPUBCHECK team http://code.google.com/p/epubcheck/

data/lib/bookshop/generators/bookshop/app/templates/book/{book.html → book.html.erb}

@@ -4,7 +4,7 @@
 <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
 <title>Cascading Style Sheets - Designing for the Web</title>
 <meta name="author" content="H�kon Wium Lie">
-<link rel="stylesheet" type="text/css" href="css/boom.css">
+<link rel="stylesheet" type="text/css" href="css/stylesheet.css">
 </head>
 <body>
 

data/lib/bookshop/generators/bookshop/generator/generator_generator.rb

@@ -1,5 +1,6 @@
 module Bookshop
   module Generators
+    # 
     class GeneratorGenerator < NamedBase
       check_class_collision :suffix => "Generator"
 

data/lib/bookshop/version.rb

@@ -1,3 +1,3 @@
 module Bookshop
-  VERSION = "0.0.14"
+  VERSION = "0.0.15"
 end

metadata

@@ -2,7 +2,7 @@
 name: bookshop
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors: 
 - D.a. Thompson
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-28 00:00:00 Z
+date: 2011-12-02 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: thor
@@ -86,13 +86,12 @@ files:
 - lib/bookshop/generators/bookshop/app/app_generator.rb
 - lib/bookshop/generators/bookshop/app/templates/CHANGELOG
 - lib/bookshop/generators/bookshop/app/templates/README.rdoc
-- lib/bookshop/generators/bookshop/app/templates/book/META_INF/container.xml
-- lib/bookshop/generators/bookshop/app/templates/book/book.html
-- lib/bookshop/generators/bookshop/app/templates/book/css/boom.css
+- lib/bookshop/generators/bookshop/app/templates/book/book.html.erb
+- lib/bookshop/generators/bookshop/app/templates/book/css/stylesheet.css
 - lib/bookshop/generators/bookshop/app/templates/book/images/canvas.jpg
 - lib/bookshop/generators/bookshop/app/templates/book/images/html-18.png
-- lib/bookshop/generators/bookshop/app/templates/book/mimetype
 - lib/bookshop/generators/bookshop/app/templates/builds/epub/.empty_directory
+- lib/bookshop/generators/bookshop/app/templates/builds/html/.empty_directory
 - lib/bookshop/generators/bookshop/app/templates/builds/mobi/.empty_directory
 - lib/bookshop/generators/bookshop/app/templates/builds/pdf/.empty_directory
 - lib/bookshop/generators/bookshop/app/templates/config/application.rb

data/lib/bookshop/generators/bookshop/app/templates/book/META_INF/container.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
-   <rootfiles>
-      <rootfile full-path="OEBPS/content.opf" media-type="application/oebps-package+xml"/>
-   </rootfiles>
-</container>

data/lib/bookshop/generators/bookshop/app/templates/book/mimetype

@@ -1 +0,0 @@
-application/epub+zip