abak-flow 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.idea/
+.rvmrc

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem 'hub', '~> 1.8.1'
+gem 'commander', '~> 4.0.7'

data/README.md

@@ -0,0 +1,34 @@
+Abak-flow
+=========
+Нет, это не новая идеология ведения проекта, это всего лишь набор утилит которые помогают связать использование git-flow и github
+
+# Концепция
+Идеология 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 request help
+
+# Примеры использования
+*в процессе*
+
+# В заключении
+Данный репозиторий и изложенные в нем идеи ни в коем случае не претендуют на идеал и совершенство. Это всего лишь узко заточенная комбинация гемов

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/abak-flow.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'abak-flow/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'abak-flow'
+  s.version     = Abak::Flow::VERSION
+  s.authors     = ['Strech (aka Sergey Fedorov)']
+  s.email       = ['oni.strech@gmail.com']
+  s.homepage    = 'https://github.com/Strech/abak-flow'
+  s.summary     = %q{Совмещение 2-х подходов разработки Git-flow & Github-flow}
+  s.description = %q{Простой набор правил и комманд, заточеных для работы в git-flow с использование в качестве удаленного репозитория github}
+
+  s.rubyforge_project = 'abak-flow'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'hub'
+  s.add_runtime_dependency 'commander'
+end

data/bin/request

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# -*- encoding: utf-8 -*-
+require 'abak-flow'
+require "abak-flow/request"

data/lib/abak-flow.rb

@@ -0,0 +1,4 @@
+require 'hub'
+require 'abak-flow/hub_extensions'
+require 'abak-flow/version'
+require "commander/import"

data/lib/abak-flow/hub_extensions.rb

@@ -0,0 +1,114 @@
+module Abak::Flow
+  module RunnerExtension
+    def execute
+      if args.noop?
+        puts commands
+      elsif not args.skip?
+        if args.chained?
+          execute_command_chain
+        else
+          %x{#{args.to_exec.join(' ')}}
+        end
+      end
+    end
+  end
+
+  module CommandsExtension
+    def pull_request(args)
+      args.shift
+      options = { }
+      force = explicit_owner = false
+      base_project = local_repo.main_project
+      head_project = local_repo.current_project
+
+      from_github_ref = lambda do |ref, context_project|
+        if ref.index(':')
+          owner, ref = ref.split(':', 2)
+          project = github_project(context_project.name, owner)
+        end
+        [project || context_project, ref]
+      end
+
+      while arg = args.shift
+        case arg
+        when '-f'
+          force = true
+        when '-b'
+          base_project, options[:base] = from_github_ref.call(args.shift, base_project)
+        when '-h'
+          head = args.shift
+          explicit_owner = !!head.index(':')
+          head_project, options[:head] = from_github_ref.call(head, head_project)
+        when '-i'
+          options[:issue] = args.shift
+        when '-d'
+          options[:body] = args.shift
+        else
+          if url = resolve_github_url(arg) and url.project_path =~ /^issues\/(\d+)/
+            options[:issue] = $1
+            base_project = url.project
+          elsif !options[:title] then options[:title] = arg
+          else
+            abort "invalid argument: #{arg}"
+          end
+        end
+      end
+
+      options[:project] = base_project
+      options[:base] ||= master_branch.short_name
+
+      if tracked_branch = options[:head].nil? && current_branch.upstream
+        if base_project == head_project and tracked_branch.short_name == options[:base]
+          $stderr.puts "Aborted: head branch is the same as base (#{options[:base].inspect})"
+          warn "(use `-h <branch>` to specify an explicit pull request head)"
+          abort
+        end
+      end
+      options[:head] ||= (tracked_branch || current_branch).short_name
+
+      # when no tracking, assume remote branch is published under active user's fork
+      user = github_user(true, head_project.host)
+      if head_project.owner != user and !tracked_branch and !explicit_owner
+        head_project = head_project.owned_by(user)
+      end
+
+      remote_branch = "#{head_project.remote}/#{options[:head]}"
+      options[:head] = "#{head_project.owner}:#{options[:head]}"
+
+      if !force and tracked_branch and local_commits = git_command("rev-list --cherry #{remote_branch}...")
+        $stderr.puts "Aborted: #{local_commits.split("\n").size} commits are not yet pushed to #{remote_branch}"
+        warn "(use `-f` to force submit a pull request anyway)"
+        abort
+      end
+
+      if args.noop?
+        puts "Would reqest a pull to #{base_project.owner}:#{options[:base]} from #{options[:head]}"
+        exit
+      end
+
+      unless options[:title] or options[:issue]
+        base_branch = "#{base_project.remote}/#{options[:base]}"
+        changes = git_command "log --no-color --pretty=medium --cherry %s...%s" %
+          [base_branch, remote_branch]
+
+        options[:title], options[:body] = pullrequest_editmsg(changes) { |msg|
+          msg.puts "# Requesting a pull to #{base_project.owner}:#{options[:base]} from #{options[:head]}"
+          msg.puts "#"
+          msg.puts "# Write a message for this pull request. The first block"
+          msg.puts "# of text is the title and the rest is description."
+        }
+      end
+
+      pull = create_pullrequest(options)
+
+      args.executable = 'echo'
+      args.replace [pull['html_url']]
+    rescue HTTPExceptions
+      display_http_exception("creating pull request", $!.response)
+      exit 1
+    end
+  end
+
+  Hub::Runner.send :include, RunnerExtension
+  Hub::Commands.send :include, CommandsExtension
+end

data/lib/abak-flow/request.rb

@@ -0,0 +1,123 @@
+# -*- encoding: utf-8 -*-
+module Abak::Flow
+  # @TODO Сделать класс, в котором собрать общие куски из задач
+
+  program :name, 'Утилита для оформления pull request на github.com'
+  program :version, '0.0.1'
+  program :description, 'Утилита, заточенная под git-flow но с использованием github.com'
+
+  default_command :help
+  command :publish do |c|
+    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|
+      repository     = Hub::Commands.send :local_repo
+      current_branch = repository.current_branch.short_name
+      request_rules  = {
+        :feature => :develop,
+        :hotfix  => :master
+      }
+      jira_browse_url = 'http://jira.dev.apress.ru/browse/'
+
+      # Проверим, что мы не в мастере или девелопе
+      if [:master, :develop].include? current_branch.to_sym
+        say 'Нельзя делать pull request из меток master или develop'
+        exit
+      end
+
+      # Проверим, что у нас настроен upstream
+      if repository.remote_by_name('upstream').nil?
+        say 'Необходимо настроить репозиторий upstream (главный) для текущего пользователя'
+        say '=> git remote add upstream https://Developer@github.com/abak-press/sample.git'
+        exit
+      end
+
+      if args.first.to_s.empty?
+        say 'Пожалуйста, укажите в заголовке номер вашей задачи, например так:'
+        say '=> git request "PC-001"'
+        exit
+      end
+
+      # Расставим ветки согласно правилам
+      remote_branch, task = current_branch.split('/').push(nil).map(&:to_s)
+      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?
+
+      # Запушим текущую ветку на origin
+      # @TODO Может быть лучше достать дерективу конфига origin?
+      say "=> Обновляю ветку #{current_branch} на origin"
+      Hub::Runner.execute('push', repository.main_project.remote.name, current_branch)
+
+      # Запостим pull request на upstream
+      command_options = ['pull-request', args.first, '-b', base, '-h', head, '-d']
+      command_options |= ['-d', jira_browse_url + task] if task =~ /^\w+\-\d{1,}$/
+
+      say '=> Делаю pull request на upstream'
+      say Hub::Runner.execute(*command_options)
+    end
+  end
+
+  command :update do |c|
+    c.syntax      = 'git request update'
+    c.description = 'Обновить ветку на удаленном (origin) репозитории'
+
+    c.option '--branch STRING', String, 'Имя ветки, которую нужно обновить'
+
+    c.action do |args, options|
+      repository     = Hub::Commands.send :local_repo
+      current_branch = repository.current_branch.short_name
+
+      # Запушим текущую ветку на origin
+      branch = options.branch || current_branch
+      say "=> Обновляю ветку #{branch} на origin"
+      Hub::Runner.execute('push', repository.main_project.remote.name, branch)
+    end
+  end
+
+  command :done do |c|
+    c.syntax      = 'git request done'
+    c.description = 'Завершить pull request. По умолчанию удаляются ветки как локальная (local), так и удаленная (origin)'
+
+    c.option '--branch STRING', String, 'Имя ветки pull request которой нужно закрыть'
+    c.option '--all', 'Удаляет ветку в локальном репозитории и в удалнном (local + origin) (по умолчанию)'
+    c.option '--local', 'Удаляет ветку только в локальном репозитории (local)'
+    c.option '--origin', 'Удаляет ветку в удаленном репозитории (origin)'
+
+    c.action do |args, options|
+      repository     = Hub::Commands.send :local_repo
+      current_branch = repository.current_branch.short_name
+      branch         = options.branch || current_branch
+
+      type = :all
+      if [options.local, options.origin].compact.count == 1
+        type = options.local ? :local : :origin
+      end
+
+      warning = "Внимание! Alarm! Danger! Achtung\nЕсли вы удалите ветку на удаленном репозитории, а ваш pull request еще не приняли, вы рискуете потерять проделанную работу.\nВы уверены, что хотите продолжить?"
+      if [:all, :origin].include?(type)
+        say '=> Вы приняли верное решение :)' && exit unless agree("#{warning} [yes/no/y/n]:")
+      end
+
+      if [:all, :origin].include? type
+        say "=> Удаляю ветку #{branch} на origin"
+        Hub::Runner.execute('push', repository.main_project.remote.name, ':' + branch)
+      end
+
+      if [:all, :local].include? type
+        remote_branch, task = current_branch.split('/').push(nil).map(&:to_s)
+
+        say "=>  Удаляю локальную ветку #{branch}"
+        Hub::Runner.execute('checkout', 'develop')
+        Hub::Runner.execute('branch', '-D', branch)
+      end
+    end
+  end
+end

data/lib/abak-flow/version.rb

@@ -0,0 +1,5 @@
+module Abak
+  module Flow
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: abak-flow
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Strech (aka Sergey Fedorov)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-04 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hub
+  requirement: &70279720232900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70279720232900
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: &70279720232480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70279720232480
+description: Простой набор правил и комманд, заточеных для работы в git-flow с использование
+  в качестве удаленного репозитория github
+email:
+- oni.strech@gmail.com
+executables:
+- request
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- VERSION
+- abak-flow.gemspec
+- bin/request
+- lib/abak-flow.rb
+- lib/abak-flow/hub_extensions.rb
+- lib/abak-flow/request.rb
+- lib/abak-flow/version.rb
+homepage: https://github.com/Strech/abak-flow
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: abak-flow
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Совмещение 2-х подходов разработки Git-flow & Github-flow
+test_files: []