aroundhome_cops 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8b9bd51596d52489367945aaa124fd6553037b18c02532108d7257ce32cdc730
+  data.tar.gz: be240ec3e67e0f2d0b6c5df03ec67ec4fbb6430dd0a169e436bf78eab4284b54
+SHA512:
+  metadata.gz: 55bf0c984dec9a4618ca6666a3f55eb0bad1fa6e9853c65bcec2f5bf51cd99f883cf558e5f2a37dcd35c3fbdc9e19f03b39170ed63014f5219124cdbedcdae4c
+  data.tar.gz: fbe4d180f3285f76b38dd1371004d265d22c9efbd212b8073541d3efa6e128a5dfcf126687931f0fc6d55b5a5b7ccd1973cdd5f3fb367ebe677c39e2a2f0b47b

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+.DS_Store

data/.gitlab-ci.yml

@@ -0,0 +1,33 @@
+image: ruby:latest
+
+stages:
+  - test
+  - publish
+
+variables:
+  SSH_AUTH_SOCK: "/ssh-agent"
+
+before_script:
+  - mkdir -p /root/.ssh && ssh-keyscan -H codevault.io > /root/.ssh/known_hosts 2>/dev/null
+  - bundle config jobs 8
+  - bundle install --path=/tmp/bundler --quiet
+
+rubocop:
+  stage: test
+  script:
+    - bundle exec rubocop
+
+publish_gem:
+  stage: publish
+  script:
+    - mkdir ~/.gem
+    - |
+      cat << EOF > ~/.gem/credentials
+      ---
+      :rubygems_api_key: ${RUBYGEMS_API_KEY}
+      EOF
+    - chmod 0600 ~/.gem/credentials
+    - gem build aroundhome_cops.gemspec
+    - gem push $(find `pwd` -name "aroundhome_cops-*.gem")
+  only:
+    - master

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_gem:
+  aroundhome_cops:
+    - default.yml

data/CHANGELOG.md

