hologram 0.5.9 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e48a782a8a76b16ebd3ae5127bf1b331ae6d435
-  data.tar.gz: 01448485dc3f2ed3a396ab0fd2bc699dd7d9438e
+  metadata.gz: 24abd28899897760d163bbf8dd975e4589436af0
+  data.tar.gz: ac2d7bf8b43b646802107f20284378c77bfa26f3
 SHA512:
-  metadata.gz: 380bd924c01c63dd9b9dfba8fffee5acc19e48806da2157901fcda52ded6e30f5ee5b5d367111449188904fc17b0120c313171cd5db2f82dc26bd224f501a185
-  data.tar.gz: 9837b618d0854234b1e85cc32ffb53bcaa41dfc09c0f3b029bb1b7ce74f83b405ffadb5ce93ac775bd32fc4b1ba28e3165fb3361d4e688f2a2fbd69457a353f7
+  metadata.gz: 9793211c0cf19e31fd8c5384ec17f149ebfec48ff596477a94b48507b6f467519d146962f32f8e2aa7196773e4c0d272bbc1555f0bf2be9cf3062d2be9915fdb
+  data.tar.gz: f9308f6c7136fcefd2bd7188c583d699355071ca6ffb24e2586a9d57156db8e56c4f2b9b42d62c64b632aa516c2b910bd26117a71ca0bbc6f3f982d9234ddce7

data/LICENSE.txt

@@ -1,23 +1,25 @@
-Copyright (c) 2013, Trulia, Inc.
-All rights reserved.
+Copyright (c) 2013, Trulia, Inc. All rights reserved.
 
 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 the Trulia, Inc. nor the
+     names of its contributors may be used to endorse or promote products
+     derived from this software without specific prior written permission.
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 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.
+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 TRULIA, INC. 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.

data/README.md

