rocco_rails 0.8.1 → 0.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/README.md +20 -2
- data/docs/README.html +112 -0
- data/docs/index.html +2 -2
- data/docs/lib/rocco_rails/railtie.html +12 -4
- data/docs/lib/tasks/rails_tasks.html +9 -0
- data/docs/lib/tasks/rocco_tasks.html +9 -1
- data/docs/menu.html +1 -1
- data/lib/config/rocco.yml +1 -0
- data/lib/config/rocco.yml.sample +3 -1
- data/lib/rocco_rails/railtie.rb +1 -1
- data/lib/rocco_rails/version.rb +1 -1
- data/lib/tasks/rails_tasks.rake +9 -0
- data/lib/tasks/rocco_tasks.rake +9 -1
- data/lib/templates/index.erb +1 -1
- data/rocco_rails.gemspec +1 -0
- metadata +100 -52
data/README.md
CHANGED
|
@@ -21,7 +21,7 @@ documentation generator in CoffeeScript:
|
|
|
21
21
|
Add this lines to your application's Gemfile:
|
|
22
22
|
|
|
23
23
|
gem 'rocco', :git => "git://github.com/rtomayko/rocco.git"
|
|
24
|
-
gem 'rocco_rails'
|
|
24
|
+
gem 'rocco_rails', '~> 0.9'
|
|
25
25
|
|
|
26
26
|
## Usage
|
|
27
27
|
|
|
@@ -41,11 +41,13 @@ Default rocco.yml:
|
|
|
41
41
|
template: lib/templates/layout.mustache
|
|
42
42
|
resources_path: lib/templates/resources
|
|
43
43
|
excluded_items: config/, spec/, db/
|
|
44
|
+
index: README.rdoc
|
|
44
45
|
|
|
45
46
|
* output => define target directory
|
|
46
47
|
* template => moustache template used by rocco to generate html
|
|
47
48
|
* 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
|
|
48
49
|
* excluded_items => A comma separated list of directories not to look into
|
|
50
|
+
* index => Readme/info of the project. Added as home page in index.html. Uses github gem, so the same style can be used.
|
|
49
51
|
|
|
50
52
|
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.
|
|
51
53
|
|
|
@@ -60,7 +62,9 @@ And then, again
|
|
|
60
62
|
|
|
61
63
|
## Known issues
|
|
62
64
|
|
|
63
|
-
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)
|
|
65
|
+
- 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)
|
|
66
|
+
|
|
67
|
+
- README files (without extension) are not rendered well. Try to rename to README.rdoc
|
|
64
68
|
|
|
65
69
|
## Demo
|
|
66
70
|
|
|
@@ -69,6 +73,20 @@ You can see a demo of autogenerated gem documentation in
|
|
|
69
73
|
http://mawi.github.com/rocco_rails/
|
|
70
74
|
|
|
71
75
|
|
|
76
|
+
## Changelog
|
|
77
|
+
|
|
78
|
+
### v0.9
|
|
79
|
+
- Added support for project's README as home page redered with github gem.
|
|
80
|
+
- Fix issue #1
|
|
81
|
+
|
|
82
|
+
### v0.8.1
|
|
83
|
+
- **Mayor fix** Gem is not loaded properly
|
|
84
|
+
|
|
85
|
+
### v0.8
|
|
86
|
+
- **Initial release**
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
72
90
|
## Contributing
|
|
73
91
|
|
|
74
92
|
1. Fork it
|
data/docs/README.html
ADDED
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
<h1>RoccoRails</h1>
|
|
2
|
+
|
|
3
|
+
<p>Rocco customizable addon to generate docco style documentation in rails projects</p>
|
|
4
|
+
|
|
5
|
+
<h2>What is rocco/docco?</h2>
|
|
6
|
+
|
|
7
|
+
<p>Rocco is a quick-and-dirty, literate-programming-style documentation
|
|
8
|
+
generator for Ruby. See the Rocco generated docs for more information:</p>
|
|
9
|
+
|
|
10
|
+
<pre><code> <http://rtomayko.github.com/rocco/>
|
|
11
|
+
</code></pre>
|
|
12
|
+
|
|
13
|
+
<p>Rocco is a port of, and borrows heavily from, Docco -- the original
|
|
14
|
+
quick-and-dirty, hundred-line-long, literate-programming-style
|
|
15
|
+
documentation generator in CoffeeScript:</p>
|
|
16
|
+
|
|
17
|
+
<pre><code> <http://jashkenas.github.com/docco/>
|
|
18
|
+
</code></pre>
|
|
19
|
+
|
|
20
|
+
<h2>Installation</h2>
|
|
21
|
+
|
|
22
|
+
<p>Add this lines to your application's Gemfile:</p>
|
|
23
|
+
|
|
24
|
+
<pre><code>gem 'rocco', :git => "git://github.com/rtomayko/rocco.git"
|
|
25
|
+
gem 'rocco_rails', '~> 0.8.1'
|
|
26
|
+
</code></pre>
|
|
27
|
+
|
|
28
|
+
<h2>Usage</h2>
|
|
29
|
+
|
|
30
|
+
<h3>Easy way</h3>
|
|
31
|
+
|
|
32
|
+
<p>To generate application's documentation into 'docs' directory just run:</p>
|
|
33
|
+
|
|
34
|
+
<pre><code>rake rails:rocco
|
|
35
|
+
</code></pre>
|
|
36
|
+
|
|
37
|
+
<h3>Custom way</h3>
|
|
38
|
+
|
|
39
|
+
<p>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.</p>
|
|
40
|
+
|
|
41
|
+
<p>Default rocco.yml:</p>
|
|
42
|
+
|
|
43
|
+
<pre><code>output: docs
|
|
44
|
+
template: lib/templates/layout.mustache
|
|
45
|
+
resources_path: lib/templates/resources
|
|
46
|
+
excluded_items: config/, spec/, db/
|
|
47
|
+
index: README.rdoc
|
|
48
|
+
</code></pre>
|
|
49
|
+
|
|
50
|
+
<ul>
|
|
51
|
+
<li>output => define target directory</li>
|
|
52
|
+
<li>template => moustache template used by rocco to generate html</li>
|
|
53
|
+
<li>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</li>
|
|
54
|
+
<li>excluded_items => A comma separated list of directories not to look into</li>
|
|
55
|
+
<li>index => Readme/info of the project. Added as home page in index.html. Uses github gem, so the same style can be used.</li>
|
|
56
|
+
</ul>
|
|
57
|
+
|
|
58
|
+
<p>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.</p>
|
|
59
|
+
|
|
60
|
+
<p>You can test your rocco.yml running</p>
|
|
61
|
+
|
|
62
|
+
<pre><code>rake rails:test_rocco_config
|
|
63
|
+
</code></pre>
|
|
64
|
+
|
|
65
|
+
<p>And then, again</p>
|
|
66
|
+
|
|
67
|
+
<pre><code>rake rails:rocco
|
|
68
|
+
</code></pre>
|
|
69
|
+
|
|
70
|
+
<h2>Known issues</h2>
|
|
71
|
+
|
|
72
|
+
<ul>
|
|
73
|
+
<li><p>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)</p></li>
|
|
74
|
+
<li><p>README files (without extension) are not rendered well. Try to rename to README.rdoc</p></li>
|
|
75
|
+
</ul>
|
|
76
|
+
|
|
77
|
+
<h2>Demo</h2>
|
|
78
|
+
|
|
79
|
+
<p>You can see a demo of autogenerated gem documentation in</p>
|
|
80
|
+
|
|
81
|
+
<p>http://mawi.github.com/rocco_rails/</p>
|
|
82
|
+
|
|
83
|
+
<h2>Changelog</h2>
|
|
84
|
+
|
|
85
|
+
<h3>v0.9</h3>
|
|
86
|
+
|
|
87
|
+
<ul>
|
|
88
|
+
<li>Added support for project's README as home page redered with github gem.</li>
|
|
89
|
+
<li>Fix issue #1</li>
|
|
90
|
+
</ul>
|
|
91
|
+
|
|
92
|
+
<h3>v0.8.1</h3>
|
|
93
|
+
|
|
94
|
+
<ul>
|
|
95
|
+
<li><strong>Mayor fix</strong> Gem is not loaded properly</li>
|
|
96
|
+
</ul>
|
|
97
|
+
|
|
98
|
+
<h3>v0.8</h3>
|
|
99
|
+
|
|
100
|
+
<ul>
|
|
101
|
+
<li><strong>Initial release</strong></li>
|
|
102
|
+
</ul>
|
|
103
|
+
|
|
104
|
+
<h2>Contributing</h2>
|
|
105
|
+
|
|
106
|
+
<ol>
|
|
107
|
+
<li>Fork it</li>
|
|
108
|
+
<li>Create your feature branch (<code>git checkout -b my-new-feature</code>)</li>
|
|
109
|
+
<li>Commit your changes (<code>git commit -am 'Added some feature'</code>)</li>
|
|
110
|
+
<li>Push to the branch (<code>git push origin my-new-feature</code>)</li>
|
|
111
|
+
<li>Create new Pull Request</li>
|
|
112
|
+
</ol>
|
data/docs/index.html
CHANGED
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
"http://www.w3.org/TR/html4/frameset.dtd">
|
|
3
3
|
<html>
|
|
4
4
|
<head>
|
|
5
|
-
<title>
|
|
5
|
+
<title> rocco_rails Documentation </title>
|
|
6
6
|
</head>
|
|
7
7
|
<frameset cols="20%, 80%">
|
|
8
8
|
<frame src="menu.html">
|
|
9
|
-
<frame name="rocco" src="">
|
|
9
|
+
<frame name="rocco" src= "README.html">
|
|
10
10
|
</frameset>
|
|
11
11
|
|
|
12
12
|
</HTML>
|
|
@@ -32,16 +32,24 @@
|
|
|
32
32
|
<a class="pilcrow" href="#section-1">¶</a>
|
|
33
33
|
</div>
|
|
34
34
|
<p>From http://blog.nathanhumbert.com/2010/02/rails-3-loading-rake-tasks-from-gem.html</p>
|
|
35
|
-
|
|
36
35
|
</td>
|
|
37
36
|
<td class=code>
|
|
38
37
|
<div class='highlight'><pre><span class="nb">require</span> <span class="s1">'rocco_rails'</span>
|
|
39
38
|
<span class="nb">require</span> <span class="s1">'rails'</span>
|
|
40
39
|
<span class="k">module</span> <span class="nn">RoccoRails</span>
|
|
41
|
-
<span class="k">class</span> <span class="nc">Railtie</span> <span class="o"><</span> <span class="no">Rails</span><span class="o">::</span><span class="no">Railtie</span>
|
|
42
|
-
|
|
40
|
+
<span class="k">class</span> <span class="nc">Railtie</span> <span class="o"><</span> <span class="no">Rails</span><span class="o">::</span><span class="no">Railtie</span></pre></div>
|
|
41
|
+
</td>
|
|
42
|
+
</tr>
|
|
43
|
+
<tr id='section-2'>
|
|
44
|
+
<td class=docs>
|
|
45
|
+
<div class="pilwrap">
|
|
46
|
+
<a class="pilcrow" href="#section-2">¶</a>
|
|
47
|
+
</div>
|
|
48
|
+
<p>railtie<em>name :rocco</em>rails</p>
|
|
43
49
|
|
|
44
|
-
|
|
50
|
+
</td>
|
|
51
|
+
<td class=code>
|
|
52
|
+
<div class='highlight'><pre> <span class="n">rake_tasks</span> <span class="k">do</span>
|
|
45
53
|
<span class="nb">load</span> <span class="s2">"tasks/rails_tasks.rake"</span>
|
|
46
54
|
<span class="k">end</span>
|
|
47
55
|
<span class="k">end</span>
|
|
@@ -37,6 +37,7 @@ https://github.com/rtomayko/rocco/blob/master/lib/rocco/tasks.rb</p>
|
|
|
37
37
|
<td class=code>
|
|
38
38
|
<div class='highlight'><pre><span class="nb">require</span> <span class="s1">'rocco/tasks'</span>
|
|
39
39
|
<span class="nb">require</span> <span class="s1">'erb'</span>
|
|
40
|
+
<span class="nb">require</span> <span class="s1">'github/markup'</span>
|
|
40
41
|
|
|
41
42
|
<span class="n">namespace</span> <span class="ss">:rails</span> <span class="k">do</span></pre></div>
|
|
42
43
|
</td>
|
|
@@ -71,6 +72,7 @@ https://github.com/rtomayko/rocco/blob/master/lib/rocco/tasks.rb</p>
|
|
|
71
72
|
|
|
72
73
|
<span class="vi">@excluded_items</span> <span class="o">=</span> <span class="vi">@config</span><span class="o">[</span><span class="s2">"excluded_items"</span><span class="o">].</span><span class="n">split</span><span class="p">(</span><span class="s2">", "</span><span class="p">)</span>
|
|
73
74
|
|
|
75
|
+
|
|
74
76
|
<span class="k">end</span>
|
|
75
77
|
|
|
76
78
|
|
|
@@ -100,6 +102,12 @@ https://github.com/rtomayko/rocco/blob/master/lib/rocco/tasks.rb</p>
|
|
|
100
102
|
<span class="n">load_config</span>
|
|
101
103
|
<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>
|
|
102
104
|
<span class="vi">@title</span> <span class="o">=</span> <span class="s2">"Rocco Documentation"</span>
|
|
105
|
+
<span class="k">if</span> <span class="no">File</span><span class="o">.</span><span class="n">exists?</span><span class="p">(</span><span class="vi">@config</span><span class="o">[</span><span class="s2">"index"</span><span class="o">]</span><span class="p">)</span>
|
|
106
|
+
<span class="n">file</span> <span class="o">=</span> <span class="vi">@config</span><span class="o">[</span><span class="s2">"index"</span><span class="o">]</span>
|
|
107
|
+
<span class="n">readme_html</span> <span class="o">=</span> <span class="no">GitHub</span><span class="o">::</span><span class="no">Markup</span><span class="o">.</span><span class="n">render</span><span class="p">(</span><span class="n">file</span><span class="p">,</span> <span class="no">File</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="n">file</span><span class="p">))</span>
|
|
108
|
+
<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">"/README.html"</span><span class="p">,</span> <span class="s1">'w'</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">readme_html</span><span class="p">)}</span>
|
|
109
|
+
<span class="vi">@index_page</span> <span class="o">=</span> <span class="s2">"README.html"</span>
|
|
110
|
+
<span class="k">end</span>
|
|
103
111
|
<span class="o">[</span><span class="s2">"menu"</span><span class="p">,</span> <span class="s2">"index"</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>
|
|
104
112
|
<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">"lib/templates/</span><span class="si">#{</span><span class="n">page</span><span class="si">}</span><span class="s2">.erb"</span><span class="p">)</span>
|
|
105
113
|
<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">"%<>"</span><span class="p">)</span><span class="o">.</span><span class="n">result</span>
|
|
@@ -107,6 +115,7 @@ https://github.com/rtomayko/rocco/blob/master/lib/rocco/tasks.rb</p>
|
|
|
107
115
|
<span class="k">end</span>
|
|
108
116
|
<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">"lib/templates/menu_resources/."</span><span class="p">,</span> <span class="vi">@out</span> <span class="o">+</span> <span class="s2">"/resources"</span><span class="p">)</span>
|
|
109
117
|
|
|
118
|
+
|
|
110
119
|
<span class="k">end</span>
|
|
111
120
|
|
|
112
121
|
<span class="n">desc</span> <span class="s1">'Test actual config.yml'</span>
|
|
@@ -38,6 +38,8 @@
|
|
|
38
38
|
|
|
39
39
|
<span class="nb">require</span> <span class="s1">'rocco/tasks'</span>
|
|
40
40
|
<span class="nb">require</span> <span class="s1">'erb'</span>
|
|
41
|
+
<span class="nb">require</span> <span class="s1">'github/markup'</span>
|
|
42
|
+
|
|
41
43
|
|
|
42
44
|
|
|
43
45
|
<span class="k">def</span> <span class="nf">load_config</span>
|
|
@@ -65,7 +67,13 @@
|
|
|
65
67
|
<div class='highlight'><pre> <span class="n">task</span> <span class="ss">:rocco_index</span> <span class="k">do</span>
|
|
66
68
|
<span class="n">load_config</span>
|
|
67
69
|
<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>
|
|
68
|
-
<span class="vi">@title</span> <span class="o">=</span> <span class="s2">"
|
|
70
|
+
<span class="vi">@title</span> <span class="o">=</span> <span class="s2">"rocco_rails Documentation"</span>
|
|
71
|
+
<span class="k">if</span> <span class="no">File</span><span class="o">.</span><span class="n">exists?</span><span class="p">(</span><span class="vi">@config</span><span class="o">[</span><span class="s2">"index"</span><span class="o">]</span><span class="p">)</span>
|
|
72
|
+
<span class="n">file</span> <span class="o">=</span> <span class="vi">@config</span><span class="o">[</span><span class="s2">"index"</span><span class="o">]</span>
|
|
73
|
+
<span class="n">readme_html</span> <span class="o">=</span> <span class="no">GitHub</span><span class="o">::</span><span class="no">Markup</span><span class="o">.</span><span class="n">render</span><span class="p">(</span><span class="n">file</span><span class="p">,</span> <span class="no">File</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="n">file</span><span class="p">))</span>
|
|
74
|
+
<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">"/README.html"</span><span class="p">,</span> <span class="s1">'w'</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">readme_html</span><span class="p">)}</span>
|
|
75
|
+
<span class="vi">@index_page</span> <span class="o">=</span> <span class="s2">"README.html"</span>
|
|
76
|
+
<span class="k">end</span>
|
|
69
77
|
<span class="o">[</span><span class="s2">"menu"</span><span class="p">,</span> <span class="s2">"index"</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>
|
|
70
78
|
<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="s2">"lib/templates/</span><span class="si">#{</span><span class="n">page</span><span class="si">}</span><span class="s2">.erb"</span><span class="p">)</span>
|
|
71
79
|
<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">"%<>"</span><span class="p">)</span><span class="o">.</span><span class="n">result</span>
|
data/docs/menu.html
CHANGED
|
@@ -64,7 +64,7 @@
|
|
|
64
64
|
<body>
|
|
65
65
|
<div id="nav">
|
|
66
66
|
Jump to ...
|
|
67
|
-
<ul><li>lib<ul><li>rocco_rails<ul><li> <a href='lib/rocco_rails/
|
|
67
|
+
<ul><li>lib<ul><li>rocco_rails<ul><li> <a href='/lib/rocco_rails/version.html'> version.html</a><li> <a href='/lib/rocco_rails/railtie.html'> railtie.html</a></li></ul><li>tasks<ul><li> <a href='/lib/tasks/rails_tasks.html'> rails_tasks.html</a><li> <a href='/lib/tasks/rocco_tasks.html'> rocco_tasks.html</a></li></ul><li> <a href='/lib/rocco_rails.html'> rocco_rails.html</a></li></ul></li></ul>
|
|
68
68
|
</div>
|
|
69
69
|
<body>
|
|
70
70
|
</html>
|
data/lib/config/rocco.yml
CHANGED
data/lib/config/rocco.yml.sample
CHANGED
data/lib/rocco_rails/railtie.rb
CHANGED
data/lib/rocco_rails/version.rb
CHANGED
data/lib/tasks/rails_tasks.rake
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
# https://github.com/rtomayko/rocco/blob/master/lib/rocco/tasks.rb
|
|
3
3
|
require 'rocco/tasks'
|
|
4
4
|
require 'erb'
|
|
5
|
+
require 'github/markup'
|
|
5
6
|
|
|
6
7
|
namespace :rails do
|
|
7
8
|
# If exists a config/rocco.yml in rails path use it
|
|
@@ -27,6 +28,7 @@ namespace :rails do
|
|
|
27
28
|
|
|
28
29
|
@excluded_items = @config["excluded_items"].split(", ")
|
|
29
30
|
|
|
31
|
+
|
|
30
32
|
end
|
|
31
33
|
|
|
32
34
|
|
|
@@ -47,6 +49,12 @@ namespace :rails do
|
|
|
47
49
|
load_config
|
|
48
50
|
@menu = RoccoRails.generate_menu(@out)
|
|
49
51
|
@title = "Rocco Documentation"
|
|
52
|
+
if File.exists?(@config["index"])
|
|
53
|
+
file = @config["index"]
|
|
54
|
+
readme_html = GitHub::Markup.render(file, File.read(file))
|
|
55
|
+
File.open(@out + "/README.html", 'w') {|f| f.write(readme_html)}
|
|
56
|
+
@index_page = "README.html"
|
|
57
|
+
end
|
|
50
58
|
["menu", "index"].each do |page|
|
|
51
59
|
template = File.read(@gem_path + "lib/templates/#{page}.erb")
|
|
52
60
|
html = ERB.new(template, 0, "%<>").result
|
|
@@ -54,6 +62,7 @@ namespace :rails do
|
|
|
54
62
|
end
|
|
55
63
|
FileUtils.cp_r(@gem_path+"lib/templates/menu_resources/.", @out + "/resources")
|
|
56
64
|
|
|
65
|
+
|
|
57
66
|
end
|
|
58
67
|
|
|
59
68
|
desc 'Test actual config.yml'
|
data/lib/tasks/rocco_tasks.rake
CHANGED
|
@@ -2,6 +2,8 @@ require File.expand_path('../rocco_rails/lib/rocco_rails.rb')
|
|
|
2
2
|
|
|
3
3
|
require 'rocco/tasks'
|
|
4
4
|
require 'erb'
|
|
5
|
+
require 'github/markup'
|
|
6
|
+
|
|
5
7
|
|
|
6
8
|
|
|
7
9
|
def load_config
|
|
@@ -23,7 +25,13 @@ require 'erb'
|
|
|
23
25
|
task :rocco_index do
|
|
24
26
|
load_config
|
|
25
27
|
@menu = RoccoRails.generate_menu(@out)
|
|
26
|
-
@title = "
|
|
28
|
+
@title = "rocco_rails Documentation"
|
|
29
|
+
if File.exists?(@config["index"])
|
|
30
|
+
file = @config["index"]
|
|
31
|
+
readme_html = GitHub::Markup.render(file, File.read(file))
|
|
32
|
+
File.open(@out + "/README.html", 'w') {|f| f.write(readme_html)}
|
|
33
|
+
@index_page = "README.html"
|
|
34
|
+
end
|
|
27
35
|
["menu", "index"].each do |page|
|
|
28
36
|
template = File.read("lib/templates/#{page}.erb")
|
|
29
37
|
html = ERB.new(template, 0, "%<>").result
|
data/lib/templates/index.erb
CHANGED
data/rocco_rails.gemspec
CHANGED
metadata
CHANGED
|
@@ -1,72 +1,109 @@
|
|
|
1
|
-
--- !ruby/object:Gem::Specification
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: rocco_rails
|
|
3
|
-
version: !ruby/object:Gem::Version
|
|
4
|
-
|
|
5
|
-
prerelease:
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
hash: 25
|
|
5
|
+
prerelease: false
|
|
6
|
+
segments:
|
|
7
|
+
- 0
|
|
8
|
+
- 9
|
|
9
|
+
version: "0.9"
|
|
6
10
|
platform: ruby
|
|
7
|
-
authors:
|
|
11
|
+
authors:
|
|
8
12
|
- Mawi Marin
|
|
9
13
|
autorequire:
|
|
10
14
|
bindir: bin
|
|
11
15
|
cert_chain: []
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
16
|
+
|
|
17
|
+
date: 2012-02-23 00:00:00 +01:00
|
|
18
|
+
default_executable:
|
|
19
|
+
dependencies:
|
|
20
|
+
- !ruby/object:Gem::Dependency
|
|
15
21
|
name: rocco
|
|
16
|
-
|
|
22
|
+
prerelease: false
|
|
23
|
+
requirement: &id001 !ruby/object:Gem::Requirement
|
|
17
24
|
none: false
|
|
18
|
-
requirements:
|
|
19
|
-
- -
|
|
20
|
-
- !ruby/object:Gem::Version
|
|
21
|
-
|
|
25
|
+
requirements:
|
|
26
|
+
- - ">="
|
|
27
|
+
- !ruby/object:Gem::Version
|
|
28
|
+
hash: 3
|
|
29
|
+
segments:
|
|
30
|
+
- 0
|
|
31
|
+
version: "0"
|
|
22
32
|
type: :runtime
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
- !ruby/object:Gem::Dependency
|
|
33
|
+
version_requirements: *id001
|
|
34
|
+
- !ruby/object:Gem::Dependency
|
|
26
35
|
name: redcarpet
|
|
27
|
-
|
|
36
|
+
prerelease: false
|
|
37
|
+
requirement: &id002 !ruby/object:Gem::Requirement
|
|
28
38
|
none: false
|
|
29
|
-
requirements:
|
|
39
|
+
requirements:
|
|
30
40
|
- - ~>
|
|
31
|
-
- !ruby/object:Gem::Version
|
|
32
|
-
|
|
41
|
+
- !ruby/object:Gem::Version
|
|
42
|
+
hash: 45
|
|
43
|
+
segments:
|
|
44
|
+
- 1
|
|
45
|
+
- 17
|
|
46
|
+
version: "1.17"
|
|
33
47
|
type: :runtime
|
|
48
|
+
version_requirements: *id002
|
|
49
|
+
- !ruby/object:Gem::Dependency
|
|
50
|
+
name: github-markup
|
|
34
51
|
prerelease: false
|
|
35
|
-
|
|
36
|
-
- !ruby/object:Gem::Dependency
|
|
37
|
-
name: mustache
|
|
38
|
-
requirement: &2156225960 !ruby/object:Gem::Requirement
|
|
52
|
+
requirement: &id003 !ruby/object:Gem::Requirement
|
|
39
53
|
none: false
|
|
40
|
-
requirements:
|
|
41
|
-
- -
|
|
42
|
-
- !ruby/object:Gem::Version
|
|
43
|
-
|
|
54
|
+
requirements:
|
|
55
|
+
- - ">="
|
|
56
|
+
- !ruby/object:Gem::Version
|
|
57
|
+
hash: 3
|
|
58
|
+
segments:
|
|
59
|
+
- 0
|
|
60
|
+
version: "0"
|
|
44
61
|
type: :runtime
|
|
62
|
+
version_requirements: *id003
|
|
63
|
+
- !ruby/object:Gem::Dependency
|
|
64
|
+
name: mustache
|
|
45
65
|
prerelease: false
|
|
46
|
-
|
|
47
|
-
- !ruby/object:Gem::Dependency
|
|
48
|
-
name: pygmentize
|
|
49
|
-
requirement: &2152106520 !ruby/object:Gem::Requirement
|
|
66
|
+
requirement: &id004 !ruby/object:Gem::Requirement
|
|
50
67
|
none: false
|
|
51
|
-
requirements:
|
|
52
|
-
- -
|
|
53
|
-
- !ruby/object:Gem::Version
|
|
54
|
-
|
|
68
|
+
requirements:
|
|
69
|
+
- - ">="
|
|
70
|
+
- !ruby/object:Gem::Version
|
|
71
|
+
hash: 3
|
|
72
|
+
segments:
|
|
73
|
+
- 0
|
|
74
|
+
version: "0"
|
|
55
75
|
type: :runtime
|
|
76
|
+
version_requirements: *id004
|
|
77
|
+
- !ruby/object:Gem::Dependency
|
|
78
|
+
name: pygmentize
|
|
56
79
|
prerelease: false
|
|
57
|
-
|
|
80
|
+
requirement: &id005 !ruby/object:Gem::Requirement
|
|
81
|
+
none: false
|
|
82
|
+
requirements:
|
|
83
|
+
- - ">="
|
|
84
|
+
- !ruby/object:Gem::Version
|
|
85
|
+
hash: 3
|
|
86
|
+
segments:
|
|
87
|
+
- 0
|
|
88
|
+
version: "0"
|
|
89
|
+
type: :runtime
|
|
90
|
+
version_requirements: *id005
|
|
58
91
|
description: Rocco gem for rails
|
|
59
|
-
email:
|
|
92
|
+
email:
|
|
60
93
|
- mawitu@gmail.com
|
|
61
94
|
executables: []
|
|
95
|
+
|
|
62
96
|
extensions: []
|
|
97
|
+
|
|
63
98
|
extra_rdoc_files: []
|
|
64
|
-
|
|
99
|
+
|
|
100
|
+
files:
|
|
65
101
|
- .gitignore
|
|
66
102
|
- Gemfile
|
|
67
103
|
- LICENSE
|
|
68
104
|
- README.md
|
|
69
105
|
- Rakefile
|
|
106
|
+
- docs/README.html
|
|
70
107
|
- docs/index.html
|
|
71
108
|
- docs/lib/rocco_rails.html
|
|
72
109
|
- docs/lib/rocco_rails/railtie.html
|
|
@@ -91,28 +128,39 @@ files:
|
|
|
91
128
|
- lib/templates/menu_resources/jquery.simpletreeview.min.js
|
|
92
129
|
- lib/templates/resources/rocco.css
|
|
93
130
|
- rocco_rails.gemspec
|
|
94
|
-
|
|
131
|
+
has_rdoc: true
|
|
132
|
+
homepage: ""
|
|
95
133
|
licenses: []
|
|
134
|
+
|
|
96
135
|
post_install_message:
|
|
97
136
|
rdoc_options: []
|
|
98
|
-
|
|
137
|
+
|
|
138
|
+
require_paths:
|
|
99
139
|
- lib
|
|
100
|
-
required_ruby_version: !ruby/object:Gem::Requirement
|
|
140
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
101
141
|
none: false
|
|
102
|
-
requirements:
|
|
103
|
-
- -
|
|
104
|
-
- !ruby/object:Gem::Version
|
|
105
|
-
|
|
106
|
-
|
|
142
|
+
requirements:
|
|
143
|
+
- - ">="
|
|
144
|
+
- !ruby/object:Gem::Version
|
|
145
|
+
hash: 3
|
|
146
|
+
segments:
|
|
147
|
+
- 0
|
|
148
|
+
version: "0"
|
|
149
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
107
150
|
none: false
|
|
108
|
-
requirements:
|
|
109
|
-
- -
|
|
110
|
-
- !ruby/object:Gem::Version
|
|
111
|
-
|
|
151
|
+
requirements:
|
|
152
|
+
- - ">="
|
|
153
|
+
- !ruby/object:Gem::Version
|
|
154
|
+
hash: 3
|
|
155
|
+
segments:
|
|
156
|
+
- 0
|
|
157
|
+
version: "0"
|
|
112
158
|
requirements: []
|
|
159
|
+
|
|
113
160
|
rubyforge_project:
|
|
114
|
-
rubygems_version: 1.
|
|
161
|
+
rubygems_version: 1.3.7
|
|
115
162
|
signing_key:
|
|
116
163
|
specification_version: 3
|
|
117
164
|
summary: Rocco gem for rails
|
|
118
165
|
test_files: []
|
|
166
|
+
|