hologram 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e4adec839d8a6a2ae3bdb51fad49eae23e42cf6
-  data.tar.gz: c49899ab9a578374192073286465bdba4a23f340
+  metadata.gz: 16ebbd01d8753357faa113d708de6db358eb48d5
+  data.tar.gz: 627a707329c2d9c7c180dc1f9be75484d905a177
 SHA512:
-  metadata.gz: 80c5363bd1fef75a8547075b37a933bacf209f65e77896898ebb2d7105dcbe22f3c229a094879c4857fa14d9a69e7fbf6f19ee9145abd26a1b47d73dea6cda20
-  data.tar.gz: 9ba3a7facb16ba43a823fcc4d797e8ce95ad824c9a860470b5e065fd8b5a7e57240a8e16ba4d66925724610f70ea6fdad2a2901acc769a83dd8596154c3e6e58
+  metadata.gz: 0ecc0c2b05e8084d25db8676e223b15079382ec1d280b7d02a47a0a674f0e70b775782cfa3fc694996955244e043eb6b2bc51ab615db29e2ed8350dc5ffa5ab1
+  data.tar.gz: 0592999624d28e95c2e80f0d969082a13fec850b0613a7a39c43920b9f8dd25c3ae606e730d966945a612fe476773d868145dbedf8e36bf818f628f8c3313be6

data/README.md

@@ -1,6 +1,10 @@
 # Hologram
 
-Hologram is a Ruby gem that parses comments in your CSS and turns them into a beautiful style guide.
+Hologram is a Ruby gem that parses comments in your CSS and helps you turns them into a beautiful style guide.
+
+There are two steps to building a great style guide: 1.) documenting your css and generating html examples, and 2.) actually styling the output of step 1.
+
+The hologram gem itself is only concerned with step 1. This means you are free to make your style guide look however you would like. If you don't feel like going through this process yourself you can take a look at the templates in our [example repository](https://github.com/trulia/hologram-example/tree/gh-pages/hologram_assets/doc_assets/css) and use the assets defined there instead.
 
 ## Installation
 
@@ -11,7 +15,7 @@ Add this line to your application's Gemfile:
 And then execute:
 
     $ bundle
-    
+
 If you don't use bundler you can run `gem install hologram`.
 
 ## Usage
@@ -21,11 +25,11 @@ There are two things you need to do to start using hologram:
 1. Create a YAML config file for your project
 
 2. Document yourself some code
- 
+
 ### Creating a YAML config file
 
 Hologram needs a few configuration settings before it can begin to build
-your documentation for you. Once this is set up you can execute hologram by 
+your documentation for you. Once this is set up you can execute hologram by
 simply running:
 
 `hologram path/to/your/config.yml` or (using bundler) `bundle exec hologram path/to/your/config.yml`
@@ -41,12 +45,12 @@ Your config file needs to contain the following key/value pairs
   the documentaiton page. This typically includes html fragments (header/footer, etc),
   styleguide specific CSS, javascript and any images.
 
-* **custom_markdown**: (optional) this is the filename of a class that extends 
+* **custom_markdown**: (optional) this is the filename of a class that extends
   RedCarpet::Render::HTML class. Use this for when you need
   additional classes or html tags for different parts of the page.
 
 * **dependencies**: a **list** of relative pathes to a folderes containing any dependencies your style guide has.
-These folders will be copied over into the documentation output directory. 
+These folders will be copied over into the documentation output directory.
 PUT THE CSS/JS THAT IS ACTUALLY BEING DOCUMENTED HERE
 
 ##### Example config file
@@ -59,7 +63,7 @@ PUT THE CSS/JS THAT IS ACTUALLY BEING DOCUMENTED HERE
 
     # The assets needed to build/style the docs (includes header.html, footer.html, etc)
     documentation_assets: ../hologram_assets
-    
+
     # A custom markdown renderer that extends `RedCarpet::Render::HTML class`
     custom_markdown: trulia_markdown_renderer.rb
 
@@ -72,24 +76,24 @@ PUT THE CSS/JS THAT IS ACTUALLY BEING DOCUMENTED HERE
 
 ###Documenting your styles
 
-Hologram will scan any css/scss/less files within your **source** directory. 
+Hologram will scan any css/scss/less files within your **source** directory.
 It will look for comments that match the following:
 
     /*doc
-    --- 
-    title: Buttons 
-    name: button 
-    category: Base CSS 
+    ---
+    title: Buttons
+    name: button
+    category: Base CSS
     ---
 
     Button styles can be applied to any element. Typically you'll want
     to use either a `<button>` or an `<a>` element:
 
-    ```html_example 
+    ```html_example
       <button class="btn btnDefault">Click</button>
-      <a class="btn btnDefault" href="trulia.com">Trulia!</a> 
+      <a class="btn btnDefault" href="trulia.com">Trulia!</a>
     ```
-    
+
     If your button is actually a link to another page, please use the
     `<a>` element, while if your button performs an action, such as
     submitting a form or triggering some javascript event, then use a
@@ -99,7 +103,7 @@ 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
-markdown as defined by Redcarpet. 
+markdown as defined by Redcarpet.
 
 ####Document YAML section
 The yaml in the doc block can have any key value pair you deem important
@@ -119,21 +123,21 @@ but it specifically looks for the following keys:
 ###Documentation Assets
 
 The documentation assets folder contains the html, css, js and images
-you'll need for making your style guide look beautiful. 
+you'll need for making your style guide look beautiful.
 
-Hologram doesn't care too much about to what is in here as it is intended 
-to be custom for your style guide. 
+Hologram doesn't care too much about to what is in here as it is intended
+to be custom for your style guide.
 
-However, it does look for two files called header.html and footer.html. 
-These are html fragments that will be used when creating a new category page. 
+However, it does look for two files called header.html and footer.html.
+These are html fragments that will be used when creating a new category page.
 `header.html` will be copied to the beginning to the page and `footer.html`
-will be copied to the bottom of the page. This gives you control of how you 
-will navigate your docs and lets you include any css, disclaimer text, and 
+will be copied to the bottom of the page. This gives you control of how you
+will navigate your docs and lets you include any css, disclaimer text, and
 whatever else you need on each page.
 
 #####Styling Your Code Examples
 
-Hologram uses [pygments.rb](https://github.com/tmm1/pygments.rb) gem to provide 
+Hologram uses [pygments.rb](https://github.com/tmm1/pygments.rb) gem to provide
 syntax highlighting for code examples. One of the assets that you probably want
 to include in your documentation assets folder is a css file that styles the
 "pygmentized" code examples. We use `github.css` which can be found along with the

data/lib/hologram.rb

@@ -103,7 +103,7 @@ module Hologram
       if config['dependencies']
         config['dependencies'].each do |dir|
           dirpath  = Pathname.new(dir).realpath
-          if Dir.exists?("#{dir}")
+          if File.directory?("#{dir}")
             `rm -rf #{output_directory}/#{dirpath.basename}`
             `cp -R #{dirpath} #{output_directory}/#{dirpath.basename}`
           end
@@ -165,7 +165,13 @@ module Hologram
       yaml_match = /^\s*---\s(.*?)\s---$/m.match(comment_block)
       return unless yaml_match
       markdown = comment_block.sub(yaml_match[0], '')
-      config = YAML::load(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
@@ -276,7 +282,11 @@ module Hologram
     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
+      else
+        puts "Build not complete.".red
+      end
         puts " #{message}"
         exit 1
     end

data/lib/hologram/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hologram
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - JD Cantrell
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-12 00:00:00.000000000 Z
+date: 2013-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet