rubocop_lineup 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5cfa56198440d7781eaacc424900d3138531ce33
-  data.tar.gz: 167f93d1795b139ea974f6a1c8f3a6ff16721fe4
+  metadata.gz: 2a55e094b399226f398dbad21723ff58589c3988
+  data.tar.gz: 9f56dead4432a8a87c85d070093d311600500e9d
 SHA512:
-  metadata.gz: 625887be5c29eb398c84e41787a06a853fbdd96826fbac4d10eace54113eacf6071cdb8ab08bcc6859f6ab5a04b4f28da2957c422a31706d59bc96571a8f2bd0
-  data.tar.gz: e15d9f1a333954e0cbb2e701b0b4424ef5446fec35378de6e052fb3af277905e4020554810ce0936fc76a17ba9ec38ff510eeecc549d577f40a11a3ce711ba34
+  metadata.gz: e75a2f07204d1a6cfeadbcb71051c2f9ecff7194909f32dd5c01ca709e5fd0719f68ad2d0fa3f3f078e9f8b15db894e14068e51ac2c2dbca76fe2ea829745095
+  data.tar.gz: a01da1538723ff07e023a9549d38d7246a80dab6acb64c5b4a57c1ea5a3557c848a5707255c1cac3dc63c10e2805a1c972f2eb6bea6a82e34239f938361abe33

data/README.md

@@ -1,37 +1,64 @@
 # RubocopLineup
 
