speedflow-plugin-git 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bdca85987fc6af41e69c8c68ffa4b5fd74e042dc
+  data.tar.gz: 50aafde95295f779203097cd30aed9d757141ba5
+SHA512:
+  metadata.gz: 757d1bf31386115187ef2538ae7e6edd3393cdedbbf2abff619a45941f80471e0e5a673fe58356b09862e25363968c9d71b4d550150f9ec571cd3b58de353370
+  data.tar.gz: a2335f9f9051b85af7985d1bda34cb0a7d111158f01e0caee9fbb643987c45cc99adacb8d86301a20dfe456872a0f7666ea893724c83c5c4e1d23aecaf9ea5f0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Speedflow
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Speedflow Plugin Git
+
+[![Build Status](https://travis-ci.org/speedflow/speedflow-plugin-git.svg?branch=master)](https://travis-ci.org/speedflow/speedflow-plugin-git)
+[![Gem Version](https://badge.fury.io/rb/speedflow-plugin-git.svg)](https://badge.fury.io/rb/speedflow-plugin-git)
+[![Dependency Status](https://gemnasium.com/speedflow/speedflow-plugin-git.svg)](https://gemnasium.com/speedflow/speedflow-plugin-git)
+[![Code Climate](https://codeclimate.com/github/speedflow/speedflow-plugin-git/badges/gpa.svg)](https://codeclimate.com/github/speedflow/speedflow-plugin-git)
+[![Test Coverage](https://codeclimate.com/github/speedflow/speedflow-plugin-git/badges/coverage.svg)](https://codeclimate.com/github/speedflow/speedflow-plugin-git/coverage)
+[![Inline docs](http://inch-ci.org/github/speedflow/speedflow-plugin-git.svg?branch=master)](http://inch-ci.org/github/speedflow/speedflow-plugin-git)
+
+:package: A Speedflow plugin to work with [Git](https://git-scm.com/).
+
+## How to install?
+
+`gem install speedflow-plugin-git`
+
+## How to configure?
+
+`.speedflow.yml` :
+```yml
+---
+plugins:
+  - git
+```
+
+#### Create a branch
+
+`.speedflow.yml` :
+```yml
+#...
+
+flow:
+  test:
+    - plugin: git
+      action: create_branch
+      arguments:
+        branch: ~
+        branch_from:
+          default: origin/master
+```

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'speedflow/plugin/git'
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/speedflow-plugin-git.rb

@@ -0,0 +1 @@
+require 'speedflow/plugin/git'

data/lib/speedflow/plugin/git.rb

@@ -0,0 +1,5 @@
+require 'speedflow'
+require 'speedflow/plugin/git/version'
+require 'speedflow/plugin/git/plugin'
+require 'speedflow/plugin/git/prompt'
+require 'speedflow/plugin/git/client'

data/lib/speedflow/plugin/git/client.rb

@@ -0,0 +1,82 @@
+require 'git'
+
+module Speedflow
+  module Plugin
+    module Git
+      # Git client
+      class Client
+        # @return [Prompt] Prompt.
+        attr_writer :prompt
+
+        # @return [Git::Client] Git client.
+        attr_writer :git_client
+
+        # Initialize.
+        #
+        # config - Speedflow::Plugin::Git::Configuration instance.
+        # prompt - Speedflow::Plugin::Git::Prompt instance.
+        #
+        # Examples
+        #
+        #    Client.new({}, Speedflow::Plugin::Git::Prompt.new)
+        #    # => <Speedflow::Plugin::Git::Client>
+        #
+        # Returns nothing.
+        def initialize(config, prompt)
+          @config = config
+          @prompt = prompt
+        end
+
+        # Public: Create branch.
+        #
+        # branch      - Branch.
+        # branch_from - Branch from.
+        #
+        # Returns Git::Branch.
+        def create_branch(branch, branch_from)
+          safe do
+            git = git_client.open('.')
+            git.branch(branch_from).checkout unless branch_from.empty?
+            git.branch(branch).checkout
+          end
+        end
+
+        # Public: Branches.
+        #
+        # branch_type - String of type (:local or :remote)
+        #
+        # Returns Array of local branches.
+        def branches(branch_type = :local)
+          safe do
+            git = git_client.open('.')
+            git.branches.send(branch_type)
+          end
+        end
+
+        # Public: Safe process Git action.
+        #
+        # Returns nothing.
+        def safe
+          yield
+        rescue StandardError => exception
+          prompt.errors exception
+          abort
+        end
+
+        # Public: Git client.
+        #
+        # Returns ::Git instance.
+        def git_client
+          @git_client ||= ::Git
+        end
+
+        # Public: Prompt.
+        #
+        # Returns ::Speedflow::Plugin::Git::Prompt instance.
+        def prompt
+          @prompt ||= ::Speedflow::Plugin::Git::Prompt.new
+        end
+      end
+    end
+  end
+end

data/lib/speedflow/plugin/git/plugin.rb

@@ -0,0 +1,73 @@
+module Speedflow
+  module Plugin
+    module Git
+      # Plugin core
+      class Plugin < Speedflow::Plugin::Abstract
+        # @return [Prompt] Plugin prompt.
+        attr_writer :prompt
+
+        # @return [Client] Plugin client.
+        attr_writer :client
+
+        # Public: Constructor
+        #
+        # config - Speedflow::Plugin::Configuration object.
+        # prompt - Speedflow::Plugin::Prompt object.
+        #
+        # Examples
+        #
+        #    Manager.new(
+        #      <Speedflow::Plugin::Configuration.new({})>,
+        #      <Speedflow::Plugin::Prompt.new>)
+        #    # => <Speedflow::Plugin::Abstract>
+        #
+        # Returns nothing.
+        def initialize(config, _)
+          super(config, Prompt.new)
+        end
+
+        # Public: Create branch.
+        #
+        # Returns Hash of branch.
+        def action_create_branch
+          branch = config.by_input('branch')
+          branch = prompt.ask_branch if branch.empty?
+
+          branch_from = config.by_input('branch_from')
+          branch_from = action_search_branch['branch'] if branch_from.empty?
+
+          client.create_branch(branch, branch_from)
+
+          prompt.ok '[GIT] Branch successful created: ' \
+                    "'#{branch}' from '#{branch_from}'."
+
+          { 'branch' => branch, 'branch_from' => branch_from }
+        end
+
+        # Public: Search branch.
+        #
+        # Returns Hash of branch.
+        def action_search_branch
+          branch = prompt.branch(client.branches(prompt.branch_type))
+          action_search_branch if branch == :retry
+
+          { 'branch' => branch }
+        end
+
+        # Public: Plugin client.
+        #
+        # Returns Client instance.
+        def client
+          @client ||= Client.new(@config, @prompt)
+        end
+
+        # Public: Plugin prompt.
+        #
+        # Returns Prompt instance.
+        def prompt
+          @prompt ||= Prompt.new
+        end
+      end
+    end
+  end
+end

data/lib/speedflow/plugin/git/prompt.rb

@@ -0,0 +1,73 @@
+module Speedflow
+  module Plugin
+    module Git
+      # Plugin prompt
+      class Prompt
+        # @return [<Speedflow::Plugin::Prompt>] Plugin prompt.
+        attr_writer :prompt
+
+        # Public: Prompt ask branch.
+        #
+        # Returns String of title.
+        def ask_branch
+          ask('What is the name of branch?', required: true)
+        end
+
+        # Public: Prompt branch.
+        #
+        # branches - List of branches.
+        #
+        # Returns branch name.
+        def branch(branches)
+          prompt.select('Choose the branch:', required: true) do |menu|
+            menu.choice 'Re-select branch type', :retry
+            branches.each do |branch|
+              next if branch.name.include? '->'
+              branch_full = branch.name
+              branch_full = "#{branch.remote}/#{branch.name}" if branch.remote
+              menu.choice branch.name, branch_full
+            end
+          end
+        end
+
+        # Public: Prompt branch type.
+        #
+        # Returns String of type (:local or :remote).
+        def branch_type
+          prompt.select('Choose the branch type:', required: true) do |menu|
+            menu.choice 'Local branches', :local
+            menu.choice 'Remote branches', :remote
+          end
+        end
+
+        # Public: Errors from Git exception.
+        #
+        # exception - Git exception.
+        #
+        # Returns nothing.
+        def errors(exception)
+          prompt.error 'Git errors'
+          prompt.warn exception.message
+        end
+
+        # Delegate.
+        #
+        # method - Method.
+        # args   - Arguments.
+        # block  - Block.
+        #
+        # Returns wathever.
+        def method_missing(method, *args, &block)
+          prompt.send(method, *args, &block)
+        end
+
+        # Public: TTY prompt.
+        #
+        # Returns ::Speedflow::Plugin::Prompt instance.
+        def prompt
+          @prompt ||= ::Speedflow::Plugin::Prompt.new
+        end
+      end
+    end
+  end
+end

data/lib/speedflow/plugin/git/version.rb

@@ -0,0 +1,7 @@
+module Speedflow
+  module Plugin
+    module Git
+      VERSION = '0.2.0'.freeze
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'simplecov'
+require 'codeclimate-test-reporter'
+
+CodeClimate::TestReporter.start if ENV['CODECLIMATE_REPO_TOKEN']
+
+SimpleCov.start do
+  formatter SimpleCov::Formatter::MultiFormatter.new(
+    [SimpleCov::Formatter::HTMLFormatter, CodeClimate::TestReporter::Formatter])
+end
+
+require 'speedflow/plugin/git'

data/spec/speedflow/plugin/git/client_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Speedflow::Plugin::Git::Client do
+  let(:client) do
+    client = ::Speedflow::Plugin::Git::Client.new(double, double)
+    client.git_client = double
+    client
+  end
+
+  it '.create_branch' do
+    allow(client.git_client)
+      .to receive_message_chain(:open, :branch, :checkout)
+
+    client.create_branch('test', 'origin/master')
+  end
+
+  it '.branches' do
+    allow(client.git_client)
+      .to receive_message_chain(:open, :branches, :send)
+
+    client.branches
+  end
+
+  it '.safe' do
+    allow(client.prompt)
+      .to receive(:error)
+      .with('Git errors')
+    allow(client.prompt)
+      .to receive(:errors)
+    e = expect do
+      client.safe do
+        raise StandardError.new('Error'), '...'
+      end
+    end
+    e.to raise_error(SystemExit)
+  end
+end

data/spec/speedflow/plugin/git/plugin_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+describe Speedflow::Plugin::Git::Plugin do
+  let(:plugin) do
+    plugin = ::Speedflow::Plugin::Git::Plugin.new(double, double)
+    plugin.client = double
+    plugin
+  end
+
+  it '.action_create_branch' do
+    allow(plugin.config)
+      .to receive(:by_input)
+      .with('branch')
+      .and_return('')
+
+    allow(plugin.prompt)
+      .to receive(:ask_branch)
+      .and_return('master')
+
+    allow(plugin.prompt)
+      .to receive(:ask)
+      .with('What is the name of branch?', required: true)
+      .and_return('master')
+
+    allow(plugin.prompt)
+      .to receive(:branch_type)
+      .and_return(:remote)
+
+    allow(plugin.client)
+      .to receive(:branches)
+      .with(:remote)
+      .and_return(%w(master bar baz))
+
+    allow(plugin.prompt)
+      .to receive(:branch)
+      .with(%w(master bar baz))
+      .and_return('master')
+
+    allow(plugin.config)
+      .to receive(:by_input)
+      .with('branch_from')
+      .and_return('origin/master')
+
+    allow(plugin.prompt)
+      .to receive(:ok)
+      .with("[GIT] Branch successful created: 'master' from 'origin/master'.")
+
+    allow(plugin.client)
+      .to receive(:create_branch)
+      .with('master', 'origin/master')
+
+    expected_hash = { 'branch' => 'master', 'branch_from' => 'origin/master' }
+    expect(plugin.action_create_branch)
+      .to eq expected_hash
+  end
+
+  it '.action_search_branch' do
+    allow(plugin.prompt)
+      .to receive(:branch_type)
+      .and_return(:local)
+
+    allow(plugin.client)
+      .to receive(:branches)
+      .with(:local)
+      .and_return(%w(master foo bar :retry))
+
+    allow(plugin.prompt)
+      .to receive(:branch)
+      .with(%w(foo bar :retry))
+      .and_return(:retry)
+
+    allow(plugin.prompt)
+      .to receive(:branch_type)
+      .and_return(:local)
+
+    allow(plugin.client)
+      .to receive(:branches)
+      .with(:local)
+      .and_return(%w(master foo bar :retry))
+
+    allow(plugin.prompt)
+      .to receive(:branch)
+      .with(%w(master foo bar :retry))
+      .and_return('master')
+
+    expected_hash = { 'branch' => 'master' }
+    expect(plugin.action_search_branch)
+      .to eq expected_hash
+  end
+end

data/spec/speedflow/plugin/git/prompt_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe Speedflow::Plugin::Git::Prompt do
+  let(:prompt) do
+    prompt = ::Speedflow::Plugin::Git::Prompt.new
+    prompt.prompt = double
+    prompt
+  end
+  let(:exception) do
+    double(message: "Error\n")
+  end
+
+  it '.ok' do
+    allow(prompt.prompt)
+      .to receive(:ok)
+      .with('Test')
+
+    expect(prompt.ok('Test'))
+  end
+
+  it '.ask_branch' do
+    allow(prompt.prompt)
+      .to receive(:ask)
+      .with('What is the name of branch?', required: true)
+      .and_return('cool')
+
+    expect(prompt.ask_branch)
+      .to eq 'cool'
+  end
+
+  it '.branch' do
+    allow(prompt.prompt)
+      .to receive(:select)
+      .with('Choose the branch:', required: true)
+      .and_yield(double(choice: nil))
+      .and_return 'master'
+
+    branches = [
+      double(name: 'master', remote: ''),
+      double(name: 'HEAD -> origin/master', remote: 'origin')
+    ]
+
+    expect(prompt.branch(branches))
+      .to eq 'master'
+
+    # TODO: Complete specs with arrowed branches
+  end
+
+  it '.branch_type' do
+    allow(prompt.prompt)
+      .to receive(:select)
+      .with('Choose the branch type:', required: true)
+      .and_yield(double(choice: nil))
+      .and_return :remote
+
+    expect(prompt.branch_type)
+      .to eq :remote
+  end
+
+  it '.errors' do
+    allow(prompt.prompt)
+      .to receive(:error).with('Git errors')
+    allow(prompt.prompt)
+      .to receive(:warn).with("Error\n")
+
+    expect(prompt.errors(exception))
+  end
+end

data/spec/speedflow/plugin/git_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Speedflow::Plugin::Git do
+  it 'has a version number' do
+    expect(Speedflow::Plugin::Git::VERSION).not_to be nil
+  end
+end

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification
+name: speedflow-plugin-git
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Julien Breux
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: speedflow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: A Speedflow plugin for Git.
+email:
+- julien.breux@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/console
+- bin/setup
+- lib/speedflow-plugin-git.rb
+- lib/speedflow/plugin/git.rb
+- lib/speedflow/plugin/git/client.rb
+- lib/speedflow/plugin/git/plugin.rb
+- lib/speedflow/plugin/git/prompt.rb
+- lib/speedflow/plugin/git/version.rb
+- spec/spec_helper.rb
+- spec/speedflow/plugin/git/client_spec.rb
+- spec/speedflow/plugin/git/plugin_spec.rb
+- spec/speedflow/plugin/git/prompt_spec.rb
+- spec/speedflow/plugin/git_spec.rb
+homepage: https://github.com/speedflow/speedflow-plugin-git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: A Speedflow plugin for Git.
+test_files: []