hologram 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76d2ba97aebf57d28a1af14bb938face091b9f7a
-  data.tar.gz: 4c257fc06a73984a890d15d11e42f46ae5150203
+  metadata.gz: df438fa1f7fdc30768d2cb9981932488d74ca9ae
+  data.tar.gz: cd01a07f936c9750d9a13146684bc9740a0723fc
 SHA512:
-  metadata.gz: 21c7f40342561dd6ea32edaf1e76390f08d0b7dfbb2c64fce8e60596227e2a562e90cde16478e052930a4205dbcae738385943da5eec8eeb23bdf06209f7a323
-  data.tar.gz: 56dc6706a6ff01a7bcbfbe874f27d6c5bd5723cd809c9fe976be6027b0f92a1fff4610f20f34280ffaf13f1c7fe001cafa3a725a0ce6fdcb9613ed6c61f8808f
+  metadata.gz: 57a3a103b3f2af2580d0228c39f1ac74cf82d54e55e8cf6fc7b35b6a185c7d156e14809bdb0cc7111d409322e2179606fd3f0c95ab025d86139412ba5eac844d
+  data.tar.gz: 9dc0380bfce972458b69743ba4002ce376de9c1a335c8c65979203f9714bd93d4505e8b5b6ee635868c490b16a3154df19fbc2c40a3ab40ed42e3a8ddb6734a6

data/.travis.yml

@@ -0,0 +1,10 @@
+script: "bundle exec rake spec"
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - rbx
+
+notifications:
+  email: false

data/README.md

@@ -1,4 +1,4 @@
-# Hologram
+# Hologram [![Build Status](https://travis-ci.org/trulia/hologram.png)](https://travis-ci.org/trulia/hologram)
 
 Hologram is a Ruby gem that parses comments in your CSS and helps you turn them into a beautiful style guide.
 
@@ -69,10 +69,15 @@ Your config file needs to contain the following key/value pairs
   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
-  documenation block on the page. Each item in the list has a `title`,
-  `name`, `category`, and optionally a `parent`. This is useful for, say, building a menu that lists each component.
+  as ERB files for each page that is generated. You can access the
+  `title`, `file_name`, `blocks`, and `categories`.
+
+  `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`. This is useful for,
+  say, building a menu that lists each component.
+
+  `categories` is a list of all the categories found in the documentation
+
   **Nota Bene:** Filenames that begin with underscores will not be copied into the destination folder.
 
 
@@ -110,7 +115,7 @@ Your config file needs to contain the following key/value pairs
 
 ###Documenting your styles
 
-Hologram will scan your .css|.scss|.sass|.less|.styl files within your **source** directory.
+Hologram will scan for stylesheets (.css, .scss, .sass, .less, or .styl) within the **source** directory defined in you configuraiton.
 It will look for comments that match the following:
 
     /*doc
@@ -139,10 +144,10 @@ The first section of the comment is a yaml block that defines certain
 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.
+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 javascript. In addition to outputing the javascript 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
+The yaml in the documention block can have any key value pair you deem important
 but it specifically looks for the following keys:
 
 * **title**: The title to display in the documents

data/lib/hologram/doc_builder.rb

@@ -20,21 +20,28 @@ module Hologram
 
             begin
               @config = YAML::load_file(config_file)
+            rescue SyntaxError => e
+              DisplayMessage.error("Could not load config file, check the syntax or try 'hologram init' to get started")
             rescue
               DisplayMessage.error("Could not load config file, try 'hologram init' to get started")
             end
 
-            validate_config
+            if @config.is_a? Hash
 
-            current_path = Dir.pwd
-            base_path = Pathname.new(config_file)
-            Dir.chdir(base_path.dirname)
+              validate_config
 
-            # the real work happens here.
-            build_docs
+              current_path = Dir.pwd
+              base_path = Pathname.new(config_file)
+              Dir.chdir(base_path.dirname)
 
-            Dir.chdir(current_path)
-            DisplayMessage.success("Build completed. (-: ")
+              # the real work happens here.
+              build_docs
+
+              Dir.chdir(current_path)
+              DisplayMessage.success("Build completed. (-: ")
+            else
+              DisplayMessage.error("Could not read config file, check the syntax or try 'hologram init' to get started")
+            end
           rescue RuntimeError => e
             DisplayMessage.error("#{e}")
           end

data/lib/hologram/version.rb

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

data/spec/display_message_spec.rb

@@ -62,7 +62,7 @@ describe Hologram::DisplayMessage do
     end
 
     it 'displays an error in red' do
-      expect(display).to receive(:puts).with("\e[32m(╯°□°）╯\e[0m\e[31m︵ ┻━┻ \e[0m\e[31m Build not complete.\e[0m")
+      expect(display).to receive(:puts).with("\e[32m(\u{256F}\u{00B0}\u{25A1}\u{00B0}\u{FF09}\u{256F}\e[0m\e[31m\u{FE35} \u{253B}\u{2501}\u{253B} \e[0m\e[31m Build not complete.\e[0m")
       expect(display).to receive(:puts).with(" foo")
 
       begin

data/spec/doc_parser_spec.rb

@@ -35,11 +35,15 @@ eos
 
   context '#parse' do
     let(:result) { parser.parse }
+    let(:pages) { result[0] }
+    let(:categories) { result[1] }
 
-    it 'builds and returns a hash of pages' do
-      expect(result).to be_a Hash
+    it 'builds and returns a hash of pages and a hash of categories' do
+      expect(pages).to be_a Hash
+      expect(categories).to be_a Hash
     end
 
+
     context 'when an index page is specified' do
       subject(:parser) { Hologram::DocParser.new('spec/fixtures/source', 'foo') }
 
@@ -50,7 +54,7 @@ eos
       end
 
       it 'uses that page as the index' do
-        expect(result['index.html'][:md]).to include 'Markdown stuff'
+        expect(pages['index.html'][:md]).to include 'Markdown stuff'
       end
     end
 
@@ -62,7 +66,7 @@ eos
       end
 
       it 'takes the category in a collection and treats them as the page names' do
-        expect(result.keys).to include 'foo.html'
+        expect(pages.keys).to include 'foo.html'
       end
     end
 
@@ -78,11 +82,11 @@ eos
       end
 
       it 'appends the child doc to the category page' do
-        expect(result['base_css.html'][:md]).to include 'Some other style'
+        expect(pages['base_css.html'][:md]).to include 'Some other style'
       end
 
       it 'assigns the child doc a deeper header' do
-        expect(result['base_css.html'][:md]).to include '<h2 id="otherStyle">Some other style</h2>'
+        expect(pages['base_css.html'][:md]).to include '<h2 id="otherStyle">Some other style</h2>'
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hologram
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - JD Cantrell
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-27 00:00:00.000000000 Z
+date: 2014-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -90,6 +90,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md