rocco_rails 0.8

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+gem 'rocco', :git => "git://github.com/rtomayko/rocco.git"
+gem 'rake'
+
+# Specify your gem's dependencies in rocco_rails.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mawi Marin
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# RoccoRails
+
+Rocco customizable addon to generate docco style documentation in rails projects
+
+## What is rocco/docco?
+
+Rocco is  a quick-and-dirty,  literate-programming-style documentation
+generator for Ruby. See the Rocco generated docs for more information:
+
+                <http://rtomayko.github.com/rocco/>
+
+
+Rocco is a port of,  and borrows heavily from, Docco  -- the original
+quick-and-dirty,   hundred-line-long,   literate-programming-style
+documentation generator in CoffeeScript:
+
+                <http://jashkenas.github.com/docco/>
+
+## Installation
+
+Add this lines to your application's Gemfile:
+
+    gem 'rocco', :git => "git://github.com/rtomayko/rocco.git"
+    gem 'rocco_rails', :git => "git://github.com/mawi/rocco_rails.git"
+
+## Usage
+
+### Easy way
+
+To generate application's documentation into 'docs' directory just run:
+
+    rake rails:rocco
+
+### Custom way
+
+rocco_rails uses a rocco.yml config file inside gem directory. It can be customized by copying it to your application's config directory or running rake rails:rocco_setup.
+
+Default rocco.yml:
+
+    output: docs
+    template: lib/templates/layout.mustache
+    resources_path: lib/templates/resources
+    excluded_items: config/, spec/, db/
+
+* output => define target directory
+* template => moustache template used by rocco to generate html
+* resources_path => if you have your own template and want to use your .css or .js just put it into this directory. It will be copied and linked in generated docs
+* excluded_items => A comma separated list of directories not to look into
+
+Your custom rocco.yml doesn't have to have all options. It will merge whit gem's config. Sample rocco.yml would be good if you don't have a custom template.
+
+You can test your rocco.yml running
+
+    rake rails:test_rocco_config
+
+And then, again
+
+    rake rails:rocco
+
+
+## Known issues
+
+Rocco gem that is actualy in rubygems doesn't have the option to select a stylesheet to use. If your generated docs seems to have no style, try to use rocco's github code (see Instalation)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+
+require 'rubygems'
+
+load 'lib/tasks/rocco_tasks.rake'
+
+$LOAD_PATH.unshift 'lib'

data/docs/index.html

@@ -0,0 +1,12 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN"
+   "http://www.w3.org/TR/html4/frameset.dtd">
+<html>
+<head>
+<title> Rocco Documentation </title>
+</head>
+<frameset cols="20%, 80%">
+      <frame src="menu.html">
+      <frame name="rocco" src="">
+</frameset>
+
+</HTML>

data/docs/lib/rocco_rails.html

@@ -0,0 +1,129 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=utf-8">
+  <title>rocco_rails.rb</title>
+  <link rel='stylesheet' href='/Users/mmarin/Work/rocco_rails/docs/resources/rocco.css'>
+
+</head>
+<body>
+
+<div id='container'>
+  <div id="background"></div>
+  <table cellspacing=0 cellpadding=0>
+  <thead>
+    <tr>
+
+      <th class='docs'>
+        <h1>rocco_rails.rb</h1>
+        <p class=hint> lib/rocco_rails.rb </p>
+        </th>
+
+      <th class=code>
+      </th>
+    </tr>
+  </thead>
+  <tbody>
+
+    </tr>
+    <tr id='section-1'>
+      <td class=docs>
+        <div class="pilwrap">
+          <a class="pilcrow" href="#section-1">&#182;</a>
+        </div>
+        
+      </td>
+      <td class=code>
+        <div class='highlight'><pre><span class="nb">require</span> <span class="no">File</span><span class="o">.</span><span class="n">expand_path</span><span class="p">(</span><span class="s1">&#39;../rocco_rails/lib/rocco_rails/version.rb&#39;</span><span class="p">)</span>
+<span class="nb">require</span> <span class="s2">&quot;rocco&quot;</span>
+
+<span class="k">module</span> <span class="nn">RoccoRails</span>
+
+    <span class="k">class</span> <span class="o">&lt;&lt;</span> <span class="nb">self</span>
+    <span class="nb">require</span> <span class="s1">&#39;rocco_rails/railtie&#39;</span> <span class="k">if</span> <span class="n">defined?</span><span class="p">(</span><span class="no">Rails</span><span class="p">)</span>
+    <span class="kp">include</span> <span class="no">Rake</span><span class="o">::</span><span class="no">DSL</span> <span class="k">if</span> <span class="n">defined?</span><span class="p">(</span><span class="no">Rake</span><span class="o">::</span><span class="no">DSL</span><span class="p">)</span></pre></div>
+      </td>
+    </tr>
+    <tr id='section-2'>
+      <td class=docs>
+        <div class="pilwrap">
+          <a class="pilcrow" href="#section-2">&#182;</a>
+        </div>
+        <p>Rocco only use a var named stylesheet supposed to be the path for the stylesheet. This is a little hack to use it to
+ inject a complete directory. Default is /resources</p>
+      </td>
+      <td class=code>
+        <div class='highlight'><pre>    <span class="k">def</span> <span class="nf">generate_resources</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">rocco_out</span><span class="p">)</span>
+      <span class="n">files</span> <span class="o">=</span> <span class="no">Dir</span><span class="o">.</span><span class="n">entries</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> <span class="o">-</span> <span class="o">[</span><span class="s2">&quot;.&quot;</span><span class="p">,</span> <span class="s2">&quot;..&quot;</span><span class="o">]</span>
+      <span class="n">out</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
+      <span class="n">files</span><span class="o">.</span><span class="n">each</span> <span class="k">do</span> <span class="o">|</span><span class="n">file</span><span class="o">|</span>
+          <span class="n">out</span> <span class="o">+=</span> <span class="s2">&quot;&lt;link rel=&#39;stylesheet&#39; href=&#39;</span><span class="si">#{</span><span class="o">[</span><span class="n">rocco_out</span><span class="p">,</span> <span class="n">file</span><span class="o">].</span><span class="n">join</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">)</span><span class="si">}</span><span class="s2">&#39;&gt;</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="k">if</span> <span class="n">file</span><span class="o">.</span><span class="n">end_with?</span><span class="p">(</span><span class="s2">&quot;.css&quot;</span><span class="p">)</span>
+          <span class="n">out</span> <span class="o">+=</span> <span class="s2">&quot;&lt;script src=&#39;</span><span class="si">#{</span><span class="o">[</span><span class="n">rocco_out</span><span class="p">,</span> <span class="n">file</span><span class="o">].</span><span class="n">join</span><span class="p">(</span><span class="s1">&#39;/&#39;</span><span class="p">)</span><span class="si">}</span><span class="s2">&#39;&gt;&lt;/script&gt;</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="k">if</span> <span class="n">file</span><span class="o">.</span><span class="n">end_with?</span><span class="p">(</span><span class="s2">&quot;.js&quot;</span><span class="p">)</span>
+        <span class="k">end</span>
+      <span class="n">out</span>
+
+    <span class="k">end</span>
+
+    <span class="k">def</span> <span class="nf">generate_file_list</span><span class="p">(</span><span class="n">excuded_items</span> <span class="o">=</span> <span class="o">[]</span><span class="p">)</span>
+      <span class="n">rails_files</span> <span class="o">=</span> <span class="no">Dir</span><span class="o">.</span><span class="n">glob</span><span class="p">(</span><span class="no">File</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s2">&quot;**&quot;</span><span class="p">,</span> <span class="s2">&quot;*.rb&quot;</span><span class="p">))</span>
+      <span class="n">excuded_items</span><span class="o">.</span><span class="n">each</span> <span class="k">do</span> <span class="o">|</span><span class="n">excluded</span><span class="o">|</span>
+        <span class="n">rails_files</span><span class="o">.</span><span class="n">delete_if</span><span class="p">{</span><span class="o">|</span><span class="n">x</span><span class="o">|</span> <span class="n">x</span><span class="o">.</span><span class="n">include?</span><span class="p">(</span><span class="n">excluded</span><span class="p">)}</span>
+      <span class="k">end</span>
+      <span class="n">rails_files</span>
+    <span class="k">end</span></pre></div>
+      </td>
+    </tr>
+    <tr id='section-3'>
+      <td class=docs>
+        <div class="pilwrap">
+          <a class="pilcrow" href="#section-3">&#182;</a>
+        </div>
+        <p>http://stackoverflow.com/questions/760233/generate-a-file-list-based-on-an-array</p>
+
+      </td>
+      <td class=code>
+        <div class='highlight'><pre>    <span class="k">def</span> <span class="nf">generate_menu</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
+
+      <span class="n">old_pwd</span> <span class="o">=</span> <span class="no">Dir</span><span class="o">.</span><span class="n">pwd</span>
+      <span class="no">Dir</span><span class="o">.</span><span class="n">chdir</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
+      <span class="n">dirs</span> <span class="o">=</span> <span class="no">Dir</span><span class="o">[</span><span class="s2">&quot;**/*.html&quot;</span><span class="o">]</span>
+      <span class="no">Dir</span><span class="o">.</span><span class="n">chdir</span><span class="p">(</span><span class="n">old_pwd</span><span class="p">)</span>
+
+      <span class="n">tree</span> <span class="o">=</span> <span class="p">{}</span>
+      <span class="n">menu</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
+
+      <span class="n">dirs</span><span class="o">.</span><span class="n">each</span> <span class="k">do</span> <span class="o">|</span><span class="n">path</span><span class="o">|</span>
+        <span class="n">current</span>  <span class="o">=</span> <span class="n">tree</span>
+        <span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;/&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">inject</span><span class="p">(</span><span class="s2">&quot;&quot;</span><span class="p">)</span> <span class="k">do</span> <span class="o">|</span><span class="n">sub_path</span><span class="p">,</span><span class="n">dir</span><span class="o">|</span>
+          <span class="n">sub_path</span> <span class="o">=</span> <span class="n">sub_path</span><span class="o">[</span><span class="mi">0</span><span class="o">]</span> <span class="o">==</span> <span class="p">(</span><span class="s2">&quot;/&quot;</span><span class="p">)</span> <span class="p">?</span> <span class="n">sub_path</span><span class="o">[</span><span class="mi">1</span><span class="o">.</span><span class="n">.</span><span class="o">-</span><span class="mi">1</span><span class="o">]</span> <span class="p">:</span> <span class="n">sub_path</span>
+          <span class="n">sub_path</span> <span class="o">=</span> <span class="no">File</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">sub_path</span><span class="p">,</span> <span class="n">dir</span><span class="p">)</span>
+          <span class="n">current</span><span class="o">[</span><span class="n">sub_path</span><span class="o">]</span> <span class="o">||=</span> <span class="p">{}</span>
+          <span class="n">current</span>  <span class="o">=</span> <span class="n">current</span><span class="o">[</span><span class="n">sub_path</span><span class="o">]</span>
+          <span class="n">sub_path</span>
+        <span class="k">end</span>
+      <span class="k">end</span>
+      <span class="k">return</span> <span class="n">print_tree</span><span class="p">(</span><span class="n">tree</span><span class="p">)</span>
+    <span class="k">end</span>
+
+
+    <span class="kp">protected</span>
+
+    <span class="k">def</span> <span class="nf">print_tree</span><span class="p">(</span><span class="n">node</span><span class="p">)</span>
+      <span class="n">out</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
+      <span class="n">out</span> <span class="o">+=</span> <span class="s2">&quot;&lt;ul&gt;&quot;</span>
+      <span class="n">node</span><span class="o">.</span><span class="n">each_pair</span> <span class="k">do</span> <span class="o">|</span><span class="n">path</span><span class="p">,</span> <span class="n">subtree</span><span class="o">|</span>
+        <span class="n">out</span> <span class="o">+=</span>  <span class="n">path</span><span class="o">.</span><span class="n">end_with?</span><span class="p">(</span><span class="s2">&quot;.html&quot;</span><span class="p">)</span> <span class="p">?</span> <span class="s2">&quot;&lt;li&gt; &lt;a href=&#39;</span><span class="si">#{</span><span class="n">path</span><span class="si">}</span><span class="s2">&#39;&gt; </span><span class="si">#{</span><span class="no">File</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">path</span><span class="p">)</span><span class="si">}</span><span class="s2">&lt;/a&gt;&quot;</span> <span class="p">:</span> <span class="s2">&quot;&lt;li&gt;</span><span class="si">#{</span><span class="no">File</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">path</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span>
+        <span class="n">out</span> <span class="o">+=</span> <span class="n">print_tree</span><span class="p">(</span><span class="n">subtree</span><span class="p">)</span> <span class="k">unless</span> <span class="n">subtree</span><span class="o">.</span><span class="n">empty?</span>
+      <span class="k">end</span>
+      <span class="n">out</span> <span class="o">+=</span> <span class="s2">&quot;&lt;/li&gt;&lt;/ul&gt;&quot;</span>
+      <span class="k">return</span> <span class="n">out</span>
+    <span class="k">end</span>
+
+
+   <span class="k">end</span>
+<span class="k">end</span></pre></div>
+      </td>
+    </tr>
+  </table>
+</div>
+</body>

data/docs/lib/rocco_rails/railtie.html

@@ -0,0 +1,53 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=utf-8">
+  <title>railtie.rb</title>
+  <link rel='stylesheet' href='/Users/mmarin/Work/rocco_rails/docs/resources/rocco.css'>
+
+</head>
+<body>
+
+<div id='container'>
+  <div id="background"></div>
+  <table cellspacing=0 cellpadding=0>
+  <thead>
+    <tr>
+
+      <th class='docs'>
+        <h1>railtie.rb</h1>
+        <p class=hint> lib/rocco_rails/railtie.rb </p>
+        </th>
+
+      <th class=code>
+      </th>
+    </tr>
+  </thead>
+  <tbody>
+
+    </tr>
+    <tr id='section-1'>
+      <td class=docs>
+        <div class="pilwrap">
+          <a class="pilcrow" href="#section-1">&#182;</a>
+        </div>
+        <p>From http://blog.nathanhumbert.com/2010/02/rails-3-loading-rake-tasks-from-gem.html</p>
+
+      </td>
+      <td class=code>
+        <div class='highlight'><pre><span class="nb">require</span> <span class="s1">&#39;rocco_rails&#39;</span>
+<span class="nb">require</span> <span class="s1">&#39;rails&#39;</span>
+<span class="k">module</span> <span class="nn">RoccoRails</span>
+  <span class="k">class</span> <span class="nc">Railtie</span> <span class="o">&lt;</span> <span class="no">Rails</span><span class="o">::</span><span class="no">Railtie</span>
+    <span class="n">railtie_name</span> <span class="ss">:rocco_rails</span>
+
+    <span class="n">rake_tasks</span> <span class="k">do</span>
+      <span class="nb">load</span> <span class="s2">&quot;tasks/rails_tasks.rake&quot;</span>
+    <span class="k">end</span>
+  <span class="k">end</span>
+<span class="k">end</span></pre></div>
+      </td>
+    </tr>
+  </table>
+</div>
+</body>

data/docs/lib/rocco_rails/version.html

@@ -0,0 +1,31 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=utf-8">
+  <title>version.rb</title>
+  <link rel='stylesheet' href='/Users/mmarin/Work/rocco_rails/docs/resources/rocco.css'>
+
+</head>
+<body>
+
+<div id='container'>
+  <div id="background"></div>
+  <table cellspacing=0 cellpadding=0>
+  <thead>
+    <tr>
+
+      <th class='docs'>
+        <h1>version.rb</h1>
+        <p class=hint> lib/rocco_rails/version.rb </p>
+        </th>
+
+      <th class=code>
+      </th>
+    </tr>
+  </thead>
+  <tbody>
+
+    </tr>
+  </table>
+</div>
+</body>

data/docs/lib/tasks/rails_tasks.html

@@ -0,0 +1,136 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=utf-8">
+  <title>rails_tasks.rake</title>
+  <link rel='stylesheet' href='/Users/mmarin/Work/rocco_rails/docs/resources/rocco.css'>
+
+</head>
+<body>
+
+<div id='container'>
+  <div id="background"></div>
+  <table cellspacing=0 cellpadding=0>
+  <thead>
+    <tr>
+
+      <th class='docs'>
+        <h1>rails_tasks.rake</h1>
+        <p class=hint> lib/tasks/rails_tasks.rake </p>
+        </th>
+
+      <th class=code>
+      </th>
+    </tr>
+  </thead>
+  <tbody>
+
+    </tr>
+    <tr id='section-1'>
+      <td class=docs>
+        <div class="pilwrap">
+          <a class="pilcrow" href="#section-1">&#182;</a>
+        </div>
+        <p>Taken from https://github.com/hotsh/rstat.us/blob/master/lib/tasks/rocco.rake and
+https://github.com/rtomayko/rocco/blob/master/lib/rocco/tasks.rb</p>
+      </td>
+      <td class=code>
+        <div class='highlight'><pre><span class="nb">require</span> <span class="s1">&#39;rocco/tasks&#39;</span>
+<span class="nb">require</span> <span class="s1">&#39;erb&#39;</span>
+
+<span class="n">namespace</span> <span class="ss">:rails</span> <span class="k">do</span></pre></div>
+      </td>
+    </tr>
+    <tr id='section-2'>
+      <td class=docs>
+        <div class="pilwrap">
+          <a class="pilcrow" href="#section-2">&#182;</a>
+        </div>
+        <p>If exists a config/rocco.yml in rails path use it</p>
+      </td>
+      <td class=code>
+        <div class='highlight'><pre>    <span class="k">def</span> <span class="nf">load_config</span>
+      <span class="vi">@gem_path</span> <span class="o">=</span> <span class="no">Gem</span><span class="o">.</span><span class="n">loaded_specs</span><span class="o">[</span><span class="s1">&#39;rocco_rails&#39;</span><span class="o">].</span><span class="n">full_gem_path</span> <span class="o">+</span> <span class="s2">&quot;/&quot;</span>
+      <span class="n">gem_config</span> <span class="o">=</span> <span class="no">YAML</span><span class="o">.</span><span class="n">load_file</span><span class="p">(</span><span class="vi">@gem_path</span> <span class="o">+</span> <span class="s2">&quot;lib/config/rocco.yml&quot;</span><span class="p">)</span>
+      <span class="k">begin</span>
+        <span class="vi">@base_path</span> <span class="o">=</span> <span class="no">Rails</span><span class="o">.</span><span class="n">root</span><span class="o">.</span><span class="n">to_s</span> <span class="o">+</span> <span class="s2">&quot;/&quot;</span>
+        <span class="n">rails_config</span> <span class="o">=</span> <span class="no">YAML</span><span class="o">.</span><span class="n">load_file</span><span class="p">(</span><span class="vi">@base_path</span> <span class="o">+</span> <span class="s2">&quot;config/rocco.yml&quot;</span><span class="p">)</span>
+        <span class="vi">@config</span> <span class="o">=</span> <span class="n">gem_config</span><span class="o">.</span><span class="n">merge</span><span class="p">(</span><span class="n">rails_config</span><span class="p">)</span>
+      <span class="k">rescue</span> <span class="no">Exception</span> <span class="o">=&gt;</span> <span class="n">e</span>
+        <span class="vi">@base_path</span> <span class="o">=</span> <span class="vi">@gem_path</span>
+        <span class="vi">@config</span> <span class="o">=</span> <span class="n">gem_config</span>
+      <span class="k">end</span>
+
+      <span class="vi">@out</span> <span class="o">=</span> <span class="vi">@config</span><span class="o">[</span><span class="s2">&quot;output&quot;</span><span class="o">]</span>
+
+      <span class="n">template</span> <span class="o">=</span> <span class="vi">@base_path</span> <span class="o">+</span> <span class="vi">@config</span><span class="o">[</span><span class="s2">&quot;template&quot;</span><span class="o">]</span>
+      <span class="vi">@template</span> <span class="o">=</span> <span class="no">File</span><span class="o">.</span><span class="n">exists?</span><span class="p">(</span><span class="n">template</span><span class="p">)</span> <span class="p">?</span> <span class="n">template</span> <span class="p">:</span> <span class="vi">@gem_path</span> <span class="o">+</span> <span class="vi">@config</span><span class="o">[</span><span class="s2">&quot;template&quot;</span><span class="o">]</span>
+
+      <span class="n">resources_path</span> <span class="o">=</span> <span class="vi">@base_path</span> <span class="o">+</span> <span class="vi">@config</span><span class="o">[</span><span class="s2">&quot;resources_path&quot;</span><span class="o">]</span>
+      <span class="vi">@resources_path</span> <span class="o">=</span> <span class="no">File</span><span class="o">.</span><span class="n">exists?</span><span class="p">(</span><span class="n">resources_path</span><span class="p">)</span> <span class="p">?</span> <span class="n">resources_path</span> <span class="p">:</span> <span class="vi">@gem_path</span> <span class="o">+</span> <span class="vi">@config</span><span class="o">[</span><span class="s2">&quot;resources_path&quot;</span><span class="o">]</span>
+
+      <span class="vi">@excluded_items</span> <span class="o">=</span>  <span class="vi">@config</span><span class="o">[</span><span class="s2">&quot;excluded_items&quot;</span><span class="o">].</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;, &quot;</span><span class="p">)</span>
+
+    <span class="k">end</span>
+
+
+
+    <span class="n">desc</span> <span class="s1">&#39;Build rocco docs&#39;</span>
+    <span class="n">task</span> <span class="ss">:rocco_docs</span>
+
+      <span class="n">load_config</span>
+      <span class="no">Rocco</span><span class="o">::</span><span class="no">Task</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="ss">:rocco_docs</span><span class="p">,</span> <span class="vi">@out</span><span class="p">,</span> <span class="no">RoccoRails</span><span class="o">.</span><span class="n">generate_file_list</span><span class="p">(</span><span class="vi">@excluded_items</span><span class="p">),</span> <span class="p">{</span><span class="ss">:template_file</span> <span class="o">=&gt;</span> <span class="vi">@template</span><span class="p">,</span> <span class="ss">:stylesheet</span> <span class="o">=&gt;</span> <span class="no">RoccoRails</span><span class="o">.</span><span class="n">generate_resources</span><span class="p">(</span><span class="vi">@resources_path</span><span class="p">,</span> <span class="o">[</span><span class="no">Rails</span><span class="o">.</span><span class="n">root</span><span class="o">.</span><span class="n">to_s</span><span class="p">,</span> <span class="vi">@out</span><span class="p">,</span> <span class="s2">&quot;resources&quot;</span><span class="o">].</span><span class="n">join</span><span class="p">(</span><span class="s2">&quot;/&quot;</span><span class="p">))</span> <span class="p">})</span></pre></div>
+      </td>
+    </tr>
+    <tr id='section-3'>
+      <td class=docs>
+        <div class="pilwrap">
+          <a class="pilcrow" href="#section-3">&#182;</a>
+        </div>
+        <p>Copy resources folder to out folder</p>
+
+      </td>
+      <td class=code>
+        <div class='highlight'><pre>      <span class="no">FileUtils</span><span class="o">.</span><span class="n">mkdir_p</span><span class="p">(</span><span class="vi">@out</span> <span class="o">+</span> <span class="s2">&quot;/resources&quot;</span><span class="p">)</span> <span class="k">if</span> <span class="no">Dir</span><span class="o">[</span><span class="vi">@out</span><span class="o">].</span><span class="n">blank?</span>
+      <span class="no">FileUtils</span><span class="o">.</span><span class="n">cp_r</span><span class="p">(</span><span class="vi">@resources_path</span><span class="p">,</span> <span class="vi">@out</span><span class="p">)</span>
+
+
+    <span class="n">desc</span> <span class="s1">&#39;Generates and index.html for a rocco folder&#39;</span>
+    <span class="n">task</span> <span class="ss">:rocco_index</span> <span class="k">do</span>
+      <span class="n">load_config</span>
+      <span class="vi">@menu</span> <span class="o">=</span> <span class="no">RoccoRails</span><span class="o">.</span><span class="n">generate_menu</span><span class="p">(</span><span class="vi">@out</span><span class="p">)</span>
+      <span class="vi">@title</span> <span class="o">=</span> <span class="s2">&quot;Rocco Documentation&quot;</span>
+      <span class="o">[</span><span class="s2">&quot;menu&quot;</span><span class="p">,</span> <span class="s2">&quot;index&quot;</span><span class="o">].</span><span class="n">each</span> <span class="k">do</span> <span class="o">|</span><span class="n">page</span><span class="o">|</span>
+        <span class="n">template</span> <span class="o">=</span> <span class="no">File</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="vi">@gem_path</span> <span class="o">+</span> <span class="s2">&quot;lib/templates/</span><span class="si">#{</span><span class="n">page</span><span class="si">}</span><span class="s2">.erb&quot;</span><span class="p">)</span>
+        <span class="n">html</span> <span class="o">=</span> <span class="no">ERB</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="n">template</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="s2">&quot;%&lt;&gt;&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">result</span>
+        <span class="no">File</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="vi">@out</span> <span class="o">+</span> <span class="s2">&quot;/</span><span class="si">#{</span><span class="n">page</span><span class="si">}</span><span class="s2">.html&quot;</span><span class="p">,</span> <span class="s1">&#39;w&#39;</span><span class="p">)</span> <span class="p">{</span><span class="o">|</span><span class="n">f</span><span class="o">|</span> <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">html</span><span class="p">)</span> <span class="p">}</span>
+      <span class="k">end</span>
+      <span class="no">FileUtils</span><span class="o">.</span><span class="n">cp_r</span><span class="p">(</span><span class="vi">@gem_path</span><span class="o">+</span><span class="s2">&quot;lib/templates/menu_resources/.&quot;</span><span class="p">,</span> <span class="vi">@out</span> <span class="o">+</span> <span class="s2">&quot;/resources&quot;</span><span class="p">)</span>
+
+    <span class="k">end</span>
+
+    <span class="n">desc</span> <span class="s1">&#39;Test actual config.yml&#39;</span>
+    <span class="n">task</span> <span class="ss">:test_rocco_config</span> <span class="k">do</span>
+      <span class="n">load_config</span>
+
+
+      <span class="nb">p</span> <span class="s2">&quot;Template exist =&gt; </span><span class="si">#{</span><span class="no">File</span><span class="o">.</span><span class="n">exists?</span><span class="p">(</span><span class="vi">@template</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span>
+      <span class="nb">p</span> <span class="s2">&quot;Resources exist =&gt; </span><span class="si">#{</span><span class="no">File</span><span class="o">.</span><span class="n">exists?</span><span class="p">(</span><span class="vi">@resources_path</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span>
+      <span class="nb">p</span> <span class="s2">&quot;List of files to generate docs =&gt; </span><span class="si">#{</span><span class="no">RoccoRails</span><span class="o">.</span><span class="n">generate_file_list</span><span class="p">(</span><span class="vi">@excluded_items</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span>
+    <span class="k">end</span>
+
+    <span class="n">desc</span> <span class="s1">&#39;Copy rocco.yml to rails config path&#39;</span>
+    <span class="n">task</span> <span class="ss">:rocco_setup</span> <span class="k">do</span>
+      <span class="n">yml_path</span> <span class="o">=</span> <span class="o">[</span><span class="no">Gem</span><span class="o">.</span><span class="n">loaded_specs</span><span class="o">[</span><span class="s1">&#39;rocco_rails&#39;</span><span class="o">].</span><span class="n">full_gem_path</span><span class="p">,</span> <span class="s2">&quot;lib&quot;</span><span class="p">,</span> <span class="s2">&quot;config&quot;</span><span class="p">,</span> <span class="s2">&quot;rocco.yml.sample&quot;</span><span class="o">].</span><span class="n">join</span><span class="p">(</span><span class="s2">&quot;/&quot;</span><span class="p">)</span>
+      <span class="no">FileUtils</span><span class="o">.</span><span class="n">cp</span><span class="p">(</span><span class="n">yml_path</span><span class="p">,</span> <span class="no">Rails</span><span class="o">.</span><span class="n">root</span><span class="o">.</span><span class="n">to_s</span> <span class="o">+</span> <span class="s2">&quot;/config/rocco.yml&quot;</span><span class="p">)</span>
+      <span class="nb">p</span> <span class="s2">&quot;rocco.yml copied to config/rocco.yml&quot;</span>
+    <span class="k">end</span>
+
+    <span class="n">task</span> <span class="ss">:rocco</span> <span class="o">=&gt;</span> <span class="o">[</span><span class="ss">:rocco_docs</span><span class="p">,</span> <span class="ss">:rocco_index</span><span class="o">]</span>
+
+<span class="k">end</span></pre></div>
+      </td>
+    </tr>
+  </table>
+</div>
+</body>