RubyGems - timeline_setter - Versions diffs - 0.2.0 → 0.3.0 - Mend

timeline_setter 0.2.0 → 0.3.0

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.

Files changed (40) hide show

data/Rakefile +11 -2
data/config/assets.yml +9 -0
data/doc/doc.markdown +65 -17
data/doc/templates.html +3 -0
data/doc/timeline-setter.html +327 -238
data/doc/timeline-setter.min.html +3 -0
data/documentation/TimelineSetter/CLI.html +77 -52
data/documentation/TimelineSetter/Parser.html +40 -39
data/documentation/TimelineSetter/Timeline.html +132 -83
data/documentation/TimelineSetter.html +27 -12
data/documentation/_index.html +23 -12
data/documentation/class_list.html +20 -9
data/documentation/css/style.css +7 -5
data/documentation/file.README.html +33 -23
data/documentation/file_list.html +20 -9
data/documentation/frames.html +1 -1
data/documentation/index.html +33 -23
data/documentation/js/app.js +16 -14
data/documentation/js/full_list.js +7 -6
data/documentation/js/jquery.js +3 -3
data/documentation/method_list.html +42 -23
data/documentation/top-level-namespace.html +26 -11
data/index.html +100 -19
data/lib/timeline_setter/cli.rb +2 -0
data/lib/timeline_setter/timeline.rb +6 -3
data/lib/timeline_setter/version.rb +1 -1
data/lib/timeline_setter.rb +0 -7
data/public/javascripts/templates/card.jst +21 -0
data/public/javascripts/templates/notch.jst +1 -0
data/public/javascripts/templates/series_legend.jst +3 -0
data/public/javascripts/templates/timeline.jst +20 -0
data/public/javascripts/templates/year_notch.jst +3 -0
data/public/javascripts/templates.js +1 -0
data/public/javascripts/timeline-setter.js +303 -167
data/public/javascripts/timeline-setter.min.js +1 -0
data/public/stylesheets/timeline-setter.css +5 -5
data/spec/timeline_setter_spec.rb +2 -2
data/templates/timeline-markup.erb +5 -59
data/timeline_setter.gemspec +15 -5
metadata +15 -5

data/documentation/TimelineSetter/CLI.html CHANGED Viewed

@@ -3,16 +3,26 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<title>Class: TimelineSetter::CLI</title>
-<link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
-<link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
+<title>
+  Class: TimelineSetter::CLI
+    &mdash; Documentation by YARD 0.7.2
+</title>
+  <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
+  <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
 <script type="text/javascript" charset="utf-8">
   relpath = '..';
   if (relpath != '') relpath += '/';
 </script>
-<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
-<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
   </head>
   <body>
@@ -33,11 +43,14 @@
 </div>
       <div id="search">
-  <a id="class_list_link" href="#">Class List</a>
-  <a id="method_list_link" href="#">Method List</a>
-  <a id ="file_list_link" href="#">File List</a>
+    <a id="class_list_link" href="#">Class List</a>
+    <a id="method_list_link" href="#">Method List</a>
+    <a id="file_list_link" href="#">File List</a>
 </div>
       <div class="clear"></div>
     </div>
@@ -82,6 +95,8 @@
     <h2>
       Instance Method Summary
@@ -171,10 +186,7 @@
-    <span class="summary_desc"><div class='inline'><p>
-A new instance of CLI.
-</p>
-</div></span>
+    <span class="summary_desc"><div class='inline'>A new instance of CLI.</div></span>
 </li>
@@ -278,10 +290,7 @@ A new instance of CLI.
 </p><div class="docstring">
   <div class="discussion">
-    <p>
-A new instance of CLI
-</p>
+    A new instance of CLI
   </div>
 </div>
@@ -329,12 +338,6 @@ A new instance of CLI
       <pre class="lines">
-72
-73
-74
-75
-76
-77
 78
 79
 80
@@ -344,14 +347,24 @@ A new instance of CLI
 84
 85
 86
-87</pre>
+87
+88
+89
+90
+91
+92
+93
+94
+95</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/timeline_setter/cli.rb', line 72</span>
+      <pre class="code"><span class="info file"># File 'lib/timeline_setter/cli.rb', line 78</span>
 <span class='def def kw'>def</span> <span class='compile! fid id'>compile!</span>