@@ -0,0 +1,98 @@
+## Version 2.0.0
+
+* Rename to `aroundhome_cops` (our company name changed a while ago)
+    * **Breaking**: This requires you to make changes to `.rubocop.yml`
+* Remove references to internals from the repository, so that open sourcing
+  the gem is possible
+
+## Version 1.7.0
+
+* Do not count keyword arguments in `Metrics/ParameterLists`
+
+## Version 1.6.0
+
+* Rubocop 0.86
+    * Enable new cops
+
+## Version 1.5.0
+
+* Rubocop 0.82:
+    * Enable new cops
+    * Keep `Layout/LineLength` disabled for migrations
+* Use new gem source
+
+## Version 1.4.0
+
+* Rubocop 0.78 compatibility: Do not mention Rails cops anymore, since those have been removed
+
+## Version 1.3.5
+
+* **Removes**
+  * Perfomance rules. 0.68 version of rubocop dropping support for these rules. If needed by the team due to conventions, take a look into gem rubocop-perfomance.
+* **Discussion issue**
+  * https://codevault.io/aroundhome/aroundhome_cops/issues/2
+
+## Version 1.3.4
+
+* Ignore node_modules
+
+## Version 1.3.3
+
+* Ignore all public files
+
+## Version 1.3.2
+
+* Ignore uploaded files directory
+
+## Version 1.3.1
+
+* Ignore playground directory
+
+## Version 1.3.0
+
+* Ignore all migrations before 2018
+* Exempt all migrations from metric checks
+
+## Version 1.2.3
+
+* Also ignore `Metrics/BlockLength` violations for `xdescribe` and `xcontext`
+  (which are RSpec's pending equivalents of `describe` and `context`)
+
+## Version 1.2.2
+
+* `Style/FormatStringToken` temporary disabled because of a bug in Rubocop 0.52.0
+
+## Version 1.2.1
+
+* AllCops
+  * Exclude:
+    * We now Exclude all migrations being done before 2017
+## Version 1.2.0
+
+* Increase threshold for `Metrics/MethodLength`
+
+## Version 1.1.2
+
+* Metrics/BlockLength: Exclude the following file:
+  - \*.gemspec
+
+## Version 1.1.1
+
+* Rubocop of at least 0.51 version is now required
+* Removed `EnforcedStyle: never` from `Style/Encoding` since it is not supported anymore
+
+## Version 1.1.0
+
+* Metrics/BlockLength: Exclude the following methods:
+  - factory
+  - define
+  - shared_examples_for
+  - shared_examples
+
+* Metrics/BlockLength: Exclude the following file:
+  - spec_helper.rb
+
+
+## Version 1.0.0
+
+* Initial version as a gem

data/Gemfile

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

data/README.md

@@ -0,0 +1,44 @@
+# AroundhomeCops
+
+This repository hosts our configuration gem for rubocop.
+
+The configuration provided here is intended to apply to all of our projects.
+Your application might have special rules of its own, which you can freely
+override in your local configuration. But if you think a rule is of general
+relevance, that it should probably live here.
+
+## Usage
+
+Include this gem in your Gemfile:
+
+```ruby
+gem 'aroundhome_cops'
+```
+
+Let your `.rubocop.yml` inherit from this gem:
+
+```yml
+inherit_gem:
+  aroundhome_cops:
+    - default.yml
+```
+
+## Customizing rules
+
+The snippet above is everything needed to use this configuration as default.
+Starting from there it is possible to make local changes to the configuration.
+
+Take this example `.rubocop.yml`:
+
+```yml
+inherit_gem:
+  aroundhome_cops:
+    - default.yml
+
+# We still have unfixed offenses in some files
+inherit_from: .rubocop_todo.yml
+
+# This project agreed on a different line length than the rest of the company
+Metrics/LineLength:
+  Max: 120
+```

data/aroundhome_cops.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aroundhome_cops'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'aroundhome_cops'
+  spec.version       = AroundhomeCops::VERSION
+  spec.authors       = ['Jan Sandbrink']
+  spec.email         = ['jan.sandbrink@aroundhome.de']
+
+  spec.summary       = 'Dependency and configuration for rubocop.'
+  spec.homepage      = 'https://github.com/aroundhome/aroundhome_cops'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+                                        .reject { |f| f.match(%r{^spec/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rubocop', '~> 0.86'
+end

data/default.yml

@@ -0,0 +1,167 @@
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+    - 'db/schema.rb'
+    - 'doc/**/*'
+    - 'docker_app/**/*'
+    - 'Guardfile'
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+    - 'playground/**/*'
+    - 'public/**/*'
+    - 'node_modules/**/*'
+    - 'db/migrate/200*.rb'
+    - 'db/migrate/2010*.rb'
+    - 'db/migrate/2011*.rb'
+    - 'db/migrate/2012*.rb'
+    - 'db/migrate/2013*.rb'
+    - 'db/migrate/2014*.rb'
+    - 'db/migrate/2015*.rb'
+    - 'db/migrate/2016*.rb'
+    - 'db/migrate/2017*.rb'
+
+# Models can have a bunch of attributes which lead to long methods and high
+# complexity values. However, these methods are still very readable because they
+# usually have a lot of repetition.
+Metrics:
+  Exclude:
+    - 'db/migrate/*.rb'
+
+# See above (Metrics). This cop was previously called Metrics/LineLength
+# and therefore disabled as well for migrations.
+Layout/LineLength:
+  Exclude:
+    - 'db/migrate/*.rb'
+
+
+# We need to configure exemptions for blocks that we generally accept to be
+# long, since they are less comparable to methods and more comparable to
+# modules/classes.
+Metrics/BlockLength:
+  ExcludedMethods:
+    - context
+    - describe
+    - namespace
+    - factory
+    - define
+    - shared_examples_for
+    - shared_examples
+    - xcontext
+    - xdescribe
+  Exclude:
+    - 'config/environments/*.rb' # instead of excluding all :configure methods
+    - 'config/routes.rb'
+    - 'spec/spec_helper.rb' # instead of excluding all :configure methods
+    - '*.gemspec' # a gemspec could easily have more than the 25 lines limit
+
+# Increase from rubocops default limit of 10 lines.
+# The idea of increasing the default limit is to reduce the "false alarm rate"
+# of this cop on projects without a rubocop_todo.yml.
+# The intention of the cop is to fight complicated methods, but it often triggers
+# for (subjectively) easy methods, too.
+Metrics/MethodLength:
+  Max: 16
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+# Encoding comments are not neccessary in all 2.x versions of ruby, since
+# UTF-8 has become the default encoding.
+Style/Encoding:
+  Enabled: true
+  Exclude:
+    - '*.gemspec'
+
+# Ruby 2.3 introduced optional automatic freezing of string literals
+# This might become default in future versions.
+# For details on this feature see the internet, e.g. https://wyeworks.com/blog/2015/12/1/immutable-strings-in-ruby-2-dot-3
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+
+# This cop tries to make you use module_funtion instead of extend self
+# This is bad because both have their own use-case and should not be used
+# and sometimes cannot be used to do the same thing
+Style/ModuleFunction:
+  Enabled: false
+
+# While it is very often useful to separate numbers after every three digits
+# for readability, this mostly doesn't make sense if the number doesn't
+# represent an amount but rather an identifier. Thus the use of underscores
+# every three digits is recommended but not enforced.
+Style/NumericLiterals:
+  Enabled: false
+
+# Do not force the same one letter variable names for all occurences of inject
+Style/SingleLineBlockParams:
+  Enabled: false
+
+# Rubocop 0.52.0 added new 'unannotated' style, which mistakenly treat
+# date/time formatting strings as regular formatting strings
+# Disable is temporary until the fix is released.
+# To check if the bug was fixed, make sure this code is okay for Rubocop:
+# Time.strptime('2017-12-13', '%Y-%m-%d')
+Style/FormatStringToken:
+  Enabled: false
+
+# The maximum amount of positional arguments in a method really shouldn't exceed
+# the rubocop default of 5.
+# However, keyword arguments do not make a method signature as unreadable as positional
+# arguments. There are valid cases for longer argument lists (e.g. data objects or
+# DSLs with implicit default values).
+# In those cases keyword args provide a good balance between readability and the need to
+# pass more arguments into an object.
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
+# ----------------- Rubocop-forced enablements --------------
+
+# Since version 0.80 rubocop wants to cause fewer breaking changes by new cops.
+# Since then new cops have to be manually enabled/disabled for a warning to
+# disappear. Unless there is a reason to opt out of them, we will enable all of
+# them below.
+# Disabled cops will appear above with a comment explaining disablement.
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true

data/lib/aroundhome_cops.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AroundhomeCops
+  VERSION = '2.0.0'
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: aroundhome_cops
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Jan Sandbrink
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.86'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.86'
+description: 
+email:
+- jan.sandbrink@aroundhome.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- aroundhome_cops.gemspec
+- default.yml
+- lib/aroundhome_cops.rb
+homepage: https://github.com/aroundhome/aroundhome_cops
+licenses: []
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Dependency and configuration for rubocop.
+test_files: []