middleman-deploy 0.0.5 → 0.0.6

data/.gitignore

@@ -1 +1,2 @@
 Gemfile.lock
+coverage

data/Gemfile

@@ -14,4 +14,5 @@ group :test do
   gem "fivemat"
   gem "aruba",    "~> 0.4.11"
   gem "rspec",    "~> 2.7"
+  gem "simplecov"
 end

data/README.md

@@ -1,4 +1,4 @@
-Middleman Delpoy -- Deploy a [middleman](http://middlemanapp.com/) built site over rsync or to github pages.
+Middleman Delpoy -- Deploy a [middleman](http://middlemanapp.com/) built site over rsync or via git (e.g. gh-pages on github).
 
 [![Build Status](https://secure.travis-ci.org/tvaughan/middleman-deploy.png)](http://travis-ci.org/tvaughan/middleman-deploy)
 
@@ -6,8 +6,6 @@ Middleman Delpoy -- Deploy a [middleman](http://middlemanapp.com/) built site ov
 
 ## QUICK START
 
-If deploying through `rsync`, be sure it is installed.
-
 ### Step 1
 
     gem install middleman-deploy
@@ -29,6 +27,8 @@ Then run:
 
 ### Step 4a - Rsync setup
 
+First be sure that `rsync` is installed.
+
 #### These settings are required.
 
 Edit `config.rb`, and add:
@@ -56,7 +56,22 @@ To remove orphaned files or directories on the remote host, add:
 
 Default is `false`.
 
-### Step 4b - GitHub Pages setup
+### Step 4b - Git setup
+
+First be sure that you have already placed your project under revision
+control using git.
+
+For example, for the default values of remote="master" and
+branch="gh-pages", the output of `git branch -a` should look like:
+
+      gh-pages
+    * master
+      remotes/origin/HEAD -> origin/master
+      remotes/origin/gh-pages
+      remotes/origin/master
+
+This shows that "gh-pages" exists in the remote and local repos. There
+needs to be at least one commit in "gh-pages" with which to start.
 
 Edit `config.rb`, and add:
 
@@ -64,13 +79,26 @@ Edit `config.rb`, and add:
       deploy.method = :git
     end
 
-The git deploy method assumes your project is in a repository with
-github set up as `origin` and a working `gh-pages` branch already in place.
+#### These settings are optional.
+
+To use a particular remote, add:
+
+      deploy.remote = "some-other-remote-name"
+
+Default is `origin`. Run `git remote -v` to see a list of possible
+remotes.
+
+To use a particular branch, add:
+
+      deploy.branch = "some-other-branch-name"
+
+Default is `gh-pages`. Run `git branch -a` to see a list of possible
+branches.
 
 ### Step 5
 
     middleman build [--clean]
-    middleman deploy
+    middleman deploy [--clean]
 
 ### NOTES
 

data/features/support/env.rb

@@ -1,4 +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-deploy')
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-deploy')

data/lib/middleman-deploy/commands.rb

@@ -1,8 +1,12 @@
 require "middleman-core/cli"
 
 require "middleman-deploy/extension"
+require "middleman-deploy/pkg-info"
 
-require 'git'
+require "git"
+
+PACKAGE = "#{Middleman::Deploy::PACKAGE}"
+VERSION = "#{Middleman::Deploy::VERSION}"
 
 module Middleman
   module Cli
@@ -20,7 +24,7 @@ module Middleman
         true
       end
 
-      desc "deploy", "Copy build directory to a remote host"
+      desc "deploy", "Deploy build directory to a remote host via rsync or git"
       method_option "clean",
       :type => :boolean,
       :aliases => "-c",
@@ -37,20 +41,26 @@ module Middleman
 You should follow one of the two examples below to setup the deploy
 extension in config.rb.
 
-# To copy the build directory to a remote host:
+# To deploy the build directory to a remote host via rsync:
 activate :deploy do |deploy|
   deploy.method = :rsync
   # host, user, and path *must* be set
   deploy.user = "tvaughan"
   deploy.host = "www.example.com"
   deploy.path = "/srv/www/site"
-  # clean is optional (default is false).
+  # clean is optional (default is false)
   deploy.clean = true
 end
 
-# To push to a remote gh-pages branch on GitHub:
+# To deploy to a remote branch via git (e.g. gh-pages on github):
 activate :deploy do |deploy|
   deploy.method = :git
+  # remote is optional (default is "origin")
+  # run `git remote -v` to see a list of possible remotes
+  deploy.remote = "some-other-remote-name"
+  # branch is optional (default is "gh-pages")
+  # run `git branch -a` to see a list of possible branches
+  deploy.branch = "some-other-branch-name"
 end
 EOF
       end
@@ -61,16 +71,16 @@ EOF
         begin
           options = ::Middleman::Application.server.inst.options
         rescue
-          print_usage_and_die "You need to activate the deploy extension in config.rb"
+          print_usage_and_die "You need to activate the deploy extension in config.rb."
         end
 
         if (!options.method)
-          print_usage_and_die "The deploy extension requires you to set a method"
+          print_usage_and_die "The deploy extension requires you to set a method."
         end
 
         if (options.method == :rsync)
           if (!options.host || !options.user || !options.path)
-            print_usage_and_die "The rsync deploy method requires host, user, and path to be set"
+            print_usage_and_die "The rsync deploy method requires host, user, and path to be set."
           end
         end
 
@@ -83,6 +93,8 @@ EOF
         user = self.deploy_options.user
         path = self.deploy_options.path
 
+        puts "## Deploying via rsync to #{user}@#{host}:#{path} port=#{port}"
+
         command = "rsync -avze '" + "ssh -p #{port}" + "' build/ #{user}@#{host}:#{path}"
 
         if options.has_key? "clean"
@@ -99,27 +111,33 @@ EOF
       end
 
       def deploy_git
-        puts "## Deploying to GitHub Pages"
+        remote = self.deploy_options.remote
+        branch = self.deploy_options.branch
+
+        puts "## Deploying via git to remote=\"#{remote}\" and branch=\"#{branch}\""
+
+        # ensure that the remote branch exists in ENV["MM_ROOT"]
+        orig = Git.open(ENV["MM_ROOT"])
+        # TODO: orig.branch(branch, "#{remote}/#{branch}")
+
         Dir.mktmpdir do |tmp|
-          # clone ./ with branch gh-pages to tmp
-          repo = Git.clone(ENV['MM_ROOT'], tmp)
-          repo.checkout('origin/gh-pages', :new_branch => 'gh-pages')
+          # clone ENV["MM_ROOT"] to tmp (ENV["MM_ROOT"] is now "origin")
+          repo = Git.clone(ENV["MM_ROOT"], tmp)
+          repo.checkout("origin/#{branch}", :new_branch => branch)
 
           # copy ./build/* to tmp
-          FileUtils.cp_r(Dir.glob(File.join(ENV['MM_ROOT'], 'build', '*')), tmp)
+          FileUtils.cp_r(Dir.glob(File.join(ENV["MM_ROOT"], "build", "*")), tmp)
 
           # git add and commit in tmp
           repo.add
-          repo.commit("Automated commit at #{Time.now.utc}")
-
-          # push from tmp to self
-          repo.push('origin', 'gh-pages')
+          repo.commit("Automated commit at #{Time.now.utc} by #{PACKAGE} #{VERSION}")
 
-          # push to github
-          github_url = Git.open(ENV['MM_ROOT']).remote.url
-          repo.add_remote('github', github_url)
-          repo.push('github', 'gh-pages')
+          # push back into ENV["MM_ROOT"]
+          repo.push("origin", branch)
         end
+
+        orig.push(remote, branch)
+        orig.remote(remote).fetch
       end
 
     end

data/lib/middleman-deploy/extension.rb

@@ -5,7 +5,7 @@ require "middleman-core"
 module Middleman
   module Deploy
 
-    class Options < Struct.new(:whatisthis, :method, :host, :port, :user, :path, :clean); end
+    class Options < Struct.new(:whatisthis, :method, :host, :port, :user, :path, :clean, :remote, :branch); end
 
     class << self
 
@@ -19,6 +19,8 @@ module Middleman
 
         options.port ||= 22
         options.clean ||= false
+        options.remote ||= "origin"
+        options.branch ||= "gh-pages"
 
         @@options = options
 

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

@@ -1,6 +1,6 @@
 module Middleman
   module Deploy
     PACKAGE = "middleman-deploy"
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

data/middleman-deploy.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Tom Vaughan","Ben Cates"]
   s.email       = ["thomas.david.vaughan@gmail.com"]
   s.homepage    = "http://tvaughan.github.com/middleman-deploy/"
-  s.summary     = %q{Deploy a middleman built site over rsync or to github pages.}
-  s.description = %q{Deploy a middleman built site over rsync or to github pages.}
+  s.summary     = %q{Deploy a middleman built site over rsync or via git (e.g. gh-pages on github).}
+  s.description = %q{Deploy a middleman built site over rsync or via git (e.g. gh-pages on github).}
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-deploy
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-04 00:00:00.000000000 Z
+date: 2012-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
-  requirement: &9045080 !ruby/object:Gem::Requirement
+  requirement: &21821760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *9045080
+  version_requirements: *21821760
 - !ruby/object:Gem::Dependency
   name: git
-  requirement: &9057240 !ruby/object:Gem::Requirement
+  requirement: &21821260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,8 +33,9 @@ dependencies:
         version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *9057240
-description: Deploy a middleman built site over rsync or to github pages.
+  version_requirements: *21821260
+description: Deploy a middleman built site over rsync or via git (e.g. gh-pages on
+  github).
 email:
 - thomas.david.vaughan@gmail.com
 executables: []
@@ -76,6 +77,6 @@ rubyforge_project:
 rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: Deploy a middleman built site over rsync or to github pages.
+summary: Deploy a middleman built site over rsync or via git (e.g. gh-pages on github).
 test_files: []
 has_rdoc: