foreplay 0.9.13 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd6889f62e82a25a5f10498ad1b2e74a5eaeeb1c
-  data.tar.gz: d5acf45b1c8349c10541df6d4b76fdcb9cc0f7d6
+  metadata.gz: 35a3ae418413c4a78a0c33ef41eb5e7168287e32
+  data.tar.gz: 954d074b1b34dc7643b3cd4a3b8daa433fa74ad1
 SHA512:
-  metadata.gz: d22228c8a9f679b14b37a783fd4f0626ce6052690517e1cede98efb7e1f0f2f7d2b6d42371423a2437c5e3aa352c7643dc1f6cc60353dce3adacf72ad616d704
-  data.tar.gz: 56ee1a44522a2d1fb9daa5a023152faaa35950312b4aa8bd0e7ebe872b4c8799868eb21f514f72a6328c84a63c60cd98dced8651f5eef4785537dc0710b70efb
+  metadata.gz: 20fd2bc4dc6f9eae22d3c098425b581d7b53d19bb0a1085ef8263edcb54b8bbd6f61b98f91ae78034d393316231203c97a90308b9f98cfc4c95af63569b8ddd8
+  data.tar.gz: aa5ad1cdc055544d768d7ffd63e2dd7766f5eddc23103ea4ab90c8a131efdb8d9b662a4e74e02a770856900c477d337123a8d2f2289797b24959b6a06a10bced

data/.gitignore

@@ -1,4 +1,6 @@
 .ruby-gemset
+._*
+.DS_Store
 
 *.TMP
 *.rbc

data/.rubocop.yml

@@ -12,7 +12,7 @@ DotPosition:
 
 ClassAndModuleChildren:
   Description: 'Checks style of children classes and modules.'
-  EnforcedStyle: compact
+  EnforcedStyle: nested
   Enabled: true
 
 Documentation:

data/lib/foreplay/cli.rb

@@ -2,50 +2,52 @@ require 'thor'
 require 'foreplay'
 require 'foreplay/setup'
 
-class Foreplay::CLI < Thor
-  desc 'deploy ENVIRONMENT', 'Deploys to specified environment'
-
-  method_option :role,        aliases: '-r'
-  method_option :server,      aliases: '-s'
-  method_option :config_file, aliases: '-f'
-  method_option :verbose,     aliases: '-v'
-
-  def deploy(environment)
-    Foreplay::Launcher.start [:deploy, environment, options]
-  end
-
-  desc 'check ENVIRONMENT', 'Checks if configuration is OK for specified environment'
-
-  method_option :role,        aliases: '-r'
-  method_option :server,      aliases: '-s'
-  method_option :config_file, aliases: '-f'
-  method_option :verbose,     aliases: '-v'
-
-  def check(environment)
-    Foreplay::Launcher.start [:check, environment, options]
-  end
-
-  desc 'setup', 'Create the Foreplay config file'
-
-  method_option :name,        aliases: '-n'
-  method_option :repository,  aliases: '-r'
-  method_option :user,        aliases: '-u'
-  method_option :password
-  method_option :keyfile
-  method_option :private_key, aliases: '-k'
-  method_option :path,        aliases: '-f'
-  method_option :port,        aliases: '-p', type: :numeric
-  method_option :servers,     aliases: '-s', type: :array
-  method_option :db_adapter,  aliases: '-a'
-  method_option :db_encoding, aliases: '-e'
-  method_option :db_name,     aliases: '-d'
-  method_option :db_pool,                    type: :numeric
-  method_option :db_host,     aliases: '-h'
-  method_option :db_user
-  method_option :db_password
-  method_option :resque_redis
-
-  def setup
-    Foreplay::Setup.start
+module Foreplay
+  class CLI < Thor
+    desc 'deploy ENVIRONMENT', 'Deploys to specified environment'
+
+    method_option :role,        aliases: '-r'
+    method_option :server,      aliases: '-s'
+    method_option :config_file, aliases: '-f'
+    method_option :verbose,     aliases: '-v'
+
+    def deploy(environment)
+      Foreplay::Launcher.start [:deploy, environment, options]
+    end
+
+    desc 'check ENVIRONMENT', 'Checks if configuration is OK for specified environment'
+
+    method_option :role,        aliases: '-r'
+    method_option :server,      aliases: '-s'
+    method_option :config_file, aliases: '-f'
+    method_option :verbose,     aliases: '-v'
+
+    def check(environment)
+      Foreplay::Launcher.start [:check, environment, options]
+    end
+
+    desc 'setup', 'Create the Foreplay config file'
+
+    method_option :name,        aliases: '-n'
+    method_option :repository,  aliases: '-r'
+    method_option :user,        aliases: '-u'
+    method_option :password
+    method_option :keyfile
+    method_option :private_key, aliases: '-k'
+    method_option :path,        aliases: '-f'
+    method_option :port,        aliases: '-p', type: :numeric
+    method_option :servers,     aliases: '-s', type: :array
+    method_option :db_adapter,  aliases: '-a'
+    method_option :db_encoding, aliases: '-e'
+    method_option :db_name,     aliases: '-d'
+    method_option :db_pool,                    type: :numeric
+    method_option :db_host,     aliases: '-h'
+    method_option :db_user
+    method_option :db_password
+    method_option :resque_redis
+
+    def setup
+      Foreplay::Setup.start
+    end
   end
 end

data/lib/foreplay/engine/defaults.rb

@@ -0,0 +1,60 @@
+module Foreplay
+  class Engine
+    module Defaults
+      include Foreplay
+
+      DEFAULT_CONFIG_FILE = "#{Dir.getwd}/config/foreplay.yml"
+      DEFAULTS_KEY        = 'defaults'
+
+      def defaults
+        return @defaults if @defaults
+
+        # Establish defaults
+        # First the default defaults
+        @defaults = {
+          'name'            =>  File.basename(Dir.getwd),
+          'environment'     =>  environment,
+          'port'            =>  DEFAULT_PORT
+        }
+
+        @defaults['env'] = secrets
+        @defaults['application'] = secrets
+        @defaults = @defaults.supermerge(roles_all[DEFAULTS_KEY]) if roles_all.key? DEFAULTS_KEY
+        @defaults = @defaults.supermerge(roles[DEFAULTS_KEY])     if roles.key? DEFAULTS_KEY
+        @defaults
+      end
+
+      # Secret environment variables
+      def secrets
+        @secrets ||= (Foreplay::Engine::Secrets.new(environment, roles_all['secrets']).fetch || {})
+      end
+
+      def roles
+        @roles ||= roles_all[environment]
+      end
+
+      def roles_all
+        return @roles_all if @roles_all
+
+        @roles_all = YAML.load(File.read(config_file))
+
+        # This environment
+        unless @roles_all.key? environment
+          terminate("No deployment configuration defined for #{environment} environment.\nCheck #{config_file}")
+        end
+
+        @roles_all
+      rescue Errno::ENOENT
+        terminate "Can't find configuration file #{config_file}.\n"\
+          'Please run foreplay setup or create the file manually.'
+      rescue Psych::SyntaxError
+        terminate "I don't understand the configuration file #{config_file}.\n"\
+          'Please run foreplay setup or edit the file manually.'
+      end
+
+      def config_file
+        @config_file ||= (filters['config_file'] || DEFAULT_CONFIG_FILE)
+      end
+    end
+  end
+end

data/lib/foreplay/engine/logger.rb

@@ -1,48 +1,52 @@
-class Foreplay::Engine::Logger
-  INDENT = 4
-  MARGIN = 24
-
-  attr_reader :message, :options
-
-  def initialize(m, o = {})
-    @message = m
-    @options = o
-
-    output
-  end
-
-  def output
-    puts formatted_message unless silent?
-  end
-
-  def formatted_message
-    @formatted_message ||= header + message
-                                    .gsub(/\A\s*/, '')
-                                    .gsub(/\s+\z/, '')
-                                    .gsub(/(\r\n*)/, "\\1#{margin}")
-  end
-
-  def header
-    @header ||= (margin_format % header_content[0, margin_width - 1]).white
-  end
-
-  def header_content
-    @header_content ||= (options[:host] || '')
-  end
-
-  def margin
-    @margin ||= margin_format % ''
-  end
-
-  def silent?
-    @silent ||= (options[:silent] == true) || message.blank?
-  end
-
-  def margin_width
-    @margin_width ||= MARGIN + INDENT * (options[:indent] || 0)
-  end
-
-  def margin_format
-    @margin_format ||= "%-#{margin_width}s"
+module Foreplay
+  class Engine
+    class Logger
+      INDENT = 4
+      MARGIN = 24
+
+      attr_reader :message, :options
+
+      def initialize(m, o = {})
+        @message = m
+        @options = o
+
+        output
+      end
+
+      def output
+        puts formatted_message unless silent?
+      end
+
+      def formatted_message
+        @formatted_message ||= header + message
+                                        .gsub(/\A\s+/, '')
+                                        .gsub(/\s+\z/, '')
+                                        .gsub(/(\r\n|\r|\n)/, "\\1#{margin}")
+      end
+
+      def header
+        @header ||= (margin_format % header_content[0, margin_width - 1]).white
+      end
+
+      def header_content
+        @header_content ||= (options[:host] || '')
+      end
+
+      def margin
+        @margin ||= margin_format % ''
+      end
+
+      def silent?
+        @silent ||= (options[:silent] == true) || message.blank?
+      end
+
+      def margin_width
+        @margin_width ||= MARGIN + INDENT * (options[:indent] || 0)
+      end
+
+      def margin_format
+        @margin_format ||= "%-#{margin_width}s"
+      end
+    end
   end
 end

