Hologram always assumes ERB files should be executed

[adamsanderson]

This might be a bit tricky to get right, but it appears that as of v1.1.0, Hologram assumes that any ERB file should be executed to generate a page in the style guide.

This probably makes sense if you're using it to generate a sample JSON file to give some JS something to play with, but it breaks Rails assets that use ERB. For instance, one might have a file like sprites.css.erb, which is a CSS file that relies on Rails helpers.

If any files like this exist in the directory specified by source in the yaml config, Hologram will either generate a sprites.css file in destination directory, or crash if the file needs any Rails helpers.

Perhaps Hologram's DocBuilder could only call write_erb if the file looks like it's either a straight ERB file, ie: readme.erb or an html erb file like readme.html.erb, and just document the file otherwise.

[jdcantrell]

Ah thanks for the info.

We might be able to handle this using some config flags. I'll think about this for a little while and see if we can get a point release with a fix this week,

Config idea for now:

process_erb_files: true
exclude_erb:
 - sprice.css.erb

By default we would not process erb files, but if the config flag is set we will process everything that is not listed in the excludes list.

[adamsanderson]

You could also probably add an exclude_processing option that takes a glob, ie:

exclude_processing: *.{css,js}.erb

Then test it with File.fnmatch(glob, path).

[jdcantrell]

Went with:

ignore_paths:
  - "*.erb"
  - my_file.scss

[jdcantrell]

Went with:

ignore_paths:
  - "*.erb"
  - my_file.scss

[jdcantrell]

Went with:

ignore_paths:
  - "*.erb"
  - my_file.scss

[adamsanderson]

Hey, thanks for taking care of this.

[jdcantrell]

NP! Sorry for the triple comment, not sure what I was doing when that happened.

[wwcline]

Adding the ignore_paths option in #213 solves the problem where you don't want Hologram to treat every ERb as if it were a style guide page, but it also seems to prevent Hologram from processing documentation blocks inside ERb files.

For instance, one might have a file like sprites.css.erb, which is a CSS file that relies on Rails helpers.

In my case, I have .css.erb files that contain documentation blocks. Hologram is processing the ERb and putting files like sprites.css in my output directory. I can stop that behavior by setting ignore_paths but in neither case will sprites.css.erb’s documentation blocks appear anywhere in the output pages.

[wwcline]

The problematic code seems to be this:

https://github.com/trulia/hologram/blob/master/lib/hologram/doc_parser.rb#L89

Am I correct in understanding that *.erb files will never be scanned for documentation blocks, as Hologram works currently?