middleman-targets 1.0.0

data/lib/middleman-targets.rb

@@ -0,0 +1,13 @@
+################################################################################
+# middleman-targets.rb
+#  This file brings in the CLI additions and activates and registers this
+#  extension in Middleman.
+################################################################################
+
+require 'middleman-core'
+require_relative 'middleman-targets/commands'
+
+Middleman::Extensions.register :MiddlemanTargets, :before_configuration do
+  require_relative 'middleman-targets/extension'
+  MiddlemanTargets
+end

data/lib/middleman-targets/commands.rb

@@ -0,0 +1,6 @@
+################################################################################
+# commands.rb
+#  This file aggregates all of the elements that extend Middleman's CLI.
+################################################################################
+
+require_relative 'middleman-cli/build_all'

data/lib/middleman-targets/extension.rb

@@ -0,0 +1,281 @@
+################################################################################
+# extension.rb
+#  This file constitutes the framework for the bulk of this extension.
+################################################################################
+require 'middleman-core'
+
+class MiddlemanTargets < ::Middleman::Extension
+
+  ############################################################
+  # Define the options that are to be set within `config.rb`
+  # as Middleman *application* (not extension) options.
+  ############################################################
+  define_setting :target, 'default', 'The default target to process if not specified.'
+  define_setting :targets, { :default => { :features => {} } } , 'A hash that defines many characteristics of the target.'
+  define_setting :target_magic_images, true, 'Enable magic images for targets.'
+  define_setting :target_magic_word, 'all', 'The magic image prefix for asset substitution.'
+
+
+  ############################################################
+  # initialize
+  ############################################################
+  def initialize(app, options_hash={}, &block)
+
+    super
+    app.config[:target] = app.config[:target].to_sym
+
+  end # initialize
+
+
+  ############################################################
+  # after_configuration
+  #  Handle the --target cli setting.
+  #############################################################
+  def after_configuration
+
+    return if app.config[:exit_before_ready]
+
+    app.config[:target] = app.config[:target].downcase.to_sym
+    requested_target = app.config[:target]
+    valid_targets = app.config[:targets].each_key.collect { |item| item.downcase}
+
+    if valid_targets.count < 1
+      say 'middleman-targets is activated but there are no targets specified in your', :red
+      say 'configuration file.', :red
+      exit 1
+    end
+
+    if valid_targets.include?(requested_target)
+
+      if app.config[:mode] == :server
+        say "Middleman will serve using target \"#{requested_target}\".", :blue
+      else
+        if (build_dir = app.config[:targets][app.config[:target]][:build_dir])
+          app.config[:build_dir] = sprintf(build_dir, requested_target)
+        else
+          app.config[:build_dir] = "#{app.config[:build_dir]} (#{requested_target})"
+        end
+        say "Middleman will build using target \"#{requested_target}\".", :blue
+        say "Build directory is \"#{app.config[:build_dir]}\".", :blue
+      end
+
+    else
+
+      if requested_target
+        say "The target \"#{requested_target}\" is invalid. Use one of these:", :red
+      else
+        say 'No target has been specified. Use one of these:', :red
+      end
+      valid_targets.each { |t| say "  #{t}", :red }
+      exit 1
+
+    end
+
+  end # after_configuration
+
+
+  ############################################################
+  #  Sitemap manipulators.
+  #    Add new methods to each resource.
+  ############################################################
+  def manipulate_resource_list(resources)
+
+    resources.each do |resource|
+
+      #--------------------------------------------------------
+      #  valid_features
+      #    Returns an array of valid features for this page
+      #    based on the current target, i.e., features that
+      #    are true for the current target. These are the
+      #    only features that can be used with frontmatter
+      #    :target or :exclude.
+      #--------------------------------------------------------
+      def resource.valid_features
+        @app.config[:targets][@app.config[:target]][:features].select { |k, v| v }.keys
+      end
+
+
+      #--------------------------------------------------------
+      #  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 frontmatter, 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
+      #    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.
+      #--------------------------------------------------------
+      def resource.targeted?
+        target_name = @app.config[:target]
+            ( !self.data['target'] || (self.data['target'].include?(target_name) || (self.data['target'] & self.valid_features).count > 0) ) &&
+            ( !self.data['exclude'] || !(self.data['exclude'].include?(target_name) || (self.data['exclude'] & self.valid_features).count > 0) )
+      end
+
+
+      #========================================================
+      #  ignore un-targeted pages
+      #    Here we have the chance to ignore resources that
+      #    don't belong in this build based on front matter
+      #    options.
+      #========================================================
+      resource.ignore! unless resource.targeted?
+
+
+      #========================================================
+      #  ignore non-target images
+      #    Here we have the chance to ignore images from other
+      #    targets if :target_magic_images is enabled.
+      #========================================================
+      if @app.config[:target_magic_images] && resource.content_type && resource.content_type.start_with?('image/')
+        targets = @app.config[:targets].keys
+        targets.delete(@app.config[:target])
+        keep = true
+        targets.each { |prefix| keep = keep && File.basename(resource.path) !~ /^#{prefix}\-/i }
+        unless keep
+          resource.ignore!
+          say "  Ignoring #{resource.path} because this target is #{@app.config[:target]}.", :yellow
+        end
+      end
+
+
+    end # resources.each
+
+    resources
+
+  end # manipulate_resource_list
+
+
+  ############################################################
+  #  Helpers
+  #    Methods defined in this helpers block are available in
+  #    templates.
+  ############################################################
+
+  helpers do
+
+    #--------------------------------------------------------
+    # target_name
+    #   Return the current build target.
+    #--------------------------------------------------------
+    def target_name
+      @app.config[:target]
+    end
+
+
+    #--------------------------------------------------------
+    # target_name?
+    #   Is the current target `proposal`?
+    #--------------------------------------------------------
+    def target_name?( proposal )
+      @app.config[:target] == proposal.to_sym
+    end
+
+
+    #--------------------------------------------------------
+    # target_feature?
+    #   Does the target have the feature `feature`?
+    #--------------------------------------------------------
+    def target_feature?( feature )
+      features = @app.config[:targets][@app.config[:target]][:features]
+      features.key?(feature.to_sym) && features[feature.to_sym]
+    end
+
+
+    #--------------------------------------------------------
+    # target_value( key )
+    #   Attempts to return arbitrary key values for the
+    #   current target.
+    #--------------------------------------------------------
+    def target_value( key )
+      target_values = @app.config[:targets][@app.config[:target]]
+      target_values.key?(key) ? target_values[key] : nil
+    end
+
+
+    #--------------------------------------------------------
+    # image_tag
+    #   Override the built-in version in order to support:
+    #    - automatic target-specific images. Note that this
+    #      only works on local files.
+    #    - target and feature dependent images.
+    #    - absolute paths
+    #--------------------------------------------------------
+    def image_tag(path, params={})
+      params.symbolize_keys!
+
+      # We won't return an image at all if a :target or :feature parameter
+      # was provided, unless we're building that target or feature.
+      return if params.include?(:target) && !target_name?(params[:target])
+      return if params.include?(:feature) && !target_feature?(params[:feature])
+
+      params.delete(:target)
+      params.delete(:feature)
+
+
+      # Let's try to find a substitutable file if the current image name
+      # begins with the :target_magic_word
+      if @app.config[:target_magic_images] && File.basename(path).start_with?( @app.config[:target_magic_word])
+        real_path = path.dup
+
+        # Enable absolute paths, too.
+        real_path = if path.start_with?('/')
+                      File.expand_path(File.join(@app.config[:source], real_path))
+                    else
+                      File.expand_path(File.join(@app.config[:source], @app.config[:images_dir], real_path))
+                    end
+
+        proposed_file = real_path.sub( "#{@app.config[:target_magic_word]}-", "#{app.config[:target]}-" )
+        file = app.files.find(:source, proposed_file)
+
+        # Now, only make the change *if* the file exists on disk.
+        if file && file[:full_path].exist?
+          path = path.dup.sub("#{@app.config[:target_magic_word]}-", "#{app.config[:target]}-")
+
+          # Support automatic alt tags for absolute locations, too. Only do
+          # this for absolute paths; let the extension do its own thing
+          # otherwise.
+          if @app.extensions[:automatic_alt_tags] && path.start_with?('/')
+            alt_text = File.basename(file[:full_path].to_s, '.*')
+            alt_text.capitalize!
+            params[:alt] ||= alt_text
+          end
+
+        end
+      end
+
+      super(path, params)
+    end
+
+
+  end #helpers
+
+
+  ############################################################
+  # say
+  #  Output colored messages using ANSI codes.
+  ############################################################
+  def say(message = '', color = :reset)
+    colors = { :blue   => "\033[34m",
+               :cyan   => "\033[36m",
+               :green  => "\033[32m",
+               :red    => "\033[31m",
+               :yellow => "\033[33m",
+               :reset  => "\033[0m",
+    }
+
+    if RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
+      puts message
+    else
+      puts colors[color] + message + colors[:reset]
+    end
+  end # say
+
+
+end # class MiddlemanTargets

data/lib/middleman-targets/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+    module MiddlemanTargets
+        VERSION = '1.0.0'
+    end
+end

data/middleman-targets.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'middleman-targets/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'middleman-targets'
+  s.version     = Middleman::MiddlemanTargets::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Jim Derry']
+  s.email       = ['balthisar@gmail.com']
+  s.homepage    = 'https://github.com/middlemac/middleman-targets'
+  s.summary     = 'Provides multiple build targets and tools for Middleman.'
+  s.description = 'Provides multiple build targets and tools for Middleman.'
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+  
+  # The version of middleman-core your extension depends on
+  s.add_runtime_dependency('middleman-core', ['~> 4.1', '>= 4.1.6'])
+
+  # Additional dependencies
+  s.add_runtime_dependency('middleman-cli', ['~> 4.1', '>= 4.1.6'])
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: middleman-targets
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jim Derry
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.6
+- !ruby/object:Gem::Dependency
+  name: middleman-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.6
+description: Provides multiple build targets and tools for Middleman.
+email:
+- balthisar@gmail.com
+executables:
+- middleman-targets
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/middleman-targets
+- documentation_project/.gitignore
+- documentation_project/Gemfile
+- documentation_project/README.md
+- documentation_project/config.rb
+- documentation_project/source/frontmatter.html.md.erb
+- documentation_project/source/helpers-resources.html.md.erb
+- documentation_project/source/images/free-logo-small.png
+- documentation_project/source/images/free-logo-small@2x.png
+- documentation_project/source/images/free-logo.png
+- documentation_project/source/images/free-logo@2x.png
+- documentation_project/source/images/pro-logo-small.png
+- documentation_project/source/images/pro-logo-small@2x.png
+- documentation_project/source/images/pro-logo.png
+- documentation_project/source/images/pro-logo@2x.png
+- documentation_project/source/index.html.md.erb
+- documentation_project/source/javascripts/all.js
+- documentation_project/source/layouts/layout.haml
+- documentation_project/source/layouts/template-logo-large.haml
+- documentation_project/source/layouts/template-logo-medium.haml
+- documentation_project/source/layouts/template-logo-small.haml
+- documentation_project/source/only-free.html.md.erb
+- documentation_project/source/only-pro.html.md.erb
+- documentation_project/source/simple-demo.html.md.erb
+- documentation_project/source/stylesheets/_github.scss
+- documentation_project/source/stylesheets/_middlemac_minimal.scss
+- documentation_project/source/stylesheets/_normalize.scss
+- documentation_project/source/stylesheets/style.css.scss
+- documentation_project/source/target-feature-config.html.md.erb
+- lib/middleman-targets.rb
+- lib/middleman-targets/commands.rb
+- lib/middleman-targets/extension.rb
+- lib/middleman-targets/version.rb
+- middleman-targets.gemspec
+homepage: https://github.com/middlemac/middleman-targets
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Provides multiple build targets and tools for Middleman.
+test_files: []
+has_rdoc: