middleman-target 0.0.1 → 0.0.3

data/README.md

@@ -1,6 +1,6 @@
 # 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.
+Middleman-Target is an extension to [MIDDLEMAN] 3.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.
 
@@ -41,11 +41,13 @@ If you wanted a particular condition to apply to more than one target you may do
 
 ..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]
+    active :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:
 
@@ -73,22 +75,49 @@ To build the target of "aardvark" you would run:
 
 # 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()
 
 # 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.
+This new version is for [MIDDLEMAN] 3.0.x ONLY. For compatibility with Middleman 2.0.x, please see version 0.0.1 of this gem.
 
-## Gem Version Hell
+## Installing in to Middleman tree
 
-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:
+Add the following near the top of your config.rb:
 
-    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
+    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 "active" method as:
+
+    active :target do |t|
+      t.build_targets = { ... }
+    end
+
+Please see /examples for a working usage example.
+
+# 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.
+
+# Misc
+
+The middleman-target gem is Copyright 2012-2013 Matthew Nielsen, distributed under the MIT License.
+
+Thanks to jtwalters@github for patches and motivation to add Middleman 3 compatibility.
 
 [MIDDLEMAN]: https://github.com/middleman/middleman/

data/examples/config.rb

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

data/features/support/env.rb

@@ -0,0 +1,18 @@
+ENV["TEST"] = "true"
+ENV["AUTOLOAD_SPROCKETS"] = "false"
+
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require "middleman-core"
+require "middleman-core/step_definitions"
+# require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-target')
+
+require 'middleman-target'
+
+After do
+  ENV['MIDDLEMAN_BUILD_TARGET'] = nil
+end
+
+
+Given /^build target is "(.*?)"$/ do |target_name|
+  ENV['MIDDLEMAN_BUILD_TARGET'] = target_name
+end

data/features/target.feature

@@ -0,0 +1,35 @@
+Feature: Target
+
+  Scenario: build target name
+    Given build target is "foo"
+    And the Server is running at "build_target"
+    When I go to "/build_target.html"
+    Then I should see "current build target: foo"
+
+  Scenario: build target map
+    Given the Server is running at "build_targets"
+    When I go to "/build_targets.html"
+    Then I should see 'build target map: {"phonegap"=>{:includes=>["android", "ios"]}}'
+
+  Scenario: build target is "phonegap" which includes "ios"
+    Given build target is "ios"
+    And the Server is running at "build_target_includes"
+    When I go to "/build_target_includes.html"
+    Then I should see "Specified target ios is included in phonegap target."
+
+  Scenario: build target is "phonegap" which does not include "windows_phone"
+    Given build target is "windows_phone"
+    And the Server is running at "build_target_includes"
+    When I go to "/build_target_includes.html"
+    Then I should see "Specified target windows_phone is not included in phonegap target."
+
+  Scenario: no target or using default build target
+    Given the Server is running at "build_target_default"
+    When I go to "/build_target_default.html"
+    Then I should see "Using the default build target, or no target specified."
+
+  Scenario: target specified, not using default build target
+    Given build target is "foo"
+    Given the Server is running at "build_target_default"
+    When I go to "/build_target_default.html"
+    Then I should see "A build target has been specified that is not the default."

data/fixtures/build_target/config.rb

@@ -0,0 +1 @@
+activate :target

data/fixtures/build_target/source/build_target.html.erb

@@ -0,0 +1 @@
+<p>current build target: <%= build_target %></p>

data/fixtures/build_target_default/config.rb

@@ -0,0 +1 @@
+activate :target

data/fixtures/build_target_default/source/build_target_default.html.erb

@@ -0,0 +1,7 @@
+<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>

data/fixtures/build_target_includes/config.rb

@@ -0,0 +1,9 @@
+activate :target do |target|
+
+  target.build_targets = {
+    "phonegap" => {
+      :includes => %w[android ios]
+    }
+  }
+
+end

data/fixtures/build_target_includes/source/build_target_includes.html.erb

@@ -0,0 +1,2 @@
+<p>Specified target <%= build_target %> <% if target?(:phonegap) %>is<% else %>is not<% end %> included in phonegap target.</p>
+

data/fixtures/build_targets/config.rb

@@ -0,0 +1,9 @@
+activate :target do |target|
+
+  target.build_targets = {
+    "phonegap" => {
+      :includes => %w[android ios]
+    }
+  }
+
+end

data/fixtures/build_targets/source/build_targets.html.erb

@@ -0,0 +1 @@
+<p>build target map: <%= build_targets.inspect %></p>

data/lib/middleman-target/extension.rb

@@ -0,0 +1,71 @@
+module Middleman
+  module Target
+
+    # Options class copied from
+    # https://github.com/middleman/middleman-blog/blob/master/lib/middleman-blog/extension.rb
+    class Options
+      KEYS = [ :build_targets ]
+
+      KEYS.each do |name|
+        attr_accessor name
+      end
+
+      def initialize(options={})
+        options.each do |k,v|
+          self.send(:"#{k}=", v)
+        end
+      end
+    end
+
+    class << self
+      def registered(app, options_hash={}, &block)
+        # app.set :build_targets, {}
+        app.helpers HelperMethods
+
+        options = Options.new(options_hash)
+        yield options if block_given?
+
+        if options.build_targets
+          raise "#build_targets must be a hash" unless options.build_targets.class == Hash
+          app.set :build_target_definitions, options.build_targets
+        end
+      end
+      alias :included :registered
+    end
+
+    module HelperMethods
+      DEFAULT_BUILD_TARGET = :default
+
+      def build_targets
+        @build_target ||= build_target_definitions
+      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
+end

data/lib/middleman-target.rb

@@ -1,53 +1,6 @@
-module Middleman::Features::Target
+require "middleman-core"
 
-  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
+::Middleman::Extensions.register(:target) do
+  require "middleman-target/extension"
+  ::Middleman::Target
+end

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require "middleman-target"

metadata

@@ -1,95 +1,125 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: middleman-target
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Matthew Nielsen
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-04-12 00:00:00 -06:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: middleman
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 0
-        - 15
-        version: 2.0.15
+      - !ruby/object:Gem::Version
+        version: 3.0.11
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.11
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 9
-        - 0
-        version: 2.9.0
+      - !ruby/object:Gem::Version
+        version: 0.4.11
   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.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.11
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+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: 
+files:
 - README.md
 - examples/config.rb
 - examples/source/index.html.erb
+- lib/middleman-target/extension.rb
 - lib/middleman-target.rb
-- spec/spec.opts
-- spec/spec_helper.rb
-- spec/lib/middleman-target_spec.rb
-has_rdoc: true
+- lib/middleman_extension.rb
+- fixtures/build_target/config.rb
+- fixtures/build_target/source/build_target.html.erb
+- fixtures/build_target_default/config.rb
+- fixtures/build_target_default/source/build_target_default.html.erb
+- fixtures/build_target_includes/config.rb
+- fixtures/build_target_includes/source/build_target_includes.html.erb
+- fixtures/build_targets/config.rb
+- fixtures/build_targets/source/build_targets.html.erb
+- features/support/env.rb
+- features/target.feature
 homepage: https://github.com/xunker/middleman-target
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+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"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ability to specify build targets for Middleman projects
 test_files: []
-

data/spec/lib/middleman-target_spec.rb

@@ -1,155 +0,0 @@
-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

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