paratrooper 3.0.0.beta1 → 3.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84bd6c187cb422b1e72b4dc30aa60012f46600b3
-  data.tar.gz: 3d14dd42f2b029cf97418d1508a84b250e6750c4
+  metadata.gz: a1fb94737f8ced52c1df089c4c9cb3c835c13955
+  data.tar.gz: b5e02afaefe802bbf6b55a4142f6bd4f6a5bbcf7
 SHA512:
-  metadata.gz: c29d2b06b09efe69089e18e791509d30affa865e0bc9a22dc1a8ed7db3fba3bd30142c54238fa31761f433b8039e793e99d0a1bed8566e65c8ff800e590250d5
-  data.tar.gz: e05a117d41e9811b65621b54ca91501573b7a4503a645ec7fa618bfdeb2c37798c353ca4245b47fab73c1c2737a66bf5d3ada33238c3277d55f760bdc480bcac
+  metadata.gz: 9123dc496f3675b12eaa400be60bbfe9ada36bc591a842055e904fd2f84119a0296125e6e582e7e5a59e15b85c6e8218dba9d0cddeec5736231b2e9e8de02ca6
+  data.tar.gz: 7c68f45526ab6002f81a5a2378ba47a6fb5a80105e408b4215f97d316b2fdd80570f781d9fc6e68e85bcef2e213f00a69390fd8911d1ac073df737bcdbee924b

data/README.md

@@ -11,13 +11,13 @@ Simplify your [Heroku][] deploy with quick and concise deployment rake tasks.
 Add this line to your application's Gemfile:
 
 ```shell
-  gem 'paratrooper'
+gem 'paratrooper'
 ```
 
 and then execute
 
 ```shell
-  bundle
+bundle
 ```
 
 or
@@ -25,7 +25,7 @@ or
 install it yourself with
 
 ```shell
-  gem install paratrooper
+gem install paratrooper
 ```
 
 ## Usage
@@ -33,19 +33,13 @@ install it yourself with
 Instantiate Paratrooper with the name of your heroku application.
 
 ```ruby
-Paratrooper::Deploy.new('amazing-app')
+Paratrooper.deploy('amazing-app')
 ```
 
 You can also provide a tag:
 
 ```ruby
-Paratrooper::Deploy.new('amazing-app', tag: 'staging')
-```
-
-or alternatively:
-
-```ruby
-Paratrooper::Deploy.new('amazing-app') do |deploy|
+Paratrooper.deploy('amazing-app') do |deploy|
   deploy.tag = 'staging'
 end
 ```
@@ -57,20 +51,22 @@ You can authenticate your Heroku account in a few ways:
 * Provide an API Key
 
 ```ruby
-Paratrooper::Deploy.new('app', api_key: 'API_KEY')
+Paratrooper.deploy('app') do |deploy|
+  deploy.api_key = 'API_KEY'
+end
 ```
 
 * Set an environment variable
 
 ```ruby
 ENV['HEROKU_API_KEY'] = 'API_KEY'
-Paratrooper::Deploy.new('app')
+Paratrooper.deploy('app')
 ```
 
 * Local Netrc file
 
 ```ruby
-Paratrooper::Deploy.new('app')
+Paratrooper.deploy('app')
 ```
 
 This method works via a local Netrc file handled via the [Heroku Toolbelt][] and is the default and preferred method for providing authentication keys.
@@ -80,13 +76,7 @@ This method works via a local Netrc file handled via the [Heroku Toolbelt][] and
 If you use multiple SSH keys for managing multiple accounts, for example in your `.ssh/config`, you can set the `deployment_host` option:
 
 ```ruby
-Paratrooper::Deploy.new('app', deployment_host: 'HOST')
-```
-
-or alternatively:
-
-```ruby
-Paratrooper::Deploy.new('amazing-app') do |deploy|
+Paratrooper.deploy('amazing-app') do |deploy|
   deploy.deployment_host = 'HOST'
 end
 ```
@@ -94,70 +84,37 @@ end
 This also works if you're using the [heroku-accounts](https://github.com/ddollar/heroku-accounts) plugin:
 
 ```ruby
-Paratrooper::Deploy.new('app', deployment_host: 'heroku.ACCOUNT_NAME')
+Paratrooper.deploy('app') do |deploy|
+  deploy.deployment_host: 'heroku.ACCOUNT_NAME'
+end
 ```
 
 ## Tag Management
 
-By providing tag options for Paratrooper, your code can be tagged and deployed from various reference points.
-
-### Staging example
-```ruby
-  Paratrooper::Deploy.new("staging-app", tag: 'staging')
-```
-This will create/update a `staging` git tag at `HEAD`.
-
-### Production example
-```ruby
-  Paratrooper::Deploy.new("amazing-production-app",
-    tag: 'production',
-    match_tag: 'staging'
-  )
-```
-
-or alternatively:
-
-```ruby
-Paratrooper::Deploy.new('amazing-production-app') do |deploy|
-  deploy.tag       = 'production'
-  deploy.match_tag = 'staging'
-end
-```
-This will create/update a `production` git tag at `staging` and deploy the `production` tag.
+Please note: Tag management has been removed from Paratrooper 3. It added unneccesary complexity around an individual's deployment process.
 
 ## Sensible Default Deployment
 
-You can use the object's methods any way you'd like, but we've provided a sensible default at `Paratrooper#deploy`.
+You can use the object's methods any way you'd like, but we've provided a sensible default at `Paratrooper.deploy`.
 
 This will perform the following tasks:
 
-* Create or update a git tag (if provided)
 * Push changes to Heroku
 * Run database migrations if any have been added to db/migrate
-* Restart the application
-* Warm application instance
+* Restart the application if migrations needed to be run
 
 ### Example Usage
 
 ```ruby
-require 'paratrooper'
-
 namespace :deploy do
   desc 'Deploy app in staging environment'
   task :staging do
-    deployment = Paratrooper::Deploy.new("amazing-staging-app", tag: 'staging')
-
-    deployment.deploy
+    Paratrooper.deploy("amazing-staging-app")
   end
 
   desc 'Deploy app in production environment'
   task :production do
-    deployment = Paratrooper::Deploy.new("amazing-production-app") do |deploy|
-      deploy.tag              = 'production'
-      deploy.match_tag        = 'staging'
-    end
-
-    deployment.deploy
+    Paratrooper.deploy("amazing-production-app")
   end
 end
 ```
@@ -174,7 +131,6 @@ There are 'before' and 'after' hooks for each of the following:
 
 * setup
 * activate_maintenance_mode
-* update_repo_tag
 * push_repo
 * run_migrations
 * app_restart
@@ -193,20 +149,17 @@ to disable your application monitoring.
 namespace :deploy do
   desc 'Deploy app in production environment'
   task :production do
