sti_deploy 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86116a867e48eaf50a17d236db5ce8f820ec012c
-  data.tar.gz: 4366f3f0ae1cdc6d69dd1755c4149a93cac1fae9
+  metadata.gz: b37d901874e0ce71fbf27b26e4de59f2c4ca56ae
+  data.tar.gz: 7dadc0eb56dd04471d43145deb4b70bc7d22204d
 SHA512:
-  metadata.gz: d38cb2896edf10c76e5b9d373d69d800ecb36128141afa93c354907c6dd3dfca5c7c2be43d6036f2694d190f18c3cb6811580df46e770209f477f44872b3d096
-  data.tar.gz: '0078d86afb0770560258026d05fe1b215c5a3edc241dfb2ee2fa0dadf678322fad02440d8671965ba958a567191b997de574ef6ef51715eb756a9dbf3a7059d2'
+  metadata.gz: 7cbda8c33a65025c68aa78e5372430004a13ef93e1d32a9863c5b55bc85b7712d1f0e46f2b860c759d5dcd027294db32cb98584690ab9231260fb6230fabca83
+  data.tar.gz: c37506275d303987bd9748c74c0c32ee8a77d3031fda5a6dadd341f473e459d7e50746dc05c12e9f6fa52953302c48d64f63215bc9f331a6c5c24038c2383c8b

data/README.md

@@ -1,2 +1,42 @@
 # STI Deploy
