middleman-targets 1.0.3 → 1.0.4

data/documentation_project/source/stylesheets/_middlemac_minimal.scss

@@ -51,7 +51,7 @@ html
 
 body
 {
-    font-family: -apple-system-font, -webkit-system-font, "HelveticaNeue", "Helvetica Neue", "Helvetica", sans-serif;
+  font-family: -apple-system-font, -webkit-system-font, "HelveticaNeue", "Helvetica Neue", "Helvetica", sans-serif;
 	height: 100%;
 	min-width: 600px;
 }
@@ -514,3 +514,285 @@ 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/documentation_project/source/target-feature-config.html.md.erb

@@ -35,40 +35,10 @@ activate them _before_ activating `middleman-targets`.
 
 ## The Configuration Options
 
-`target`
+<%= partial 'partials/config' %>
 
-  : This is the target that is used automatically when you `middleman build` 
-    or `middleman server` without using the `--targets` option from the
-    command line.
+* * *
 
-`targets`
-
-  : The `targets` key is a comprehensive list of your targets, their features,
-    and other data pertinent to your targets.
-  
-    All of the keys contained in this structure are described in the next
-    section, below.
-
-`target_magic_images`
-`target_magic_word`
-
-  : By enabling `target_magic_images` and using `middleman-targets`’ image
-    helper, target specific images will be used instead of the image you 
-    specify, *if* that image name is prefixed with `target_magic_word`. For
-    example, you might request `all-my_image.png`, and `pro-my_image.png` (if it
-    exists) will be used in your :pro target instead.
-    
-    Important: when this is enabled, images from *other* targets will *not* be
-    included in the build! In the example above, *any* image prefixed with 
-    `free-` would not be included in the output directory.
-  
-`build_dir`
-
-  : Build output will use this directory as a *prefix*; if the target
-    is `:pro`, then the actual build directory will be `build (pro)/`. If the
-    `build_dir` key is present for any of the `targets`, they will override this
-    setting.
-    
 ## The `targets` key by example
 
 The code below is the actual `targets` key for this sample project. We’ll look
@@ -77,7 +47,7 @@ defined, and how you can effect your build output directory as well as add
 other arbitrary data to each target.
 
 ~~~ ruby
-set :targets, {
+config[:targets] = {
   :free =>
       {
       :sample_key => 'People who use free versions don\'t drive profits.',
@@ -109,14 +79,14 @@ Looking at the top level of this structure you can see that there are two
 targets defined: `free` and `pro`. Nested within each of them are a series of
 additional keys.
 
-`sample_key`
+`:sample_key`
 
  : This is an example data key associated with each target. You can specify as
    many as you wish using any naming convention that suits you. Target-specific
    values can be retrieved in your pages using the `target_value`
    [helper](helpers-resources.html).
    
-`build_dir`
+`:build_dir`
 
  : When used for a target then this specified directory overrides the Middleman
    `build_dir` setting. Note that in this project only the `free` target
@@ -127,7 +97,7 @@ additional keys.
    a single `%s` **sprintf** placeholder which will be filled with the target
    name during build, as shown in this example.
    
-`features`
+`:features`
 
  : This key is where you define the features that are pertinent to each of your
    targets, as well as enable or disable them.

data/features/build_target_option.feature

@@ -0,0 +1,42 @@
+Feature: Build with various target options.
+
+  As a software developer
+  I want to build output with different targets
+  In order to deploy different versions of my project
+  
+  Scenario: Build with the default target (pro)
+    Given a fixture app "middleman_targets_app"
+    When I run `middleman build` interactively
+    And I stop middleman if the output contains:
+    """
+    Project built successfully.
+    """
+    Then the output should contain:
+    """
+    Middleman will build using target "pro".
+    """
+
+  Scenario: Build with --target pro
+    Given a fixture app "middleman_targets_app"
+    When I run `middleman build --target pro` interactively
+    And I stop middleman if the output contains:
+    """
+    Project built successfully.
+    """
+    Then the output should contain:
+    """
+    Middleman will build using target "pro".
+    """
+
+  Scenario: Build with --target free
+    Given a fixture app "middleman_targets_app"
+    When I run `middleman build --target free` interactively
+    And I stop middleman if the output contains:
+    """
+    Project built successfully.
+    """
+    Then the output should contain:
+    """
+    Middleman will build using target "free".
+    """
+

data/features/helpers_and_resources.feature

@@ -0,0 +1,44 @@
+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 deploy different versions of my project
+  
+  Scenario: Build with the default target
+    Given a built app at "middleman_targets_app"
+    When I cd to "custom_build_dir (pro)"
+    And the file "index.html" should contain "Insult: NO"
+    And the file "index.html" should contain "TargetName: pro"
+    And the file "index.html" should contain "TargetFree: NO"
+    And the file "index.html" should contain "TargetValueForSampleKey: You are a valued contributor to our balance sheet!"
+    And the file "index.html" should contain "CurrentPageValidFeatures: [:grants_wishes]"
+    And the file "index.html" should contain 'src="/pro-root.png"'
+    And the file "index.html" should contain 'src="/all-root-logo.png"'
+    And the file "index.html" should contain 'src="/images/pro-image.png"'
+    And the file "index.html" should contain 'src="/images/all-logo.png"'
+
+  Scenario: Build with --target pro
+    Given a built app at "middleman_targets_app" with flags "--target pro"
+    When I cd to "custom_build_dir (pro)"
+    And the file "index.html" should contain "Insult: NO"
+    And the file "index.html" should contain "TargetName: pro"
+    And the file "index.html" should contain "TargetFree: NO"
+    And the file "index.html" should contain "TargetValueForSampleKey: You are a valued contributor to our balance sheet!"
+    And the file "index.html" should contain "CurrentPageValidFeatures: [:grants_wishes]"
+    And the file "index.html" should contain 'src="/pro-root.png"'
+    And the file "index.html" should contain 'src="/all-root-logo.png"'
+    And the file "index.html" should contain 'src="/images/pro-image.png"'
+    And the file "index.html" should contain 'src="/images/all-logo.png"'
+
+  Scenario: Build with --target free
+    Given a built app at "middleman_targets_app" with flags "--target free"
+    When I cd to "free_build (free)"
+    And the file "index.html" should contain "Insult: YES"
+    And the file "index.html" should contain "TargetName: free"
+    And the file "index.html" should contain "TargetFree: YES"
+    And the file "index.html" should contain "TargetValueForSampleKey: People who use free versions don't drive profits."
+    And the file "index.html" should contain "CurrentPageValidFeatures: [:feature_advertise_pro, :insults_user]"
+    And the file "index.html" should contain 'src="/free-root.png"'
+    And the file "index.html" should contain 'src="/all-root-logo.png"'
+    And the file "index.html" should contain 'src="/images/free-image.png"'
+    And the file "index.html" should contain 'src="/images/all-logo.png"'

data/features/server_target_option.feature

@@ -0,0 +1,42 @@
+Feature: Run the preview server with various target options.
+
+  As a software developer
+  I want to start the preview server with different targets
+  In order to view my changes immediately in the browser
+  
+  Background:
+    Given a fixture app "middleman_targets_app"
+    And the default aruba timeout is 30 seconds
+    
+  Scenario: Start the server with the default target (pro)
+    When I run `middleman server` interactively
+    And I stop middleman if the output contains:
+    """
+    Inspect your site configuration
+    """
+    And the output should contain:
+    """
+    Middleman will serve using target "pro"
+    """
+
+  Scenario: Start the server with the --pro target
+    When I run `middleman server --target pro` interactively
+    And I stop middleman if the output contains:
+    """
+    Inspect your site configuration
+    """
+    And the output should contain:
+    """
+    Middleman will serve using target "pro"
+    """
+
+  Scenario: Start the server with the --free target
+    When I run `middleman server --target free` interactively
+    And I stop middleman if the output contains:
+    """
+    Inspect your site configuration
+    """
+    And the output should contain:
+    """
+    Middleman will serve using target "free"
+    """

data/features/support/env.rb

@@ -0,0 +1,20 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+ENV['TEST'] = 'true'
+
+require 'middleman'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'lib', ENV['GEM_NAME'] || 'middleman-targets')
+
+
+require 'cucumber/formatter/pretty'
+class QuietFormatter < Cucumber::Formatter::Pretty
+  def initialize(runtime, io, options)
+     $stderr = File.new( '/dev/null', 'w' )
+    super(runtime, io, options)
+  end
+  
+  def after_features(features)
+    $stderr = STDOUT
+    super(features)
+  end
+end

data/fixtures/middleman_targets_app/config.rb

@@ -0,0 +1,33 @@
+activate :MiddlemanTargets
+
+set :target, :pro
+
+set :targets, {
+  :free =>
+      {
+      :sample_key => 'People who use free versions don\'t drive profits.',
+      :build_dir  => 'free_build (%s)',
+      :features   =>
+          {
+          :feature_advertise_pro => true,
+          :insults_user          => true,
+          :grants_wishes         => false,
+          }
+      },
+
+  :pro =>
+      {
+      :sample_key => 'You are a valued contributor to our balance sheet!',
+      :features =>
+          {
+          :feature_advertise_pro => false,
+          :insults_user          => false,
+          :grants_wishes         => true,
+          }
+      },
+}
+
+set :target_magic_images, true
+set :target_magic_word, 'all'
+
+set :build_dir, 'custom_build_dir'

data/fixtures/middleman_targets_app/source/index.html.md.erb

@@ -0,0 +1,35 @@
+<% if target_feature?(:insults_user) %>
+Insult: YES
+<% else %>
+Insult: NO
+<% end %>
+
+TargetName: <%= target_name %>
+
+<% if target_name?(:free) %>
+TargetFree: YES
+<% else %>
+TargetFree: NO
+<% end %>
+
+TargetValueForSampleKey: <%= target_value(:sample_key) %>
+
+CurrentPageValidFeatures: <%= current_page.valid_features %>
+
+
+~~~
+<%= image_tag '/all-root.png' %>
+~~~
+
+~~~
+<%= image_tag '/all-root-logo.png' %>
+~~~
+
+~~~
+<%= image_tag 'all-image.png' %>
+~~~
+
+~~~
+<%= image_tag 'all-logo.png' %>
+~~~
+