hanzo 0.6.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a3fdfe4074e2f695d32dea1ced3d9543437063c2
-  data.tar.gz: 364e464b762238cc38edb434325ec5f2a5becb6e
+SHA256:
+  metadata.gz: 290405d45a84ebf4e33e50cb8cdbcbe24c11841073a21739afd05c368f36b1d3
+  data.tar.gz: ad08e638c4b8cf91620982fb662645bc096c8176a58b2270fc015b349a2c4704
 SHA512:
-  metadata.gz: 4eb468e8e684e30e2cb56e589f1577aea1c1981a904d57a77193238585b5013a70452e40bcab2ba321f50aa795e8691831696b3e74c2cf6a54a88adaf67b5c06
-  data.tar.gz: 94f54a5a792360c4e580a879e0fb0075958b1cda8d25113beda95188438c59753a73456c37dd477cd09ebf3f74cd948e5b789f7b4dd4518f90b9eca9e966cdb2
+  metadata.gz: e7388b062c22e59b25eb6fde535943aa71817c22de2e85dac8b0fb579b85d72183b32856262818e896e61a5047d22912a70b146a295e45a59bc90d0e53c8048b
+  data.tar.gz: 0d30be502353ae1c5de32f547d5ddcf1e8c3fab1fb6bac6bf8de3b359750a21a388b36039e3e3b738287e982bb1c1a8e70c3ca7afe6bae41af914ce2be794e5b

data/.rubocop.yml

@@ -4,6 +4,9 @@ Documentation:
 Encoding:
   Enabled: false
 
+BlockLength:
+  Max: 100
+
 LineLength:
   Max: 200
 
@@ -17,7 +20,7 @@ IfUnlessModifier:
   Enabled: false
 
 CaseIndentation:
-  IndentWhenRelativeTo: case
+  EnforcedStyle: case
   IndentOneStep: true
 
 MethodLength:
@@ -56,3 +59,7 @@ DoubleNegation:
 
 TrivialAccessors:
   ExactNameMatch: true
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%w':    '()'

data/README.md

@@ -3,10 +3,9 @@
     <img src="http://i.imgur.com/RZbJy1u.png" alt="Hanzo" />
   </a>
   <br />
-  Hanzo is a sharp tool to handle deployments of multiple environments of the same application on Heroku.
+  Hanzo is a sharp tool to handle deploying an application on Heroku on multiple environments.
   <br /><br />
   <a href="https://rubygems.org/gems/hanzo"><img src="http://img.shields.io/gem/v/hanzo.svg" /></a>
-  <a href="https://codeclimate.com/github/mirego/hanzo"><img src="http://img.shields.io/codeclimate/github/mirego/hanzo.svg" /></a>
   <a href='https://gemnasium.com/mirego/hanzo'><img src="http://img.shields.io/gemnasium/mirego/hanzo.svg" /></a>
   <a href="https://travis-ci.org/mirego/hanzo"><img src="http://img.shields.io/travis/mirego/hanzo.svg" /></a>
 </p>
@@ -23,58 +22,59 @@ gem 'hanzo'
 
 ## Usage
 
-Create an `.hanzo.yml` file at the root of your app that will contain a map of
+Create a `.hanzo.yml` file at the root of your app that will contain a map of
 remotes, with the remote as the key and the Heroku application name as the value.
 
-You can also specify commands that can be ran on the application after a
-successful deploy. Hanzo will prompt to run each of them, they each will be ran
-with `heroku run` and the application will be restarted at the end.
+You can also use `after_deploy` to specify commands that will be run on the application
+after a successful deployment. Hanzo will prompt you before running each command,
+then use `heroku run` to execute it. The application is restarted afterwards.
 
 ```yaml
 remotes:
   qa: heroku-app-name-qa
   staging: heroku-app-name-staging
   production: heroku-app-name-production
+
 after_deploy:
   - rake db:migrate
+
+console: rails console
 ```
 
-### Install remotes
+### `hanzo install`
 
-Whenever you add a new remote to your `.hanzo.yml` file, you'll have to install those
-remotes locally by running `hanzo install`.
+#### Remotes
+
+Whenever you add new remotes to your `.hanzo.yml` file, you'll have to install
+them locally by running `hanzo install remotes`.
 
 ```bash
-> hanzo install
+$ hanzo install remotes
+```
 
+```
 -----> Creating git remotes
        Adding qa
         git remote rm qa 2>&1 > /dev/null
-        git remote add qa git@heroku.com:heroku-app-name-qa.git
+        git remote add qa https://git.heroku.com/heroku-app-name-qa.git
        Adding staging
         git remote rm staging 2>&1 > /dev/null
-        git remote add staging git@heroku.com:heroku-app-name-staging.git
+        git remote add staging https://git.heroku.com/heroku-app-name-staging.git
        Adding production
         git remote rm production 2>&1 > /dev/null
-        git remote add production git@heroku.com:heroku-app-name-production.git
+        git remote add production https://git.heroku.com/heroku-app-name-production.git
 ```
 
-### Deploy a branch or a tag
+#### Labs
 
-```bash
-> hanzo deploy qa
-
------> Branch to deploy: |HEAD|
-```
-
-### Install labs
-
-Once all your remotes are installed, you might want to enable some
-Heroku labs feature for all of them.
+Once all your remotes are installed, you might want to enable Heroku labs
+features:
 
 ```bash
-> bundle exec hanzo install labs
+$ hanzo install labs
+```
 
+```
 -----> Activating Heroku Labs
        Add preboot? yes
        - Enabled for qa
@@ -86,12 +86,115 @@ Heroku labs feature for all of them.
        - Enabled for production
 ```
 
+### `hanzo deploy`
+
+You can deploy to a specific remote using `hanzo deploy <remote>` and an
+optional reference to deploy. If no reference is specified, Hanzo will prompt
+for one (with `HEAD` as the default value).
+
+```bash
+$ hanzo deploy qa release/qa
+```
+
+```
+       git push -f qa release/qa:master
+
+       …
+
+remote: Verifying deploy... done.
+To heroku.com:heroku-app-name-qa.git
+   550c719..27e3538  release/qa -> master
+
+       Run `rake db:migrate` on qa? y
+       heroku run rake db:migrate --remote qa
+
+Running rake db:migrate on heroku-app-name-qa...
+15:45:26.380 [info] Already up
+       heroku ps:restart --remote qa
+
+Restarting dynos on heroku-app-name-qa...
+```
+
+### `hanzo diff`
+
+You can use `hanzo diff <remote>` to compare the current repository state to the code
+that is currently deployed in the specified remote.
+
+Warning: This uses Heroku’s git repository references so its output might be
+wrong if the application was rollbacked.
+
+```
+$ hanzo diff qa
+       git remote update qa && git diff qa/master...HEAD
+```
+
+```diff
+────────────────────────────────────────────────────────────────────────────────────────────
+ -- a/lib/my_app/router.ex
+ ++ b/lib/my_app/router.ex
+────────────────────────────────────────────────────────────────────────────────────────────
+@@ -30,6 +30,8 @@ defmodule MyApp.Router do
+    plug(:fetch_flash)
++   plug(:protect_from_forgery)
++   plug(:put_secure_browser_headers)
+```
+
+### `hanzo config`
+
+#### Compare
+
+You can use `hanzo config compare` to find out which environment variables are
+present in only some of your environments.
+
+```
+$ hanzo config compare
+```
+
+```
+-----> Fetching environment variables
+       heroku config -r qa
+       heroku config -r staging
+       heroku config -r production
+
+-----> Comparing environment variables
+       Missing variables in qa
+       - ASSET_HOST
+       Missing variables in staging
+       - SMTP_PASSWORD
+       - SMTP_PORT
+       - SMTP_SERVER
+       - SMTP_USER
+       Missing variables in production
+       - SMTP_PASSWORD
+       - SMTP_PORT
+       - SMTP_SERVER
+       - SMTP_USER
+```
+
+### `hanzo console`
+
+You can define a `console` command in `.hanzo.yml` to quickly spawn a console
+process using `heroku run`.
+
+```bash
+$ hanzo console qa
+```
+
+```
+Running iex -S mix on heroku-app-name-qa... up
+> |
+```
+
 ## License
 
-`Hanzo` is © 2013-2017 [Mirego](http://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause).  See the [`LICENSE.md`](https://github.com/mirego/hanzo/blob/master/LICENSE.md) file.
+`Hanzo` is © 2013-2018 [Mirego](http://www.mirego.com) and may be freely
+distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause). See the
+[`LICENSE.md`](https://github.com/mirego/hanzo/blob/master/LICENSE.md) file.
 
 ## About Mirego
 
-[Mirego](http://mirego.com) is a team of passionate people who believe that work is a place where you can innovate and have fun. We're a team of [talented people](http://life.mirego.com) who imagine and build beautiful Web and mobile applications. We come together to share ideas and [change the world](http://mirego.org).
+[Mirego](https://www.mirego.com) is a team of passionate people who believe that
+work is a place where you can innovate and have fun. We're a team of [talented people](https://life.mirego.com)
+who imagine and build beautiful Web and mobile applications. We come together to share ideas and [change the world](http://mirego.org).
 
-We also [love open-source software](http://open.mirego.com) and we try to give back to the community as much as we can.
+We also [love open-source software](https://open.mirego.com) and we try to give back to the community as much as we can.

data/bin/hanzo

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w(.. lib))
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'hanzo'
 

data/hanzo.gemspec

@@ -7,10 +7,10 @@ require 'hanzo/version'
 Gem::Specification.new do |spec|
   spec.name          = 'hanzo'
   spec.version       = Hanzo::VERSION
-  spec.authors       = ['Samuel Garneau']
-  spec.email         = ['sgarneau@mirego.com']
-  spec.description   = 'Hanzo is a tool to handle deployments in multiple environments on Heroku.'
-  spec.summary       = 'Hanzo is a tool to handle deployments in multiple environments on Heroku.'
+  spec.authors       = ['Samuel Garneau', 'Rémi Prévost']
+  spec.email         = ['sgarneau@mirego.com', 'rprevost@mirego.com']
+  spec.description   = 'Hanzo is a sharp tool to handle deploying an application on Heroku on multiple environments.'
+  spec.summary       = 'Hanzo is a sharp tool to handle deploying an application on Heroku on multiple environments.'
   spec.homepage      = 'https://github.com/mirego/hanzo'
   spec.license       = 'BSD 3-Clause'
 
@@ -21,9 +21,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'phare', '~> 0.6'
-  spec.add_development_dependency 'rubocop', '~> 0.24'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'rubocop', '~> 0.49'
 
   spec.add_dependency 'highline', '>= 1.6.19'
 end

data/lib/hanzo/cli.rb

@@ -2,11 +2,12 @@ require 'hanzo/modules/deploy'
 require 'hanzo/modules/diff'
 require 'hanzo/modules/install'
 require 'hanzo/modules/config'
+require 'hanzo/modules/console'
 
 module Hanzo
   class CLI < Base
     def run
-      @options.parse!(@args) if @opts.respond_to? :parse!
+      @options.parse!(@args) if @options.respond_to? :parse!
       puts @options unless @options.to_s == "Usage: hanzo [options]\n"
     end
 
@@ -17,7 +18,10 @@ module Hanzo
     end
 
     def initialize_cli
-      initialize_help && return if @app.nil?
+      @options.on('-v', '--version', 'Print version') do
+        puts "Hanzo #{Hanzo::VERSION}"
+        exit
+      end
 
       begin
         @options = Hanzo.const_get(@app.capitalize).new(@args).options
@@ -35,11 +39,11 @@ module Hanzo
              diff - Show the diff between HEAD and the current release
           install - Install Hanzo configuration
            config - Manage Heroku configuration variables
+          console - Run a console command
 
         Options:
       BANNER
-      @options.on('-h', '--help', 'You\'re looking at it.') { puts @options }
-      @options.on('-v', '--version', 'Print version') { puts "Hanzo #{Hanzo::VERSION}" }
+      @options.on('-h', '--help', 'You\'re looking at it.')
     end
   end
 end

data/lib/hanzo/modules/config.rb

@@ -52,7 +52,7 @@ module Hanzo
       @variables.each_pair do |env, variables|
         missing_variables = all_variables - variables
         Hanzo.print "Missing variables in #{env}", :yellow
-        Hanzo.print missing_variables.map { |v| "- #{v}" }
+        Hanzo.print(missing_variables.map { |v| "- #{v}" })
       end
     end
   end

data/lib/hanzo/modules/console.rb

@@ -0,0 +1,57 @@
+module Hanzo
+  class Console < Base
+    # Classes
+    UnknownEnvironment = Class.new(StandardError)
+    UninstalledEnvironment = Class.new(StandardError)
+    UnknownCommand = Class.new(StandardError)
+
+    def initialize_variables
+      @env = extract_argument(1)
+    end
+
+    def initialize_cli
+      initialize_help && return if @env.nil?
+
+      validate_environment_existence!
+
+      console
+    rescue UnknownCommand
+      Hanzo.unindent_print 'A “console” command is needed in `.hanzo.yml`', :red
+    rescue UnknownEnvironment
+      Hanzo.unindent_print "Environment `#{@env}` doesn't exist. Add it to .hanzo.yml and run:\n  hanzo install remotes", :red
+      Hanzo.unindent_print "\nFor more information, read https://github.com/mirego/hanzo#remotes", :red
+    rescue UninstalledEnvironment
+      Hanzo.unindent_print "Environment `#{@env}` has been found in your .hanzo.yml file. Before using it, you must install it:\n  hanzo install remotes", :red
+    end
+
+    def console
+      command = Hanzo.config['console']
+      raise UnknownCommand unless command
+
+      Hanzo.run "heroku run --remote #{@env} #{command}"
+    end
+
+  protected
+
+    def initialize_help
+      @options.banner = <<-BANNER.unindent
+        Usage: hanzo console ENVIRONMENT
+
+        Available environments
+      BANNER
+
+      Hanzo::Installers::Remotes.environments.each do |env|
+        @options.banner << "  - #{env.first}\n"
+      end
+    end
+
+    def validate_environment_existence!
+      raise UnknownEnvironment unless fetcher.exist?
+      raise UninstalledEnvironment unless fetcher.installed?
+    end
+
+    def fetcher
+      @fetcher ||= Hanzo::Fetchers::Environment.new(@env)
+    end
+  end
+end

data/lib/hanzo/modules/deploy.rb

@@ -18,7 +18,7 @@ module Hanzo
       deploy && run_after_deploy_commands
     rescue UnknownEnvironment
       Hanzo.unindent_print "Environment `#{@env}` doesn't exist. Add it to .hanzo.yml and run:\n  hanzo install remotes", :red
-      Hanzo.unindent_print "\nFor more information, read https://github.com/mirego/hanzo#install-remotes", :red
+      Hanzo.unindent_print "\nFor more information, read https://github.com/mirego/hanzo#remotes", :red
     rescue UninstalledEnvironment
       Hanzo.unindent_print "Environment `#{@env}` has been found in your .hanzo.yml file. Before using it, you must install it:\n  hanzo install remotes", :red
     end

data/lib/hanzo/modules/install.rb

@@ -18,7 +18,7 @@ module Hanzo
 
       method = "install_#{@type}"
 
-      if self.respond_to?(method)
+      if respond_to?(method)
         send(method)
       else
         initialize_help

data/lib/hanzo/modules/installers/labs.rb

@@ -4,7 +4,7 @@ module Hanzo
       def install_labs
         Hanzo.title('Activating Heroku Labs')
 
-        Hanzo::Heroku.available_labs.each do |name, _|
+        Hanzo::Heroku.available_labs.each_key do |name|
           next unless Hanzo.agree("Add #{name}?")
 
           Hanzo::Installers::Remotes.environments.each_pair do |env, _|

data/lib/hanzo/modules/installers/remotes.rb

@@ -12,7 +12,7 @@ module Hanzo
       def self.add_remote(app, env)
         Hanzo.print "Adding #{env}"
         Hanzo.run "git remote rm #{env} 2>&1 > /dev/null"
-        Hanzo.run "git remote add #{env} git@heroku.com:#{app}.git"
+        Hanzo.run "git remote add #{env} https://git.heroku.com/#{app}.git"
       end
 
       def self.environments

data/lib/hanzo/version.rb

@@ -1,3 +1,3 @@
 module Hanzo
-  VERSION = '0.6.2'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/lib/hanzo.rb

@@ -15,11 +15,11 @@ module Hanzo
     output = true
 
     _run do
-      if fetch_output
-        output = `#{command}`
-      else
-        output = system(command)
-      end
+      output = if fetch_output
+                 `#{command}`
+               else
+                 system(command)
+               end
     end
 
     output
@@ -68,6 +68,6 @@ end
 
 class String
   def unindent
-    gsub(/^#{scan(/^\s*/).min_by { |l| l.length }}/, '')
+    gsub(/^#{scan(/^\s*/).min_by(&:length)}/, '')
   end
 end

data/spec/cli/deploy_spec.rb

@@ -2,9 +2,9 @@ require 'spec_helper'
 
 describe Hanzo::CLI do
   describe :deploy do
-    let(:deploy!) { Hanzo::CLI.new(['deploy', 'production']) }
+    let(:deploy!) { Hanzo::CLI.new(%w(deploy production)) }
     let(:deploy_question) { 'Branch to deploy in production:' }
-    let(:deploy_command) { "git push -f production 1.0.0:master" }
+    let(:deploy_command) { 'git push -f production 1.0.0:master' }
 
     before do
       expect(Hanzo::Installers::Remotes).to receive(:environments).and_return(['production'])
@@ -12,8 +12,8 @@ describe Hanzo::CLI do
     end
 
     context 'deploy with specific branch' do
-      let(:deploy!) { Hanzo::CLI.new(['deploy', 'production', '2.0.0']) }
-      let(:deploy_command) { "git push -f production 2.0.0:master" }
+      let(:deploy!) { Hanzo::CLI.new(%w(deploy production 2.0.0)) }
+      let(:deploy_command) { 'git push -f production 2.0.0:master' }
       let(:deploy_result) { true }
       let(:config) { {} }
 

data/spec/cli/install_spec.rb

@@ -18,10 +18,10 @@ describe Hanzo::CLI do
         expect(Hanzo::Heroku).to receive(:available_labs).and_return(available_labs)
         expect(Hanzo).to receive(:title).with(labs_title)
 
-        available_labs.each do |name, _|
+        available_labs.each_key do |name|
           expect(Hanzo).to receive(:agree).with("Add #{name}?").and_return(true)
 
-          heroku_remotes.each do |env, _|
+          heroku_remotes.each_key do |env|
             expect(Hanzo).to receive(:run).with("#{enable_labs_cmd} #{name} --remote #{env}")
             expect(Hanzo).to receive(:print).with("#{enable_labs_info} #{env}")
           end
@@ -46,7 +46,7 @@ describe Hanzo::CLI do
           heroku_remotes.each do |env, app|
             expect(Hanzo).to receive(:print).with("Adding #{env}")
             expect(Hanzo).to receive(:run).with("git remote rm #{env} 2>&1 > /dev/null")
-            expect(Hanzo).to receive(:run).with("git remote add #{env} git@heroku.com:#{app}.git")
+            expect(Hanzo).to receive(:run).with("git remote add #{env} https://git.heroku.com/#{app}.git")
           end
         end
 

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w(.. lib))
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'hanzo'
 

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: hanzo
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Samuel Garneau
+- Rémi Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-29 00:00:00.000000000 Z
+date: 2021-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,47 +40,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.24'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.24'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '0.49'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '0.49'
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
@@ -94,9 +95,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.19
-description: Hanzo is a tool to handle deployments in multiple environments on Heroku.
+description: Hanzo is a sharp tool to handle deploying an application on Heroku on
+  multiple environments.
 email:
 - sgarneau@mirego.com
+- rprevost@mirego.com
 executables:
 - hanzo
 extensions: []
@@ -118,6 +121,7 @@ files:
 - lib/hanzo/fetchers/environment.rb
 - lib/hanzo/heroku.rb
 - lib/hanzo/modules/config.rb
+- lib/hanzo/modules/console.rb
 - lib/hanzo/modules/deploy.rb
 - lib/hanzo/modules/diff.rb
 - lib/hanzo/modules/install.rb
@@ -149,11 +153,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Hanzo is a tool to handle deployments in multiple environments on Heroku.
+summary: Hanzo is a sharp tool to handle deploying an application on Heroku on multiple
+  environments.
 test_files:
 - spec/cli/config_spec.rb
 - spec/cli/deploy_spec.rb