@@ -27,8 +27,8 @@ If you don't use bundler you can run `gem install hologram`.
 hologram init
 ```
 
-This will create a config yml file, and also create a starter
-`_header.tpl` and `_footer.tpl` file for you. You can then tweak the
+This will create a `hologram_config.yml` file  (more on this below), and also create a starter
+`_header.html` and `_footer.html` file for you. You can then tweak the
 config values and start documenting your css.
 
 Building the documentation is simply:
@@ -66,13 +66,14 @@ Your config file needs to contain the following key/value pairs
   (header/footer, etc), styleguide specific CSS, javascript and any
   images. Hologram specifically looks for two files: `_header.html` and
   `_footer.html`, these are used to start and end every html page
-  holgoram generates. Hologram treats `_header.html` and `_footer.html`
+  hologram generates. 
+
+  Hologram treats `_header.html` and `_footer.html`
   as ERB files for each page that is generated you can access the
-  `title`, `file_name`, and `blocks`. `blocks` is a list of each
+  `title`, `file_name`, and `blocks`.  `blocks` is a list of each
   documenation block on the page. Each item in the list has a `title`,
-  `name`, `category`, and optionally a `parent`. Additionaly, filenames
-  that begin with underscores will not be copied into the destination
-  folder.
+  `name`, `category`, and optionally a `parent`. This is useful for, say, building a menu that lists each component. 
+  **Nota Bene:** Filenames that begin with underscores will not be copied into the destination folder.
 
 
 * **custom_markdown**: (optional) this is the filename of a class that
@@ -135,9 +136,11 @@ It will look for comments that match the following:
     */
 
 The first section of the comment is a yaml block that defines certain
-aspects of the this documentation block. The second part is simply
+aspects of the this documentation block (more on that in the next section). The second part is simply
 markdown as defined by Redcarpet.
 
+Notice the use of `html_example`. This tells the markdown renderer that it should treat the example as...well...html. If your project uses [haml](http://haml.info/) you can also use `haml_example`. In that case the output will be html for the example and the code block will show the haml used to generate the html. For components that require [javascript](https://www.destroyallsoftware.com/talks/wat) you can use `js_example` for your js. In addtion to outputing the js in a `<code>` block it will also wrap it in a `<script>` tag for execution.
+
 ####Document YAML section
 The yaml in the doc block can have any key value pair you deem important
 but it specifically looks for the following keys:
@@ -147,8 +150,11 @@ but it specifically looks for the following keys:
   components in the same category will be written to the same page.
 * **name**: This is used for grouping components, by assigning
   a name a component can be referenced in another component as a parent.
-* **parent**: Optional. If this is set the current component will be
-  displayed as a section within the parent's documentation.
+* **parent**: (Optional.) This should be the **name** of another components. If this is set the current component will be displayed as a section within the **parent**'s documentation. 
+
+For example, you might have a component with the **name** *buttons* and another component named *buttonSkins*. You could set the **parent** for the *buttonSkins* component to be *buttons*. It would then nest the *buttonSkins* documentation inside the *buttons* documentation. 
+
+Each level of nesting (components are infinitely nestable) will have a heading tag that represents its depth. In the above example *buttons* would have an `<h1>` and *buttonSkins* would have an `<h2>`. This you can [see this exact example in our demo repo](https://github.com/trulia/hologram-example/tree/master/components/button), and the output of this nesting [in our demo styleguide](http://trulia.github.io/hologram-example/base_css.html#Buttons).
 
 
 ###Documentation Assets

data/lib/hologram.rb

@@ -1,29 +1,3 @@
-# Copyright (c) 2013, Trulia, Inc.
-# All rights reserved.
-#
-# 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 the Trulia, Inc. 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 TRULIA, INC. 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.
-
 require "hologram/version"
 
 require 'redcarpet'
@@ -37,23 +11,8 @@ require 'hologram_markdown_renderer'
 
 module Hologram
 
-  #Helper class for binding things for ERB
-  class TemplateVariables
-    attr_accessor :title, :file_name, :blocks
-
-    def initialize(title, file_name, blocks)
-      @title = title
-      @file_name = file_name
-      @blocks = blocks
-    end
-
-    def get_binding
-      binding
-    end
-  end
-
   class DocumentBlock
-    attr_accessor :name, :parent, :children, :title, :category, :markdown, :output_file, :config
+    attr_accessor :name, :parent, :children, :title, :category, :markdown, :config, :heading
 
     def initialize(config = nil, markdown = nil)
       @children = {}
@@ -62,9 +21,9 @@ module Hologram
 
     def set_members(config, markdown)
       @name     = config['name']
-      @parent   = config['parent']
       @category = config['category']
       @title    = config['title']
+      @parent   = config['parent']
       @markdown = markdown
     end
 
@@ -79,10 +38,15 @@ module Hologram
     def is_valid?
       @name && @markdown
     end
+
+    # sets the header tag based on how deep your nesting is
+    def markdown_with_heading(heading = 1)
+      @markdown = "\n\n<h#{heading.to_s} id=\"#{@name}\">#{@title}</h#{heading.to_s}>" + @markdown
+    end
   end
 
 
-  class Builder
+  class DocBuilder
     attr_accessor :doc_blocks, :config, :pages
 
     INIT_TEMPLATE_PATH = File.expand_path('./template/', File.dirname(__FILE__)) + '/'
@@ -92,14 +56,14 @@ module Hologram
     ]
 
     def init(args)
-      @doc_blocks, @pages = {}, {}
+      @pages = {}
       @supported_extensions = ['.css', '.scss', '.less', '.sass', '.styl', '.js', '.md', '.markdown' ]
 
       begin
         if args[0] == 'init' then
 
           if File.exists?("hologram_config.yml")
-            puts "Cowardly refusing to overwrite existing hologram_config.yml"
+            puts "Cowardly refusing to overwrite existing hologram_config.yml".yellow
           else
             FileUtils.cp_r INIT_TEMPLATE_FILES, Dir.pwd
             puts "Created the following files and directories:"
@@ -115,22 +79,22 @@ module Hologram
             begin
               @config = YAML::load_file(config_file)
             rescue
-              display_error "Could not load config file, try hologram init to get started"
+              DisplayMessage.error("Could not load config file, try 'hologram init' to get started")
             end
 
             validate_config
 
-            #TODO: maybe this should move into build_docs
             current_path = Dir.pwd
             base_path = Pathname.new(config_file)
             Dir.chdir(base_path.dirname)
 
+            # the real work happens here.
             build_docs
 
             Dir.chdir(current_path)
             puts "Build completed. (-: ".green
           rescue RuntimeError => e
-            display_error("#{e}")
+            DisplayMessage.error("#{e}")
           end
         end
       end
@@ -145,19 +109,32 @@ module Hologram
       begin
         input_directory  = Pathname.new(config['source']).realpath
       rescue
-        display_error "Can not read source directory, does it exist?"
+        DisplayMessage.error("Can not read source directory, does it exist?")
       end
 
       output_directory = Pathname.new(config['destination']).realpath
       doc_assets       = Pathname.new(config['documentation_assets']).realpath unless !File.directory?(config['documentation_assets'])
 
       if doc_assets.nil?
-        display_warning "Could not find documentation assets at #{config['documentation_assets']}"
+        DisplayMessage.warning("Could not find documentation assets at #{config['documentation_assets']}")
       end
 
-      process_dir(input_directory)
+      # recursively traverse our directory structure looking for files that
+      # match our "parseable" file types. Open those files pulling out any
+      # comments matching the hologram doc style /*doc */ and create DocBlock
+      # objects from those comments, then add those to a collection object which
+      # is then returned.
+      doc_block_collection = process_dir(input_directory)
+
+      # doc blocks can define parent/child relationships that will nest their
+      # documentation appropriately. we can't put everything into that structure
+      # on our first pass through because there is no guarantee we'll parse files
+      # in the correct order. This step takes the full collection and creates the
+      # proper structure.
+      doc_block_collection.create_nested_structure
 
-      build_pages_from_doc_blocks(@doc_blocks)
+      # hand off our properly nested collection to the output generator
+      build_pages_from_doc_blocks(doc_block_collection.doc_blocks)
 
       # if we have an index category defined in our config copy that
       # page to index.html
@@ -165,7 +142,7 @@ module Hologram
         if @pages.has_key?(config['index'] + '.html')
           @pages['index.html'] = @pages[config['index'] + '.html']
         else
-          display_warning "Could not generate index.html, there was no content generated for the category #{config['index']}."
+          DisplayMessage.warning("Could not generate index.html, there was no content generated for the category #{config['index']}.")
         end
       end
 
@@ -181,7 +158,7 @@ module Hologram
               `cp -R #{dirpath} #{output_directory}/#{dirpath.basename}`
             end
           rescue