-    deployment = Paratrooper::Deploy.new("amazing-production-app") do |deploy|
-      deploy.tag = 'production'
-      deploy.match_tag = 'staging'
+    Paratrooper.deploy("amazing-production-app") do |deploy|
       deploy.add_callback(:before_setup) do |output|
         output.display("Totally going to turn off newrelic")
         system %Q[curl https://rpm.newrelic.com/accounts/ACCOUNT_ID/applications/APPLICATION_ID/ping_targets/disable -X POST -H "X-Api-Key: API_KEY"]
       end
+
       deploy.add_callback(:after_teardown) do |output|
         system %Q[curl https://rpm.newrelic.com/accounts/ACCOUNT_ID/applications/APPLICATION_ID/ping_targets/enable -X POST -H "X-Api-Key: API_KEY"]
         output.display("Aaaannnd we're back")
       end
     end
-
-    deployment.deploy
   end
 end
 ```
@@ -219,15 +172,13 @@ Or maybe you just want to run a rake task on your application. Since this task m
 namespace :deploy do
   desc 'Deploy app in production environment'
   task :production do
-    deployment = Paratrooper::Deploy.new("amazing-production-app") do |deploy|
+    Paratrooper.deploy("amazing-production-app") do |deploy|
       deploy.maintenance = true
       deploy.add_callback(:after_teardown) do |output|
         output.display("Running some task that needs to run")
         deploy.add_remote_task("rake some:task:to:run")
       end
     end
-
-    deployment.deploy
   end
 end
 ```

data/lib/paratrooper/configuration.rb

@@ -10,12 +10,13 @@ module Paratrooper
   class Configuration
     include Callbacks
 
-    attr_accessor :branch_name, :app_name, :api_key
+    attr_accessor :branch_name, :tag_name, :match_tag_name, :app_name, :api_key
     attr_writer :protocol, :heroku, :migration_check,
       :system_caller, :deployment_host, :http_client, :screen_notifier,
       :source_control
 
     alias :branch= :branch_name=
+    alias :tag= :tag_name=
 
     def attributes=(attrs)
       attrs.each do |method, value|

data/lib/paratrooper/deploy.rb

@@ -3,11 +3,9 @@ require 'paratrooper/configuration'
 require 'paratrooper/error'
 
 module Paratrooper
-
-  # Public: Entry point into the library.
-  #
   class Deploy
     extend Forwardable
+
     delegate [:system_caller, :migration_check, :notifiers,
       :deloyment_host, :heroku, :source_control, :screen_notifier
     ] => :config
@@ -76,6 +74,15 @@ module Paratrooper
       end
     end
 
+    def update_repo_tag
+      if source_control.taggable?
+        callback(:update_repo_tag) do
+          notify(:update_repo_tag)
+          source_control.update_repo_tag
+        end
+      end
+    end
+
     # Public: Activates Heroku maintenance mode.
     #
     def activate_maintenance_mode
@@ -140,6 +147,7 @@ module Paratrooper
     # Alias: #deploy
     def default_deploy
       setup
+      update_repo_tag
       push_repo
       maintenance_mode do
         run_migrations
@@ -179,7 +187,7 @@ module Paratrooper
     def default_payload
       {
         app_name: config.app_name,
-        deployment_remote: source_control.remote,
+        deployment_remote: deployment_remote,
         force_push: config.force_push,
         reference_point: source_control.reference_point,
       }

data/lib/paratrooper/source_control.rb

@@ -38,9 +38,42 @@ module Paratrooper
       "-f " if config.force_push
     end
 
-    # Internal: Calls commands meant to go to system
+    def tag_name
+      config.tag_name
+    end
+
+    def taggable?
+      !untaggable?
+    end
+
+    def untaggable?
+      tag_name.nil? || tag_name.empty?
+    end
+
+    def match_tag_name
+      config.match_tag_name
+    end
+
+    def scm_tag_reference
+      "refs/tags/#{tag_name}" if tag_name
+    end
+
+    def scm_match_reference
+      if match_tag_name
+        "refs/tags/#{match_tag_name}"
+      else
+        "HEAD"
+      end
+    end
+
+    def update_repo_tag
+      system_call("git tag #{tag_name} #{match_tag_name} -f")
+      system_call("git push -f origin #{scm_tag_reference}")
+    end
+
+    # Internal: Calls commands meant to go to system.
     #
-    # cmd - String version of system command
+    # cmd - String version of system command.
     #
     def system_call(cmd, exit_code = false)
       system_caller.execute(cmd, exit_code)

data/lib/paratrooper/version.rb

@@ -1,3 +1,3 @@
 module Paratrooper
-  VERSION = "3.0.0.beta1".freeze
+  VERSION = "3.0.0.beta2".freeze
 end

data/spec/paratrooper/source_control_spec.rb

@@ -125,6 +125,27 @@ describe Paratrooper::SourceControl do
     end
   end
 
+  describe "update_repo_tag" do
+    let(:system_caller) { double(:system_caller) }
+
+    before do
+      allow(system_caller).to receive(:execute)
+    end
+
+    it "issues command to create/update & push tag based on tag name" do
+      config = instance_double(Paratrooper::Configuration,
+        system_caller: system_caller,
+        tag_name: 'TAG',
+        match_tag_name: 'MATCH_TAG'
+      )
+      source_control = described_class.new(config)
+      source_control.update_repo_tag
+
+      expected_cmd = ["git tag TAG MATCH_TAG -f", false]
+      expect(system_caller).to have_received(:execute).with(*expected_cmd)
+    end
+  end
+
   describe "push_to_deploy" do
     let(:system_caller) { double(:system_caller) }
 
@@ -230,4 +251,40 @@ describe Paratrooper::SourceControl do
       end
     end
   end
+
+  describe "#scm_tag_reference" do
+    context "when tag_name is available" do
+      it "returns fully qualified tag name" do
+        config = instance_double(Paratrooper::Configuration, tag_name: "TAG")
+        source_control = described_class.new(config)
+        expect(source_control.scm_tag_reference).to eq("refs/tags/TAG")
+      end
+    end
+
+    context "when tag_name is unavailable" do
+      it "returns nil" do
+        config = instance_double(Paratrooper::Configuration, tag_name: nil)
+        source_control = described_class.new(config)
+        expect(source_control.scm_tag_reference).to be_nil
+      end
+    end
+  end
+
+  describe "#scm_match_reference" do
+    context "when match_tag_name is available" do
+      it "returns fully qualified tag name" do
+        config = instance_double(Paratrooper::Configuration, match_tag_name: "MATCH_TAG")
+        source_control = described_class.new(config)
+        expect(source_control.scm_match_reference).to eq("refs/tags/MATCH_TAG")
+      end
+    end
+
+    context "when match_tag_name is unavailable" do
+      it "returns HEAD" do
+        config = instance_double(Paratrooper::Configuration, match_tag_name: nil)
+        source_control = described_class.new(config)
+        expect(source_control.scm_match_reference).to eq("HEAD")
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paratrooper
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta1
+  version: 3.0.0.beta2
 platform: ruby
 authors:
 - Matt Polito
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-29 00:00:00.000000000 Z
+date: 2015-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -171,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Library to create task for deployment to Heroku