xbrlware-ce 1.0.2 → 1.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (44) hide show
  1. data/Rakefile.rb +1 -1
  2. data/ReleaseNotes.txt +8 -0
  3. data/doc/classes/CGI.html +195 -0
  4. data/doc/classes/Edgar/HTMLFeedDownloader.html +8 -8
  5. data/doc/classes/Edgar/RSSFeedDownloader.html +15 -15
  6. data/doc/classes/Xbrlware/Context.html +63 -63
  7. data/doc/classes/Xbrlware/Entity.html +36 -36
  8. data/doc/classes/Xbrlware/Identifier.html +12 -12
  9. data/doc/classes/Xbrlware/Instance.html +91 -91
  10. data/doc/classes/Xbrlware/Item.html +19 -19
  11. data/doc/classes/Xbrlware/Linkbase/CalculationLinkbase/Calculation/CalculationArc.html +6 -6
  12. data/doc/classes/Xbrlware/Linkbase/CalculationLinkbase/Calculation.html +6 -6
  13. data/doc/classes/Xbrlware/Linkbase/CalculationLinkbase.html +12 -12
  14. data/doc/classes/Xbrlware/Linkbase/DefinitionLinkbase/Definition/DefinitionArc.html +6 -6
  15. data/doc/classes/Xbrlware/Linkbase/DefinitionLinkbase/Definition.html +12 -12
  16. data/doc/classes/Xbrlware/Linkbase/DefinitionLinkbase.html +13 -13
  17. data/doc/classes/Xbrlware/Linkbase/LabelLinkbase/Label.html +6 -6
  18. data/doc/classes/Xbrlware/Linkbase/LabelLinkbase.html +19 -19
  19. data/doc/classes/Xbrlware/Linkbase/Linkbase/Link/Arc.html +24 -24
  20. data/doc/classes/Xbrlware/Linkbase/Linkbase/Link.html +12 -12
  21. data/doc/classes/Xbrlware/Linkbase/Linkbase.html +6 -6
  22. data/doc/classes/Xbrlware/Linkbase/PresentationLinkbase/Presentation/PresentationArc.html +6 -6
  23. data/doc/classes/Xbrlware/Linkbase/PresentationLinkbase/Presentation.html +12 -12
  24. data/doc/classes/Xbrlware/Linkbase/PresentationLinkbase.html +13 -13
  25. data/doc/classes/Xbrlware/Taxonomy.html +44 -44
  26. data/doc/classes/Xbrlware/TaxonomyDefintion.html +12 -12
  27. data/doc/classes/Xbrlware/Unit/Divide.html +6 -6
  28. data/doc/classes/Xbrlware/Unit.html +6 -6
  29. data/doc/classes/Xbrlware.html +17 -14
  30. data/doc/created.rid +1 -1
  31. data/doc/files/lib/edgar_rb.html +2 -1
  32. data/doc/files/lib/xbrlware/cgi_patch_rb.html +120 -0
  33. data/doc/files/lib/xbrlware/instance_rb.html +1 -1
  34. data/doc/files/lib/xbrlware/util_rb.html +1 -1
  35. data/doc/files/lib/xbrlware_rb.html +2 -1
  36. data/doc/fr_class_index.html +1 -0
  37. data/doc/fr_file_index.html +1 -0
  38. data/doc/fr_method_index.html +79 -78
  39. data/lib/edgar.rb +3 -1
  40. data/lib/xbrlware/cgi_patch.rb +58 -0
  41. data/lib/xbrlware/instance.rb +5 -3
  42. data/lib/xbrlware/util.rb +4 -1
  43. data/lib/xbrlware.rb +1 -0
  44. metadata +6 -2
data/Rakefile.rb CHANGED
@@ -32,7 +32,7 @@ TESTDIR = 'test'
32
32
  EXAMPLEDIR = 'example'
33
33
 
34
34
  # Configure some constants and built-in tasks
35
- CURRENT_VERSION = '1.0.2'
35
+ CURRENT_VERSION = '1.0.3'
36
36
  PKG_VERSION = ENV['REL'] ? ENV['REL'] : CURRENT_VERSION
37
37
 
38
38
  COMMUNITY_EDITION = 'xbrlware-ce'
data/ReleaseNotes.txt ADDED
@@ -0,0 +1,8 @@
1
+ bitstat xbrlware community edition 1.0.3 release notes
2
+
3
+ Bugs
4
+
5
+ * [xbrlware-ce-dev-1] : footnoteLink element may exist without footnote, footnoteArc in instance document.
6
+ * [xbrlware-ce-dev-2] : error raised when xbrl linkbase document has HTML element  
7
+ * [xbrlware-ce-dev-3] : file_grep not working as intended when reference linkbase file is present.
8
+
data/doc/classes/CGI.html ADDED
@@ -0,0 +1,195 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+
6
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
+ <head>
8
+ <title>Class: CGI</title>
9
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
+ <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
12
+ <script type="text/javascript">
13
+ // <![CDATA[
14
+
15
+ function popupCode( url ) {
16
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
+ }
18
+
19
+ function toggleCode( id ) {
20
+ if ( document.getElementById )
21
+ elem = document.getElementById( id );
22
+ else if ( document.all )
23
+ elem = eval( "document.all." + id );
24
+ else
25
+ return false;
26
+
27
+ elemStyle = elem.style;
28
+
29
+ if ( elemStyle.display != "block" ) {
30
+ elemStyle.display = "block"
31
+ } else {
32
+ elemStyle.display = "none"
33
+ }
34
+
35
+ return true;
36
+ }
37
+
38
+ // Make codeblocks hidden by default
39
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
+
41
+ // ]]>
42
+ </script>
43
+
44
+ </head>
45
+ <body>
46
+
47
+
48
+
49
+ <div id="classHeader">
50
+ <table class="header-table">
51
+ <tr class="top-aligned-row">
52
+ <td><strong>Class</strong></td>
53
+ <td class="class-name-in-header">CGI</td>
54
+ </tr>
55
+ <tr class="top-aligned-row">
56
+ <td><strong>In:</strong></td>
57
+ <td>
58
+ <a href="../files/lib/xbrlware/cgi_patch_rb.html">
59
+ lib/xbrlware/cgi_patch.rb
60
+ </a>
61
+ <br />
62
+ </td>
63
+ </tr>
64
+
65
+ <tr class="top-aligned-row">
66
+ <td><strong>Parent:</strong></td>
67
+ <td>
68
+ Object
69
+ </td>
70
+ </tr>
71
+ </table>
72
+ </div>
73
+ <!-- banner header -->
74
+
75
+ <div id="bodyContent">
76
+
77
+
78
+
79
+ <div id="contextContent">
80
+
81
+ <div id="description">
82
+ <p>
83
+ below method copied from ruby-1.8.7-p248, ruby 1.8.7 (2009-12-24 patchlevel
84
+ 248) for patching.
85
+ </p>
86
+
87
+ </div>
88
+
89
+
90
+ </div>
91
+
92
+ <div id="method-list">
93
+ <h3 class="section-bar">Methods</h3>
94
+
95
+ <div class="name-list">
96
+ <a href="#M000001">unescapeHTML</a>&nbsp;&nbsp;
97
+ </div>
98
+ </div>
99
+
100
+ </div>
101
+
102
+
103
+ <!-- if includes -->
104
+
105
+ <div id="section">
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+ <!-- if method_list -->
115
+ <div id="methods">
116
+ <h3 class="section-bar">Public Class methods</h3>
117
+
118
+ <div id="method-M000001" class="method-detail">
119
+ <a name="M000001"></a>
120
+
121
+ <div class="method-heading">
122
+ <a href="#M000001" class="method-signature">
123
+ <span class="method-name">unescapeHTML</span><span class="method-args">(string)</span>
124
+ </a>
125
+ </div>
126
+
127
+ <div class="method-description">
128
+ <p>
129
+ Unescape a string that has been HTML-escaped
130
+ </p>
131
+ <pre>
132
+ CGI::unescapeHTML(&quot;Usage: foo &amp;quot;bar&amp;quot; &amp;lt;baz&amp;gt;&quot;)
133
+ # =&gt; &quot;Usage: foo \&quot;bar\&quot; &lt;baz&gt;&quot;
134
+ </pre>
135
+ <p><a class="source-toggle" href="#"
136
+ onclick="toggleCode('M000001-source');return false;">[Source]</a></p>
137
+ <div class="method-source-code" id="M000001-source">
138
+ <pre>
139
+ <span class="ruby-comment cmt"># File lib/xbrlware/cgi_patch.rb, line 19</span>
140
+ <span class="ruby-keyword kw">def</span> <span class="ruby-constant">CGI</span><span class="ruby-operator">::</span><span class="ruby-identifier">unescapeHTML</span>(<span class="ruby-identifier">string</span>)
141
+ <span class="ruby-identifier">string</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/&amp;(amp|quot|gt|lt|\#[0-9]+|\#x[0-9A-Fa-f]+);/n</span>) <span class="ruby-keyword kw">do</span>
142
+ <span class="ruby-identifier">match</span> = <span class="ruby-identifier">$1</span>.<span class="ruby-identifier">dup</span>
143
+ <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">match</span>
144
+ <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'amp'</span> <span class="ruby-keyword kw">then</span>
145
+ <span class="ruby-value str">'&amp;'</span>
146
+ <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'quot'</span> <span class="ruby-keyword kw">then</span>
147
+ <span class="ruby-value str">'&quot;'</span>
148
+ <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'gt'</span> <span class="ruby-keyword kw">then</span>
149
+ <span class="ruby-value str">'&gt;'</span>
150
+ <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'lt'</span> <span class="ruby-keyword kw">then</span>
151
+ <span class="ruby-value str">'&lt;'</span>
152
+ <span class="ruby-keyword kw">when</span> <span class="ruby-regexp re">/\A#0*(\d+)\z/n</span> <span class="ruby-keyword kw">then</span>
153
+ <span class="ruby-keyword kw">if</span> <span class="ruby-constant">Integer</span>(<span class="ruby-identifier">$1</span>) <span class="ruby-operator">&lt;</span> <span class="ruby-value">256</span>
154
+ <span class="ruby-value">32</span>.<span class="ruby-identifier">chr</span> <span class="ruby-keyword kw">if</span> <span class="ruby-constant">Integer</span>(<span class="ruby-identifier">$1</span>) <span class="ruby-operator">&gt;</span> <span class="ruby-value">126</span>
155
+ <span class="ruby-constant">Integer</span>(<span class="ruby-identifier">$1</span>).<span class="ruby-identifier">chr</span> <span class="ruby-keyword kw">if</span> <span class="ruby-constant">Integer</span>(<span class="ruby-identifier">$1</span>) <span class="ruby-operator">&lt;=</span> <span class="ruby-value">126</span>
156
+ <span class="ruby-keyword kw">else</span>
157
+ <span class="ruby-keyword kw">if</span> <span class="ruby-constant">Integer</span>(<span class="ruby-identifier">$1</span>) <span class="ruby-operator">&lt;</span> <span class="ruby-value">65536</span> <span class="ruby-keyword kw">and</span> (<span class="ruby-identifier">$KCODE</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">?u</span> <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">$KCODE</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">?U</span>)
158
+ [<span class="ruby-constant">Integer</span>(<span class="ruby-identifier">$1</span>)].<span class="ruby-identifier">pack</span>(<span class="ruby-value str">&quot;U&quot;</span>)
159
+ <span class="ruby-keyword kw">else</span>
160
+ <span class="ruby-node">&quot;&amp;##{$1};&quot;</span>
161
+ <span class="ruby-keyword kw">end</span>
162
+ <span class="ruby-keyword kw">end</span>
163
+ <span class="ruby-keyword kw">when</span> <span class="ruby-regexp re">/\A#x([0-9a-f]+)\z/n</span><span class="ruby-identifier">i</span> <span class="ruby-keyword kw">then</span>
164
+ <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">$1</span>.<span class="ruby-identifier">hex</span> <span class="ruby-operator">&lt;</span> <span class="ruby-value">128</span>
165
+ <span class="ruby-identifier">$1</span>.<span class="ruby-identifier">hex</span>.<span class="ruby-identifier">chr</span>
166
+ <span class="ruby-keyword kw">else</span>
167
+ <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">$1</span>.<span class="ruby-identifier">hex</span> <span class="ruby-operator">&lt;</span> <span class="ruby-value">65536</span> <span class="ruby-keyword kw">and</span> (<span class="ruby-identifier">$KCODE</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">?u</span> <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">$KCODE</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">?U</span>)
168
+ [<span class="ruby-identifier">$1</span>.<span class="ruby-identifier">hex</span>].<span class="ruby-identifier">pack</span>(<span class="ruby-value str">&quot;U&quot;</span>)
169
+ <span class="ruby-keyword kw">else</span>
170
+ <span class="ruby-node">&quot;&amp;#x#{$1};&quot;</span>
171
+ <span class="ruby-keyword kw">end</span>
172
+ <span class="ruby-keyword kw">end</span>
173
+ <span class="ruby-keyword kw">else</span>
174
+ <span class="ruby-node">&quot;&amp;#{match};&quot;</span>
175
+ <span class="ruby-keyword kw">end</span>
176
+ <span class="ruby-keyword kw">end</span>
177
+ <span class="ruby-keyword kw">end</span>
178
+ </pre>
179
+ </div>
180
+ </div>
181
+ </div>
182
+
183
+
184
+ </div>
185
+
186
+
187
+ </div>
188
+
189
+
190
+ <div id="validator-badges">
191
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
192
+ </div>
193
+
194
+ </body>
195
+ </html>
data/doc/classes/Edgar/HTMLFeedDownloader.html CHANGED
@@ -81,7 +81,7 @@
81
81
  <div id="description">
82
82
  <p>
83
83
  This class defines method to <a
84
- href="HTMLFeedDownloader.html#M000078">download</a> XBRL files from
84
+ href="HTMLFeedDownloader.html#M000079">download</a> XBRL files from
85
85
  SEC&#8216;s EDGAR filling url. See <a
86
86
  href="http://code.google.com/p/xbrlware/wiki/ReportGeneration">report
87
87
  generation xbrlware wiki</a> for how to use this class.
@@ -96,7 +96,7 @@ generation xbrlware wiki</a> for how to use this class.
96
96
  <h3 class="section-bar">Methods</h3>
97
97
 
98
98
  <div class="name-list">
99
- <a href="#M000078">download</a>&nbsp;&nbsp;
99
+ <a href="#M000079">download</a>&nbsp;&nbsp;
100
100
  </div>
101
101
  </div>
102
102
 
@@ -139,11 +139,11 @@ generation xbrlware wiki</a> for how to use this class.
139
139
  <div id="methods">
140
140
  <h3 class="section-bar">Public Instance methods</h3>
141
141
 
142
- <div id="method-M000078" class="method-detail">
143
- <a name="M000078"></a>
142
+ <div id="method-M000079" class="method-detail">
143
+ <a name="M000079"></a>
144
144
 
145
145
  <div class="method-heading">
146
- <a href="#M000078" class="method-signature">
146
+ <a href="#M000079" class="method-signature">
147
147
  <span class="method-name">download</span><span class="method-args">(url, download_to=File.expand_path(&quot;.&quot;)+File::SEPARATOR)</span>
148
148
  </a>
149
149
  </div>
@@ -151,14 +151,14 @@ generation xbrlware wiki</a> for how to use this class.
151
151
  <div class="method-description">
152
152
  <p>
153
153
  Takes url and download_to (where to <a
154
- href="HTMLFeedDownloader.html#M000078">download</a>)
154
+ href="HTMLFeedDownloader.html#M000079">download</a>)
155
155
  </p>
156
156
  <pre>
157
157
  default value for download_to is current_dir
158
158
  </pre>
159
159
  <p><a class="source-toggle" href="#"
160
- onclick="toggleCode('M000078-source');return false;">[Source]</a></p>
161
- <div class="method-source-code" id="M000078-source">
160
+ onclick="toggleCode('M000079-source');return false;">[Source]</a></p>
161
+ <div class="method-source-code" id="M000079-source">
162
162
  <pre>
163
163
  <span class="ruby-comment cmt"># File lib/edgar/edgar_data_downloader.rb, line 92</span>
164
164
  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">download</span>(<span class="ruby-identifier">url</span>, <span class="ruby-identifier">download_to</span>=<span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-value str">&quot;.&quot;</span>)<span class="ruby-operator">+</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">SEPARATOR</span>)
data/doc/classes/Edgar/RSSFeedDownloader.html CHANGED
@@ -81,7 +81,7 @@
81
81
  <div id="description">
82
82
  <p>
83
83
  This class defines method to <a
84
- href="RSSFeedDownloader.html#M000077">download</a> XBRL files from
84
+ href="RSSFeedDownloader.html#M000078">download</a> XBRL files from
85
85
  SEC&#8216;s XBRL RSS Feed. See <a
86
86
  href="http://code.google.com/p/xbrlware/wiki/ReportGeneration">report
87
87
  generation xbrlware wiki</a> for how to use this class.
@@ -96,8 +96,8 @@ generation xbrlware wiki</a> for how to use this class.
96
96
  <h3 class="section-bar">Methods</h3>
97
97
 
98
98
  <div class="name-list">
99
- <a href="#M000077">download</a>&nbsp;&nbsp;
100
- <a href="#M000076">new</a>&nbsp;&nbsp;
99
+ <a href="#M000078">download</a>&nbsp;&nbsp;
100
+ <a href="#M000077">new</a>&nbsp;&nbsp;
101
101
  </div>
102
102
  </div>
103
103
 
@@ -139,19 +139,19 @@ generation xbrlware wiki</a> for how to use this class.
139
139
  <div id="methods">
140
140
  <h3 class="section-bar">Public Class methods</h3>
141
141
 
142
- <div id="method-M000076" class="method-detail">
143
- <a name="M000076"></a>
142
+ <div id="method-M000077" class="method-detail">
143
+ <a name="M000077"></a>
144
144
 
145
145
  <div class="method-heading">
146
- <a href="#M000076" class="method-signature">
146
+ <a href="#M000077" class="method-signature">
147
147
  <span class="method-name">new</span><span class="method-args">(sec_edgar_rss_file=nil)</span>