-An automated script to make commits and merges faster
+
+[![Gem Version](https://badge.fury.io/rb/sti_deploy.svg)](https://badge.fury.io/rb/sti_deploy)
+
+Um programa automatizado para acelerar o processo de fazer o release de uma
+versão para deploy. Foi desenvolvido para funcionar com um processo de deploy
+específico.
+
+## Funcionamento
+
+Esse programa disponibiliza um executável `sti_deploy` que realiza as seguintes
+ações:
+
+1. Detecta o arquivo que contém o número de versão do projeto e o lê
+2. Pergunta o tipo de deploy (staging, hotfix)
+3. Faz um bump na versão de acordo com o tipo escolhido
+4. Pergunta por uma mensagem contendo as notas de release
+5. Faz o commit e push para o branch atual
+6. Se necessário, faz o merge e push para o branch de release configurado
+7. Faz checkout de volta ao branch de trabalho
+8. Cria e dá push em uma nova tag para o release
+
+## Instalação
+
+Instale a gem usando:
+
+    gem install sti_deploy
+    
+Execute o instalador:
+
+    rails g sti_deploy:install
+    
+O instalador irá pedir o idioma desejado, o nome do usuário no Git. Com isso,
+será criado um arquivo `sti_deploy.yml` no root do projeto, e esse arquivo será
+adicionado ao `.gitignore`, pois ele **não deve ser commitado**.
+ 
+## Utilização
+
+Para utilizar, basta executar o comando `sti_deploy` no terminal, no diretório
+root do projeto. O script irá pedir os dados necessários para fazer os commits,
+merges e tags necessárias para dar início ao deploy. A gem **não** realiza o
+deploy em si.

data/lang/en.yml

@@ -20,3 +20,10 @@ en:
     system:
       interrupted: "\n\nDeploy aborted. Bye-bye."
       finished: "\nThe deploy init process has finished!"
+    generator:
+      language_chosen: Language set to English!
+      username_prompt: "\nType in your Git username:"
+      username_chosen: "Username configured!\n"
+      gitignore_updated: 'The new file sti_deploy.yml was added to the .gitignore file!'
+      gitignore_skipped: "\nThe .gitignore file already ignores the new sti_deploy.yml file!"
+      finish: "\nThe installation of StiDeploy is finished!"

data/lang/pt-BR.yml

@@ -20,3 +20,10 @@ pt-BR:
     system:
       interrupted: "\n\nDeploy abortado. Bye-bye."
       finished: "\nO processo de início do deploy está terminado!"
+    generator:
+      language_chosen: 'Idioma configurado para Português!'
+      username_prompt: "\nDigite o seu nome de usuário do Git:"
+      username_chosen: "Nome de usuário configurado!\n"
+      gitignore_updated: 'O novo arquivo sti_deploy.yml foi adicionado ao .gitignore!'
+      gitignore_skipped: "O arquivo do .gitignore já ignora o novo arquivo sti_deploy.yml!"
+      finish: "\nA instalação do StiDeploy foi concluída!"

data/lib/generators/sti_deploy/install_generator.rb

@@ -0,0 +1,90 @@
+# Generator para configurar a gem na aplicação host.
+
+require 'sti_deploy/messages'
+
+module StiDeploy
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc <<DESC
+Description:
+  - Copies the configuration file to the root of the project
+  - Configures the username, branches and languages
+  - Adds the new configuration file to the .gitignore file
+DESC
+
+    def copy_install_file
+      copy_file('sti_deploy.yml', 'sti_deploy.yml')
+    end
+
+    def set_language
+      language = choose_language
+      if language
+        I18n.locale = language
+        replace_in_file('sti_deploy.yml', '<LANG>', language)
+        StiDeploy::Messages.load_messages
+        StiDeploy::Messages.puts('generator.language_chosen', color: :green)
+      else
+        puts 'Invalid option. Please choose a valid option!'
+        set_language
+      end
+    end
+
+    def set_username
+      replace_in_file('sti_deploy.yml', '<USERNAME>', choose_username.strip)
+      StiDeploy::Messages.puts('generator.username_chosen', color: :green)
+    end
+
+    def add_file_to_gitignore
+      return if file_not_found('.gitignore')
+      ignore_lines_sti_deploy = File.readlines('.gitignore').map do |line|
+        line.include?('sti_deploy.yml')
+      end
+      if ignore_lines_sti_deploy.any?
+        StiDeploy::Messages.puts('generator.gitignore_skipped', color: :yellow)
+      else
+        append_to_file '.gitignore', "sti_deploy.yml\n"
+        StiDeploy::Messages.puts('generator.gitignore_updated', color: :green)
+      end
+    end
+
+    def finish_install
+      StiDeploy::Messages.puts('generator.finish', color: :light_blue)
+    end
+
+    protected
+
+    def file_not_found(file, say_if_not_found = true)
+      unless File.exists?(file)
+        msg = "#{file} not found, configure manually"
+        shell.say_status('not found', msg, :red) if say_if_not_found
+        return true
+      end
+      false
+    end
+
+    def choose_language
+      puts 'Which language do you prefer?'
+      I18n.available_locales.each_with_index do |locale, index|
+        puts "  #{index + 1}: #{locale}"
+      end
+      print '> '
+      choice = gets
+      options_array = I18n.available_locales.size.times.map { |i| i + 1 }
+      return nil unless options_array.include?(choice.to_i)
+      I18n.available_locales[choice.to_i - 1]
+    end
+
+    def choose_username
+      StiDeploy::Messages.puts('generator.username_prompt')
+      print '> '
+      gets
+    end
+
+    def replace_in_file(file_name, from, to)
+      contents = File.read(file_name)
+      new_contents = contents.gsub(from, to.to_s)
+      File.open(file_name, 'w') { |file| file.puts new_contents }
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+git_username: '<USERNAME>'
+language: '<LANG>'
+version_path: 'config/initializers/version.rb'
+branches:
+  hotfix:
+    origin: hotfix
+    target: producao
+  project:
+    origin: projeto
+    target: homologacao
+  staging:
+    origin: master
+    target: homologacao

data/lib/sti_deploy/configuration.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'yaml'
-require 'pry'
 
 module StiDeploy
   class Configuration

data/lib/sti_deploy/messages.rb

@@ -19,6 +19,7 @@ module StiDeploy
         I18n.load_path = Dir[LANG_PATH]
         I18n.backend.load_translations
         I18n.default_locale = :en
+        return unless const_defined?(:Configuration)
         I18n.locale = Configuration.language
       end
 

data/lib/version.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-VERSION = '0.1.9'
+VERSION = '0.2.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sti_deploy
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - Rodrigo Castro Azevedo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-05 00:00:00.000000000 Z
+date: 2017-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.6
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.6
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: '0.49'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: '0.49'
 description: A small program to make commits and merges faster. This program automagically
   bumps the version number, commits to the working branch, merges to the deploy branch,
   and creates a release tag.
@@ -67,6 +67,8 @@ files:
 - bin/sti_deploy
 - lang/en.yml
 - lang/pt-BR.yml
+- lib/generators/sti_deploy/install_generator.rb
+- lib/generators/sti_deploy/templates/sti_deploy.yml
 - lib/sti_deploy.rb
 - lib/sti_deploy/configuration.rb
 - lib/sti_deploy/deploy.rb
@@ -85,9 +87,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -95,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: A small program to make commits and merges faster.