abak-flow 0.3.2 → 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MGU3ZjFmYjE3OWMyMDM4NTI1NWJjYzQxZDFjZTM5YmQ2YmQ0M2Q1ZQ==
+  data.tar.gz: !binary |-
+    NjViMDJhOWE1ZmRhMTU0ZjZkNjVkNjhlYTBiZmE0ZTM1NjgyYzlkZA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NWE0M2ZjYmJkMDQ0MWU4OWUxZDBiODk4NTU0N2Q2M2IyZTU4ZGIyZTgxZTBl
+    NGEyY2M4YTZjMjI4ZmZjY2FlZjJjMTZiMzg0YThmYTBkN2E1ODA2NzVjYjc2
+    MjFiZDlkZDdiMmU1ODExNzJiNzBhYzA0MDE1ZWNjMTIxMjViOWI=
+  data.tar.gz: !binary |-
+    MzZkYmQ0OThkMDcxYjFlNmI4MTdlYmRjOTY1NzBmNDYxNTI3Mjc5M2M5ZjVh
+    YmM2ZDJlM2ZhOTk0YjQ5MWJkZmVkNmVkY2I2MmMwOTYxMTQyOWZhOTBiMGEw
+    YzVmYjYzNjY4ZDZiOGZmYjEyMzFkOTM4MGFhYjI1YjgwZTQ1ZGU=

data/.gitignore

@@ -1,8 +1,11 @@
 *.gem
+.ruby-*
 .bundle
 Gemfile.lock
 pkg/*
 tmp/
 .idea/
+coverage/
 .rvmrc
 .DS_Store
+tmtags*

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+branches:
+  only:
+    - release-1.0
+bundler_args: --without linux mac

data/Gemfile

@@ -1,3 +1,12 @@
 source "https://rubygems.org"
 
-gemspec
+gemspec
+
+group :linux do
+  gem "libnotify"
+  gem "rb-inotify"
+end
+
+group :mac do
+  gem "terminal-notifier-guard"
+end

data/README.md

@@ -2,7 +2,9 @@ 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)**
+**Начиная с версии 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 использует следующий набор веток:
@@ -25,10 +27,10 @@ Github-flow же наоборот ведет основную разработк
 
 # Установка
 
-    $ gem install abak-flow
+    $ gem install abak-flow -v 1.0.0
     $ git config --global alias.request '!request'
-    $ git config --global abak.apiuser YOUR_GITHUB_MAIL@gmail.com
-    $ git config --global abak.apitoken 0123456789YOUR_GITHUB_API_TOKEN
+    $ git config --global abak-flow.oauth-user YOUR_GITHUB_MAIL@gmail.com
+    $ git config --global abak-flow.oauth-token 0123456789YOUR_GITHUB_API_TOKEN
     $ git remote add upstream git://github.com/GITHUB_PROJECT_USER/GITHUB_PROJECT_NAME.git
     
 ### А если я использую прокси, как быть?
@@ -40,13 +42,13 @@ Github-flow же наоборот ведет основную разработк
 
 ---
 
-**Заметьте:** В конфиге git, значением *abak.apiuser* должен являться тот email адрес, под которым вы заходите на github
+**Заметьте:** В конфиге git, значением *abak.oauth-user* должен являться тот email адрес, под которым вы заходите на github
 
 **Обратите внимание:** В данном контексте под **upstream** подразумевается адрес репозитория в который будут оформляться pull request. А репозиторием **origin** будет являться ваш форк 
 
 # С чего начать?
 
-    $ git request readycheck
+    $ git request checkup
 
 или
     
@@ -58,7 +60,7 @@ Github-flow же наоборот ведет основную разработк
 ### Самый простой способ начать новую задачу:
 
     $ git checkout develop
-    $ git request feature 'TASK-001'
+    $ git flow feature start 'TASK-001'
     $ touch 'hello.txt' && echo 'Hello world!' > hello.txt
     $ git commit -a -m 'Hello world commit'
     $ git request publish
@@ -68,7 +70,7 @@ Github-flow же наоборот ведет основную разработк
 Теперь то же самое, только словами:
 
 * Переключимся в ветку develop
-* Abak-flow создаст ветку, пригодную для оформления pull request (правила именования и правила самого реквеста)
+* git-flow создаст ветку, пригодную для оформления pull request (правила именования и правила самого реквеста)
 * Простое создание нового файла
 * Git процедуры добавления своих изменений в репозиторий
 * Затем публикация вашей ветки на вашем форке (если таковая уже есть, то просто обновление), затем оформление pull request из этой ветки в соответствующую правилам ветку на upstream (в данном случае это будет ветка develop)
@@ -76,36 +78,17 @@ Github-flow же наоборот ведет основную разработк
 Для задач, которые должны быть выполнены в виде hotfix принцип тот же:
 
     $ git checkout master
-    $ git request hotfix 'TASK-001'
+    $ git flow hotfix start 'TASK-001'
     $ …
     $ git request publish
 
 *На самом деле переключаться на master или develop в самом начале вовсе не обязательно, этот шаг был приведен для пущей ясности*
 
-### Обновление ветки на удаленном репозитории:
-
-    $ git checkout feature/TASK-001
-    $ git request update
-
-### Завершение текущей задачи:
-Вообще, завершать задачу лучше только после того, как ваш pull request был принят. Почему? На самом деле по ряду причин. По умолчанию эта команда удаляет как вашу текущую ветку с задачей в локальном репозитории и в добавок ко всему - на вашем удаленном репозитории (форке)
-
-    $ git checkout feature/TASK-001
-    $ git request done 
-
-Чтобы оставить какую либо ветку в живых возможно напрямую указать, какую копию ветки **удалить**, локальную или же удаленную (на origin)
-
-    $ git checkout feature/TASK-001
-    $ git request done --origin
-
-Или же так
-
-    $ git checkout feature/TASK-001
-    $ git request done --local
-
 ## Маленькие хитрости
 Если сразу правильно именовать ветки, т.е ветку с задачей создавать с именем, такого формата TASK-001, то, в описание pull request автоматически вставится ссылка на задачу в jira, а в имя pull request сразу вставится название, состоящее из имени задачи, т.е TASK-001
 
+Если делать реквест из ветки не соответствующей формату TASK-001, то в название подставится последний commit message. Если вы считаете, что нужно указать, что-то другое - всегда можно воспользоваться опцией `--title`
+
 ## А помощь?
 Многие команды имеют какие-то дополнительные опции. Но они нужны только в экзотических случаях. Но при любом раскладе подсказку и тонкий намек всегда можно получить воспользовавших такой командой:
 

data/Rakefile

@@ -1 +1,26 @@
 require "bundler/gem_tasks"
+
+require "yard"
+require "yard-tomdoc"
+require "cane/rake_task"
+require "rspec/core/rake_task"
+
+desc "Ready check"
+task default: [:quality, :coverage, :doc]
+
+RSpec::Core::RakeTask.new(:coverage) do |rspec|
+  ENV["COVERAGE"] = "true"
+end
+
+Cane::RakeTask.new(:quality) do |cane|
+  cane.abc_max = 15
+  cane.abc_glob = cane.style_glob = cane.doc_glob = "{lib}/abak-flow/*.rb"
+  cane.style_exclude = %w({lib}/abak-flow/request.rb)
+  cane.style_measure = 120
+  cane.parallel = false
+end
+
+YARD::Rake::YardocTask.new(:doc) do |yard|
+  yard.files   = %w({apps,models,lib}/**/*.rb)
+  yard.options = %w(--embed-mixins --protected --plugin tomdoc)
+end

data/VERSION

@@ -1 +1 @@
-0.3.2
+1.0

data/abak-flow.gemspec

@@ -1,24 +1,28 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path('../lib', __FILE__)
-require 'abak-flow/version'
+# coding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
 
-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}
+require "abak-flow/version"
 
-  s.rubyforge_project = 'abak-flow'
+Gem::Specification.new do |gem|
+  gem.name        = "abak-flow"
+  gem.version     = Abak::Flow::VERSION
+  gem.authors     = ["Strech (aka Sergey Fedorov)"]
+  gem.email       = ["oni.strech@gmail.com"]
+  gem.homepage    = "https://github.com/Strech/abak-flow"
+  gem.summary     = "Совмещение 2-х подходов разработки Git-flow & Github-flow"
+  gem.description = "Простой набор правил и комманд, заточеных для работы в git-flow с использование в качестве удаленного репозитория github"
 
-  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']
+  gem.rubyforge_project = "abak-flow"
 
-  s.add_runtime_dependency 'hub', '~> 1.10.3'
-  s.add_runtime_dependency 'commander', '~> 4.1.2'
-  s.add_runtime_dependency 'octokit', '~> 1.19.0'
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  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 "git",       "~> 1.2.5"
+  gem.add_runtime_dependency "commander", ">= 4.1.3"
+  gem.add_runtime_dependency "ruler",     ">= 1.4.2"
+  gem.add_runtime_dependency "i18n",      ">= 0.6.1"
+  gem.add_runtime_dependency "ansi",      ">= 1.4.3"
 end

data/bin/request

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

data/lib/abak-flow/branch.rb

@@ -0,0 +1,108 @@
+# coding: utf-8
+
+module Abak::Flow
+  class Branch
+    FOLDER_HOTFIX  = "hotfix".freeze
+    FOLDER_FEATURE = "feature".freeze
+    TASK_FORMAT    = /^\w+\-\d{1,}$/.freeze
+
+    DEVELOPMENT = "develop".freeze
+    MASTER      = "master".freeze
+
+    MAPPING = {
+      FOLDER_HOTFIX  => MASTER,
+      FOLDER_FEATURE => DEVELOPMENT
+    }.freeze
+
+    def initialize(branch, manager)
+      @manager = manager
+      @branch = branch.is_a?(Git::Branch) ? branch
+                                          : manager.git.branch(branch)
+    end
+
+    def name
+      @branch.full
+    end
+
+    def message
+      @branch.gcommit.message
+    end
+
+    def folder
+      split_prefix_and_task.first
+    end
+
+    def task
+      split_prefix_and_task.last
+    end
+
+    def compare_link(branch)
+      diff = "#{@manager.repository.upstream.owner}:#{branch}...#{@branch}"
+
+      File.join [
+        @manager.github.web_endpoint,
+        @manager.repository.origin.to_s,
+        "compare", diff
+      ]
+    end
+
+    def update
+      origin = @manager.repository.origin.repo
+      @manager.git.push(origin, @branch)
+    end
+
+    def pick_up_base_name
+      mappable? ? MAPPING[folder]
+                : name
+    end
+
+    def pick_up_title
+      tracker_task? ? task
+                    : message
+    end
+
+    # TODO : Вынести в i18n
+    def pick_up_body
+      tracker_task? ? "http://jira.railsc.ru/browse/#{task}"
+                    : nil
+    end
+
+    def hotfix?
+      folder == FOLDER_HOTFIX
+    end
+
+    def feature?
+      folder == FOLDER_FEATURE
+    end
+
+    def tracker_task?
+      !(task =~ TASK_FORMAT).nil?
+    end
+
+    def mappable?
+      hotfix? || feature?
+    end
+
+    def current?
+      @branch.current
+    end
+
+    def valid?
+      !@branch.name.empty?
+    end
+
+    def to_s
+      @branch.to_s
+    end
+
+    private
+    def split_prefix_and_task
+      return @folder_and_task if defined? @folder_and_task
+
+      matches = name.match(/^(?<prefix>.+)\/(?<task>.+)$/)
+
+      @folder_and_task = matches.nil? ? [nil, nil]
+                                      : [matches[:prefix], matches[:task]]
+    end
+  end
+end

data/lib/abak-flow/branches.rb

@@ -0,0 +1,68 @@
+# coding: utf-8
+#
+# Wrapper class for git branches.
+# Provides access to git branches and also defines current_branch
+module Abak::Flow
+  module Branches
+    extend Forwardable
+
+    def_delegator "Abak::Flow::Git.instance", :git
+
+    def self.current_branch
+      Branch.new git.branches[git.current_branch]
+    end
+
+    # ==========================================================================
+    # TODO : Refactor
+    # 3. Statistics & Cleaning
+    #
+    # => PullRequest.garbage
+    # => PullRequest.clean
+    # => PullRequest.clean(hard: true)
+    def self.garbage
+      Project.init
+      [Project.upstream.repo, Project.origin.repo].map(&:fetch)
+
+      branches = GithubClient.connection.branches(Project.origin.to_s)
+                             .reject { |branch| %w(master develop).include? branch.name }
+
+      messages = Messages.new "pull_request.garbage"
+      messages << [:collected_branches, {count: branches.count}]
+
+      branches.each_with_index do |branch, index|
+
+        # WRONG PREFIX
+        upstream_branch = Git.command_lines("branch", ["-r", "--contain", branch.commit.sha])
+                             .select { |branches| branches.include? "upstream/#{branch.prefix}" }
+
+        local_sha = git.branches[branch.name] ? git.branches[branch.name].gcommit.sha : ""
+
+        statuses = {
+          branch_unused: upstream_branch.empty?,
+          branch_differ: !local_sha.empty? && local_sha != branch.commit.sha,
+          branch_missing: local_sha.empty?
+        }
+
+        unless statuses.values.inject &:|
+          messages << [:deletion_allowed, {index: index, branch_name: branch.name}]
+          next
+        end
+
+        diagnoses = statuses.select { |_, bool| bool }.
+                             map { |name, _| messages.t name }.
+                             map { |msg| "   ↪ #{msg}" }.
+                             join("\n")
+
+        if statuses.select { |_, bool| bool }.keys == [:missing]
+          messages << [:deletion_possibly, {index: index, branch_name: branch.name, diagnoses: diagnoses}]
+        else
+          messages << [:deletion_restricted, {index: index, branch_name: branch.name, diagnoses: diagnoses}]
+        end
+      end
+
+      messages
+    end
+
+
+  end
+end

data/lib/abak-flow/configuration.rb

@@ -0,0 +1,67 @@
+# coding: utf-8
+require "i18n"
+require "ruler"
+
+module Abak::Flow
+  class Configuration
+    include Ruler
+
+    OPTIONS = [:oauth_user, :oauth_token, :locale, :http_proxy].freeze
+    LOCALE_FILES = File.join(File.dirname(__FILE__), "locales/*.{rb,yml}").freeze
+
+    attr_reader :errors
+
+    def initialize(manager)
+      @manager = manager
+      @errors = []
+
+      configure!
+    end
+
+    def ready?
+      @errors = []
+
+      multi_ruleset do
+        fact(:oauth_user_not_setup)  { oauth_user.nil? }
+        fact(:oauth_token_not_setup) { oauth_token.nil? }
+
+        rule([:oauth_user_not_setup])  { @errors << I18n.t("configuration.errors.oauth_user_not_setup") }
+        rule([:oauth_token_not_setup]) { @errors << I18n.t("configuration.errors.oauth_token_not_setup") }
+      end
+
+      @errors.empty? ? true : false
+    end
+
+    def display_name
+      I18n.t("configuration.name")
+    end
+
+    private
+    def configure!
+      load_gitconfig
+      setup_locale
+    end
+
+    def setup_locale
+      I18n.load_path += Dir.glob(LOCALE_FILES)
+      I18n.locale = locale
+    end
+
+    def load_gitconfig
+      git_config = @manager.git.config.select { |k, _| k.include? "abak-flow." }
+                               .map { |k,v| [to_method_name(k), v] }
+
+      config = Hash[git_config]
+      config[:locale] ||= "en"
+      config[:http_proxy] ||= ENV["http_proxy"] || ENV["HTTP_PROXY"]
+
+      OPTIONS.each do |name|
+        define_singleton_method(name) { config[name] }
+      end
+    end
+
+    def to_method_name(name)
+      name.sub(/abak-flow./, "").gsub(/\W/, "_").to_sym
+    end
+  end
+end

data/lib/abak-flow/locales/en.yml

@@ -0,0 +1,32 @@
+en:
+  configuration:
+    name: Configuration
+    errors:
+      oauth_user_not_setup: Options oauth_user not setted
+      oauth_token_not_setup: Options oauth_token not setted
+    recommendations: "Check [abak-flow] section in ~/.gitcofig file"
+
+  repository:
+    name: Repository
+    errors:
+      origin_not_setup: Repository with name 'origin' not found
+      upstream_not_setup: Repository with name 'upstream' not found
+    recommendations: "Check .git/cofig file"
+
+  pull_request:
+    name: Pull Request
+
+  commands:
+    checkup:
+      fail: You are not prepared!
+      success: "Congratulations, you are ready to ROCK :)"
+    compare:
+      fail: Something goes wrong!
+      updating: "Updating %{branch} → %{upstream}"
+      diverging: "Branches may diverging\nAdvice: switch to branch '%{branch}' and retry operation"
+    publish:
+      fail: Something goes wrong!
+      success: "Pull request successfuly created %{link}"
+      requesting: "Creating pull request %{branch} → %{upstream}"
+      updating: "Updating %{branch} → %{upstream}"
+      nothing: I have nothing to say ...

data/lib/abak-flow/locales/ru.yml

@@ -0,0 +1,32 @@
+ru:
+  configuration:
+    name: Корфигурация
+    errors:
+      oauth_user_not_setup: Не установлена опция oauth_user
+      oauth_token_not_setup: Не установлена опция oauth_token
+    recommendations: "Проверьте секцию [abak-flow] в файле ~/.gitcofig"
+
+  repository:
+    name: Репозиторий
+    errors:
+      origin_not_setup: Репозиторий с именем 'origin' не найден
+      upstream_not_setup: Репозиторий с именем 'upstream' не найден
+    recommendations: Проверьте файл .git/cofig
+
+  pull_request:
+    name: Пулл реквест
+
+  commands:
+    checkup:
+      fail: "Вы не готовы!"
+      success: "Поздравляем, вы готовы чтобы жечь :)"
+    compare:
+      fail: Что-то пошло не так!
+      updating: "Обновление %{branch} → %{upstream}"
+      diverging: "Ветки могут расходиться.\nСовет: переключитесь в ветку '%{branch}' и повторите операцию"
+    publish:
+      fail: Что-то пошло не так!
+      success: "Пулл реквест успешно создан %{link}"
+      requesting: "Создание пулл реквеста %{branch} → %{upstream}"
+      updating: "Обновление %{branch} → %{upstream}"
+      nothing: Мне нечего добавить ...

data/lib/abak-flow/manager.rb

@@ -0,0 +1,35 @@
+# coding: utf-8
+require "git"
+require "octokit"
+
+module Abak::Flow
+  class Manager
+
+    def initialize
+      # preload dependencies
+      configuration
+      repository
+
+      yield self if block_given?
+    end
+
+    def configuration
+      @configuration ||= Configuration.new(self)
+    end
+
+    def repository
+      @repository ||= Repository.new(self)
+    end
+
+    def github
+      @github ||= Octokit::Client.new(login: configuration.oauth_user,
+        oauth_token: configuration.oauth_token,
+        proxy: configuration.http_proxy)
+    end
+
+    def git
+      @git ||= Git.open(".")
+    end
+
+  end
+end

data/lib/abak-flow/messages.rb

@@ -0,0 +1,86 @@
+# coding : utf-8
+require "i18n"
+
+# TODO : Нужен простой метод, для перевода без скоупа
+module Abak::Flow
+  class Messages
+    extend Forwardable
+
+    attr_reader :scope, :elements
+
+    def initialize(scope)
+      Configuration.instance
+
+      @scope = scope
+      @elements = []
+    end
+
+    # Iterate elements from locale scope (translating online)
+    #
+    # Returns nothing
+    def each
+      raise ArgumentError, "No block given" unless block_given?
+
+      elements.each do |key|
+        yield translate(key)
+      end
+    end
+
+    # Put item to elements
+    #
+    # Returns Symbol
+    def push(element)
+      @elements << element
+    end
+    alias :<< :push
+
+    # section header from locale scope
+    #
+    # Returns String
+    def header
+      translate :header
+    end
+
+    # Print all elements from locale scope without header
+    #
+    # Returns Symbol
+    def to_s
+      return "" if elements.empty?
+
+      elements.collect { |element| translate *element } * "\n"
+    end
+
+    def print
+      return "" if elements.empty?
+
+      all_elements = []
+      elements.each_with_index do |element, index|
+        all_elements << "#{index + 1}. #{translate(*element)}"
+      end
+
+      all_elements * "\n"
+    end
+
+    # Print section header from locale scope and all elements from scope
+    #
+    # Returns String
+    def pretty_print
+      return "" if elements.empty?
+
+      [header, print] * "\n\n"
+    end
+    alias :pp :pretty_print
+
+    def translate(key, options = {})
+      I18n.t key, {scope: scope}.merge!(options)
+    end
+    alias :t :translate
+
+    def purge!
+      @elements = []
+    end
+
+    private
+    def_delegator :elements, :empty?
+  end
+end