circlemator 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c813019d9366200fd764c399fa6736d7e0d690e5
-  data.tar.gz: b2692e0b581a721cbe5854ba21cdb932552cbe32
+  metadata.gz: 0bc105b86b626325f97f0d06877e60e7d6e0751c
+  data.tar.gz: 8d8d411aa9f82022ea83ff19c7c827225ac7a497
 SHA512:
-  metadata.gz: c0a99bfe944824eb9e5dffb63ab81c8352e7cc63fb42dd1f8229b8535144c6f9998c13a2dabab405f269fab975778e1defefb71866c9383a5d504f6a265414c3
-  data.tar.gz: 70629c129f63f0646a1a9d185b2d8b6da8377584b93c5dacf70eacaa77f2ecf8a2c333d481c17674e14e73c561b47d56a81919e541470b49a4b931a5771eba2e
+  metadata.gz: 6de47e2288045df12d26553f8d2815cdb14faa9af8b9540b0a19d874656f21a73b2c2b06441becb107a6e5a03de8b89a7ea45e8d8351b763c83ba3f34d4a16bd
+  data.tar.gz: adb99ddcae2c9956bc8171ba99e3b4fb29580629a6a5fa85d79a13c4452a3bdc836bff4da6af07fc7e3754122ac06d732742615a4c01abd8cc400cd0eee55511

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_gem:
+  rf-stylez: ruby/rubocop.yml

data/Gemfile

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in circlemator.gemspec
 gemspec
+
+gem 'rf-stylez'
+gem 'rspec_junit_formatter'

data/Guardfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/README.md

@@ -1,7 +1,7 @@
-# Circlemator
+# Circlemator [![Circle CI](https://circleci.com/gh/rainforestapp/circlemator.png?style=badge&circle-token=0b39cf33b52e34ef6bb29cf2f2a1c071fef3f26f)](https://circleci.com/gh/rainforestapp/circlemator)
 
 Circlemator is a bucket of tricks for working with CircleCI and Github
-used internally at Rainforest QA.
+used internally at [Rainforest QA](http://www.rainforestqa.com).
 
 ## Installation
 
@@ -50,6 +50,26 @@ to be set in CircleCI:
 - `CIRCLE_API_TOKEN`: Your CircleCI API token. (Can also be set with
   the `-t` option.)
 
+### Style check
+
+Think of this as a poor man's HoundCI: it runs Rubocop (and/or more
+linters/checkers TBD) and comments on the Github pull request using
+the excellent [Pronto](https://github.com/mmozuras/pronto). Use it
+like so:
+
+```yml
+test:
+  pre:
+    - bundle exec circlemator style-check --base-branch=develop
+```
+
+(It probably makes sense in either the `pre` or `override` steps.)
+
+`style-check` requires the following environment variable to be set:
+
+- `GITHUB_ACCESS_TOKEN`: A Github API auth token for a user with commit
+  access to your repo. (Can also be set with the `-g` option.)
+
 ### Self-merge release branch
 
 Preamble: at Rainforest, our process for getting code into production
@@ -59,7 +79,7 @@ looks like this:
 2. Run unit tests and get code review (repeat 1-2 as necessary).
 3. Merge feature branch to `develop`.
 4. Open release pull request from `develop` to `master`.
-5. Run unit tests + Rainforest against `develop`.
+5. Run unit tests + [Rainforest](http://www.rainforestqa.com) against `develop`.
 6. Merge `develop` into `master` if everything's green.
 7. Deploy from `master`.
 
@@ -92,7 +112,7 @@ request.
 
 `self-merge` requires the following environment variable to be set:
 
-- `GITHUB_AUTH_TOKEN`: A Github API auth token for a user with commit
+- `GITHUB_ACCESS_TOKEN`: A Github API auth token for a user with commit
   access to your repo. (Can also be set with the `-g` option.)
 
 Also, unfortunately branch protection cannot be enabled on your

data/Rakefile

@@ -1 +1,2 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+require 'bundler/gem_tasks'

data/circle.yml

@@ -0,0 +1,4 @@
+test:
+  pre:
+    - bundle exec exe/circlemator cancel-old
+    - bundle exec exe/circlemator style-check --base-branch=master

data/circlemator.gemspec

@@ -1,28 +1,35 @@
-# coding: utf-8
+# frozen_string_literal: true
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'circlemator/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "circlemator"
+  spec.name          = 'circlemator'
   spec.version       = Circlemator::VERSION
-  spec.authors       = ["Emanuel Evans"]
-  spec.email         = ["emanuel@rainforestqa.com"]
+  spec.authors       = ['Emanuel Evans']
+  spec.email         = ['emanuel@rainforestqa.com']
 
-  spec.summary       = %q{A bucket of tricks for CircleCI and Github.}
-  spec.description   = <<-EOF
+  spec.summary       = 'A bucket of tricks for CircleCI and Github.'
+  spec.description   = <<-EOF.strip
     A few utilities for CircleCI to improve your CI workflow.
   EOF
-  spec.homepage      = "https://github.com/rainforestapp/circlemator"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/rainforestapp/circlemator'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "httparty", "~> 0.13.7"
+  spec.add_dependency 'httparty', '~> 0.13.7'
+  spec.add_dependency 'pronto', '~> 0.5.3'
+  spec.add_dependency 'pronto-rubocop', '~> 0.5.2'
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'vcr', '~> 3.0.1'
+  spec.add_development_dependency 'webmock', '~> 1.22.6'
+  spec.add_development_dependency 'rspec', '~> 3.4.0'
+  spec.add_development_dependency 'guard-rspec', '~> 4.6.4'
 end

data/exe/circlemator

@@ -1,11 +1,14 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 require 'optparse'
 require_relative '../lib/circlemator/build_canceler'
 require_relative '../lib/circlemator/self_merger'
+require_relative '../lib/circlemator/github_repo'
+require_relative '../lib/circlemator/style_checker'
 
 options = {}
 parser = OptionParser.new do |opts|
-  opts.banner = "Usage: circlemator (self-merge|cancel-old) [options]"
+  opts.banner = 'Usage: circlemator (self-merge|cancel-old) [options]'
 
   opts.on('-bBRANCH', '--base-branch=BRANCH', 'Base branch for merging') do |b|
     options[:base_branch] = b
@@ -42,7 +45,7 @@ end
 
 def require_opt(opts, key)
   if !opts[key]
-    puts "Option #{key.gsub(/_/, '-')} is required!"
+    puts "Option #{key.to_s.gsub(/_/, '-')} is required!"
     exit 1
   end
 end
@@ -54,14 +57,16 @@ end
 
 options[:user] = require_env 'CIRCLE_PROJECT_USERNAME'
 options[:repo] = require_env 'CIRCLE_PROJECT_REPONAME'
+options[:github_auth_token] ||= ENV['GITHUB_ACCESS_TOKEN']
+options[:github_auth_token] ||= ENV['GITHUB_AUTH_TOKEN']
 
 case ARGV[0]
 when 'self-merge'
   options[:sha] = require_env 'CIRCLE_SHA1'
-  options[:github_auth_token] ||= ENV['GITHUB_AUTH_TOKEN']
   require_opt options, :github_auth_token
   require_opt options, :base_branch
   require_opt options, :compare_branch
+  options[:github_repo] = Circlemator::GithubRepo.new(options)
 
   Circlemator::SelfMerger.new(options).merge!
 when 'cancel-old'
@@ -70,12 +75,18 @@ when 'cancel-old'
   require_opt options, :circle_api_token
 
   Circlemator::BuildCanceler.new(options).cancel_old_builds!
+when 'style-check'
+  options[:sha] = require_env 'CIRCLE_SHA1'
+  options[:compare_branch] ||= require_env 'CIRCLE_BRANCH'
+  require_opt options, :github_auth_token
+  require_opt options, :base_branch
+  options[:github_repo] = Circlemator::GithubRepo.new(options)
+
+  Circlemator::StyleChecker.new(options).check!
 else
   puts parser
 end
 
-
-
 # Local Variables:
 # major-mode: ruby-mode
 # End:

data/lib/circlemator.rb

@@ -1,4 +1,5 @@
-require "circlemator/version"
+# frozen_string_literal: true
+require 'circlemator/version'
 
 module Circlemator
 end

data/lib/circlemator/build_canceler.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 require 'httparty'
 require 'json'
 
 module Circlemator
   class BuildCanceler
-    def initialize(user: , repo: , current_build: , circle_api_token: )
+    def initialize(user: , repo: , current_build: , circle_api_token: , **_opts)
       @user = user
       @repo = repo
       @current_build = current_build
@@ -30,7 +31,7 @@ module Circlemator
       end
 
       if cancel_self
-        puts "Daisy, Daisy, give me your answer, do..."
+        puts 'Daisy, Daisy, give me your answer, do...'
         HTTParty.post "https://circleci.com/api/v1/project/#{@user}/#{@repo}/#{@current_build}/cancel",
                       circle_auth
       end

data/lib/circlemator/github_repo.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+require 'httparty'
+
+module Circlemator
+  class GithubRepo
+    include HTTParty
+
+    class InvalidPath < StandardError
+      def initialize(path)
+        super "Path #{path} is not valid for repo"
+      end
+    end
+
+    class WrongRepo < StandardError
+      def initialize(url, repo)
+        super "URL #{url} does not belong to repo #{repo}"
+      end
+    end
+
+    base_uri 'https://api.github.com/repos'
+
+    def initialize(user: , repo: , github_auth_token: , **_opts)
+      @user = user
+      @repo = repo
+      @auth_token = github_auth_token
+    end
+
+    def get(path, opts = {})
+      self.class.get(fix_path(path), opts.merge(basic_auth: auth))
+    end
+
+    def put(path, opts = {})
+      self.class.put(fix_path(path), opts.merge(basic_auth: auth))
+    end
+
+    private
+
+    def fix_path(path)
+      case path
+      when %r(\A#{self.class.base_uri}(/#{@user}/#{@repo}.*)\z)
+        $1
+      when %r(\A#{self.class.base_uri})
+        raise WrongRepo.new(path, "#{@user}/#{@repo}")
+      when %r(\A/.*)
+        "/#{@user}/#{@repo}#{path}"
+      else
+        raise InvalidPath, path
+      end
+    end
+
+    def auth
+      { username: @auth_token, password: 'x-oauth-basic' }
+    end
+  end
+end

data/lib/circlemator/pr_finder.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+require 'circlemator/github_repo'
+
+module Circlemator
+  class PrFinder
+    class BadResponseError < StandardError
+      def initialize(response)
+        super "Bad response from github: #{response.inspect}"
+      end
+    end
+
+    def initialize(github_repo: , base_branch: , compare_branch: , sha: , **_opts)
+      @github_repo = github_repo
+      @base_branch = base_branch
+      @compare_branch = compare_branch
+      @sha = sha
+    end
+
+    def find_pr
+      response = @github_repo.get '/pulls', query: { base: @base_branch }
+      if response.code != 200
+        raise BadResponseError, response
+      end
+
+      prs = JSON.parse(response.body)
+      target_pr = prs.find do |pr|
+        pr.fetch('head').fetch('ref') == @compare_branch &&
+          pr.fetch('head').fetch('sha') == @sha &&
+          pr.fetch('base').fetch('ref') == @base_branch
+      end
+
+      return if target_pr.nil?
+
+      [target_pr.fetch('number'), target_pr.fetch('url')]
+    end
+  end
+end

data/lib/circlemator/self_merger.rb

@@ -1,69 +1,29 @@
+# frozen_string_literal: true
 require 'httparty'
 require 'json'
 
 module Circlemator
   class SelfMerger
-    def initialize(user: ,
-                   repo: ,
-                   sha: ,
-                   github_auth_token: ,
-                   base_branch: ,
-                   compare_branch: )
-      @user = user
-      @repo = repo
-      @sha = sha
-      @auth_token = github_auth_token
-      @base_branch = base_branch
-      @compare_branch = compare_branch
+    MESSAGE = 'Auto-merge by Circlemator!'
+    def initialize(opts)
+      github_repo = opts.fetch(:github_repo)
+      raise "#{github_repo} is invalid" unless github_repo.is_a? GithubRepo
+
+      @github_repo = github_repo
+      @sha = opts.fetch(:sha)
+      @opts = opts
     end
 
     def merge!
-      pr_number, pr_url = find_pr
+      pr_number, pr_url = PrFinder.new(@opts).find_pr
       return if pr_number.nil? || pr_url.nil?
 
-      msg = "Auto-merge by Circlemator!"
-      response = HTTParty.put "#{pr_url}/merge",
-                              body: { commit_message: msg, sha: @sha }.to_json,
-                              basic_auth: github_auth
+      response = @github_repo.put "#{pr_url}/merge",
+                                  body: { commit_message: MESSAGE, sha: @sha }.to_json
       if response.code != 200
         body = JSON.parse(response.body)
         raise "Merge failed: #{body.fetch('message')}"
       end
     end
-
-    private
-
-    def find_pr
-      response = HTTParty.get "https://api.github.com/repos/#{github_repo}/pulls",
-                              query: { base: @base_branch },
-                              basic_auth: github_auth
-      if response.code != 200
-        raise "Bad response from Github: #{response.inspect}"
-      end
-
-      prs = JSON.parse(response.body)
-      pr = prs.find do |pr|
-        pr.fetch('head').fetch('ref') == @compare_branch &&
-          pr.fetch('head').fetch('sha') == @sha &&
-          pr.fetch('base').fetch('ref') == @base_branch
-      end
-
-      if pr.nil?
-        puts 'No release PR. Not merging.'
-        return
-      end
-
-      [pr.fetch('number'), pr.fetch('url')]
-    end
-
-
-    def github_repo
-      "#{@user}/#{@repo}"
-    end
-
-
-    def github_auth
-      { username: @auth_token, password: 'x-oauth-basic' }
-    end
   end
 end

data/lib/circlemator/style_checker.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+require 'httparty'
+require 'json'
+require 'pronto'
+require 'pronto/rubocop'
+require 'circlemator/pr_finder'
+
+module Circlemator
+  class StyleChecker
+    def initialize(opts)
+      @opts = opts
+      @base_branch = opts.fetch(:base_branch)
+    end
+
+    def check!
+      pr_number, _ = PrFinder.new(@opts).find_pr
+      if pr_number
+        ENV['PULL_REQUEST_ID'] = pr_number.to_s
+        formatter = ::Pronto::Formatter::GithubPullRequestFormatter.new
+      else
+        formatter = ::Pronto::Formatter::GithubFormatter.new
+      end
+
+      ::Pronto.run(@base_branch, '.', formatter)
+    end
+  end
+end

data/lib/circlemator/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Circlemator
-  VERSION = "0.1.1"
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: circlemator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Emanuel Evans
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-23 00:00:00.000000000 Z
+date: 2016-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.13.7
+- !ruby/object:Gem::Dependency
+  name: pronto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+- !ruby/object:Gem::Dependency
+  name: pronto-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +80,77 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: "    A few utilities for CircleCI to improve your CI workflow.\n"
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.22.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.22.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.6.4
+description: A few utilities for CircleCI to improve your CI workflow.
 email:
 - emanuel@rainforestqa.com
 executables:
@@ -61,18 +159,25 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - Gemfile
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- circle.yml
 - circlemator.gemspec
 - exe/circlemator
 - lib/circlemator.rb
 - lib/circlemator/build_canceler.rb
+- lib/circlemator/github_repo.rb
+- lib/circlemator/pr_finder.rb
 - lib/circlemator/self_merger.rb
+- lib/circlemator/style_checker.rb
 - lib/circlemator/version.rb
 homepage: https://github.com/rainforestapp/circlemator
 licenses: