abak-flow 1.0.10 → 1.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OGQyNTgyODI5NjI1MTVmMTg2NzQ3OTUwYjM4NTJkNDlmMWYyNzk2Mg==
+  data.tar.gz: !binary |-
+    Mjk5YmQ0NjY2ZGM4ZmZlMWJiODY1OTRkYmMwNjM3MGQyYjNlMTJmNg==
+SHA512:
+  metadata.gz: !binary |-
+    MWFjNzFjYTM0MGZhMTMyNDU5N2E2NDQ1MWM4YzczNmM4NGY2MzdkOGU3YTUy
+    NDFhYTkwNWQ1NThkN2I3MTJhMzdmMDU0YjFiNWUzZmI0NjExYjA2NWExODBh
+    YmQwNTAyNDg5MzRiNDdhYzRkMmE5NTc0MzZmZjMxZDE0YjkwMDk=
+  data.tar.gz: !binary |-
+    MDA0NjU4NmJlZjFlZTMwMGYxODMyN2IzMWYzYjYwM2JiZTYxOWMxNmQ5NWUx
+    NDI1YmFlNzEzZjVkN2Q3ZWY0YmY5MDM0M2MyOWRkZmEzNDVlY2QzNWI1ODVi
+    ODU4YTJmNTQ2OTQ0M2Y1OWJlNDc2NWFkYTYzY2NkZmE3YjkzODA=

data/README.md

@@ -1,40 +1,27 @@
 Abak-flow
 =========
