pronto 0.2.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f111d71e81d706ca4c7b27acb6b7975f41c3a228
-  data.tar.gz: 6e095990250968f7d9b21fd18408f6080587bd03
+  metadata.gz: eab403503e8dbeb40f3d944afe3e66d7a6cabca2
+  data.tar.gz: d57522b4873da0a0ea3f2034107469f026c33e0e
 SHA512:
-  metadata.gz: 16cbef1d33a4944b03650b71e08ae9ddda91f424b0cf8e3ca62a8bd8fa155623e6433b906e4bb29732b4d0951c86dfdd7a3e619d8f1571fd5bc1c9b8ffccc425
-  data.tar.gz: dc71ff6f03901e319fdff52d4e13837b76be86f0d80a065da512f3d6a6f8849aa3a1d15c2a3bf037d0797f2fb38677fb1b0220ad41c95176cbbb2ba638d9139d
+  metadata.gz: f4ede27aa270973fb03c9ba2b1431f1cf9e1cef42b527719f66b9aa3ac855cdb7e352b59bd21de000bc47c5af19f44b778229e319adece9a9a5f342ee2a3d36e
+  data.tar.gz: 345071ecbe13dd72c6d3dbfb807bbf345317d72cacf9bf3fbcb9f009c861f9154b09bbd248c37db33006fe6773fbd044ffd246c5072fd99dce886913610a5e35

data/lib/pronto.rb

@@ -1,34 +1,38 @@
 require 'rugged'
-require 'pronto/rugged/diff'
-require 'pronto/rugged/diff/delta'
-require 'pronto/rugged/diff/patch'
-require 'pronto/rugged/diff/line'
-require 'pronto/rugged/tree'
-require 'pronto/rugged/remote'
-require 'pronto/rugged/repository'
-require 'pronto/rugged/commit'
+require 'octokit'
+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/formatter/text_formatter'
 require 'pronto/formatter/json_formatter'
 require 'pronto/formatter/github_formatter'
+require 'pronto/formatter/github_pull_request_formatter'
 require 'pronto/formatter/checkstyle_formatter'
 require 'pronto/formatter/formatter'
 
 module Pronto
   def self.run(commit = 'master', repo_path = '.', formatter = nil)
-    repo = Rugged::Repository.new(repo_path)
     commit ||= 'master'
-    merge_base = repo.merge_base(commit, repo.head.target)
-    patches = repo.diff(merge_base, repo.head.target)
 
-    result = run_all_runners(patches, merge_base)
+    repo = Git::Repository.new(repo_path)
+    patches = repo.diff(commit)
+
+    result = run_all_runners(patches)
 
     formatter ||= default_formatter
-    formatter.format(result, repo)
+    puts formatter.format(result, repo)
+
+    result
   end
 
   def self.gem_names
@@ -37,7 +41,7 @@ module Pronto
         true
       elsif gem.name != 'pronto'
         runner_path = File.join(gem.full_gem_path, "lib/pronto/#{gem.name}.rb")
-        File.exists?(runner_path)
+        File.exist?(runner_path)
       end
     end
 
@@ -48,9 +52,9 @@ module Pronto
 
   private
 
-  def self.run_all_runners(patches, commit)
+  def self.run_all_runners(patches)
     Runner.runners.map do |runner|
-      runner.new.run(patches, commit)
+      runner.new.run(patches, patches.commit)
     end.flatten.compact
   end
 

data/lib/pronto/cli.rb

@@ -14,6 +14,10 @@ module Pronto
 
     desc 'run', 'Run Pronto'
 
+    method_option :'exit-code',
+                  type: :boolean,
+                  banner: 'Exits with non-zero code if there were any warnings/errors.'
+
     method_option :commit,
                   type: :string,
                   default: 'master',
@@ -39,7 +43,8 @@ module Pronto
       end
 
       formatter = ::Pronto::Formatter.get(options[:formatter])
-      puts ::Pronto.run(options[:commit], '.', formatter)
+      messages = ::Pronto.run(options[:commit], '.', formatter)
+      exit(messages.count) if options[:'exit-code']
     rescue Rugged::RepositoryError
       puts '"pronto" should be run from a git repository'
     end

data/lib/pronto/formatter/formatter.rb

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

data/lib/pronto/formatter/github_formatter.rb

@@ -1,17 +1,16 @@
-require 'octokit'
-
 module Pronto
   module Formatter
     class GithubFormatter
       def format(messages, repo)
         commit_messages = messages.map do |message|
-          github_slug = repo.remotes.map(&:github_slug).compact.first
+          github_slug = repo.github_slug
           sha = message.commit_sha
-          position = message.line.commit_line.position if message.line
-          path = message.path
           body = message.msg
+          path = message.path
+          position = message.line.commit_line.position if message.line
 
-          create_comment(github_slug, sha, position, path, body)
+          comment = Github::Comment.new(github_slug, sha, body, path, position)
+          create_comment(github_slug, sha, comment)
         end
 
         "#{commit_messages.compact.count} Pronto messages posted to GitHub"
@@ -19,26 +18,14 @@ module Pronto
 
       private
 
-      def create_comment(repo, sha, position, path, body)
+      def create_comment(repo, sha, comment)
         comments = client.commit_comments(repo, sha)
-
-        existing_comment = comments.find do |comment|
-          comment.position == position &&
-            comment.path == path &&
-            comment.body == body
-        end
-
-        unless existing_comment
-          client.create_commit_comment(repo, sha, body, path, nil, position)
-        end
-      end
-
-      def access_token
-        ENV['GITHUB_ACCESS_TOKEN']
+        existing = comments.any? { |c| comment == c }
+        client.create_commit_comment(repo, sha, comment) unless existing
       end
 
       def client
-        @client ||= Octokit::Client.new(access_token: access_token)
+        @client ||= Github.new
       end
     end
   end

data/lib/pronto/formatter/github_pull_request_formatter.rb

@@ -0,0 +1,41 @@
+module Pronto
+  module Formatter
+    class GithubPullRequestFormatter
+      def format(messages, repo)
+        commit_messages = messages.map do |message|
+          github_slug = repo.github_slug
+          body = message.msg
+          path = message.path
+
+          commits = repo.commits_until(message.commit_sha)
+
+          line = nil
+          sha = commits.find do |commit|
+            patches = repo.show_commit(commit)
+            line = patches.find_line(message.full_path, message.line.new_lineno)
+            line
+          end
+
+          position = line.position - 1
+
+          comment = Github::Comment.new(github_slug, sha, body, path, position)
+          create_comment(github_slug, sha, comment)
+        end
+
+        "#{commit_messages.compact.count} Pronto messages posted to GitHub"
+      end
+
+      private
+
+      def create_comment(repo, sha, comment)
+        comments = client.pull_comments(repo, sha)
+        existing = comments.any? { |c| comment == c }
+        client.create_pull_comment(repo, sha, comment) unless existing
+      end
+
+      def client
+        @client ||= Github.new
+      end
+    end
+  end
+end

data/lib/pronto/git/line.rb

@@ -0,0 +1,44 @@
+module Pronto
+  module Git
+    class Line < Struct.new(:line, :patch, :hunk)
+      extend Forwardable
+
+      def_delegators :line, :addition?, :deletion?, :content, :new_lineno,
+                     :old_lineno, :line_origin
+
+      def position
+        hunk_index = patch.hunks.find_index { |h| h.header == hunk.header }
+        line_index = patch.lines.find_index(line)
+
+        line_index + hunk_index + 1
+      end
+
+      def commit_sha
+        blame[:final_commit_id] if blame
+      end
+
+      def commit_line
+        @commit_line ||= begin
+          patches = patch.repo.show_commit(commit_sha)
+
+          result = patches.find_line(patch.new_file_full_path,
+                                     blame[:orig_start_line_number])
+          result || self # no commit_line means that it was just added
+        end
+      end
+
+      def ==(other)
+        content == other.content &&
+          line_origin == other.line_origin &&
+          old_lineno == other.old_lineno &&
+          new_lineno == other.new_lineno
+      end
+
+      private
+
+      def blame
+        @blame ||= patch.blame(new_lineno)
+      end
+    end
+  end
+end

data/lib/pronto/git/patch.rb

@@ -0,0 +1,41 @@
+module Pronto
+  module Git
+    class Patch < Struct.new(:patch, :repo)
+      extend Forwardable
+
+      def_delegators :patch, :delta, :hunks, :stat
+
+      def additions
+        stat[0]
+      end
+
+      def deletions
+        stat[1]
+      end
+
+      def blame(lineno)
+        repo.blame(self, lineno)
+      end
+
+      def lines
+        @lines ||= begin
+          hunks.flat_map do |hunk|
+            hunk.lines.map { |line| Line.new(line, self, hunk) }
+          end
+        end
+      end
+
+      def added_lines
+        lines.select(&:addition?)
+      end
+
+      def deleted_lines
+        lines.select(&:deletion?)
+      end
+
+      def new_file_full_path
+        repo.path.join(delta.new_file[:path])
+      end
+    end
+  end
+end

