middleman-targets 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 538cbe8f9ebafb3d881145f28ba6a0d8f80e362c
-  data.tar.gz: 971d1152ee7fd0fd2f875ebfaebc2727fc09ac51
+  metadata.gz: 7a0c601e30b8d5beb37283c652cf41790157c314
+  data.tar.gz: 5a24bebde45c5a00ea98d9152ae57fc60337ff59
 SHA512:
-  metadata.gz: 843728b544dec1b827acf71cc75746f2d215a4ab37dc77328060a7a7e259964a18c0185a4e56f4030e9622fb45bf8de50a072e2b29d59c83c4d0c58fe3e77c34
-  data.tar.gz: 0a475c0233be66cdc15b41ef43df05793205fb8635a872bd9259c854d3badb17dc24fb4fa194cfe8b8f2ac3d994adfa5770237884b104607dac4765f40b789d2
+  metadata.gz: 1f351b50ebaeb1f243ccc6c7a2c2c56681e0c175cc055b6642c18d602dc5de8266f904b33ae0bd13754bbfbbee6471f01065ebc28659694b451fdb5541e16c59
+  data.tar.gz: b327da177ded0c89ce0ba06355506d0f2cee7b3bba59da8de80744726bad0d0afadcc6c4b372a35f6344ddee3edb0c6d7c06b354c6bfd90f162008b03d0fde7b

data/.gitignore

@@ -15,3 +15,10 @@ Gemfile.lock
 
 # Ignore build folders
 build/*
+
+# Yard cruft
+/doc/
+/.yardoc
+
+# Aruba
+/tmp/

data/.yardopts

@@ -0,0 +1,9 @@
+--no-private
+--markup=markdown
+--load yard/yard_extensions.rb
+--exclude middleman-targets/version.rb
+--exclude middleman-targets/commands.rb
+--exclude middleman-targets/middleman-cli/build_all.rb
+--one-file
+--readme yard/readme.md
+--title middleman-targets

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 middleman-targets change log
 ============================
 
+- Version 1.0.4 / 2016-April-14
+
+  - Added Cucumber tests.
+  - Added *much* documentation to the extension source in order to
+    generate YARD documentation.
+  - Improved the documentation sample project to use YARD's output.
+
 - Version 1.0.3 / 2016-April-08
 
   - A bit of internal refactoring in order for related gems to be able

data/README.md

@@ -71,6 +71,7 @@ Or:
 bundle exec middleman serve --target mytarget
 ~~~
 
+
 Added Features
 --------------
 
@@ -89,10 +90,26 @@ available, including
 - …and more.
 
 
+Rake Tasks
+----------
+
+Run tests:
+
+~~~ bash
+rake test
+~~~
+
+Generate YARD documentation:
+
+~~~ bash
+rake yard
+~~~
+
+
 Middlemac
 ---------
 
-  This Middleman extension is a critical part of
+This Middleman extension is a critical part of
 [Middlemac](https://github.com/middlemac), the Mac OS X help building system
 for Mac OS X applications. However this gem is not Mac OS X specific and can be
 useful in any application for which you want to generate multiple targets.
@@ -101,11 +118,11 @@ useful in any application for which you want to generate multiple targets.
 License
 -------
 
-MIT. See `LICENSE.md`.
+MIT. See [`LICENSE.md`](LICENSE.md).
 
 
 Changelog
 ---------
 
-See `CHANGELOG.md` for point changes, or simply have a look at the commit
-history for non-version changes (such as readme updates).
+See [`CHANGELOG.md`](CHANGELOG.md) for point changes, or simply have a look at
+the commit history for non-version changes (such as readme updates).

data/Rakefile

@@ -1,10 +1,16 @@
 require 'bundler/gem_tasks'
-require 'rake/testtask'
+require 'cucumber/rake/task'
+require 'yard'
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.libs << 'lib'
-  t.test_files = FileList['test/**/*_test.rb']
+ENV['GEM_NAME'] = 'middleman-targets'
+
+task :default => :test
+
+Cucumber::Rake::Task.new(:test, 'Features that must pass') do |task|
+  task.cucumber_opts = '--require features --color --tags ~@wip --strict --format QuietFormatter'
 end
 
-task :default => :spec
+
+YARD::Rake::YardocTask.new(:yard) do |task|
+  task.stats_options = ['--list-undoc']
+end

data/documentation_project/Gemfile

@@ -9,6 +9,6 @@ gem 'wdm', '~> 0.1.0', platforms: [:mswin, :mingw]
 gem 'tzinfo-data', platforms: [:mswin, :mingw, :jruby]
 
 # Middleman Gems
-gem 'middleman-targets', '~>1.0.3'
+gem 'middleman-targets', '~>1.0.4'
 gem 'middleman', '~> 4.1.6'
 gem 'middleman-syntax'

data/documentation_project/config.rb

@@ -23,7 +23,7 @@ activate :MiddlemanTargets
 # Set the default target. This is the target that is used automatically
 # when you `middleman build` or `middleman server` without using the
 # `targets` CLI option.
-set :target, :pro
+config[:target] = :pro
 
 # Setup your targets and their features. You can use any target names and
 # feature names that you like, but keep in mind that the key :features is
@@ -37,7 +37,7 @@ set :target, :pro
 # You can add your own keys to each target for your own uses; the
 # `sample_key` below is an example of such. The generic `target_value()`
 # helper can retrieve these values, or you can write your own helpers.
-set :targets, {
+config[:targets] = {
   :free =>
       {
       :sample_key => 'People who use free versions don\'t drive profits.',
@@ -71,21 +71,21 @@ set :targets, {
 # 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.
-set :target_magic_images, true
-set :target_magic_word, 'all'
+config[:target_magic_images] = true
+config[:target_magic_word] = 'all'
 
 # Note that output will now 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.
-set :build_dir, 'build'
+config[:build_dir] = 'build'
 
 
 #==========================================================================
 # Regular Middleman Setup
 #==========================================================================
 
-set :relative_links, true
+config[:relative_links] = true
 activate :syntax
 
 
@@ -103,7 +103,7 @@ helpers do
   end
 
   def product_version
-    '1.0.3'
+    '1.0.4'
   end
 
   def product_uri

data/documentation_project/source/helpers-resources.html.md.erb

@@ -9,82 +9,30 @@ layout: template-logo-medium
 working with multiple targets easier.
 
 
-## Resources
-
-Middleman’s resource list is available to all of your templates and pages, and
-also available for your own helpers, and `middleman-targets` provides a couple
-of resource map additions than can prove useful when developing your own
-helpers.
-
-`valid_features`
-
- : `valid_features` returns an array of features that are enabled and applicable
-   to the current build target. Although available for output in your pages,
-   this is probably most useful for developing your own helpers.
-   
-   By way of example, the raw output of `<%%= current_page.valid_features %>`
-   on this page is `<%= current_page.valid_features %>`. The output will be
-   different if you switch targets.
-   
-`targeted?`
-
- : Determines if the resource is eligible for inclusion in the current page
-   based on the front matter `target` and `exclude` data fields
-  
-   - if `frontmatter:target` is used, the target or feature appears in the 
-     front matter, and
-   - if `frontmatter:exclude` is used, the target or enabled feature does NOT
-     appear in the frontmatter.
-     
-   In general you won't use this resource method on pages because resources will
-   already be excluded before you have a chance to check them, and so any
-   leftover resources will always return true for this method. This method could
-   be valuable in writing your own helpers, however.
-
-
 ## Helpers
 
-`target_name`
+This extension provides several useful helpers to manage multiple targets and
+features. Most of them are demonstrated at [Simple features demonstration](simple-demo.html).
 
-  : Return the current build target.
+<%= partial 'partials/helpers' %>
 
-`target_name?(proposal)`
 
- : Is the current target `proposal`?
-
-`target_feature?(feature)`
+## Resources
 
- : Does the target have the feature `feature`?
+Middleman’s resource list is available to all of your templates and pages, and
+also available for your own helpers, and `middleman-targets` provides a couple
+of resource map additions than can prove useful when developing your own
+helpers.
 
-`target_value(key)`
+<%= partial 'partials/resources' %>
 
- : Attempts to return the value for they key `key` for the current target.
- 
-`image_tag`
+* * *
 
- : Extends Middleman’s built-in `image_tag` helper in order to support:
- 
-   - automatic target-specific images. Note that this only works on local files.
-   - target and feature dependent images.
-   - absolute paths
-   
-   Automatic target-specific images are described in 
-   [Simple features demonstration](simple-demo.html), and allow you to specify
-   an image with a magic prefix in your source code which will be substituted
-   with a target-specific image for output.
-   
-   Target- and feature-dependent images add the `:target` and `:feature`
-   options to the `image_tag` parameter array, indicating that the image should
-   only be used in the condition specified. For example,
-   `image_tag 'my_image.png', :feature => 'insults_user'` will only include the
-   image if the current target has the feature `insults_user` enabled.
-   
-   As a freebie that’s not specifically related to multiple targets, our
-   `image_tag` helper also works with absolute image paths, where ”absolute”
-   means relative to your project directory. Specifying `/assets/images/photo.png`
-   will correctly reference that image as if your project directory were the
-   root filesystem.
+### Example
 
+The raw output of `<%%= current_page.valid_features %>` on this page is 
+`<%= current_page.valid_features %>`. The output will be different if you switch
+targets.
 
 
 <% content_for :seeAlso do %>

data/documentation_project/source/partials/config.erb

@@ -0,0 +1,326 @@
+<div class="attr_details">
+
+  <div class="method_details first">
+    <h3 class="signature first" id="config[:build_dir]=-instance_method">
+
+      - (<tt>String</tt>) <strong>config[:build_dir]=</strong>(value)
+
+
+
+
+
+    </h3><div class="docstring">
+    <div class="discussion">
+
+      <p>Indicates where <strong>Middleman</strong> will put build output. This standard config
+        value will be treated as a <em>prefix</em>; for example if the current target is <code>:pro</code> and this
+        value is set to its default <code>build</code>, then the actual build directory will
+        be <code>build (pro)/</code>.</p>
+
+      <p>If the <code>build_dir</code> key is present for any of the <code>config[:targets]</code>, they
+        will override this setting.</p>
+
+
+    </div>
+  </div>
+    <div class="tags">
+      <p class="tag_title">Parameters:</p>
+      <ul class="param">
+
+        <li>
+
+          <span class='name'>value</span>
+
+
+          <span class='type'>(<tt>String</tt>)</span>
+
+
+
+          &mdash;
+          <div class='inline'><p>Indicate the build directory prefix that should be
+            used for build output.</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 the current value of this configuration setting.</p>
+          </div>
+
+        </li>
+
+      </ul>
+
+    </div>
+  </div>
+
+
+  <div class="method_details">
+    <h3 class="signature">
+
+      - (<tt>Symbol</tt>) <strong>config[:target]=</strong>(value)
+
+
+
+
+
+    </h3><div class="docstring">
+    <div class="discussion">
+
+      <p>Indicates the current target that is being built or served. When
+        set in <code>config.rb</code> it indicates the default target if one is not
+        specified on the command line.</p>
+
+
+    </div>
+  </div>
+    <div class="tags">
+      <p class="tag_title">Parameters:</p>
+      <ul class="param">
+
+        <li>
+
+          <span class='name'>value</span>
+
+
+          <span class='type'>(<tt>Symbol</tt>)</span>
+
+
+
+          &mdash;
+          <div class='inline'><p>The target from <code>config[:targets]</code> that should
+            be used as the default.</p>
+          </div>
+
+        </li>
+
+      </ul>
+
+      <p class="tag_title">Returns:</p>
+      <ul class="return">
+
+        <li>
+
+
+          <span class='type'>(<tt>Symbol</tt>)</span>
+
+
+
+          &mdash;
+          <div class='inline'><p>Returns the current target.</p>
+          </div>
+
+        </li>
+
+      </ul>
+
+    </div>
+  </div>
+
+
+  <div class="method_details ">
+    <h3 class="signature ">
+
+      - (<tt>Boolean</tt>) <strong>config[:target_magic_images]=</strong>(value)
+
+
+
+
+
+    </h3><div class="docstring">
+    <div class="discussion">
+
+      <p>This option is used to enable or disable the target magic images feature.
+        If it’s <code>true</code> then the <code>image_tag</code> helper will attempt to substitute
+        target-specific images instead of the specified image, if the specified
+        image begins with <code>:target_magic_word</code>.</p>
+
+
+    </div>
+  </div>
+    <div class="tags">
+      <p class="tag_title">Parameters:</p>
+      <ul class="param">
+
+        <li>
+
+          <span class='name'>value</span>
+
+
+          <span class='type'>(<tt>Boolean</tt>)</span>
+
+
+
+          &mdash;
+          <div class='inline'><p>Specify whether or not automatic target-specific
+            image substitution should be enabled.</p>
+          </div>
+
+        </li>
+
+      </ul>
+
+      <p class="tag_title">Returns:</p>
+      <ul class="return">
+
+        <li>
+
+
+          <span class='type'>(<tt>Boolean</tt>)</span>
+
+
+
+          &mdash;
+          <div class='inline'><p>Returns the current state of this option.</p>
+          </div>
+
+        </li>
+
+      </ul>
+
+    </div>
+  </div>
+
+
+  <div class="method_details ">
+    <h3 class="signature ">
+
+      - (<tt>String</tt>) <strong>config[:target_magic_word]=</strong>(value)
+
+
+
+
+
+    </h3><div class="docstring">
+    <div class="discussion">
+
+      <p>Indicates the magic image prefix for image substitution with the
+        <code>image_tag</code> helper when <code>:target_magic_images</code> is enabled. For example
+        if you specify <code>all-image.png</code> and <code>pro-image.png</code> exists, then the
+        latter will be used by the helper instead of the former.</p>
+
+
+    </div>
+  </div>
+    <div class="tags">
+      <p class="tag_title">Parameters:</p>
+      <ul class="param">
+
+        <li>
+
+          <span class='name'>value</span>
+
+
+          <span class='type'>(<tt>String</tt>)</span>
+
+
+
+          &mdash;
+          <div class='inline'><p>Indicate the prefix that should indicate and image
+            the should be substituted, such as <code>all</code>.</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 the current magic prefix.</p>
+          </div>
+
+        </li>
+
+      </ul>
+
+    </div>
+  </div>
+
+
+  <div class="method_details ">
+    <h3 class="signature ">
+
+      - (<tt>Hash</tt>) <strong>config[:targets]=</strong>(value)
+
+
+
+
+
+    </h3><div class="docstring">
+    <div class="discussion">
+
+      <p>A hash that defines all of the characteristics of your individual targets.
+        The <code>build_dir</code> and <code>features</code> keys in a target have special meanings;
+        other keys can be added arbitrarily and helpers can fetch these for you.
+        A best practice is to assign the same features to <em>all</em> of your targets and
+        toggle them <code>on</code> or <code>off</code> on a target-specific basis.</p>
+
+
+    </div>
+  </div>
+    <div class="tags">
+
+    <p class="tag_title">Parameters:</p>
+    <ul class="param">
+
+      <li>
+
+        <span class='name'>value</span>
+
+
+        <span class='type'>(<tt>Hash</tt>)</span>
+
+
+
+        &mdash;
+        <div class='inline'><p>The complete definition of your targets, their
+          features, and other keys-value pairs that you wish to include.</p>
+        </div>
+
+      </li>
+
+    </ul>
+
+    <p class="tag_title">Returns:</p>
+    <ul class="return">
+
+      <li>
+
+
+        <span class='type'>(<tt>Hash</tt>)</span>
+
+
+
+        &mdash;
+        <div class='inline'><p>Returns the attributes of your targets.</p>
+        </div>
+
+      </li>
+
+    </ul>
+
+  </div>
+</div>
+
+</div>