-  <span class='if if kw'>if</span> <span class='@options ivar id'>@options</span><span class='lbrack token'>[</span><span class='symbol val'>:assets</span><span class='rbrack token'>]</span>
+  <span class='if if kw'>if</span> <span class='notop op'>!</span><span class='@options ivar id'>@options</span><span class='lbrack token'>[</span><span class='symbol val'>:no_assets</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='notop op'>!</span><span class='@options ivar id'>@options</span><span class='lbrack token'>[</span><span class='symbol val'>:min</span><span class='rbrack token'>]</span>
     <span class='FileUtils constant id'>FileUtils</span><span class='dot token'>.</span><span class='cp_r identifier id'>cp_r</span><span class='lparen token'>(</span><span class='Dir constant id'>Dir</span><span class='dot token'>.</span><span class='glob identifier id'>glob</span><span class='lparen token'>(</span><span class='dstring node'>&quot;#{TimelineSetter::ROOT}/public/*&quot;</span><span class='rparen token'>)</span><span class='comma token'>,</span> <span class='outdir identifier id'>outdir</span><span class='rparen token'>)</span>
+    <span class='comment val'># Concatenate JSTs to timeline-setter.js and remove templates.js</span>
+    <span class='dxstring node'>`cat #{outdir}/javascripts/templates.js &gt;&gt; #{outdir}/javascripts/timeline-setter.js &amp;&amp; rm -rf #{outdir}/javascripts/templates*`</span>
   <span class='end end kw'>end</span>
   <span class='File constant id'>File</span><span class='dot token'>.</span><span class='open identifier id'>open</span><span class='lparen token'>(</span><span class='timeline_page_path identifier id'>timeline_page_path</span><span class='comma token'>,</span> <span class='string val'>'w+'</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='doc identifier id'>doc</span><span class='bitor op'>|</span>
@@ -384,12 +397,12 @@ A new instance of CLI
       <pre class="lines">
-56
-57
-58</pre>
+59
+60
+61</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/timeline_setter/cli.rb', line 56</span>
+      <pre class="code"><span class="info file"># File 'lib/timeline_setter/cli.rb', line 59</span>
 <span class='def def kw'>def</span> <span class='events identifier id'>events</span>
   <span class='TimelineSetter constant id'>TimelineSetter</span><span class='colon2 op'>::</span><span class='Parser constant id'>Parser</span><span class='dot token'>.</span><span class='new identifier id'>new</span> <span class='sheet identifier id'>sheet</span>
@@ -413,15 +426,21 @@ A new instance of CLI
       <pre class="lines">
-60
-61
-62</pre>
+63
+64
+65
+66
+67
+68</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/timeline_setter/cli.rb', line 60</span>
+      <pre class="code"><span class="info file"># File 'lib/timeline_setter/cli.rb', line 63</span>
 <span class='def def kw'>def</span> <span class='html identifier id'>html</span>
-  <span class='TimelineSetter constant id'>TimelineSetter</span><span class='colon2 op'>::</span><span class='Timeline constant id'>Timeline</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='events identifier id'>events</span><span class='dot token'>.</span><span class='events identifier id'>events</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='@options ivar id'>@options</span><span class='lbrack token'>[</span><span class='symbol val'>:min</span><span class='rbrack token'>]</span> <span class='question op'>?</span> <span class='symbol val'>:timeline_min</span> <span class='colon op'>:</span> <span class='symbol val'>:timeline</span><span class='rparen token'>)</span>
+  <span class='TimelineSetter constant id'>TimelineSetter</span><span class='colon2 op'>::</span><span class='Timeline constant id'>Timeline</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='lbrace token'>{</span>
+    <span class='symbol val'>:events</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='events identifier id'>events</span><span class='dot token'>.</span><span class='events identifier id'>events</span><span class='comma token'>,</span>
+    <span class='symbol val'>:interval</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='@options ivar id'>@options</span><span class='lbrack token'>[</span><span class='symbol val'>:interval</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='string val'>''</span>
+  <span class='rbrace token'>}</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='@options ivar id'>@options</span><span class='lbrack token'>[</span><span class='symbol val'>:min</span><span class='rbrack token'>]</span> <span class='question op'>?</span> <span class='symbol val'>:timeline_min</span> <span class='colon op'>:</span> <span class='symbol val'>:timeline</span><span class='rparen token'>)</span>
 <span class='end end kw'>end</span>
 </pre>
     </td>
@@ -442,12 +461,12 @@ A new instance of CLI
       <pre class="lines">
-64
-65
-66</pre>
+70
+71
+72</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/timeline_setter/cli.rb', line 64</span>
+      <pre class="code"><span class="info file"># File 'lib/timeline_setter/cli.rb', line 70</span>
 <span class='def def kw'>def</span> <span class='outdir identifier id'>outdir</span>
   <span class='@options ivar id'>@options</span><span class='lbrack token'>[</span><span class='symbol val'>:output</span><span class='rbrack token'>]</span> <span class='question op'>?</span> <span class='@options ivar id'>@options</span><span class='lbrack token'>[</span><span class='symbol val'>:output</span><span class='rbrack token'>]</span> <span class='colon op'>:</span> <span class='dstring node'>&quot;#{`pwd`.strip}/&quot;</span>
@@ -506,7 +525,10 @@ A new instance of CLI
 42
 43
 44
-45</pre>
+45
+46
+47
+48</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/timeline_setter/cli.rb', line 10</span>
@@ -522,8 +544,8 @@ A new instance of CLI
     <span class='opts identifier id'>opts</span><span class='dot token'>.</span><span class='on identifier id'>on</span><span class='lparen token'>(</span><span class='string val'>'-o'</span><span class='comma token'>,</span> <span class='string val'>'--output OUTPUT'</span><span class='comma token'>,</span> <span class='string val'>'Output directory to install timeline into.'</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span>
       <span class='@options ivar id'>@options</span><span class='lbrack token'>[</span><span class='symbol val'>:output</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='o identifier id'>o</span>
     <span class='end end kw'>end</span>
-    <span class='opts identifier id'>opts</span><span class='dot token'>.</span><span class='on identifier id'>on</span><span class='lparen token'>(</span><span class='string val'>'-a'</span><span class='comma token'>,</span> <span class='string val'>'--with-assets'</span><span class='comma token'>,</span> <span class='string val'>'Output timeline supporting assets as well'</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='a identifier id'>a</span><span class='bitor op'>|</span>
-      <span class='@options ivar id'>@options</span><span class='lbrack token'>[</span><span class='symbol val'>:assets</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='a identifier id'>a</span>
+    <span class='opts identifier id'>opts</span><span class='dot token'>.</span><span class='on identifier id'>on</span><span class='lparen token'>(</span><span class='string val'>'-a'</span><span class='comma token'>,</span> <span class='string val'>'--without-assets'</span><span class='comma token'>,</span> <span class='string val'>'Output timeline without supporting assets'</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='a identifier id'>a</span><span class='bitor op'>|</span>
+      <span class='@options ivar id'>@options</span><span class='lbrack token'>[</span><span class='symbol val'>:no_assets</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='a identifier id'>a</span>
     <span class='end end kw'>end</span>
     <span class='opts identifier id'>opts</span><span class='dot token'>.</span><span class='on identifier id'>on</span><span class='lparen token'>(</span><span class='string val'>'-O'</span><span class='comma token'>,</span> <span class='string val'>'--open'</span><span class='comma token'>,</span> <span class='string val'>'Open generated timeline in a browser'</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span>
       <span class='@options ivar id'>@options</span><span class='lbrack token'>[</span><span class='symbol val'>:open</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='o identifier id'>o</span>
@@ -531,6 +553,9 @@ A new instance of CLI
     <span class='opts identifier id'>opts</span><span class='dot token'>.</span><span class='on identifier id'>on</span><span class='lparen token'>(</span><span class='string val'>'-m'</span><span class='comma token'>,</span> <span class='string val'>'--min'</span><span class='comma token'>,</span> <span class='string val'>'Create a minified one-page version of the timeline'</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='m identifier id'>m</span><span class='bitor op'>|</span>
       <span class='@options ivar id'>@options</span><span class='lbrack token'>[</span><span class='symbol val'>:min</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='m identifier id'>m</span>
     <span class='end end kw'>end</span>
+    <span class='opts identifier id'>opts</span><span class='dot token'>.</span><span class='on identifier id'>on</span><span class='lparen token'>(</span><span class='string val'>'-i'</span><span class='comma token'>,</span> <span class='string val'>'--interval INTERVAL'</span><span class='comma token'>,</span> <span class='string val'>'Override automatic interval notches with a custom interval.'</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='i identifier id'>i</span><span class='bitor op'>|</span>
+      <span class='@options ivar id'>@options</span><span class='lbrack token'>[</span><span class='symbol val'>:interval</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='i identifier id'>i</span>
+    <span class='end end kw'>end</span>
     <span class='opts identifier id'>opts</span><span class='dot token'>.</span><span class='on_tail identifier id'>on_tail</span><span class='lparen token'>(</span><span class='string val'>&quot;-h&quot;</span><span class='comma token'>,</span> <span class='string val'>&quot;--help&quot;</span><span class='comma token'>,</span> <span class='string val'>&quot;Show this message&quot;</span><span class='rparen token'>)</span> <span class='do do kw'>do</span>
@@ -566,12 +591,12 @@ A new instance of CLI
       <pre class="lines">
-52
-53
-54</pre>
+55
+56
+57</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/timeline_setter/cli.rb', line 52</span>
+      <pre class="code"><span class="info file"># File 'lib/timeline_setter/cli.rb', line 55</span>
 <span class='def def kw'>def</span> <span class='sheet identifier id'>sheet</span>
   <span class='File constant id'>File</span><span class='dot token'>.</span><span class='open identifier id'>open</span><span class='lparen token'>(</span><span class='@options ivar id'>@options</span><span class='lbrack token'>[</span><span class='symbol val'>:csv</span><span class='rbrack token'>]</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='read identifier id'>read</span>
@@ -595,12 +620,12 @@ A new instance of CLI
       <pre class="lines">
-68
-69
-70</pre>
+74
+75
+76</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/timeline_setter/cli.rb', line 68</span>
+      <pre class="code"><span class="info file"># File 'lib/timeline_setter/cli.rb', line 74</span>
 <span class='def def kw'>def</span> <span class='timeline_page_path identifier id'>timeline_page_path</span>
   <span class='File constant id'>File</span><span class='dot token'>.</span><span class='join identifier id'>join</span><span class='lparen token'>(</span><span class='outdir identifier id'>outdir</span><span class='comma token'>,</span> <span class='string val'>'timeline.html'</span><span class='rparen token'>)</span>
@@ -616,9 +641,9 @@ A new instance of CLI
 </div>
     <div id="footer">
-  Generated on Thu Apr 21 10:33:41 2011 by
+  Generated on Wed Nov  2 15:20:08 2011 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.6.5 (ruby-1.8.7).
+  0.7.2 (ruby-1.8.7).
 </div>
   </body>

data/documentation/TimelineSetter/Parser.html CHANGED Viewed

@@ -3,16 +3,26 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<title>Class: TimelineSetter::Parser</title>
-<link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
-<link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
+<title>
+  Class: TimelineSetter::Parser
+    &mdash; Documentation by YARD 0.7.2
+</title>
+  <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
+  <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
 <script type="text/javascript" charset="utf-8">
   relpath = '..';
   if (relpath != '') relpath += '/';
 </script>
-<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
-<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
   </head>
   <body>
@@ -33,11 +43,14 @@
 </div>
       <div id="search">
-  <a id="class_list_link" href="#">Class List</a>
-  <a id="method_list_link" href="#">Method List</a>
-  <a id ="file_list_link" href="#">File List</a>
+    <a id="class_list_link" href="#">Class List</a>
+    <a id="method_list_link" href="#">Method List</a>
+    <a id="file_list_link" href="#">File List</a>
 </div>
       <div class="clear"></div>
     </div>
@@ -103,10 +116,7 @@
-    <span class="summary_desc"><div class='inline'><p>
-Returns the value of attribute events.
-</p>
-</div></span>
+    <span class="summary_desc"><div class='inline'>Returns the value of attribute events.</div></span>
 </li>
@@ -114,6 +124,8 @@ Returns the value of attribute events.
   </ul>
     <h2>
       Instance Method Summary
@@ -140,11 +152,8 @@ Returns the value of attribute events.
-    <span class="summary_desc"><div class='inline'><p>
-Initialize a new timeline from a CSV file via TableFu, add a hash for each
-row (event) in the sheet to an events array.
-</p>
-</div></span>
+    <span class="summary_desc"><div class='inline'>Initialize a new timeline from a CSV file via TableFu,
+add a hash for each row (event) in the sheet to an events array.</div></span>
 </li>
@@ -164,21 +173,16 @@ row (event) in the sheet to an events array.
 </p><div class="docstring">
   <div class="discussion">
-    <p>
-Initialize a new timeline from a CSV file via TableFu, add a hash for each
-row (event) in the sheet to an events array. Sheet should contain columns
-for
-</p>
-<pre class="code">
- <span class='mult op'>*</span> <span class='date identifier id'>date</span>
- <span class='mult op'>*</span> <span class='display_date identifier id'>display_date</span>
- <span class='mult op'>*</span> <span class='description identifier id'>description</span>
- <span class='mult op'>*</span> <span class='link identifier id'>link</span>
- <span class='mult op'>*</span> <span class='thumbnail identifier id'>thumbnail</span>
- <span class='mult op'>*</span> <span class='series identifier id'>series</span>
- <span class='mult op'>*</span> <span class='html identifier id'>html</span>
-</pre>
+    Initialize a new timeline from a CSV file via TableFu,
+add a hash for each row (event) in the sheet to an events array.
+Sheet should contain columns for
+ * date
+ * display_date
+ * description
+ * link
+ * thumbnail
+ * series
+ * html
   </div>
 </div>
@@ -239,10 +243,7 @@ for
 </p><div class="docstring">
   <div class="discussion">
-    <p>
-Returns the value of attribute events
-</p>
+    Returns the value of attribute events
   </div>
 </div>
@@ -276,9 +277,9 @@ Returns the value of attribute events
 </div>
     <div id="footer">
-  Generated on Thu Apr 21 10:33:42 2011 by
+  Generated on Wed Nov  2 15:20:07 2011 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.6.5 (ruby-1.8.7).
+  0.7.2 (ruby-1.8.7).
 </div>
   </body>