hr_deploy 0.0.2 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93edb710600a30c90ce512be9dae066d6cfb64f5
-  data.tar.gz: 9129a7c55e56c7fed6c3a269763c22ccc6a01ceb
+  metadata.gz: 269384c663c1693b844f227cbd8219d1e9e0ddaf
+  data.tar.gz: 3f9c00a090f410433ea4949950032515eeaa7f76
 SHA512:
-  metadata.gz: d84c22c58a26875b651ef921ae5ac61c25e9e4791be78f523d0abf7ceb77f6089ad9a48a834302540b3f4bce6b316a577362e8391fd66699910cf62c867df29e
-  data.tar.gz: 8447cc2204afa97ee798a40201a7ee2efecb13688f199f0fca99e9776a5f98fd010cc763598c5e2a3e5d24923c1f7b1d04fb45b1fcaa927df01a03d49f1a357c
+  metadata.gz: d1a59907ccd34338cd0abf9fbaa37b57ad4368207e318918a494743718ad6a4910888923037a495d464bbc1a49654413fcd255003566caecac853928090e6a65
+  data.tar.gz: b55cfd0cf957c4f195fb3511326dacaa3c2d67bb266a5d78020268b69d54b75670ca775e76d1e7d5aaaf30f8a1eabd4e37463052d45f774809c0391cb1f2671e

data/bin/hr_deploy

@@ -1,230 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'hr_deploy/deployer'
-require 'hr_deploy/config_handler'
-require 'hr_deploy/target'
-require 'hr_deploy/version'
+require 'hr_deploy/application'
 
-private
-
-def main
-  command = parse(ARGV)
-  if command
-    react(command)
-  else
-    puts 'Unknown command'
-    puts
-    help(true)
-    exit 1
-  end
-end
-
-def parse(opts)
-  if opts == [] || opts == ['help']
-    { command: :help }
-
-  elsif opts == ['version']
-    { command: :version }
-
-  elsif opts == ['generate']
-    { command: :generate }
-
-  elsif opts.first == 'deploy'
-    # Deploy command
-    # Possible combinations:
-    #
-    # (empty)
-    # (target)
-    # --no-confirm
-    # (target) --no-confirm
-    # --no-confirm target
-
-    deploy_options = opts[1, opts.length]
-
-    # 0 to 2 additional options to 'deploy' command
-    return nil unless deploy_options.length <= 2
-
-    confirm = true
-    confirm = false if deploy_options.delete('--no-confirm')
-
-    # After we have removed '--no-confirm', we either have one param (target) or nothing
-    return nil unless deploy_options.length <= 1
-
-    # 'nil' for no target (default target)
-    target = deploy_options.first
-
-    # Explicit target should not be a command argument
-    return nil if target && target.start_with?('--')
-
-    { command: :deploy, target: target, confirm: confirm }
-
-  else
-    nil
-  end
-end
-
-def react(command)
-  if command[:command] == :help
-    help
-
-  elsif command[:command] == :version
-    version
-
-  elsif command[:command] == :generate || command[:command] == :deploy
-    if inside_app?
-      if command[:command] == :generate
-        generate
-      else
-        attempt_deploy(command[:target], command[:confirm])
-      end
-
-    else
-      puts 'You should be inside a Heroku app to run this command'
-      exit 1
-    end
-
-  else
-    raise "Command was parsed but don't know how to deal with it"
-  end
-end
-
-def generate
-  generate = true
-
-  if HR_Deploy::ConfigHandler.config_exists?
-    print 'Config file already exists. Overwrite? [Y/n] > '
-    generate = ($stdin.gets.chomp == 'Y')
-  end
-
-  if generate
-    HR_Deploy::ConfigHandler.new.generate_config
-    puts "Example config created at #{HR_Deploy::ConfigHandler::CONFIG_FILE_NAME}. Edit it to suit your needs"
-  end
-end
-
-def attempt_deploy(target_name, confirm)
-
-  # These tools are needed for all deploys
-  exit 1 unless tools_available?('heroku', 'git')
-
-  if HR_Deploy::ConfigHandler.config_exists?
-    raw_targets = HR_Deploy::ConfigHandler.new.load_targets
-    if raw_targets
-      # Config is correct
-      targets = raw_targets.map { |raw_target| HR_Deploy::Target.new(raw_target) }
-
-      if target_name
-        # Explicit target name given
-
-        target = targets.find { |target| target.name == target_name }
-        if target
-          deploy(target, confirm)
-        else
-          puts "No such target: #{target_name}"
-          exit 1
-        end
-
-      else
-        # No target is specified, look for the default one
-        default_targets = targets.select { |target| target.default? }
-
-        if default_targets.length == 0
-          puts 'No default target specified. Edit config to specify one'
-          exit 1
-        elsif default_targets.length > 1
-          puts 'Multiple default targets specified. Edit config to specify only one'
-          exit 1
-        else
-          # Deploy default target
-          deploy(default_targets.first, confirm)
-        end
-      end
-    else
-      # 'ConfigHandler.new.load_targets' will print out the error here
-      exit 1
-    end
-  else
-    puts "No deployment config is present. Run 'hr_deploy generate' to generate a config example"
-    exit 1
-  end
-end
-
-def deploy(target, confirm)
-  # Some targets need 'curl' to disable/enable New Relic pinger
-  exit 1 if target.requires_curl? && !tools_available?('curl')
-
-  # Actual deployment
-  deployer = HR_Deploy::Deployer.new(target, confirm)
-  deployer.deploy
-end
-
-def inside_app?
-  File.directory?('.git')
-end
-
-def tools_available?(*tools)
-
-  def command_available?(cmd)
-    exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
-    ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
-      exts.each do |ext|
-        exe = File.join(path, "#{cmd}#{ext}")
-        return true if File.executable? exe
-      end
-    end
-    false
-  end
-
-  all_tools_available = true
-
-  tools.each do |tool|
-    unless command_available?(tool)
-      puts "You don't have access to '#{tool}' command"
-      all_tools_available = false
-    end
-  end
-
-  all_tools_available
-end
-
-def help(after_error = false)
-  help_string = ''
-
-  unless after_error
-    help_string += "hr_deploy - Deploy Rails apps to Heroku\n\n"
-  end
-
-
-  help_string += <<-eos
-Usage:            hr_deploy [command]
-
-The following commands are supported:
-
-generate          Generate a config file which specifies targets to deploy to.
-                  Won't overwrite existing config unless confirmed.
-
-deploy [target]   Deploy to [target]. If no [target] is specified, deploy
-                  to default target specified in config.
-                  This command supports the following options:
-
-                  --no-confirm   Skip confirmations while deploying.
-                                 This does not affect the initial
-                                 confirmation that triggers the deploy itself.
-                                 Default behavior is to confirm actions.
-
-version           Show gem version.
-
-help              Show help.
-
-Verbose documentation is at:
-https://github.com/enthrops/hr_deploy/blob/master/README.md
-  eos
-
-  puts help_string
-end
-
-def version
-  puts HR_Deploy::VERSION
-end
-
-main
+HR_Deploy::Application.new.run

data/lib/hr_deploy/application.rb

@@ -0,0 +1,64 @@
+require 'hr_deploy/parser'
+require 'hr_deploy/config_handler'
+require 'hr_deploy/deployer'
+require 'hr_deploy/helper'
+require 'hr_deploy/version'
+
+module HR_Deploy
+
+  class Application
+
+    def run
+      parser = HR_Deploy::Parser.new
+      command = parser.parse_cmd_args
+
+      dispatch(command[:action], command[:options])
+    end
+
+    private
+
+    def dispatch(action, options)
+      if action == :help
+        HR_Deploy::Helper.new.show_help(options)
+        return
+      end
+
+      if action == :version
+        show_version
+        return
+      end
+
+      if action == :generate
+        # Will halt app if not at the top of a git repo
+        assert_inside_git_root
+        HR_Deploy::ConfigHandler.new.generate_config
+        return
+      end
+
+      if action == :deploy
+        # Will halt app if not at the top of a git repo
+        assert_inside_git_root
+        HR_Deploy::Deployer.new.deploy(options[:target_name],
+                                       options[:confirm],
+                                       options[:dry_run],
+                                       options[:db_change])
+        return
+      end
+
+      raise "Command was parsed but don't know how to deal with it"
+    end
+
+    def show_version
+      puts "hr_deploy #{HR_Deploy::VERSION}"
+    end
+
+    private
+
+    def assert_inside_git_root
+      unless File.directory?('.git')
+        puts 'You should be at the top level of a Heroku application to run this command'
+        exit 1
+      end
+    end
+  end
+end

