pronto 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0bc03d47044e614765fdb291066cf44aac7f6c76
-  data.tar.gz: ae8b22913e762688ce93085b4a9b6544e98668e0
+  metadata.gz: 6b3458313f197182636f5f267fe7119b63c3b8cf
+  data.tar.gz: 37235aba300815df70ddf5e48f58cd680d896e9b
 SHA512:
-  metadata.gz: a8b46b058f9f24e776ed49b042e1732cd3dafabd55a8c16580cdfa51ffbfe3e9f1c2b74a5075469acb43d70dd4be2b03a7a08ec704182df20e2c16e791ccccb6
-  data.tar.gz: 427cddf924889b41d684c0ce2fb05056bb970c26dc0058ed296d22b2c025bfdfbe09bcf03318b537a6f6f6ba5c70f5c899863cf4524c3a59670f454d152e67fa
+  metadata.gz: c0f39899baeec5c9332d152980553ca0bae1cb97d00826fcc56c73189a43d0a8f8d95b38a51ef2478bdd0aeb807d493afa03a3dfc65a2802916ceb801b820d57
+  data.tar.gz: 024ae53ce123604e0b8b9f0e0744241ff35925a7047bc3cdfe90f6dda6bc240353888b8861c74d957f085dae9f105f3f325652c18b84bf0495ac36e33e97e230

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2014 Mindaugas Mozūras
+Copyright (c) 2015 Mindaugas Mozūras
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -7,7 +7,7 @@
 [![Inline docs](http://inch-ci.org/github/mmozuras/pronto.png)](http://inch-ci.org/github/mmozuras/pronto)
 
 Pronto runs analysis quickly by checking only the relevant changes. Created to
-be used on pull requests, but suited for other scenarios as well. Perfect if you
+be used on pull requests, but also suited for other scenarios. Perfect if you
 want to find out quickly if branch introduces changes that conform to your
 [styleguide](https://github.com/mmozuras/pronto-rubocop), [are DRY](https://github.com/mmozuras/pronto-flay), [don't introduce security holes](https://github.com/mmozuras/pronto-brakeman) and [more](#runners).
 
@@ -20,49 +20,59 @@ Pronto runs the checks on a diff between the current HEAD and the provided commi
 ### GitHub Integration
 
 You can run Pronto as a step of your CI builds and get the results as comments
-on GitHub commits using `GithubFormatter`.
+on GitHub commits using `GithubFormatter` or `GithubPullRequestFormatter`.
 
 Add Pronto runners you want to use to your Gemfile:
 ```ruby
-  gem 'pronto-rubocop'
+gem 'pronto'
+gem 'pronto-rubocop', require: false
+gem 'pronto-scss', require: false
 ```
 or gemspec file:
 ```ruby
-  s.add_development_dependency 'pronto-rubocop'
+s.add_development_dependency 'pronto'
+s.add_development_dependency 'pronto-rubocop'
+s.add_development_dependency 'pronto-scss'
 ```
-Set the GITHUB_ACCESS_TOKEN environment variable to [OAuth token](https://help.github.com/articles/creating-an-access-token-for-command-line-use) 
-that has access to the repository. Then set up a rake task:
-```ruby
-  Pronto.gem_names.each { |gem_name| require "pronto/#{gem_name}" }
+Set the GITHUB_ACCESS_TOKEN environment variable to [OAuth token](https://help.github.com/articles/creating-an-access-token-for-command-line-use)
+that has access to the repository.
 
-  formatter = Pronto::Formatter::GithubFormatter.new
-  Pronto.run('origin/master', '.', formatter)
+Then just run it:
+```bash
+GITHUB_ACCESS_TOKEN=token pronto run -f github -c origin/master
 ```
-or run it via command line:
+or, if you want comments to appear on pull request diff, instead of commit:
+```bash
+GITHUB_ACCESS_TOKEN=token PULL_REQUEST_ID=id pronto run -f github_pr -c origin/master
 ```
- GITHUB_ACCESS_TOKEN=<token> bundle exec pronto run -f github -c origin/master
+
+As an alternative, you can also set up a rake task:
+```ruby
+Pronto.gem_names.each { |gem_name| require "pronto/#{gem_name}" }
+
+formatter = Pronto::Formatter::GithubFormatter.new # or GithubPullRequestFormatter
+Pronto.run('origin/master', '.', formatter)
 ```
 
 ### Local Changes
 
 You can run Pronto locally. First, install Pronto and the runners you want to use:
 ```bash
-  gem install pronto
-  gem install pronto-rubocop
+gem install pronto
+gem install pronto-rubocop
 ```
 Then navigate to the repository you want to run Pronto on, and:
 ```bash
-  git checkout feature/branch
-  pronto run # Pronto runs against master by default
+git checkout feature/branch
+pronto run # Pronto runs against master by default
 ```
 
-Run `pronto` in your terminal without any arguments to see what more Pronto is
-capable off.
+Just run `pronto` without any arguments to see what Pronto is capable off.
 
 ## Runners
 
 Pronto can run various tools and libraries, as long as there's a runner for it.
-Currently available runners:
+Currently available:
 
 * [pronto-rubocop](https://github.com/mmozuras/pronto-rubocop)
 * [pronto-flay](https://github.com/mmozuras/pronto-flay)
@@ -74,3 +84,5 @@ Currently available runners:
 * [pronto-jshint](https://github.com/mmozuras/pronto-jshint)
 * [pronto-spell](https://github.com/mmozuras/pronto-spell)
 * [pronto-haml](https://github.com/mmozuras/pronto-haml)
+* [pronto-scss](https://github.com/mmozuras/pronto-scss)
+* [pronto-coffeelint](https://github.com/siebertm/pronto-coffeelint)

data/lib/pronto.rb

@@ -1,35 +1,38 @@
 require 'rugged'
 require 'octokit'
+require 'gitlab'
 require 'forwardable'
 
 require 'pronto/git/repository'
 require 'pronto/git/patches'
 require 'pronto/git/patch'
 require 'pronto/git/line'
-require 'pronto/git/remote'
 
 require 'pronto/plugin'
 require 'pronto/message'
 require 'pronto/runner'
 require 'pronto/github'
+require 'pronto/gitlab'
 
 require 'pronto/formatter/text_formatter'
 require 'pronto/formatter/json_formatter'
 require 'pronto/formatter/github_formatter'
 require 'pronto/formatter/github_pull_request_formatter'
+require 'pronto/formatter/gitlab_formatter'
 require 'pronto/formatter/checkstyle_formatter'
 require 'pronto/formatter/formatter'
 
 module Pronto
-  def self.run(commit = 'master', repo_path = '.', formatter = nil)
+  def self.run(commit = 'master', repo_path = '.',
+               formatter = Formatter::TextFormatter.new, file = nil)
     commit ||= 'master'
 
     repo = Git::Repository.new(repo_path)
-    patches = repo.diff(commit)
+    options = { paths: [file] } if file
+    patches = repo.diff(commit, options)
 
     result = run_all_runners(patches)
 
-    formatter ||= default_formatter
     puts formatter.format(result, repo)
 
     result
@@ -57,8 +60,4 @@ module Pronto
       runner.new.run(patches, patches.commit)
     end.flatten.compact
   end
-
-  def default_formatter
-    Formatter::TextFormatter.new
-  end
 end

data/lib/pronto/cli.rb

@@ -24,6 +24,11 @@ module Pronto
                   aliases: '-c',
                   banner: 'Commit for the diff'
 
+    method_option :index,
+                  type: :boolean,
+                  aliases: '-i',
+                  banner: 'Analyze changes in git index (staging area)'
+
     method_option :runner,
                   type: :array,
                   default: [],
@@ -36,14 +41,15 @@ module Pronto
                   aliases: '-f',
                   banner: "Pick output formatter. Available: #{::Pronto::Formatter.names.join(', ')}"
 
-    def run
+    def run(path = nil)
       gem_names = options[:runner].any? ? options[:runner] : ::Pronto.gem_names
       gem_names.each do |gem_name|
         require "pronto/#{gem_name}"
       end
 
       formatter = ::Pronto::Formatter.get(options[:formatter])
-      messages = ::Pronto.run(options[:commit], '.', formatter)
+      commit = options[:index] ? :index : options[:commit]
+      messages = ::Pronto.run(commit, '.', formatter, path)
       exit(messages.count) if options[:'exit-code']
     rescue Rugged::RepositoryError
       puts '"pronto" should be run from a git repository'

data/lib/pronto/formatter/checkstyle_formatter.rb

@@ -25,7 +25,7 @@ module Pronto
       end
 
       def process_messages(messages)
-        group_messages(messages).map do |path, path_messages|
+        messages.group_by(&:path).map do |path, path_messages|
           REXML::Element.new('file', @checkstyle).tap do |file|
             file.attributes['name'] = path
             add_file_messages(path_messages, file)
@@ -33,10 +33,6 @@ module Pronto
         end
       end
 
-      def group_messages(messages)
-        messages.group_by { |message| message.path }
-      end
-
       def add_file_messages(path_messages, file)
         path_messages.each do |message|
           REXML::Element.new('error', file).tap do |e|

data/lib/pronto/formatter/formatter.rb

@@ -12,6 +12,7 @@ module Pronto
     FORMATTERS = {
       'github' => GithubFormatter,
       'github_pr' => GithubPullRequestFormatter,
+      'gitlab' => GitlabFormatter,
       'json' => JsonFormatter,
       'checkstyle' => CheckstyleFormatter,
       'text' => TextFormatter

data/lib/pronto/formatter/github_formatter.rb

@@ -2,15 +2,16 @@ module Pronto
   module Formatter
     class GithubFormatter
       def format(messages, repo)
+        messages = messages.uniq { |message| [message.msg, message.line.new_lineno] }
+        client = Github.new(repo)
+
         commit_messages = messages.map do |message|
-          github_slug = repo.github_slug
           sha = message.commit_sha
           body = message.msg
           path = message.path
           position = message.line.commit_line.position if message.line
 
-          comment = Github::Comment.new(github_slug, sha, body, path, position)
-          create_comment(github_slug, sha, comment)
+          create_comment(client, sha, body, path, position)
         end
 
         "#{commit_messages.compact.count} Pronto messages posted to GitHub"
@@ -18,14 +19,11 @@ module Pronto
 
       private
 
-      def create_comment(repo, sha, comment)
-        comments = client.commit_comments(repo, sha)
+      def create_comment(client, sha, body, path, position)
+        comment = Github::Comment.new(sha, body, path, position)
+        comments = client.commit_comments(sha)
         existing = comments.any? { |c| comment == c }
-        client.create_commit_comment(repo, sha, comment) unless existing
-      end
-
-      def client
-        @client ||= Github.new
+        client.create_commit_comment(comment) unless existing
       end
     end
   end

data/lib/pronto/formatter/github_pull_request_formatter.rb

@@ -2,8 +2,10 @@ module Pronto
   module Formatter
     class GithubPullRequestFormatter
       def format(messages, repo)
+        messages = messages.uniq { |message| [message.msg, message.line.new_lineno] }
+        client = Github.new(repo)
+
         commit_messages = messages.map do |message|
-          github_slug = repo.github_slug
           body = message.msg
           path = message.path
 
@@ -16,8 +18,7 @@ module Pronto
             line
           end
 
-          comment = Github::Comment.new(github_slug, sha, body, path, line.position)
-          create_comment(github_slug, sha, comment)
+          create_comment(client, sha, body, path, line.position)
         end
 
         "#{commit_messages.compact.count} Pronto messages posted to GitHub"
@@ -25,14 +26,11 @@ module Pronto
 
       private
 
-      def create_comment(repo, sha, comment)
-        comments = client.pull_comments(repo, sha)
+      def create_comment(client, sha, body, path, position)
+        comment = Github::Comment.new(sha, body, path, position)
+        comments = client.pull_comments(sha)
         existing = comments.any? { |c| comment == c }
-        client.create_pull_comment(repo, sha, comment) unless existing
-      end
-
-      def client
-        @client ||= Github.new
+        client.create_pull_comment(comment) unless existing
       end
     end
   end

data/lib/pronto/formatter/gitlab_formatter.rb

@@ -0,0 +1,29 @@
+module Pronto
+  module Formatter
+    class GitlabFormatter
+      def format(messages, repo)
+        messages = messages.uniq { |message| [message.msg, message.line.new_lineno] }
+        client = Gitlab.new repo
+
+        commit_messages = messages.map do |message|
+          create_comment(client,
+                         message.commit_sha,
+                         message.msg,
+                         message.path,
+                         message.line.commit_line.new_lineno)
+        end
+
+        "#{commit_messages.compact.count} Pronto messages posted to GitLab"
+      end
+
+      private
+
+      def create_comment(client, sha, note, path, line)
+        comment = Gitlab::Comment.new(sha, note, path, line)
+        comments = client.commit_comments(sha)
+        existing = comments.any? { |c| comment == c }
+        client.create_commit_comment(comment) unless existing
+      end
+    end
+  end
+end

data/lib/pronto/git/repository.rb

@@ -7,14 +7,15 @@ module Pronto
         @repo = Rugged::Repository.new(path)
       end
 
-      def github_slug
-        remotes.map(&:github_slug).compact.first
-      end
-
-      def diff(commit)
-        merge_base = merge_base(commit)
-        patches = @repo.diff(merge_base, head)
-        Patches.new(self, merge_base, patches)
+      def diff(commit, options = nil)
+        if commit == :index
+          patches = @repo.index.diff(options)
+          Patches.new(self, head, patches)
+        else
+          merge_base = merge_base(commit)
+          patches = @repo.diff(merge_base, head, options)
+          Patches.new(self, merge_base, patches)
+        end
       end
 
       def show_commit(sha)
@@ -50,6 +51,14 @@ module Pronto
                           track_copies_any_commit_copies: true)[0]
       end
 
+      def branch
+        @repo.head.name.sub('refs/heads/', '') if @repo.head.branch?
+      end
+
+      def remote_urls
+        @repo.remotes.map(&:url)
+      end
+
       private
 
       def empty_patches(sha)
@@ -63,10 +72,6 @@ module Pronto
       def head
         @repo.head.target
       end
-
-      def remotes
-        @remotes ||= @repo.remotes.map { |remote| Remote.new(remote) }
-      end
     end
   end
 end

data/lib/pronto/github.rb

@@ -1,50 +1,73 @@
 module Pronto
   class Github
-    def initialize
+    def initialize(repo)
+      @repo = repo
       @comment_cache = {}
+      @pull_id_cache = {}
     end
 
-    def pull_comments(repo, sha)
-      @comment_cache["#{repo}/#{pull_id}/#{sha}"] ||= begin
-        client.pull_comments(repo, pull_id).map do |comment|
-          Comment.new(repo, sha, comment.body, comment.path, comment.position)
+    def pull_comments(sha)
+      @comment_cache["#{pull_id}/#{sha}"] ||= begin
+        client.pull_comments(slug, pull_id).map do |comment|
+          Comment.new(sha, comment.body, comment.path, comment.position)
         end
       end
     end
 
-    def commit_comments(repo, sha)
-      @comment_cache["#{repo}/#{sha}"] ||= begin
-        client.commit_comments(repo, sha).map do |comment|
-          Comment.new(repo, sha, comment.body, comment.path, comment.position)
+    def commit_comments(sha)
+      @comment_cache["#{sha}"] ||= begin
+        client.commit_comments(slug, sha).map do |comment|
+          Comment.new(sha, comment.body, comment.path, comment.position)
         end
       end
     end
 
-    def create_commit_comment(repo, sha, comment)
-      client.create_commit_comment(repo, sha, comment.body, comment.path,
-                                   nil, comment.position)
+    def create_commit_comment(comment)
+      client.create_commit_comment(slug, comment.sha, comment.body,
+                                   comment.path, nil, comment.position)
     end
 
-    def create_pull_comment(repo, sha, comment)
-      client.create_pull_comment(repo, pull_id, comment.body, sha, comment.path,
-                                 comment.position)
+    def create_pull_comment(comment)
+      client.create_pull_comment(slug, pull_id, comment.body,
+                                 comment.sha, comment.path, comment.position)
     end
 
     private
 
+    def slug
+      @slug ||= begin
+        @repo.remote_urls.map do |url|
+          match = /.*github.com(:|\/)(?<slug>.*).git/.match(url)
+          match[:slug] if match
+        end.compact.first
+      end
+    end
+
     def client
       @client ||= Octokit::Client.new(access_token: access_token)
     end
 
+    def pull_requests
+      @pull_requests ||= client.pull_requests(slug)
+    end
+
     def pull_id
-      ENV['PULL_REQUEST_ID'].to_i
+      @pull_id ||= begin
+        pull_id = ENV['PULL_REQUEST_ID']
+        if pull_id
+          pull_id.to_i
+        elsif @repo.branch
+          pull = pull_requests.find { |pr| pr[:head][:ref] == @repo.branch }
+          pull[:number].to_i if pull
+        end
+      end
     end
 
     def access_token
       ENV['GITHUB_ACCESS_TOKEN']
     end
 
-    class Comment < Struct.new(:repo, :sha, :body, :path, :position)
+    class Comment < Struct.new(:sha, :body, :path, :position)
       def ==(other)
         position == other.position &&
           path == other.path &&

data/lib/pronto/gitlab.rb

@@ -0,0 +1,55 @@
+module Pronto
+  class Gitlab
+    def initialize(repo)
+      @repo = repo
+      @comment_cache = {}
+    end
+
+    def commit_comments(sha)
+      @comment_cache["#{sha}"] ||= begin
+        client.commit_comments(slug, sha).map do |comment|
+          Comment.new(sha, comment.note, comment.path, comment.line)
+        end
+      end
+    end
+
+    def create_commit_comment(comment)
+      client.create_commit_comment(slug, comment.sha, comment.note,
+                                   path: comment.path, line: comment.line,
+                                   line_type: 'new')
+    end
+
+    private
+
+    def slug
+      @slug ||= begin
+        host = URI.split(endpoint)[2, 2].compact.join(':')
+        slug = @repo.remote_urls.map do |url|
+          match = /.*#{host}(:|\/)(?<slug>.*).git/.match(url)
+          match[:slug] if match
+        end.compact.first
+        URI.escape(slug, '/') if slug
+      end
+    end
+
+    def client
+      @client ||= ::Gitlab.client(endpoint: endpoint, private_token: private_token)
+    end
+
+    def private_token
+      ENV['GITLAB_API_PRIVATE_TOKEN']
+    end
+
+    def endpoint
+      ENV['GITLAB_API_ENDPOINT']
+    end
+
+    class Comment < Struct.new(:sha, :note, :path, :line)
+      def ==(other)
+        line == other.line &&
+          path == other.path &&
+          note == other.note
+      end
+    end
+  end
+end

data/lib/pronto/version.rb

@@ -1,3 +1,3 @@
 module Pronto
-  VERSION = '0.3.3'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pronto
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Mindaugas Mozūras
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-28 00:00:00.000000000 Z
+date: 2015-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: gitlab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +128,15 @@ files:
 - lib/pronto/formatter/formatter.rb
 - lib/pronto/formatter/github_formatter.rb
 - lib/pronto/formatter/github_pull_request_formatter.rb
+- lib/pronto/formatter/gitlab_formatter.rb
 - lib/pronto/formatter/json_formatter.rb
 - lib/pronto/formatter/text_formatter.rb
 - lib/pronto/git/line.rb
 - lib/pronto/git/patch.rb
 - lib/pronto/git/patches.rb
-- lib/pronto/git/remote.rb
 - lib/pronto/git/repository.rb
 - lib/pronto/github.rb
+- lib/pronto/gitlab.rb
 - lib/pronto/message.rb
 - lib/pronto/plugin.rb
 - lib/pronto/rake_task/travis_pull_request.rb
@@ -147,8 +162,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Pronto runs analysis by checking only the introduced changes
 test_files: []
+has_rdoc: 

data/lib/pronto/git/remote.rb

@@ -1,10 +0,0 @@
-module Pronto
-  module Git
-    class Remote < Struct.new(:remote)
-      def github_slug
-        match = /.*github.com(:|\/)(?<slug>.*).git/.match(remote.url)
-        match[:slug] if match
-      end
-    end
-  end
-end