rubocop-changes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3418a7faaf54f2badc919df11d3dfd5f17e47ec13fba028601969bf656eb8914
+  data.tar.gz: 663ee14253cc36da82dfe424403f46e86c3aa982e9b63f11c6bdb540a4f0c5e8
+SHA512:
+  metadata.gz: 4085342a0463a1ed252ce253405ab8784c2cb9b4e60d1d167c5c570a16446ed911cdd50ef1d97fca0089647e061223d9a72c51d3dd2dd57c01c3f6212bc54385
+  data.tar.gz: e9789e521c3b1e55408d4bce90945fe2a3869a42b0508d251b6cabc599ac90fe14929b3b90e4fa8f1a6b971ff2c553c892c301bf68f7c34c53281ac5ea8a60f2

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.byebug_history

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+sudo: false
+rvm:
+  - 2.3.3
+  - 2.4.0
+before_install:
+  - gem update bundler
+notifications:
+  email:
+    - fcsonline@gmail.com

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at fcsonline@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rubocop-changes.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    rubocop-changes (0.1.0)
+      rubocop (~> 0.59)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    byebug (10.0.2)
+    diff-lcs (1.3)
+    git_diff_parser (3.2.0)
+    jaro_winkler (1.5.4)
+    parallel (1.19.1)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.76.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  byebug (~> 10.0)
+  git_diff_parser (~> 3.2)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.59)
+  rubocop-changes!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ferran Basora
+
+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,70 @@
+# Rubocop::Changes
+
+[![Gem Version](http://img.shields.io/gem/v/rubocop-changes.svg?style=flat)](http://badge.fury.io/rb/rubocop-changes)
+[![Build Status](http://img.shields.io/travis/fcsonline/rubocop-changes/master.svg?style=flat)](https://travis-ci.org/fcsonline/rubocop-changes)
+
+`rubocop-changes` runs rubocop and shows only the offenses you introduced since
+the fork point of your git branch. Will not complain about existing offenses in
+your main branch.
+
+This is useful for CI checks for your pull requests but it could be useful too
+for you daily work, to know new offenses created by you.
+
+Internally `rubocop-changes` runs `rubocop` and a `git diff` and does the
+intersection of line numbers to know the new offenses you are introducing to
+you master branch.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-changes'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubocop-changes
+
+## Usage
+
+    $ bundle exec rubocop-changes
+
+## Alternatives
+
+There are similar projects out there, but all of them show all Rubocop offenses for all changes files:
+
+- https://github.com/m4i/rubocop-git
+- https://github.com/packsaddle/rubocop-select
+- https://github.com/mcgain/rubocop-diff
+- https://github.com/yohira0616/diffcop
+- https://github.com/SimpleNexus/nexocop
+
+## Ideas
+
+Those are some ideas to improve `rubocop-changes`:
+
+- [ ] Let users specify which formatter to use for the output
+- [ ] Let users specify the rubocop config file
+
+## 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/fcsonline/rubocop-changes. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rubocop::Changes project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fcsonline/rubocop-changes/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rubocop/changes/checker'
+
+checker = Rubocop::Changes::Checker.new
+offenses = checker.run
+
+exit offenses.count.positive? ? 1 : 0

data/lib/rubocop/changes.rb

@@ -0,0 +1,8 @@
+require 'rubocop/changes/version'
+
+module Rubocop
+  module Changes
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/lib/rubocop/changes/check.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Rubocop
+  module Changes
+    class Check
+      def initialize(analysis, patch)
+        @analysis = analysis
+        @patch = patch
+      end
+
+      def offenses
+        analysis.offenses.select do |offense|
+          line_numbers.include?(line(offense))
+        end
+      end
+
+      def path
+        analysis.path
+      end
+
+      private
+
+      attr_reader :analysis, :patch
+
+      def line_numbers
+        lines_from_diff & lines_from_rubocop
+      end
+
+      def lines_from_diff
+        patch.changed_line_numbers
+      end
+
+      def lines_from_rubocop
+        analysis
+          .offenses
+          .map(&method(:line))
+          .uniq
+      end
+
+      def line(offense)
+        offense.location.line
+      end
+    end
+  end
+end

data/lib/rubocop/changes/checker.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require 'git_diff_parser'
+require 'byebug'
+require 'rubocop'
+require 'json'
+
+require 'rubocop/changes/check'
+require 'rubocop/changes/shell'
+
+module Rubocop
+  module Changes
+    class UnknownForkPointError < StandardError; end
+
+    class Checker
+      def run
+        raise UnknownForkPointError if fork_point.empty?
+
+        # TODO: Let users choose the formatter
+        formatter = RuboCop::Formatter::SimpleTextFormatter.new($stdout)
+
+        formatter.started('')
+
+        print_offenses(formatter)
+
+        formatter.finished(ruby_changed_files)
+
+        checks.map(&:offenses).flatten
+      end
+
+      private
+
+      def fork_point
+        @fork_point ||= Shell.run('git merge-base HEAD origin/master')
+      end
+
+      def diff
+        Shell.run("git diff #{fork_point}")
+      end
+
+      def patches
+        @patches ||= GitDiffParser.parse(diff)
+      end
+
+      def changed_files
+        patches.map(&:file)
+      end
+
+      def ruby_changed_files
+        changed_files.select { |changed_file| changed_file =~ /.rb$/ }
+      end
+
+      def rubocop
+        Shell.run("bundle exec rubocop -f j #{ruby_changed_files.join(' ')}")
+      end
+
+      def rubocop_json
+        @rubocop_json ||= JSON.parse(rubocop, object_class: OpenStruct)
+      end
+
+      def checks
+        @checks ||= ruby_changed_files.map do |file|
+          analysis = rubocop_json.files.find { |item| item.path == file }
+          patch = patches.find { |item| item.file == file }
+
+          next unless analysis
+
+          Check.new(analysis, patch)
+        end.compact
+      end
+
+      def offended_lines
+        checks.map(&:offended_lines).flatten.compact
+      end
+
+      def total_offenses
+        checks.map { |check| check.offended_lines.size }.inject(0, :+)
+      end
+
+      def print_offenses(formatter)
+        checks.each do |check|
+          print_offenses_for_check(formatter, check)
+        end
+      end
+
+      def print_offenses_for_check(formatter, check)
+        offenses = check.offenses.map do |offense|
+          RuboCop::Cop::Offense.new(
+            offense.severity,
+            offense.location,
+            offense.message,
+            offense.cop_name
+          )
+        end
+
+        formatter.file_finished(check.path, offenses)
+      end
+    end
+  end
+end

data/lib/rubocop/changes/shell.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Rubocop
+  module Changes
+    class Shell
+      def self.run(command)
+        `#{command}`.strip
+      end
+    end
+  end
+end

data/lib/rubocop/changes/version.rb

@@ -0,0 +1,5 @@
+module Rubocop
+  module Changes
+    VERSION = "0.1.0"
+  end
+end

data/rubocop-changes.gemspec

@@ -0,0 +1,41 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rubocop/changes/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubocop-changes"
+  spec.version       = Rubocop::Changes::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 2.3.0'
+  spec.authors       = ["Ferran Basora"]
+  spec.email         = ["fcsonline@gmail.com"]
+
+  spec.summary       = "Rubocop on changed lines"
+  spec.description   = "Run rubocop on changed lines from forked point"
+  spec.homepage      = 'https://rubygems.org/gems/rubocop-changes'
+  spec.license       = "MIT"
+
+  spec.metadata = {
+    'source_code_uri' => spec.homepage,
+    'bug_tracker_uri' => 'https://github.com/fcsonline/rubocop-changes/issues'
+  }
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.extra_rdoc_files = ['LICENSE.txt', 'README.md']
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'rubocop', '~> 0.59'
+
+  spec.add_development_dependency 'rubocop', '~> 0.59'
+  spec.add_development_dependency 'byebug', '~> 10.0'
+  spec.add_development_dependency 'git_diff_parser', '~> 3.2'
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-changes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ferran Basora
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.59'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.59'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.59'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.59'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: git_diff_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: Run rubocop on changed lines from forked point
+email:
+- fcsonline@gmail.com
+executables:
+- rubocop-changes
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/rubocop-changes
+- lib/rubocop/changes.rb
+- lib/rubocop/changes/check.rb
+- lib/rubocop/changes/checker.rb
+- lib/rubocop/changes/shell.rb
+- lib/rubocop/changes/version.rb
+- rubocop-changes.gemspec
+homepage: https://rubygems.org/gems/rubocop-changes
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://rubygems.org/gems/rubocop-changes
+  bug_tracker_uri: https://github.com/fcsonline/rubocop-changes/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Rubocop on changed lines
+test_files: []