Skip to content

Commit aea2374

Browse files
ianardeeianardee
committed
deploy: 76dc287 
1 parent 9839f15 commit aea2374

508 files changed

Lines changed: 64210 additions & 112670 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎Mindee.html‎

Lines changed: 8 additions & 8 deletions
Large diffs are not rendered by default.

‎Mindee/Dependency.html‎

Lines changed: 363 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,363 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6+
<title>
7+
Module: Mindee::Dependency
8+
9+
&mdash; Documentation by YARD 0.9.38
10+
11+
</title>
12+
13+
<link rel="stylesheet" href="../css/style.css" type="text/css" />
14+
15+
<link rel="stylesheet" href="../css/common.css" type="text/css" />
16+
17+
<script type="text/javascript">
18+
pathId = "Mindee::Dependency";
19+
relpath = '../';
20+
</script>
21+
22+
23+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
24+
25+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
26+
27+
28+
</head>
29+
<body>
30+
<div class="nav_wrap">
31+
<iframe id="nav" src="../class_list.html?1"></iframe>
32+
<div id="resizer"></div>
33+
</div>
34+
35+
<div id="main" tabindex="-1">
36+
<div id="header">
37+
<div id="menu">
38+
39+
<a href="../_index.html">Index (D)</a> &raquo;
40+
<span class='title'><span class='object_link'><a href="../Mindee.html" title="Mindee (module)">Mindee</a></span></span>
41+
&raquo;
42+
<span class="title">Dependency</span>
43+
44+
</div>
45+
46+
<div id="search">
47+
48+
<a class="full_list_link" id="class_list_link"
49+
href="../class_list.html">
50+
51+
<svg width="24" height="24">
52+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55+
</svg>
56+
</a>
57+
58+
</div>
59+
<div class="clear"></div>
60+
</div>
61+
62+
<div id="content"><h1>Module: Mindee::Dependency
63+
64+
65+
66+
</h1>
67+
<div class="box_info">
68+
69+
70+
71+
72+
73+
74+
75+
76+
77+
78+
79+
<dl>
80+
<dt>Defined in:</dt>
81+
<dd>lib/mindee.rb<span class="defines">,<br />
82+
lib/mindee/dependency.rb</span>
83+
</dd>
84+
</dl>
85+
86+
</div>
87+
88+
<h2>Overview</h2><div class="docstring">
89+
<div class="discussion">
90+
91+
<p>Centralized check for optional heavy dependencies</p>
92+
93+
94+
</div>
95+
</div>
96+
<div class="tags">
97+
98+
99+
</div>
100+
101+
<h2>
102+
Constant Summary
103+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
104+
</h2>
105+
106+
<dl class="constants">
107+
108+
<dt id="MINDEE_DEPENDENCIES_LOAD_ERROR-constant" class="">MINDEE_DEPENDENCIES_LOAD_ERROR =
109+
110+
</dt>
111+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Attempted to load Mindee PDF/Image tools without required dependencies. </span><span class='tstring_end'>&#39;</span></span> \
112+
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>If you need to process local files, please replace the &#39;mindee-lite&#39; gem </span><span class='tstring_end'>&quot;</span></span> \
113+
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>with the standard &#39;mindee&#39; gem in your Gemfile.</span><span class='tstring_end'>&quot;</span></span></pre></dd>
114+
115+
</dl>
116+
117+
118+
119+
120+
121+
122+
123+
124+
125+
<h2>
126+
Class Method Summary
127+
<small><a href="#" class="summary_toggle">collapse</a></small>
128+
</h2>
129+
130+
<ul class="summary">
131+
132+
<li class="public ">
133+
<span class="summary_signature">
134+
135+
<a href="#all_deps_available%3F-class_method" title="all_deps_available? (class method)">.<strong>all_deps_available?</strong> &#x21d2; Boolean </a>
136+
137+
138+
139+
</span>
140+
141+
142+
143+
144+
145+
146+
147+
148+
149+
<span class="summary_desc"><div class='inline'></div></span>
150+
151+
</li>
152+
153+
154+
<li class="public ">
155+
<span class="summary_signature">
156+
157+
<a href="#check_all_dependencies-class_method" title="check_all_dependencies (class method)">.<strong>check_all_dependencies</strong> &#x21d2; Object </a>
158+
159+
160+
161+
</span>
162+
163+
164+
165+
166+
167+
168+
169+
170+
171+
<span class="summary_desc"><div class='inline'></div></span>
172+
173+
</li>
174+
175+
176+
<li class="public ">
177+
<span class="summary_signature">
178+
179+
<a href="#require_all_deps!-class_method" title="require_all_deps! (class method)">.<strong>require_all_deps!</strong> &#x21d2; Object </a>
180+
181+
182+
183+
</span>
184+
185+
186+
187+
188+
189+
190+
191+
192+
193+
<span class="summary_desc"><div class='inline'></div></span>
194+
195+
</li>
196+
197+
198+
</ul>
199+
200+
201+
202+
203+
<div id="class_method_details" class="method_details_list">
204+
<h2>Class Method Details</h2>
205+
206+
207+
<div class="method_details first">
208+
<h3 class="signature first" id="all_deps_available?-class_method">
209+
210+
.<strong>all_deps_available?</strong> &#x21d2; <tt>Boolean</tt>
211+
212+
213+
214+
215+
216+
</h3><div class="docstring">
217+
<div class="discussion">
218+
219+
220+
</div>
221+
</div>
222+
<div class="tags">
223+
224+
<p class="tag_title">Returns:</p>
225+
<ul class="return">
226+
227+
<li>
228+
229+
230+
<span class='type'>(<tt>Boolean</tt>)</span>
231+
232+
233+
234+
</li>
235+
236+
</ul>
237+
238+
</div><table class="source_code">
239+
<tr>
240+
<td>
241+
<pre class="lines">
242+
243+
244+
17
245+
18
246+
19</pre>
247+
</td>
248+
<td>
249+
<pre class="code"><span class="info file"># File 'lib/mindee/dependency.rb', line 17</span>
250+
251+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_all_deps_available?'>all_deps_available?</span>
252+
<span class='id identifier rubyid_check_all_dependencies'>check_all_dependencies</span>
253+
<span class='kw'>end</span></pre>
254+
</td>
255+
</tr>
256+
</table>
257+
</div>
258+
259+
<div class="method_details ">
260+
<h3 class="signature " id="check_all_dependencies-class_method">
261+
262+
.<strong>check_all_dependencies</strong> &#x21d2; <tt>Object</tt>
263+
264+
265+
266+
267+
268+
</h3><table class="source_code">
269+
<tr>
270+
<td>
271+
<pre class="lines">
272+
273+
274+
6
275+
7
276+
8
277+
9
278+
10
279+
11
280+
12
281+
13</pre>
282+
</td>
283+
<td>
284+
<pre class="code"><span class="info file"># File 'lib/mindee/dependency.rb', line 6</span>
285+
286+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_check_all_dependencies'>check_all_dependencies</span>
287+
<span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>origami</span><span class='tstring_end'>&#39;</span></span>
288+
<span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>mini_magick</span><span class='tstring_end'>&#39;</span></span>
289+
<span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>pdf-reader</span><span class='tstring_end'>&#39;</span></span>
290+
<span class='kw'>true</span>
291+
<span class='kw'>rescue</span> <span class='const'>LoadError</span>
292+
<span class='kw'>false</span>
293+
<span class='kw'>end</span></pre>
294+
</td>
295+
</tr>
296+
</table>
297+
</div>
298+
299+
<div class="method_details ">
300+
<h3 class="signature " id="require_all_deps!-class_method">
301+
302+
.<strong>require_all_deps!</strong> &#x21d2; <tt>Object</tt>
303+
304+
305+
306+
307+
308+
</h3><div class="docstring">
309+
<div class="discussion">
310+
311+
312+
</div>
313+
</div>
314+
<div class="tags">
315+
316+
<p class="tag_title">Raises:</p>
317+
<ul class="raise">
318+
319+
<li>
320+
321+
322+
<span class='type'>(<tt>LoadError</tt>)</span>
323+
324+
325+
326+
</li>
327+
328+
</ul>
329+
330+
</div><table class="source_code">
331+
<tr>
332+
<td>
333+
<pre class="lines">
334+
335+
336+
21
337+
22
338+
23</pre>
339+
</td>
340+
<td>
341+
<pre class="code"><span class="info file"># File 'lib/mindee/dependency.rb', line 21</span>
342+
343+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_require_all_deps!'>require_all_deps!</span>
344+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>LoadError</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="#MINDEE_DEPENDENCIES_LOAD_ERROR-constant" title="Mindee::Dependency::MINDEE_DEPENDENCIES_LOAD_ERROR (constant)">MINDEE_DEPENDENCIES_LOAD_ERROR</a></span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_all_deps_available?'>all_deps_available?</span>
345+
<span class='kw'>end</span></pre>
346+
</td>
347+
</tr>
348+
</table>
349+
</div>
350+
351+
</div>
352+
353+
</div>
354+
355+
<div id="footer">
356+
Generated on Wed Apr 8 08:43:02 2026 by
357+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
358+
0.9.38 (ruby-3.2.11).
359+
</div>
360+
361+
</div>
362+
</body>
363+
</html>

0 commit comments

Comments
 (0)