hologram 0.5.3 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16ebbd01d8753357faa113d708de6db358eb48d5
-  data.tar.gz: 627a707329c2d9c7c180dc1f9be75484d905a177
+  metadata.gz: 44fd37424aab536da5370b6abfbc8c5a68822f13
+  data.tar.gz: 04896bbf8a01403e51749ba13b2f090fb2472c10
 SHA512:
-  metadata.gz: 0ecc0c2b05e8084d25db8676e223b15079382ec1d280b7d02a47a0a674f0e70b775782cfa3fc694996955244e043eb6b2bc51ab615db29e2ed8350dc5ffa5ab1
-  data.tar.gz: 0592999624d28e95c2e80f0d969082a13fec850b0613a7a39c43920b9f8dd25c3ae606e730d966945a612fe476773d868145dbedf8e36bf818f628f8c3313be6
+  metadata.gz: 0a356a2e50be8c1e95c3912482d29cfb400a6bff706343fd69a1791d37cab3f4224d1084094634303b714a11967b1c60d07a9946bc45928149104c392acb9ccc
+  data.tar.gz: c6a79b44f60c67445b05f084c4d6efe62a7442f136c2596e9c9db571f536fb95b615b99bc3db528bd695b9516b64e481bc0e4542232fefedf6dba49a43d805e8

data/README.md

@@ -4,7 +4,7 @@ Hologram is a Ruby gem that parses comments in your CSS and helps you turns them
 
 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.
+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](https://github.com/trulia/hologram-example/tree/master/templates) in our [example repository](https://github.com/trulia/hologram-example) and use the assets defined there instead.
 
 ## Installation
 
@@ -143,6 +143,16 @@ 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
 css we use to style code blocks [here](https://github.com/trulia/hologram-example/tree/gh-pages/hologram_assets/doc_assets/css).
 
+## Supported Preprocessors/File Types
+
+The following preprocessors/file types are supported by Hologram:
+- Sass (.scss, .sass)
+- Less (.less)
+- Stylus (.styl)
+- Vanilla CSS (.css)
+- Javascript (.js)
+- Markdown (.md, .markdown)
+
 ## Contributing
 
 1. Fork it

data/lib/hologram.rb

@@ -64,6 +64,8 @@ module Hologram
 
     def init(args)
       @doc_blocks, @pages = {}, {}
+      @supported_extensions = ['.css', '.scss', '.less', '.sass', '.styl', '.js', '.md', '.markdown' ]
+
       begin
         @config = args ? YAML::load_file(args[0]) : YAML::load_file('hologram_config.yml')
         validate_config
@@ -92,7 +94,12 @@ module Hologram
 
       input_directory  = Pathname.new(config['source']).realpath
       output_directory = Pathname.new(config['destination']).realpath
-      doc_assets       = Pathname.new(config['documentation_assets']).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']}"
+      end
 
       process_dir(input_directory)
 
@@ -110,11 +117,13 @@ module Hologram
         end
       end
 
-      Dir.foreach(doc_assets) do |item|
-       # ignore . and .. directories
-       next if item == '.' or item == '..'
-       `rm -rf #{output_directory}/#{item}`
-       `cp -R #{doc_assets}/#{item} #{output_directory}/#{item}`
+      if !doc_assets.nil?
+        Dir.foreach(doc_assets) do |item|
+         # ignore . and .. directories
+         next if item == '.' or item == '..'
+         `rm -rf #{output_directory}/#{item}`
+         `cp -R #{doc_assets}/#{item} #{output_directory}/#{item}`
+        end
       end
     end
 
@@ -149,8 +158,14 @@ module Hologram
 
     def process_file(file)
       file_str = File.read(file)
-      # get any comment blocks that match the pattern /*doc ... */
-      hologram_comments = file_str.scan(/^\s*\/\*doc(.*?)\*\//m)
+      # get any comment blocks that match the patterns:
+      # .sass: //doc (follow by other lines proceeded by a space) 
+      # other types: /*doc ... */
+      if file.end_with?('.sass')
+        hologram_comments = file_str.scan(/\s*\/\/doc\s*((( [^\n]*\n)|\n)+)/)
+      else
+        hologram_comments = file_str.scan(/^\s*\/\*doc(.*?)\*\//m)
+      end
       return unless hologram_comments
 
       hologram_comments.each do |comment_block|
@@ -228,6 +243,8 @@ module Hologram
         # generate doc nav html
         if File.exists?("#{doc_assets}/header.html")
           fh.write(File.read("#{doc_assets}/header.html"))
+        else
+          display_warning "No header.html found in documentation assets. Without this your css/header will not be included on the generated pages."
         end
 
         # write the docs
@@ -236,6 +253,8 @@ module Hologram
         # write the footer
         if File.exists?("#{doc_assets}/footer.html")
           fh.write(File.read("#{doc_assets}/footer.html"))
+        else
+          display_warning "No footer.html found in documentation assets. This might be okay to ignore..."
         end
         fh.close()
       end
@@ -277,8 +296,7 @@ module Hologram
 
 
     def is_supported_file_type?(file)
-      supported_extensions = ['.css', '.scss', '.less', '.sass', '.js', '.md', '.markdown' ]
-      supported_extensions.include?(File.extname(file))
+      @supported_extensions.include?(File.extname(file))
     end
 
     def display_error(message)
@@ -291,6 +309,10 @@ module Hologram
         exit 1
     end
 
+    def display_warning(message)
+      puts "Warning: ".yellow + message
+    end
+
 
     def get_file_name(str)
       str = str.gsub(' ', '_').downcase + '.html'

data/lib/hologram/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hologram
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors:
 - JD Cantrell
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-20 00:00:00.000000000 Z
+date: 2013-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -119,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Build document type things.