RubyGems - middleman-target - Versions diffs - 0.0.1 - Mend

middleman-target 0.0.1

Files changed (8) hide show

data/README.md +94 -0
data/examples/config.rb +14 -0
data/examples/source/index.html.erb +32 -0
data/lib/middleman-target.rb +53 -0
data/spec/lib/middleman-target_spec.rb +155 -0
data/spec/spec.opts +4 -0
data/spec/spec_helper.rb +0 -0
metadata +95 -0

data/README.md ADDED Viewed

@@ -0,0 +1,94 @@
+# Middleman-Target
+Middleman-Target is an extension to [MIDDLEMAN] 2.0.x to allow you to specify a build target and generate the content accordingly.
+You can use Middleman-Target in your Middleman project to build multiple versions of your source from one source tree.
+# Examples
+## Simple
+ERB code:
+    <p>
+      <%# NOTE: target?() is a shorthand alias for build_target_is?() %>
+      <% if build_target_is?(:foo) %>
+        Foo specific stuff.
+      <% elsif target?(:bar) %>
+        Bar specific stuff.
+      <% else %>
+        The build target <%= build_target %> has no special needs.
+      <% end %>
+    </p>
+Output when run with a build target of 'foo':
+    Foo specific stuff.
+..'bar':
+    Bar specific stuff.
+..anything else ('baz' in this case):
+    The build target baz 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:
+    set_build_targets({
+      "phonegap" => {
+        :includes => %w[android ios]
+      }
+    })
+..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
+# TODO:
+* write rdoc
+* 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()
+# REQUIREMENTS AND INSTALLATION
+Middleman-Target was developed against [MIDDLEMAN] 2.0.15. Compatibility with other versions is not guaranteed.  When Middleman 3.0 is released this will likely not work with it.
+## Gem Version Hell
+Because gem authors don't specify minimal and maximal version of dependencies, installing Middleman 2.0.15 can put you in dependency version hell.  To rememdy this, install gems in this order:
+    gem install multi_json -v="1.0.3"
+    gem install execjs -v="1.2.7"
+    gem install middleman -v="2.0.15"
+    gem install middleman-target
+[MIDDLEMAN]: https://github.com/middleman/middleman/

data/examples/config.rb ADDED Viewed

@@ -0,0 +1,14 @@
+require '../lib/middleman-target'
+activate :target
+set_build_targets({
+  "phonegap" => {
+    :includes => %w[android ios]
+  }
+})
+disable :layout
+configure :build do
+end

data/examples/source/index.html.erb ADDED Viewed

@@ -0,0 +1,32 @@
+<html>
+  <body>
+    <h1>current build target: <%= build_target %></h1>
+    <h4>build target map: <%= build_targets.inspect %></h4>
+    <p>
+      <% if build_target_is?(:foo) %>
+        Foo specific stuff.
+      <% elsif target?(:bar) %>
+        Bar specific stuff.
+      <% else %>
+        The build target <%= build_target %> has no special needs.
+      <% end %>
+    </p>
+    <p>
+      <% if target?(:phonegap) %>
+        Specified target is included in "phonegap" target.
+      <% else %>
+        Specified target is not in "phonegap" target.
+      <% end %>
+    </p>
+    <p>
+      <% if default_target? || no_target? %>
+        Using the default build target, or no target specified.
+      <% else %>
+        A build target has been specified that is not the default.
+      <% end %>
+    </p>
+  </body>
+</html>

data/lib/middleman-target.rb ADDED Viewed

@@ -0,0 +1,53 @@
+module Middleman::Features::Target
+  class << self
+    def registered(app)
+      app.set :build_targets, {}
+      app.extend ClassMethods
+      app.helpers HelperMethods
+    end
+    alias :included :registered
+  end
+  module ClassMethods
+    def set_build_targets(targets={})
+      raise "#set_build_targets() argument must be a hash" unless targets.class == Hash
+      settings.build_targets = targets
+    end
+  end
+  module HelperMethods
+    DEFAULT_BUILD_TARGET = :default
+    def build_targets
+      @build_target ||= settings.build_targets
+    end
+    def build_target
+      @middleman_build_target ||= if ENV['MIDDLEMAN_BUILD_TARGET']
+        ENV['MIDDLEMAN_BUILD_TARGET'].downcase.to_sym
+      else
+        DEFAULT_BUILD_TARGET
+      end
+    end
+    def build_target_is?(target_name)
+      if build_targets.empty?
+        build_target == target_name
+      else
+        if !build_targets[target_name.to_s].nil?
+          if (build_targets[target_name.to_s][:includes] || []).include?(build_target.to_s)
+            return true
+          end
+        end
+        return false
+      end
+    end
+    alias :target? :build_target_is?
+    def default_target?
+      build_target == DEFAULT_BUILD_TARGET
+    end
+    alias :no_target? :default_target?
+  end
+end

data/spec/lib/middleman-target_spec.rb ADDED Viewed

@@ -0,0 +1,155 @@
+require 'spec_helper'
+module Middleman
+  module Features
+    require 'lib/middleman-target'
+  end
+end
+class HelperMethodTest
+  include Middleman::Features::Target::HelperMethods
+end
+class ClassMethodTest
+  include Middleman::Features::Target::ClassMethods
+end
+###
+describe Middleman::Features do
+  describe Middleman::Features::Target do
+    describe '.registered' do
+      pending "Not sure how to test this guy"
+    end
+  end
+  describe Middleman::Features::Target::ClassMethods do
+    before(:each) do
+      @base = ClassMethodTest.new
+    end
+    describe '#set_build_targets' do
+      it 'should set the build_targets setting to be the passed value' do
+        # expect
+        @base.stub!(:settings).and_return(mock('settings'))
+        @base.settings.should_receive(:build_targets=).once.with({:foo => 'bar'})
+        # when
+        @base.set_build_targets({:foo => 'bar'})
+      end
+      it 'should only accept hashes as arguments' do
+        lambda {
+          @base.set_build_targets('string')
+        }.should raise_error(RuntimeError)
+      end
+    end
+  end
+  describe Middleman::Features::Target::HelperMethods do
+    before(:each) do
+      @base = HelperMethodTest.new
+    end
+    describe '#build_target_is?' do
+      before(:each) do
+        @base.stub!(:settings).and_return(mock('settings', :build_targets => {}))
+      end
+      it 'should be true if build target matches passed argument' do
+        # given
+        @base.stub!(:build_target).and_return(:foo)
+        # expect
+        @base.build_target_is?(:foo).should be_true
+      end
+      it 'should be false if build target does not match passed argument' do
+        # given
+        @base.stub!(:build_target).and_return(:bar)
+        # expect
+        @base.build_target_is?(:foo).should be_false
+      end
+      it 'should be true if build_targets defines a target that "includes" this target' do
+        # given
+        @base.stub!(:build_target).and_return(:android)
+        @base.stub!(:settings).and_return(
+          mock('settings', :build_targets => {
+            "phonegap" => {
+              :includes => %w[android ios]
+            }
+          })
+        )
+        # expect
+        @base.build_target_is?(:phonegap).should be_true
+      end
+      it 'should be false if build_targets is defined but does "include" target in any definition' do
+        # given
+        @base.stub!(:build_target).and_return(:winmo6)
+        @base.stub!(:settings).and_return(
+          mock('settings', :build_targets => {
+            "phonegap" => {
+              :includes => %w[android ios]
+            }
+          })
+        )
+        # expect
+        @base.build_target_is?(:phonegap).should be_false
+      end
+    end
+    describe '#default_target?' do
+      it 'should be true if the current target is the default target' do
+        # given
+        @base.stub!(:build_target).and_return(
+          Middleman::Features::Target::HelperMethods::DEFAULT_BUILD_TARGET
+        )
+        # expect
+        @base.default_target?.should be_true
+      end
+      it 'should be false if the current target is not the default target' do
+        # given
+        @base.stub!(:build_target).and_return(:something)
+        # expect
+        @base.default_target?.should be_false
+      end
+    end
+    describe '#build_target' do
+      before(:each) do
+        @base.stub!(:settings).and_return(mock('settings', :build_targets => {}))
+      end
+      it 'should return the specified build target if one was given' do
+        # given
+        ENV['MIDDLEMAN_BUILD_TARGET'] = 'something'
+        # expect
+        @base.build_target.should == :something
+      end
+      it 'should downcase and symbolize the given build target' do
+        # given
+        ENV['MIDDLEMAN_BUILD_TARGET'] = 'SoMeThInG'
+        # expect
+        @base.build_target.should == :something
+      end
+      it 'should return the default build target if one was given' do
+        # given
+        ENV['MIDDLEMAN_BUILD_TARGET'] = nil
+        # expect
+        @base.build_target.should == Middleman::Features::Target::HelperMethods::DEFAULT_BUILD_TARGET
+      end
+    end
+  end
+end

data/spec/spec.opts ADDED Viewed

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb ADDED Viewed

File without changes

metadata ADDED Viewed

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: middleman-target
+version: !ruby/object:Gem::Version
+  prerelease: false
+  segments:
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthew Nielsen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2012-04-12 00:00:00 -06:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        segments:
+        - 2
+        - 0
+        - 15
+        version: 2.0.15
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        segments:
+        - 2
+        - 9
+        - 0
+        version: 2.9.0
+  type: :development
+  version_requirements: *id002
+description: Allows you specify different targets for a middleman build so you can build different versions of a site from the same source tree.
+email: xunker@pyxidis.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- examples/config.rb
+- examples/source/index.html.erb
+- lib/middleman-target.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/lib/middleman-target_spec.rb
+has_rdoc: true
+homepage: https://github.com/xunker/middleman-target
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      version: "0"
+requirements: []
+rubyforge_project:
+rubygems_version: 1.3.6
+signing_key:
+specification_version: 3
+summary: Ability to specify build targets for Middleman projects
+test_files: []