foreplay 0.9.8 → 0.9.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12c397ff52837a1e5fd7a68631639acb440e4026
-  data.tar.gz: 44f1d0cce1ce602e68ab2fa64d42aa4961fad32f
+  metadata.gz: 54fa14c8cd58bcbcfa3d6ae58721785d2cbedf60
+  data.tar.gz: 78bfd857d56736431725d9d3b9eddc307f327c85
 SHA512:
-  metadata.gz: ad5695f9428ef9f84713e98a2574a9404f66fb28cdb3e4140076202d76d19141469f6cb67ad20a9ba5f03f2e7c47cb7ce2c82d363b02d00f4d6b72640916b792
-  data.tar.gz: a732fa61abbd044584baf912d7c3787e3814ad3ea4259ea69add455f615fede9c8647ebb9da59ed1601aeb6c5a3cff65f1d05ad2bd212b0c8965b32d3bcc86df
+  metadata.gz: df13a59675a8e854d44d4b09c85723af3d8ef482c1fd726a5f3c1dd7169d5d0e17b77b8b4a6088fe122c74a6942dc42989ae44a4cf6edfe2bb0ee4f5a6d59dab
+  data.tar.gz: d98356701a491e17c6beea0abeedf0530515f13f6952bb3278d289089990a87b984fbf64bcf3e91671f7cc2658acca1f3737eb1609f31078ab0239ec52c53266

data/.rubocop.yml

@@ -42,14 +42,7 @@ LineLength:
 
 MethodLength:
   Description: 'Avoid methods longer than 10 lines of code.'
-  Max: 27 # 85
-
-CyclomaticComplexity:
-  Description: 'Avoid complex methods.'
-  Max: 9
-
-PerceivedComplexity:
-  Max: 11 # 17
+  Max: 18 # 27 # 85
 
 AbcSize:
-  Max: 48 # 62
+  Max: 23 # 62

data/lib/foreplay.rb

@@ -5,6 +5,7 @@ require 'foreplay/engine'
 require 'foreplay/engine/remote'
 require 'foreplay/engine/remote/check'
 require 'foreplay/engine/remote/step'
+require 'foreplay/engine/port'
 require 'foreplay/engine/role'
 require 'foreplay/engine/secrets'
 require 'foreplay/engine/server'

data/lib/foreplay/engine.rb

@@ -1,6 +1,6 @@
 require 'yaml'
 require 'string'
-require 'active_support/core_ext/object'
+require 'hash'
 
 class Foreplay::Engine
   include Foreplay
@@ -29,49 +29,19 @@ class Foreplay::Engine
     puts "#{mode.capitalize}ing #{environment.dup.yellow} environment, "\
          "#{explanatory_text(filters, 'role')}, #{explanatory_text(filters, 'server')}"
 
-    threads = []
-
-    roles.each do |role, additional_instructions|
-      next if role == DEFAULTS_KEY # 'defaults' is not a role
-      next if filters.key?('role') && filters['role'] != role
-
-      threads.concat Foreplay::Engine::Role.new(
+    actionable_roles.map do |role, instructions|
+      Foreplay::Engine::Role.new(
         environment,
         mode,
-        build_instructions(role, additional_instructions)
+        build_instructions(role, instructions)
       ).threads
-    end
-
-    threads.each(&:join)
+    end.flatten.each(&:join)
 
     puts mode == :deploy ? 'Finished deployment' : 'Deployment configuration check was successful'
   end
 
-  # Returns a new hash with +hash+ and +other_hash+ merged recursively, including arrays.
-  #
-  #   h1 = { x: { y: [4,5,6] }, z: [7,8,9] }
-  #   h2 = { x: { y: [7,8,9] }, z: 'xyz' }
-  #   h1.supermerge(h2)
-  #   #=> {:x=>{:y=>[4, 5, 6, 7, 8, 9]}, :z=>[7, 8, 9, "xyz"]}
-  def supermerge(hash, other_hash)
-    fail 'supermerge only works if you pass two hashes. '\
-      "You passed a #{hash.class} and a #{other_hash.class}." unless hash.is_a?(Hash) && other_hash.is_a?(Hash)
-
-    new_hash = hash.deep_dup
-
-    other_hash.each_pair do |k, v|
-      tv = new_hash[k]
-
-      if tv.is_a?(Hash) && v.is_a?(Hash)
-        new_hash[k] = supermerge(tv, v)
-      elsif tv.is_a?(Array) || v.is_a?(Array)
-        new_hash[k] = Array.wrap(tv) + Array.wrap(v)
-      else
-        new_hash[k] = v
-      end
-    end
-
-    new_hash
+  def actionable_roles
+    roles.select { |role, _i| role != DEFAULTS_KEY && role != filters['role'] }
   end
 
   private
@@ -81,7 +51,7 @@ class Foreplay::Engine
   end
 
   def build_instructions(role, additional_instructions)
-    instructions          = supermerge(defaults, additional_instructions)
+    instructions          = defaults.supermerge(additional_instructions)
     instructions['role']  = role
     required_keys         = %w(name environment role servers path repository)
 
@@ -115,16 +85,19 @@ class Foreplay::Engine
       'port'        =>  50_000
     }
 
-    # Add secret environment variables
-    secrets = Foreplay::Engine::Secrets.new(environment, roles_all['secrets']).fetch || {}
-    @defaults['env'] = @defaults['env'].merge secrets
+    @defaults['env'].merge! secrets
     @defaults['application'] = secrets
 
-    @defaults = supermerge(@defaults, roles_all[DEFAULTS_KEY]) if roles_all.key? DEFAULTS_KEY
-    @defaults = supermerge(@defaults, roles[DEFAULTS_KEY])     if roles.key? DEFAULTS_KEY
+    @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

data/lib/foreplay/engine/port.rb

@@ -0,0 +1,66 @@
+module Foreplay::Engine::Port
+  include Foreplay
+
+  def host
+    return @host if @host
+    @host, _p = server.split(':') # Parse host + port
+    @host
+  end
+
+  def name
+    @name ||= instructions['name']
+  end
+
+  def current_port
+    @current_port ||= port_details['current_port']
+  end
+
+  def current_service
+    @current_service ||= port_details['current_service']
+  end
+
+  def former_port
+    @former_port ||= port_details['former_port']
+  end
+
+  def former_service
+    @former_service ||= port_details['former_service']
+  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_details
+    return @port_details if @port_details
+
+    current_port_string = Foreplay::Engine::Remote.new(server, port_steps, instructions).__send__(mode).strip!
+
+    if current_port_string.blank?
+      puts "#{host}#{INDENT}No instance is currently deployed"
+    else
+      puts "#{host}#{INDENT}Current instance is using port #{current_port_string}"
+    end
+
+    cp      = current_port_string.to_i
+    port    = instructions['port']
+    ports   = [port + 1000, port]
+    cp, fp  = cp == port ? ports : ports.reverse
+
+    @port_details = {
+      'current_port'    => cp,
+      'current_service' => "#{name}-#{cp}",
+      'former_port'     => fp,
+      'former_service'  => "#{name}-#{fp}"
+    }
+  end
+end

data/lib/foreplay/engine/remote.rb

@@ -22,7 +22,7 @@ class Foreplay::Engine::Remote
     puts "#{host}#{INDENT}Successfully connected to #{host} on port #{port}"
 
     session.shell do |sh|
-      steps.each { |step| output += Foreplay::Engine::Remote::Step.new(host, sh, step, instructions).deploy }
+      steps.each { |step| output += Foreplay::Engine::Remote::Step.new(host, sh, step, instructions).execute }
     end
 
     session.close

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

@@ -9,31 +9,22 @@ class Foreplay::Engine::Remote::Step
     @instructions = i
   end
 
-  def deploy
+  def execute
     puts "#{host}#{INDENT}#{(step['commentary'] || step['command']).yellow}" unless step['silent'] == true
+    output Foreplay::Engine::Step.new(step, instructions).build.map { |command| execute_command(command) }.join
+  end
 
-    # Output from this step
-    output    = ''
-    previous  = '' # We don't need or want the final CRLF
-    commands  = Foreplay::Engine::Step.new(step, instructions).build
-
-    commands.each do |command|
-      process = shell.execute command
-
-      process.on_output do |_, o|
-        previous = o
-        output += previous
-      end
-
-      shell.wait!
-
-      if step['ignore_error'] == true || process.exit_status == 0
-        print output.gsub!(/^/, "#{host}#{INDENT * 2}") unless step['silent'] == true || output.blank?
-      else
-        terminate(output)
-      end
-    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
 
