rubocop_runner 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6496eae0006789063c795fdb605512ea77a818f7
-  data.tar.gz: ad9196ee1bcb21cce83302616a0e697cacc65ca9
+SHA256:
+  metadata.gz: 4edae991bbf997137f70923de75efa9f962e3bbbef4adf23153b9665647d7ab3
+  data.tar.gz: 3177e5e82f471687ba7f5bbe1be982ff61009776b5253559e9e796e8426d2459
 SHA512:
-  metadata.gz: c1bc3c7d665d73db37cd303bca169baf5136dbf4c3d92f29a958611e775004a0669de1090ac803480c82e6a60ba27ca5b84649b0e20ea591c69b3d7f4b06f01c
-  data.tar.gz: 105b51b7973490909180f69aa17224429c30af58cc408504e1e0707e2c9696c3a54e268df985057dd1ac04fbd551ce346a9462e22a08361b5c1682bfb129363a
+  metadata.gz: c8af65c62bc28e8f76e8e182031c7db29d0106389a5a5284fb311ede92976aa687b8f9f91b03d55ad3f57956e8de41c3b27ab206c1fcc2225ed9553bf6be62f6
+  data.tar.gz: b0ecc14943daa0f43b6cc731e5600b0b2843b0ed95d26f2bcbdf39fbb94adee6be5332cf8107d9ff04cd1469db319475538de37e9058e0b11cdabd71b4bb23a6

data/CHANGELOG.md

@@ -5,6 +5,11 @@ Changelog
 master
 ---
 
+2.2.0
+---
+
+- also inspect `.rake` files
+- readme format changes
 
 2.1.0
 ---

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,69 @@
+# 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, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, 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
+
+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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/Gemfile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 gemspec

data/{LICENSE.txt → LICENSE}

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 Runtastic
+Copyright (c) 2019 runtastic GmbH
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,31 +1,32 @@
 # RubocopRunner
 
-[![Gem Version](https://badge.fury.io/rb/rubocop_runner.svg)](https://badge.fury.io/rb/rubocop_runner)
+[![Gem Version](https://badge.fury.io/rb/rubocop_runner.svg)][rubygems]
 
-This gem provides means of running rubocop including auto-correct on all files
-which are currently staged in git. This can be easily used as pre-commit hook
-with the included template.
+This gem provides you with a rake task to install rubocop as a git pre-commit hook.
+If rubocop finds any issues it will abort the commit. It will try to auto-correct
+all issues in the files that are being commited, but will abort the commit even
+if all issues can be auto-corrected so that you can verify the changes before
+actually commiting them.
 
-If rubocop can fix all detected issues itself via autocorrect it will will do
-so. The commit will abort in this situation.
-In case rubocop accepts all code changes the commit continues.
-
-_Although this gem has no tests it's pretty battle tested and is in use at runtastic since years._
+_Although this gem has no tests it's battle tested and is in use at runtastic
+since years._
 
 ## Installation
 
 Add these lines to your application's Gemfile:
 
 ```ruby
-group :development do
-  gem 'rubocop_runner', '~> 2.0', require: false
-end
+gem 'rubocop_runner', '~> 2.1', require: false
 ```
 
 And then execute:
 
     $ bundle
 
+Or install it yourself as:
+
+    $ gem install rubocop_runner
+
 ## Usage
 
 To create a rubocop runner pre-commit hook once just run
@@ -45,22 +46,24 @@ RubocopRunner::RakeTask.new
 Afterwards, just run the `rake rubocop:install` task to install the pre-commit
 hook.
 
-## ToDo
-
-- add tests
-- improve gem structure
-
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. 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).
+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/runtastic/rubocop_runner.
+This project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the [code of conduct][cc].
 
 ## License
+The gem is available as open source under [the terms of the MIT License][mit].
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
+[rubygems]: https://rubygems.org/gems/rubocop_runner
+[mit]: https://choosealicense.com/licenses/mit/
+[cc]: ../CODE_OF_CONDUCT.md

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 
 begin

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'rubocop_runner'

data/lib/rubocop_runner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubocop_runner/version'
 require 'rubocop'
 
@@ -7,6 +9,7 @@ module RubocopRunner
   # from https://github.com/djberg96/ptools/blob/master/lib/ptools.rb#L90
   def binary?(file)
     return true if File.ftype(file) != 'file'
+
     s = (File.read(file, File.stat(file).blksize) || '').split(//)
     ((s.size - s.grep(' '..'~').size) / s.size.to_f) > 0.30
   end
@@ -42,8 +45,8 @@ module RubocopRunner
     end
   end
 
-  RUBY_PATTERN = /\.(rb|gemspec)$/
-  RUBY_NAMES = %w(Guardfile Gemfile Rakefile config.ru).freeze
+  RUBY_PATTERN = /\.(rb|gemspec|rake)$/.freeze
+  RUBY_NAMES = %w[Guardfile Gemfile Rakefile config.ru].freeze
 
   def ruby_file?(filename)
     RUBY_NAMES.include?(filename) || !(filename =~ RUBY_PATTERN).nil?
@@ -55,12 +58,13 @@ module RubocopRunner
     end
   end
 
-  DEFAULT_ARGS = %w(--auto-correct
+  DEFAULT_ARGS = %w[--auto-correct
                     --format fuubar
                     --force-exclusion
-                    --fail-level autocorrect).freeze
+                    --fail-level autocorrect].freeze
   def run
     return 0 if staged_ruby_files.empty?
+
     ::RuboCop::CLI.new.run(DEFAULT_ARGS + staged_ruby_files)
   end
 
@@ -73,6 +77,7 @@ module RubocopRunner
 
   def create_backup(pre_commit_path)
     return unless File.exist?(pre_commit_path)
+
     FileUtils.mv(pre_commit_path,
                  pre_commit_path.join('.bkp'),
                  force: true)
@@ -82,6 +87,7 @@ module RubocopRunner
     require 'fileutils'
     git_root = Pathname.new "#{root}/.git"
     return false unless File.exist?(git_root)
+
     pre_commit_path = git_root.join('hooks', 'pre-commit')
     create_backup(pre_commit_path)
 

data/lib/rubocop_runner/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RubocopRunner
-  VERSION = '2.1.0'.freeze
+  VERSION = '2.2.0'
 end

data/lib/template/pre-commit

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 begin
   require 'bundler/setup'

data/rubocop_runner.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'rubocop_runner/version'
 
@@ -22,9 +23,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'bundler', '> 1.10', '<3'
   spec.add_development_dependency 'rake', '~> 10.0'
 
-  spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rubocop'
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: rubocop_runner
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Andreas Eger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-02 00:00:00.000000000 Z
+date: 2019-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '1.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '1.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +45,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +59,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,8 +87,9 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
@@ -111,8 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: runs rubocop for all changed files