-TODO: Delete this and the text above, and describe your gem
+![Image of Old-Timey Police Lineup](https://upload.wikimedia.org/wikipedia/commons/0/04/Oppstilling-2.jpg)
+
+If yer trying to bring in a new sheriff to the wild, wild west of your legacy codebase,
+there's gonna be some outlaws that are just too ornery to contend with. Better to just 
+leave those scoundrels be that aren't in your crosshairs and let yer deputies focus on 
+what's at hand. 
+
+This gem presumes yer a-usin' git for yer revisionin' purposes. For now, it also figgers
+yer always branchin' from master, which, I know, I know, that ain't always how ever'body
+out here on the frontier likes to operate, but hey, we're just gettin' started here.
+
+Also, you should know goin' in that we're duck punchin' into a sweet spot of the Rubocop
+underbelly, and well, we just may get to fightin' in the future if them Rubocop folk
+get some fancy refactorin' ideas.
+
+Not to mention that some o' yer tougher deputies may get sidelined if they need more than
+a changed line to do thar job ... we'll just have to see about all that down the road.  
+
+I'm not sure how we fell into a old western theme here with a modern robot-type gem, but
+sometimes ... well, sometimes, the bear eats you.    
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this to yer Gemfile:
 
 ```ruby
 gem 'rubocop_lineup'
 ```
 
-And then execute:
+And then bundle that up:
 
     $ bundle
 
-Or install it yourself as:
+Or just put it in with all yer other gems if so inclined:
 
     $ gem install rubocop_lineup
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
+To use it regular-like, add this to the 
+[require section](https://github.com/bbatsov/rubocop/blob/master/manual/extensions.md#loading-extensions) 
+of .rubocop.yml:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```yaml 
+   require:
+   - rubocop_lineup
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+If you only need to use it ever' now-n-again, inform yer rubocop with the 
+`-r rubocop_lineup` option.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rubocop_lineup.
+We'd appreciate hearin' some of yer good ideas about our lil project here, and maybe
+even if'in you have a problemo or two with it, you might could get some help here 
+with that. Mosey over to the project at https://github.com/mysterysci/rubocop_lineup
+and have a shot or two with us.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+This gem is one o' them open source deals, and our danged lawyers told us we should 
+refer you to this here pronouncement: [MIT License](https://opensource.org/licenses/MIT).

data/bin/console

@@ -6,9 +6,5 @@ require "rubocop_lineup"
 # 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(__FILE__)
+require "pry"
+Pry.start

data/lib/rubocop_lineup/diff_liner.rb

@@ -6,11 +6,11 @@ module RubocopLineup
   # This class depends on git diffs generated the with -U0 option.
   class DiffLiner
     def self.diff_uncommitted(dir = Dir.pwd)
-      new(diff_from(dir, "HEAD"))
+      new(diff_from(dir, "HEAD"), dir)
     end
 
     def self.diff_branch(parent_branch, dir = Dir.pwd)
-      new(diff_from(dir, "#{parent_branch}..."))
+      new(diff_from(dir, "#{parent_branch}..."), dir)
     end
 
     def self.diff_from(dir, obj)
@@ -22,26 +22,27 @@ module RubocopLineup
     end
 
     # Expects a Git::Diff instance, which handles parsing diff output into files.
-    def initialize(diff)
-      @data = process(diff)
+    def initialize(diff, dir)
+      @dir = dir
+      process(diff)
     end
 
-    def files
-      @data.keys
+    def filenames
+      @data_full_paths.keys
     end
 
-    def changed_line_numbers
-      @data
+    def file_line_changes
+      @data_full_paths
     end
 
     private
 
     def process(diff)
-      Hash[diff.map { |diff_file| process_diff_file(diff_file) }]
+      @data_full_paths = Hash[diff.map { |diff_file| process_diff_file(diff_file) }]
     end
 
     def process_diff_file(diff_file)
-      [diff_file.path,
+      [File.join(@dir, diff_file.path),
        calc_line_numbers(diff_file.patch.scan(/@@(.*)@@/).flatten)]
     end
 

data/lib/rubocop_lineup/duck_punch_rubocop.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module DuckPunch
+  module CommentConfig
+    def cop_enabled_at_line?(cop, line_number)
+      source_file = processed_source.path
+      files_hash = RubocopLineup.line_em_up(Dir.pwd)
+      return false unless files_hash.key?(source_file)
+
+      offending_lines = (line_number..(last_line || line_number)).to_a
+      changed_line_numbers = files_hash[source_file]
+      (changed_line_numbers & offending_lines).empty? ? false : super
+    end
+
+    def last_line
+      # `loc_end` will be nil in cases like Parser::Source::Map::Collection
+      # https://www.rubydoc.info/github/whitequark/parser/Parser/Source/Map/Collection
+      # which point to the entire file, but presumably won't have any range
+      # cops analyzing it (e.g. Gemfile is like this).
+
+      loc_end = processed_source.ast.loc.end
+      loc_end ? loc_end.line : nil
+    end
+  end
+
+  module TargetFinder
+    def find(args)
+      # returns an array of full file paths that are the files to inspect.
+      files = super(args)
+      files_hash = RubocopLineup.line_em_up(Dir.pwd)
+      files & files_hash.keys
+    end
+  end
+end
+
+RuboCop::CommentConfig.prepend(DuckPunch::CommentConfig)
+RuboCop::TargetFinder.prepend(DuckPunch::TargetFinder)

data/lib/rubocop_lineup/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubocopLineup
-  VERSION = "0.1.1".freeze
+  VERSION = "0.2.0".freeze
 end

data/lib/rubocop_lineup.rb

@@ -3,7 +3,7 @@
 require "rubocop_lineup/version"
 require "rubocop_lineup/line_number_calculator"
 require "rubocop_lineup/diff_liner"
-require "rubocop_lineup/monkey_patch_rubocop"
+require "rubocop_lineup/duck_punch_rubocop"
 
 module RubocopLineup
   # This defaults the parent branch to 'master'. This is a reasonable
@@ -15,15 +15,15 @@ module RubocopLineup
   def self.line_em_up(directory, parent_branch = "master")
     @line_em_up ||= begin
       Dir.chdir(directory) do
-        uncommitted_changes = DiffLiner.diff_uncommitted.changed_line_numbers
-        committed_changes_on_branch = DiffLiner.diff_branch(parent_branch).changed_line_numbers
+        uncommitted = DiffLiner.diff_uncommitted.file_line_changes
+        committed_on_branch = DiffLiner.diff_branch(parent_branch).file_line_changes
 
         # When a file has committed changes AND uncommitted_changes,
         # we will only include the lines from the uncommitted changes
         # because the lines in the previous committed changes may not
         # be accurate anymore. See test suite for a sample case.
 
-        committed_changes_on_branch.merge(uncommitted_changes)
+        committed_on_branch.merge(uncommitted)
       end
     end
   end

data/rubocop_lineup.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rubocop", "~> 0.55"
 
   spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "pry"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop_lineup
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - chrismo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-11 00:00:00.000000000 Z
+date: 2018-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -100,8 +114,8 @@ files:
 - bin/setup
 - lib/rubocop_lineup.rb
 - lib/rubocop_lineup/diff_liner.rb
+- lib/rubocop_lineup/duck_punch_rubocop.rb
 - lib/rubocop_lineup/line_number_calculator.rb
-- lib/rubocop_lineup/monkey_patch_rubocop.rb
 - lib/rubocop_lineup/version.rb
 - rubocop_lineup.gemspec
 homepage: https://github.com/mysterysci/rubocop_lineup

data/lib/rubocop_lineup/monkey_patch_rubocop.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require "rubocop"
-
-module DuckPunch
-  module CommentConfig
-    def cop_enabled_at_line?(cop, line_number)
-      source_file = processed_source.path.sub("#{Dir.pwd}/", "")
-      files_hash = RubocopLineup.line_em_up(Dir.pwd)
-      return false unless files_hash.key?(source_file)
-      changed_line_numbers = files_hash[source_file]
-      changed_line_numbers.include?(line_number) ? super : false
-    end
-  end
-end
-
-RuboCop::CommentConfig.prepend(DuckPunch::CommentConfig)