-    output
+  def output(o)
+    puts o.gsub!(/^/, "#{host}#{INDENT * 2}") unless step['silent'] == true || o.blank?
+    o
   end
 end

data/lib/foreplay/engine/server.rb

@@ -1,5 +1,5 @@
 class Foreplay::Engine::Server
-  include Foreplay
+  include Foreplay::Engine::Port
   attr_reader :environment, :mode, :instructions, :server
 
   def initialize(e, m, i, s)
@@ -10,24 +10,33 @@ class Foreplay::Engine::Server
   end
 
   def execute
-    preposition = mode == :deploy ? 'to' : 'for'
-
-    message = "#{mode.capitalize}ing #{name.yellow} #{preposition} #{host.yellow} "
-    message += "for the #{role.dup.yellow} role in the #{environment.dup.yellow} environment"
-    puts message
+    execute_announce
+    foreman
+    env
+    Foreplay::Engine::Remote.new(server, steps, instructions).__send__ mode
+  end
 
-    # Contents of .foreman file
-    instructions['foreman']['app']   = current_service
-    instructions['foreman']['port']  = current_port
-    instructions['foreman']['user']  = user
-    instructions['foreman']['log']   = "$HOME/#{path}/#{current_port}/log"
+  def execute_announce
+    preposition = mode == :deploy ? 'to' : 'for'
+    puts "#{mode.capitalize}ing #{name.yellow} #{preposition} #{host.yellow} "\
+        "for the #{role.dup.yellow} role in the #{environment.dup.yellow} environment"
+  end
 
-    # Contents of .env file
-    instructions['env']['HOME']  = '$HOME'
-    instructions['env']['SHELL'] = '$SHELL'
-    instructions['env']['PATH']  = '$PATH:`which bundle`'
+  def foreman
+    instructions['foreman'].merge!(
+      'app'   => current_service,
+      'port'  => current_port,
+      'user'  => user,
+      'log'   => "$HOME/#{path}/#{current_port}/log"
+    )
+  end
 
-    Foreplay::Engine::Remote.new(server, steps, instructions).__send__ mode
+  def env
+    instructions['env'].merge!(
+      'HOME'  => '$HOME',
+      'SHELL' => '$SHELL',
+      'PATH'  => '$PATH:`which bundle`'
+    )
   end
 
   def role
@@ -38,10 +47,6 @@ class Foreplay::Engine::Server
     @user ||= instructions['user']
   end
 
-  def name
-    @name ||= instructions['name']
-  end
-
   def path
     return @path if @path
 
@@ -51,12 +56,6 @@ class Foreplay::Engine::Server
     @path
   end
 
-  def host
-    return @host if @host
-    @host, _p = server.split(':') # Parse host + port
-    @host
-  end
-
   def steps
     @steps ||= YAML.load(
       ERB.new(
@@ -66,57 +65,4 @@ class Foreplay::Engine::Server
       ).result(binding)
     )
   end
-
-  def current_port
-    @current_port ||= port_details['current_port']
-  end
-
-  def current_service
-    @current_service ||= port_details['current_service']
-  end
-
-  def former_port
-    @former_port ||= port_details['former_port']
-  end
-
-  def former_service
-    @former_service ||= port_details['former_service']
-  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_details
-    return @port_details if @port_details
-
-    current_port_string = Foreplay::Engine::Remote.new(server, port_steps, instructions).__send__(mode).strip!
-
-    if current_port_string.blank?
-      puts "#{host}#{INDENT}No instance is currently deployed"
-    else
-      puts "#{host}#{INDENT}Current instance is using port #{current_port_string}"
-    end
-
-    cp      = current_port_string.to_i
-    port    = instructions['port']
-    ports   = [port + 1000, port]
-    cp, fp  = cp == port ? ports : ports.reverse
-
-    @port_details = {
-      'current_port'    => cp,
-      'current_service' => "#{name}-#{cp}",
-      'former_port'     => fp,
-      'former_service'  => "#{name}-#{fp}"
-    }
-  end
 end

data/lib/foreplay/engine/step.rb

@@ -9,44 +9,90 @@ class Foreplay::Engine::Step
   def build
     # Each step can be (1) a command or (2) a series of values to add to a file
     if step.key?('key')
-      instructions.key?(step['key']) ? build_commands(step, instructions) : []
+      instructions.key?(step['key']) ? commands : []
     else
       # ...or just execute the command specified
       [step['command']]
     end
   end
 
