pronto 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd8b0fda3d023e477bd597284d3e03929203c630
-  data.tar.gz: c288acc2abfe04edfaf9019ab9a88e6e31ff1546
+  metadata.gz: 800c72660ff1c44c50bcb121d16addbdd3155035
+  data.tar.gz: 1e69d5e353aa63b326b21845f31d00d3d2a6e6dc
 SHA512:
-  metadata.gz: fb4693ed64d9c46496d2df7414613609120b56dc3673b97729dd4dcb6fc2866624f1b49c800575562634fff7e7dc824a0bf22db2f77c7766d2a205828a4695ce
-  data.tar.gz: ea08d936438b0af186d709736166b88043a0487acf100ca6f0af2d51a5b4b676f3e2ba537c1ed2e83eb3afb7f01d679546198c11e95dee8d29f4852dff201a51
+  metadata.gz: 6da3eb9370bd8b8f6a65a07fcfdd5ef8d6a2d2ff655ee8d5ae541cbc5a8036412c46b92130c2a8bcc60517332b3a6998db56a9c9a3e1d8a751c59c5ce26461c0
+  data.tar.gz: b0c0b6cb81e088dc11bd4d97fe06440345c32b924f66d02a208af5ef6f46ade2cbb52dbbce19e275feb0ba2bad9d069cf06d44eb715cd02e4c9291097dd7300d

data/README.md

