danger-pep8 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3fad07b15f8e3bca5bd67f2bab48c7b52f6b47c5
-  data.tar.gz: 900c6d44722334ac1ae821c3c73afa3be5bd65c0
+  metadata.gz: 8946ed7fb42ae6a537a53fc8f957fc5a207a7786
+  data.tar.gz: e18b77d8b3e07890747d802f9d4931e491060133
 SHA512:
-  metadata.gz: dd32ea40a8e36a8bd3005c7af89b2a30ba0d329c3e08cf78f84af00bb898455018e3ab61a9e4fc8bbcb090a5f96d888cf60300f870f8872a4725045f198718af
-  data.tar.gz: 33860ae9b9c38408b787ed3e04225ae8926cd92e8929a9961c956699dcab4206cb3930bcdaa0209b6ffaf11e2ba59d4d3e6aea95020e257bcea93f152539fb6a
+  metadata.gz: 782b3c8a213a339ce9b986857d7061f09b691b1cd21fdb619f745933b318fd864e9b2dcd0ee79004c72af2aba3ecc6611282e53ab715f9157c5b125b3b1d8bbf
+  data.tar.gz: bb1f9f476851f32684cbdb718ddbe4cf00d65aa1800f94499fed654227ed399c5dfe3637f695c8e5abdc4b765beb099c8ea2fe01ba41c63c6b12ac231d4ce747

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 0.0.2
+- Add `use_inline_comments` param to `lint` method (github only)
+
+## 0.0.1
+- Initial version

data/README.md

@@ -39,6 +39,12 @@ pep8.base_dir = "src"
 pep8.lint
 ```
 
+#### Use GitHub's inline comments instead of a markdown table
+
+```rb
+pep8.lint(use_inline_comments=true)
+```
+
 #### Running using a configuration file different than the usual
 
 If you need to specify a different configuration file, use the `config_file` parameter below. Check [this link](http://flake8.pycqa.org/en/latest/user/configuration.html#configuration-locations) for more information about Configuration Locations.
@@ -79,13 +85,3 @@ pep8.count_errors(should_fail = true)
 ## License
 
 MIT
-
-## TODO
-- [x] write specs
-- [x] configure ci build
-- [x] create a changelog
-- [x] add code comments
-- [x] fill out readme.md
-- [x] open source it
-- [ ] publish gem
-- [ ] send MR to danger.systems

data/lib/pep8/gem_version.rb

@@ -1,3 +1,3 @@
 module Pep8
-  VERSION = "0.0.1".freeze
+  VERSION = "0.0.2".freeze
 end

data/lib/pep8/plugin.rb

@@ -11,7 +11,7 @@ module Danger
   #
   # @example Lint files inside a given directory
   #
-  #          pep8.base_dir "src"
+  #          pep8.base_dir = "src"
   #          pep8.lint
   #
   # @example Warns if number of issues is greater than a given threshold
@@ -54,27 +54,26 @@ module Danger
     # Lint all python files inside a given directory. Defaults to "."
     # @return [void]
     #
-    def lint
+    def lint(use_inline_comments=false)
       ensure_flake8_is_installed
 
       errors = run_flake
       return if errors.empty? || errors.count <= threshold
 
-      report = errors.inject(MARKDOWN_TEMPLATE) do |out, error_line|
-        file, line, column, reason = error_line.split(":")
-        out += "| #{short_link(file, line)} | #{line} | #{column} | #{reason.strip.gsub("'", "`")} |\n"
+      if use_inline_comments
+        comment_inline(errors)
+      else
+        print_markdown_table(errors)
       end
-
-      markdown(report)
     end
 
     # Triggers a warning/failure if total lint errors found exceedes @threshold
     # @param [Bool] should_fail
     #        A flag to indicate whether it should warn ou fail the build.
-    #        It adds an entry on the corresponding warnings/failures table. 
+    #        It adds an entry on the corresponding warnings/failures table.
     # @return [void]
     #
-    def count_errors(should_fail = false)
+    def count_errors(should_fail=false)
       ensure_flake8_is_installed
 
       total_errors = run_flake(:count => true).first.to_i
@@ -103,13 +102,29 @@ module Danger
     end
 
     def ensure_flake8_is_installed
-      system "pip install --user flake8" unless flake8_installed?
+      system "pip install --user flake8 --upgrade" unless flake8_installed?
     end
 
     def flake8_installed?
       `which flake8`.strip.empty? == false
     end
 
+    def print_markdown_table(errors=[])
+      report = errors.inject(MARKDOWN_TEMPLATE) do |out, error_line|
+        file, line, column, reason = error_line.split(":")
+        out += "| #{short_link(file, line)} | #{line} | #{column} | #{reason.strip.gsub("'", "`")} |\n"
+      end
+
+      markdown(report)
+    end
+
+    def comment_inline(errors=[])
+      errors.each do |error|
+        file, line, column, reason = error.split(":")
+        message(reason.strip.gsub("'", "`"), file: file, line: line)
+      end
+    end
+
     def short_link(file, line)
       if danger.scm_provider.to_s == "github"
         return github.html_link("#{file}#L#{line}", full_path: false)

data/spec/pep8_spec.rb

@@ -23,28 +23,40 @@ module Danger
           allow(@pep8).to receive(:`).with("which flake8").and_return("/usr/bin/flake8")
         end
 
-        it 'runs lint from current directory by default' do
-          expect(@pep8).to receive(:`).with("flake8 .").and_return("")
-          @pep8.lint
-        end
+        describe 'lint' do
+          it 'runs lint from current directory by default' do
+            expect(@pep8).to receive(:`).with("flake8 .").and_return("")
+            @pep8.lint
+          end
 
-        it 'runs lint from a custom directory' do
-          expect(@pep8).to receive(:`).with("flake8 my/custom/directory").and_return("")
+          it 'runs lint from a custom directory' do
+            expect(@pep8).to receive(:`).with("flake8 my/custom/directory").and_return("")
 
-          @pep8.base_dir = "my/custom/directory"
-          @pep8.lint
-        end
+            @pep8.base_dir = "my/custom/directory"
+            @pep8.lint
+          end
 
-        it 'handles a custom config file' do
-          expect(@pep8).to receive(:`).with("flake8 . --config my-pep8-config").and_return("")
-          @pep8.config_file = "my-pep8-config"
-          @pep8.lint
-        end
+          it 'handles a custom config file' do
+            expect(@pep8).to receive(:`).with("flake8 . --config my-pep8-config").and_return("")
+            @pep8.config_file = "my-pep8-config"
+            @pep8.lint
+          end
+
+          it 'handles a lint with no errors' do
+            allow(@pep8).to receive(:`).with("flake8 .").and_return("")
+            @pep8.lint
+            expect(@pep8.status_report[:markdowns].first).to be_nil
+          end
+
+          it 'comments inline properly' do
+            lint_report = "./tests/test_matcher.py:90:9: E128 continuation line under-indented for visual indent\n"
+            allow(@pep8).to receive(:`).with("flake8 .").and_return(lint_report)
+
+            @pep8.lint(use_inline_comments=true)
 
-        it 'handles a lint with no errors' do
-          allow(@pep8).to receive(:`).with("flake8 .").and_return("")
-          @pep8.lint
-          expect(@pep8.status_report[:markdowns].first).to be_nil
+            message = @pep8.status_report[:messages].first
+            expect(message).to eq('E128 continuation line under-indented for visual indent')
+          end
         end
 
         context 'when running on github' do
@@ -89,33 +101,34 @@ module Danger
 
             expect(@pep8.status_report[:markdowns].first).to be_nil
           end
-
         end
 
-        it 'handles errors showing only count' do
-          allow(@pep8).to receive(:`).with("flake8 . --quiet --quiet --count").and_return("10")
+        describe 'count_errors' do
+          it 'handles errors showing only count' do
+            allow(@pep8).to receive(:`).with("flake8 . --quiet --quiet --count").and_return("10")
 
-          @pep8.count_errors
+            @pep8.count_errors
 
-          warning_message = @pep8.status_report[:warnings].first
-          expect(warning_message).to include("10 PEP 8 issues found")
-        end
+            warning_message = @pep8.status_report[:warnings].first
+            expect(warning_message).to include("10 PEP 8 issues found")
+          end
 
-        it 'should not report for count_errors if total errors is bellow configured threshold' do
-          allow(@pep8).to receive(:`).with("flake8 . --quiet --quiet --count").and_return("10")
+          it 'should not report for count_errors if total errors is bellow configured threshold' do
+            allow(@pep8).to receive(:`).with("flake8 . --quiet --quiet --count").and_return("10")
 
-          @pep8.threshold = 20
-          @pep8.count_errors
+            @pep8.threshold = 20
+            @pep8.count_errors
 
-          expect(@pep8.status_report[:warnings]).to be_empty
-        end
+            expect(@pep8.status_report[:warnings]).to be_empty
+          end
 
-        it 'should not report anything if there is no error' do
-          allow(@pep8).to receive(:`).with("flake8 . --quiet --quiet --count").and_return("")
+          it 'should not report anything if there is no error' do
+            allow(@pep8).to receive(:`).with("flake8 . --quiet --quiet --count").and_return("")
 
-          @pep8.count_errors
+            @pep8.count_errors
 
-          expect(@pep8.status_report[:warnings]).to be_empty
+            expect(@pep8.status_report[:warnings]).to be_empty
+          end
         end
 
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: danger-pep8
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Gustavo Barbosa
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-12 00:00:00.000000000 Z
+date: 2016-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api