xbrlware-ce 1.0.4 → 1.1.0

data/doc/classes/Xbrlware/Item.html

@@ -100,9 +100,9 @@ instance page on xbrlware wiki</a> for more details.
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000051">balance</a>&nbsp;&nbsp;
-      <a href="#M000049">new</a>&nbsp;&nbsp;
-      <a href="#M000050">value</a>&nbsp;&nbsp;
+      <a href="#M000063">balance</a>&nbsp;&nbsp;
+      <a href="#M000061">new</a>&nbsp;&nbsp;
+      <a href="#M000062">value</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -180,23 +180,23 @@ instance page on xbrlware wiki</a> for more details.
     <div id="methods">
       <h3 class="section-bar">Public Class methods</h3>
 
-      <div id="method-M000049" class="method-detail">
-        <a name="M000049"></a>
+      <div id="method-M000061" class="method-detail">
+        <a name="M000061"></a>
 
         <div class="method-heading">
-          <a href="#M000049" class="method-signature">
+          <a href="#M000061" class="method-signature">
           <span class="method-name">new</span><span class="method-args">(name, context, value, unit=nil,precision=nil,decimals=nil, footnotes=nil)</span>
           </a>
         </div>
       
         <div class="method-description">
           <p>
-Constructs item <a href="Item.html#M000050">value</a> is normalized based
+Constructs item <a href="Item.html#M000062">value</a> is normalized based
 on precision and decimals passed as per XBRL specification
 </p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000049-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000049-source">
+            onclick="toggleCode('M000061-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000061-source">
 <pre>
 <span class="ruby-comment cmt"># File lib/xbrlware/item.rb, line 31</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">context</span>, <span class="ruby-identifier">value</span>, <span class="ruby-identifier">unit</span>=<span class="ruby-keyword kw">nil</span>,<span class="ruby-identifier">precision</span>=<span class="ruby-keyword kw">nil</span>,<span class="ruby-identifier">decimals</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">footnotes</span>=<span class="ruby-keyword kw">nil</span>)
@@ -215,19 +215,19 @@ on precision and decimals passed as per XBRL specification
 
       <h3 class="section-bar">Public Instance methods</h3>
 
-      <div id="method-M000051" class="method-detail">
-        <a name="M000051"></a>
+      <div id="method-M000063" class="method-detail">
+        <a name="M000063"></a>
 
         <div class="method-heading">
-          <a href="#M000051" class="method-signature">
+          <a href="#M000063" class="method-signature">
           <span class="method-name">balance</span><span class="method-args">()</span>
           </a>
         </div>
       
         <div class="method-description">
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000051-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000051-source">
+            onclick="toggleCode('M000063-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000063-source">
 <pre>
 <span class="ruby-comment cmt"># File lib/xbrlware/item.rb, line 48</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">balance</span>
@@ -239,19 +239,19 @@ on precision and decimals passed as per XBRL specification
         </div>
       </div>
 
-      <div id="method-M000050" class="method-detail">
-        <a name="M000050"></a>
+      <div id="method-M000062" class="method-detail">
+        <a name="M000062"></a>
 
         <div class="method-heading">
-          <a href="#M000050" class="method-signature">
+          <a href="#M000062" class="method-signature">
           <span class="method-name">value</span><span class="method-args">() {|@value| ...}</span>
           </a>
         </div>
       
         <div class="method-description">
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000050-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000050-source">
+            onclick="toggleCode('M000062-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000062-source">
 <pre>
 <span class="ruby-comment cmt"># File lib/xbrlware/item.rb, line 41</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">value</span>

data/doc/classes/Xbrlware/Linkbase/CalculationLinkbase/Calculation.html

@@ -148,7 +148,7 @@
 <pre>
 <span class="ruby-comment cmt"># File lib/xbrlware/linkbase/calculation_linkbase.rb, line 118</span>
         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">entity_details</span>, <span class="ruby-identifier">title</span>, <span class="ruby-identifier">role</span>, <span class="ruby-identifier">href</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">arcs</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">contexts</span>=<span class="ruby-keyword kw">nil</span>)
-          <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">title</span>, <span class="ruby-identifier">role</span>, <span class="ruby-identifier">href</span>, <span class="ruby-identifier">arcs</span>)
+          <span class="ruby-keyword kw">super</span>(<span class="ruby-value str">&quot;Calculation&quot;</span>, <span class="ruby-identifier">title</span>, <span class="ruby-identifier">role</span>, <span class="ruby-identifier">href</span>, <span class="ruby-identifier">arcs</span>)
           <span class="ruby-ivar">@contexts</span>=<span class="ruby-identifier">contexts</span>
           <span class="ruby-ivar">@entity_details</span>=<span class="ruby-identifier">entity_details</span>
         <span class="ruby-keyword kw">end</span>

data/doc/classes/Xbrlware/Linkbase/DefinitionLinkbase/Definition.html

@@ -144,7 +144,7 @@
 <pre>
 <span class="ruby-comment cmt"># File lib/xbrlware/linkbase/definition_linkbase.rb, line 153</span>
         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">title</span>, <span class="ruby-identifier">role</span>, <span class="ruby-identifier">href</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">primary_items</span>=<span class="ruby-keyword kw">nil</span>)
-          <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">title</span>, <span class="ruby-identifier">role</span>, <span class="ruby-identifier">href</span>, <span class="ruby-identifier">primary_items</span>)
+          <span class="ruby-keyword kw">super</span>(<span class="ruby-value str">&quot;Definition&quot;</span>, <span class="ruby-identifier">title</span>, <span class="ruby-identifier">role</span>, <span class="ruby-identifier">href</span>, <span class="ruby-identifier">primary_items</span>)
           <span class="ruby-ivar">@primary_items</span>=<span class="ruby-identifier">primary_items</span>
         <span class="ruby-keyword kw">end</span>
 </pre>
@@ -178,7 +178,7 @@
                 <span class="ruby-identifier">dimension</span>.<span class="ruby-identifier">domains</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">domain</span><span class="ruby-operator">|</span>
                   <span class="ruby-identifier">domains</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">domain</span>.<span class="ruby-identifier">href</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-value str">&quot;_&quot;</span>, <span class="ruby-value str">&quot;:&quot;</span>)
                 <span class="ruby-keyword kw">end</span>
-                <span class="ruby-identifier">dim_dom_map</span>[<span class="ruby-identifier">dimension</span>.<span class="ruby-identifier">href</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-value str">&quot;_&quot;</span>, <span class="ruby-value str">&quot;:&quot;</span>)]=<span class="ruby-identifier">domains</span>
+                <span class="ruby-identifier">dim_dom_map</span>[<span class="ruby-identifier">dimension</span>.<span class="ruby-identifier">href</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-value str">&quot;_&quot;</span>, <span class="ruby-value str">&quot;:&quot;</span>)]=<span class="ruby-identifier">domains</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">domains</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">0</span>
               <span class="ruby-keyword kw">end</span>
             <span class="ruby-keyword kw">end</span>
           <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@primary_items</span>.<span class="ruby-identifier">nil?</span>

data/doc/classes/Xbrlware/Linkbase/Linkbase/Link.html

@@ -123,6 +123,11 @@
           <td class="context-item-value">&nbsp;[R]&nbsp;</td>
           <td class="context-item-desc"></td>
         </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">link_type</td>
+          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
         <tr class="top-aligned-row context-row">
           <td class="context-item-name">role</td>
           <td class="context-item-value">&nbsp;[R]&nbsp;</td>
@@ -148,7 +153,7 @@
 
         <div class="method-heading">
           <a href="#M000005" class="method-signature">
-          <span class="method-name">new</span><span class="method-args">(title, role, href, arcs=nil)</span>
+          <span class="method-name">new</span><span class="method-args">(link_type, title, role, href, arcs=nil)</span>
           </a>
         </div>
       
@@ -158,7 +163,8 @@
           <div class="method-source-code" id="M000005-source">
 <pre>
 <span class="ruby-comment cmt"># File lib/xbrlware/linkbase/linkbase.rb, line 100</span>
-        <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">title</span>, <span class="ruby-identifier">role</span>, <span class="ruby-identifier">href</span>, <span class="ruby-identifier">arcs</span>=<span class="ruby-keyword kw">nil</span>)
+        <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">link_type</span>, <span class="ruby-identifier">title</span>, <span class="ruby-identifier">role</span>, <span class="ruby-identifier">href</span>, <span class="ruby-identifier">arcs</span>=<span class="ruby-keyword kw">nil</span>)
+          <span class="ruby-ivar">@link_type</span>=<span class="ruby-identifier">link_type</span>
           <span class="ruby-ivar">@role</span> = <span class="ruby-identifier">role</span>
           <span class="ruby-ivar">@href</span> = <span class="ruby-identifier">href</span>
 
@@ -191,7 +197,7 @@
             onclick="toggleCode('M000006-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000006-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/xbrlware/linkbase/linkbase.rb, line 127</span>
+<span class="ruby-comment cmt"># File lib/xbrlware/linkbase/linkbase.rb, line 128</span>
         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">inspect</span>(<span class="ruby-identifier">verbose_flag</span>=<span class="ruby-value str">&quot;q&quot;</span>)
           <span class="ruby-identifier">puts</span> <span class="ruby-value str">&quot; title [&quot;</span><span class="ruby-operator">+</span><span class="ruby-identifier">title</span><span class="ruby-operator">+</span><span class="ruby-value str">&quot;] role [&quot;</span><span class="ruby-operator">+</span><span class="ruby-identifier">role</span><span class="ruby-operator">+</span><span class="ruby-value str">&quot;]&quot;</span>
           <span class="ruby-identifier">print_arc_hierarchy</span>(<span class="ruby-identifier">verbose_flag</span>)

data/doc/classes/Xbrlware/Linkbase/Linkbase/Link/Arc.html

@@ -178,7 +178,7 @@
             onclick="toggleCode('M000007-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000007-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/xbrlware/linkbase/linkbase.rb, line 138</span>
+<span class="ruby-comment cmt"># File lib/xbrlware/linkbase/linkbase.rb, line 139</span>
           <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">item_id</span>, <span class="ruby-identifier">href</span>, <span class="ruby-identifier">role</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">order</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">priority</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">label</span>=<span class="ruby-keyword kw">nil</span>)
             <span class="ruby-ivar">@item_id</span>=<span class="ruby-identifier">item_id</span>
             <span class="ruby-ivar">@href</span>=<span class="ruby-identifier">href</span>
@@ -214,7 +214,7 @@
             onclick="toggleCode('M000009-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000009-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/xbrlware/linkbase/linkbase.rb, line 157</span>
+<span class="ruby-comment cmt"># File lib/xbrlware/linkbase/linkbase.rb, line 158</span>
           <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">eql?</span>(<span class="ruby-identifier">o</span>)
             <span class="ruby-identifier">o</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Arc</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-ivar">@item_id</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">item_id</span>
           <span class="ruby-keyword kw">end</span>
@@ -237,7 +237,7 @@
             onclick="toggleCode('M000008-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000008-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/xbrlware/linkbase/linkbase.rb, line 153</span>
+<span class="ruby-comment cmt"># File lib/xbrlware/linkbase/linkbase.rb, line 154</span>
           <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">has_children?</span>
             <span class="ruby-ivar">@children</span>.<span class="ruby-identifier">size</span><span class="ruby-operator">&gt;</span><span class="ruby-value">0</span>
           <span class="ruby-keyword kw">end</span>
@@ -260,7 +260,7 @@
             onclick="toggleCode('M000010-source');return false;">[Source]</a></p>
           <div class="method-source-code" id="M000010-source">
 <pre>
-<span class="ruby-comment cmt"># File lib/xbrlware/linkbase/linkbase.rb, line 161</span>
+<span class="ruby-comment cmt"># File lib/xbrlware/linkbase/linkbase.rb, line 162</span>
           <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">hash</span>
             <span class="ruby-ivar">@item_id</span>.<span class="ruby-identifier">hash</span>
           <span class="ruby-keyword kw">end</span>

data/doc/classes/Xbrlware/Linkbase/PresentationLinkbase/Presentation.html

@@ -169,7 +169,7 @@
 <pre>
 <span class="ruby-comment cmt"># File lib/xbrlware/linkbase/presentation_linkbase.rb, line 135</span>
         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">entity_details</span>, <span class="ruby-identifier">title</span>, <span class="ruby-identifier">role</span>, <span class="ruby-identifier">href</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">contexts</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">arcs</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">definition</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">instance</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">dimensions</span>=[])