-  def build_commands(step, instructions)
-    # Add values from the config file to a file on the remote machine
-    key       = step['key']
-    prefix    = step['prefix'] || ''
-    suffix    = step['suffix'] || ''
-    path      = step['path'] || ''
-    before    = step['before'] || ''
-    delimiter = step['delimiter'] || ''
-    after     = step['after'] || ''
+  def commands
+    return @commands if @commands
 
     step['silent'] = true
-    filename = "#{path}#{prefix}#{key}#{suffix}"
 
-    if step.key?('header')
-      commands  = ["echo \"#{step['header']}\" > #{filename}"]
-      redirect  = '>>'
+    if header?
+      @commands  = ["echo \"#{header}\" > #{filename}"]
+      redirect
     else
-      commands  = []
-      redirect  = '>'
+      @commands  = []
     end
 
     if instructions[key].is_a? Hash
-      instructions[key].each do |k, v|
-        commands << "echo \"#{before}#{k}#{delimiter}#{v}#{after}\" #{redirect} #{filename}"
-        redirect = '>>'
-      end
+      build_commands_from_hash
     else
-      commands << "echo \"#{before}#{delimiter}#{instructions[key]}#{after}\" #{redirect} #{filename}"
-      redirect = '>>'
+      build_commands_from_string
     end
 
-    commands
+    @commands
+  end
+
+  def build_commands_from_hash
+    instructions[key].each do |k, v|
+      @commands << "echo \"#{before}#{k}#{delimiter}#{v}#{after}\" #{redirect} #{filename}"
+    end
+  end
+
+  def build_commands_from_string
+    @commands << "echo \"#{before}#{delimiter}#{instructions[key]}#{after}\" #{redirect} #{filename}"
+  end
+
+  def redirect
+    if @redirect
+      '>>'
+    else
+      @redirect = true
+      '>'
+    end
+  end
+
+  def filename
+    @filename ||= "#{path}#{prefix}#{key}#{suffix}"
+  end
+
+  def key
+    @key ||= step['key']
+  end
+
+  def prefix
+    @prefix ||= step['prefix'] || ''
+  end
+
+  def suffix
+    @suffix ||= step['suffix'] || ''
+  end
+
+  def path
+    @path ||= step['path'] || ''
+  end
+
+  def before
+    @before ||= step['before'] || ''
+  end
+
+  def delimiter
+    @delimiter ||= step['delimiter'] || ''
+  end
+
+  def after
+    @after ||= step['after'] || ''
+  end
+
+  def header
+    @header ||= step['header']
+  end
+
+  def header?
+    header.present?
   end
 end

data/lib/foreplay/version.rb

@@ -1,3 +1,3 @@
 module Foreplay
-  VERSION = '0.9.8'
+  VERSION = '0.9.9'
 end

data/lib/hash.rb

@@ -0,0 +1,30 @@
+require 'active_support/core_ext/object'
+
+class Hash
+  # Returns a new hash with +hash+ and +other_hash+ merged recursively, including arrays.
+  #
+  #   h1 = { x: { y: [4,5,6] }, z: [7,8,9] }
+  #   h2 = { x: { y: [7,8,9] }, z: 'xyz' }
+  #   h1.supermerge(h2)
+  #   #=> {:x=>{:y=>[4, 5, 6, 7, 8, 9]}, :z=>[7, 8, 9, "xyz"]}
+  def supermerge(other_hash)
+    fail 'supermerge only works if you pass a hash. '\
+      "You passed a #{self.class} and a #{other_hash.class}." unless other_hash.is_a?(Hash)
+
+    new_hash = deep_dup
+
+    other_hash.each_pair do |k, v|
+      tv = new_hash[k]
+
+      if tv.is_a?(Hash) && v.is_a?(Hash)
+        new_hash[k] = tv.supermerge(v)
+      elsif tv.is_a?(Array) || v.is_a?(Array)
+        new_hash[k] = Array.wrap(tv) + Array.wrap(v)
+      else
+        new_hash[k] = v
+      end
+    end
+
+    new_hash
+  end
+end

data/spec/lib/foreplay/deploy_spec.rb

@@ -24,7 +24,7 @@ describe Foreplay::Launcher do
     allow(session).to receive(:shell).and_yield(shell)
     allow(shell).to receive(:execute).and_return(process)
     allow(shell).to receive(:wait!).and_return(false)
