abak-flow 0.2.3 → 0.3.0

data/README.md

@@ -2,6 +2,8 @@ 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)**
+
 # Концепция
 Идеология git-flow использует следующий набор веток:
 
@@ -25,9 +27,9 @@ Github-flow же наоборот ведет основную разработк
 
     $ gem install abak-flow
     $ git config --global alias.request '!request'
-    $ git config --global abak.apiuser your_github_mail@gmail.com
-    $ git config --global abak.apitoken 0123456789yourf0123456789token
-    $ git remote add upstream git://github.com/github_user_name/project.git
+    $ git config --global abak.apiuser YOUR_GITHUB_MAIL@gmail.com
+    $ git config --global abak.apitoken 0123456789YOUR_GITHUB_API_TOKEN
+    $ git remote add upstream git://github.com/GITHUB_PROJECT_USER/GITHUB_PROJECT_NAME.git
     
 ### А если я использую прокси, как быть?
     $ git config --global abak.proxy http://my-proxy.com:3129
@@ -46,7 +48,7 @@ Github-flow же наоборот ведет основную разработк
 
     $ git request readycheck
 
-или    
+или
     
     $ git request help
     
@@ -61,6 +63,8 @@ Github-flow же наоборот ведет основную разработк
     $ git commit -a -m 'Hello world commit'
     $ git request publish
 
+**Внимание:** Не нужно называться ветку TASK. Используйте префикс задачь из jira
+
 Теперь то же самое, только словами:
 
 * Переключимся в ветку develop
@@ -86,17 +90,17 @@ Github-flow же наоборот ведет основную разработк
 ### Завершение текущей задачи:
 Вообще, завершать задачу лучше только после того, как ваш pull request был принят. Почему? На самом деле по ряду причин. По умолчанию эта команда удаляет как вашу текущую ветку с задачей в локальном репозитории и в добавок ко всему - на вашем удаленном репозитории (форке)
 
-    $ git co feature/TASK-001
+    $ git checkout feature/TASK-001
     $ git request done 
 
 Чтобы оставить какую либо ветку в живых возможно напрямую указать, какую копию ветки **удалить**, локальную или же удаленную (на origin)
 
-    $ git co feature/TASK-001
+    $ git checkout feature/TASK-001
     $ git request done --origin
 
 Или же так
 
-    $ git co feature/TASK-001
+    $ git checkout feature/TASK-001
     $ git request done --local
 
 ## Маленькие хитрости
@@ -108,4 +112,4 @@ Github-flow же наоборот ведет основную разработк
     $ git request done --help
 
 # В заключении
-Данный репозиторий и изложенные в нем идеи ни в коем случае не претендуют на идеал и совершенство. Это всего лишь узко заточенная комбинация гемов
+Данный репозиторий и изложенные в нем идеи ни в коем случае не претендуют на идеал и совершенство. Это всего лишь узко заточенная комбинация гемов

data/lib/abak-flow/config.rb

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+module Abak::Flow
+  class Config < Struct.new(:api_user, :api_token, :proxy)
+    [:api_user, :api_token, :proxy].each {|attribute| define_method("#{attribute}?") { !send(attribute).to_s.empty? } }
+
+    def self.current
+      return @current_config unless @current_config.nil?
+
+      HighLine.color_scheme = HighLine::SampleColorScheme.new
+      git_reader = Hub::Commands.send(:git_reader)
+
+      api_user  = git_reader.read_config('abak.apiuser')
+      api_token = git_reader.read_config('abak.apitoken')
+      proxy     = git_reader.read_config('abak.proxy')
+      env_proxy = ENV['http_proxy'] || ENV['HTTP_PROXY']
+
+      @current_config = new(api_user, api_token, proxy || env_proxy)
+    end
+  end
+end

data/lib/abak-flow/github_client.rb

