thegarage-gitx 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0cd1a0eaf545d914d7275da4599fcee5c7dc3284
-  data.tar.gz: 8e2c239161413fb79f72a1624ceae554bc599a63
+  metadata.gz: 2e53179bded6c6d5e54e69a8bacb3116ffcd411e
+  data.tar.gz: 770a7742c1daec8aafb3b8dee9291f3455498161
 SHA512:
-  metadata.gz: f697b405d674d513a0df4dc848fd4f2ff2e5bf06b14d1e17593de8057396bb3a174e5b27f73a5de2513a28ef67d5df8ba41eec1ebe4286f69ed14f1bb0b24815
-  data.tar.gz: 615d7875d46b07da53f74b334177ef85292cefa2a7cf3d0892112b215a6b3764008608b3786ba8517ea7060458430c2a2a63d1317e4f60d954bcda552c648ee5
+  metadata.gz: 80522f4bbe1c40bb3078b74f945f5921c10797bec6f2ea5f7cf659e2af9e0cceb6fde07c0f71919e4377914afe3f402cc2e00d9f5612a816d0d793136ea23fc1
+  data.tar.gz: 49e817eb55e0efb84e8feaa93c0c2eced2c3f791472510f88ed92dd04a316b00ae82ae3fa6f20aebcfe659bd588501463c75c530d74ac4c913769bc7daff4aff

data/lib/thegarage/gitx/cli.rb

@@ -1,6 +1,7 @@
 require "thor"
 require 'rest_client'
 require 'thegarage/gitx'
+require 'thegarage/gitx/github'
 
 module Thegarage
   module Gitx
@@ -8,18 +9,9 @@ module Thegarage
       include Thor::Actions
       add_runtime_options!
 
-      include Thegarage::Gitx
       include Thegarage::Gitx::Git
-      include Thegarage::Gitx::Github
 
       TAGGABLE_BRANCHES = %w(master staging)
-      PULL_REQUEST_FOOTER = <<-EOS.dedent
-        # Pull Request Protips
-        # Include description of how this change accomplishes the task at hand.
-        # Use GitHub flavored Markdown http://github.github.com/github-flavored-markdown/
-        # Review CONTRIBUTING.md for recommendations of artifacts, links, images, screencasts, etc.
-        # NOTE: this footer will automatically be stripped from the pull request.
-      EOS
 
       method_option :trace, :type => :boolean, :aliases => '-v'
       def initialize(*args)
@@ -33,19 +25,10 @@ module Thegarage
       method_option :assignee, :type => :string, :aliases => '-a', :desc => 'pull request assignee'
       # @see http://developer.github.com/v3/pulls/
       def reviewrequest
-        fail 'Github authorization token not found' unless authorization_token
         update
 
-        changelog = run_cmd "git log #{BASE_BRANCH}...#{current_branch} --no-merges --pretty=format:'* %s%n%b'"
-        description_template = []
-        description_template << options[:description]
-        description_template << "\n"
-        description_template << '### Changelog'
-        description_template << changelog
-        description_template << PULL_REQUEST_FOOTER
-
-        description = editor_input(description_template.join("\n"))
-        url = create_pull_request description, options[:assignee]
+        changelog = run_cmd "git log #{Thegarage::Gitx::BASE_BRANCH}...#{current_branch} --no-merges --pretty=format:'* %s%n%b'"
+        url = github.create_pull_request(current_branch, changelog, options)
         say 'Pull request created: '
         say url, :green
       end
@@ -180,6 +163,10 @@ module Thegarage
       def pretend?
         options[:pretend]
       end
+
+      def github
+        @github ||= Thegarage::Gitx::Github.new(current_repo, self)
+      end
     end
   end
 end

data/lib/thegarage/gitx/git.rb

@@ -21,29 +21,6 @@ module Thegarage
         @repo ||= Grit::Repo.new(Dir.pwd)
       end
 
-      # lookup the current repository of the PWD
-      # ex: git@github.com:socialcast/thegarage/gitx.git OR https://github.com/socialcast/thegarage/gitx.git
-      def current_remote_repo
-        repo = current_repo.config['remote.origin.url']
-        repo.to_s.gsub(/\.git$/,'').split(/[:\/]/).last(2).join('/')
-      end
-
-      # @returns [String] github username (ex: 'wireframe') of the current github.user
-      # @returns empty [String] when no github.user is set on the system
-      def current_user
-        current_repo.config['github.user']
-      end
-
-      # @returns [String] auth token stored in git (current repo, user config or installed global settings)
-      def github_auth_token
-        current_repo.config['thegarage.gitx.githubauthtoken']
-      end
-
-      # store new auth token in the local project git config
-      def github_auth_token=(new_token)
-        current_repo.config['thegarage.gitx.githubauthtoken'] = new_token
-      end
-
       # retrieve a list of branches
       def branches(options = {})
         branches = []
@@ -115,55 +92,32 @@ module Thegarage
         AGGREGATE_BRANCHES.include?(branch)
       end
 
-      # launch configured editor to retreive message/string
-      def editor_input(initial_text = '')
-        require 'tempfile'
-        Tempfile.open('reviewrequest.md') do |f|
-          f << initial_text
-          f.flush
-
-          editor = ENV['EDITOR'] || 'vi'
-          flags = case editor
-          when 'mate', 'emacs', 'subl'
-            '-w'
-          when 'mvim'
-            '-f'
-          else
-            ''
-          end
-          pid = fork { exec "#{editor} #{flags} #{f.path}" }
-          Process.waitpid(pid)
-          description = File.read(f.path)
-          description.gsub(CLI::PULL_REQUEST_FOOTER, '').chomp.strip
-        end
+      def create_build_tag(branch, label)
+        timestamp = Time.now.utc.strftime '%Y-%m-%d-%H-%M-%S'
+        git_tag = "build-#{branch}-#{timestamp}"
+        run_cmd "git tag #{git_tag} -a -m '#{label}'"
+        run_cmd "git push origin #{git_tag}"
       end
-    end
-
-    def create_build_tag(branch, label)
-      timestamp = Time.now.utc.strftime '%Y-%m-%d-%H-%M-%S'
-      git_tag = "build-#{branch}-#{timestamp}"
-      run_cmd "git tag #{git_tag} -a -m '#{label}'"
-      run_cmd "git push origin #{git_tag}"
-    end
 
-    def build_tags_for_branch(branch)
-      run_cmd "git fetch --tags"
-      build_tags = run_cmd("git tag -l 'build-#{branch}-*'").split
-      build_tags.sort
-    end
+      def build_tags_for_branch(branch)
+        run_cmd "git fetch --tags"
+        build_tags = run_cmd("git tag -l 'build-#{branch}-*'").split
+        build_tags.sort
+      end
 
-    def migrations_need_to_be_reverted?
-      return false unless File.exists?('db/migrate')
-      outdated_migrations = run_cmd("git diff #{head_branch}...#{outdated_branch} --name-only db/migrate").split
-      return false if outdated_migrations.empty?
+      def migrations_need_to_be_reverted?
+        return false unless File.exists?('db/migrate')
+        outdated_migrations = run_cmd("git diff #{head_branch}...#{outdated_branch} --name-only db/migrate").split
+        return false if outdated_migrations.empty?
 
-      say "#{outdated_branch} contains migrations that may need to be reverted.  Ensure any reversable migrations are reverted on affected databases before nuking.", :red
-      say 'Example commands to revert outdated migrations:'
-      outdated_migrations.reverse.each do |migration|
-        version = File.basename(migration).split('_').first
-        say "rake db:migrate:down VERSION=#{version}"
+        say "#{outdated_branch} contains migrations that may need to be reverted.  Ensure any reversable migrations are reverted on affected databases before nuking.", :red
+        say 'Example commands to revert outdated migrations:'
+        outdated_migrations.reverse.each do |migration|
+          version = File.basename(migration).split('_').first
+          say "rake db:migrate:down VERSION=#{version}"
+        end
+        !yes?("Are you sure you want to nuke #{outdated_branch}? (y/n) ", :green)
       end
-      !yes?("Are you sure you want to nuke #{outdated_branch}? (y/n) ", :green)
     end
   end
 end

data/lib/thegarage/gitx/github.rb

@@ -1,26 +1,74 @@
-require 'thegarage/gitx/git'
 require 'rest_client'
 require 'json'
+require 'tempfile'
 
 module Thegarage
   module Gitx
-    module Github
-      include Thegarage::Gitx::Git
+    class Github
       CLIENT_NAME = 'The Garage Git eXtensions'
       CLIENT_URL = 'https://github.com/thegarage/thegarage-gitx'
+      PULL_REQUEST_FOOTER = <<-EOS.dedent
+        # Pull Request Protips(tm):
+        # * Include description of how this change accomplishes the task at hand.
+        # * Use GitHub flavored Markdown http://github.github.com/github-flavored-markdown/
+        # * Review CONTRIBUTING.md for recommendations of artifacts, links, images, screencasts, etc.
+        #
+        # This footer will automatically be stripped from the pull request description
+      EOS
+
+      attr_reader :repo, :shell
+
+      def initialize(repo, shell)
+        @repo = repo
+        @shell = shell
+      end
+
+      # returns the url of the created pull request
+      # @see http://developer.github.com/v3/pulls/
+      def create_pull_request(branch, changelog, options = {})
+        fail 'Github authorization token not found' unless authorization_token
+        remote = remote_origin_name
+        body = pull_request_body(changelog, options[:description])
+
+        shell.say "Creating pull request for "
+        shell.say "#{branch} ", :green
+        shell.say "against "
+        shell.say "#{Thegarage::Gitx::BASE_BRANCH} ", :green
+        shell.say "in "
+        shell.say remote, :green
+
+        payload = {
+          :title => branch,
+          :base => Thegarage::Gitx::BASE_BRANCH,
+          :head => branch,
+          :body => body
+        }.to_json
+        response = RestClient::Request.new(:url => "https://api.github.com/repos/#{remote}/pulls", :method => "POST", :payload => payload, :headers => request_headers).execute
+        data = JSON.parse response.body
+
+        assign_pull_request(branch, options[:assignee], data) if options[:assignee]
+
+        url = data['html_url']
+        url
+      rescue RestClient::Exception => e
+        process_error e
+        throw e
+      end
 
       private
+
       # request github authorization token
       # User-Agent is required
       # store the token in local git config
+      # @returns [String] auth token stored in git (current repo, user config or installed global settings)
       # @see http://developer.github.com/v3/oauth/#scopes
       # @see http://developer.github.com/v3/#user-agent-required
       def authorization_token
-        auth_token = github_auth_token
+        auth_token = repo.config['thegarage.gitx.githubauthtoken']
         return auth_token unless auth_token.to_s.blank?
 
-        raise "Github user not configured.  Run: `git config --global github.user 'me@email.com'`" unless current_user
-        password = ask("Github password for #{current_user}: ", :echo => false)
+        fail "Github user not configured.  Run: `git config --global github.user 'me@email.com'`" unless username
+        password = shell.ask("Github password for #{username}: ", :echo => false)
 
         payload = {
           :scopes => ['repo'],
@@ -30,7 +78,7 @@ module Thegarage
         response = RestClient::Request.new({
           :url => "https://api.github.com/authorizations",
           :method => "POST",
-          :user => current_user,
+          :user => username,
           :password => password,
           :payload => payload,
           :headers => {
@@ -41,58 +89,79 @@ module Thegarage
         }).execute
         data = JSON.parse response.body
         token = data['token']
-        self.github_auth_token = token
+        repo.config['thegarage.gitx.githubauthtoken'] = token
         token
       rescue RestClient::Exception => e
         process_error e
         throw e
       end
 
-      # returns the url of the created pull request
-      # @see http://developer.github.com/v3/pulls/
-      def create_pull_request(body, assignee = nil)
-        branch = current_branch
-        repo = current_remote_repo
-
-        say "Creating pull request for "
-        say "#{branch} ", :green
-        say "against "
-        say "#{Thegarage::Gitx::BASE_BRANCH} ", :green
-        say "in "
-        say repo, :green
-
-        payload = {:title => branch, :base => Thegarage::Gitx::BASE_BRANCH, :head => branch, :body => body}.to_json
-        response = RestClient::Request.new(:url => "https://api.github.com/repos/#{repo}/pulls", :method => "POST", :payload => payload, :headers => github_request_headers).execute
-        data = JSON.parse response.body
-
-        assign_pull_request(branch, assignee, data) if assignee
-
-        url = data['html_url']
-        url
-      rescue RestClient::Exception => e
-        process_error e
-        throw e
-      end
-
       def assign_pull_request(branch, assignee, data)
         issue_payload = { :title => branch, :assignee => assignee }.to_json
-        RestClient::Request.new(:url => data['issue_url'], :method => "PATCH", :payload => issue_payload, :headers => github_request_headers).execute
+        RestClient::Request.new(:url => data['issue_url'], :method => "PATCH", :payload => issue_payload, :headers => request_headers).execute
       rescue RestClient::Exception => e
         process_error e
       end
 
       def process_error(e)
         data = JSON.parse e.http_body
-        say "Github request failed: #{data['message']}", :red
+        shell.say "Github request failed: #{data['message']}", :red
       end
 
-      def github_request_headers
+      def request_headers
         {
           :accept => :json,
           :content_type => :json,
           'Authorization' => "token #{authorization_token}"
         }
       end
+
+      # @returns [String] github username (ex: 'wireframe') of the current github.user
+      # @returns empty [String] when no github.user is set on the system
+      def username
+        repo.config['github.user']
+      end
+
+      # lookup the current repository of the PWD
+      # ex: git@github.com:socialcast/thegarage/gitx.git OR https://github.com/socialcast/thegarage/gitx.git
+      def remote_origin_name
+        remote = repo.config['remote.origin.url']
+        remote.to_s.gsub(/\.git$/,'').split(/[:\/]/).last(2).join('/')
+      end
+
+      def pull_request_body(changelog, description = nil)
+        description_template = []
+        description_template << description if description
+        description_template << "\n"
+        description_template << '### Changelog'
+        description_template << changelog
+        description_template << PULL_REQUEST_FOOTER
+
+        body = input_from_editor(description_template.join("\n"))
+        body.gsub(PULL_REQUEST_FOOTER, '').chomp.strip
+      end
+
+      # launch configured editor to retreive message/string
+      def input_from_editor(initial_text = '')
+        Tempfile.open('reviewrequest.md') do |f|
+          f << initial_text
+          f.flush
+
+          editor = repo.config['core.editor'] || ENV['EDITOR'] || 'vi'
+          flags = case editor
+          when 'mate', 'emacs', 'subl'
+            '-w'
+          when 'mvim'
+            '-f'
+          else
+            ''
+          end
+          pid = fork { exec([editor, flags, f.path].join(' ')) }
+          Process.waitpid(pid)
+          contents = File.read(f.path)
+          contents.chomp.strip
+        end
+      end
     end
   end
 end

data/lib/thegarage/gitx/version.rb

@@ -1,5 +1,5 @@
 module Thegarage
   module Gitx
-    VERSION = '1.4.0'
+    VERSION = '1.4.1'
   end
 end

data/spec/thegarage/gitx/cli_spec.rb

@@ -275,68 +275,12 @@ describe Thegarage::Gitx::CLI do
   end
 
   describe '#reviewrequest' do
-    context 'when github.user is not configured' do
-      let(:current_user) { nil }
-      it 'raises error' do
-        allow(cli).to receive(:current_user).and_return(current_user)
-
-        expect do
-          cli.reviewrequest
-        end.to raise_error /Github user not configured/
-      end
-    end
-    context 'when authorization_token is nil' do
-      let(:options) { {description: 'testing'} }
-      let(:current_user) { 'ryan@codecrate.com' }
-      let(:github_password) { 'secretz' }
-      let(:authorization_token) { 'auth_token' }
-      let(:expected_auth_body) do
-        JSON.dump({
-         scopes: ["repo"],
-         note: "The Garage Git eXtensions",
-         note_url: "https://github.com/thegarage/thegarage-gitx"
-        })
-      end
-      before do
-        stub_request(:post, "https://#{current_user}:#{github_password}@api.github.com/authorizations").
-          with(:body => expected_auth_body).
-          to_return(:status => 200, :body => JSON.dump(token: authorization_token), :headers => {})
-
-        stub_request(:post, "https://api.github.com/repos/thegarage/thegarage-gitx/pulls").
-          to_return(:status => 200, :body => %q({"html_url": "http://github.com/repo/project/pulls/1"}), :headers => {})
-
-        allow(cli).to receive(:current_user).and_return(current_user)
-        expect(cli).to receive(:ask).with('Github password for ryan@codecrate.com: ', {:echo => false}).and_return(github_password).any_number_of_times
-        allow(cli).to receive(:github_auth_token=).with(authorization_token)
-
-        expect(cli).to receive(:editor_input).and_return('scrubbed text')
-        expect(cli).to receive(:run).with("git pull origin feature-branch", capture: true).ordered
-        expect(cli).to receive(:run).with("git pull origin master", capture: true).ordered
-        expect(cli).to receive(:run).with("git push origin HEAD", capture: true).ordered
-        expect(cli).to receive(:run).with("git log master...feature-branch --no-merges --pretty=format:'* %s%n%b'", capture: true).and_return("2013-01-01 did some stuff").ordered
-
-        cli.reviewrequest
-      end
-      it 'creates authorization_token' do
-        should meet_expectations
-      end
-      it 'should create github pull request' do
-        should meet_expectations
-      end
-      it 'should run expected commands' do
-        should meet_expectations
-      end
-    end
-    context 'when description != null and there is an existing authorization_token' do
-      let(:options) { {description: 'testing'} }
-      let(:authorization_token) { '123981239123' }
+    context 'when github configured correctly' do
+      let(:github) { double('fake github') }
       before do
-        stub_request(:post, "https://api.github.com/repos/thegarage/thegarage-gitx/pulls").
-          to_return(:status => 200, :body => %q({"html_url": "http://github.com/repo/project/pulls/1"}), :headers => {})
-
-        allow(cli).to receive(:authorization_token).and_return(authorization_token)
+        expect(cli).to receive(:github).and_return(github)
+        expect(github).to receive(:create_pull_request).and_return('https://path/to/new/pull/request')
 
-        expect(cli).to receive(:editor_input).and_return('scrubbed text')
         expect(cli).to receive(:run).with("git pull origin feature-branch", capture: true).ordered
         expect(cli).to receive(:run).with("git pull origin master", capture: true).ordered
         expect(cli).to receive(:run).with("git push origin HEAD", capture: true).ordered

data/spec/thegarage/gitx/github_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe Thegarage::Gitx::Github do
+  let(:repo) { double('fake shell', config: repo_config) }
+  let(:repo_config) do
+    {
+      'remote.origin.url' => 'https://github.com/thegarage/thegarage-gitx'
+    }
+  end
+  let(:shell) { double('fake shell', say: nil, ask: nil) }
+  subject { Thegarage::Gitx::Github.new(repo, shell) }
+
+  describe '#create_pull_request' do
+    context 'when github.user is not configured' do
+      it 'raises error' do
+        expect do
+          subject.create_pull_request 'example-branch', 'changelog'
+        end.to raise_error /Github user not configured/
+      end
+    end
+    context 'when config.authorization_token is nil' do
+      let(:repo_config) do
+        {
+          'remote.origin.url' => 'https://github.com/thegarage/thegarage-gitx',
+          'github.user' => 'ryan@codecrate.com'
+        }
+      end
+      let(:github_password) { 'secretz' }
+      let(:authorization_token) { '123981239123' }
+      let(:expected_auth_body) do
+        JSON.dump({
+         scopes: ["repo"],
+         note: "The Garage Git eXtensions",
+         note_url: "https://github.com/thegarage/thegarage-gitx"
+        })
+      end
+      before do
+        stub_request(:post, "https://ryan@codecrate.com:secretz@api.github.com/authorizations").
+          with(:body => expected_auth_body).
+          to_return(:status => 200, :body => JSON.dump(token: authorization_token), :headers => {})
+
+        stub_request(:post, "https://api.github.com/repos/thegarage/thegarage-gitx/pulls").
+          to_return(:status => 200, :body => %q({"html_url": "http://github.com/repo/project/pulls/1"}), :headers => {})
+
+        expect(shell).to receive(:ask).with('Github password for ryan@codecrate.com: ', {:echo => false}).and_return(github_password).any_number_of_times
+
+        expect(subject).to receive(:input_from_editor).and_return('scrubbed text')
+        subject.create_pull_request 'example-branch', 'changelog'
+      end
+      it 'creates authorization_token' do
+        expect(repo_config).to include('thegarage.gitx.githubauthtoken' => authorization_token)
+      end
+      it 'should create github pull request' do
+        should meet_expectations
+      end
+      it 'should run expected commands' do
+        should meet_expectations
+      end
+    end
+    context 'when there is an existing authorization_token' do
+      let(:authorization_token) { '123981239123' }
+      let(:repo_config) do
+        {
+          'remote.origin.url' => 'https://github.com/thegarage/thegarage-gitx',
+          'github.user' => 'ryan@codecrate.com',
+          'thegarage.gitx.githubauthtoken' => authorization_token
+        }
+      end
+      before do
+        stub_request(:post, "https://api.github.com/repos/thegarage/thegarage-gitx/pulls").
+          to_return(:status => 200, :body => %q({"html_url": "http://github.com/repo/project/pulls/1"}), :headers => {})
+
+        expect(subject).to receive(:input_from_editor).and_return('scrubbed text')
+        subject.create_pull_request 'example-branch', 'changelog'
+      end
+      it 'should create github pull request' do
+        should meet_expectations
+      end
+      it 'should run expected commands' do
+        should meet_expectations
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thegarage-gitx
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Ryan Sonnek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-05 00:00:00.000000000 Z
+date: 2014-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grit
@@ -183,6 +183,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/meet_expectations_matcher.rb
 - spec/thegarage/gitx/cli_spec.rb
+- spec/thegarage/gitx/github_spec.rb
 - thegarage-gitx.gemspec
 homepage: ''
 licenses:
@@ -212,3 +213,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/meet_expectations_matcher.rb
 - spec/thegarage/gitx/cli_spec.rb
+- spec/thegarage/gitx/github_spec.rb