-          <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">title</span>, <span class="ruby-identifier">role</span>, <span class="ruby-identifier">href</span>, <span class="ruby-identifier">arcs</span>)
+          <span class="ruby-keyword kw">super</span>(<span class="ruby-value str">&quot;Presentation&quot;</span>, <span class="ruby-identifier">title</span>, <span class="ruby-identifier">role</span>, <span class="ruby-identifier">href</span>, <span class="ruby-identifier">arcs</span>)
           <span class="ruby-ivar">@entity_details</span>=<span class="ruby-identifier">entity_details</span>
           <span class="ruby-ivar">@contexts</span>=<span class="ruby-identifier">contexts</span>
           <span class="ruby-ivar">@definition</span>=<span class="ruby-identifier">definition</span>

data/doc/classes/Xbrlware/Report.html

@@ -0,0 +1,352 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Xbrlware::Report</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Xbrlware::Report</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/xbrlware/report_rb.html">
+                lib/xbrlware/report.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+This class defines methods to generate HTML reports from XBRL documents.
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000030">gen</a>&nbsp;&nbsp;
+      <a href="#M000031">gen_for</a>&nbsp;&nbsp;
+      <a href="#M000029">new</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+    <div id="constants-list">
+      <h3 class="section-bar">Constants</h3>
+
+      <div class="name-list">
+        <table summary="Constants">
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">PREF</td>
+          <td>=</td>
+          <td class="context-item-value">{}</td>
+        </tr>
+        </table>
+      </div>
+    </div>
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+
+      <div id="method-M000029" class="method-detail">
+        <a name="M000029"></a>
+
+        <div class="method-heading">
+          <a href="#M000029" class="method-signature">
+          <span class="method-name">new</span><span class="method-args">(entity_details={}, pref={})</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000029-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000029-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/xbrlware/report.rb, line 8</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">entity_details</span>={}, <span class="ruby-identifier">pref</span>={})
+      <span class="ruby-constant">PREF</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">pref</span>)
+      <span class="ruby-constant">PREF</span>[<span class="ruby-value str">&quot;ITEM_FORMAT&quot;</span>]=<span class="ruby-identifier">lambda</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">val</span><span class="ruby-operator">|</span> (<span class="ruby-constant">BigDecimal</span>(<span class="ruby-identifier">val</span>)<span class="ruby-operator">/</span><span class="ruby-value">1000000</span>).<span class="ruby-identifier">round</span>(<span class="ruby-value">4</span>).<span class="ruby-identifier">to_s</span>(<span class="ruby-value str">&quot;F&quot;</span>)} <span class="ruby-keyword kw">if</span> <span class="ruby-constant">PREF</span>[<span class="ruby-value str">&quot;ITEM_FORMAT&quot;</span>].<span class="ruby-identifier">nil?</span>
+      <span class="ruby-constant">PREF</span>[<span class="ruby-value str">&quot;ITEM_FORMAT_DESC&quot;</span>]=<span class="ruby-value str">&quot; in millions &quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-constant">PREF</span>[<span class="ruby-value str">&quot;ITEM_FORMAT_DESC&quot;</span>].<span class="ruby-identifier">nil?</span>
+      <span class="ruby-constant">PREF</span>[<span class="ruby-value str">&quot;ITEM_FORMAT_EXCLUDE&quot;</span>] = [<span class="ruby-value str">&quot;EntityRegistrantName&quot;</span>, <span class="ruby-value str">&quot;EntityCentralIndexKey&quot;</span>, <span class="ruby-value str">&quot;DocumentType&quot;</span>, <span class="ruby-value str">&quot;DocumentPeriodEndDate&quot;</span>, <span class="ruby-value str">&quot;CurrentFiscalYearEndDate&quot;</span>, <span class="ruby-value str">&quot;EntityCommonStockSharesOutstanding&quot;</span>] <span class="ruby-keyword kw">if</span> <span class="ruby-constant">PREF</span>[<span class="ruby-value str">&quot;ITEM_EXCLUDE&quot;</span>].<span class="ruby-identifier">nil?</span> 
+      <span class="ruby-ivar">@entity_details</span>=<span class="ruby-identifier">entity_details</span>
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000030" class="method-detail">
+        <a name="M000030"></a>
+
+        <div class="method-heading">
+          <a href="#M000030" class="method-signature">
+          <span class="method-name">gen</span><span class="method-args">(path_to_data_folder=&quot;.&quot;, report_for=&quot;pre|cal&quot;, report_type=&quot;html|xls|xml|json&quot;, verbose_flag=&quot;q&quot;)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Takes path to folder that contains xbrl documents of entities. If the
+folder contains xbrl documents of single entity then HTML reports are
+generated for that entity. If there is need to generate reports for
+multiple entities then
+</p>
+<pre>
+ 1. Create root folder
+ 2. Create subfolder for each entity inside root folder
+ 3. The sub folders contains xbrl documents of the entity
+ 4. File names of xbrl documents has to be in the following convention (if files are not in the convention mentioned below, you have to use gen_for method to generate reports)
+   calculation linkbase document must end with _cal.xml
+   definition linkbase document must end with _def.xml
+   presentation linkbase document must end with _pre.xml
+   label linkbase document must end with _lab.xml
+   taxonomy file must end with .xsd
+   instance document must end with .xml
+</pre>
+<p>
+calling &quot;<a href="Report.html#M000030">gen</a>&quot; with root folder,
+will create reports for all entities under root folder detailed reports are
+stored under &quot;reports&quot; folder of the entity. If the
+&quot;reports&quot; doesn&#8216;t exist, it will be created. Consolidated
+report of all generated reports is stored under root folder with name
+&quot;edgar_report_index.html&quot;
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000030-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000030-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/xbrlware/report.rb, line 122</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">gen</span>(<span class="ruby-identifier">path_to_data_folder</span>=<span class="ruby-value str">&quot;.&quot;</span>, <span class="ruby-identifier">report_for</span>=<span class="ruby-value str">&quot;pre|cal&quot;</span>, <span class="ruby-identifier">report_type</span>=<span class="ruby-value str">&quot;html|xls|xml|json&quot;</span>, <span class="ruby-identifier">verbose_flag</span>=<span class="ruby-value str">&quot;q&quot;</span>)
+      <span class="ruby-ivar">@ins_report_map</span>={}
+      <span class="ruby-identifier">files</span>=<span class="ruby-identifier">xbrl_files</span>(<span class="ruby-identifier">path_to_data_folder</span>)
+      <span class="ruby-identifier">$LOG</span>.<span class="ruby-identifier">info</span> <span class="ruby-value str">&quot; Filtering xbrl files from folder [&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">path_to_data_folder</span> <span class="ruby-operator">+</span> <span class="ruby-value str">&quot;] done&quot;</span>
+      <span class="ruby-identifier">files</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">file_map</span><span class="ruby-operator">|</span>
+        <span class="ruby-keyword kw">begin</span>
+          <span class="ruby-ivar">@ins_report_map</span>[<span class="ruby-identifier">file_map</span>[<span class="ruby-value str">&quot;ins&quot;</span>]]=<span class="ruby-identifier">gen_for</span>(<span class="ruby-identifier">file_map</span>, <span class="ruby-identifier">report_for</span>, <span class="ruby-identifier">report_type</span>, <span class="ruby-identifier">verbose_flag</span>)
+          <span class="ruby-identifier">$LOG</span>.<span class="ruby-identifier">info</span> <span class="ruby-value str">&quot;Report generation for [&quot;</span><span class="ruby-operator">+</span><span class="ruby-identifier">file_map</span>[<span class="ruby-value str">&quot;ins&quot;</span>]<span class="ruby-operator">+</span><span class="ruby-value str">&quot;] completed.&quot;</span>
+        <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span><span class="ruby-operator">:</span>
+          <span class="ruby-identifier">$LOG</span>.<span class="ruby-identifier">fatal</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>
+        <span class="ruby-keyword kw">end</span>
+      <span class="ruby-keyword kw">end</span>
+
+      <span class="ruby-identifier">erb</span> = <span class="ruby-constant">ERB</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@@html_template</span>)
+      <span class="ruby-identifier">index_content</span>=<span class="ruby-identifier">erb</span>.<span class="ruby-identifier">result</span>(<span class="ruby-identifier">get_binding</span>)
+      <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-value str">&quot;master_report_index.html&quot;</span>, <span class="ruby-value str">'w'</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">write</span>(<span class="ruby-identifier">index_content</span>) }
+
+    <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span><span class="ruby-operator">:</span>
+      <span class="ruby-identifier">$LOG</span>.<span class="ruby-identifier">fatal</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000031" class="method-detail">
+        <a name="M000031"></a>
+
+        <div class="method-heading">
+          <a href="#M000031" class="method-signature">
+          <span class="method-name">gen_for</span><span class="method-args">(file_map, report_for=&quot;pre|cal&quot;, report_type=&quot;html|xls|xml|json&quot;, verbose_flag=&quot;q&quot;, report_dir=nil, meta_gen=true)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Generates HTML reports from given Hash that contains files for instance,
+taxonomy, calculation, presentation, label, definition. Example of
+populating hash,
+</p>
+<pre>
+  files={}
+  files[&quot;ins&quot;] = &quot;&lt;instnace_file_path&gt;&quot;
+  files[&quot;tax&quot;] = &quot;&lt;taxonomy_file_path&gt;&quot;
+  files[&quot;cal&quot;] = &quot;&lt;calculation_linkbase_file_path&gt;&quot;
+  files[&quot;pre&quot;] = &quot;&lt;presentation_linkbase_file_path&gt;&quot;
+  files[&quot;lab&quot;] = &quot;&lt;label_linkbase_file_path&gt;&quot;
+  files[&quot;def&quot;] = &quot;&lt;definition_linkbase_file_path&gt;&quot;
+</pre>
+<p>
+Generated HTML reports will be stored under &quot;reports&quot; folder of
+current dir. If the &quot;reports&quot; doesn&#8216;t exist, it will be
+created. If &quot;cal&quot; is passed as null, calculation linkbase path
+from taxonomy will be used. Same for other linkbases too (ie,
+&quot;pre&quot;, &quot;lab&quot; and &quot;def&quot;.)
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000031-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000031-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/xbrlware/report.rb, line 204</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">gen_for</span> (<span class="ruby-identifier">file_map</span>, <span class="ruby-identifier">report_for</span>=<span class="ruby-value str">&quot;pre|cal&quot;</span>, <span class="ruby-identifier">report_type</span>=<span class="ruby-value str">&quot;html|xls|xml|json&quot;</span>, <span class="ruby-identifier">verbose_flag</span>=<span class="ruby-value str">&quot;q&quot;</span>, <span class="ruby-identifier">report_dir</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">meta_gen</span>=<span class="ruby-keyword kw">true</span>)
+      <span class="ruby-identifier">ins_file</span>=<span class="ruby-identifier">file_map</span>[<span class="ruby-value str">&quot;ins&quot;</span>]
+      <span class="ruby-identifier">tax_file</span>=<span class="ruby-identifier">file_map</span>[<span class="ruby-value str">&quot;tax&quot;</span>]
+      <span class="ruby-identifier">cal_file</span>=<span class="ruby-identifier">file_map</span>[<span class="ruby-value str">&quot;cal&quot;</span>]
+      <span class="ruby-identifier">pre_file</span>=<span class="ruby-identifier">file_map</span>[<span class="ruby-value str">&quot;pre&quot;</span>]
+      <span class="ruby-identifier">lab_file</span>=<span class="ruby-identifier">file_map</span>[<span class="ruby-value str">&quot;lab&quot;</span>]
+      <span class="ruby-identifier">def_file</span>=<span class="ruby-identifier">file_map</span>[<span class="ruby-value str">&quot;def&quot;</span>]
+
+      <span class="ruby-identifier">reports_map</span>={}
+
+      <span class="ruby-identifier">instance</span>=<span class="ruby-keyword kw">nil</span>
+      <span class="ruby-identifier">m</span>=<span class="ruby-constant">Benchmark</span>.<span class="ruby-identifier">measure</span> <span class="ruby-keyword kw">do</span>
+        <span class="ruby-identifier">instance</span> = <span class="ruby-constant">Instance</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">ins_file</span>, <span class="ruby-identifier">tax_file</span>)
+        <span class="ruby-identifier">taxonomy</span>=<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">taxonomy</span>
+        <span class="ruby-identifier">taxonomy</span>.<span class="ruby-identifier">init_all_lb</span>(<span class="ruby-identifier">cal_file</span>, <span class="ruby-identifier">pre_file</span>, <span class="ruby-identifier">lab_file</span>, <span class="ruby-identifier">def_file</span>)
+      <span class="ruby-keyword kw">end</span>
+      <span class="ruby-identifier">bm</span>(<span class="ruby-value str">&quot; Initializing xbrl took&quot;</span>, <span class="ruby-identifier">m</span>)
+
+      <span class="ruby-identifier">instance</span>.<span class="ruby-identifier">entity_details</span>=<span class="ruby-ivar">@entity_details</span>
+      <span class="ruby-identifier">reports_map</span>[<span class="ruby-value str">&quot;entity_details&quot;</span>]=<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">entity_details</span>
+      <span class="ruby-identifier">reports_map</span>[<span class="ruby-value str">&quot;instance&quot;</span>]=<span class="ruby-identifier">instance</span>
+
+      <span class="ruby-identifier">report_dir</span> = (<span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-identifier">ins_file</span>)) <span class="ruby-operator">+</span> <span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">Separator</span> <span class="ruby-operator">+</span> <span class="ruby-value str">&quot;report&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">Separator</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">report_dir</span>.<span class="ruby-identifier">nil?</span>
+      <span class="ruby-constant">File</span>.<span class="ruby-identifier">makedirs</span>(<span class="ruby-identifier">report_dir</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">report_dir</span>)
+
+      <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">report_for</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/pre/</span> <span class="ruby-operator">&amp;&amp;</span> (<span class="ruby-keyword kw">not</span> <span class="ruby-identifier">instance</span>.<span class="ruby-identifier">taxonomy</span>.<span class="ruby-identifier">prelb</span>.<span class="ruby-identifier">nil?</span>)
+        <span class="ruby-identifier">links</span>=<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">taxonomy</span>.<span class="ruby-identifier">prelb</span>.<span class="ruby-identifier">presentation</span>
+        <span class="ruby-identifier">pre_dir</span> = <span class="ruby-identifier">report_dir</span> <span class="ruby-operator">+</span> <span class="ruby-value str">&quot;pre&quot;</span>
+        <span class="ruby-constant">File</span>.<span class="ruby-identifier">makedirs</span>(<span class="ruby-identifier">pre_dir</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">pre_dir</span>)
+        <span class="ruby-identifier">reports_map</span>[<span class="ruby-value str">&quot;pre&quot;</span>]=<span class="ruby-identifier">write_reports</span>(<span class="ruby-identifier">links</span>, <span class="ruby-identifier">pre_dir</span>, <span class="ruby-identifier">report_type</span>, <span class="ruby-identifier">verbose_flag</span>)
+      <span class="ruby-keyword kw">end</span>
+
+      <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">report_for</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/cal/</span> <span class="ruby-operator">&amp;&amp;</span> (<span class="ruby-keyword kw">not</span> <span class="ruby-identifier">instance</span>.<span class="ruby-identifier">taxonomy</span>.<span class="ruby-identifier">callb</span>.<span class="ruby-identifier">nil?</span>)
+        <span class="ruby-identifier">links</span>=<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">taxonomy</span>.<span class="ruby-identifier">callb</span>.<span class="ruby-identifier">calculation</span>
+        <span class="ruby-identifier">cal_dir</span> = <span class="ruby-identifier">report_dir</span> <span class="ruby-operator">+</span> <span class="ruby-value str">&quot;cal&quot;</span>
+        <span class="ruby-constant">File</span>.<span class="ruby-identifier">makedirs</span>(<span class="ruby-identifier">cal_dir</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">cal_dir</span>)
+        <span class="ruby-identifier">reports_map</span>[<span class="ruby-value str">&quot;cal&quot;</span>]=<span class="ruby-identifier">write_reports</span>(<span class="ruby-identifier">links</span>, <span class="ruby-identifier">cal_dir</span>, <span class="ruby-identifier">report_type</span>, <span class="ruby-identifier">verbose_flag</span>)
+      <span class="ruby-keyword kw">end</span>
+
+      <span class="ruby-identifier">_tmp</span> = <span class="ruby-ivar">@ins_report_map</span>
+
+      <span class="ruby-identifier">erb</span> = <span class="ruby-constant">ERB</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@@html_template</span>)
+      <span class="ruby-identifier">index_content</span>=<span class="ruby-identifier">erb</span>.<span class="ruby-identifier">result</span>(<span class="ruby-identifier">lambda</span> <span class="ruby-keyword kw">do</span>
+        <span class="ruby-ivar">@ins_report_map</span>={}
+        <span class="ruby-ivar">@ins_report_map</span>[<span class="ruby-identifier">file_map</span>[<span class="ruby-value str">&quot;ins&quot;</span>]]=<span class="ruby-identifier">reports_map</span>
+        <span class="ruby-identifier">lambda</span> {}
+      <span class="ruby-keyword kw">end</span>.<span class="ruby-identifier">call</span>)
+
+      <span class="ruby-ivar">@ins_report_map</span> = <span class="ruby-identifier">_tmp</span>
+
+<span class="ruby-comment cmt">#      str_ci_key=reports_map[&quot;entity_details&quot;][&quot;ci_key&quot;]</span>
+<span class="ruby-comment cmt">#      str_doc_end_date=reports_map[&quot;entity_details&quot;][&quot;doc_end_date&quot;]</span>
+<span class="ruby-comment cmt">#      str_doc_end_date=&quot;&quot; if str_doc_end_date.nil?</span>
+<span class="ruby-comment cmt">#      str_doc_end_date.gsub!(&quot;-&quot;, &quot;&quot;)</span>
+<span class="ruby-comment cmt">#      report_index_file = report_dir + str_ci_key+&quot;_&quot;+str_doc_end_date+&quot;_report.html&quot;</span>
+
+      <span class="ruby-identifier">report_index_file</span> = <span class="ruby-identifier">report_dir</span> <span class="ruby-operator">+</span> <span class="ruby-value str">&quot;report_index.html&quot;</span>
+      <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>( <span class="ruby-identifier">report_index_file</span>, <span class="ruby-value str">'w'</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">write</span>(<span class="ruby-identifier">index_content</span>) }
+
+      <span class="ruby-identifier">reports_map</span>[<span class="ruby-value str">&quot;report_index_file&quot;</span>]=<span class="ruby-identifier">report_index_file</span>
+
+      <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">meta_gen</span>
+        <span class="ruby-identifier">meta_file_name</span> = <span class="ruby-identifier">report_dir</span> <span class="ruby-operator">+</span> <span class="ruby-value str">&quot;meta.json&quot;</span>
+        <span class="ruby-identifier">meta_gen_content</span> = <span class="ruby-identifier">reports_map</span>.<span class="ruby-identifier">reject</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">k</span><span class="ruby-operator">==</span><span class="ruby-value str">&quot;instance&quot;</span>}.<span class="ruby-identifier">to_json</span>.<span class="ruby-identifier">to_s</span>
+        <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>( <span class="ruby-identifier">meta_file_name</span>, <span class="ruby-value str">'w'</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">write</span>(<span class="ruby-identifier">meta_gen_content</span>) }
+        <span class="ruby-identifier">reports_map</span>[<span class="ruby-value str">&quot;report_meta_file&quot;</span>]=<span class="ruby-identifier">meta_file_name</span>
+      <span class="ruby-keyword kw">end</span>
+
+      <span class="ruby-identifier">reports_map</span>
+    <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
+      <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot; Report generation failed for instance &quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">ins_file</span> <span class="ruby-operator">+</span> <span class="ruby-node">&quot;\n #{e.to_s + &quot;\n&quot; + e.backtrace.join(&quot;\n &quot;)}&quot;</span>
+    <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>