data/lib/hr_deploy/color.rb

@@ -0,0 +1,21 @@
+class String
+  def colorize(color_code)
+    "\e[#{color_code}m#{self}\e[0m"
+  end
+
+  def green
+    colorize(32)
+  end
+
+  def blue
+    colorize(34)
+  end
+
+  def red
+    colorize(31)
+  end
+
+  def yellow
+    colorize(33)
+  end
+end

data/lib/hr_deploy/config_handler.rb

@@ -1,9 +1,12 @@
 require 'yaml'
+require 'hr_deploy/target'
 
 module HR_Deploy
 
   class ConfigHandler
 
+    private
+
     CONFIG_FILE_NAME = '.heroku_deploy_config.yaml'
 
     EXAMPLE_CONFIG =
@@ -40,6 +43,18 @@ module HR_Deploy
     # automatically, set this to true. Delete this line if you don't use that.
     :backup_db: true
 
+    # Whether to enable and disable maintenance mode before and after deploys.
+    # Optional, defaults to true. Nice to disable for staging environments.
+    :maintenance: true
+
+    # Whether to precompile and sync your assets to Amazon S3 bucket.
+    # Enable if you use the 'asset_sync' gem. This will run 'rake assets:clean'
+    # and 'rake assets:precompile' before pushing code to Heroku. Note that
+    # this option does not configure 'asset_sync' to work with your project,
+    # you have to set that up manually. Delete this line if you don't use that.
+    # Optional, defaults to false.
+    :s3_asset_sync: true
+
     # Whether this target is default, optional, defaults to false.
     # If default is set to true, this target will be picked automatically
     # when you execute 'hr_deploy deploy' without arguments.
@@ -51,29 +66,76 @@ module HR_Deploy
     :new_relic_disable_pinger_url: 'http://disable'
     :new_relic_enable_pinger_url: 'http://enable'
     :backup_db: true
+    :maintenance: true
+    :s3_asset_sync: true
     :default: false
     eos
 
+    public
+
+    attr_reader :error
+    attr_reader :targets
+
+    def new
+      @error = nil
+      @raw_targets = nil
+      @targets = []
+    end
+
     def self.config_exists?
       File.exists?(CONFIG_FILE_NAME)
     end
 
-    # Check if the YAML file is in the right format
-    def load_targets
+    def generate_config
+      generate = true
+
+      if self.class.config_exists?
+        print 'Config file already exists. Overwrite? [Y/n] > '
+        answer = $stdin.gets.chomp.downcase
+        generate = false unless answer == 'y' || answer == 'yes'
+      end
+
+      if generate
+        File.open(CONFIG_FILE_NAME, 'w') { |file| file.write(EXAMPLE_CONFIG) }
+        puts "Example config created at #{CONFIG_FILE_NAME}. Edit it to suit your needs"
+      else
+        puts 'Not overwriting config'
+      end
+    end
+
+    def attempt_to_load_targets
+      # If any of the checks fail, 'self.error' will be set
+      # If no checks fail, 'self.targets' will be set
+
+      if valid_format?
+        if valid_structure?
+          self.targets = load_targets
+        end
+      end
+    end
+
+    private
+
+    attr_writer :error
+    attr_writer :targets
+    attr_accessor :raw_targets
+
+    def valid_format?
       begin
-        targets = YAML.load_file(CONFIG_FILE_NAME)
+        self.raw_targets = YAML.load_file(CONFIG_FILE_NAME)
 
       rescue
-        puts 'Could not parse config'
-        puts "Fix it or generate a new one with 'hr_deploy generate'"
-        return nil
+        self.error = "Could not parse config\n" +
+            "Fix it or generate a new one with 'hr_deploy generate'"
+        false
 
       else
+        # Check config is in the right format
 
         correct_format = true
 
-        if targets.instance_of?(Array)
-          targets.each do |target|
+        if raw_targets.instance_of?(Array)
+          raw_targets.each do |target|
             if target.instance_of?(Hash) && target.length == 1
               options = target.values.first
               unless options.instance_of?(Hash) || options == nil
@@ -90,28 +152,29 @@ module HR_Deploy
         end
 
         if correct_format
-          correct_config?(targets) ? targets : nil
+          true
         else
-          puts 'Incorrect config format'
-          puts "Fix it or generate a new one with 'hr_deploy generate'"
-          nil
+          self.error = "Incorrect config format\n" +
+              "Fix it or generate a new one with 'hr_deploy generate'"
+          false
         end
       end
     end
 
-    def correct_config?(targets)
+    def valid_structure?
       # At this point we know we've got an array of hashes
       # Each hash has one key, and another hash as the value of that key
 
-      targets.each do |target|
+      raw_targets.each do |target|
 
         enable_pinger_url_given = false
         disable_pinger_url_given = false
 
         target_name = target.keys.first
+
         # Each target name is a symbol
         unless target_name.instance_of?(Symbol)
-          puts "Target name is specified incorrectly: #{target_name}"
+          self.error = "Target name is specified incorrectly: #{target_name}"
           return false
         end
 
@@ -124,67 +187,99 @@ module HR_Deploy
 
             # Each option name is a symbol
             unless option.instance_of?(Symbol)
-              puts "Option is specified incorrectly: #{option}"
+              self.error = "Option is specified incorrectly: #{option}"
               return false
             end
 
             case option
             when :description
               unless value.instance_of?(String)
-                puts 'Target description should be a string'
+                self.error = 'Target description should be a string'
                 return false
               end
 
             when :new_relic_disable_pinger_url
               disable_pinger_url_given = true
               unless value.instance_of?(String)
-                puts 'New Relic disable pinger URL should be a string'
+                self.error = 'New Relic disable pinger URL should be a string'
                 return false
               end
 
             when :new_relic_enable_pinger_url
               enable_pinger_url_given = true
               unless value.instance_of?(String)
-                puts 'New Relic enable pinger URL should be a string'
+                self.error = 'New Relic enable pinger URL should be a string'
                 return false
               end
 
             when :backup_db
               unless value.instance_of?(TrueClass) || value.instance_of?(FalseClass)
-                puts 'Backup database option should be a boolean'
+                self.error = 'Backup database option should be a boolean'
+                return false
+              end
+
+            when :maintenance
+              unless value.instance_of?(TrueClass) || value.instance_of?(FalseClass)
+                self.error = 'Maintenance mode control option should be a boolean'
+                return false
+              end
+
+            when :s3_asset_sync
+              unless value.instance_of?(TrueClass) || value.instance_of?(FalseClass)
+                self.error = "'asset_sync' gem invoke option should be a boolean"
                 return false
               end
 
             when :default
               unless value.instance_of?(TrueClass) || value.instance_of?(FalseClass)
-                puts 'Whether this target is the default one option should be a boolean'
+                self.error = 'Whether this target is the default one option should be a boolean'
                 return false
               end
 
             else
-              puts "Option unknown: #{option}"
+              self.error = "Option unknown: #{option}"
               return false
             end
           end
 
           if enable_pinger_url_given && (!disable_pinger_url_given)
-            puts 'URL to enable New Relic pinger is given, but URL to disable it is not'
+            self.error = 'URL to enable New Relic pinger is given, but URL to disable it is not'
             return false
           end
 
           if disable_pinger_url_given && (!enable_pinger_url_given)
-            puts 'URL to disable New Relic pinger is given, but URL to enable it is not'
+            self.error = 'URL to disable New Relic pinger is given, but URL to enable it is not'
             return false
           end
         end
       end
 
-      # Config is correct
+      # Config is correct if we made it here
       true
     end
 
-    def generate_config
-      File.open(CONFIG_FILE_NAME, 'w') { |file| file.write(EXAMPLE_CONFIG) }
+    # 'self.raw_targets' is set and config is valid
+    # Map those into 'Target' objects
+    def load_targets
+      raw_targets.map do |target|
+        name = target.keys.first.to_s
+        options = target.values.first
+
+        if options
+          # Additional options were given in the config
+          HR_Deploy::Target.new(name: name,
+                                description: options[:description],
+                                new_relic_disable_pinger_url: options[:new_relic_disable_pinger_url],
+                                new_relic_enable_pinger_url: options[:new_relic_enable_pinger_url],
+                                backup_db: options[:backup_db],
+                                maintenance: options[:maintenance],
+                                default: options[:default],
+                                s3_asset_sync: options[:s3_asset_sync])
+        else
+          # Only target name was given, 'options' hash is nil
+          HR_Deploy::Target.new(name: name)
+        end
+      end
     end
   end
 end