148
148
  </a>
149
149
  </div>
150
150
 
151
151
  <div class="method-description">
152
152
  <p><a class="source-toggle" href="#"
153
- onclick="toggleCode('M000076-source');return false;">[Source]</a></p>
154
- <div class="method-source-code" id="M000076-source">
153
+ onclick="toggleCode('M000077-source');return false;">[Source]</a></p>
154
+ <div class="method-source-code" id="M000077-source">
155
155
  <pre>
156
156
  <span class="ruby-comment cmt"># File lib/edgar/edgar_data_downloader.rb, line 29</span>
157
157
  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">sec_edgar_rss_file</span>=<span class="ruby-keyword kw">nil</span>)
@@ -165,11 +165,11 @@ generation xbrlware wiki</a> for how to use this class.
165
165
 
166
166
  <h3 class="section-bar">Public Instance methods</h3>
167
167
 
168
- <div id="method-M000077" class="method-detail">
169
- <a name="M000077"></a>
168
+ <div id="method-M000078" class="method-detail">
169
+ <a name="M000078"></a>
170
170
 
171
171
  <div class="method-heading">
172
- <a href="#M000077" class="method-signature">
172
+ <a href="#M000078" class="method-signature">
173
173
  <span class="method-name">download</span><span class="method-args">(limit=100, download_to=File.expand_path(&quot;.&quot;)+File::SEPARATOR+&quot;edgar_data&quot;)</span>
174
174
  </a>
175
175
  </div>
@@ -177,16 +177,16 @@ generation xbrlware wiki</a> for how to use this class.
177
177
  <div class="method-description">
178
178
  <p>
179
179
  Takes limit (how many entities to <a
180
- href="RSSFeedDownloader.html#M000077">download</a>), download_to (where to
181
- <a href="RSSFeedDownloader.html#M000077">download</a>)
180
+ href="RSSFeedDownloader.html#M000078">download</a>), download_to (where to
181
+ <a href="RSSFeedDownloader.html#M000078">download</a>)
182
182
  </p>
183
183
  <pre>
184
184
  default value for limit is 100
185
185
  default value for download_to is current_dir + &quot;/edgar_data&quot;
186
186
  </pre>
187
187
  <p><a class="source-toggle" href="#"
188
- onclick="toggleCode('M000077-source');return false;">[Source]</a></p>
189
- <div class="method-source-code" id="M000077-source">
188
+ onclick="toggleCode('M000078-source');return false;">[Source]</a></p>
189
+ <div class="method-source-code" id="M000078-source">
190
190
  <pre>
191
191
  <span class="ruby-comment cmt"># File lib/edgar/edgar_data_downloader.rb, line 37</span>
192
192
  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">download</span>(<span class="ruby-identifier">limit</span>=<span class="ruby-value">100</span>, <span class="ruby-identifier">download_to</span>=<span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-value str">&quot;.&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-operator">+</span><span class="ruby-value str">&quot;edgar_data&quot;</span>)