middlemac-extras 1.0.6 → 1.0.7

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
  1. checksums.yaml +4 -4
  2. data/.gitignore +8 -1
  3. data/.yardopts +7 -0
  4. data/CHANGELOG.md +26 -9
  5. data/Rakefile +209 -7
  6. data/documentation_project/Gemfile +3 -3
  7. data/documentation_project/config.rb +2 -2
  8. data/documentation_project/source/api_reference.html.md.erb +38 -0
  9. data/documentation_project/source/cli.html.md.erb +4 -3
  10. data/documentation_project/source/config_rb.html.md.erb +1 -2
  11. data/documentation_project/source/css_image_sizes.html.md.erb +2 -3
  12. data/documentation_project/source/image_tag.html.md.erb +1 -2
  13. data/documentation_project/source/index.html.md.erb +8 -7
  14. data/documentation_project/source/license.html.md.erb +1 -2
  15. data/documentation_project/source/md_images.html.md.erb +1 -2
  16. data/documentation_project/source/md_links.html.md.erb +1 -2
  17. data/documentation_project/source/partials/_yard_config.erb +200 -0
  18. data/documentation_project/source/partials/_yard_helpers.erb +146 -0
  19. data/documentation_project/source/partials/_yard_helpers_extended.erb +135 -0
  20. data/documentation_project/source/stylesheets/_middlemac_minimal.scss +281 -0
  21. data/features/helpers.feature +39 -0
  22. data/features/support/env.rb +20 -0
  23. data/fixtures/middlemac_extras_app/config.rb +7 -0
  24. data/fixtures/middlemac_extras_app/source/images/middlemac-extras-small.png +0 -0
  25. data/fixtures/middlemac_extras_app/source/images/middlemac-extras-small@2x.png +0 -0
  26. data/fixtures/middlemac_extras_app/source/images/middlemac-extras-smaller.png +0 -0
  27. data/fixtures/middlemac_extras_app/source/index.html.md.erb +31 -0
  28. data/lib/middlemac-extras/extension.rb +135 -43
  29. data/lib/middlemac-extras/version.rb +1 -1
  30. data/middlemac-extras.gemspec +11 -3
  31. data/yard/readme.md +6 -0
  32. data/yard/template-grouped/default/module/html/method_details_list.erb +11 -0
  33. data/yard/template-partials/default/method_details/setup.rb +4 -0
  34. data/yard/template-partials/default/module/html/attribute_details.erb +9 -0
  35. data/yard/template-partials/default/module/html/method_details_list.erb +10 -0
  36. data/yard/template-partials/default/module/setup.rb +6 -0
  37. data/yard/template-partials/default/onefile/html/layout.erb +1 -0
  38. data/yard/template-partials/default/onefile/html/setup.rb +4 -0
  39. data/yard/yard_extensions.rb +109 -0
  40. metadata +92 -13