-            display_warning "Could not copy dependency: #{dir}"
+            DisplayMessage.warning("Could not copy dependency: #{dir}")
           end
         end
       end
@@ -200,6 +177,7 @@ module Hologram
 
     def process_dir(base_directory)
       #get all directories in our library folder
+      doc_block_collection = DocBlockCollection.new
       directories = Dir.glob("#{base_directory}/**/*/")
       directories.unshift(base_directory)
 
@@ -210,23 +188,24 @@ module Hologram
           files << file
         end
         files.sort!
-        process_files(files, directory)
+        process_files(files, directory, doc_block_collection)
       end
+      doc_block_collection
     end
 
 
-    def process_files(files, directory)
+    def process_files(files, directory, doc_block_collection)
       files.each do |input_file|
         if input_file.end_with?('md')
           @pages[File.basename(input_file, '.md') + '.html'] = {:md => File.read("#{directory}/#{input_file}"), :blocks => []}
         else
-          process_file("#{directory}/#{input_file}")
+          process_file("#{directory}/#{input_file}", doc_block_collection)
         end
       end
     end
 
 
-    def process_file(file)
+    def process_file(file, doc_block_collection)
       file_str = File.read(file)
       # get any comment blocks that match the patterns:
       # .sass: //doc (follow by other lines proceeded by a space)
@@ -239,73 +218,30 @@ module Hologram
       return unless hologram_comments
 
       hologram_comments.each do |comment_block|
-        doc_block = build_doc_block(comment_block[0])
-        add_doc_block_to_collection(doc_block) if doc_block
+        doc_block_collection.add_doc_block(comment_block[0])
       end
     end
 
 
-    # this should throw an error if we have a match, but now yaml_match
-    def build_doc_block(comment_block)
-      yaml_match = /^\s*---\s(.*?)\s---$/m.match(comment_block)
-      return unless yaml_match
-      markdown = comment_block.sub(yaml_match[0], '')
-
-      begin
-        config = YAML::load(yaml_match[1])
-      rescue
-        display_error("Could not parse YAML:\n#{yaml_match[1]}")
-      end
-
-      if config['name'].nil?
-        puts "Missing required name config value. This hologram comment will be skipped. \n #{config.inspect}"
-      else
-        doc_block = DocumentBlock.new(config, markdown)
-      end
-    end
-
-
-    def add_doc_block_to_collection(doc_block)
-      return unless doc_block.is_valid?
-      if doc_block.parent.nil?
-        #parent file
-        begin
-          doc_block.output_file = get_file_name(doc_block.category)
-        rescue NoMethodError => e
-          display_error("No output file specified. Missing category? \n #{doc_block.inspect}")
-        end
-
-        @doc_blocks[doc_block.name] = doc_block;
-        doc_block.markdown = "\n\n<#{@config['parent_heading_tag']} id=\"#{doc_block.name}\">#{doc_block.title}</#{@config['parent_heading_tag']}>" + doc_block.markdown
-      else
-        # child file
-        parent_doc_block = @doc_blocks[doc_block.parent]
-        if parent_doc_block
-          if doc_block.title.nil?
-            doc_block.markdown = doc_block.markdown
-          else
-            doc_block.markdown = "\n\n<#{@config['child_heading_tag']} id=\"#{doc_block.name}\">#{doc_block.title}</#{@config['child_heading_tag']}>" + doc_block.markdown
-          end
-          parent_doc_block.children[doc_block.name] = doc_block
-        else
-          @doc_blocks[doc_block.parent] = DocumentBlock.new()
-        end
-      end
-    end
-
-
-    def build_pages_from_doc_blocks(doc_blocks, output_file = nil)
+    def build_pages_from_doc_blocks(doc_blocks, output_file = nil, depth = 1)
       doc_blocks.sort.map do |key, doc_block|
-        output_file = doc_block.output_file || output_file
+
+        # if the doc_block has a category set then use that, this will be
+        # true of all top level doc_blocks. The output file they set will then
+        # be passed into the recursive call for adding children to the output
+        output_file = get_file_name(doc_block.category) if doc_block.category
 
         if !@pages.has_key?(output_file)
           @pages[output_file] = {:md => "", :blocks => []}
         end
 
         @pages[output_file][:blocks].push(doc_block.get_hash)
-        @pages[output_file][:md] << doc_block.markdown
+        @pages[output_file][:md] << doc_block.markdown_with_heading(depth)
+
         if doc_block.children
-          build_pages_from_doc_blocks(doc_block.children, output_file)
+          depth += 1
+          build_pages_from_doc_blocks(doc_block.children, output_file, depth)
+          depth -= 1
         end
       end
     end
@@ -321,7 +257,7 @@ module Hologram
         header_erb = ERB.new(File.read("#{doc_assets}/header.html"))
       else
         header_erb = nil
-        display_warning "No _header.html found in documentation assets. Without this your css/header will not be included on the generated pages."
+        DisplayMessage.warning("No _header.html found in documentation assets. Without this your css/header will not be included on the generated pages.")
       end
 
       if File.exists?("#{doc_assets}/_footer.html")
@@ -330,7 +266,7 @@ module Hologram
         footer_erb = ERB.new(File.read("#{doc_assets}/footer.html"))
       else
         footer_erb = nil
-        display_warning "No _footer.html found in documentation assets. This might be okay to ignore..."
+        DisplayMessage.warning("No _footer.html found in documentation assets. This might be okay to ignore...")
       end
 
       #generate html from markdown
@@ -339,7 +275,7 @@ module Hologram
 
         title = page[:blocks].empty? ? "" : page[:blocks][0][:category]
 
-        tpl_vars = TemplateVariables.new title, file_name, page[:blocks]
+        tpl_vars = TemplateVariables.new(title, file_name, page[:blocks])
 
         # generate doc nav html
         unless header_erb.nil?
@@ -347,7 +283,11 @@ module Hologram
         end
 
         # write the docs
-        fh.write(renderer.render(page[:md]))
+        begin
+          fh.write(renderer.render(page[:md]))
+        rescue Exception => e
+          DisplayMessage.error(e.message)
+        end
 
         # write the footer
         unless footer_erb.nil?
@@ -369,9 +309,9 @@ module Hologram
           puts "Custom markdown renderer #{renderer_class} loaded."
           renderer = Redcarpet::Markdown.new(Module.const_get(renderer_class), { :fenced_code_blocks => true, :tables => true })
         rescue LoadError => e
-          display_error("Could not load #{config['custom_markdown']}.")
+          DisplayMessage.error("Could not load #{config['custom_markdown']}.")
         rescue NameError => e
-          display_error("Class #{renderer_class} not found in #{config['custom_markdown']}.")
+          DisplayMessage.error("Class #{renderer_class} not found in #{config['custom_markdown']}.")
         end
       end
       renderer
@@ -380,24 +320,15 @@ module Hologram
 
     def validate_config
       unless @config.key?('source')
-        display_error "No source directory specified in the config file"
+        DisplayMessage.error("No source directory specified in the config file")
       end
 
       unless @config.key?('destination')
-        display_error "No destination directory specified in the config"
+        DisplayMessage.error("No destination directory specified in the config")
       end
 
       unless @config.key?('documentation_assets')
-        display_error "No documentation assets directory specified"
-      end
-
-      #Setup some defaults for these guys
-      unless @config.key?('parent_heading_tag')
-        @config['parent_heading_tag'] = 'h1'
-      end
-
-      unless @config.key?('child_heading_tag')
-        @config['child_heading_tag'] = 'h2'
+        DisplayMessage.error("No documentation assets directory specified")
       end
     end
 
@@ -406,31 +337,98 @@ module Hologram
       @supported_extensions.include?(File.extname(file))
     end
 
-    def display_error(message)
-      if RUBY_VERSION.to_f > 1.8 then
-        puts "(\u{256F}\u{00B0}\u{25A1}\u{00B0}\u{FF09}\u{256F}".green + "\u{FE35} \u{253B}\u{2501}\u{253B} ".yellow + " Build not complete.".red
+
+    def get_file_name(str)
+      str = str.gsub(' ', '_').downcase + '.html'
+    end
+
+
+    def get_fh(output_directory, output_file)
+      File.open("#{output_directory}/#{output_file}", 'w')
+    end
+  end
+
+
+  #Helper class for binding things for ERB
+  class TemplateVariables
+    attr_accessor :title, :file_name, :blocks
+
+    def initialize(title, file_name, blocks)
+      @title = title
+      @file_name = file_name
+      @blocks = blocks
+    end
+
+    def get_binding
+      binding()
+    end
+  end
+
+  class DocBlockCollection
+    attr_accessor :doc_blocks
+
+    def initialize
+      @doc_blocks = {}
+    end
+
+    # this should throw an error if we have a match, but no yaml_match
+    def add_doc_block(comment_block)
+      yaml_match = /^\s*---\s(.*?)\s---$/m.match(comment_block)
+      return unless yaml_match
+
+      markdown = comment_block.sub(yaml_match[0], '')
+
+      begin
+        config = YAML::load(yaml_match[1])
+      rescue
+        DisplayMessage.error("Could not parse YAML:\n#{yaml_match[1]}")
+      end
+
+      if config['name'].nil?
+        DisplayMessage.warning("Missing required name config value. This hologram comment will be skipped. \n #{config.inspect}")
       else