-Нет, это не новая идеология ведения проекта, это всего лишь набор утилит которые помогают связать использование [git-flow](https://github.com/nvie/gitflow) и [github flow](http://scottchacon.com/2011/08/31/github-flow.html)
 
-**Начиная с версии v0.2.1 используется авторизация OAuth2. [Как ей пользоваться?](https://github.com/Strech/abak-flow/wiki/How-start-work-with-new-abak-flow)**
-
-**Начиная с версии v1.0.0 используется новый формат конфигурации. [Как мигрировать старую?](https://github.com/Strech/abak-flow/wiki/How-start-work-with-abak-flow-v1.0.0)**
-
-# Концепция
-Идеология git-flow использует следующий набор веток:
-
-* *master* - всегда пригодна для развертывания
-* *develop* - основная ветка разработки
-* *hotfix* - ветка для изменений которые попадут на продакшен сервер
-* *feature* - ветки для крупных задач
+[![Code Climate](https://codeclimate.com/github/Strech/abak-flow/badges/gpa.svg)](https://codeclimate.com/github/Strech/abak-flow)
+[![Dependency Status](https://gemnasium.com/Strech/abak-flow.svg)](https://gemnasium.com/Strech/abak-flow)
 
-Github-flow же наоборот ведет основную разработку в ветке master, но при этом master является пригодным для развертывания в любой момент.
+Нет, это не новая идеология ведения разработки в проекте, это всего лишь набор утилит которые помогают связать использование [git-flow](https://github.com/nvie/gitflow) и [github flow](http://scottchacon.com/2011/08/31/github-flow.html)
 
-После долгих раздумий было принято применить следующий набор правил, для разработки на github:
+**Начиная с версии v0.2.1 используется авторизация OAuth2. [Как ей пользоваться?](https://github.com/Strech/abak-flow/wiki/How-start-work-with-new-abak-flow)**
 
-1. Вся разработка любой задачи и функционала ведется только в ветках **feature**
-2. Разработаный функционал из ветки **feature** оформляется pull request только в ветку **develop**
-3. Все исправления ошибок, которые должны попасть на продакшен сервер делаются только в ветках **hotfix**
-4. Исправленные ошибки из ветки **hotfix** фофрмляются pull request только в ветку **master**
-5. После получения исправлений на текущий момент в репозитории инициируется merge ветки **master** в **develop**
+**Начиная с версии v1.0.0 используется новый формат конфигурации. [Как мигрировать старую?](https://github.com/Strech/abak-flow/wiki/How-start-work-with-abak-flow-v1.0.0)**
 
+**Начиная с версии v1.1.0 используется новый формат токена для Github API. [Как обновить?](https://github.com/Strech/abak-flow/wiki/How-start-work-with-abak-flow-v1.1.0)**
 
 # Установка
 
-    $ gem install abak-flow -v 1.0.0
+    $ gem install abak-flow -v '>= 1.1.0'
     $ git config --global alias.request '!request'
-    $ git config --global abak-flow.oauth-user YOUR_GITHUB_MAIL@gmail.com
-    $ git config --global abak-flow.oauth-token 0123456789YOUR_GITHUB_API_TOKEN
+    $ git request configure
     $ git remote add upstream git://github.com/GITHUB_PROJECT_USER/GITHUB_PROJECT_NAME.git
 
 ### А если я использую прокси, как быть?
-    $ git config --global abak-flow.http-proxy http://my-proxy.com:3129
+
+При конфигурации вас спросят о прокси сервере. Если его нет, оставьте поле пустым
 
 Далее по приоритету идут переменные окружения. Сначала **http_proxy**, затем **HTTP_PROXY**
 
@@ -42,9 +29,11 @@ Github-flow же наоборот ведет основную разработк
 
 ---
 
-**Заметьте:** В конфиге git, значением *abak.oauth-user* должен являться тот email адрес, под которым вы заходите на github
+**Важно:** Пароль никогда и нигде не будет сохранен. Он [будет использован](https://developer.github.com/v3/#basic-authentication) для создания персонального токена
+
+**Заметьте:** При конфигурации необходимо указать email адрес под которым вы заходите на github
 
-**Обратите внимание:** В данном контексте под **upstream** подразумевается адрес репозитория в который будут оформляться pull request. А репозиторием **origin** будет являться ваш форк
+**Обратите внимание:** В данном контексте под **upstream** подразумевается адрес репозитория в который будут оформляться пул реквесты. А репозиторием **origin** будет являться ваш форк
 
 # С чего начать?
 
@@ -54,35 +43,61 @@ Github-flow же наоборот ведет основную разработк
 
     $ git request help
 
-**Примечание:** Вообще-то все комманды поддерживают опцию *--help*, но вот именно *git request --help* успевает перехватиться самим git и он конечно неодумевает как ему показать хэлп по внешней комманде
+**Примечание:** Вообще-то все комманды поддерживают опцию `--help`, но вот именно `git request --help` успевает перехватиться самим git и он конечно неодумевает как ему показать хэлп по внешней комманде
+
+# Список команд
+
+    $ git request configure
+    $ git request checkup
+    $ git request compare [--base <имя ветки>] [--head <имя ветки>]
+    $ git request publish [--base <имя ветки>] [--head <имя ветки>] [--title <заголовок>] [--body <описание>]
+    $ git request done
+
+# Концепция
+Идеология git-flow использует следующий набор веток:
+
+* *master* - всегда пригодна для развертывания
+* *develop* - основная ветка разработки
+* *hotfix* - ветка для изменений которые попадут на продакшен сервер
+* *feature* - ветки для крупных задач
+
+Github-flow же наоборот ведет основную разработку в ветке master, но при этом master является пригодным для развертывания в любой момент.
+
+После долгих раздумий было принято применить следующий набор правил, для разработки на github:
+
+1. Вся разработка любой задачи и функционала ведется только в ветках **feature**
+2. Разработаный функционал из ветки **feature** оформляется pull request только в ветку **develop**
+3. Все исправления ошибок, которые должны попасть на продакшен сервер делаются только в ветках **hotfix**
+4. Исправленные ошибки из ветки **hotfix** фофрмляются pull request только в ветку **master**
+5. После получения исправлений на текущий момент в репозитории инициируется merge ветки **master** в **develop**
 
 # Примеры использования
 ### Самый простой способ начать новую задачу:
 
     $ git checkout develop
-    $ git flow feature start 'TASK-001'
+    $ git checkout -b feature/TASK-001
     $ touch 'hello.txt' && echo 'Hello world!' > hello.txt
     $ git commit -a -m 'Hello world commit'
     $ git request publish
 
-**Внимание:** Не нужно называться ветку TASK. Используйте префикс задачь из jira
+**Внимание:** Не нужно называться ветку TASK. Используйте префикс задач из jira
 
 Теперь то же самое, только словами:
 
 * Переключимся в ветку develop
-* git-flow создаст ветку, пригодную для оформления pull request (правила именования и правила самого реквеста)
+* Создадим ветку в которй будем выполнять задачу
 * Простое создание нового файла
-* Git процедуры добавления своих изменений в репозиторий
-* Затем публикация вашей ветки на вашем форке (если таковая уже есть, то просто обновление), затем оформление pull request из этой ветки в соответствующую правилам ветку на upstream (в данном случае это будет ветка develop)
+* Git процедуры добавления своих изменений в индекс
+* Затем публикация вашей ветки на вашем форке (если таковая уже есть, то просто обновление), затем оформление пул реквеста из этой ветки в соответствующую правилам ветку на upstream (в данном случае это будет ветка develop)
 
 Для задач, которые должны быть выполнены в виде hotfix принцип тот же:
 
     $ git checkout master
-    $ git flow hotfix start 'TASK-001'
+    $ git checkout -b hotfix/TASK-001
     $ …
     $ git request publish
 
-*На самом деле переключаться на master или develop в самом начале вовсе не обязательно, этот шаг был приведен для пущей ясности*
+*На самом деле переключаться на master или develop в самом начале вовсе не обязательно, этот шаг был приведен для ясности*
 
 ## Маленькие хитрости
 Если сразу правильно именовать ветки, т.е ветку с задачей создавать с именем, такого формата TASK-001, то, в описание pull request автоматически вставится ссылка на задачу в jira, а в имя pull request сразу вставится название, состоящее из имени задачи, т.е TASK-001
@@ -99,4 +114,4 @@ Github-flow же наоборот ведет основную разработк
 
 ## Лицензия
 
-Abak-flow выпускается под лицензией [MIT](http://www.opensource.org/licenses/MIT).
+Abak-flow выпускается под лицензией [MIT](http://www.opensource.org/licenses/MIT).

data/abak-flow.gemspec

@@ -20,15 +20,13 @@ Gem::Specification.new do |gem|
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.require_paths = ["lib"]
 
-  gem.add_runtime_dependency "octokit",   "~> 1.19.0"
+  gem.add_runtime_dependency "octokit",   "~> 3.1.0"
   gem.add_runtime_dependency "git",       "~> 1.2.5"
   gem.add_runtime_dependency "commander", "~> 4.1.6"
   gem.add_runtime_dependency "ruler",     "~> 1.4.2"
   gem.add_runtime_dependency "i18n",      "~> 0.6.9"
   gem.add_runtime_dependency "ansi",      "~> 1.4.3"
 
-  gem.add_runtime_dependency "faraday",   "= 0.8.9" # TODO : remove after octokit upgrade
-
   gem.add_development_dependency "cane"
   gem.add_development_dependency "simplecov"
   gem.add_development_dependency "rspec", "~> 2.14"

data/lib/abak-flow.rb

@@ -1,23 +1,27 @@
+# coding: utf-8
+
+require "ansi/code"
+require "commander/blank"
+require "commander/command"
+
+module Abak
+  module Flow
+  end
+end
+
 require "abak-flow/version"
+require "abak-flow/locale"
 require "abak-flow/manager"
 require "abak-flow/configuration"
 require "abak-flow/repository"
 require "abak-flow/branch"
 require "abak-flow/pull_request"
-require "abak-flow/visitor"
+require "abak-flow/inspector"
+require "abak-flow/errors_presenter"
 require "abak-flow/commands/checkup"
 require "abak-flow/commands/compare"
+require "abak-flow/commands/configure"
+require "abak-flow/commands/publish"
+require "abak-flow/commands/done"
 
-
-# Может пригодится
-# module ::Faraday
-#   class Response::RaiseOctokitError < Response::Middleware
-#     def error_message_with_trace(response)
-#       message = (response[:body].errors || []).map {|error| "=> #{error.code}: #{error.message}" }.join("\n")
-
-#       [error_message_without_trace(response), message].reject { |m| m.empty? }.join("\n\nДополнительные сообщения:\n")
-#     end
-#     alias_method :error_message_without_trace, :error_message
-#     alias_method :error_message, :error_message_with_trace
-#   end
-# end
+Abak::Flow::Manager.locale

data/lib/abak-flow/branch.rb

@@ -20,9 +20,8 @@ module Abak::Flow
     attr_reader :task
 
     def initialize(branch)
-      @manager = Manager.instance
       @branch = branch.is_a?(Git::Branch) ? branch
-                                          : @manager.git.branch(branch)
+                                          : Manager.git.branch(branch)
 
       parse_branch_name
     end
@@ -43,11 +42,11 @@ module Abak::Flow
     end
 
     def compare_link(branch)
-      diff = "#{@manager.repository.upstream.owner}:#{branch}...#{@branch}"
+      diff = "#{Manager.repository.upstream.owner}:#{branch}...#{@branch}"
 
       File.join [
-        @manager.github.web_endpoint,
-        @manager.repository.origin.to_s,
+        Manager.github.web_endpoint,
+        Manager.repository.origin.to_s,
         "compare", diff
       ]
     end
@@ -72,13 +71,13 @@ module Abak::Flow
     end
 
     def update
-      origin = @manager.repository.origin.repo
-      @manager.git.push(origin, @branch)
+      origin = Manager.repository.origin.repo
+      Manager.git.push(origin, @branch)
     end
 
     def delete_on_remote
-      origin = @manager.repository.origin.repo
-      @manager.git.push(origin, ":#{@branch}")
+      origin = Manager.repository.origin.repo
+      Manager.git.push(origin, ":#{@branch}")
     end
 
     def delete_on_local
@@ -114,7 +113,7 @@ module Abak::Flow
     end
 
     def valid?
-      !@branch.name.empty?
+      !@branch.name.strip.empty?
     end
 
     private

data/lib/abak-flow/commands/checkup.rb

@@ -1,27 +1,24 @@
 # coding: utf-8
-require "ansi/code"
-
 module Abak::Flow
   module Commands
     class Checkup
-
-      def initialize
-        manager = Manager.instance
-
-        @configuration = manager.configuration
-        @repository = manager.repository
-      end
+      include ANSI::Code
 
       def run(args, options)
         process(args, options)
-        say ANSI.green { I18n.t("commands.checkup.success") }
+
+        say green { Manager.locale.success(self) }
       end
 
       def process(args, options)
-        Visitor.new(@configuration, @repository,
-                    command: "checkup", call: :ready?, inspect: :errors)
-               .on_fail(exit: 1)
+        inspector = Inspector.new(call_method: :valid?, collect_attribute: :errors)
+        inspector.examine(Manager.configuration, Manager.repository).on_fail do |insp|
+          say red { Manager.locale.error(self) }
+          say yellow { insp.output }
+
+          exit 100
+        end
       end
     end # class Checkup
   end # module Commands
-end # module Abak::Flow
+end # module Abak::Flow

data/lib/abak-flow/commands/compare.rb

@@ -1,45 +1,35 @@
 # coding: utf-8
-require "commander/blank"
-require "commander/command"
-require "ansi/code"
+# 101 exit code available
 
 module Abak::Flow
   module Commands
     class Compare
-      # TODO : Быть может стоит сделать include ANSI
-
-      def initialize
-        manager = Manager.instance
-
-        @configuration = manager.configuration
-        @repository = manager.repository
-        @git = manager.git
-      end
+      include ANSI::Code
 
       def run(args, options)
-        Checkup.new.process(
-          Array.new, ::Commander::Command::Options.new)
+        Checkup.new.process(Array.new, ::Commander::Command::Options.new)
 
-        current = @git.current_branch
+        current = Manager.git.current_branch
         head = Branch.new(options.head || current)
         base = Branch.new(options.base || head.extract_base_name)
 
         if head.current?
-          say ANSI.white {
-            I18n.t("commands.compare.updating",
-              branch: ANSI.bold { head },
-              upstream: ANSI.bold { "#{@repository.origin}" }) }
+          say white {
+            Manager.locale.word(self, 'updating',
+              branch: bold { head },
+              upstream: bold { "#{Manager.repository.origin}" })
+          }
 
           head.update
         else
-          say ANSI.yellow {
-            I18n.t("commands.compare.diverging",
-              branch: ANSI.bold { head }) }
+          say yellow {
+            Manager.locale.word(self, 'diverging', branch: bold { head })
+          }
         end
 
-        say ANSI.green { head.compare_link(base) }
+        say green { head.compare_link(base) }
       end
 
     end
   end
-end
+end

data/lib/abak-flow/commands/configure.rb

@@ -0,0 +1,108 @@
+# coding: utf-8
+require "octokit"
+
+module Abak::Flow
+  module Commands
+    class Configure
+      include ANSI::Code
+
+      def run(args, options)
+        process(args, options)
+
+        puts
+        say green { Manager.locale.success(self) }
+      end
+
+      def process(args, options)
+        interview
+
+        password_hash = deffered do
+          client = Octokit::Client.new(login: @login, password: @password)
+          response = client.create_authorization(
+            scopes: ["repo"], note: "abak-flow",
+            note_url: "https://github.com/Strech/abak-flow",
+            headers: @headers)
+
+          response[:token]
+        end
+
+        Manager.configuration.rewrite(
+          login: @login, password: password_hash,
+          locale: @locale, http_proxy: @http_proxy)
+      end
+
+      private
+
+      def interview
+        @login = ask("#{Manager.locale.word(self, 'email')}: ")
+        @password = password("#{Manager.locale.word(self, 'password')}: ", nil)
+        @locale = choose("#{Manager.locale.word(self, 'locale')}:\n", :en, :ru)
+        @http_proxy = ask("#{Manager.locale.word(self, 'http_proxy')}: ")
+        @headers = {}
+      end
+
+      def otp_interview
+        @headers = {"X-GitHub-OTP" => ask("#{Manager.locale.word(self, 'sms_otp')}: ")}
+      end
+
+      # TODO : Refactor to object
+      def deffered(&block)
+        progressbar.show
+        thread = Thread.new do
+          Thread.current[:result] = suppress { block.call }
+        end
+
+        loop do
+          progressbar.increment
+          break if thread.status === false
+
+          if thread.status.nil?
+            progressbar.erase_line
+            say red { Manager.locale.error(self, 'execution_failed') }
+
+            exit 102
+          end
+
+          sleep 0.3
+        end
+
+        case thread[:result]
+        when Octokit::OneTimePasswordRequired
+          progressbar.erase_line
+          otp_interview
+
+          return deffered(&block)
+        when NilClass
+          progressbar.erase_line
+          say red { Manager.locale.error(self, 'empty_response') }
+
+          exit 103
+        when Exception
+          progressbar.erase_line
+          say red { thread[:result].message }
+
+          exit 104
+        else
+          # no-op
+        end
+
+        thread[:result]
+      end
+
+      def progressbar
+        @progressbar ||= Commander::UI::ProgressBar.new(100,
+          progress_str: ".", incomplete_str: " ", format: ":title:progress_bar",
+          complete_message: "", title: Manager.locale.word(self, 'configuring'))
+      end
+
+      def suppress(&block)
+        begin
+          block.call
+        rescue => error
+          error
+        end
+      end
+
+    end # class Configure
+  end # module Commands
+end # module Abak::Flow