face_control 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b374e68daaa27205ecc59c9465ff8f11433bb5d1
-  data.tar.gz: 3afdc0deb89bc2e385032c54c950e59d9d1b461d
+  metadata.gz: 4a232c3cf9da606837421e0f388819373c6aa46b
+  data.tar.gz: 07bedda93cc95dba9c5ea6b716c1f2c5e894506a
 SHA512:
-  metadata.gz: 1ff712dbd9a72ac6612cd3e20974c82ae8aedb72fe97a00a388b7eab4857d03c0164970b9b156fc160c98ffb1a4b7d1a8e9a295685cf0b3838fd85aacb0fbdc2
-  data.tar.gz: 9b7b31b34cc4b460c75066b463cd1bd20cb1752d056f102f490ca15a5b6c7ce86ced03b5265945a0dd5cdacb2ecffbebb2386f97c65842a3d94d7eb3e972b8e7
+  metadata.gz: 54fe2769b81e249dc71c9aac26bb8311b4f522999a4d181af30322c30e0e6dedaa1e2f2fc869bb13421bde49df9877728e38a16fbe8e9d1370dbbbf1e2b65bad
+  data.tar.gz: d7511c518230fa2200e9ec6da57522fbc3c23e5f049ff8e4207350f1df8017e187d4074e71ab8680d332ab8a048f708ca20dff06cd3cdec830cb3b10d52dc5d8

data/.rubocop.yml

@@ -11,5 +11,8 @@ Style/FileName:
 Style/SpaceBeforeBlockBraces:
   EnforcedStyle: no_space
 
+Style/SpaceInsideBlockBraces:
+  SpaceBeforeBlockParameters: false
+
 Style/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space

data/.vexor.yml

@@ -0,0 +1,8 @@
+rvm:
+- 1.9
+- 2.0
+- 2.1
+- 2.2
+
+before_script:
+- sudo npm install -g coffeelint

data/README.md

@@ -1,3 +1,6 @@
+[![Vexor](https://ci.vexor.io/projects/126da196-c8e6-46f0-8bc7-b5f8f4b49732/status.svg)](https://ci.vexor.io/ui/projects/126da196-c8e6-46f0-8bc7-b5f8f4b49732/builds)
+[![Coveralls](https://img.shields.io/coveralls/vassilevsky/face_control.svg)](https://coveralls.io/github/vassilevsky/face_control)
+
 # Face Control
 
 Comment on added lines of pull requests in [Atlassian Stash][].
@@ -12,8 +15,6 @@ Inspired by [Hound][].
 
 ## Usage
 
-    rubocop -f json -o rubocop.json
-    coffeelint --reporter raw app/assets/javascripts > coffeelint_report.json
     face-control <project> <repository> <pull_request_id>
 
 It's natural to run this on a continuous integration server.
@@ -43,8 +44,6 @@ For example, here's a [Jenkins][] project setup:
             gem install rubocop face_control
             npm install -g coffeelint
 
-            rubocop -f json -o rubocop.json || true
-            coffeelint --reporter raw app/assets/javascripts > coffeelint_report.json || true
             face-control <project> <repository> $PULL_REQUEST_ID
 
 If you don't want to receive RuboCop comments with certain severity level,

data/Rakefile

@@ -1 +1,10 @@
 require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.warning = true
+end
+
+task :default => :test

data/TODO

@@ -0,0 +1 @@
+* Warn if RuboCop version is too old (cannot reliably determine if an offense can be corrected automatically)

data/exe/face-control

@@ -1,37 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'logger'
-require 'docopt'
 require 'face_control'
-require 'stash'
 
-begin
-  USAGE = "#{File.dirname(__FILE__)}/../USAGE"
-  args = Docopt.docopt(File.read(USAGE))
-
-  project         = args['<project>']
-  repository      = args['<repository>']
-  pull_request_id = args['<pull_request_id>']
-
-  ignored_severities = []
-  if args['--skip-severity']
-    ignored_severities = args['--skip-severity'].split(',')
-    puts "Skipping RuboCop offenses with severities: #{ignored_severities.join(', ')}."
-  end
-
-  config = Stash::Config.new
-  server = Stash::Server.new(config.host, config.user, config.password, Logger.new(STDOUT))
-  repository = server.repository(project, repository)
-  pull_request = repository.pull_request(pull_request_id)
-
-  [
-    FaceControl::Inputs::RubocopJson.new(ignored_severities),
-    FaceControl::Inputs::CoffeeLintRaw.new
-  ].each do |input|
-    input.comments.each do |comment|
-      pull_request.add_comment(comment.file, comment.line, comment.text)
-    end
-  end
-rescue Docopt::Exit => e
-  puts e.message
-end
+FaceControl::CLI.new.run

data/face_control.gemspec

@@ -12,9 +12,9 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Checks Atlassian Stash pull requests and comments on issues in added code'
   spec.homepage      = 'https://github.com/vassilevsky/face_control'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject{ |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject{|f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}){ |f| File.basename(f) }
+  spec.executables   = spec.files.grep(%r{^exe/}){|f| File.basename(f) }
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'docopt'
@@ -23,4 +23,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.8'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.8'
+  spec.add_development_dependency 'minitest-reporters', '~> 1.0'
+  spec.add_development_dependency 'webmock', '~> 1.21'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
 end

data/lib/face_control.rb

@@ -1,3 +1,5 @@
 require 'face_control/version'
+require 'face_control/cli'
 require 'face_control/comment'
-require 'face_control/inputs'
+require 'face_control/checker_runner'
+require 'face_control/checkers'

data/lib/face_control/checker_runner.rb

@@ -0,0 +1,28 @@
+module FaceControl
+  class CheckerRunner
+    def initialize(checker_class, filenames = [], options = {})
+      @checker = checker_class.new
+      if @checker.respond_to?(:options=)
+        @checker.options = options
+      end
+
+      @filenames = filenames
+    end
+
+    def comments
+      return [] if relevant_filenames.empty?
+
+      @checker.parse(`#{@checker.command(relevant_filenames.join(' '))}`)
+    end
+
+    private
+
+    def relevant_filenames
+      @relevant_filenames ||= @checker.relevant_globs.map do |glob|
+        @filenames.select do |filename|
+          File.fnmatch?(glob, filename)
+        end
+      end.flatten.uniq
+    end
+  end
+end

data/lib/face_control/checkers.rb

@@ -0,0 +1,2 @@
+require 'face_control/checkers/rubocop'
+require 'face_control/checkers/coffeelint'

data/lib/face_control/checkers/_example.rb

@@ -0,0 +1,39 @@
+require 'face_control/comment'
+
+module FaceControl
+  module Checkers
+    class Example
+      # @optional
+      # Define only if you use @options in the following methods
+      attr_writer :options
+
+      # @return [Array<String>] Shell globs to filter only files relevant to this checker
+      #                         out of all files with added lines in the pull request
+      def relevant_globs
+        %w(bin/*)
+      end
+
+      # @param filenames [String] Files with added lines in the pull request
+      #                           only relevant to this checker (filtered by globs above)
+      # @return [String] Command line to check the files
+      def command(filenames)
+        "ls -l #{filenames}"
+      end
+
+      # @param command_output [String] Stdout of the command above
+      # @return Array<FaceControl::Comment> Comments to post to the pull request
+      def parse(command_output)
+        command_output.split("\n").map do |line|
+          fields = line.split
+
+          mode = fields.first
+          file = fields.last
+
+          if mode != '-rwxr-xr-x'
+            Comment.new(file: file, line: 1, text: 'Invalid file mode')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/face_control/checkers/coffeelint.rb

@@ -0,0 +1,28 @@
+require 'json'
+require 'face_control/comment'
+
+module FaceControl
+  module Checkers
+    class CoffeeLint
+      def relevant_globs
+        %w(*.coffee)
+      end
+
+      def command(filenames)
+        "coffeelint --reporter raw #{filenames}"
+      end
+
+      def parse(command_output)
+        JSON.parse(command_output).map do |file, problems|
+          problems.map do |problem|
+            Comment.new(
+              file: file,
+              line: problem['lineNumber'],
+              text: "(#{problem['level']}) #{problem['message']}"
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/face_control/{inputs/rubocop_json.rb → checkers/rubocop.rb}

@@ -1,21 +1,31 @@
+# encoding: UTF-8
+
 require 'json'
 require 'rubocop'
 require 'face_control/comment'
 
 module FaceControl
-  module Inputs
-    class RubocopJson
-      attr_accessor :ignored_severities, :filename
+  module Checkers
+    class RuboCop
+      attr_writer :options
 
-      def initialize(ignored_severities = [], filename = 'rubocop.json')
-        self.ignored_severities = ignored_severities
-        self.filename = filename
+      def relevant_globs
+        %w(
+          *.rb
+          *.rake
+          Capfile
+          Gemfile
+          Rakefile
+          Vagrantfile
+        )
+      end
 
-        fail "#{filename} does not exist" unless File.exist?(filename)
+      def command(filenames)
+        "rubocop --format json #{filenames}"
       end
 
-      def comments
-        report['files'].map do |file|
+      def parse(command_output)
+        JSON.parse(command_output)['files'].map do |file|
           file['offenses'].reject do |offense|
             ignored_severities.include?(offense['severity'])
           end.map do |offense|
@@ -25,13 +35,13 @@ module FaceControl
               text: text(offense, file)
             )
           end
-        end.flatten
+        end
       end
 
       private
 
-      def report
-        JSON.parse(File.read(filename))
+      def ignored_severities
+        @options.fetch(:ignored_severities, [])
       end
 
       def text(offense, file)
@@ -50,7 +60,7 @@ module FaceControl
 
       def style_guide_url(offense)
         cop_name = offense['cop_name']
-        cop_config = RuboCop::ConfigLoader.default_configuration[cop_name]
+        cop_config = ::RuboCop::ConfigLoader.default_configuration[cop_name]
         cop_config['StyleGuide']
       end
 

data/lib/face_control/cli.rb

@@ -0,0 +1,72 @@
+require 'logger'
+require 'docopt'
+require 'stash'
+
+module FaceControl
+  class CLI
+    USAGE = File.read("#{File.dirname(__FILE__)}/../../USAGE")
+
+    def run
+      logger = Logger.new(STDOUT)
+      project, repository, pull_request_id, ignored_severities = arguments
+      pull_request = pull_request(project, repository, pull_request_id, logger)
+
+      logger.info('Running checkers...')
+      comments = check(pull_request, ignored_severities, logger)
+      return if comments.empty?
+
+      logger.info("Posting #{comments.size} comments...")
+      add_comments(pull_request, comments)
+    end
+
+    def check(pull_request, ignored_severities, logger)
+      unless ignored_severities.empty?
+        logger.info("Skipping RuboCop offenses with severities: #{ignored_severities.join(', ')}.")
+      end
+
+      filenames = pull_request.filenames_with_added_lines
+
+      checkers = [
+        FaceControl::CheckerRunner.new(FaceControl::Checkers::RuboCop, filenames, ignored_severities: ignored_severities),
+        FaceControl::CheckerRunner.new(FaceControl::Checkers::CoffeeLint, filenames)
+      ]
+
+      checkers.map(&:comments).flatten
+    end
+
+    def add_comments(pull_request, comments)
+      comments.each do |comment|
+        pull_request.add_comment(comment.file, comment.line, comment.text)
+      end
+    end
+
+    private
+
+    def arguments
+      args = Docopt.docopt(USAGE)
+
+      project = args['<project>']
+      repository = args['<repository>']
+      pull_request_id = args['<pull_request_id>']
+
+      ignored_severities = []
+      if args['--skip-severity']
+        ignored_severities = args['--skip-severity'].split(',')
+      end
+
+      [project, repository, pull_request_id, ignored_severities]
+    rescue Docopt::Exit => e
+      puts e.message
+      exit(1)
+    end
+
+    def pull_request(project, repository, pull_request_id, logger)
+      @pull_request ||= begin
+        config = Stash::Config.new
+        server = Stash::Server.new(config.host, config.user, config.password, logger)
+        repository = server.repository(project, repository)
+        repository.pull_request(pull_request_id)
+      end
+    end
+  end
+end

data/lib/face_control/comment.rb

@@ -2,10 +2,10 @@ module FaceControl
   class Comment
     attr_accessor :file, :line, :text
 
-    def initialize(file:, line:, text:)
-      self.file = file
-      self.line = line
-      self.text = text
+    def initialize(options)
+      self.file = options.fetch(:file)
+      self.line = options.fetch(:line)
+      self.text = options.fetch(:text)
     end
   end
 end

data/lib/face_control/version.rb

@@ -1,3 +1,3 @@
 module FaceControl
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

data/lib/stash/pull_request.rb

@@ -9,6 +9,10 @@ module Stash
       self.id = id
     end
 
+    def filenames_with_added_lines
+      diff.filenames_with_added_lines
+    end
+
     def add_comment(file, line, text)
       return unless diff.added_line?(file, line)
       return if already_commented?(file, line, text)

data/lib/stash/pull_request/diff.rb

@@ -5,12 +5,29 @@ module Stash
         @diff = diff
       end
 
+      def filenames_with_added_lines
+        diffs_with_added_lines.map do |diff|
+          diff['destination']['toString']
+        end
+      end
+
       def added_line?(file, line)
         added_lines(file).include?(line)
       end
 
       private
 
+      def diffs_with_added_lines
+        @diff['diffs'].select do |diff|
+          diff['destination'] &&
+          diff['hunks'].find do |hunk|
+            hunk['segments'].find do |segment|
+              segment['type'] == 'ADDED'
+            end
+          end
+        end
+      end
+
       def added_lines(file)
         @added_lines ||= {}
         @added_lines[file] ||= begin

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: face_control
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Ilya Vassilevsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-06 00:00:00.000000000 Z
+date: 2015-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
@@ -80,6 +80,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 description: 
 email:
 - vassilevsky@gmail.com
@@ -90,25 +146,24 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".vexor.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- TODO
 - USAGE
-- bin/bundler
-- bin/console
-- bin/face-control
-- bin/httparty
-- bin/rake
-- bin/setup
 - exe/face-control
 - face_control.gemspec
 - lib/face_control.rb
+- lib/face_control/checker_runner.rb
+- lib/face_control/checkers.rb
+- lib/face_control/checkers/_example.rb
+- lib/face_control/checkers/coffeelint.rb
+- lib/face_control/checkers/rubocop.rb
+- lib/face_control/cli.rb
 - lib/face_control/comment.rb
-- lib/face_control/inputs.rb
-- lib/face_control/inputs/coffeelint_raw.rb
-- lib/face_control/inputs/rubocop_json.rb
 - lib/face_control/version.rb
 - lib/stash.rb
 - lib/stash/config.rb
@@ -135,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Checks Atlassian Stash pull requests and comments on issues in added code

data/bin/bundler

@@ -1,16 +0,0 @@
-#!/usr/bin/env ruby
-#
-# This file was generated by Bundler.
-#
-# The application 'bundler' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
-
-require 'rubygems'
-require 'bundler/setup'
-
-load Gem.bin_path('bundler', 'bundler')

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'face_control'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start

data/bin/face-control

@@ -1,16 +0,0 @@
-#!/usr/bin/env ruby
-#
-# This file was generated by Bundler.
-#
-# The application 'face-control' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
-
-require 'rubygems'
-require 'bundler/setup'
-
-load Gem.bin_path('face_control', 'face-control')

data/bin/httparty

@@ -1,16 +0,0 @@
-#!/usr/bin/env ruby
-#
-# This file was generated by Bundler.
-#
-# The application 'httparty' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
-
-require 'rubygems'
-require 'bundler/setup'
-
-load Gem.bin_path('httparty', 'httparty')

data/bin/rake

@@ -1,16 +0,0 @@
-#!/usr/bin/env ruby
-#
-# This file was generated by Bundler.
-#
-# The application 'rake' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
-
-require 'rubygems'
-require 'bundler/setup'
-
-load Gem.bin_path('rake', 'rake')

data/bin/setup

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

data/lib/face_control/inputs.rb

@@ -1,2 +0,0 @@
-require 'face_control/inputs/rubocop_json'
-require 'face_control/inputs/coffeelint_raw'

data/lib/face_control/inputs/coffeelint_raw.rb

@@ -1,34 +0,0 @@
-require 'json'
-require 'face_control/comment'
-
-module FaceControl
-  module Inputs
-    class CoffeeLintRaw
-      attr_accessor :filename
-
-      def initialize(filename = 'coffeelint_report.json')
-        self.filename = filename
-
-        fail "#{filename} does not exist" unless File.exist?(filename)
-      end
-
-      def comments
-        report.map do |file, problems|
-          problems.map do |problem|
-            Comment.new(
-              file: file,
-              line: problem['lineNumber'],
-              text: "(#{problem['level']}) #{problem['message']}"
-            )
-          end
-        end.flatten
-      end
-
-      private
-
-      def report
-        JSON.parse(File.read(filename))
-      end
-    end
-  end
-end