-        puts "Build not complete.".red
+        doc_block = DocumentBlock.new(config, markdown)
       end
-        puts " #{message}"
-        exit 1
-    end
 
-    def display_warning(message)
-      puts "Warning: ".yellow + message
+      @doc_blocks[doc_block.name] = doc_block if doc_block.is_valid?
     end
 
+    def create_nested_structure
+      blocks_to_remove_from_top_level = []
+      @doc_blocks.each do |key, doc_block|
+        # don't do anything to top level doc_blocks
+        next if !doc_block.parent
 
-    def get_file_name(str)
-      str = str.gsub(' ', '_').downcase + '.html'
+        parent = @doc_blocks[doc_block.parent]
+        parent.children[doc_block.name] = doc_block
+        doc_block.parent = parent
+        blocks_to_remove_from_top_level << doc_block.name
+      end
+
+      blocks_to_remove_from_top_level.each do |key|
+        @doc_blocks.delete(key)
+      end
     end
+  end
 
+end
 
-    def get_fh(output_directory, output_file)
-      File.open("#{output_directory}/#{output_file}", 'w')
+
+
+class DisplayMessage
+  def self.error(message)
+    if RUBY_VERSION.to_f > 1.8 then
+      puts "(\u{256F}\u{00B0}\u{25A1}\u{00B0}\u{FF09}\u{256F}".green + "\u{FE35} \u{253B}\u{2501}\u{253B} ".yellow + " Build not complete.".red
+    else
+      puts "Build not complete.".red
     end
+      puts " #{message}"
+      exit 1
   end
 
+  def self.warning(message)
+    puts "Warning: ".yellow + message
+  end
 end
 
 

data/lib/hologram/version.rb

@@ -25,5 +25,5 @@
 # ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 module Hologram
-  VERSION = "0.5.9"
+  VERSION = "0.6.0"
 end

data/lib/hologram_markdown_renderer.rb

@@ -1,29 +1,3 @@
-# Copyright (c) 2013, Trulia, Inc.
-# All rights reserved.
-#
-# 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 the Trulia, Inc. 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 TRULIA, INC. 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.
-
 class HologramMarkdownRenderer < Redcarpet::Render::HTML
   def block_code(code, language)
     if language and language.include?('example')
@@ -32,10 +6,38 @@ class HologramMarkdownRenderer < Redcarpet::Render::HTML
         '<script>' + code + '</script>
         <div class="codeBlock jsExample">' + Pygments.highlight(code) + '</div>'
       else
-        '<div class="codeExample">' + '<div class="exampleOutput">' + code + '</div>' + '<div class="codeBlock">' + Pygments.highlight(code) + '</div>' + '</div>'
+        '<div class="codeExample">' + '<div class="exampleOutput">' + render_html(code, language) + '</div>' + '<div class="codeBlock">' + Pygments.highlight(code, :lexer => get_lexer(language)) + '</div>' + '</div>'
       end
     else
       '<div class="codeBlock">' + Pygments.highlight(code) + '</div>'
-    end      
+    end
+  end
+
+  private
+  def render_html(code, language)
+    case language
+      when 'haml_example'
+        safe_require('haml', language)
+        return Haml::Engine.new(code.strip).render(Object.new, {})
+      else
+        code
+    end
+  end
+
+  def get_lexer(language)
+    case language
+      when 'haml_example'
+        'haml'
+      else
+        'html'
+    end
+  end
+
+  def safe_require(templating_library, language)
+    begin
+      require templating_library
+    rescue LoadError
+      raise "#{templating_library} must be present for you to use #{language}"
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hologram
 version: !ruby/object:Gem::Version
-  version: 0.5.9
+  version: 0.6.0
 platform: ruby
 authors:
 - JD Cantrell
@@ -9,76 +9,76 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-05 00:00:00.000000000 Z
+date: 2013-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.2.2
 - !ruby/object:Gem::Dependency
   name: sass
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.7
 - !ruby/object:Gem::Dependency
   name: pygments.rb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Build doc type things
@@ -89,7 +89,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -112,17 +112,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Build document type things.