data/documentation_project/source/partials/_yard_config.erb ADDED
@@ -0,0 +1,200 @@
1
+
2
+
3
+
4
+
5
+ <div id="instance_attr_details" class="attr_details">
6
+
7
+
8
+ <span id="options[:img_auto_extensions]=-instance_method"></span>
9
+ <div class="method_details first">
10
+ <h3 class="signature first" id="options[:img_auto_extensions]=-instance_method">
11
+
12
+ - (<tt>Boolean</tt>) <strong>options[:img_auto_extensions]=</strong>(value)
13
+
14
+
15
+
16
+
17
+
18
+ </h3><div class="docstring">
19
+ <div class="discussion">
20
+ <p>This option determines whether or not to support specifying images without
21
+ using a file name extension. If set to <code>true</code> then the <code>image_tag</code> helper
22
+ will work for images even if you don’t specify an extension, but only if a
23
+ file exists on disk that has one of the extensions in
24
+ <code>:img_auto_extensions_order</code>.</p>
25
+
26
+
27
+ </div>
28
+ </div>
29
+ <div class="tags">
30
+ <p class="tag_title">Parameters:</p>
31
+ <ul class="param">
32
+
33
+ <li>
34
+
35
+ <span class='name'>value</span>
36
+
37
+
38
+ <span class='type'>(<tt>Boolean</tt>)</span>
39
+
40
+
41
+
42
+ &mdash;
43
+ <div class='inline'><p><code>true</code> or <code>false</code> to enable or disable this feature.</p>
44
+ </div>
45
+
46
+ </li>
47
+
48
+ </ul>
49
+
50
+ <p class="tag_title">Returns:</p>
51
+ <ul class="return">
52
+
53
+ <li>
54
+
55
+
56
+ <span class='type'>(<tt>Boolean</tt>)</span>
57
+
58
+
59
+
60
+ &mdash;
61
+ <div class='inline'><p>Returns the current value of this option.</p>
62
+ </div>
63
+
64
+ </li>
65
+
66
+ </ul>
67
+
68
+ </div>
69
+ </div>
70
+
71
+
72
+ <span id="options[:img_auto_extensions_order]=-instance_method"></span>
73
+ <div class="method_details ">
74
+ <h3 class="signature " id="options[:img_auto_extensions_order]=-instance_method">
75
+
76
+ - (<tt>Array&lt;String&gt;</tt>) <strong>options[:img_auto_extensions_order]=</strong>(value)
77
+
78
+
79
+
80
+
81
+
82
+ </h3><div class="docstring">
83
+ <div class="discussion">
84
+ <p>This option defines the eligible file name extensions and their precedence
85
+ when you specify an image without an extension using the <code>image_tag</code> helper.
86
+ Set this to an array of image file extensions in your desired order of
87
+ of precedence.</p>
88
+
89
+
90
+ </div>
91
+ </div>
92
+ <div class="tags">
93
+ <p class="tag_title">Parameters:</p>
94
+ <ul class="param">
95
+
96
+ <li>
97
+
98
+ <span class='name'>value</span>
99
+
100
+
101
+ <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
102
+
103
+
104
+
105
+ &mdash;
106
+ <div class='inline'><p>Set to an array of image extensions.</p>
107
+ </div>
108
+
109
+ </li>
110
+
111
+ </ul>
112
+
113
+ <p class="tag_title">Returns:</p>
114
+ <ul class="return">
115
+
116
+ <li>
117
+
118
+
119
+ <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
120
+
121
+
122
+
123
+ &mdash;
124
+ <div class='inline'><p>Returns the current value of this option.</p>
125
+ </div>
126
+
127
+ </li>
128
+
129
+ </ul>
130
+
131
+ </div>
132
+ </div>
133
+
134
+
135
+ <span id="options[:retina_srcset]=-instance_method"></span>
136
+ <div class="method_details ">
137
+ <h3 class="signature " id="options[:retina_srcset]=-instance_method">
138
+
139
+ - (<tt>Boolean</tt>) <strong>options[:retina_srcset]=</strong>(value)
140
+
141
+
142
+
143
+
144
+
145
+ </h3><div class="docstring">
146
+ <div class="discussion">
147
+ <p>This option determines whether or not the enhanced <code>image_tag</code> helper will
148
+ be used to include an @2x <code>srcset</code> attribute automatically. This automatic
149
+ behavior will only be applied if the image asset exists on disk and this
150
+ option is set to <code>true</code>.</p>
151
+
152
+
153
+ </div>
154
+ </div>
155
+ <div class="tags">
156
+ <p class="tag_title">Parameters:</p>
157
+ <ul class="param">
158
+
159
+ <li>
160
+
161
+ <span class='name'>value</span>
162
+
163
+
164
+ <span class='type'>(<tt>Boolean</tt>)</span>
165
+
166
+
167
+
168
+ &mdash;
169
+ <div class='inline'><p><code>true</code> or <code>false</code> to enable or disable this feature.</p>
170
+ </div>
171
+
172
+ </li>
173
+
174
+ </ul>
175
+
176
+ <p class="tag_title">Returns:</p>
177
+ <ul class="return">
178
+
179
+ <li>
180
+
181
+
182
+ <span class='type'>(<tt>Boolean</tt>)</span>
183
+
184
+
185
+
186
+ &mdash;
187
+ <div class='inline'><p>Returns the current value of this option.</p>
188
+ </div>
189
+
190
+ </li>
191
+
192
+ </ul>
193
+
194
+ </div>
195
+ </div>
196
+
197
+ </div>
198
+
199
+
200
+
data/documentation_project/source/partials/_yard_helpers.erb ADDED
@@ -0,0 +1,146 @@
1
+
2
+
3
+
4
+
5
+
6
+ <div class="method_details_list">
7
+
8
+
9
+
10
+ <div class="method_details first">
11
+ <h3 class="signature first" id="css_image_sizes-instance_method">
12
+
13
+ - (<tt>String</tt>) <strong>css_image_sizes</strong>
14
+
15
+
16
+
17
+
18
+
19
+ </h3><div class="docstring">
20
+ <div class="discussion">
21
+ <p>This helper provides CSS for every image in your
22
+ project. Each image will have a declaration that sets
23
+ <code>max-width</code> and <code>max-height</code> to the actual size of the
24
+ image. Proper @2x image support is included. It’s most
25
+ useful to use this helper in a <code>some_file.css.erb</code>
26
+ file.</p>
27
+
28
+
29
+ </div>
30
+ </div>
31
+ <div class="tags">
32
+
33
+ <p class="tag_title">Returns:</p>
34
+ <ul class="return">
35
+
36
+ <li>
37
+
38
+
39
+ <span class='type'>(<tt>String</tt>)</span>
40
+
41
+
42
+
43
+ &mdash;
44
+ <div class='inline'><p>Returns a string with the CSS markup
45
+ for every image found in your project.</p>
46
+ </div>
47
+
48
+ </li>
49
+
50
+ </ul>
51
+
52
+ </div>
53
+ </div>
54
+
55
+ <div class="method_details ">
56
+ <h3 class="signature " id="md_images-instance_method">
57
+
58
+ - (<tt>String</tt>) <strong>md_images</strong>
59
+
60
+
61
+
62
+
63
+
64
+ </h3><div class="docstring">
65
+ <div class="discussion">
66
+ <p>This helper provides access to <code>middlemac-extras</code>’
67
+ index of images in Markdown reference format, enabling
68
+ you to use reference-style images in documents. Because
69
+ this helper includes literal Markdown, it’s only useful
70
+ in Markdown documents.</p>
71
+
72
+
73
+ </div>
74
+ </div>
75
+ <div class="tags">
76
+
77
+ <p class="tag_title">Returns:</p>
78
+ <ul class="return">
79
+
80
+ <li>
81
+
82
+
83
+ <span class='type'>(<tt>String</tt>)</span>
84
+
85
+
86
+
87
+ &mdash;
88
+ <div class='inline'><p>Returns a string with the Markdown
89
+ index of every image in your project.</p>
90
+ </div>
91
+
92
+ </li>
93
+
94
+ </ul>
95
+
96
+ </div>
97
+ </div>
98
+
99
+ <div class="method_details ">
100
+ <h3 class="signature " id="md_links-instance_method">
101
+
102
+ - (<tt>String</tt>) <strong>md_links</strong>
103
+
104
+
105
+
106
+
107
+
108
+ </h3><div class="docstring">
109
+ <div class="discussion">
110
+ <p>This helper provides access to <code>middlemac-extras</code>’
111
+ index of links in Markdown reference format, enabling
112
+ you to use reference-style links in documents. Because
113
+ this helper includes literal Markdown, it’s only useful
114
+ in Markdown documents.</p>
115
+
116
+
117
+ </div>
118
+ </div>
119
+ <div class="tags">
120
+
121
+ <p class="tag_title">Returns:</p>
122
+ <ul class="return">
123
+
124
+ <li>
125
+
126
+
127
+ <span class='type'>(<tt>String</tt>)</span>
128
+
129
+
130
+
131
+ &mdash;
132
+ <div class='inline'><p>Returns a string with the Markdown
133
+ index of every page in your project.</p>
134
+ </div>
135
+
136
+ </li>
137
+
138
+ </ul>
139
+
140
+ </div>
141
+ </div>
142
+
143
+
144
+ </div>
145
+
146
+
data/documentation_project/source/partials/_yard_helpers_extended.erb ADDED
@@ -0,0 +1,135 @@
1
+
2
+
3
+
4
+
5
+
6
+ <div class="method_details_list">
7
+
8
+
9
+
10
+ <div class="method_details first">
11
+ <h3 class="signature first" id="image_tag-instance_method">
12
+
13
+ - (<tt>String</tt>) <strong>image_tag</strong>(path, params = {})
14
+
15
+
16
+
17
+
18
+
19
+ </h3><div class="docstring">
20
+ <div class="discussion">
21
+ <p>With the proper options enabled this helper extends
22
+ the built-in functionality of <strong>Middleman</strong>’s helpers
23
+ in a couple of ways. With <code>:retina_srcset</code> enabled,
24
+ automatic <code>srcset</code> attributes will be applied to
25
+ <code>&lt;img&gt;</code> tags if an @2x version of the specified image
26
+ is found. With <code>:img_auto_extensions</code> it’s possible to
27
+ specify image names without the file name extension.</p>
28
+
29
+
30
+ </div>
31
+ </div>
32
+ <div class="tags">
33
+ <p class="tag_title">Parameters:</p>
34
+ <ul class="param">
35
+
36
+ <li>
37
+
38
+ <span class='name'>path</span>
39
+
40
+
41
+ <span class='type'>(<tt>String</tt>)</span>
42
+
43
+
44
+
45
+ &mdash;
46
+ <div class='inline'><p>Specify path to the image file.</p>
47
+ </div>
48
+
49
+ </li>
50
+
51
+ <li>
52
+
53
+ <span class='name'>params</span>
54
+
55
+
56
+ <span class='type'>(<tt>Hash</tt>)</span>
57
+
58
+
59
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
60
+
61
+
62
+ &mdash;
63
+ <div class='inline'><p>Optional parameters to pass to
64
+ the helper. <strong>Middleman</strong> (and other extensions)
65
+ provide other parameters in addition to these.</p>
66
+ </div>
67
+
68
+ </li>
69
+
70
+ </ul>
71
+
72
+
73
+
74
+
75
+
76
+
77
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
78
+ <ul class="option">
79
+
80
+ <li>
81
+ <span class="name">:img_auto_extensions</span>
82
+ <span class="type">(<tt>Boolean</tt>)</span>
83
+ <span class="default">
84
+
85
+ </span>
86
+
87
+ &mdash; <div class='inline'><p>Allows
88
+ control of the automatic image extensions option
89
+ on a per-use basis.</p>
90
+ </div>
91
+
92
+ </li>
93
+
94
+ <li>
95
+ <span class="name">:retina_srcset</span>
96
+ <span class="type">(<tt>Boolean</tt>)</span>
97
+ <span class="default">
98
+
99
+ </span>
100
+
101
+ &mdash; <div class='inline'><p>Allows control
102
+ of the automatic @2x images feature on a per-use
103
+ basis.</p>
104
+ </div>
105
+
106
+ </li>
107
+
108
+ </ul>
109
+
110
+
111
+ <p class="tag_title">Returns:</p>
112
+ <ul class="return">
113
+
114
+ <li>
115
+
116
+
117
+ <span class='type'>(<tt>String</tt>)</span>
118
+
119
+
120
+
121
+ &mdash;
122
+ <div class='inline'><p>Returns an HTML <code>&lt;img&gt;</code> tag.</p>
123
+ </div>
124
+
125
+ </li>
126
+
127
+ </ul>
128
+
129
+ </div>
130
+ </div>
131
+
132
+
133
+ </div>
134
+
135
+