hologram 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba28330eccb6f989b7d979e73c654ab2d70a34d7
-  data.tar.gz: d754bea437e55dee31fcb283f7957d85e1534b8a
+  metadata.gz: 5d23baf9cab5e0651cfa087dd470867770389fb4
+  data.tar.gz: 69b89861f9dbc9a09dc720d9e6a5e1f9ee3b4485
 SHA512:
-  metadata.gz: bdaf1aa34dd312b82c9fa26db208fc7106756096b30dc02b9050e0bb69ac2a7e5f68492faabe45466603da074e084f5374386db703ef8c73651b4b817167910a
-  data.tar.gz: 76d55b87389c39f9015d84ad0070b54d953cdcf1a5bda3faeb3ccd780846d155fd4ecc73d8dc3c35e27fa11ef9bae63a07bd1d8a8ee5191a3e95354b74589661
+  metadata.gz: 8eeb3b8e627c7f0dbfc5d4b8b73458ea6da97111979cd734e239e7daa34ba1d4304c6accb1488b4404ba23a1c8f581453d420a48b96f99eaa552583fc265fb32
+  data.tar.gz: 84684a77e6dff76831cb74ec9d0cb33ff299b59593c6f4865dc4d0d960217e9a458466980fdf156ed50810b34179339d98845beb274972855574528fa51f4035

data/CHANGELOG.md

@@ -0,0 +1,61 @@
+#Changelog
+
+##1.2.0 - 2014-07-22
+
+JD Cantrell
+* Replace pygments with rouge
+* Add in initial plugin support
+
+Todd Sedano
+* Update specs to use `be_truthy` and `be_falsy` (fixes deprecation
+  warnings)
+
+Carsten Zimmermann
+* Update redcarpet dependency to use newer versions of redcarpet
+
+Geoffrey Giesemann, Vanessa de Sant Anna, Nicole Sullivan
+* Add support for multiple source directories in the hologram config
+
+rishabhsrao
+* Remove the --root command line flag
+
+Marek
+* Add missing div tag in `_header.html`
+
+Todd Sedano, bigethan, August Flanagan, JD Cantrell
+* Many useful readme updates
+
+##1.1.0 - 2014-05-13
+
+Rajan Agaskar, Dominick Reinhold, and Nicole Sullivan
+* Support multiple categories
+* Create assets when output directory does not exist
+
+jho406
+* Major Clean up and refactors
+* Code climate badge
+* Readme updates
+* Spec updates
+
+
+JD Cantrell
+* Use UTF-8 as default encoding
+* Do not error when a directory name matches a supported file type
+* Sort documentation blocks case insensitively
+* Support .erb files
+* Pass in config and full pages object to .erb templates
+* If title does not exist default it to title with underscores
+* Display an error when a documentation block does not have a category
+* Warn when the parent block is specified but could not be found
+* Add -c flag for specifying config (you may still specify the config as
+  the first parameter to hologram)
+
+August Flanagan
+* Remove rspec as a runtime dependency
+
+James Myers & Madhura Bhave
+* A rendering scope can now be defined when using haml_examples
+
+Mike Wilkes
+* Documentation clean ups
+* Fix a typo in the config template

data/README.md

@@ -40,6 +40,19 @@ 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.
 
+Add some documentation to one of your stylesheets:
+
+    /*doc
+    ---
+    title: Alert
+    name: alert
+    category: basics
+    ---
+    ```html_example
+        <div class='alert'>Hello</div>
+    ```
+    */
+
 Building the documentation is simply:
 
 ``` hologram ```
@@ -51,9 +64,6 @@ Hologram has a couple of command line flags:
 
 * `-c` or `--config` - specify the config file, by default hologram
   looks for `hologram_config.yml`
-* `-r` or `--root` - specify the directory to use when processing files
-  (useful if you run hologram in a different directory than your assets.
-  Defaults to current working directory)
 
 ## Details
 
@@ -75,7 +85,8 @@ hologram path/to/your/config.yml`
 
 Your config file needs to contain the following key/value pairs
 
-* **source**: relative path to your source files
+* **source**: relative path(s) to your source files. Accepts either a
+  single value or an array
 
 * **destination**: relative path where you want the documentation to be
   built
@@ -127,6 +138,11 @@ Your config file needs to contain the following key/value pairs
     # The directory containing the source files to parse recursively
     source: ./sass
 
+    # You may alternately specify multiple directories.
+    # source:
+    #  - ./sass
+    #  - ./library-sass
+
     # The directory that hologram will build to
     destination: ./docs
 
@@ -172,6 +188,8 @@ in your configuration.  It will look for comments that match the following:
 
     */
 
+**NB:** Sass users who are using the `.sass` flavor of Sass should use `//doc` style comments with indents to create their comment blocks.
+
 The first section of the comment is a YAML block that defines certain
 aspects of this documentation block (more on that in the next
 section). The second part is simply markdown as defined by Redcarpet.
@@ -256,7 +274,13 @@ The following preprocessors/file types are supported by Hologram:
 - [Guard Hologram](https://github.com/kmayer/guard-hologram) is a sweet
   little gem that uses guard to monitor changes to your hologram project
   and rebuilds your style guide on the fly as you make changes.
-
+- [Grunt Hologram](https://github.com/jchild3rs/grunt-hologram/) is a sweet
+  little grunt task that will generate your hologram style guide.
+- [Classname Clicker](https://github.com/bigethan/hologram-addons/) is a handy
+  UI addition that gives the ability to see rules that apply to a classname by 
+  clicking on them within hologram.
+- [Cortana](https://github.com/Yago/Cortana) is a theme for hologram. It also 
+  includes a handy search feature.
 
 ## Contributing
 
@@ -285,7 +309,11 @@ These fine people have also contributed to making hologram a better gem:
 * [Elana Koren](https://github.com/elanakoren)
 * [Ken Mayer](https://github.com/kmayer)
 * [Roberto Ostinelli](https://github.com/ostinelli)
+* [Dominick Reinhold](https://github.com/d-reinhold)
 * [Nicole Sullivan](https://github.com/stubbornella)
+* [Mike Wilkes](https://github.com/mikezx6r)
+* [Vanessa Sant'Anna](https://github.com/vsanta)
+* [Geoffrey Giesemann](https://github.com/geoffwa)
 
 
 ## License

data/hologram.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |spec|
   spec.homepage      = "http://trulia.github.io/hologram"
   spec.license       = "MIT"
 
-  spec.add_dependency "redcarpet", "~> 2.2"
-  spec.add_dependency "pygments.rb", "~> 0.4"
+  spec.add_dependency "redcarpet", ">= 2.2", "< 4.0"
+  spec.add_dependency "rouge", ">= 1.5"
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = ['hologram']

data/lib/hologram.rb

@@ -1,11 +1,13 @@
 require 'redcarpet'
 require 'yaml'
-require 'pygments'
+require 'rouge'
 require 'fileutils'
 require 'pathname'
 require 'erb'
 
 require 'hologram/version'
+require 'hologram/plugin'
+require 'hologram/plugins'
 require 'hologram/document_block'
 require 'hologram/doc_block_collection'
 require 'hologram/doc_parser'

data/lib/hologram/cli.rb

@@ -10,6 +10,7 @@ module Hologram
 
     def run
       return setup if args[0] == 'init'
+      extra_args = []
 
       #support passing the config file with no command line flag
       config = args[0].nil? ? 'hologram_config.yml' : args[0]
@@ -18,16 +19,21 @@ module Hologram
         opt.on_tail('-h', '--help', 'Show this message.') { puts opt; exit }
         opt.on_tail('-v', '--version', 'Show version.') { puts "hologram #{Hologram::VERSION}"; exit }
         opt.on('-c', '--config FILE', 'Path to config file. Default: hologram_config.yml') { |config_file| config = config_file }
-        opt.parse!(args)
+        begin
+          opt.parse!(args)
+        rescue OptionParser::InvalidOption => e
+          extra_args.push(e.to_s.sub(/invalid option:\s+/, ''))
+        end
+
       end
 
-      config.nil? ? build : build(config)
+      config.nil? ? build(extra_args) : build(extra_args, config)
 
     end
 
     private
-    def build(config = 'hologram_config.yml')
-      builder = DocBuilder.from_yaml(config)
+    def build(extra_args = [], config = 'hologram_config.yml')
+      builder = DocBuilder.from_yaml(config, extra_args)
       DisplayMessage.error(builder.errors.first) if !builder.is_valid?
       builder.build
     rescue CommentLoadError, NoCategoryError => e

data/lib/hologram/doc_block_collection.rb

@@ -16,6 +16,7 @@ module Hologram
       end
 
       @doc_blocks[doc_block.name] = doc_block
+      return doc_block
     end
 
     def create_nested_structure

data/lib/hologram/doc_builder.rb

@@ -4,7 +4,7 @@ module Hologram
     attr_reader :errors
     attr :doc_assets_dir, :output_dir, :input_dir, :header_erb, :footer_erb
 
-    def self.from_yaml(yaml_file)
+    def self.from_yaml(yaml_file, extra_args = [])
 
       #Change dir so that our paths are relative to the config file
       base_path = Pathname.new(yaml_file)
@@ -18,7 +18,7 @@ module Hologram
         'config_yml' => config,
         'base_path' => Pathname.new(yaml_file).dirname,
         'renderer' => Utils.get_markdown_renderer(config['custom_markdown'])
-      ))
+      ), extra_args)
 
     rescue SyntaxError, ArgumentError, Psych::SyntaxError
       raise SyntaxError, "Could not load config file, check the syntax or try 'hologram init' to get started"
@@ -35,17 +35,18 @@ module Hologram
       DisplayMessage.created(new_files)
     end
 
-    def initialize(options)
+    def initialize(options, extra_args = [])
       @pages = {}
       @errors = []
-      @dependencies = options.fetch('dependencies', [])
+      @dependencies = options.fetch('dependencies', nil) || []
       @index = options['index']
       @base_path = options.fetch('base_path', Dir.pwd)
       @renderer = options.fetch('renderer', MarkdownRenderer)
-      @source = options['source']
+      @source = Array(options['source'])
       @destination = options['destination']
       @documentation_assets = options['documentation_assets']
       @config_yml = options['config_yml']
+      @plugins = Plugins.new(options.fetch('config_yml', {}), extra_args)
     end
 
     def build
@@ -70,19 +71,35 @@ module Hologram
     def is_valid?
       errors.clear
       set_dirs
-      errors << "No source directory specified in the config file" if !source
-      errors << "No destination directory specified in the config" if !destination
-      errors << "No documentation assets directory specified" if !documentation_assets
-      errors << "Can not read source directory (#{source}), does it exist?" if source && !input_dir
+      validate_source
+      validate_destination
+      validate_document_assets
+
       errors.empty?
     end
 
     private
 
+    def validate_source
+      errors << "No source directory specified in the config file" if source.empty?
+      source.each do |dir|
+        next if real_path(dir)
+        errors << "Can not read source directory (#{dir}), does it exist?"
+      end
+    end
+
+    def validate_destination
+      errors << "No destination directory specified in the config" if !destination
+    end
+
+    def validate_document_assets
+      errors << "No documentation assets directory specified" if !documentation_assets
+    end
+
     def set_dirs
       @output_dir = real_path(destination)
       @doc_assets_dir = real_path(documentation_assets)
-      @input_dir = real_path(source)
+      @input_dir = multiple_paths(source)
     end
 
     def real_path(dir)
@@ -90,8 +107,12 @@ module Hologram
       Pathname.new(dir).realpath
     end
 
+    def multiple_paths dirs
+      Array(dirs).map { |dir| real_path(dir) }.compact
+    end
+
     def build_docs
-      doc_parser = DocParser.new(input_dir, index)
+      doc_parser = DocParser.new(input_dir, index, @plugins)
       @pages, @categories = doc_parser.parse
 
       if index && !@pages.has_key?(index + '.html')

data/lib/hologram/doc_parser.rb

@@ -3,8 +3,9 @@ module Hologram
     SUPPORTED_EXTENSIONS = ['.css', '.scss', '.less', '.sass', '.styl', '.js', '.md', '.markdown', '.erb' ]
     attr_accessor :source_path, :pages, :doc_blocks
 
-    def initialize(source_path, index_name = nil)
-      @source_path = source_path
+    def initialize(source_path, index_name = nil, plugins)
+      @plugins = plugins
+      @source_paths = Array(source_path)
       @index_name = index_name
       @pages = {}
       @output_files_by_category = {}
@@ -16,7 +17,12 @@ module Hologram
       # 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(source_path)
+
+      doc_block_collection = DocBlockCollection.new
+
+      @source_paths.each do |source_path|
+        process_dir(source_path, doc_block_collection)
+      end
 
       # doc blocks can define parent/child relationships that will nest their
       # documentation appropriately. we can't put everything into that structure
@@ -29,6 +35,8 @@ module Hologram
       # hand off our properly nested collection to the output generator
       build_output(doc_block_collection.doc_blocks)
 
+      @plugins.finalize(@pages)
+
       # if we have an index category defined in our config copy that
       # page to index.html
       if @index_name
@@ -43,9 +51,8 @@ module Hologram
 
     private
 
-    def process_dir(base_directory)
+    def process_dir(base_directory, doc_block_collection)
       #get all directories in our library folder
-      doc_block_collection = DocBlockCollection.new
       directories = Dir.glob("#{base_directory}/**/*/")
       directories.unshift(base_directory)
 
@@ -58,7 +65,6 @@ module Hologram
         files.sort!
         process_files(files, directory, doc_block_collection)
       end
-      doc_block_collection
     end
 
     def process_files(files, directory, doc_block_collection)
@@ -85,8 +91,15 @@ module Hologram
       end
       return unless hologram_comments
 
+
+
       hologram_comments.each do |comment_block|
-        doc_block_collection.add_doc_block(comment_block[0], file)
+        block = doc_block_collection.add_doc_block(comment_block[0], file)
+
+        if (!block.nil?)
+          @plugins.block(block, file)
+        end
+
       end
     end
 
@@ -104,6 +117,7 @@ module Hologram
         end
         build_output(doc_block.children, nil, depth + 1)
       end
+
     end
 
     def is_supported_file_type?(file)

data/lib/hologram/document_block.rb

@@ -23,6 +23,7 @@ module Hologram
     end
 
     def set_members(config, markdown)
+      @config   = config
       @name     = config['name']
       @categories = Array(config['category'] || config['categories'])
       @title    = config['title']

data/lib/hologram/markdown_renderer.rb

@@ -1,16 +1,19 @@
 module Hologram
   class MarkdownRenderer < Redcarpet::Render::HTML
     def block_code(code, language)
+      formatter = Rouge::Formatters::HTML.new(wrap: false)
       if language and language.include?('example')
         if language.include?('js')
+          lexer = Rouge::Lexer.find('js')
           # first actually insert the code in the docs so that it will run and make our example work.
-          '<script>' + code + '</script>
-          <div class="codeBlock jsExample">' + Pygments.highlight(code) + '</div>'
+          '<script>' + code + '</script> <div class="codeBlock jsExample"><div class="highlight"><pre>' + formatter.format(lexer.lex(code)) + '</pre></div></div>'
         else
-          '<div class="codeExample">' + '<div class="exampleOutput">' + render_html(code, language) + '</div>' + '<div class="codeBlock">' + Pygments.highlight(code, :lexer => get_lexer(language)) + '</div>' + '</div>'
+          lexer = Rouge::Lexer.find(get_lexer(language))
+          '<div class="codeExample">' + '<div class="exampleOutput">' + render_html(code, language) + '</div>' + '<div class="codeBlock"><div class="highlight"><pre>' + formatter.format(lexer.lex(code)) + '</pre></div></div>' + '</div>'
         end
       else
-        '<div class="codeBlock">' + Pygments.highlight(code) + '</div>'
+        lexer = Rouge::Lexer.find_fancy('guess', code)
+        '<div class="codeBlock"><div class="highlight"><pre>' + formatter.format(lexer.lex(code)) + '</pre></div></div>'
       end
     end
 

data/lib/hologram/plugin.rb

@@ -0,0 +1,84 @@
+module Hologram
+  class Plugin
+    attr :active, :name
+
+    # Plugin constructor:
+    # +config+: This is the config object generated from the config file
+    # hologram was loaded with
+    # +args+: These are the command line arguments hologram was run with
+    def initialize(config, args)
+      @active = self.get_active(args);
+    end
+
+    def get_active(args)
+      flagged = false
+      OptionParser.new do |opt|
+        opt.on_tail("--#{@name}") { flagged = true }
+        begin
+          opt.parse!(args)
+        rescue OptionParser::InvalidOption
+          flagged = false
+        end
+      end
+
+      return flagged
+    end
+
+    def is_active?()
+      @active
+    end
+
+    def parse_block(comment_block, file)
+
+      plugin_sections = comment_block.markdown.scan(/^\s*\[\[\[plugin:#{Regexp.quote(@name)}(.*?)\]\]\]/m)
+
+      if self.is_active?
+
+        self.block(comment_block, file, !plugin_sections.empty?)
+
+        for section in plugin_sections
+          plugin_data = section[0]
+          replace_text = self.plugin(plugin_data, comment_block, file)
+          comment_block.markdown = comment_block.markdown.gsub("[[[plugin:#{@name}#{plugin_data}]]]", replace_text)
+        end
+      else
+        # plugin is inactive, so remove it from our markdown
+        for section in plugin_sections
+          plugin_data = section[0]
+          comment_block.markdown = comment_block.markdown.gsub("[[[plugin:#{@name}#{plugin_data}]]]", '')
+        end
+      end
+
+    end
+
+    # This is called on every block that hologram parses.
+    # Params:
+    # +comment_block+: This is a doc_block object. It provides name,
+    # children, title, markdown, yml config accessors.
+    # +filename+: The filename for the current file being processed
+    # +has_plugin+: This is a boolean that is true if this comment block
+    # has plugin data for this plugin and false otherwise.
+    def block(comment_block, filename, has_plugin) end
+
+    # This is called everytime parse_block encounters a [[[plugin:name ]]]
+    # section.
+    # Params:
+    # +data+: The text inside the plugin section.
+    # +block+: The current doc_block object
+    # +filename+: The filename of the file the plugin section is in
+    #
+    # Returns: A string that will replace the plugin block in the
+    # documentation
+    def plugin(data, block, filename)
+      return ""
+    end
+
+
+    # This method is called after hologram has processed all the source
+    # files. Pages is a dictionary of html pages to be written. The key is
+    # the file name while the value is the html source.
+    def finalize(pages) end
+
+
+  end
+end

data/lib/hologram/plugins.rb

@@ -0,0 +1,49 @@
+module Hologram
+  class Plugins
+
+    attr_accessor :plugins
+
+    def initialize(config = {}, args)
+      @plugins = []
+
+      if config.has_key?('plugins')
+        for plugin_file in config['plugins']
+          plugin_path = Pathname.new(plugin_file).realpath
+          load plugin_path
+          plugin_class = Utils.get_class_name(plugin_file)
+          register(plugin_class, config, args)
+        end
+      end
+    end
+
+    def register(plugin_class, config, args)
+      clazz = Object.const_get(plugin_class)
+      obj = clazz.new(config, args)
+      if obj.is_active?
+        DisplayMessage.info("Plugin active: #{plugin_class}")
+      else
+        DisplayMessage.info("Plugin not active: #{plugin_class}")
+      end
+
+      @plugins.push(obj)
+    end
+
+    def block(comment_block, file)
+      for plugin in @plugins
+        #We parse comment blocks even when the plugin is not active,
+        #this allows us to remove the plugin's data blocks from the
+        #markdown output
+        plugin.parse_block(comment_block, file)
+      end
+    end
+
+    def finalize(pages)
+      for plugin in @plugins
+        if plugin.is_active?
+          plugin.finalize(pages)
+        end
+      end
+    end
+
+  end
+end

data/lib/hologram/utils.rb

@@ -3,8 +3,9 @@ module Hologram
     def self.get_markdown_renderer(custom_markdown = nil)
       return MarkdownRenderer if custom_markdown.nil?
 
-      load custom_markdown
-      renderer_class = File.basename(custom_markdown, '.rb').split(/_/).map(&:capitalize).join
+      md_file = Pathname.new(custom_markdown).realpath
+      load md_file
+      renderer_class = self.get_class_name(custom_markdown)
       DisplayMessage.info("Custom markdown renderer #{renderer_class} loaded.")
       Module.const_get(renderer_class)
     rescue LoadError => e
@@ -12,5 +13,9 @@ module Hologram
     rescue NameError => e
       DisplayMessage.error("Class #{renderer_class} not found in #{custom_markdown}.")
     end
+
+    def self.get_class_name(file)
+      File.basename(file, '.rb').split(/_/).map(&:capitalize).join
+    end
   end
 end

data/lib/hologram/version.rb

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

data/lib/template/doc_assets/_header.html

@@ -5,19 +5,19 @@
     <link rel="stylesheet" href="./your_stylesheet_here.css">
   </head>
   <body>
+    <div>
+      <nav>
+        <ul>
+        <% @categories.each do |category, file_name| %>
+          <li><a href="<%= file_name %>"><%= category %></a></li>
+        <% end %>
+        </ul>
+      </nav>
 
-    <nav>
-      <ul>
-      <% @categories.each do |category, file_name| %>
-        <li><a href="<%= file_name %>"><%= category %></a></li>
-      <% end %>
-      </ul>
-    </nav>
-
-    <h1>a brand new style guide, it's super effective</h1>
-    <section class="content">
-      <ul>
-      <% @blocks.each do |b| %>
-        <li><a href="#<%= b[:name] %>"><%= b[:title] %></a></li>
-      <% end %>
-      </ul>
+      <h1>a brand new style guide, it's super effective</h1>
+      <section class="content">
+        <ul>
+        <% @blocks.each do |b| %>
+          <li><a href="#<%= b[:name] %>"><%= b[:title] %></a></li>
+        <% end %>
+        </ul>

data/spec/cli_spec.rb

@@ -29,7 +29,7 @@ describe Hologram::CLI do
       subject(:builder) { double(Hologram::DocBuilder, is_valid?: true, build: true) }
 
       it 'builds the documentation' do
-        expect(Hologram::DocBuilder).to receive(:from_yaml).with('test.yml').and_return(builder)
+        expect(Hologram::DocBuilder).to receive(:from_yaml).with('test.yml', []).and_return(builder)
         cli.run
       end
     end

data/spec/display_message_spec.rb

@@ -13,7 +13,7 @@ describe Hologram::DisplayMessage do
 
     it 'sets quiet to true' do
       display.quiet!
-      expect(display.quiet?).to be_true
+      expect(display.quiet?).to be_truthy
     end
   end
 

data/spec/doc_builder_spec.rb

@@ -11,24 +11,34 @@ describe Hologram::DocBuilder do
 
   context '.from_yaml' do
     subject(:builder) { Hologram::DocBuilder }
+    let(:spec_root)   { File.expand_path('../', __FILE__) }
+    let(:tmpdir)      { @tmpdir }
 
-    context 'when passed a valid config file' do
-      let(:config_path) { File.join(Dir.pwd, 'spec/fixtures/source/config.yml') }
-      let(:config_copy_path) { File.join(Dir.pwd, 'spec/fixtures/source/config.yml.copy') }
-
-      around do |example|
-        Dir.mktmpdir do |tmpdir|
-          FileUtils.cp(config_path, config_copy_path)
-          File.open(config_copy_path, 'a'){ |io| io << "destination: #{tmpdir}" }
-          current_dir = Dir.pwd
-          Dir.chdir(tmpdir)
+    around do |example|
+      Dir.mktmpdir do |tmpdir|
+        @tmpdir = tmpdir
+        current_dir = Dir.pwd
 
+        begin
+          Dir.chdir(tmpdir)
           example.run
-
+        ensure
           Dir.chdir(current_dir)
-          FileUtils.rm(config_copy_path)
         end
       end
+    end
+
+    context 'when passed a valid config file' do
+      let(:config_path) { File.join(spec_root, 'fixtures/source/config.yml') }
+      let(:config_copy_path) { File.join(spec_root, 'fixtures/source/config.yml.copy') }
+
+      before do
+        FileUtils.cp(config_path, config_copy_path)
+        File.open(config_copy_path, 'a'){ |io| io << "destination: #{tmpdir}" }
+      end
+      after do
+        FileUtils.rm(config_copy_path)
+      end
 
       it 'returns a DocBuilder instance' do
         expect(subject.from_yaml(config_copy_path)).to be_a Hologram::DocBuilder
@@ -48,6 +58,41 @@ describe Hologram::DocBuilder do
         expect { subject.from_yaml('bad_config.yml') }.to raise_error SyntaxError
       end
     end
+
+    context 'when source option is an array' do
+      let(:config_path) { File.join(spec_root, 'fixtures/source/config_multi_source.yml') }
+      let(:config_copy_path) { File.join(spec_root, 'fixtures/source/config_multi_source.yml.copy') }
+
+      before do
+        FileUtils.cp(config_path, config_copy_path)
+        File.open(config_copy_path, 'a'){ |io| io << "destination: #{tmpdir}" }
+      end
+      after do
+        FileUtils.rm(config_copy_path)
+      end
+
+      it 'returns a DocBuilder instance' do
+        expect(subject.from_yaml(config_copy_path)).to be_a Hologram::DocBuilder
+      end
+    end
+
+    context 'when dependencies is left blank' do
+      let(:yaml) { "dependencies:\n" }
+
+      before do
+        File.open('fixable_bad_config.yml', 'w'){ |io| io << yaml }
+      end
+
+      after do
+        FileUtils.rm('fixable_bad_config.yml')
+      end
+
+      it 'deletes the empty config variable' do
+        builder = subject.from_yaml('fixable_bad_config.yml')
+        expect(builder).to be_a Hologram::DocBuilder
+        expect(builder.dependencies).to eql []
+      end
+    end
   end
 
   context '.setup_dir' do
@@ -66,13 +111,13 @@ describe Hologram::DocBuilder do
     end
 
     it 'creates a config file' do
-      expect(File.exists?('hologram_config.yml')).to be_true
+      expect(File.exists?('hologram_config.yml')).to be_truthy
     end
 
     it 'creates default assets' do
       Dir.chdir('doc_assets') do
         ['_header.html', '_footer.html'].each do |asset|
-          expect(File.exists?(asset)).to be_true
+          expect(File.exists?(asset)).to be_truthy
         end
       end
     end
@@ -107,7 +152,7 @@ describe Hologram::DocBuilder do
 
     context 'when config vars are present and directories exists' do
       it 'returns true' do
-        expect(builder.is_valid?).to be_true
+        expect(builder.is_valid?).to be_truthy
       end
     end
 
@@ -118,7 +163,7 @@ describe Hologram::DocBuilder do
         end
 
         it 'returns false' do
-          expect(builder.is_valid?).to be_false
+          expect(builder.is_valid?).to be_falsy
         end
 
         it 'populates errors' do
@@ -128,13 +173,13 @@ describe Hologram::DocBuilder do
       end
     end
 
-    context "when the source directory does not exist" do
+    context 'when the source directory does not exist' do
       before do
         config['source'] = './foo'
       end
 
       it 'returns false' do
-        expect(builder.is_valid?).to be_false
+        expect(builder.is_valid?).to be_falsy
       end
 
       it 'populates errors' do
@@ -142,6 +187,20 @@ describe Hologram::DocBuilder do
         expect(builder.errors.size).to eql 1
       end
     end
+
+    context 'when source is an array' do
+      let(:config) do
+        {
+          'source' => ['spec/fixtures/source/components', 'spec/fixtures/source/templates'],
+          'documentation_assets' => 'spec/fixtures/source/templates',
+          'base_path' => 'spec/fixtures/source/'
+        }
+      end
+
+      it 'returns true' do
+        expect(builder.is_valid?).to be_truthy
+      end
+    end
   end
 
   context '#build' do
@@ -168,7 +227,7 @@ describe Hologram::DocBuilder do
     it 'builds a styleguide' do
       builder.build
       style_files.each_with_index do |file, index|
-        expect(FileUtils.cmp(file, processed_files[index])).to be_true
+        expect(FileUtils.cmp(file, processed_files[index])).to be_truthy
       end
     end
   end

data/spec/doc_parser_spec.rb

@@ -58,8 +58,14 @@ multi-parent
 
   let(:source_path) { 'spec/fixtures/source' }
   let(:temp_doc) { File.join(source_path, 'components', 'button', 'skin', 'testSkin.css') }
+  let(:plugins) {
+    plugins = double()
+    allow(plugins).to receive(:block)
+    allow(plugins).to receive(:finalize)
+    return plugins
+  }
 
-  subject(:parser) { Hologram::DocParser.new('spec/fixtures/source') }
+  subject(:parser) { Hologram::DocParser.new('spec/fixtures/source/components', nil, plugins) }
 
   context '#parse' do
     let(:result) { parser.parse }
@@ -71,6 +77,15 @@ multi-parent
       expect(output_files_by_category).to be_a Hash
     end
 
+    context "when the source has multiple paths" do
+      subject(:parser) { Hologram::DocParser.new(['spec/fixtures/source/colors', 'spec/fixtures/source/components'], nil, plugins) }
+
+      it "parses all sources" do
+        expect(pages['base_css.html'][:md]).to include 'Base colors'
+        expect(pages['base_css.html'][:md]).to include 'Background Colors'
+      end
+    end
+
     context 'when the component has two categories' do
       around do |example|
         File.open(temp_doc, 'a+'){ |io| io << multi_category_doc }
@@ -85,7 +100,7 @@ multi-parent
 
 
     context 'when an index page is specified' do
-      subject(:parser) { Hologram::DocParser.new('spec/fixtures/source', 'foo') }
+      subject(:parser) { Hologram::DocParser.new('spec/fixtures/source', 'foo', plugins) }
 
       around do |example|
         File.open(temp_doc, 'a+'){ |io| io << doc }

data/spec/fixtures/source/colors/colors.css

@@ -0,0 +1,11 @@
+/*doc
+---
+title: Colors
+name: colors
+category: Base CSS
+---
+
+Base colors
+
+
+*/

data/spec/fixtures/source/config_multi_source.yml

@@ -0,0 +1,19 @@
+# Hologram config
+
+# The directory containing the source files to parse
+source:
+  - ./components
+  - ./templates
+
+# The assets needed to build the docs (includes header.html, footer.html, etc)
+documentation_assets: ./templates
+
+# This is a custom markdown renderer (see Redcarpet documentation for
+# how to do this)
+# custom_markdown: trulia_markdown_renderer.rb
+
+# Any other asset folders that need to be copied to the destination folder
+# This where you should include your full stylesheets, component javascript,
+# libraries and any other dependencies your style guide will have
+dependencies:
+  - ./extra

data/spec/fixtures/styleguide/base_css.html

@@ -90,8 +90,8 @@ specific components and modules on the page.</p>
 use either a <code>&lt;button&gt;</code> or an <code>&lt;a&gt;</code> element:</p>
 <div class="codeExample"><div class="exampleOutput"><button class="btn btnDefault">Click</button>
 <a class="btn btnDefault" href="http://trulia.com">Don't click</a>
-</div><div class="codeBlock"><div class="highlight"><pre><span class="nt">&lt;button</span> <span class="na">class=</span><span class="s">&quot;btn btnDefault&quot;</span><span class="nt">&gt;</span>Click<span class="nt">&lt;/button&gt;</span>
-<span class="nt">&lt;a</span> <span class="na">class=</span><span class="s">&quot;btn btnDefault&quot;</span> <span class="na">href=</span><span class="s">&quot;http://trulia.com&quot;</span><span class="nt">&gt;</span>Don&#39;t click<span class="nt">&lt;/a&gt;</span>
+</div><div class="codeBlock"><div class="highlight"><pre><span class="nt">&lt;button</span> <span class="na">class=</span><span class="s">"btn btnDefault"</span><span class="nt">&gt;</span>Click<span class="nt">&lt;/button&gt;</span>
+<span class="nt">&lt;a</span> <span class="na">class=</span><span class="s">"btn btnDefault"</span> <span class="na">href=</span><span class="s">"http://trulia.com"</span><span class="nt">&gt;</span>Don't click<span class="nt">&lt;/a&gt;</span>
 </pre></div></div></div>
 <p>If your button is actually a link to another page, please use the
 <code>&lt;a&gt;</code> element, while if your button performs an action, such as submitting

data/spec/utils_spec.rb

@@ -44,7 +44,7 @@ describe Hologram::Utils do
         it 'exits' do
           expect {
             utils.get_markdown_renderer('foo')
-          }.to raise_error SystemExit
+          }.to raise_error Errno::ENOENT
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hologram
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - JD Cantrell
@@ -9,36 +9,42 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-13 00:00:00.000000000 Z
+date: 2014-07-22 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'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: '2.2'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: pygments.rb
+  name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +97,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -107,6 +114,8 @@ files:
 - lib/hologram/document_block.rb
 - lib/hologram/errors.rb
 - lib/hologram/markdown_renderer.rb
+- lib/hologram/plugin.rb
+- lib/hologram/plugins.rb
 - lib/hologram/template_variables.rb
 - lib/hologram/utils.rb
 - lib/hologram/version.rb
@@ -121,11 +130,13 @@ files:
 - spec/document_block_spec.rb
 - spec/fixtures/renderer/invalid_renderer.rb
 - spec/fixtures/renderer/valid_renderer.rb
+- spec/fixtures/source/colors/colors.css
 - spec/fixtures/source/components/background/backgrounds.css
 - spec/fixtures/source/components/button/buttons.css
 - spec/fixtures/source/components/button/skin/buttonSkins.css
 - spec/fixtures/source/components/index.md
 - spec/fixtures/source/config.yml
+- spec/fixtures/source/config_multi_source.yml
 - spec/fixtures/source/extra/css/screen.css
 - spec/fixtures/source/templates/_footer.html
 - spec/fixtures/source/templates/_header.html
@@ -170,11 +181,13 @@ test_files:
 - spec/document_block_spec.rb
 - spec/fixtures/renderer/invalid_renderer.rb
 - spec/fixtures/renderer/valid_renderer.rb
+- spec/fixtures/source/colors/colors.css
 - spec/fixtures/source/components/background/backgrounds.css
 - spec/fixtures/source/components/button/buttons.css
 - spec/fixtures/source/components/button/skin/buttonSkins.css
 - spec/fixtures/source/components/index.md
 - spec/fixtures/source/config.yml
+- spec/fixtures/source/config_multi_source.yml
 - spec/fixtures/source/extra/css/screen.css
 - spec/fixtures/source/templates/_footer.html
 - spec/fixtures/source/templates/_header.html