bookshop 0.0.21 → 0.0.22

data/README.rdoc

@@ -2,13 +2,9 @@
 
     "a book publishing framework for today's publishing world"
 	
-bookshop is a book publishing framework for publishers, editors, and coders in today's publishing industry. bookshop provides a framework for developing books using well-known/standard web languages like HTML/CSS, which are then converted into pdf and other (e)book formats. The framework is optimized to help developers quickly ramp-up, allowing them to jump in and develop their html-to-pdf/(e)book flows, by favoring convention over configuration, setting them up with best-practices, standards and tools from the start.
+bookshop is a book publishing framework for building pdf/(e)books based on HTML, CSS, and JavaScript. The framework is optimized to help publishers, editors, and authors quickly ramp-up, allowing them to jump in and develop their html-to-pdf/(e)book 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:
-* separating the book into layers
-  * *Content*: the book's source - <i>writings, images, videos, copy</i>
-  * *Structure*: using div/css microformat to describe the book's structure - <i>chapter, section, etc.</i>
-  * *Style*: stylesheets to create the book's layout - <i>fonts, margins, color, etc.</i>
 * using common tools like HTML/CSS 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 in HTML as easy as 'gem install bookshop'
 * pulling all the html-to-pdf/(e)book tools together into one place (wkhtmltopdf, kindlegen, epubcheck)
@@ -262,9 +258,10 @@ The default directory structure of a generated bookshop project:
 
     |-- book/                 # Source files for your book
         |--book.html.erb      # The master file
-        |--css/
-            |--stylesheet.css
-        |--images/
+        |--assets/
+            |--css/
+                |--stylesheet.css
+            |--images/
 
     |-- builds/               # All the builds are created here
         |--epub/
@@ -302,45 +299,9 @@ config
 6. Let us know about your code and we'll review/merge it into the master.
 7. And pat yourself on the back for contributing to an open source project!!
 	