-    allow(process).to receive(:on_output).and_yield(process, "output message\n")
+    allow(process).to receive(:on_output).and_yield(process, "output message 1\noutput message 2\n")
     allow(process).to receive(:exit_status).and_return(0)
   end
 

data/spec/lib/hash_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+require 'hash'
+
+describe Hash do
+  context '#supermerge' do
+    it 'should complain unless two hashes are passed to it' do
+      expect { {}.supermerge('y') }.to raise_error(RuntimeError)
+    end
+
+    it 'should merge two simple hashes' do
+      expect({ a: 'x' }.supermerge(b: 'y')).to eq(a: 'x', b: 'y')
+    end
+
+    it 'should merge two hashes both with arrays at the same key' do
+      expect({ a: ['x'] }.supermerge(a: ['y'])).to eq(a: %w(x y))
+    end
+
+    it 'should merge an array and a value at the same key' do
+      expect({ a: 'x' }.supermerge(a: ['y'])).to eq(a: %w(x y))
+    end
+
+    it 'should replace a value at the same key' do
+      expect({ a: 'x' }.supermerge(a: 'y')).to eq(a: 'y')
+    end
+
+    it 'should merge two subhashes at the same key' do
+      expect({ a: { b: 'x' } }.supermerge(a: { c: 'y' })).to eq(a: { b: 'x', c: 'y' })
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreplay
 version: !ruby/object:Gem::Version
-  version: 0.9.8
+  version: 0.9.9
 platform: ruby
 authors:
 - Xenapto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-06 00:00:00.000000000 Z
+date: 2015-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foreman
@@ -222,6 +222,7 @@ files:
 - lib/foreplay.rb
 - lib/foreplay/cli.rb
 - lib/foreplay/engine.rb
+- lib/foreplay/engine/port.rb
 - lib/foreplay/engine/remote.rb
 - lib/foreplay/engine/remote/check.rb
 - lib/foreplay/engine/remote/step.rb
@@ -235,11 +236,12 @@ files:
 - lib/foreplay/setup.rb
 - lib/foreplay/setup/foreplay.yml
 - lib/foreplay/version.rb
+- lib/hash.rb
 - lib/string.rb
 - spec/lib/foreplay/deploy_spec.rb
-- spec/lib/foreplay/engine_spec.rb
 - spec/lib/foreplay/secrets_spec.rb
 - spec/lib/foreplay/setup_spec.rb
+- spec/lib/hash_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Xenapto/foreplay
 licenses:
@@ -271,7 +273,7 @@ test_files:
 - features/setup.feature
 - features/support/env.rb
 - spec/lib/foreplay/deploy_spec.rb
-- spec/lib/foreplay/engine_spec.rb
 - spec/lib/foreplay/secrets_spec.rb
 - spec/lib/foreplay/setup_spec.rb
+- spec/lib/hash_spec.rb
 - spec/spec_helper.rb

data/spec/lib/foreplay/engine_spec.rb

@@ -1,32 +0,0 @@
-require 'spec_helper'
-require 'foreplay'
-
-describe Foreplay::Engine do
-  context '#supermerge' do
-    let(:engine) { Foreplay::Engine.new('b', 'b') }
-
-    it 'should complain unless two hashes are passed to it' do
-      expect { engine.supermerge('x', 'y') }.to raise_error(RuntimeError)
-    end
-
-    it 'should merge two simple hashes' do
-      expect(engine.supermerge({ a: 'x' }, b: 'y')).to eq(a: 'x', b: 'y')
-    end
-
-    it 'should merge two hashes both with arrays at the same key' do
-      expect(engine.supermerge({ a: ['x'] }, a: ['y'])).to eq(a: %w(x y))
-    end
-
-    it 'should merge an array and a value at the same key' do
-      expect(engine.supermerge({ a: 'x' }, a: ['y'])).to eq(a: %w(x y))
-    end
-
-    it 'should replace a value at the same key' do
-      expect(engine.supermerge({ a: 'x' }, a: 'y')).to eq(a: 'y')
-    end
-
-    it 'should merge two subhashes at the same key' do
-      expect(engine.supermerge({ a: { b: 'x' } }, a: { c: 'y' })).to eq(a: { b: 'x', c: 'y' })
-    end
-  end
-end