@@ -0,0 +1,13 @@
+# -*- encoding: utf-8 -*-
+module Abak::Flow
+  class GithubClient
+    def self.connect(config)
+      return @github_connect unless @github_connect.nil?
+
+      github_options = {:login => config.api_user, :oauth_token => config.api_token}
+      github_options[:proxy] = config.proxy if config.proxy?
+
+      @github_connect = Octokit::Client.new(github_options)
+    end
+  end
+end

data/lib/abak-flow/pull_request.rb

@@ -0,0 +1,211 @@
+# -*- encoding: utf-8 -*-
+module Abak::Flow
+  class PullRequest
+    extend Forwardable
+
+    attr_reader :repository, :request_params
+    attr_reader :config, :validator
+
+    def initialize(config, options)
+      strategy = options.delete(:strategy) || :publish
+
+      @repository = Hub::Commands.send(:local_repo)
+      @request_params = OpenStruct.new(options)
+      @config = config
+
+      @validator = Validator.new(strategy, self)
+    end
+
+    delegate [:validate!, :valid?] => :validator
+    delegate [:base=, :head=, :title=, :body=] => :request_params
+
+    def default_task
+      @default_task ||= current_branch.split('/').push(nil)[1].to_s
+    end
+
+    def branch_prefix
+      @branch_prefix  ||= current_branch.include?('/') ? current_branch.split('/').first : ''
+    end
+
+    def current_branch
+      @current_branch ||= repository.current_branch.short_name
+    end
+
+    def from_repo
+      @from_repo ||= begin
+        upstream_project = repository.remote_by_name('upstream').project
+        "#{upstream_project.owner}/#{upstream_project.name}"
+      end
+    end
+    
+    def origin_repo
+      @origin_repo ||= repository.main_project.remote.name
+    end
+
+    def base
+      exit unless validator.valid?
+
+      branch = Abak::Flow::PullRequest.branch_by_prefix(branch_prefix)
+
+      request_params.body || "#{repository.remote_by_name('upstream').project.owner}:#{branch}"
+    end
+
+    def head
+      exit unless validator.valid?
+
+      request_params.head || "#{repository.repo_owner}:#{current_branch}"
+    end
+
+    def title
+      exit unless validator.valid?
+
+      request_params.title
+    end
+
+    def body
+      exit unless validator.valid?
+
+      request_params.body
+    end
+
+    def self.branch_by_prefix(prefix)
+      {:feature => :develop, :hotfix  => :master}.fetch(prefix.to_sym, '')
+    end
+
+    # TODO Вынести
+    class Validator
+      attr_reader :strategy, :target_object
+      attr_reader :errors, :executed
+
+      def initialize(strategy_name, target_object)
+        @strategy = Abak::Flow::PullRequest.const_get("Strategy#{strategy_name.capitalize}".to_sym)
+        @target_object = target_object
+        @errors = []
+      end
+
+      def valid?
+        return errors.empty? if executed
+
+        validate!
+        errors.empty?
+      end
+
+      protected
+      def validate!
+        @executed = true
+
+        strategy.attributes.each do |attribute|
+          send("validate_#{attribute}")
+        end
+
+        print_errors
+      end
+
+      def print_errors
+        errors.each do |error|
+          say color(error[:message], :error).to_s
+          say color(error[:tip], :info).to_s
+        end
+      end
+
+      def validate_api_user
+        return if target_object.config.api_user?
+
+        @errors << {
+          :message => 'Необходимо указать своего пользователя API github',
+          :tip     => '=> https://github.com/Strech/abak-flow/blob/master/README.md'
+        }
+      end
+
+      def validate_api_token
+        return if target_object.config.api_token?
+
+        @errors << {
+          :message => 'Необходимо указать токен своего пользователя API github',
+          :tip     => '=> https://github.com/Strech/abak-flow/blob/master/README.md'
+        }
+      end
+
+      def validate_origin
+        return unless target_object.repository.remote_by_name('origin').nil?
+
+        @errors << {
+          :message => 'Необходимо настроить репозиторий origin (форк) для текущего пользователя',
+          :tip     => '=> git remote add origin https://Developer@github.com/abak-press/sample.git'
+        }
+      end
+
+      def validate_upstream
+        return unless target_object.repository.remote_by_name('upstream').nil?
+
+        @errors << {
+          :message => 'Необходимо настроить репозиторий upstream (главный) для текущего пользователя',
+          :tip     => '=> git remote add upstream https://Developer@github.com/abak-press/sample.git'
+        }
+      end
+
+      def validate_title
+        return unless target_object.request_params.title.empty?
+
+        @errors << {
+          :message => 'Пожалуйста, укажите что-нибудь для заголовка pull request, например номер вашей задачи вот так:',
+          :tip     => '=> git request publish "PC-001"'
+        }
+      end
+
+      def validate_branch
+        return if [:master, :develop].include?(target_object.current_branch.to_sym)
+
+        @errors << {
+          :message => 'Нельзя делать pull request из меток master или develop, попробуйде переключиться, например так:',
+          :tip     => '=> git checkout master'
+        }
+      end
+
+      def validate_deleted_branch
+        return unless [:master, :develop].include?(target_object.current_branch.to_sym)
+
+        @errors << {
+          :message => 'Извините, но нельзя удалить ветку develop или master',
+          :tip     => '=> git checkout feature/TASK-0001'
+        }
+      end
+    end
+
+    class Strategy
+      def self.attributes
+        raise NotImplementedError
+      end
+    end
+
+    class StrategyFeature < Strategy
+      def self.attributes
+        StrategyReadycheck.attributes | [:title, :branch]
+      end
+    end
+
+    class StrategyPublish < Strategy
+      def self.attributes
+        StrategyReadycheck.attributes | [:title]
+      end
+    end
+
+    class StrategyUpdate < Strategy
+      def self.attributes
+        StrategyReadycheck.attributes
+      end
+    end
+
+    class StrategyDone < Strategy
+      def self.attributes
+        StrategyReadycheck.attributes | [:deleted_branch]
+      end
+    end
+
+    class StrategyReadycheck < Strategy
+      def self.attributes
+        [:origin, :upstream, :api_user, :api_token]
+      end
+    end
+  end
+end

