rubocop_runner 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4b279ef953a3b18c17aa0119e92144523ba81467
+  data.tar.gz: 6db9d7df701314ee10cb230916fe0443823cdb6f
+SHA512:
+  metadata.gz: 186968b18e3bcf626ddc6db422de13f98cbad01d70eaa799a1e3b69888c6e6ed4a3ea8235a81a392958c76bd80c36cec7970c4a04c33b4ee70da07e046077683
+  data.tar.gz: ac2d7150badd6b2bbc2c9a80592eb4feccbb9242266d46d94564032b734b95cb891e8340ec9c0d6b6fa3b83d4c7fdcd4c5da9e2cf16c238e3d5028933bc895b7

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Style/FileName:
+  Exclude:
+    - 'lib/template/pre-commit'
+Style/Documentation:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2017 Runtastic
+
+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,72 @@
+# RubocopRunner
+
+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.
+
+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 internally since years._
+
+## Installation
+
+Add these lines to your application's Gemfile:
+
+```ruby
+group :development do
+  gem 'rubocop_runner', '~> 2.0', require: false
+end
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+To create a rubocop runner pre-commit hook once just run
+
+```sh
+ruby -rrubocop_runner -e "RubocopRunner.install"
+```
+
+To make it easy for every developer on the project you can also add the following rake task
+
+```ruby
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+  namespace :rubocop do
+    desc 'Install Rubocop as pre-commit hook'
+    task :install do
+      require 'rubocop_runner'
+      RubocopRunner.install
+    end
+  end
+rescue LoadError
+  p 'rubocop not installed'
+end
+```
+
+## ToDo
+
+- add the install rake task itself to the gem
+- add tests
+- improve gem structure
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/runtastic/rubocop_runner.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+  namespace :rubocop do
+    desc 'Install Rubocop as pre-commit hook'
+    task :install do
+      require 'rubocop_runner'
+      RubocopRunner.install
+    end
+  end
+rescue LoadError
+  p 'rubocop not installed'
+end

data/bin/console

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

data/bin/setup

@@ -0,0 +1,9 @@
+#!/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
+bundle exec rake rubocop:install

data/lib/rubocop_runner/version.rb

@@ -0,0 +1,3 @@
+module RubocopRunner
+  VERSION = '2.0.0'.freeze
+end

data/lib/rubocop_runner.rb

@@ -0,0 +1,94 @@
+require 'rubocop_runner/version'
+require 'rubocop'
+
+module RubocopRunner
+  module_function
+
+  # 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
+
+  def staged_files
+    files = `git diff --cached --name-only --diff-filter=ACM`.split
+    files.reject do |f|
+      if File.ftype(f) != 'file'
+        true
+      else
+        size = File.size(f)
+        size > 1_000_000 || (size > 20 && binary?(f))
+      end
+    end
+  end
+
+  def merge?
+    File.exist?('.git/MERGE_MSG') && File.exist?('.git/MERGE_HEAD')
+  end
+
+  def conflict_files
+    IO.read('.git/MERGE_MSG')
+      .each_line
+      .select { |e| e.start_with?("\t") }
+      .map(&:strip)
+  end
+
+  def files
+    if merge?
+      conflict_files
+    else
+      staged_files
+    end
+  end
+
+  RUBY_PATTERN = /\.(rb|gemspec)$/
+  RUBY_NAMES = %w(Guardfile Gemfile Rakefile config.ru).freeze
+
+  def ruby_file?(filename)
+    RUBY_NAMES.include?(filename) || !(filename =~ RUBY_PATTERN).nil?
+  end
+
+  def staged_ruby_files
+    @ruby_files ||= files.select do |file|
+      !File.directory?(file) && File.exist?(file) && ruby_file?(file)
+    end
+  end
+
+  DEFAULT_ARGS = %w(--auto-correct
+                    --format fuubar
+                    --force-exclusion
+                    --fail-level autocorrect).freeze
+  def run
+    return 0 if staged_ruby_files.empty?
+    ::RuboCop::CLI.new.run(DEFAULT_ARGS + staged_ruby_files)
+  end
+
+  RUBOCOP_RUNNER_HOME =
+    Pathname.new(File.join(File.dirname(__FILE__), '..')).realpath
+
+  def root
+    RUBOCOP_RUNNER_HOME
+  end
+
+  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)
+  end
+
+  def install(root = '.')
+    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)
+
+    pre_commit_template_path = RubocopRunner.root.join('lib',
+                                                       'template',
+                                                       'pre-commit')
+    FileUtils.cp(pre_commit_template_path, pre_commit_path)
+    FileUtils.chmod('+x', pre_commit_path)
+  end
+end

data/lib/template/pre-commit

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'bundler/setup'
+  require 'rubocop_runner'
+rescue LoadError
+  puts "can't find rubocop in current bundle"
+  exit 1
+end
+
+exit RubocopRunner.run

data/rubocop_runner.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubocop_runner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rubocop_runner'
+  spec.version       = RubocopRunner::VERSION
+  spec.authors       = ['Andreas Eger']
+  spec.email         = ['andreas.eger@runtastic.com']
+  spec.summary       = 'runs rubocop for all changed files'
+  spec.description   = <<-DESC
+  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.
+  DESC
+  spec.homepage      = 'https://github.com/runtastic/rubocop_runner'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  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 'rake', '~> 10.0'
+
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'pry'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: rubocop_runner
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Andreas Eger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-10 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: rubocop
+  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: 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'
+description: |2
+    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.
+email:
+- andreas.eger@runtastic.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rubocop_runner.rb
+- lib/rubocop_runner/version.rb
+- lib/template/pre-commit
+- rubocop_runner.gemspec
+homepage: https://github.com/runtastic/rubocop_runner
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: runs rubocop for all changed files
+test_files: []