sti_deploy 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffacae68d8d0443b32913f669dc4e923dedb1138
-  data.tar.gz: c144695aeee4321a100836322c387fbb49523664
+  metadata.gz: 484d5b6189243cace8416105b7ca73f138bf56a1
+  data.tar.gz: 87900c87e1ac599c135e72c78a4a0fd1fd356d6b
 SHA512:
-  metadata.gz: a9391f261a47cca2978cde97c8a29dbe3144f71cdf86f8c9c834ddfa68fc7031c013c7d03fccdb76c4d4ff9869086f72bed925909bf9db3fc5b6a62e24e9ed8c
-  data.tar.gz: 99a6b78d656e98ed2501265e21dd13da141614f211e0d75761932da25aae56812e0f4a199ac2b810b14f9ce7b7755d9f8cedee5596ded47d5e32e5e58e808be2
+  metadata.gz: 8779c37c0b98f3cb4ba950e843ea357c3df6f4f8b98f16dfbb07da75dd550b8650c15c0bee1af37f84c524d8f3c90c0ff2259fa0532ef8baac7f2b3d99739b49
+  data.tar.gz: f8952e022d876d925602f27311d0b20be235d9f373ee285361c83fc35f43d20cad3655706e3a019e5ff2fa2fe72b5505e1dbe44c8e58cb6d2987973393c48c7a

data/lang/en.yml

@@ -6,16 +6,19 @@ en:
       detected: "Version number detected: %{version}"
       increment: "\nThe version number will be bumped from \"%{old}\" to \"%{new}\"."
     deploy_type:
-      prompt: "\nIs the deploy for hot(f)ix, staging(h), (p)roject, or (r)elease? Type in \"f\", \"h\", \"p\", or \"r\": "
-      invalid: 'Invalid option. Type in only "f", "h", "p", or "r", imbecile!'
+      prompt: "\nIs the deploy for (h)otfix, release (c)andidate, (p)re-release, or (r)elease? Type in \"c\", \"h\", \"p\", or \"r\": "
+      invalid: 'Invalid option. Type in only "c", "h", "p", or "r", imbecile!'
     release_message:
       prompt: "\nInform a summary of the changes made, in order to create a Git tag:\n> "
       invalid: 'Please write a proper summary (min of 10 chars)!'
     git:
       by: by
-      preparing: Setting up for deploy.
       committing: "\nCommiting the new version number..."
+      merge_error: "There was an error during the merge from \"%{origin}\" to \"%{target}\". Please resolve any conflicts and try again."
       merging: "\nMerging from \"%{origin}\" to \"%{target}\"..."
+      preparing: Setting up for deploy.
+      pull_error: "There was an error trying to checkout and pull from \"%{origin}\". Abort, abort!"
+      push_error: "There was an error trying to push to \"%{target}\". Abort, abort!"
       tagging: "\nCreating a new tag..."
     system:
       interrupted: "\n\nDeploy aborted. Bye-bye."

data/lang/pt-BR.yml

@@ -6,16 +6,19 @@ pt-BR:
       detected: "Número de versão detectado: %{version}"
       increment: "\nA versão será incrementada de \"%{old}\" para \"%{new}\"."
     deploy_type:
-      prompt: "\nO deploy é para hot(f)ix, (h)omologação, or (p)rojeto? Digite \"f\", \"h\", \"p\", ou \"r\": "
-      invalid: 'Tipo inválido. Digite apenas "f", "h", "p", ou "r", animal!'
+      prompt: "\nO deploy é para (h)otfix, (c)andidato de release, (p)ré-release, ou (r)elease? Digite \"c\", \"h\", \"p\", ou \"r\": "
+      invalid: 'Tipo inválido. Digite apenas "c", "h", "p", ou "r", animal!'
     release_message:
       prompt: "\nEscreva um resumo das alterações feitas, para criar a tag no Git:\n> "
       invalid: 'Escreva uma mensagem decente (min 10 chars)!'
     git:
       by: por
-      preparing: Preparando para deploy.
       committing: "\nComitando a nova versão..."
+      merge_error: "Houve um erro durante o merge de \"%{origin}\" para \"%{target}\". Resolva os conflitos e tente novamente."
       merging: "\nFazendo merge de \"%{origin}\" para \"%{target}\"..."
+      preparing: Preparando para deploy.
+      pull_error: "Houve um erro durante o checkout e pull de \"%{origin}\". Abortar, abortar!"
+      push_error: "Houve um erro durante o push para \"%{target}\". Abortar, abortar!"
       tagging: "\nCriando uma nova tag..."
     system:
       interrupted: "\n\nDeploy abortado. Bye-bye."

data/lib/generators/sti_deploy/templates/sti_deploy.yml

@@ -3,11 +3,16 @@ language: '<LANG>'
 version_path: 'config/initializers/version.rb'
 branches:
   hotfix:
-    origin: hotfix
-    target: producao
-  project:
-    origin: projeto
-    target: homologacao
-  staging:
-    origin: master
-    target: homologacao
+    commit: hotfix
+    merge: producao
+  release_candidate:
+    commit: master
+    merge: homologacao
+  pre_release:
+    commit: projeto
+    merge: homologacao
+  release:
+    commit: homologacao
+    merge:
+      - producao
+      - hotfix

data/lib/sti_deploy.rb

@@ -8,13 +8,18 @@ require_relative 'sti_deploy/version'
 require_relative 'sti_deploy/git'
 require_relative 'sti_deploy/deploy_type'
 require_relative 'sti_deploy/deploy'
+require_relative 'sti_deploy/version/version_bumper'
+
+Dir[__dir__ + '/sti_deploy/version/*.rb'].each { |file| require_relative(file) }
+Dir[__dir__ + '/sti_deploy/deploy/*.rb'].each { |file| require_relative(file) }
 
 # Program exit codes:
 #
-# -3: Error: Program was interrupted (CTRL+C)
-# -2: Error: Version file was not found
-# -1: Error: A valid version number within the version file was not found
-#  0: Program exited successfully
+# 0: Program exited successfully
+# 1: Error: A valid version number within the version file was not found
+# 2: Error: Version file was not found
+# 3: Error: Program was interrupted (CTRL+C)
+# 4: Error: There was an error during the Git commit or merge process
 
 module StiDeploy
   class << self
@@ -26,7 +31,7 @@ module StiDeploy
       Messages.puts 'system.finished', color: :green
     rescue Interrupt
       Messages.puts 'system.interrupted', color: :red
-      exit(-3)
+      exit(3)
     end
   end
 end

data/lib/sti_deploy/configuration.rb

@@ -21,14 +21,14 @@ module StiDeploy
         read('git_username') || ''
       end
 
-      def origin_branch(deploy_type)
-        read('branches')[deploy_type.full_name]['origin'] || 'master'
+      def commit_branch(deploy_type)
+        read('branches')[deploy_type.to_s]['commit'] || 'master'
       rescue StandardError
         'master'
       end
 
-      def target_branch(deploy_type)
-        read('branches')[deploy_type.full_name]['target'] || 'master'
+      def merge_branch(deploy_type)
+        read('branches')[deploy_type.to_s]['merge'] || 'master'
       rescue StandardError
         'master'
       end

data/lib/sti_deploy/deploy.rb

@@ -2,22 +2,21 @@
 
 module StiDeploy
   class Deploy
-    attr_reader :version, :type, :message, :git_user
+    attr_reader :version, :type
 
     def initialize
       @version = Version.load_version
-      @git_user = Configuration.git_username
     end
 
     def update_version!
       version.bump(read_type)
       version.update_file!
+      Messages.puts('version.increment', old: version.old, new: version.to_s,
+                    color: :green)
     end
 
     def commit_merge_and_tag!
-      git_commit!
-      git_merge! unless same_origin_target_branches?
-      git_tag!
+      Git.new(version, type).commit_merge_and_tag!(read_release_message)
     end
 
     private
@@ -25,7 +24,7 @@ module StiDeploy
     def read_type
       Messages.print('deploy_type.prompt')
       type = gets.chomp
-      return @type = DeployType.new(type) if %w[f F h H p P r R].include? type
+      return @type = DeployType.new(type) if %w[c C h H p P r R].include? type
       Messages.puts('deploy_type.invalid')
       read_type
     end
@@ -33,52 +32,9 @@ module StiDeploy
     def read_release_message
       Messages.print('release_message.prompt')
       msg = gets.chomp
-      return @message = msg if msg.size >= 10
+      return msg if msg.size >= 10
       Messages.puts('release_message.invalid')
       read_release_message
     end
-
-    def git_commit!
-      read_release_message
-      Messages.puts('git.committing', color: :yellow)
-      Git.add_version
-      Git.commit(message: commit_message)
-      Git.push(branch: origin_branch)
-    end
-
-    def git_merge!
-      Messages.puts('git.merging', origin: origin_branch, target: target_branch,
-                    color: :yellow)
-      Git.checkout(branch: target_branch)
-      Git.pull(branch:     target_branch)
-      Git.merge(branch:    origin_branch)
-      Git.push(branch:     target_branch)
-      Git.checkout(branch: origin_branch)
-    end
-
-    def git_tag!
-      Messages.puts('git.tagging', color: :yellow)
-      Git.tag(version: version.to_s, message: message)
-      Git.push_tags
-    end
-
-    def commit_message
-      by = I18n.t('messages.git.by')
-      preparing = I18n.t('messages.git.preparing')
-      return "#{preparing} #{message}" if git_user.nil? || git_user.empty?
-      "#{by} #{git_user}: #{preparing} #{message}"
-    end
-
-    def same_origin_target_branches?
-      origin_branch == target_branch
-    end
-
-    def origin_branch
-      Configuration.origin_branch(type)
-    end
-
-    def target_branch
-      Configuration.target_branch(type)
-    end
   end
 end

data/lib/sti_deploy/deploy_type.rb

@@ -4,16 +4,23 @@ module StiDeploy
   class DeployType
     attr_reader :type
 
+    DEPLOY_TYPES = {
+      c: 'release_candidate',
+      h: 'hotfix',
+      p: 'pre_release',
+      r: 'release'
+    }
+
     def initialize(type)
       @type = type.downcase
     end
 
     def full_name
-      { h: 'staging', f: 'hotfix', p: 'project', r: 'release' }[type.to_sym]
+      DEPLOY_TYPES[type.to_sym]
     end
 
     def to_s
-      type
+      full_name
     end
   end
 end

data/lib/sti_deploy/git.rb

@@ -2,38 +2,77 @@
 
 module StiDeploy
   class Git
+    attr_reader :version, :deploy_type
+
     class << self
       def add_version
         `git add #{Configuration.version_path}`
       end
 
       def commit(message: '')
-        `git commit -m "#{message.tr('"', '\"')}"`
+        `git commit -m "#{message.tr('"', '\"')}"`.zero?
       end
 
       def checkout(branch: 'master')
-        `git checkout #{branch}`
+        `git checkout #{branch}`.zero?
       end
 
       def merge(branch: 'master')
-        `git merge #{branch}`
+        `git merge #{branch}`.zero?
       end
 
       def tag(version: '', message: '')
-        `git tag -a v#{version.to_s} -m "#{message.tr('"', '\"')}"`
+        `git tag -a v#{version.to_s} -m "#{message.tr('"', '\"')}"`.zero?
       end
 
       def pull(branch: 'master', remote: 'origin')
-        `git pull #{remote} #{branch}`
+        `git pull #{remote} #{branch}`.zero?
       end
 
       def push(branch: 'master', remote: 'origin')
-        `git push #{remote} #{branch}`
+        `git push #{remote} #{branch}`.zero?
       end
 
       def push_tags
-        `git push --tags`
+        `git push --tags`.zero?
+      end
+    end
+
+    def initialize(version, deploy_type)
+      @version = version
+      @deploy_type = deploy_type
+    end
+
+    def commit_merge_and_tag!(message)
+      commit!(message)
+      merge!
+      tag!(message)
+    end
+
+    def commit!(message)
+      Git::Commit.new(commit_branch, message).commit!
+    end
+
+    def merge!
+      merge_branches.each do |target_branch|
+        Git::Merge.new(commit_branch, target_branch).merge!
       end
     end
