middleman-targets 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5b0207312e941b65b1ee3842b775d77c868fccdc
+  data.tar.gz: 17aa00a667fcece866f54b5080ae53e9e8269b58
+SHA512:
+  metadata.gz: 3eff02a74fc75761e2820e4aaad2c61a6edb7e78be4cff60f7081f0cce0e72ee89e951cbe72afedddbc7dc11875c514de9106505f9197bc16a2f2d5bd851f0b1
+  data.tar.gz: cd7d551e89f13468ac9e6b7f9dd6b84912cb3248e24f5e87b6b905807682a807aebf588e80dfba5c255f1ccf64645912fc19364e6fd6188a3ea10d85302f4a22

data/.gitignore

@@ -0,0 +1,17 @@
+# Rubymine noise
+.idea/
+
+# BBedit noise
+*.bbprojectd
+
+# Mac OS X noise
+.DS_Store
+
+# Ignore bundler lock files
+Gemfile.lock
+
+# Ignore pkg folder
+/pkg
+
+# Ignore build folders
+build*

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+middlemac-targets change log
+============================
+
+- Version 1.0.0 / 2016-March
+
+  - Initial Release

data/Gemfile

@@ -0,0 +1,18 @@
+# If you do not have OpenSSL installed, update
+# the following line to use "http://" instead
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in middlemac.gemspec
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'yard'
+end
+
+group :test do
+  gem 'cucumber'
+  gem 'aruba'
+  gem 'rspec'
+end

data/LICENSE.md

@@ -0,0 +1,22 @@
+The MIT License
+===============
+
+Copyright (c) 2016 Jim Derry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,110 @@
+middleman-targets readme
+========================
+
+`middleman-targets`
+
+ : This gem provides the ability to generate multiple targets by outfitting
+   Middleman with additional command line options. The provided helpers make
+   it simple to control content that is specific to each target, based on the
+   target name or based on feature sets for each target.
+
+   It is standalone and can be used in any Middleman project.
+
+
+Install the Gem
+---------------
+
+Install the gem in your preferred way, typically:
+
+~~~ bash
+gem install middleman-targets
+~~~
+
+From git source:
+
+~~~ bash
+rake install
+~~~
+
+
+Documentation
+-------------
+
+The complete documentation leverages the features of this gem in order to better
+document them. Having installed the gem, read the full documentation in your
+web browser:
+
+~~~ bash
+middleman-targets documentation
+cd middleman-targets-docs/
+bundle install
+bundle exec middleman server
+~~~
+   
+And then open your web browser to the address specified (typically
+`localhost:4567`).
+
+
+Quick Documentation
+-------------------
+
+[Middleman](https://middlemanapp.com/) 4.1.6 or newer is required. Earlier
+point versions of Middleman do not have the necessary support for this
+extension.
+
+Once setup and configured, you can build multiple targets like so:
+
+~~~ bash
+bundle exec middleman build --target mytarget
+~~~
+
+Or:
+
+~~~ bash
+bundle exec middleman build_all
+~~~
+
+Or:
+
+~~~ bash
+bundle exec middleman serve --target mytarget
+~~~
+
+Added Features
+--------------
+
+To support multiple targets and features, flexible configuration and helpers are
+available, including
+
+- Enhanced `image_tag` support chooses target-specific assets for you.
+- Enhanced `image_tag` support conditionally includes assets specific to
+  targets or features that you designate.
+- The `target_name?()` helper allows you to selectively include or exclude
+  content on a per-target basis.
+- The `target_feature?()` helper allows fined-grained control over included
+  content by managing features of a target instead of a target per se.
+- Front matter `target` and `exclude` arrays can ensure entire pages are
+  included or excluded on a target and/or feature specific basis.
+- …and more.
+
+
+Middlemac
+---------
+
+  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.
+
+
+License
+-------
+
+MIT. See `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).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/middleman-targets

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+
+################################################################################
+# middleman-targets
+#  This file constitutes the command line interface for middleman-targets
+################################################################################
+
+require 'thor'
+require 'fileutils'
+require 'middleman-targets/version'
+
+module MiddlemacTargetsCli
+
+  class Cli < Thor
+
+    map %w[--version -v] => :__print_version
+    
+    ############################################################
+    # help
+    #  Override to add additional description.
+    ############################################################
+    def help(*args)
+      if args.count == 0
+        puts <<-HEREDOC
+
+middleman-targets version #{Middleman::MiddlemanTargets::VERSION}
+
+This gem adds functionality to Middleman and is not executable on its own
+(other than for generating the documentation sample project). Instead, you
+must add this gem to your Middleman project's `Gemfile` and then activate
+it in your `config.rb` file. This will enable the new `--target` command
+line option in Middleman, and the new `build_all` command.
+
+HEREDOC
+      end
+      super
+    end
+
+
+    ############################################################
+    # documentation
+    ############################################################
+    desc 'documentation', 'Install the sample project into your current working directory.'
+    long_desc <<-HEREDOC
+`documentation` will produce a sample project named `middleman-targets-docs/`
+in your current working directory. This sample uses the features of this gem.
+You can then serve this new project to read the documentation by:
+
+cd middleman-targets-docs
+bundle install
+bundle exec middleman server
+    
+    HEREDOC
+    def documentation
+      source = File.join('..', '..', 'documentation_project', '.')
+      source = File.expand_path(source, __FILE__)
+      dest = File.expand_path(File.join('.', 'middleman-targets-docs', '.'))
+      FileUtils.cp_r(source, dest)
+      puts "middleman-targets installed the project in\n#{dest}" 
+    end
+
+
+    ############################################################
+    # __print_version
+    ############################################################
+    desc '--version, -v', 'print the version'
+    def __print_version
+      puts "middleman-targets version #{Middleman::MiddlemanTargets::VERSION}"
+    end
+
+  end # class Cli
+
+end # module MiddlemacTargetsCli
+
+
+###########################################################
+# Main
+###########################################################
+
+MiddlemacTargetsCli::Cli.start(ARGV)

data/documentation_project/.gitignore

@@ -0,0 +1,25 @@
+# Rubymine noise
+.idea/
+
+# BBedit noise
+*.bbprojectd
+
+# Mac OS X noise
+.DS_Store
+
+# Ignore bundler lock files
+Gemfile.lock
+
+# Ignore pkg folder
+/pkg
+
+# Ignore build folders
+.rbenv-*
+.ruby-gemset
+.ruby-version
+.sass-cache
+.sassc
+.tmp
+build*
+Makefile
+tmp

data/documentation_project/Gemfile

@@ -0,0 +1,14 @@
+# If you do not have OpenSSL installed, change
+# the following line to use 'http://'
+source 'https://rubygems.org'
+
+# For faster file watcher updates on Windows:
+gem 'wdm', '~> 0.1.0', platforms: [:mswin, :mingw]
+
+# Windows does not come with time zone data
+gem 'tzinfo-data', platforms: [:mswin, :mingw, :jruby]
+
+# Middleman Gems
+gem 'middleman-targets', '~>1.0.0'
+gem 'middleman', '~> 4.1.6'
+gem 'middleman-syntax'

data/documentation_project/README.md

@@ -0,0 +1,13 @@
+documentation-project readme
+----------------------------
+
+This gem's documentation is a Middleman project using the features of this gem.
+To view the documentation project, `cd` into this directory and
+
+~~~ bash
+gem install
+bundle exec middleman serve
+~~~
+
+When the server starts, it will provide instructions on how to view the project
+in your web browser.

data/documentation_project/config.rb

@@ -0,0 +1,123 @@
+################################################################################
+# Sample Project for middleman-targets
+################################################################################
+
+#==========================================================================
+# Conflicting helpers
+#  middleman-targets extends the built-in `image_tag` helper, but so do
+#  some of Middleman's other extensions. To avoid issues, make sure you
+#  activate those other extensions, first, before :MiddlemanTargets.
+#==========================================================================
+activate :automatic_image_sizes
+activate :automatic_alt_tags
+
+
+#==========================================================================
+# Extension Setup
+#  Note that middleman-targets adds configuration parameters to the base
+#  Middleman application (supported feature in 4.0+); there are *not*
+#  extension options. Additionally if middleman-targets is in your Gemfile
+#  then it is also activated automatically.
+#==========================================================================
+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
+
+# 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
+# required for each of your targets.
+#
+# The key :build_dir for any target, if used, will override the global
+# :build_dir setting. You can use a specific string for this setting, and
+# this string can optionally include a single %s sprintf placeholder which
+# will be filled with the target name.
+#
+# 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, {
+  :free =>
+      {
+      :sample_key => 'People who use free versions don\'t drive profits.',
+      :build_dir  => '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,
+          }
+      },
+}
+
+# By enabling :target_magic_images and using middleman-targets' image helper,
+# then 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.
+set :target_magic_images, true
+set :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'
+
+
+#==========================================================================
+# Regular Middleman Setup
+#==========================================================================
+
+set :relative_links, true
+activate :syntax
+
+
+#==========================================================================
+# Helpers
+#  These helpers are used by the sample project only; there's no need
+#  to keep them around in your own projects.
+#==========================================================================
+
+# Methods defined in the helpers block are available in templates
+helpers do
+
+  def product_name
+    'middleman-targets'
+  end
+
+  def product_version
+    '2.0.0-beta1'
+  end
+
+  def product_uri
+    'https://github.com/middlemac'
+  end
+
+end
+
+# Build-specific configuration
+configure :build do
+  # Minify CSS on build
+  # activate :minify_css
+
+  # Minify Javascript on build
+  # activate :minify_javascript
+end