@@ -4,14 +4,48 @@
 [![Build Status](https://secure.travis-ci.org/mmozuras/pronto.png)](http://travis-ci.org/mmozuras/pronto)
 [![Dependency Status](https://gemnasium.com/mmozuras/pronto.png)](https://gemnasium.com/mmozuras/pronto)
 
-
 ## Usage
 
-pronto runs static analysis on your branches quickly by analysing only the
-introduced changes.
+Pronto runs analysis quickly by checking only the introduced changes.
+
+### Pull Requests
+
+You can run Pronto as part of your builds and then get results as commit
+comments using `GithubFormatter`.
+
+Actually, Pronto runs Pronto whenever you make a pull request on Pronto. It
+uses Travis CI and the included `TravisPullRequest` rake task for that.
+
+To do the same, start by adding Pronto runners you want to use to your Gemfile:
+```ruby
+  gem 'pronto-rubocop'
+```
+or gemspec file:
+```ruby
+  s.add_development_dependency 'pronto-rubocop'
+```
+Then run it using the included rake task or manually.
+
+### Local Changes
+
+You can run Pronto locally. First, install Pronto and runners you want to use:
+```bash
+  gem install pronto
+  gem install pronto-rubocop
+```
+Then navigate to repository you want run Pronto on, and:
+```bash
+  git checkout feature/branch
+  pronto exec # Pronto runs against master by default
+```
+
+Run `pronto` in your terminal without any arguments to see what more Pronto is
+capable off.
 
-## Installation
+## Runners
 
-Install like any other Ruby gem:
+Pronto can run various tools and libraries, as long as there's a runner for it.
+Currently available runners:
 
-    gem install pronto
+* [pronto-rubocop](https://github.com/mmozuras/pronto-rubocop)
+* [pronto-flay](https://github.com/mmozuras/pronto-flay)

data/lib/pronto/cli.rb

@@ -23,28 +23,17 @@ module Pronto
                   type: :string,
                   default: nil,
                   aliases: '-f',
-                  banner: "Formatter, defaults to text. Available: #{::Pronto::Formatter.names.join(', ')}"
-
-    method_option :access_token,
-                  type: :string,
-                  default: nil,
-                  aliases: '-t',
-                  banner: 'Github access token, used for github formatter'
+                  banner: "Formatter, defaults to text.
+                           Available: #{::Pronto::Formatter.names.join(', ')}"
 
     def exec
-      gem_names = options[:runner].any? ? options[:runner]
-                                        : ::Pronto.gem_names
+      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])
-      if formatter.is_a? ::Pronto::Formatter::GithubFormatter
-        access_token = options[:access_token]
-        formatter.client = Octokit::Client.new(access_token: access_token)
-      end
-
-      puts ::Pronto.run(options[:commit], '.', formatter)
+      ::Pronto.run(options[:commit], '.', formatter)
     rescue Rugged::RepositoryError
       puts '"pronto" should be run from a git repository'
     end

data/lib/pronto/formatter/github_formatter.rb

@@ -3,31 +3,50 @@ require 'octokit'
 module Pronto
   module Formatter
     class GithubFormatter
-      attr_writer :client
-
       def format(messages)
         messages.each do |message|
-          @client.create_commit_comment(github_slug(message),
-                                        sha(message),
-                                        message.msg,
-                                        message.path,
-                                        message.line.new_lineno)
-        end
+          repo = github_slug(message)
+          sha = commit_sha(message)
+          position = message.line.position
+          path = message.path
+          body = message.msg
 
-        "#{messages.count} pronto messages posted to GitHub"
+          create_commit_comment(repo, sha, position, path, body)
+        end
       end
 
       private
 
+      def create_commit_comment(repo, sha, position, path, body)
+        commit_comments = client.commit_comments(repo, sha)
+        existing_comment = commit_comments.find do |comment|
+          comment.position = position &&
+            comment.path == path &&
+            comment.body == body
+        end
+
+        if existing_comment.nil?
+          client.create_commit_comment(repo, sha, body, path, nil, position)
+        end
+      end
+
+      def access_token
+        ENV['GITHUB_ACCESS_TOKEN']
+      end
+
+      def client
+        @client ||= Octokit::Client.new(access_token: access_token)
+      end
+
       def github_slug(message)
         message.repo.remotes.map(&:github_slug).compact.first
       end
 
-      def sha(message)
+      def commit_sha(message)
         blamelines = blame(message).lines
         lineno = message.line.new_lineno
 
-        blameline = blamelines.detect { |line| line.lineno == lineno }
+        blameline = blamelines.find { |line| line.lineno == lineno }
 
         blameline.commit.id if blameline
       end

data/lib/pronto/rake_task/travis_pull_request.rb

@@ -0,0 +1,61 @@
+require 'pronto'
+require 'octokit'
+require 'rake'
+require 'rake/tasklib'
+
+module Pronto
+  module RakeTask
+    # Provides a custom rake task to use with Travis.
+    #
+    # require 'rubocop/rake/travis_pull_request'
+    # Pronto::Rake::TravisPullRequest.new
+    class TravisPullRequest < Rake::TaskLib
+      attr_accessor :name
+      attr_accessor :verbose
+
+      def initialize(*args, &task_block)
+        setup_ivars(args)
+
+        unless ::Rake.application.last_comment
+          desc 'Run Pronto on Travis Pull Request'
+        end
+
+        task(name, *args) do |_, task_args|
+          RakeFileUtils.send(:verbose, verbose) do
+            if task_block
+              task_block.call(*[self, task_args].slice(0, task_block.arity))
+            end
+            run_task(verbose)
+          end
+        end
+      end
+
+      def run_task(verbose)
+        return if pull_request_number.nil? || pull_request_number == 'false'
+
+        client = Octokit::Client.new
+
+        pull_request = client.pull_request(repo_slug, pull_request_number)
+        formatter = ::Pronto::Formatter::GithubFormatter.new
+
+        ::Pronto.gem_names.each { |gem_name| require "pronto/#{gem_name}" }
+        ::Pronto.run(pull_request.base.sha, '.', formatter)
+      end
+
+      private
+
+      def pull_request_number
+        ENV['TRAVIS_PULL_REQUEST']
+      end
+
+      def repo_slug
+        ENV['TRAVIS_REPO_SLUG']
+      end
+
+      def setup_ivars(args)
+        @name = args.shift || :pronto_travis_pull_request
+        @verbose = true
+      end
+    end
+  end
+end

data/lib/pronto/version.rb

@@ -1,3 +1,3 @@
 module Pronto
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/rugged/diff/line.rb

@@ -4,6 +4,20 @@ module Rugged
       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 ==(other)
+        content == other.content &&
+          line_origin == other.line_origin &&
+          old_lineno == other.old_lineno &&
+          new_lineno == other.new_lineno
+      end
     end
   end
 end

data/lib/rugged/diff/patch.rb

@@ -13,8 +13,6 @@ module Rugged
         delta.new_file_full_path
       end
 
-      private
-
       def lines
         map(&:lines).flatten.compact
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pronto
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Mindaugas Mozūras
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-22 00:00:00.000000000 Z
+date: 2013-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: grit
   requirement: !ruby/object:Gem::Requirement
@@ -94,7 +94,21 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.14.0
-description: pronto
+- !ruby/object:Gem::Dependency
+  name: pronto-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: 
 email: mindaugas.mozuras@gmail.com
 executables:
 - pronto
@@ -108,6 +122,7 @@ files:
 - lib/pronto/formatter/text_formatter.rb
 - lib/pronto/message.rb
 - lib/pronto/plugin.rb
+- lib/pronto/rake_task/travis_pull_request.rb
 - lib/pronto/runner.rb
 - lib/pronto/version.rb
 - lib/pronto.rb
@@ -144,6 +159,6 @@ rubyforge_project:
 rubygems_version: 2.0.7
 signing_key: 
 specification_version: 4
-summary: pronto
+summary: Pronto runs analysis quickly by checking only the introduced changes
 test_files: []
 has_rdoc: