quipper-rubocop-config 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 39849ee3faaf88c0150a90c7205f44c5c2d711f0
+  data.tar.gz: 8f4662baa1e1233a65a8b96e81f1229b2fef081d
+SHA512:
+  metadata.gz: 2eb33470f7f7e94e1877ee1a9b8351ff0aa5f3cfb126d980a7d35a87df02a455be9aa2c75cec09e0f3aa8ae1f344bc861fbfe210cb40fc983a40fa4f66ca57a2
+  data.tar.gz: 8731b6aadd1682ee0f8d3116d7fc855957c624682bb3c6cb30d65c79bfc210a6814f9987f520dadd35d9de72e9373a975f6878c8c0f00f500aad509cf277e5ac

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,13 @@
+inherit_from: .rubocop_todo.yml
+
+# This file is autogenerated by quipper-rubocop-config gem.
+#
+# If you would like to change a rubocop rule please do so here:
+# https://github.com/quipper/quipper-rubocop-config/blob/master/config/rubocop.yml
+# This ensures the rubocop config will be applied across all repos using the gem.
+inherit_gem:
+  quipper-rubocop-config:
+    - "config/rubocop.yml"
+
+AllCops:
+  TargetRubyVersion: 2.5

data/.rubocop_todo.yml

@@ -0,0 +1,59 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-07-11 18:46:26 +0900 using RuboCop version 0.58.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowBorderComment, AllowMarginComment.
+Layout/EmptyComment:
+  Exclude:
+    - 'exe/quipper-rubocop-config'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/LeadingBlankLines:
+  Exclude:
+    - 'quipper-rubocop-config.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/LeadingCommentSpace:
+  Exclude:
+    - 'lib/quipper/rubocop/config.rb'
+
+# Offense count: 1
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/quipper/rubocop/config.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/ExpandPathArguments:
+  Exclude:
+    - 'quipper-rubocop-config.gemspec'
+
+# Offense count: 1
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/quipper/rubocop/config.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedOctalStyle.
+# SupportedOctalStyles: zero_with_o, zero_only
+Style/NumericLiteralPrefix:
+  Exclude:
+    - 'lib/quipper/rubocop/config.rb'
+
+# Offense count: 6
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 120

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 quipper-rubocop-config.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Drew Terry
+
+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,53 @@
+# Quipper Rubocop Configs
+
+Adds Rubocop and holds the default rubocop config for Quipper that can be shared in any ruby repo.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+quipper_gem 'quipper-rubocop-config'
+```
+
+And then execute:
+
+  `$ bundle install`
+
+$$ Usage
+
+Then using the command line client you can use:
+
+  `$ bundle exec quipper-rubocop-config install`
+
+Which will automatically install the `.rubocop.yml` which holds the configs.
+
+
+### Adding it into a legacy application
+
+Additionally if this is being installed into a legacy repo or one that already has a lot of files (and thus rubocop errors) you can run:
+
+`$ bundle exec quipper-rubocop-config --with_todo`
+
+ This installs the `.rubocop_todo.yml` file which lists the rules that are currently broken but which you might want to fix later and tells rubocop to ignore them for now.
+
+## Prepush hook
+
+If you want to run rubocop before pushing there is a prepush hook which you can install.
+
+  `$ bundle exec quipper-rubocop-config install_prepush`
+
+This installs a prepush in `.git/hooks` folder so if you already have a `pre-push` file you won't be able to use it.
+If you want the fancy ability to autocorrect and commit your changes as well you can set `export RUBO_AUTOCORRECT=true` as an environment variable.
+
+## Changing or adding a rule
+Please edit this file:
+
+https://github.com/quipper/quipper-rubocop-config/blob/master/config/rubocop.yml
+
+## Uninstall 
+
+To remove this gem and all created files simply run:
+  `$ bundle exec quipper-rubocop-config uninstall`
+
+and then remove the Gem from your Gemfile.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "quipper/rubocop/config"
+
+# 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/config/rubocop.yml

@@ -0,0 +1,24 @@
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  Enabled: true
+
+Layout/DotPosition:
+  EnforcedStyle: leading
+  Enabled: true
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: space
+  Enabled: true
+
+Style/AsciiComments:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*.rb"
+
+Style/NumericPredicate:
+  Enabled: false
+
+Naming/PredicateName:
+  Enabled: false

data/exe/quipper-rubocop-config

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+$LOAD_PATH.unshift File.dirname(__FILE__) + "/../lib"
+
+# Exit cleanly from an early interrupt
+Signal.trap("INT") { exit 1 }
+
+require "quipper/rubocop/config"
+
+Quipper::Rubocop::Config::CLI.start(ARGV)

data/lib/quipper/rubocop/config.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "thor"
+require "erb"
+
+module Quipper
+  module Rubocop
+    module Config
+      class CLI < Thor
+        RUBOCOP_CONFIG_FILE_NAME = ".rubocop.yml"
+        RUBOCOP_TODO_FILE_NAME = ".rubocop_todo.yml"
+        GITHOOK_FILE_PATH = ".git/hooks/pre-push"
+
+        desc "install", "Install rubocop config"
+        option :with_todo
+        def install
+          create_rubocop_config!(RUBOCOP_CONFIG_FILE_NAME)
+          create_rubocop_todo_file! if options[:with_todo]
+        end
+
+        desc "install_prepush", "Install prepush hook"
+        def install_prepush
+          create_prepush_hook!(GITHOOK_FILE_PATH)
+        end
+
+        desc "uninstall", "uninstall rubocop config"
+        option :hook
+        def uninstall
+          remove_file(RUBOCOP_CONFIG_FILE_NAME) unless options[:hook]
+          remove_file(RUBOCOP_TODO_FILE_NAME) unless options[:hook]
+          remove_file(GITHOOK_FILE_PATH)
+
+          puts "Uninstallation complete"
+        end
+
+        private
+
+        def create_rubocop_config!(config_file_name)
+          puts "#{File.exist?(config_file_name) ? 'overwrite' : 'create'} #{config_file_name}"
+          FileUtils.copy_file(File.join(template_path, config_file_name), config_file_name)
+        end
+
+        def create_rubocop_todo_file!
+          puts "creating rubocop todo file"
+          system "rubocop --auto-gen-config"
+        end
+
+        def create_prepush_hook!(file_path)
+          puts "adding git prepush hook at #{file_path}"
+
+          raise "File already exists at #{file_path}" if File.exist?(file_path)
+
+          hook_template = File.join(template_path, ".githooks/pre-push.erb")
+          @branch_name = ask("What is the name of the branch you would like to compare to? (usually master or develop)")
+          hook_template = ERB.new(File.read(hook_template)).result(binding)
+          File.open(file_path, "w+") do |f|
+            f.write(hook_template)
+          end
+          FileUtils.chmod(0755, file_path)
+          puts "hook created!"
+        end
+
+        def remove_file(file_path)
+          if File.exist?(file_path) && added_by_this_gem?(file_path)
+            File.delete(file_path)
+            puts "Removing #{file_path}"
+          end
+        end
+
+        def template_path
+          File.expand_path("../../../templates", __dir__)
+        end
+
+        def added_by_this_gem?(file_name)
+          File.read(file_name).include?("quipper-rubocop-config")
+        end
+      end
+    end
+  end
+end

data/lib/quipper/rubocop/config/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Quipper
+  module Rubocop
+    module Config
+      VERSION = "0.1.0"
+    end
+  end
+end

data/quipper-rubocop-config.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "quipper/rubocop/config/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "quipper-rubocop-config"
+  spec.version       = Quipper::Rubocop::Config::VERSION
+  spec.authors       = ["Drew Terry"]
+  spec.email         = ["drewpterry@yahoo.com"]
+
+  spec.summary       = "Quipper's rubocop config"
+  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.add_dependency "rubocop", "0.58.1" # Rubocop doesn't follow semantic versioning and is relatively unstable
+  spec.add_dependency "thor", "~> 0.19"
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/templates/.githooks/pre-push.erb

@@ -0,0 +1,39 @@
+#!/usr/bin/env bash
+
+# Automatically generated by quipper-rubocop-config
+
+all_changed_files="git diff --name-only <%= @branch_name %>... | grep '\.rb$'"
+autocorrect_command="$all_changed_files | xargs bundle exec rubocop -a"
+normal_rubocop_command="$all_changed_files | xargs bundle exec rubocop"
+
+printf "\nFiles to be checked...\n\n"
+
+eval $all_changed_files
+
+if [ "$RUBO_AUTOCORRECT" = true ]; then
+    if [ -z "$(git status --untracked-files=no --porcelain)" ]; then
+
+        printf "\nFixing style mistakes in changed files...\n\n"
+
+        eval $autocorrect_command
+
+        printf "\n"
+
+        git add -u
+        git commit -m "automated rubocop changes"
+
+      else
+        printf "Your working directory isn't clean, please commit or stash the files in your working directory"
+        printf "\n\n"
+        exit 1
+    fi
+
+  else
+    printf "\nRunning without autocorrect"
+    printf "\nIf you want to run autocorrect you can use the following command (it's long!) and commit the changes yourself:\n\n"
+    printf "$autocorrect_command"
+fi
+
+printf "\n\nChecking modified lines for mistakes...\n\n"
+
+eval $normal_rubocop_command

data/templates/.rubocop.yml

@@ -0,0 +1,11 @@
+# This file is autogenerated by quipper-rubocop-config gem.
+#
+# If you would like to change a rubocop rule please do so here:
+# https://github.com/quipper/quipper-rubocop-config/blob/master/config/rubocop.yml
+# This ensures the rubocop config will be applied across all repos using the gem.
+inherit_gem:
+  quipper-rubocop-config:
+    - "config/rubocop.yml"
+
+AllCops:
+  TargetRubyVersion: 2.5

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: quipper-rubocop-config
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Drew Terry
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.58.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.58.1
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+description: 
+email:
+- drewpterry@yahoo.com
+executables:
+- quipper-rubocop-config
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/rubocop.yml
+- exe/quipper-rubocop-config
+- lib/quipper/rubocop/config.rb
+- lib/quipper/rubocop/config/version.rb
+- quipper-rubocop-config.gemspec
+- templates/.githooks/pre-push.erb
+- templates/.rubocop.yml
+homepage: 
+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: Quipper's rubocop config
+test_files: []