data/lib/abak-flow/request.rb

@@ -1,7 +1,5 @@
 # -*- encoding: utf-8 -*-
 module Abak::Flow
-  # @TODO Сделать класс, в котором собрать общие куски из задач
-
   program :name, 'Утилита для оформления pull request на github.com'
   program :version, Abak::Flow::VERSION
   program :description, 'Утилита, заточенная под git-flow но с использованием github.com'
@@ -11,94 +9,44 @@ module Abak::Flow
     c.syntax      = 'git request publish <Заголовок>'
     c.description = 'Оформить pull request из текущей ветки (feature -> develop, hotfix -> master)'
 
-    # Опции нужны, если человек хочет запушить ветку, с именем отличным от стандарта
+    # Опции нужны, если человек хочет запушить  `` ветку, с именем отличным от стандарта
     c.option '--head STRING', String, 'Имя ветки, которую нужно принять в качестве изменений'
     c.option '--base STRING', String, 'Имя ветки, в которую нужно принять изменения'
 
     c.action do |args, options|
-      HighLine.color_scheme = HighLine::SampleColorScheme.new
-
-      request_rules   = {:feature => :develop, :hotfix  => :master}
       jira_browse_url = 'http://jira.dev.apress.ru/browse/'
 
-      repository          = Hub::Commands.send :local_repo
-      current_branch      = repository.current_branch.short_name
-      remote_branch, task = current_branch.split('/').push(nil).map(&:to_s)
+      config = Abak::Flow::Config.current
+      github_client = Abak::Flow::GithubClient.connect(config)
+      request = Abak::Flow::PullRequest.new(config, :head => options.head, :base => options.base)
 
       title = args.first.to_s.strip
-      title = task if task =~ /^\w+\-\d{1,}$/ && title.empty?
-
-      api_user     = Hub::Commands.send(:git_reader).read_config('abak.apiuser')
-      api_token    = Hub::Commands.send(:git_reader).read_config('abak.apitoken')
-      config_proxy = Hub::Commands.send(:git_reader).read_config('abak.proxy')
-      env_proxy    = ENV['http_proxy'] || ENV['HTTP_PROXY']
-
-      client_opts = {:proxy => config_proxy || env_proxy} if config_proxy || env_proxy
-      client_opts ||= {}
-
-      api_client = Octokit::Client.new({:login => api_user, :oauth_token => api_token}.merge(client_opts))
-
-      # Проверим, что мы не в мастере или девелопе
-      if [:master, :develop].include? current_branch.to_sym
-        say color('Нельзя делать pull request из меток master или develop', :error).to_s
-        exit
-      end
-
-      # Проверим, что у нас настроен origin
-      if repository.remote_by_name('origin').nil?
-        say color('Необходимо настроить репозиторий origin (форк) для текущего пользователя', :error).to_s
-        say color('=> git remote add origin https://Developer@github.com/abak-press/sample.git', :info).to_s
-        exit
-      end
+      body = 'Я забыл какая это задача :('
 
-      # Проверим, что у нас настроен upstream
-      if repository.remote_by_name('upstream').nil?
-        say color('Необходимо настроить репозиторий upstream (главный) для текущего пользователя', :error).to_s
-        say color('=> git remote add upstream https://Developer@github.com/abak-press/sample.git', :info).to_s
-        exit
-      end
-
-      if title.empty?
-        say color('Пожалуйста, укажите что-нибудь для заголовка pull request, например номер вашей задачи вот так:', :error).to_s
-        say color('=> git request publish "PC-001"', :info).to_s
-        exit
-      end
-
-      # Проверим, что у нас указан апи юзер
-      if api_user.empty?
-        say color('Необходимо указать своего пользователя API github', :error).to_s
-        say color('=> https://github.com/Strech/abak-flow/blob/master/README.md', :info).to_s
-        exit
-      end
-
-      # Проверим, что у нас указан токен
-      if api_token.empty?
-        say color('Необходимо указать токен своего пользователя API github', :error).to_s
-        say color('=> https://github.com/Strech/abak-flow/blob/master/README.md', :info).to_s
-        exit
+      if request.default_task =~ /^\w+\-\d{1,}$/
+        title = request.default_task if title.empty?
+        body = jira_browse_url + request.default_task
       end
 
-      upstream_project = repository.remote_by_name('upstream').project
+      request.title = title
+      request.body  = body
 
-      # Расставим ветки согласно правилам
-      head = "#{repository.repo_owner}:#{current_branch}"
-      base = "#{repository.remote_by_name('upstream').project.owner}:#{request_rules.fetch(remote_branch.to_sym, '')}"
-
-      head = options.head unless options.head.nil?
-      base = options.base unless options.base.nil?
+      exit unless request.valid?
 
       # Запушим текущую ветку на origin
-      # TODO Может быть лучше достать дерективу конфига origin?
-      say "=> Обновляю ветку #{current_branch} на origin"
-      Hub::Runner.execute('push', 'origin', current_branch)
+      say "=> Обновляю ветку #{request.current_branch} на origin"
+      Hub::Runner.execute('push', 'origin', request.current_branch)
 
       # Запостим pull request на upstream
-      body = jira_browse_url + task if task =~ /^\w+\-\d{1,}$/
-      body ||= 'Я забыл какая это задача :('
-
       say '=> Делаю pull request на upstream'
-      result = api_client.create_pull_request("#{upstream_project.owner}/#{upstream_project.name}", base, head, title, body)
-      say result._links.html.href
+      begin
+        result = github_client.create_pull_request(request.from_repo, request.base, request.head, request.title, request.body)
+        say color(result._links.html.href, :green).to_s
+      rescue => e
+        say color(e.message, :error).to_s
+        say "\nПроблемы? Попробуйте заглянуть сюда:"
+        say color('=> cписок кодов статуса ответа http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html', :info).to_s
+      end
     end
   end
 
@@ -109,20 +57,13 @@ module Abak::Flow
     c.option '--branch STRING', String, 'Имя ветки, которую нужно обновить'
 
     c.action do |args, options|
-      HighLine.color_scheme = HighLine::SampleColorScheme.new
+      config = Abak::Flow::Config.current
+      request = Abak::Flow::PullRequest.new(config, :strategy => :update)
 
-      repository     = Hub::Commands.send :local_repo
-      current_branch = repository.current_branch.short_name
-
-      # Проверим, что у нас настроен origin
-      if repository.remote_by_name('origin').nil?
-        say color('Необходимо настроить репозиторий origin (форк) для текущего пользователя', :error).to_s
-        say color('=> git remote add origin https://Developer@github.com/abak-press/sample.git', :info).to_s
-        exit
-      end
+      exit unless request.valid?
 
       # Запушим текущую ветку на origin
-      branch = options.branch || current_branch
+      branch = options.branch || request.current_branch
       say "=> Обновляю ветку #{branch} на origin"
       Hub::Runner.execute('push', 'origin', branch)
     end
@@ -133,7 +74,7 @@ module Abak::Flow
     c.description = 'Создать ветку для выполнения задачи. Лучше всего, если название задачи, будет ее номером из jira'
 
     c.action do |args, options|
-      HighLine.color_scheme = HighLine::SampleColorScheme.new
+      config = Abak::Flow::Config.current
 
       task = args.shift.to_s
 
@@ -155,7 +96,7 @@ module Abak::Flow
     c.description = 'Создать ветку для выполнения bugfix задачи. Лучше всего, если название задачи, будет ее номером из jira'
 
     c.action do |args, options|
-      HighLine.color_scheme = HighLine::SampleColorScheme.new
+      config = Abak::Flow::Config.current
 
       task = args.shift.to_s
 
@@ -182,36 +123,30 @@ module Abak::Flow
     c.option '--origin', 'Удаляет ветку в удаленном репозитории (origin)'
 
     c.action do |args, options|
-      HighLine.color_scheme = HighLine::SampleColorScheme.new
+      config  = Abak::Flow::Config.current
+      request = Abak::Flow::PullRequest.new(config, :strategy => :done)
+      branch  = options.branch || request.current_branch
 
-      repository     = Hub::Commands.send :local_repo
-      current_branch = repository.current_branch.short_name
-      branch         = options.branch || current_branch
+      exit unless request.valid?
 
       type = :all
       if [options.local, options.origin].compact.count == 1
         type = options.local ? :local : :origin
       end
 
-      if [:master, :develop].include? branch.to_sym
-        say color('Извините, но нельзя удалить ветку develop или master', :error).to_s
-        exit
-      end
-
-      warning = "Внимание! Alarm! Danger! Achtung\nЕсли вы удалите ветку на удаленном репозитории, а ваш pull request еще не приняли, вы рискуете потерять проделанную работу.\nВы уверены, что хотите продолжить?"
+      warning = color('Внимание! Alarm! Danger! Achtung!', :error).to_s +
+                "\nЕсли вы удалите ветку на удаленном (remote) репозитории, а ваш pull request еще не приняли, вы рискуете потерять проделанную работу.\nВы уверены, что хотите продолжить?"
       if [:all, :origin].include?(type)
         say '=> Вы приняли верное решение :)' && exit unless agree("#{warning} [y/n]:")
       end
 
-      # @TODO Проверку на наличие ветки на origin
-      if [:all, :origin].include? type
+      # TODO Проверку на наличие ветки на origin
+      if [:all, :origin].include?(type)
         say "=> Удаляю ветку #{branch} на origin"
-        Hub::Runner.execute('push', repository.main_project.remote.name, ':' + branch)
+        Hub::Runner.execute('push', request.origin_repo, ':' + branch)
       end
 
-      if [:all, :local].include? type
-        remote_branch, task = current_branch.split('/').push(nil).map(&:to_s)
-
+      if [:all, :local].include?(type)
         say "=> Удаляю локальную ветку #{branch}"
         Hub::Runner.execute('checkout', 'develop')
         Hub::Runner.execute('branch', '-D', branch)
@@ -225,61 +160,17 @@ module Abak::Flow
     c.description = 'Проверить все ли настроено для работы с github и удаленным (origin) репозиторием'
 
     c.action do |args, options|
-      HighLine.color_scheme = HighLine::SampleColorScheme.new
-      repository     = Hub::Commands.send :local_repo
-      current_branch = repository.current_branch.short_name
-
-      api_user     = Hub::Commands.send(:git_reader).read_config('abak.apiuser').to_s
-      api_token    = Hub::Commands.send(:git_reader).read_config('abak.apitoken').to_s
-      config_proxy = Hub::Commands.send(:git_reader).read_config('abak.proxy')
-      env_proxy    = ENV['http_proxy'] || ENV['HTTP_PROXY']
-
-      errors = []
-
-      # Проверим, что у нас настроен origin
-      if repository.remote_by_name('origin').nil?
-        errors << [
-          'Необходимо настроить репозиторий origin (форк) для текущего пользователя',
-          '=> git remote add origin https://Developer@github.com/abak-press/sample.git'
-        ]
-      end
-
-      # Проверим, что у нас настроен upstream
-      if repository.remote_by_name('upstream').nil?
-        errors << [
-          'Необходимо настроить репозиторий upstream (главный) для текущего пользователя',
-          '=> git remote add upstream https://Developer@github.com/abak-press/sample.git'
-        ]
-      end
-
-      # Проверим, что у нас указан апи юзер
-      if api_user.empty?
-        errors << [
-          'Необходимо указать своего пользователя API github',
-          '=> https://github.com/Strech/abak-flow/blob/master/README.md'
-        ]
-      end
-
-      # Проверим, что у нас указан токен
-      if api_token.empty?
-        errors << [
-          'Необходимо указать токен своего пользователя API github',
-          '=> https://github.com/Strech/abak-flow/blob/master/README.md'
-        ]
-      end
+      config  = Abak::Flow::Config.current
+      request = Abak::Flow::PullRequest.new(config, :strategy => :readycheck)
 
-      if config_proxy || env_proxy
-        message = "== В качестве прокси будет установлено значение #{config_proxy || env_proxy} =="
+      if config.proxy?
+        message = "== В качестве прокси будет установлено значение #{config.proxy} =="
         say color('=' * message.length, :info).to_s
         say color(message, :info).to_s
         say color('=' * message.length + "\n", :info).to_s
       end
 
-      errors.each do |error|
-        say "#{color(error.first, :error)}\n#{color(error.last, :info)}"
-      end
-
-      say color('Хм ... кажется у вас все готово к работе', :debug).to_s if errors.count.zero?
+      say color('Хм ... кажется у вас все готово к работе', :debug).to_s if request.valid?
     end
   end
 end

data/lib/abak-flow/version.rb

@@ -1,5 +1,5 @@
 module Abak
   module Flow
-    VERSION = '0.2.3'
+    VERSION = '0.3.0'
   end
 end

data/lib/abak-flow.rb

@@ -3,9 +3,17 @@ module Abak
   end
 end
 
+require 'ostruct'
+require 'forwardable'
+
 require 'hub'
 require 'highline'
 require 'octokit'
+
 require 'abak-flow/hub_extensions'
+require 'abak-flow/config'
+require 'abak-flow/github_client'
+require 'abak-flow/pull_request'
 require 'abak-flow/version'
-require "commander/import"
+
+require 'commander/import'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: abak-flow
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-16 00:00:00.000000000 Z
+date: 2012-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hub
@@ -76,7 +76,10 @@ files:
 - abak-flow.gemspec
 - bin/request
 - lib/abak-flow.rb
+- lib/abak-flow/config.rb
+- lib/abak-flow/github_client.rb
 - lib/abak-flow/hub_extensions.rb
+- lib/abak-flow/pull_request.rb
 - lib/abak-flow/request.rb
 - lib/abak-flow/version.rb
 homepage: https://github.com/Strech/abak-flow