Build a middleman project for multiple platforms using the same codebase. Allows you to build a middleman project for multiple platforms using the same codebase. Useful for creating PhoneGap/Cordova apps that target multiple OSes while using same source tree.
Ruby Gherkin HTML
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
examples
features
fixtures
lib
.gitignore
.travis.yml
Gemfile
README.md
Rakefile
middleman-target.gemspec

README.md

Gem Version Build Status Code Climate

Middleman-Target

Middleman-Target is an extension to MIDDLEMAN 3.x.x and greater to allow you to specify a build target and generate the content accordingly.

NOTE: This version is for MIDDLEMAN >= 3.x.x and Ruby >= 1.9.1. For compatibility with Middleman 2.x.x or Ruby 1.8.7, please see version 0.0.1 of this gem.

What you use it for

Middleman-Target is used to build different versions of in your Middleman project depending on the target you specify.

I created Middleman-Target when I was creating a Phonegap/Cordova app and wanted to use the same HTML code base for both iOS and Android and the web. I needed an easy way to say:

  • If I'm inside Phonegap on iOS, do this.
  • If I'm inside Phonegap on Android, do this.
  • If I'm inside Phonegap on iOS or Android do this.
  • If I'm running as a real mobile web site in a real browser (not in Phonegap), do this.

I created the gem to handle cases like that. Then you can specify a target and middleman will build your project according to that target.

Examples

Simple

ERB code:

<p>
  <%# NOTE: target?() is a shorthand alias for build_target_is?() %>
  <% if build_target_is?(:ios) %>
    iOS specific stuff.
  <% elsif target?(:android) %>
    Android specific stuff.
  <% else %>
    The build target <%= build_target %> has no special needs.
  <% end %>
</p>

Output when run with a build target of 'ios':

iOS specific stuff.

..'Android':

Android specific stuff.

..anything else ('blackberry' in this case):

The build target blackberry has no special needs.

Less simple using build target maps:

If you wanted a particular condition to apply to more than one target you may do something like:

if (target?(:anrdroid) || target?(:ios)) { ... }

..but that can get ugly. Instead we have the concept of "build target maps". They are declared in the config.rb:

activate :target do |t|
  t.build_targets = {
    "phonegap" => {
      :includes => %w[android ios]
    }
  }
end

..this means that if my current built target is "android", a query like:

build_target_is?(:phonegap)

..will be TRUE since "android" is specifed as being 'included' in this phonegap build target.

NOTE: You cannot "build" the "phonegap" target directly, you would build the "android" and "ios" targets separately. This is here so you can specify conditions that span two or more build targets without having to make complicated "if" statements.

Default target

If no target is specified the target of "default" is assumed.

More Examples

Please see the EXAMPLES directory for more thorough information.

Building a target

Middleman-target doesn't yet properly connect to the CLI portion of Middleman. Instead, to specify a build target you currently use and environment variable named "MIDDLEMAN_BUILD_TARGET".

To build the target of "aardvark" you would run:

MIDDLEMAN_BUILD_TARGET=aardvark middleman build

Installing in to Middleman tree

Add the following near the top of your config.rb:

require 'rubygems' # may not be needed depending on ruby ver
require 'middleman-target'
activate :target

To specify a build target map, pass a block in to the activate method as:

activate :target do |t|
  t.build_targets = { ... }
end

Please see /examples for a working usage example.

TODO:

  • repace target.build_targets with something more extensible
  • write rdoc
  • validate the hash passed in to set_build_targets()
  • set build target on the command line as "middleman build TARGET"
  • use app.set instead of always reading ENV for build target
  • not allowed to use a build target from the command line if that build_target if specified as a first-order entry in set_build_targets()

Contributing

If there is any thing you'd like to contribute or fix, please:

  • Fork the repo
  • Make your changes
  • Add Cucumber tests for any new functionality
  • Verify all existing tests work properly
  • Make a pull request

The Cucumber features for this project assume the gem is installed, so to make any changes you will need to build and install the gem locally with your changes.

Changes

0.0.8 July 15, 2015

  • Tested with middleman 3.3.12, changed post-install warning to reflect this.
  • Fixes issue 11.

0.0.7

0.0.6

  • Removed maximal middleman version requirement. If the version of middleman currently installed in greater than the last-tested version, a post-install warning is given but the installation will succeed.

0.0.5

  • Changed middleman dependency from ~>3.0.11 to >= 3.0.0 and < 3.2

0.0.4

Misc

The middleman-target gem is Copyright 2012-2015 Matthew Nielsen, distributed under the MIT License.

Thanks to jtwalters@github for patches and motivation to add Middleman 3 compatibility.