punt 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 687b38915674b3400cd3b3d16615c26f4628c546
-  data.tar.gz: 861ddf532ff4c71e1d51cbdf59eb87292f152e71
+  metadata.gz: 85662d179b096c017a378b0b34fea547c5da584f
+  data.tar.gz: 06f3732c176a5c0f7e681c7c00f5598388ec3d80
 SHA512:
-  metadata.gz: 39bae4b4a2fc7ad3ceb4a09d6b1c21f1174ad1f9cde866ef6ab5484581b7127cc24139aa6289293d91ad605043edc5c140f009a1293b9a06fba0d00aa61dcf70
-  data.tar.gz: 95fb837f967c75d4cfe94a0d09b90f0469c0adc0e59ca91b1dd0c859009ae9a15e451f7d4b8bb14ffa370174bb88d60db795c1133a787906e7e392b71daf17ec
+  metadata.gz: 6805ab861ee0fb061e4df7f7f23124b3b3720740066e2c6c31f50a72556b2a0476c54f8789c3fdb521c087d2aed339d7e8963834049d9644070f19f338aeec15
+  data.tar.gz: dead02ac41701114854d8ebec2091a19a09e8ea0ef538e1f5842862009495652ff2c677b88ae082d26d0e062cb747789b0867b1e64529566254fb6bd6d7ef168

data/lib/punt.rb

@@ -1,7 +1,14 @@
 require 'yaml'
 
-require 'punt/asset_helper'
-require 'punt/puntfile'
+require 'punt/mode/mode_scp'
+require 'punt/repo/repo_git'
+
+require 'punt/helper/asset_helper'
+require 'punt/helper/puntfile_helper'
+require 'punt/helper/mode_helper'
+require 'punt/helper/repo_helper'
+
+require 'punt/deploy'
 
 require 'punt/cmd/cmd'
 require 'punt/cmd/cmd_init'

data/lib/punt/cmd/cmd_deploy.rb

@@ -2,141 +2,20 @@ require 'optparse'
 require 'tempfile'
 
 class CmdDeploy < Cmd
-    include Puntfile
 
     tag name: "deploy"
     tag summary: "Deploy to the specified environment"
 
     def run(argv)
         opts = parse_opts(argv)
-
-        if (opts[:dry_run])
-            puts "Dry Run! Nothing will be deployed or modified. All commands that would cause side-effects will be printed below"
-        end
-
         env = argv.shift
-        ref = argv.shift
-
-
-        env = puntfile.first.first unless env
-
-        environment = puntfile[env] if env
-
-
-
-        if (!environment)
-            raise "No environment #{env} was found in the puntfile"
-        end
-
-        mode = environment["mode"]
-
-        if mode != "scp"
-            raise "No mode available for the given mode '#{mode}'"
-        end
-
-
-        # Some Git Stuff
-        repo = environment["repo"]
-        if (repo != "git")
-            raise "No repo available for the given repository type #{repo}"
-        end
-
-        original_head = `git rev-parse --short HEAD`.strip
-        original_branch = `git rev-parse --abbrev-ref HEAD`.strip
-
-        ref = original_head unless ref
-        ref = `git rev-parse --short --verify #{ref}`.strip
-        ref_full = `git rev-parse --verify #{ref}`.strip
-
-        # TODO: Check to see if there are any changes! Yell and complain if there are any changes
-
-
-
-        puts "Deploying #{ref} to #{env}"
-        puts ""
-
-        # Checkout the code
-        if ref != original_head
-            if opts[:dry_run]
-                puts "git checkout #{ref}"
-            else
-                `git checkout #{ref}`
-            end
-        end
-
-        # Upload Version File
-        scp_versionfile(ref_full, "start", environment, dry_run: opts[:dry_run] || false)
-        if environment["files"]
-            environment["files"].each do |key, value|
-                scp_upload(key, value, environment, dry_run: opts[:dry_run] || false)
-            end
-        end
-        scp_versionfile(ref_full, "success", environment, dry_run: opts[:dry_run] || false)
+        repo_ref = argv.shift
 
-        # Revert to our previous checkout
-        if ref != original_head
-            if opts[:dry_run]
-                puts "git checkout #{original_branch}"
-            else
-                `git checkout #{original_branch}`
-            end
-        end
+        Deploy.new.deploy(env: env, repo_ref: repo_ref, dry_run: opts[:dry_run], force_local: opts[:force_local])
     end
 
     private
 
-    def scp_versionfile(ref, version_name, environment, dry_run: false)
-
-        if (!dry_run)
-            versionfile = Tempfile.new('foo')
-            versionfile.write("#{ref}")
-            versionfile.close()
-
-            scp_upload(versionfile.path, ".punt_#{version_name}", environment, dry_run: dry_run)
-
-            versionfile.unlink
-        end
-    end
-
-    def scp_upload(local_file, remote, environment, dry_run: false)
-        scp_args = ["scp"]
-        scp = scp_opts(environment, scp_args)
-
-        if (File.directory?(local_file))
-            scp << "-r"
-        end
-
-        scp << local_file
-        scp << scp_remote_file(remote, environment)
-
-        scp_command = scp.join(" ")
-
-        puts scp_command
-        `#{scp_command}` unless dry_run
-    end
-
-    def scp_opts(environment, scp_args)
-        if (environment["ssh_key"])
-            scp_args << "-i"
-            scp_args << environment["ssh_key"]
-        end
-    end
-
-    def scp_remote_file(remote, environment)
-        if !remote.start_with?("/") && !remote.start_with?("~")
-            remote = File.join(environment["remote_base"], remote)
-        end
-
-        return "#{scp_host(environment)}#{remote}"
-    end
-
-    def scp_host(environment)
-        arg = "#{environment["host"]}:"
-        arg = "#{environment["username"]}@#{arg}" if environment["username"]
-
-        return arg
-    end
-
     def parse_opts(argv)
         options = {}
 
@@ -146,6 +25,10 @@ class CmdDeploy < Cmd
             opts.on("-d", "--dry-run", "Show the commands that punt would execute, but don't actually do anything.") do |d|
                 options[:dry_run] = d
             end
+
+            opts.on("-l", "--force-local", "Try and push commits even if there are local changes") do |f|
+                options[:force_local] = f
+            end
         end
 
         opt_parser.parse!(argv)

data/lib/punt/cmd/cmd_remote.rb

@@ -1,7 +1,7 @@
 require 'tempfile'
 
 class CmdRemote < Cmd
-    include Puntfile
+    include PuntfileHelper
 
     tag name: "remote"
     tag summary: "Return the SHA1 of the version deployed to the remote"

data/lib/punt/deploy.rb

@@ -0,0 +1,66 @@
+class Deploy
+    include PuntfileHelper
+    include ModeHelper
+    include RepoHelper
+
+    def deploy(env: nil, repo_ref: nil, dry_run: false, force_local: false)
+
+        dry_run_banner if dry_run
+
+        environment = punt_environment(env: env)
+
+        mode = get_mode(environment)
+        repo = get_repo(environment)
+
+        repo_state = repo.save_state()
+        mode_opts = mode.mode_opts(environment)
+
+        starting_revision = repo.current_revision_name(short: true)
+
+        repo_ref = starting_revision unless repo_ref
+        desired_revision = repo.canonical_revision_name(repo_ref, short: true)
+        desired_revision_long = repo.canonical_revision_name(repo_ref, short: false)
+
+        if (repo.any_uncommited_changes?)
+            if force_local
+                puts "There are uncommitted changes! We're going to try and deploy anyway because the --force-local flag was present"
+            else
+                raise "There are uncommitted changes! Run `git status` to view the uncommitted files. Commit all of your changes, so that the deploy comes from a specific git revision. To force a deploy using these local changes use the parameter --force-local and don't specify a specific commit ref"
+            end
+        end
+
+        puts "Deploying #{desired_revision} to #{env}"
+        puts ""
+
+        # Checkout the code
+        if desired_revision != starting_revision
+            repo.checkout_revision(desired_revision, dry_run: dry_run)
+        end
+
+        # Upload Starting File
+        mode.upload_versionfile(desired_revision_long, "start", mode_opts: mode_opts ) unless dry_run
+
+        # Upload Files
+        if environment["files"]
+            environment["files"].each do |key, value|
+                mode.upload(key, value, mode_opts: mode_opts, dry_run: dry_run, verbose: true)
+            end
+        end
+
+        # Upload Success File
+        mode.upload_versionfile(desired_revision_long, "success", mode_opts: mode_opts ) unless dry_run
+
+        # Revert to our previous checkout
+        if desired_revision != starting_revision
+            repo.restore_state(repo_state, dry_run: dry_run)
+        end
+    end
+
+    private
+
+    def dry_run_banner
+        puts "Dry Run!"
+        puts "\tNothing will be deployed or modified. All commands that would cause side-effects will be printed below"
+        puts ""
+    end
+end

data/lib/punt/helper/mode_helper.rb

@@ -0,0 +1,9 @@
+module ModeHelper
+    def get_mode(environment)
+        env_mode = environment["mode"]
+        mode = ModeScp.new if env_mode == "scp"
+
+        raise "No mode available for the given mode '#{env_mode}'" unless mode
+        return mode
+    end
+end

data/lib/punt/helper/puntfile_helper.rb

@@ -0,0 +1,42 @@
+module PuntfileHelper
+
+    SUPPORTED_PUNTFILES = ["puntfile.yml", "puntfile.yaml", "Puntfile.yml", "Puntfile.yaml", "puntfile", "Puntfile"]
+
+    # Returns the puntfile hash for the current program. This will scan the various supported Puntfile
+    # file formats and attempt to load the first one it finds.
+    def puntfile
+        load_puntfile
+
+        return @@puntfile
+    end
+
+    # Pulls the specific environment hash out of the Puntfile. If no environment is
+    # given, this automatically returns the default environment.
+    def punt_environment(env: nil)
+        env = puntfile.first.first unless env
+        environment = puntfile[env] if env
+
+        if (!environment)
+            raise "No environment #{env} was found in the puntfile"
+        end
+
+        return environment
+    end
+
+    private
+
+    def load_puntfile
+        return if defined?(@@puntfile)
+
+        SUPPORTED_PUNTFILES.each do |puntfile|
+            if File.exists?(puntfile)
+                @@puntfile = YAML.load_file(puntfile)
+                return
+            end
+        end
+
+        raise "We couldn't find puntfile.yml in the current directory"
+    end
+
+
+end

data/lib/punt/helper/repo_helper.rb

@@ -0,0 +1,9 @@
+module RepoHelper
+    def get_repo(environment)
+        env_repo = environment["repo"]
+        repo = RepoGit.new if env_repo == "git"
+
+        raise "No repo available for the given repo '#{env_repo}'" unless repo
+        return repo
+    end
+end

data/lib/punt/mode/mode_scp.rb

@@ -0,0 +1,59 @@
+class ModeScp
+
+    def mode_opts(environment)
+        return environment["scp"]
+    end
+
+    def upload(local_path, remote_path, mode_opts: nil, dry_run: false, verbose: true)
+        scp_args = ["scp"]
+        scp_common_options(mode_opts, scp_args)
+
+        if (File.directory?(local_path))
+            scp_args << "-r"
+        end
+
+        scp_args << local_path
+        scp_args << scp_remote_file(remote_path, mode_opts)
+
+        scp_command = scp_args.join(" ")
+
+        puts scp_command if verbose
+        `#{scp_command}` unless dry_run
+    end
+
+    def upload_versionfile(version, deploystage, mode_opts: nil)
+        filename = ".punt_#{deploystage}"
+
+        versionfile = Tempfile.new(filename)
+        versionfile.write("#{version}")
+        versionfile.close()
+
+        upload(versionfile.path, filename, mode_opts: mode_opts)
+
+        versionfile.unlink
+    end
+
+    private
+
+    def scp_common_options(scp_opts, scp_args)
+        if (scp_opts["ssh_key"])
+            scp_args << "-i"
+            scp_args << scp_opts["ssh_key"]
+        end
+    end
+
+    def scp_remote_file(remote_path, scp_opts)
+        if !remote_path.start_with?("/") && !remote_path.start_with?("~")
+            remote_path = File.join(scp_opts["remote_base"], remote_path)
+        end
+
+        return "#{scp_host(scp_opts)}#{remote_path}"
+    end
+
+    def scp_host(scp_opts)
+        arg = "#{scp_opts["host"]}:"
+        arg = "#{scp_opts["user"]}@#{arg}" if scp_opts["user"]
+
+        return arg
+    end
+end

data/lib/punt/repo/repo_git.rb

@@ -0,0 +1,37 @@
+class RepoGit
+
+    def any_uncommited_changes?()
+        return true if `git diff --numstat | wc -l`.strip != "0"
+        return true if `git diff --cached --numstat | wc -l`.strip != "0"
+        return true if `git ls-files --others --exclude-standard | wc -l`.strip != "0"
+        return false
+    end
+
+    def current_revision_name(short: false)
+        canonical_revision_name("HEAD", short: short)
+    end
+
+    def canonical_revision_name(revision_name, short: false)
+        return `git rev-parse --short --verify #{revision_name}`.strip if short
+        return `git rev-parse --verify #{revision_name}`.strip
+    end
+
+    def checkout_revision(revision_name, dry_run: false)
+        puts "git checkout #{revision_name}" if dry_run
+        `git checkout #{revision_name}` unless dry_run
+    end
+
+    def save_state()
+        current_branch = `git rev-parse --abbrev-ref HEAD`
+
+        return current_revision_name if current_branch == "HEAD"
+        return current_branch
+    end
+
+    def restore_state(state, dry_run: false)
+        puts "git checkout #{state}" if dry_run
+        `git checkout #{state}` unless dry_run
+    end
+
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: punt
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Noah Callaway
@@ -21,12 +21,17 @@ files:
 - assets/init/puntfile.yml
 - bin/punt
 - lib/punt.rb
-- lib/punt/asset_helper.rb
 - lib/punt/cmd/cmd.rb
 - lib/punt/cmd/cmd_deploy.rb
 - lib/punt/cmd/cmd_init.rb
 - lib/punt/cmd/cmd_remote.rb
-- lib/punt/puntfile.rb
+- lib/punt/deploy.rb
+- lib/punt/helper/asset_helper.rb
+- lib/punt/helper/mode_helper.rb
+- lib/punt/helper/puntfile_helper.rb
+- lib/punt/helper/repo_helper.rb
+- lib/punt/mode/mode_scp.rb
+- lib/punt/repo/repo_git.rb
 homepage: http://rubygems.org/gems/punt
 licenses:
 - MIT

data/lib/punt/puntfile.rb

@@ -1,27 +0,0 @@
-module Puntfile
-
-    SUPPORTED_PUNTFILES = ["puntfile.yml", "puntfile.yaml", "Puntfile.yml", "Puntfile.yaml", "puntfile", "Puntfile"]
-
-    def puntfile
-        load_puntfile
-
-        return @@puntfile
-    end
-
-    private
-
-    def load_puntfile
-        return if defined?(@@puntfile)
-
-        SUPPORTED_PUNTFILES.each do |puntfile|
-            if File.exists?(puntfile)
-                @@puntfile = YAML.load_file(puntfile)
-                return
-            end
-        end
-
-        raise "We couldn't find puntfile.yml in the current directory"
-    end
-
-
-end