data/lib/pronto/git/patches.rb

@@ -0,0 +1,24 @@
+module Pronto
+  module Git
+    class Patches
+      include Enumerable
+
+      attr_reader :commit, :repo
+
+      def initialize(repo, commit, patches)
+        @commit = commit
+        @patches = patches.map { |patch| Git::Patch.new(patch, repo) }
+      end
+
+      def each(&block)
+        @patches.each(&block)
+      end
+
+      def find_line(path, line)
+        patch = find { |p| p.new_file_full_path == path }
+        lines = patch ? patch.lines : []
+        lines.find { |l| l.new_lineno == line }
+      end
+    end
+  end
+end

data/lib/pronto/git/remote.rb

@@ -0,0 +1,10 @@
+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

data/lib/pronto/git/repository.rb

@@ -0,0 +1,68 @@
+require 'pathname'
+
+module Pronto
+  module Git
+    class Repository
+      def initialize(path)
+        @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)
+      end
+
+      def show_commit(sha)
+        return [] unless sha
+
+        commit = @repo.lookup(sha)
+        return [] if commit.parents.count != 1
+
+        # TODO: Rugged does not seem to support diffing against multiple parents
+        diff = commit.diff(reverse: true)
+        return [] if diff.nil?
+
+        Patches.new(self, sha, diff.patches)
+      end
+
+      def commits_until(sha)
+        result = []
+        @repo.walk('HEAD', Rugged::SORT_TOPO).take_while do |commit|
+          result << commit.oid
+          !commit.oid.start_with?(sha)
+        end
+        result
+      end
+
+      def path
+        Pathname.new(@repo.path).parent
+      end
+
+      def blame(patch, lineno)
+        Rugged::Blame.new(@repo, patch.delta.new_file[:path],
+                          min_line: lineno, max_line: lineno,
+                          track_copies_same_file: true,
+                          track_copies_any_commit_copies: true)[0]
+      end
+
+      private
+
+      def merge_base(commit)
+        @repo.merge_base(commit, head)
+      end
+
+      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

@@ -0,0 +1,55 @@
+module Pronto
+  class Github
+    def initialize
+      @comment_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)
+        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)
+        end
+      end
+    end
+
+    def create_commit_comment(repo, sha, comment)
+      client.create_commit_comment(repo, 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)
+    end
+
+    private
+
+    def client
+      @client ||= Octokit::Client.new(access_token: access_token)
+    end
+
+    def pull_id
+      ENV['PULL_REQUEST_ID'].to_i
+    end
+
+    def access_token
+      ENV['GITHUB_ACCESS_TOKEN']
+    end
+
+    class Comment < Struct.new(:repo, :sha, :body, :path, :position)
+      def ==(other)
+        position == other.position &&
+          path == other.path &&
+          body == other.body
+      end
+    end
+  end
+end

data/lib/pronto/message.rb

@@ -17,8 +17,12 @@ module Pronto
       @commit_sha ||= line.commit_sha if line
     end
 
+    def full_path
+      repo.path.join(path) if repo
+    end
+
     def repo
-      line.patch.delta.repo if line
+      line.patch.repo if line
     end
   end
 end

data/lib/pronto/rake_task/travis_pull_request.rb

@@ -1,5 +1,4 @@
 require 'pronto'
-require 'octokit'
 require 'rake'
 require 'rake/tasklib'
 

data/lib/pronto/version.rb

@@ -1,3 +1,3 @@
 module Pronto
-  VERSION = '0.2.6'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pronto
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
 platform: ruby
 authors:
 - Mindaugas Mozūras
@@ -14,122 +14,86 @@ dependencies:
   name: rugged
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 0.19.0
-    - - <=
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: 0.21.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 0.19.0
-    - - <=
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: 0.21.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.19'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.19'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.19.0
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.7'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 2.7.1
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.7'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 2.7.1
+        version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: grit
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.5'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 2.5.0
-  type: :runtime
+        version: '10.3'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.5'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: '10.3'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '10.1'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '10.1'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.14'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 2.14.0
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.14'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 2.14.0
+        version: '1.0'
 description: |2
       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
@@ -149,19 +113,18 @@ files:
 - lib/pronto/formatter/checkstyle_formatter.rb
 - lib/pronto/formatter/formatter.rb
 - lib/pronto/formatter/github_formatter.rb
+- lib/pronto/formatter/github_pull_request_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/message.rb
 - lib/pronto/plugin.rb
 - lib/pronto/rake_task/travis_pull_request.rb
-- lib/pronto/rugged/commit.rb
-- lib/pronto/rugged/diff.rb
-- lib/pronto/rugged/diff/delta.rb
-- lib/pronto/rugged/diff/line.rb
-- lib/pronto/rugged/diff/patch.rb
-- lib/pronto/rugged/remote.rb
-- lib/pronto/rugged/repository.rb
-- lib/pronto/rugged/tree.rb
 - lib/pronto/runner.rb
 - lib/pronto/version.rb
 homepage: http://github.org/mmozuras/pronto

data/lib/pronto/rugged/commit.rb

@@ -1,9 +0,0 @@
-module Rugged
-  class Commit
-    def show
-      # TODO: Rugged does not seem to support diffing against multiple parents
-      return if parents.count != 1
-      diff(parents.first, reverse: true)
-    end
-  end
-end

data/lib/pronto/rugged/diff.rb

@@ -1,6 +0,0 @@
-module Rugged
-  class Diff
-    attr_reader :owner
-    alias_method :tree, :owner
-  end
-end

data/lib/pronto/rugged/diff/delta.rb

@@ -1,16 +0,0 @@
-require 'pathname'
-
-module Rugged
-  class Diff
-    class Delta
-      def repo
-        diff.tree.repo
-      end
-
-      def new_file_full_path
-        repo_path = Pathname.new(repo.path).parent
-        repo_path.join(new_file[:path])
-      end
-    end
-  end
-end

data/lib/pronto/rugged/diff/line.rb

@@ -1,63 +0,0 @@
-module Rugged
-  class Diff
-    class Line
-      def patch
-        hunk.owner
-      end
-
-      def position
-        hunk_index = patch.hunks.find_index { |h| h.header == hunk.header }
-        line_index = patch.lines.find_index(self)
-
-        line_index + hunk_index + 1
-      end
-
-      def commit
-        @commit ||= begin
-          repo.lookup(commit_sha) if commit_sha
-        end
-      end
-
-      def commit_sha
-        @commit_sha ||= begin
-          blameline.commit.id if blameline
-        end
-      end
-
-      def commit_line
-        @commit_line ||= begin
-          diff = commit.show
-          patches = diff ? diff.patches : []
-          commit_patch = patches.find do |p|
-            patch.new_file_full_path == p.new_file_full_path
-          end
-
-          lines = commit_patch ? commit_patch.lines : []
-          result = lines.find { |l| blameline.lineno == l.new_lineno }
-
-          result || self # no commit_line means that it was just added
-        end
-      end
-
-      def ==(other)
-        content == other.content &&
-          line_origin == other.line_origin &&
-          old_lineno == other.old_lineno &&
-          new_lineno == other.new_lineno
-      end
-
-      private
-
-      def repo
-        patch.diff.tree.repo
-      end
-
-      def blameline
-        @blameline ||= begin
-          blamelines = repo.blame(patch.new_file_full_path).lines
-          blamelines.find { |line| line.lineno == new_lineno }
-        end
-      end
-    end
-  end
-end

data/lib/pronto/rugged/diff/patch.rb

@@ -1,21 +0,0 @@
-module Rugged
-  class Diff
-    class Patch
-      def added_lines
-        lines.select(&:addition?)
-      end
-
-      def deleted_lines
-        lines.select(&:deletion?)
-      end
-
-      def new_file_full_path
-        delta.new_file_full_path
-      end
-
-      def lines
-        map(&:lines).flatten.compact
-      end
-    end
-  end
-end

data/lib/pronto/rugged/remote.rb

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

data/lib/pronto/rugged/repository.rb

@@ -1,11 +0,0 @@
-require 'grit'
-
-module Rugged
-  class Repository
-    def blame(filepath)
-      # TODO: Using grit blame implementation for now.
-      # Replace it with Rugged implementation when it's available.
-      ::Grit::Repo.new(path).blame(filepath, 'HEAD')
-    end
-  end
-end

data/lib/pronto/rugged/tree.rb

@@ -1,6 +0,0 @@
-module Rugged
-  class Tree
-    attr_reader :owner
-    alias_method :repo, :owner
-  end
-end