bookshop 0.0.17 → 0.0.18

data/CHANGELOG

@@ -1,3 +1,16 @@
+0.0.18:
+	Features
+		Added @output variable for use in ERB source files so conditionals can be used to
+			define custom layouts based upon the type of output being built
+			(e.g. html, pdf, etc)
+		
+		Abstracted the book-to-yaml class into it's own class under */commands/yaml/book.rb
+		
+	Documentation
+		Edited the example book to demonstrate use of "output" conditionals in ERB source
+			files.
+		Added documentation in README's to show use of "output" conditionals in ERB source
+
 0.0.17:
 	Features
 		Added config/book.yml, providing a data structure for elements accessible within the

data/README.rdoc

@@ -73,6 +73,21 @@ All of the source documents and assets for your book are stored in the +book/+ f
 
     <%= import(your_source_file.html.erb) %>
 
+* specify content only for certain build outputs (e.g. html, pdf, epub, etc.)
+
+    # to generate titles that change depending on the build
+    
+    <p>Title: 
+      <% if @output == :html %>
+        <%= book.html.title %>
+      <% elsif @output == :pdf %>
+        <%= book.pdf.title %>
+      <% end %>
+    </p>
+    
+    # did you notice the book.html.title? Look below at the book.yml for explanation
+
+
 * explore other creative ways to structure and enhance your book (we'd love to see how you are doing it)
 
 http://www.ruby-doc.org/stdlib-1.9.3/libdoc/erb/rdoc/ERB.html
@@ -107,9 +122,13 @@ http://en.wikipedia.org/wiki/YAML
 
 === Building Your First Book
 
-To build a pdf format of your book from the html source:
+To build a pdf format of your book from the ERB source:
+
+    $ bookshop build pdf    # -> find the output in builds/pdf/book_(date).pdf
 
-    $ bookshop build pdf
+To build an HTML format of your book from the ERB source:
+
+    $ bookshop build html   # -> find the output in builds/html/book_(date).html
 
 == Getting Help
 
@@ -127,7 +146,6 @@ The default directory structure of a generated bookshop project:
     pdf
 
   |-- config
-  |-- tools
 
 book
   Holds all the manuscript html code/files. This is where your master manuscript lives from which everything is built.
@@ -146,9 +164,6 @@ build/pdf
 
 config
   application-wide variables and configurations will go here
-	
-tools
-  Holds all third-party tools: epubcheck, kindlegen
 
 == Get Involved
 1. Fork the repository.

data/lib/bookshop/commands/build.rb

@@ -3,43 +3,11 @@ require 'erb'
 require 'fileutils'
 require 'yaml'
 
+require 'bookshop/commands/yaml/book'
+
 module Bookshop
   module Commands
-    
-    class Book
-
-      def initialize(data={})
-        @data = {}
-        update!(data)
-      end
-
-      def update!(data)
-        data.each do |key, value|
-          self[key] = value
-        end
-      end
-
-      def [](key)
-        @data[key.to_sym]
-      end
-
-      def []=(key, value)
-        if value.class == Hash
-          @data[key.to_sym] = Book.new(value)
-        else
-          @data[key.to_sym] = value
-        end
-      end
-
-      def method_missing(sym, *args)
-        if sym.to_s =~ /(.+)=$/
-          self[$1] = args.first
-        else
-          self[sym]
-        end
-      end
 
-    end
     # Define build commands for bookshop command line
     class Build < Thor::Group
       include Thor::Actions
@@ -67,22 +35,27 @@ module Bookshop
       # 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 book settings into the book object
+        
+        # Load the book.yml into the Book object
         book = Book.new(YAML.load_file('config/book.yml'))
+        
+        # Parse the source erb file
         ERB.new(File.read('book/'+file)).result(binding).gsub(/\n$/,'')
       end
       
-      erb = import('book.html.erb')
-      
       case build
       
       # 'build html' generates a html version of the book from the
       #    book/book.html.erb source file
+      # @output variable is set to "html" for access as a conditional
+      #   in the source erb's
       when 'html'
         # Clean up any old builds
         puts "Deleting any old builds"
         FileUtils.rm_r Dir.glob('builds/html/*')
         
+        @output = :html
+        erb = import('book.html.erb')
         puts "Generating new html from erb"
         File.open("builds/html/book_#{Time.now.strftime('%m-%e-%y')}.html", 'a') do |f|
           f << erb
@@ -99,6 +72,8 @@ module Bookshop
         FileUtils.rm_r Dir.glob('builds/pdf/*')
         FileUtils.rm_r Dir.glob('builds/html/*')
         
+        @output = :pdf
+        erb = import('book.html.erb')
         # Generate the html from ERB
         puts "Generating new html from erb"
         File.open('builds/html/book.html', 'a') do |f|

data/lib/bookshop/commands/yaml/book.rb

@@ -0,0 +1,43 @@
+# Take a YAML data structure and express it in a 'class.method.method' convention so
+#   it can be passed to the build command, used in the source files to call data
+#   from the book.yml file
+#
+# # book.yml
+# foo:
+#   bar: foobar
+#
+# is referenced in the source files as <%= book.foo.bar %> and yields in build 'foobar'
+class Book
+
+  def initialize(data={})
+    @data = {}
+    update!(data)
+  end
+
+  def update!(data)
+    data.each do |key, value|
+      self[key] = value
+    end
+  end
+
+  def [](key)
+    @data[key.to_sym]
+  end
+
+  def []=(key, value)
+    if value.class == Hash
+      @data[key.to_sym] = Book.new(value)
+    else
+      @data[key.to_sym] = value
+    end
+  end
+
+  def method_missing(sym, *args)
+    if sym.to_s =~ /(.+)=$/
+      self[$1] = args.first
+    else
+      self[sym]
+    end
+  end
+
+end

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

@@ -4,7 +4,7 @@ bookShop is a publishing framework for html-to-pdf/(e)book toolchain happiness a
 
 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 'gem install bookshop'
+* providing a Ruby Gem to make building a pdf or (e)book from HTML as easy as 'gem install bookshop'
 * pulling all the html-to-(e)book tools together into one place (wkhtmltopdf, kindlegen, epubcheck)
 * sticking with open-source tools
 * giving the developer a set of scripts to automate the redundant stuff
@@ -73,6 +73,21 @@ All of the source documents and assets for your book are stored in the +book/+ f
 
     <%= import(your_source_file.html.erb) %>
 
+* specify content only for certain build outputs (e.g. html, pdf, epub, etc.)
+
+    # to generate titles that change depending on the build
+    
+    <p>Title: 
+      <% if @output == :html %>
+        <%= book.html.title %>
+      <% elsif @output == :pdf %>
+        <%= book.pdf.title %>
+      <% end %>
+    </p>
+    
+    # did you notice the book.html.title? Look below at the book.yml for explanation
+
+
 * explore other creative ways to structure and enhance your book (we'd love to see how you are doing it)
 
 http://www.ruby-doc.org/stdlib-1.9.3/libdoc/erb/rdoc/ERB.html
@@ -107,9 +122,13 @@ http://en.wikipedia.org/wiki/YAML
 
 === Building Your First Book
 
-To build a pdf format of your book from the html source:
+To build a pdf format of your book from the ERB source:
+
+    $ bookshop build pdf    # -> find the output in builds/pdf/book_(date).pdf
 
-    $ bookshop build pdf
+To build an HTML format of your book from the ERB source:
+
+    $ bookshop build html   # -> find the output in builds/html/book_(date).html
 
 == Getting Help
 
@@ -127,7 +146,6 @@ The default directory structure of a generated bookshop project:
     pdf
 
   |-- config
-  |-- tools
 
 book
   Holds all the manuscript html code/files. This is where your master manuscript lives from which everything is built.
@@ -146,9 +164,6 @@ build/pdf
 
 config
   application-wide variables and configurations will go here
-	
-tools
-  Holds all third-party tools: epubcheck, kindlegen
 
 == Get Involved
 1. Fork the repository.

data/lib/bookshop/generators/bookshop/app/templates/book/book.html.erb

@@ -6,7 +6,12 @@
 <link rel="stylesheet" type="text/css" href="css/stylesheet.css">
 </head>
 <body>
-<p>Title: <%= book.title %></p>
+<p>Title: 
+	<% if @output == :html %>
+		<%= book.html.title %>
+	<% elsif @output == :pdf %>
+		<%= book.pdf.title %>
+	<% end %></p>
 <p>Subtitle: <%= book.subtitle %></p>
 <p>ISBN: <%= book.isbn %></p>
 
@@ -15,10 +20,10 @@
 <%= import('toc.html.erb')%>
 <%= import('preface.html.erb')%>
 
-<!-- Chapter 01 has the imports included inside of it -->
+<!-- Chapter 01 has additional imports included inside of it -->
 <%= import('ch01/ch01.html.erb')%>
 
-<!-- Chapter 01 has the imports included inside of it -->
+<!-- Chapter 01 has additional imports included inside of it -->
 <%= import('ch02/ch02.html.erb')%>
 
 </body></html>

data/lib/bookshop/generators/bookshop/app/templates/config/book.yml

@@ -2,37 +2,41 @@
 #
 # in book/book.html.erb
 #
-#      <p><b>Version:</b> <%= book.version %></p>
+#      <p><b>Version:</b> <%= book.epub.version %></p>
 #
 #   or
 #
-#      <% if book.epub.version >= 1.0.0 %>
+#      <% if book.epub.version == '1.0.0' %>
 #        <p>Whew! We made it!</p>
 #      <% end %>
 
-version: 0.0.1
 title: Bookshop
 subtitle: An HTML-to-PDF/(e)Book Publishing Framework
 isbn: 1234567891011     # ISBN-13
 
 
-
-# Place the epub specific settings here. Use whatever you want.
+# Place the pdf specific settings here. Use whatever you want.
 # You can use these settings in your source layouts by using a tag
-#   in book.html.erb you could use <%= book.epub.title %>
-epub:
-  title: Bookshop (the eBook)
+#   in book.html.erb you could use <%= book.pdf.title %>
+pdf:
+  version: 0.0.1
+  title: Bookshop (PDF Version)
 
 
+# Place the epub specific settings here.
+epub:
+  version: 0.0.1
+  title: Bookshop (eBook)
+
 
-# Place the epub specific settings here
+# Place the html specific settings here
 html:
-  title: Bookshop (html version)
+  title: Bookshop (HTML version)
 
 
-# You can add any additional variables
+# You can add any additional variables you want
 #
 # foo:
 #   bar: foobar
 #
-#   in book.html.erb you could use <%= foo.bar %>  # --> foobar
+#   in book.html.erb you can then use <%= foo.bar %>  # --> foobar

data/lib/bookshop/version.rb

@@ -1,3 +1,3 @@
 module Bookshop
-  VERSION = "0.0.17"
+  VERSION = "0.0.18"
 end

metadata

@@ -2,7 +2,7 @@
 name: bookshop
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.17
+  version: 0.0.18
 platform: ruby
 authors: 
 - D.a. Thompson
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-13 00:00:00 Z
+date: 2011-12-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: thor
@@ -71,6 +71,7 @@ files:
 - lib/bookshop/commands.rb
 - lib/bookshop/commands/application.rb
 - lib/bookshop/commands/build.rb
+- lib/bookshop/commands/yaml/book.rb
 - lib/bookshop/generators/bookshop/app/USAGE
 - lib/bookshop/generators/bookshop/app/app_generator.rb
 - lib/bookshop/generators/bookshop/app/templates/CHANGELOG