-== Copyright (LICENSE)
-
-BookShop is available under *either* the terms of the modified BSD license *or* the
-MIT License (2008). As a recipient of BookShop, you may choose which
-license to receive this code under (except as noted in per-module LICENSE
-files). Some modules may not be the copyright of BlueHead Publishing. These
-modules contain explicit declarations of copyright in both the LICENSE files in
-the directories in which they reside and in the code itself. No external
-contributions are allowed under licenses which are fundamentally incompatible
-with the MIT or BSD licenses that BookShop is distributed under.
-
-The text of the MIT and BSD licenses is reproduced below.
-
-=== The "New" BSD License
-
-Copyright (c) 2010-2011, BlueHead Publishing
-All rights reserved.
+== Copyright (MIT-LICENSE)
 
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-* Neither the name of Bookshop/BlueHead/BlueHead Publishing nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-=== The MIT License
-
-Copyright (c) 2010, 2011 BlueHead Publishing, et. al.,
+Copyright (C) 2010, 2011 by BlueHead Publishing, Inc (http://blueheadpublishing.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -360,11 +321,13 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 
-== The Boom Microformat License (as listed in the boom.css)
+== The Boom Microformat License - boom.css (from which the css microformat was based)
+
+http://www.alistapart.com/articles/boom
 
-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
+    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
 
 == Thanks
 
@@ -373,4 +336,7 @@ 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 WKHTMLTOPDF team http://code.google.com/p/wkhtmltopdf/
+
+A List of Our Contributors:
+https://github.com/blueheadpublishing/bookshop/blob/master/CONTRIBUTORS.md

data/lib/bookshop/commands/build.rb

@@ -5,8 +5,6 @@ require 'yaml'
 require 'PDFKit'
 
 require 'bookshop/commands/yaml/book'
-
-# require 'bookshop/commands/yaml/toc'
 # require 'bookshop/commands/epub/epub_build'
 
 module Bookshop
@@ -76,8 +74,7 @@ module Bookshop
           f << erb
         end
         
-        FileUtils.cp_r('book/css/', 'builds/html/', :verbose => true)
-        FileUtils.cp_r('book/images/', 'builds/html/', :verbose => true)
+        FileUtils.cp_r('book/assets/', 'builds/html/', :verbose => true)
         
       # 'build pdf' generates a pdf version of the book from the builds/html/book.html
       #    which is generated from the book/book.html.erb source file
@@ -97,8 +94,7 @@ module Bookshop
         end
 
         # Copy over html assets
-        FileUtils.cp_r('book/css/', 'builds/html/', :verbose => true)
-        FileUtils.cp_r('book/images/', 'builds/html/', :verbose => true)
+        FileUtils.cp_r('book/assets/', 'builds/html/', :verbose => true)
 
 
         # PDFKit.new takes the HTML and any options for wkhtmltopdf
@@ -111,10 +107,9 @@ module Bookshop
         # Save the PDF to a file
         file = kit.to_file('builds/pdf/book.pdf')
         
-      #when 'epub'
-       # require 'bookshop/commands/epub/epub_build'
-        #EpubBuild.new
-        
+      # when 'epub'
+      #   Bookshop::Commands::EpubBuild.new
+
       else
         puts "Error: Command not recognized" unless %w(-h --help).include?(build)
         puts <<-EOT

data/lib/bookshop/commands/epub/epub_build.rb

@@ -1,67 +1,91 @@
 require 'thor/group'
 require 'erb'
+require 'fileutils'
 require 'yaml'
-
+require 'nokogiri'
 
 require 'bookshop/commands/yaml/book'
 
 module Bookshop
   module Commands
 
-    # Builds the EPUB version of the book
+    # Define build commands for bookshop command line
     class EpubBuild < Thor::Group
       include Thor::Actions
       
+      app_path = APP_PATH
+      BOOK_SOURCE = "book.html.erb"
+
       # Define source root of application
       def self.source_root
         File.dirname(__FILE__)
       end
-        
-
       
-      def clean_up
+      # Load YAML files
+      def self.load_yaml_files
+        # Load the book.yml into the Book object
+        @book = Book.new(YAML.load_file('config/book.yml'))
+        # @toc = Toc.new(YAML.load_file('config/toc.yml'))
+      end
+
+      # Renders <%= import(source.html.erb) %> files with ERB
+      # 
+      # When a new import() is encountered within source files it is
+      #    processed with this method and the result is added to 'erb'
+      def self.import(file)
+        load_yaml_files
+        # Parse the source erb file
+        ERB.new(File.read('book/'+file)).result(binding).gsub(/\n$/,'')
+      end
+
+      # Create the project from templates
+      def create_base_project
+        # Clean up any old builds
         puts "Deleting any old builds"
         FileUtils.rm_r Dir.glob('builds/epub/*')
-        FileUtils.rm_r Dir.glob('builds/html/*')
+        
+        puts "Creating epub base files"
+        directory "templates", "#{app_path}/builds/epub/"
       end
       
-      def compile_erb_source
-        @output = :epub
-        
-        erb = import(BOOK_SOURCE)
-
-        # Generate the html from ERB
-        puts "Building new epub at builds/epub/book.epub"
-        File.open('builds/epub/OEBPS/book.html', 'a') do |f|
-          f << erb
-        end
-        FileUtils.cp_r('book/css/', 'builds/epub/OEBPS/', :verbose => true)
-        FileUtils.cp_r('book/images/', 'builds/epub/OEBPS/', :verbose => true)
+      @output = :epub
+      erb = import(BOOK_SOURCE)
+      puts "Generating new html from erb"
+      File.open('builds/epub/OEBPS/book.html', 'a') do |f|
+        f << erb
       end
       
-      # Load the book.yml into the Book object
-      @book = Book.new(YAML.load_file('config/book.yml'))
-      @toc = Toc.new(TAML.load_file('config/table_of_contents.yml'))
+      # Copy over html assets
+      FileUtils.cp_r('book/assets/', 'builds/epub/OEBPS/', :verbose => true)
       
-      def create_epub_structure
-        directory "templates/epub", "builds/epub"
-      end
+      # Generate toc source
+      # @output = :epub
+      # def create_toc
+      #  puts "Generating new toc from toc.html.erb"
+      #  toc_erb = import("book/toc.html.erb")
+      #  @noko_doc = Nokogiri::HTML(toc_erb)
+      #  File.open("builds/epub/OEBPS/toc.ncx", 'a') do |f|
+      #    f << @noko_doc.to_xml
+      #  end
+      #end
       
-      def generate_content_opf_file
-        template "templates/content.opf.tt" "builds/epub/OEBPS"
-      end
-
-      def generate_toc
-        template "templates/toc.ncs.tt" "builds/epub/OEBPS"
-      end
       
-      def zip_epub
-        # zip the contents into book.epub
-      end
       
-      def validate_epub
-        # cmd = %x[tools/epubcheck book_#{Time.now.strftime('%m-%e-%y').epub]
-      end
+      
+      #File.open("builds/epub/OEBPS/toc.ncx", 'a') do |f|
+      #  f << @noko_doc.to_xml
+      #end
+      
+      #@doc = Nokogiri::HTML(f)
+      
+      #f.close
+      
+      # store nav structure in array tree
+      # build xml toc.ncx file from array
+      
+      # create content.opf
+      
+      # zip it up
     end
   end
 end

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

@@ -2,13 +2,9 @@
 
     "a book publishing framework for today's publishing world"
 	
-bookshop is a book publishing framework for publishers, editors, and coders in today's publishing industry. bookshop provides a framework for developing books using well-known/standard web languages like HTML/CSS, which are then converted into pdf and other (e)book formats. The framework is optimized to help developers quickly ramp-up, allowing them to jump in and develop their html-to-pdf/(e)book flows, by favoring convention over configuration, setting them up with best-practices, standards and tools from the start.
+bookshop is a book publishing framework for building pdf/(e)books based on HTML, CSS, and JavaScript. The framework is optimized to help publishers, editors, and authors quickly ramp-up, allowing them to jump in and develop their html-to-pdf/(e)book 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:
-* separating the book into layers
-  * *Content*: the book's source - <i>writings, images, videos, copy</i>
-  * *Structure*: using div/css microformat to describe the book's structure - <i>chapter, section, etc.</i>
-  * *Style*: stylesheets to create the book's layout - <i>fonts, margins, color, etc.</i>
 * using common tools like HTML/CSS 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 in HTML as easy as 'gem install bookshop'
 * pulling all the html-to-pdf/(e)book tools together into one place (wkhtmltopdf, kindlegen, epubcheck)
@@ -262,9 +258,10 @@ The default directory structure of a generated bookshop project:
 
     |-- book/                 # Source files for your book
         |--book.html.erb      # The master file
-        |--css/
-            |--stylesheet.css
-        |--images/
+        |--assets/
+            |--css/
+                |--stylesheet.css
+            |--images/
 
     |-- builds/               # All the builds are created here
         |--epub/
@@ -302,45 +299,9 @@ config
 6. Let us know about your code and we'll review/merge it into the master.
 7. And pat yourself on the back for contributing to an open source project!!
 	
-== Copyright (LICENSE)
-
-BookShop is available under *either* the terms of the modified BSD license *or* the
-MIT License (2008). As a recipient of BookShop, you may choose which
-license to receive this code under (except as noted in per-module LICENSE
-files). Some modules may not be the copyright of BlueHead Publishing. These
-modules contain explicit declarations of copyright in both the LICENSE files in
-the directories in which they reside and in the code itself. No external
-contributions are allowed under licenses which are fundamentally incompatible
-with the MIT or BSD licenses that BookShop is distributed under.
-
-The text of the MIT and BSD licenses is reproduced below.
-
-=== The "New" BSD License
-
-Copyright (c) 2010-2011, BlueHead Publishing
-All rights reserved.
+== Copyright (MIT-LICENSE)
 
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-* Neither the name of Bookshop/BlueHead/BlueHead Publishing nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-=== The MIT License
-
-Copyright (c) 2010, 2011 BlueHead Publishing, et. al.,
+Copyright (C) 2010, 2011 by BlueHead Publishing, Inc (http://blueheadpublishing.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -360,11 +321,13 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 
-== The Boom Microformat License (as listed in the boom.css)
+== The Boom Microformat License - boom.css (from which the css microformat was based)
+
+http://www.alistapart.com/articles/boom
 
-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
+    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
 
 == Thanks
 
@@ -373,4 +336,7 @@ 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 WKHTMLTOPDF team http://code.google.com/p/wkhtmltopdf/
+
+A List of Our Contributors:
+https://github.com/blueheadpublishing/bookshop/blob/master/CONTRIBUTORS.md