Merge pull request #1 from codeur/first-version

v0.1.0

Author: pierre golfier

.gitignore

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

.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: default.yml

Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in attacked.gemspec.
+gemspec

README.md

@@ -1,3 +1,47 @@
-# Codeur Rubostyle
+# Rubocop Codeur
 Shared rubocop config gem for every Ruby projects at Codeur SARL
 
+## Installation
+Add this lines to your application's Gemfile:
+```ruby
+group :development do
+  gem 'rubocop-codeur'
+end
+```
+
+Or, for a Ruby library, add this to your gemspec:
+```ruby
+spec.add_development_dependency 'rubocop-codeur'
+```
+
+## Usage
+Create a `.rubocop.yml` with the following directives:
+```yml
+inherit_gem:
+  rubocop-codeur:
+    - default.yml
+```
+
+Then run:
+`bundle exec rubocop`
+
+You do not need to include rubocop directly in your application's dependencies. rubocop-codeur will include `rubocop`, `rubocop-minitest`, `rubocop-performance` and `rubocop-rails` dependencies.
+
+## FYI
+It might be necessary to override style rules set in this gem for some projects or to add specific ones. Rule inheritance provided by Rubocop works like the following:
+`inherit_gem → inherit_from → local rules`
+
+For example:
+```yml
+inherit_gem:
+  rubocop-codeur:
+    - default.yml
+
+inherit_from: .some_rubocop_config_file.yml
+
+AllCops:
+  Exclude:
+    - path/to/exluded/file.rb
+```
+
+Note that this should be limited to very project-specify needs in order to keep consistency across repos. Feel free to clone, checkout, update `default.yml` and submit a pull request if you want to suggest style rules changes.

Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

default.yml

@@ -0,0 +1,162 @@
+require:
+  - rubocop-minitest
+  - rubocop-performance
+  - rubocop-rails
+
+AllCops:
+  Exclude:
+    - 'db/schema.rb'
+    - 'node_modules/**/*'
+    - 'public/**/*'
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+    - 'bin/*'
+  TargetRubyVersion: 2.6
+  TargetRailsVersion: 6.0
+  NewCops: enable
+
+Rails:
+  Enabled: true
+
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent
+  IndentationWidth: 2
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_first_argument
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Layout/LineLength:
+  Max: 200
+  Exclude:
+    - 'db/migrate/*'
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+  IndentationWidth: 2
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Metrics/AbcSize:
+  Max: 65
+  Exclude:
+    - 'db/migrate/*'
+
+Metrics/BlockLength:
+  Max: 60
+  Exclude:
+    - 'config/routes.rb'
+    - 'lib/tasks/**/*'
+
+Metrics/ClassLength:
+  Max: 300
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/MethodLength:
+  Max: 60
+  Exclude:
+    - 'db/migrate/*'
+
+Metrics/ModuleLength:
+  Max: 300
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Minitest/TestMethodName:
+  Enabled: false
+
+Rails/BulkChangeTable:
+  Enabled: false
+
+Rails/CreateTableWithTimestamps:
+  Exclude:
+    - 'db/migrate/{2012,2013,2014,2015,2016,2017,2018}*.rb'
+
+Rails/FilePath:
+  EnforcedStyle: arguments
+
+Rails/ReversibleMigration:
+  Exclude:
+    - 'db/migrate/{2012,2013,2014,2015,2016,2017,2018}*.rb'
+
+Rails/SaveBang:
+  Enabled: false
+  # AllowedReceivers:
+  #   - 'mailchimp_list.members'
+
+Rails/SkipsModelValidations:
+  Enabled: false
+  Exclude:
+    - 'lib/tasks/**/*'
+    - 'db/migrate/*.rb'
+
+Rails/UnknownEnv:
+  Environments:
+    - development
+    - test
+    - staging
+    - production
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  AutoCorrect: true
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/GuardClause:
+  MinBodyLength: 3
+
+Style/HashEachMethods:
+  Enabled: true
+  AutoCorrect: true
+
+Style/HashTransformKeys:
+  Enabled: true
+  AutoCorrect: true
+
+Style/HashTransformValues:
+  Enabled: true
+  AutoCorrect: true
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/MultipleComparison:
+  Enabled: false
+
+Style/NestedTernaryOperator:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/SymbolArray:
+  MinSize: 7

lib/rubocop_codeur.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'rubocop_codeur/version'
+
+module RubocopCodeur
+end

lib/rubocop_codeur/version.rb

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

rubocop-codeur.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative 'lib/rubocop_codeur/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'rubocop-codeur'
+  spec.version     = RubocopCodeur::VERSION
+  spec.authors     = ['Dev-team Codeur']
+  spec.email       = ['[email protected]']
+  spec.homepage    = 'https://github.com/codeur/rubocop-codeur'
+  spec.summary     = 'Codeur rubocop config gem'
+  spec.description = 'Shared rubocop config gem for every Ruby projects at Codeur SARL'
+  spec.license     = 'MIT'
+
+  spec.metadata['allowed_push_host'] = 'https://gems.codeur.com'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+
+  spec.files = Dir['lib/**/*', 'MIT-LICENSE', 'README.md']
+
+  spec.required_ruby_version = '~> 2.6'
+  spec.add_dependency 'rubocop'
+  spec.add_dependency 'rubocop-minitest'
+  spec.add_dependency 'rubocop-performance'
+  spec.add_dependency 'rubocop-rails'
+end