data/lib/foreplay/engine/port.rb

@@ -1,77 +1,82 @@
-module Foreplay::Engine::Port
-  include Foreplay
+module Foreplay
+  class Engine
+    module Port
+      include Foreplay
 
-  def host
-    return @host if @host
-    @host, _p = server.split(':') # Parse host + port
-    @host
-  end
+      def host
+        return @host if @host
+        @host, _p = server.split(':') # Parse host + port
+        @host
+      end
 
-  def name
-    @name ||= instructions['name']
-  end
+      def name
+        @name ||= instructions['name']
+      end
 
-  def current_port
-    @current_port ||= port_details['current_port']
-  end
+      def current_port
+        @current_port ||= port_details['current_port']
+      end
 
-  def current_service
-    @current_service ||= port_details['current_service']
-  end
+      def current_service
+        @current_service ||= port_details['current_service']
+      end
 
-  def former_port
-    @former_port ||= port_details['former_port']
-  end
+      def former_port
+        @former_port ||= port_details['former_port']
+      end
 
-  def former_service
-    @former_service ||= port_details['former_service']
-  end
+      def former_service
+        @former_service ||= port_details['former_service']
+      end
 
-  def current_port_file
-    @current_port_file ||= ".foreplay/#{name}/current_port"
-  end
+      def current_port_file
+        @current_port_file ||= ".foreplay/#{name}/current_port"
+      end
 
-  def port_steps
-    @port_steps ||= [
-      {
-        'command' => "mkdir -p .foreplay/#{name} && touch #{current_port_file} && cat #{current_port_file}",
-        'silent' => true
-      }
-    ]
-  end
+      def port_steps
+        @port_steps ||= [
+          {
+            'command' => "mkdir -p .foreplay/#{name} && touch #{current_port_file} && cat #{current_port_file}",
+            'silent' => true
+          }
+        ]
+      end
 
-  def current_port_remote
-    return @current_port_remote if @current_port_remote
+      def current_port_remote
+        return @current_port_remote if @current_port_remote
 
-    @current_port_remote = Foreplay::Engine::Remote
-                           .new(server, port_steps, instructions)
-                           .__send__(mode)
-                           .strip!
-                           .to_i
+        @current_port_remote = Foreplay::Engine::Remote
+                               .new(server, port_steps, instructions)
+                               .__send__(mode)
+                               .strip
+                               .to_i
 
-    message = if @current_port_remote.blank?
-                'No instance is currently deployed'
-              else
-                "Current instance is using port #{@current_port_remote}"
-              end
+        if @current_port_remote == 0
+          message = 'No instance is currently deployed'
+          @current_port_remote = DEFAULT_PORT + PORT_GAP
+        else
+          message = "Current instance is using port #{@current_port_remote}"
+        end
 
-    log message, host: host
-    @current_port_remote
-  end
+        log message, host: host
+        @current_port_remote
+      end
 
-  def port_details
-    return @port_details if @port_details
+      def port_details
+        return @port_details if @port_details
 
-    cp      = current_port_remote
-    port    = instructions['port'].to_i
-    ports   = [port + 1000, port]
-    cp, fp  = cp == port ? ports : ports.reverse
+        cp      = current_port_remote
+        port    = instructions['port'].to_i
+        ports   = [port + PORT_GAP, port]
+        cp, fp  = cp == port ? ports : ports.reverse
 
-    @port_details = {
-      'current_port'    => cp,
-      'current_service' => "#{name}-#{cp}",
-      'former_port'     => fp,
-      'former_service'  => "#{name}-#{fp}"
-    }
+        @port_details = {
+          'current_port'    => cp,
+          'current_service' => "#{name}-#{cp}",
+          'former_port'     => fp,
+          'former_service'  => "#{name}-#{fp}"
+        }
+      end
+    end
   end
 end

data/lib/foreplay/engine/remote/check.rb

@@ -1,42 +1,48 @@
-class Foreplay::Engine::Remote::Check
-  include Foreplay
-  attr_reader :host, :steps, :instructions
-
-  def initialize(h, s, i)
-    @host = h
-    @steps = s
-    @instructions = i
-  end
-
-  def perform
-    steps.each do |step|
-      log "#{(step['commentary'] || step['command']).yellow}", host: host, silent: step['silent']
-
-      if step.key? 'key'
-        list_file_contents step['key']
-      else
-        list_commands step
+module Foreplay
+  class Engine
+    class Remote
+      class Check
+        include Foreplay
+        attr_reader :host, :steps, :instructions
+
+        def initialize(h, s, i)
+          @host = h
+          @steps = s
+          @instructions = i
+        end
+
+        def perform
+          steps.each do |step|
+            log "#{(step['commentary'] || step['command']).yellow}", host: host, silent: step['silent']
+
+            if step.key? 'key'
+              list_file_contents step['key']
+            else
+              list_commands step
+            end
+          end
+
+          ''
+        end
+
+        def list_file_contents(id)
+          i = instructions[id]
+
+          if i.is_a? Hash
+            i.each { |k, v| log "#{k}: #{v}", host: host, indent: 1 }
+          else
+            log i, host: host, indent: 1
+          end
+        end
+
+        def list_commands(step)
+          commands = Foreplay::Engine::Step.new(host, step, instructions).commands
+
+          commands.each do |command|
+            log command, host: host, silent: step['silent']
+          end
+        end
       end
     end
-
-    ''
-  end
-
-  def list_file_contents(id)
-    i = instructions[id]
-
-    if i.is_a? Hash
-      i.each { |k, v| log "#{k}: #{v}", host: host, indent: 1 }
-    else
-      log i, host: host, indent: 1
-    end
-  end
-
-  def list_commands(step)
-    commands = Foreplay::Engine::Step.new(host, step, instructions).commands
-
-    commands.each do |command|
-      log command, host: host, silent: step['silent']
-    end
   end
 end

data/lib/foreplay/engine/remote/step.rb

@@ -1,35 +1,41 @@
-class Foreplay::Engine::Remote::Step
-  include Foreplay
-  attr_reader :host, :shell, :step, :instructions
+module Foreplay
+  class Engine
+    class Remote
+      class Step
+        include Foreplay
+        attr_reader :host, :shell, :step, :instructions
 
-  def initialize(h, sh, st, i)
-    @host = h
-    @shell = sh
-    @step = st
-    @instructions = i
-  end
+        def initialize(h, sh, st, i)
+          @host = h
+          @shell = sh
+          @step = st
+          @instructions = i
+        end
 
-  def execute
-    s = Foreplay::Engine::Step.new(host, step, instructions)
-    s.announce
-    output s.commands.map { |command| execute_command(command) }.join
-  end
+        def execute
+          s = Foreplay::Engine::Step.new(host, step, instructions)
+          s.announce
+          output s.commands.map { |command| execute_command(command) }.join
+        end
 
-  def execute_command(command)
-    o = ''
-    process = shell.execute command
-    process.on_output { |_, po| o += po }
-    shell.wait!
-    terminate(o) unless step['ignore_error'] == true || process.exit_status == 0
-    o
-  end
+        def execute_command(command)
+          o = ''
+          process = shell.execute command
+          process.on_output { |_, po| o += po }
+          shell.wait!
+          terminate(o) unless step['ignore_error'] == true || process.exit_status == 0
+          o
+        end
 
-  def silent
-    @silent ||= instructions['verbose'] ? false : step['silent']
-  end
+        def silent
+          @silent ||= instructions['verbose'] ? false : step['silent']
+        end
 
-  def output(o)
-    log o, host: host, silent: silent, indent: 1
-    o
+        def output(o)
+          log o, host: host, silent: silent, indent: 1
+          o
+        end
+      end
+    end
   end
 end