bookshop 0.0.16 → 0.0.17

data/CHANGELOG

@@ -1,3 +1,13 @@
+0.0.17:
+	Features
+		Added config/book.yml, providing a data structure for elements accessible within the
+			book/ source files.
+			
+		Added 'current date' to the end of the generated filename of builds.
+			
+	Clean-up
+		Removed Template Generator for now, this has become part of the 0.2.0 milestone
+
 0.0.16:
 	Features
 		Added importing <%= import(your_source_file.html.erb) %> functionality for ERB source

data/README.rdoc

@@ -53,7 +53,7 @@ bookshop hopes to simplify the process by:
 
 === Editing Your New Book
 
-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:
+All of the source documents and assets for your book are stored in the +book/+ folder. The source files are all in ERB. 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:
 
 * embed ruby functions and calls
 
@@ -71,14 +71,40 @@ All of the source documents/code/assets (yay... HTML/CSS) for your book are stor
     
 * include other files or template structures
 
-    <%= import(your_source_file.erb.html) %>
+    <%= import(your_source_file.html.erb) %>
 
 * 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
+
 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.
 
 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).
 
+=== The book.yml file (config/book.yml)
+
+We've provided a data structure for your book (in YAML) so you can store pieces of data or variables that you can call within your source files.
+
+    # book.yml
+    
+    title: A Book Title
+    subtitle: A Book Subtitle
+    
+    epub:
+      title: A EPUB Title
+
+In your book source file:
+
+    # book/book.html.erb
+    
+    <p>The book title is <%= book.title %></p>
+    <p>The book subtitle is <%= book.subtitle %></p>
+    <p>The epub title is <%= book.epub.title %></p>
+
+More info about YAML:
+
+http://en.wikipedia.org/wiki/YAML
+
 === Building Your First Book
 
 To build a pdf format of your book from the html source:

data/lib/bookshop/commands/build.rb

@@ -1,9 +1,45 @@
 require 'thor/group'
 require 'erb'
 require 'fileutils'
+require 'yaml'
 
 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
@@ -17,10 +53,6 @@ module Bookshop
       build = ARGV.shift
       build = aliases[build] || build
       
-      # Renders <%= import(source.html.erb) %> files with ERB
-      def self.import(file)
-        ERB.new(File.read('book/'+file)).result(binding).gsub(/\n$/,'')
-      end
 
       # Define arguments and options
       argument :type
@@ -29,26 +61,38 @@ module Bookshop
       def self.source_root
         File.dirname(__FILE__)
       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 book settings into the book object
+        book = Book.new(YAML.load_file('config/book.yml'))
+        ERB.new(File.read('book/'+file)).result(binding).gsub(/\n$/,'')
+      end
       
       erb = import('book.html.erb')
       
       case build
       
-      # 'build html' creates a html version of the book
+      # 'build html' generates a html version of the book from the
+      #    book/book.html.erb source file
       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|
+        File.open("builds/html/book_#{Time.now.strftime('%m-%e-%y')}.html", 'a') do |f|
           f << erb
         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
+      # '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
       when 'pdf'
         # Clean up any old builds
         puts "Deleting any old builds"
@@ -65,9 +109,9 @@ module Bookshop
         FileUtils.cp_r('book/css/', 'builds/html/', :verbose => true)
         FileUtils.cp_r('book/images/', 'builds/html/', :verbose => true)
 
-        # Build the pdf
+        # Builds the pdf from builds/html/book.html
         puts "Building new pdf at builds/pdf/book.pdf from new html build"
-        cmd = %x[wkhtmltopdf builds/html/book.html builds/pdf/book.pdf]
+        cmd = %x[wkhtmltopdf builds/html/book.html builds/pdf/book_#{Time.now.strftime('%m-%e-%y')}.pdf]
         
       else
         puts "Error: Command not recognized" unless %w(-h --help).include?(build)

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

@@ -53,7 +53,7 @@ bookshop hopes to simplify the process by:
 
 === Editing Your New Book
 
-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:
+All of the source documents and assets for your book are stored in the +book/+ folder. The source files are all in ERB. 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:
 
 * embed ruby functions and calls
 
@@ -71,14 +71,40 @@ All of the source documents/code/assets (yay... HTML/CSS) for your book are stor
     
 * include other files or template structures
 
-    <%= import(your_source_file.erb.html) %>
+    <%= import(your_source_file.html.erb) %>
 
 * 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
+
 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.
 
 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).
 
+=== The book.yml file (config/book.yml)
+
+We've provided a data structure for your book (in YAML) so you can store pieces of data or variables that you can call within your source files.
+
+    # book.yml
+    
+    title: A Book Title
+    subtitle: A Book Subtitle
+    
+    epub:
+      title: A EPUB Title
+
+In your book source file:
+
+    # book/book.html.erb
+    
+    <p>The book title is <%= book.title %></p>
+    <p>The book subtitle is <%= book.subtitle %></p>
+    <p>The epub title is <%= book.epub.title %></p>
+
+More info about YAML:
+
+http://en.wikipedia.org/wiki/YAML
+
 === Building Your First Book
 
 To build a pdf format of your book from the html source:

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

@@ -6,6 +6,10 @@
 <link rel="stylesheet" type="text/css" href="css/stylesheet.css">
 </head>
 <body>
+<p>Title: <%= book.title %></p>
+<p>Subtitle: <%= book.subtitle %></p>
+<p>ISBN: <%= book.isbn %></p>
+
 
 <%= import('cover.html.erb')%>
 <%= import('toc.html.erb')%>

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

@@ -0,0 +1,38 @@
+# Settings for the book which can be called within the book source files
+#
+# in book/book.html.erb
+#
+#      <p><b>Version:</b> <%= book.version %></p>
+#
+#   or
+#
+#      <% 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.
+# 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)
+
+
+
+# Place the epub specific settings here
+html:
+  title: Bookshop (html version)
+
+
+# You can add any additional variables
+#
+# foo:
+#   bar: foobar
+#
+#   in book.html.erb you could use <%= foo.bar %>  # --> foobar

data/lib/bookshop/generators/bookshop/app/templates/script/bookshop

@@ -1,7 +1,5 @@
 # This command will automatically be run when you run "bookshop" with Bookshop gem installed from the root of your application.
 
-APP_PATH = File.expand_path('../../config/application',  __FILE__)
-require File.expand_path('../../config/boot',  __FILE__)
 require 'bookshop/commands'
 
 

data/lib/bookshop/version.rb

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

metadata

@@ -2,7 +2,7 @@
 name: bookshop
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.16
+  version: 0.0.17
 platform: ruby
 authors: 
 - D.a. Thompson
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-11 00:00:00 Z
+date: 2011-12-13 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: thor
@@ -92,14 +92,8 @@ files:
 - 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
-- lib/bookshop/generators/bookshop/app/templates/config/boot.rb
+- lib/bookshop/generators/bookshop/app/templates/config/book.yml
 - lib/bookshop/generators/bookshop/app/templates/script/bookshop
-- lib/bookshop/generators/bookshop/generator/USAGE
-- lib/bookshop/generators/bookshop/generator/generator_generator.rb
-- lib/bookshop/generators/bookshop/generator/templates/%file_name%_generator.rb.tt
-- lib/bookshop/generators/bookshop/generator/templates/USAGE.tt
-- lib/bookshop/generators/bookshop/generator/templates/templates/.empty_directory
 - lib/bookshop/post_install.rb
 - lib/bookshop/ruby_version_check.rb
 - lib/bookshop/script_bookshop_loader.rb

data/lib/bookshop/generators/bookshop/app/templates/config/application.rb

@@ -1,46 +0,0 @@
-require File.expand_path('../boot', __FILE__)
-
-require 'bookshop'
-
-# If you have a Gemfile, require the gems listed there, including any gems
-# you've limited to :test, :development, or :production.
-Bundler.require(:default, Bookshop.env) if defined?(Bundler)
-
-module <%= app_const_base %>
-  class Application < Bookshop::Application
-    # Settings in config/environments/* take precedence over those specified here.
-    # Application configuration should go into files in config/initializers
-    # -- all .rb files in that directory are automatically loaded.
-
-    # Custom directories with classes and modules you want to be autoloadable.
-    # config.autoload_paths += %W(#{config.root}/extras)
-
-    # Only load the plugins named here, in the order given (default is alphabetical).
-    # :all can be used as a placeholder for all plugins not explicitly named.
-    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
-
-    # Activate observers that should always be running.
-    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
-
-    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
-    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
-    # config.time_zone = 'Central Time (US & Canada)'
-
-    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
-    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
-    # config.i18n.default_locale = :de
-
-    # JavaScript files you want as :defaults (application.js is always included).
-<% if options[:skip_prototype] -%>
-    config.action_view.javascript_expansions[:defaults] = %w()
-<% else -%>
-    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
-<% end -%>
-
-    # Configure the default encoding used in templates for Ruby 1.9.
-    config.encoding = "utf-8"
-
-    # Configure sensitive parameters which will be filtered from the log file.
-    config.filter_parameters += [:password]
-  end
-end

data/lib/bookshop/generators/bookshop/app/templates/config/boot.rb

@@ -1,13 +0,0 @@
-require 'rubygems'
-
-# Set up gems listed in the Gemfile.
-gemfile = File.expand_path('../../Gemfile', __FILE__)
-begin
-  ENV['BUNDLE_GEMFILE'] = gemfile
-  require 'bundler'
-  Bundler.setup
-rescue Bundler::GemNotFound => e
-  STDERR.puts e.message
-  STDERR.puts "Try running `bundle install`."
-  exit!
-end if File.exist?(gemfile)

data/lib/bookshop/generators/bookshop/generator/USAGE

@@ -1,12 +0,0 @@
-Description:
-    Stubs out a new generator at lib/generators. Pass the generator name as an argument,
-    either CamelCased or snake_cased.
-
-Example:
-    `bookshop generate generator Awesome`
-
-    creates a standard awesome generator:
-        lib/generators/awesome/
-        lib/generators/awesome/awesome_generator.rb
-        lib/generators/awesome/USAGE
-        lib/generators/awesome/templates/

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

@@ -1,26 +0,0 @@
-module Bookshop
-  module Generators
-    # 
-    class GeneratorGenerator < NamedBase
-      check_class_collision :suffix => "Generator"
-
-      class_option :namespace, :type => :boolean, :default => true,
-                               :desc => "Namespace generator under lib/generators/name"
-
-      def create_generator_files
-        directory '.', generator_dir
-      end
-
-      protected
-
-        def generator_dir
-          if options[:namespace]
-            File.join("lib", "generators", file_name)
-          else
-            File.join("lib", "generators")
-          end
-        end
-
-    end
-  end
-end

data/lib/bookshop/generators/bookshop/generator/templates/%file_name%_generator.rb.tt

@@ -1,3 +0,0 @@
-class <%= class_name %>Generator < Bookshop::Generators::NamedBase
-  source_root File.expand_path('../templates', __FILE__)
-end

data/lib/bookshop/generators/bookshop/generator/templates/USAGE.tt

@@ -1,8 +0,0 @@
-Description:
-    Explain the generator
-
-Example:
-    bookshop generate <%= file_name %> Thing
-
-    This will create:
-        what/will/it/create