middlemac-extras 1.0.6 → 1.0.11

data/documentation_project/source/partials/_yard_helpers_extended.erb

@@ -0,0 +1,135 @@
+
+
+
+
+
+  <div class="method_details_list">
+    
+    
+      
+        <div class="method_details first">
+  <h3 class="signature first" id="image_tag-instance_method">
+  
+    #<strong>image_tag</strong>(path, params = {})  &#x21d2; <tt>String</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>With the proper options enabled this helper extends
+the built-in functionality of <strong>Middleman</strong>’s helpers
+in a couple of ways. With <code>:retina_srcset</code> enabled,
+automatic <code>srcset</code> attributes will be applied to
+<code>&lt;img&gt;</code> tags if an @2x version of the specified image
+is found. With <code>:img_auto_extensions</code> it’s possible to
+specify image names without the file name extension.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>path</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Specify path to the image file.</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>params</span>
+      
+      
+        <span class='type'>(<tt>Hash</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>{}</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'><p>Optional parameters to pass to
+the helper. <strong>Middleman</strong> (and other extensions)
+provide other parameters in addition to these.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+  
+    
+    
+    
+    
+    <p class="tag_title">Options Hash (<tt>params</tt>):</p>
+    <ul class="option">
+      
+        <li>
+          <span class="name">:img_auto_extensions</span>
+          <span class="type">(<tt>Boolean</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'><p>Allows
+control of the automatic image extensions option
+on a per-use basis.</p>
+</div>
+          
+        </li>
+      
+        <li>
+          <span class="name">:retina_srcset</span>
+          <span class="type">(<tt>Boolean</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'><p>Allows control
+of the automatic @2x images feature on a per-use
+basis.</p>
+</div>
+          
+        </li>
+      
+    </ul>
+  
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Returns an HTML <code>&lt;img&gt;</code> tag.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+      
+    
+  </div>
+
+

data/documentation_project/source/stylesheets/_middlemac_minimal.scss

@@ -514,3 +514,284 @@ div.image_article:after
 	display: table;
 	clear: both;
 }
+
+//*************************************
+//	For partials extracted from YARD
+//*************************************
+
+$yard_color_symbol: rgba(0,136,204,1);
+$yard_font_mono: Menlo, Consolas, Monaco, Courier, monospace;
+
+div.attr_details,
+div.method_details_list
+{
+	.inline
+	{
+		display: inline;
+
+		p:first-child
+		{
+			display: inline;
+		}
+	}
+
+	.method_details
+	{
+		border-top: 1px dotted #aaa;
+		margin-top: 15px;
+		padding-top: 0;
+
+		&.first
+		{
+			border: 0;
+		}
+	}
+
+	p.signature,
+	h3.signature
+	{
+		font-size: 0.9em;
+		font-weight: normal;
+		font-family: $yard_font_mono;
+		padding: 6px 10px;
+		margin-top: 18px;
+		background: #f2f3ff;
+		border: 1px solid #d8d8e5;
+		-moz-border-radius: 3px;
+		-webkit-border-radius: 3px;
+		color: $yard_color_symbol;
+
+		strong
+		{
+			color: inherit;;
+		}
+
+		tt
+		{
+			font-family: inherit;
+		}
+
+		.overload
+		{
+			display: block;
+		}
+
+		.extras
+		{
+			font-weight: normal;
+			font-family: sans-serif;
+			color: #444;
+			font-size: 1em;
+		}
+
+		.not_defined_here,
+		.aliases
+		{
+			display: block;
+			font-weight: normal;
+			font-size: 0.9em;
+			font-family: $yard_font_mono;
+			margin-top: 0px;
+			color: #555;
+
+			.names
+			{
+				font-family: $yard_font_mono;
+				font-weight: bold;
+				color: #000;
+				font-size: 1.2em;
+			}
+		}
+	}
+
+	div.docstring
+	{
+		div.discussion
+		{
+
+		}
+	}
+
+	div.tags
+	{
+		margin-bottom: 12px;
+
+		.tag_title
+		{
+			font-size: 1em;
+			margin-bottom: 0;
+			font-weight: bold; }
+
+		ul
+		{
+			margin-top: 5px;
+			padding-left: 30px;
+			list-style: square;
+
+			li {
+				margin-bottom: 3px;
+			}
+
+			.name
+			{
+				font-family: $yard_font_mono;
+				font-weight: bold;
+			}
+
+			.note
+			{
+				padding: 3px 6px;
+			}
+
+		}
+
+		.examples
+		{
+			.tag_title
+			{
+				margin-bottom: 10px;
+				font-weight: bold;
+			}
+
+			.inline p
+			{
+				padding: 0;
+				margin: 0;
+				margin-left: 15px;
+				font-weight: bold;
+				font-size: 0.9em;
+			}
+		}
+
+		.overload
+		{
+			.overload_item
+			{
+				list-style: none;
+				margin-bottom: 25px;
+
+				.signature
+				{
+					padding: 2px 8px;
+					background: #e5e8ff;
+					border: 1px solid #d8d8e5;
+					-moz-border-radius: 3px;
+					-webkit-border-radius: 3px;
+				}
+			}
+
+			.signature
+			{ margin-left: -15px;
+				font-family: monospace;
+				display: block;
+				font-size: 1.1em;
+			}
+
+			.docstring
+			{
+				margin-top: 15px;
+			}
+
+		}
+
+		/* syntax highlighting */
+		//.source_code { display: none; padding: 3px 8px; border-left: 8px solid #ddd; margin-top: 5px; }
+		//#filecontents pre.code, .docstring pre.code, .source_code pre { font-family: monospace; }
+		//#filecontents pre.code, .docstring pre.code { display: block; }
+		//.source_code .lines { padding-right: 12px; color: #555; text-align: right; }
+
+		#filecontents pre.code,
+		.docstring pre.code,
+		pre.example
+		{
+			padding: 5px 12px; margin-top: 4px; border: 1px solid #eef; background: #f5f5ff;
+		}
+
+		pre.code
+		{
+			color: #000;
+
+			info.file { color: #555; }
+
+			.val { color: #036A07; }
+
+			.tstring_content,
+			.heredoc_beg,
+			.heredoc_end,
+			.qwords_beg,
+			.qwords_end,
+			.tstring,
+			.dstring
+			{
+				color: #036A07;
+			}
+
+			.fid,
+			.rubyid_new,
+			.rubyid_to_s,
+			.rubyid_to_sym,
+			.rubyid_to_f,
+			.dot + pre.code .id,
+			.rubyid_to_i pre.code .rubyid_each
+			{
+				color: #0085FF;
+			}
+
+			.comment
+			{
+				color: #0066FF;
+			}
+
+			.const,
+			.constant
+			{
+				color: #585CF6;
+			}
+
+			.label,
+			.symbol
+			{
+				color: #C5060B;
+			}
+
+			.kw,
+			.rubyid_require,
+			.rubyid_extend,
+			.rubyid_include
+			{
+				color: #0000FF;
+			}
+
+			.ivar
+			{
+				color: #318495;
+			}
+
+			.gvar,
+			.rubyid_backref,
+			.rubyid_nth_ref
+			{
+				color: #6D79DE;
+			}
+
+			.regexp,
+			.dregexp
+			{
+				color: #036A07;
+			}
+
+			a
+			{
+				border-bottom: 1px dotted #bbf;
+			}
+
+		}
+	}
+
+	table.source_code
+	{
+		display: none;
+	}
+
+
+}

data/features/helpers.feature

@@ -0,0 +1,39 @@
+Feature: Provide helpers and resource items to make multiple targets easy to manage.
+
+  As a software developer
+  I want to use helpers and resource items
+  In order to enable automatic navigation of items.
+  
+  Background:
+    Given a built app at "middlemac_extras_app"
+    
+  Scenario:
+    The css_image_sizes helper should return CSS for every image in the project
+    and @2x images should have proper widths and heights, too.
+    When I cd to "build"
+    And the file "index.html" should contain "img[src$='/images/middlemac-extras-small.png'] { max-width: 128px; max-height: 128px; }"
+    And the file "index.html" should contain "img[src$='/images/middlemac-extras-small@2x.png'] { max-width: 128px; max-height: 128px; }"
+    And the file "index.html" should contain "img[src$='/images/middlemac-extras-smaller.png'] { max-width: 64px; max-height: 64px; }"
+    
+
+  Scenario:
+    The md_images helper should return Markdown references for every image in
+    the project.
+    When I cd to "build"
+    And the file "index.html" should contain '[middlemac-extras-small]: /images/middlemac-extras-small.png'
+    And the file "index.html" should contain '[middlemac-extras-small@2x]: /images/middlemac-extras-small@2x.png'
+    And the file "index.html" should contain '[middlemac-extras-smaller]: /images/middlemac-extras-smaller.png'
+    
+
+  Scenario:
+    The md_links helper should return Markdown references for every HTML file
+    in the project, and should include a title generated from the front matter.
+    When I cd to "build"
+    And the file "index.html" should contain '[index]: / "Fixture for middlemac-extras"'
+    
+  Scenario:
+    The extended image tag should include srcset automatically if @2x images are
+    present, and not include a srcset if not.
+    When I cd to "build"
+    And the file "index.html" should contain 'img src="/images/middlemac-extras-small.png" srcset="/images/middlemac-extras-small@2x.png 2x" alt=""'
+    And the file "index.html" should contain 'img src="/images/middlemac-extras-smaller.png" alt=""'