rubocop_lineup 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5c3f8e0a125f78fd6cb186b10cb6c341b5e6667
+  data.tar.gz: b0a2df3b60e4393b3a07408683b7dfb37fb8d1d2
+SHA512:
+  metadata.gz: 8328d4ccc0dc825014ec067ed80d8009ac252aeb7be7954f6668b26b92962d444eacf7d41ee1915bda777498a85a8b6f6372a0dc32c2ebd3ca009f9d8727463f
+  data.tar.gz: be1e7a4b240ccecd5b25f631f7f1e6a3ae399573185a0e3e2a69ed6c5929220934240247227d9b11ae4fd50bbd34b9dcc3e8e37491d747ae9913326efcb2811b

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/bin/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,27 @@
+AllCops:
+  TargetRubyVersion: "2.1"
+  Exclude:
+  - "bin/**"
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: true
+  Max: 120
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: '()'
+    '%w': '()'
+
+Metrics/BlockLength:
+  Exclude:
+  - "spec/**"
+
+Style/Documentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.4.4

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.4
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rubocop_lineup.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Mystery Science
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# RubocopLineup
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop_lineup'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubocop_lineup
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rubocop_lineup.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:spec, "rubocop:auto_correct"]
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+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__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rubocop_lineup/diff_liner.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+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"))
+    end
+
+    def self.diff_branch(parent_branch, dir = Dir.pwd)
+      new(diff_from(dir, "#{parent_branch}..."))
+    end
+
+    def self.diff_from(dir, obj)
+      # The -U0 option is essential to how this gem works, since it eliminates
+      # any unchanged lines in the output, allowing for simple math based on
+      # the line number header in the git output.
+
+      Git.open(dir).diff(obj, "-U0")
+    end
+
+    # Expects a Git::Diff instance, which handles parsing diff output into files.
+    def initialize(diff)
+      @data = process(diff)
+    end
+
+    def files
+      @data.keys
+    end
+
+    def changed_line_numbers
+      @data
+    end
+
+    private
+
+    def process(diff)
+      Hash[diff.map { |diff_file| process_diff_file(diff_file) }]
+    end
+
+    def process_diff_file(diff_file)
+      [diff_file.path,
+       calc_line_numbers(diff_file.patch.scan(/@@(.*)@@/).flatten)]
+    end
+
+    def calc_line_numbers(diff_line_summaries)
+      diff_line_summaries.map do |line_summary|
+        LineNumberCalculator.git_line_summary_to_numbers(line_summary.strip)
+      end.flatten
+    end
+  end
+end

data/lib/rubocop_lineup/line_number_calculator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RubocopLineup
+  # This class depends on git diffs generated the with -U0 option.
+  class LineNumberCalculator
+    # presumes the text has been parsed already to just the -/+ bits
+    # e.g. "-1 +1"
+    def self.git_line_summary_to_numbers(text)
+      # TODO: Ruby Golf this - a regex with proper grouping could probably be better.
+      _changed, added = text.split(/ /).reject(&:empty?)
+      start, count = added.sub(/^-/, "").split(/,/).map(&:to_i)
+      count ||= 1
+      (start..(start + count - 1)).to_a
+    end
+  end
+end

data/lib/rubocop_lineup/monkey_patch_rubocop.rb

@@ -0,0 +1,17 @@
+# 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)

data/lib/rubocop_lineup/version.rb

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

data/lib/rubocop_lineup.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "rubocop_lineup/version"
+require "rubocop_lineup/line_number_calculator"
+require "rubocop_lineup/diff_liner"
+require "rubocop_lineup/monkey_patch_rubocop"
+
+module RubocopLineup
+  # This defaults the parent branch to 'master'. This is a reasonable
+  # default, but not always accurate. Unfortunately, due to the nature
+  # of git, there is no 100% deterministic way to know the name of the
+  # parent branch. There are ways to calculate the parent branch name
+  # that cover common cases, but that's more complicated and may be added
+  # in a future version.
+  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
+
+        # 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)
+      end
+    end
+  end
+
+  def self.reset
+    @line_em_up = nil
+  end
+end

data/rubocop_lineup.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rubocop_lineup/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubocop_lineup"
+  spec.version       = RubocopLineup::VERSION
+  spec.authors       = ["chrismo"]
+  spec.email         = ["chrismo@clabs.org"]
+
+  spec.summary       = "Rubocop plugin to restrict cops to only changed lines."
+  spec.homepage      = "https://github.com/mysterysci/rubocop_lineup"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = "~> 2.1"
+
+  spec.add_dependency "git", "~> 1.3"
+  spec.add_dependency "rubocop", "~> 0.55"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: rubocop_lineup
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- chrismo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.55'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.55'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- chrismo@clabs.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rubocop_lineup.rb
+- lib/rubocop_lineup/diff_liner.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
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.1
+signing_key: 
+specification_version: 4
+summary: Rubocop plugin to restrict cops to only changed lines.
+test_files: []