+
+    def tag!(message)
+      Messages.puts('git.tagging', color: :yellow)
+      Git.tag(version: version.to_s, message: message)
+      Git.push_tags
+    end
+
+    def commit_branch
+      Configuration.commit_branch(deploy_type)
+    end
+
+    # Can be more than one branch, example: merge staging to production and
+    # hotfix, to synchronize production with hotfix and staging.
+    def merge_branches
+      Array(Configuration.merge_branch(deploy_type))
+    end
   end
 end

data/lib/sti_deploy/git/commit.rb

@@ -0,0 +1,30 @@
+module StiDeploy
+  class Git
+    class Commit
+      attr_reader :branch, :git_user, :message
+
+      def initialize(branch, message)
+        @branch = branch
+        @git_user = Configuration.git_username
+        @message = commit_message(git_user, message)
+      end
+
+      def commit!
+        Messages.puts('git.committing', color: :yellow)
+        Git.add_version
+        return true if Git.commit(message: message) && Git.push(branch: origin)
+        Messages.puts('git.push_error', target: origin, color: :red)
+        exit(4)
+      end
+
+      private
+
+      def commit_message(git_user, message)
+        by = I18n.t('messages.git.by')
+        preparing = I18n.t('messages.git.preparing')
+        return "#{preparing} #{message}" if git_user.nil? || git_user.empty?
+        "#{by} #{git_user}: #{preparing} #{message}"
+      end
+    end
+  end
+end

data/lib/sti_deploy/git/merge.rb

@@ -0,0 +1,47 @@
+module StiDeploy
+  class Git
+    class Merge
+      attr_reader :origin, :target
+
+      def initialize(origin_branch, target_branch)
+        @origin = origin_branch
+        @target = target_branch
+      end
+
+      def merge!
+        return unless needs_merge?
+        Messages.puts('git.merging', origin: origin, target: target,
+                      color: :yellow)
+        update_target_branch! && try_merge! && finalize_merge!
+      end
+
+      private
+
+      # Makes sure the branch is updated
+      def update_target_branch!
+        return true if Git.checkout(branch: target) && Git.pull(branch: target)
+        Messages.puts('git.pull_error', origin: origin_branch, color: :red)
+        exit(4)
+      end
+
+      def try_merge!
+        return true if Git.merge(branch: origin)
+        Messages.puts('git.merge_error', origin: origin_branch,
+                      target: target_branch, color: :red)
+        exit(4)
+      end
+
+      def finalize_merge!
+        return true if Git.push(branch: target) && Git.checkout(branch: origin)
+        Messages.puts('git.push_error', target: target_branch, color: :red)
+        exit(4)
+      end
+
+      # It only needs to merge if the origin branch is different from the
+      # target branch (no need to merge to the same branch).
+      def needs_merge?
+        origin_branch.to_s != target_branch.to_s
+      end
+    end
+  end
+end

data/lib/sti_deploy/version.rb

@@ -3,6 +3,7 @@
 module StiDeploy
   class Version
     attr_accessor :major, :minor, :hotfix, :rc, :pre
+    attr_reader :old
 
     FULL_VERSION_REGEX = /[\d]+.[\d]+.[\d]+(rc[\d]+)?(pre[\d]+)?/
 
@@ -21,7 +22,7 @@ module StiDeploy
         return true if File.file?(Configuration.version_path)
         Messages.puts('version.file_not_found',
                       path: Configuration.version_path, color: :red)
-        exit(-1)
+        exit(1)
       end
 
       def read_current_version
@@ -35,7 +36,7 @@ module StiDeploy
         return true if version && !version.is_a?(File)
         Messages.puts('version.not_found', path: Configuration.version_path,
                       color: :red)
-        exit(-2)
+        exit(2)
       end
     end
 
@@ -44,13 +45,11 @@ module StiDeploy
                                   .map(&:to_i)
       self.rc = version[/rc[\d]+/].to_s.tr('rc', '').to_i
       self.pre = version[/pre[\d]+/].to_s.tr('pre', '').to_i
+      @old = to_s
     end
 
     def bump(deploy_type)
-      old = to_s
-      send("bump_#{deploy_type}")
-      Messages.puts('version.increment', old: old, new: to_s, color: :green)
-      to_s
+      VersionBumper.from_deploy_type(deploy_type, self).bump
     end
 
     def update_file!
@@ -65,35 +64,5 @@ module StiDeploy
       base += "pre#{pre}" if pre > 0
       base
     end
-
-    private
-
-    # Bump hot(f)ix
-    def bump_f
-      self.hotfix += 1
-    end
-
-    # Bump (h)omologação
-    def bump_h
-      self.minor += 1 if rc.zero? # Se ainda não existir RC, dá bump no minor
-      self.hotfix = 0
-      self.rc += 1
-    end
-
-    # Bump (p)rojeto
-    def bump_p
-      self.minor += 1 if pre.zero? # Se ainda não existir PRE, dá bump no minor
-      self.hotfix = 0
-      self.pre += 1
-    end
-
-    # Bump (r)release
-    def bump_r
-      # Se ainda não estiver em PRE nem RC, da bump no minor
-      self.minor += 1 if pre.zero? && rc.zero?
-      self.hotfix = 0
-      self.pre = 0
-      self.rc = 0
-    end
   end
 end

data/lib/sti_deploy/version/hotfix.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module StiDeploy
+  class Version
+    class Hotfix < VersionBumper
+      def bump
+        version.hotfix += 1
+        version.pre = 0
+        version.rc = 0
+      end
+    end
+  end
+end

data/lib/sti_deploy/version/pre_release.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module StiDeploy
+  class Version
+    class PreRelease < VersionBumper
+      def bump
+        version.minor += 1 if version.pre.zero?
+        version.hotfix = 0
+        version.pre += 1
+        version.rc = 0
+      end
+    end
+  end
+end

data/lib/sti_deploy/version/release.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module StiDeploy
+  class Version
+    class Release < VersionBumper
+      def bump_version
+        version.minor += 1 if version.pre.zero? && version.rc.zero?
+        version.hotfix = 0
+        version.pre = 0
+        version.rc = 0
+      end
+    end
+  end
+end

data/lib/sti_deploy/version/release_candidate.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module StiDeploy
+  class Version
+    class ReleaseCandidate < VersionBumper
+      def bump
+        version.minor += 1 if version.rc.zero?
+        version.hotfix = 0
+        version.pre = 0
+        version.rc += 1
+      end
+    end
+  end
+end

data/lib/sti_deploy/version/version_bumper.rb

@@ -0,0 +1,24 @@
+module StiDeploy
+  class Version
+    class VersionBumper
+      attr_reader :version
+
+      # We use eval here because the only possible strings that will be
+      # evaluated live in a hardcoded hash inside StiDeploy::DeployType.
+      #
+      # rubocop:disable Security/Eval
+      def self.from_deploy_type(deploy_type, version)
+        class_name = deploy_type.to_s.split('_').map(&:capitalize).join
+        klass = eval("StiDeploy::Version::#{class_name}")
+        klass.new(version)
+      end
+      # rubocop:enable Security/Eval
+
+      def initialize(version)
+        @version = version
+      end
+
+      def bump; end
+    end
+  end
+end

data/lib/version.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-VERSION = '0.3.1'
+VERSION = '0.4.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sti_deploy
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Rodrigo Castro Azevedo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-18 00:00:00.000000000 Z
+date: 2017-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -74,8 +74,15 @@ files:
 - lib/sti_deploy/deploy.rb
 - lib/sti_deploy/deploy_type.rb
 - lib/sti_deploy/git.rb
+- lib/sti_deploy/git/commit.rb
+- lib/sti_deploy/git/merge.rb
 - lib/sti_deploy/messages.rb
 - lib/sti_deploy/version.rb
+- lib/sti_deploy/version/hotfix.rb
+- lib/sti_deploy/version/pre_release.rb
+- lib/sti_deploy/version/release.rb
+- lib/sti_deploy/version/release_candidate.rb
+- lib/sti_deploy/version/version_bumper.rb
 - lib/version.rb
 homepage: https://github.com/roooodcastro/sti_deploy
 licenses: