middleman-packager 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9a52d8287fb8999ac8b6c736562f70dc78e59cd2
+  data.tar.gz: c39183e5fa18da3e80173c879ed82bd33d37e038
+SHA512:
+  metadata.gz: 1cede87adfb94840fec678b7b6e35911eada116ee6efdbc4af22499cae6a703e449f3dd26daf2268ba058bea31424e437a5aa4c84185b6ab45b93c963bc0245a
+  data.tar.gz: 7caf9a4d65c65a4bb25ee15984021f033a3300340307cad298f4d441b785510cc50e1f94508af3bdae68bb1446fe07824524017af0fd2efeec358cf9bd8c8510

data/.gitignore

@@ -0,0 +1,8 @@
+# Ignore bundler lock file
+/Gemfile.lock
+
+# Ignore pkg folder
+/pkg
+
+# Ignore coverage folder
+/coverage

data/Gemfile

@@ -0,0 +1,23 @@
+source 'https://rubygems.org'
+
+gem "middleman-core", ">= 3.0.0"
+gem "multi_json" #, "~>1.8.2"
+
+# Specify your gem's dependencies in middleman-packager.gemspec
+gemspec
+
+
+group :development do
+  gem "rake"
+  gem "rdoc"
+  gem "yard"
+end
+
+group :test do
+  gem "compass"
+  gem "cucumber"
+  gem "fivemat"
+  gem "aruba"
+  gem "rspec"
+  gem "simplecov"
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Spencer Rhodes <spencer at spencer dash rhodes dot com>
+
+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,98 @@
+Middleman Packager
+------------------
+
+This is a [Middleman](http://www.middlemanapp.com) extension to easily package up your build into a tgz, zip, or other file archiving mechanism.
+
+This extension is inspired by the excellent [Middleman Deploy](https://github.com/tvaughan/middleman-deploy) extension.
+
+## Requirements
+[Middleman](http://www.middlemanapp.com) 3.0.0+
+
+## Installation
+
+Add this to your Middleman project's Gemfile
+
+```ruby
+gem "middleman-packager"
+```
+and run
+
+```bash
+$ bundle install
+```
+
+## Usage
+Activate the extension in your `config.rb` file:
+
+```ruby
+activate :packager
+```
+
+```bash
+$ middleman build [--clean]
+$ middleman package [-b]
+```
+
+_-b_ : pre-build before packaging
+
+_Note: `pack`, `archive`, and `zip` are aliases for `package`._
+### Config examples
+###### Block config
+
+```ruby
+\# Use zip instead of tar+gzip
+activate :packager do |pack|
+    pack.package_mask = "build-{ts:%Y-%m-%d}.tgz"
+    pack.package_cmd_mask = "zip -r {to} {from}"
+end
+```
+
+###### Inline config
+
+```ruby
+\# Custom filename mask
+activate :packager,
+    :package_mask => "../packages/my_project_{ts}.tgz"</code></pre>
+```
+
+## Options
+Default options:
+
+###### `:package_source`  _(default: [middleman build directory])_
+
+The source file/folder of your package.
+
+###### `:package_mask`  _(default: "build-{ts}.tgz")_
+
+A filename mask to use as the target archive file. Accepts relative or absolute file paths, though relative is recommended!
+
+Use `{ts[:time_format_string]}` for the generated timestamp. Optionally, you can pass a standard [Ruby Time formatting string](http://www.ruby-doc.org/core-2.0.0/Time.html#method-i-strftime) to control the timestamp output, or leave off the `:stuff` for a general timestamp.
+
+Examples:
+```ruby
+"build-{ts}.tgz" # => "build-1384121876.tgz"
+"build-{ts:%Y-%m-%d}.tgz" # => "build-2013-11-10.tgz"
+```
+
+###### `:package_cmd_mask`  _(default: "tar -zcf {to} {from}")_
+
+The command and file sequence mask to use. This mask allows you to easily change your archiving tool if you don't want to use tar. _{to}_ is replaced with the compiled `:package_mask` value, and _{from}_ is replaced with the `:package_source` value. Just make sure you change the `:package_mask` option accordingly!
+
+<!--
+###### `:auto_package`  _(default: false)_
+
+Should we auto-package after running a build?
+_Note: This is not yet working_
+
+###### `:pre_build`  _(default: false)_
+
+Run a build before creating a package?
+_Note: This is not yet working, though passing the `-b` parameter to the package command does work._
+-->
+
+## ToDo
+
+ - Get `:pre_build` working
+ - Get `:auto_package` working
+ - Run this in `:build` mode rather than `:development` mode (mm-server)
+     - Other `:development` extensions are running unnecessarily.

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  t.cucumber_opts = "--color --tags ~@wip --strict --format #{ENV['CUCUMBER_FORMAT'] || 'Fivemat'}"
+end
+
+require 'rake/clean'
+
+task :test => ["cucumber"]
+
+task :default => :test

data/features/support/env.rb

@@ -0,0 +1,6 @@
+require "simplecov"
+SimpleCov.start
+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-packager')

data/lib/middleman-packager.rb

@@ -0,0 +1,8 @@
+require "middleman-core"
+
+require "middleman-packager/commands"
+
+::Middleman::Extensions.register(:packager) do
+  require "middleman-packager/extension"
+  ::Middleman::Packager
+end

data/lib/middleman-packager/commands.rb

@@ -0,0 +1,100 @@
+require "middleman-core/cli"
+
+require "middleman-packager/extension"
+require "middleman-packager/pkg-info"
+
+module Middleman
+  module Cli
+
+    # This class provides a "package" command for the middleman CLI.
+    class Packager < Thor
+      include Thor::Actions
+
+      check_unknown_options!
+
+      namespace :package
+
+      # Tell Thor to exit with a nonzero exit code on failure
+      def self.exit_on_failure?
+        true
+      end
+
+      desc "package [options]", Middleman::Packager::TAGLINE
+      method_option "build_before",
+        :type => :boolean,
+        :aliases => "-b",
+        :desc => "Run `middleman build` before the package step"
+
+      def package
+        # puts "package running"
+        if options.has_key? "build_before"
+          build_before = options.build_before
+        else
+          build_before = self.options.build_before
+        end
+        if build_before
+          # http://forum.middlemanapp.com/t/problem-with-the-build-task-in-an-extension
+          bundler = File.exist?('Gemfile')
+          run("#{bundler ? 'bundle exec ' : ''}middleman build") || exit(1)
+        end
+        send("package_run")
+      end
+
+      protected
+
+      def print_usage_and_die(message)
+        # raise Error, "\nERROR: " + message + "\n" + <<EOF\n EOF
+        raise Error, "\nERROR: " + message + "\n"
+      end # of print_usage_and_dir
+
+      def inst
+        ::Middleman::Application.server.inst
+      end
+
+      def opts
+        opts = nil
+
+        begin
+          opts = inst.pkgopts || {}
+        rescue NoMethodError
+          print_usage_and_die "You need to activate the #{:packager.inspect} extension in config.rb."
+        end
+
+        if (!opts[:package_source])
+          print_usage_and_die "The package extension requires you to set a source file or directory."
+        end
+
+        opts
+      end
+
+      def package_run
+        # http://www.ruby-doc.org/core-2.0.0/Time.html#method-i-strftime
+        opts = self.opts
+        time = Time.now()
+        timestamp = time.to_i
+        if opts[:package_mask].match(/{(ts|timestamp):.+}/)
+          format = (opts[:package_mask].match(/{(ts|timestamp):(?<format>.+)}/))[:format]
+          timestamp = time.strftime(format)
+        end
+        file_name = (opts[:package_mask]).gsub(/{(ts|timestamp):?.*}/i, "#{timestamp}")
+        command = (opts[:package_cmd_mask])
+                    .gsub(/\{from\}/, "#{opts[:package_source]}")
+                    .gsub(/\{to\}/, "#{file_name}")
+        run(command)
+        if ($?.success?)
+          # puts "== Your build package is: #{file_name}"
+        else
+          print_usage_and_die "There was a problem creating your build package. Please check your configuration."
+        end
+      end
+
+    end
+
+    Base.map({
+      "pack" => "package",
+      "zip" => "package",
+      "archive" => "package"
+    })
+
+  end
+end

data/lib/middleman-packager/extension.rb

@@ -0,0 +1,48 @@
+# Require core library
+require "middleman-core"
+
+# Extension namespace
+module Middleman
+  module Packager
+
+    class PkgOptions < Struct.new(:package_source, :package_mask, :package_cmd_mask, :auto_package, :build_before); end
+
+    class << self
+
+      def pkgopts
+        @@pkgopts
+      end
+
+      def registered(app, options_hash={}, &block)
+        # puts "registered() running"
+        # Default options for the rsync method.
+        defaults = {
+            # :build_before => false,
+            # :auto_package => false,
+            :package_mask => "build-{ts:%Y-%m-%d}.tgz",
+            :package_cmd_mask => "tar -zcf {to} {from}",
+            :package_source => app.config[:build_dir]
+        }
+        # TODO: Refactor this with merge!
+        opts = defaults.merge(options_hash)
+        # opts = PkgOptions.new(options_hash)
+        # yield opts if block_given?
+
+        @@pkgopts = opts
+
+        app.send :include, Helpers
+      end
+
+      alias :included :registered
+
+    end
+
+    module Helpers
+      def pkgopts
+        ::Middleman::Packager.pkgopts
+      end
+    end
+
+
+  end
+end

data/lib/middleman-packager/pkg-info.rb

@@ -0,0 +1,7 @@
+module Middleman
+  module Packager
+    PACKAGE = "middleman-packager"
+    VERSION = "0.1.0"
+    TAGLINE = "Configurable post-build archiver for Middleman builds."
+  end
+end

data/lib/middleman_extension.rb

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

data/middleman-packager.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "middleman-packager/pkg-info"
+
+Gem::Specification.new do |s|
+  s.name        = Middleman::Packager::PACKAGE
+  s.version     = Middleman::Packager::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Spencer Rhodes"]
+  s.email       = ["spencer at spencer dash rhodes dot com"]
+  s.homepage    = "http://github.com/oobleck/middleman-packager"
+  s.summary     = Middleman::Packager::TAGLINE
+  s.description = s.summary # Middleman::Packager::TAGLINE
+  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", [">= 3.0.0"])
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: middleman-packager
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Spencer Rhodes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Configurable post-build archiver for Middleman builds.
+email:
+- spencer at spencer dash rhodes dot com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- features/support/env.rb
+- lib/middleman-packager.rb
+- lib/middleman-packager/commands.rb
+- lib/middleman-packager/extension.rb
+- lib/middleman-packager/pkg-info.rb
+- lib/middleman_extension.rb
+- middleman-packager.gemspec
+homepage: http://github.com/oobleck/middleman-packager
+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.0.5
+signing_key: 
+specification_version: 4
+summary: Configurable post-build archiver for Middleman builds.
+test_files:
+- features/support/env.rb