lifen-ruby-style 1.1.4 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef1c5acb2037988874bbfa359309ee7a01f69c8d019721de6e10919435847183
-  data.tar.gz: d116d8b202a31cc741e90cd836db6e63e44e71456c749529e6f1503c881dc71e
+  metadata.gz: 3ba4f3fcaadd0b6ea5f61d708e5bf6f0ac0dff645c5f2b729aa422bc58d7b947
+  data.tar.gz: 1062c0a1956bfa990498899485f45039061820d9745cac2fccdc472fdd58bddf
 SHA512:
-  metadata.gz: d4fea74c0236cacdc3524b907410c0560dcd260d226c233474dd2658364efecf236d04b44d3c3ef8b7973451ed66b7a7d4f89dd61ebb2ebeae0e1ad3b63fbaff
-  data.tar.gz: 833a05da049395af63154429876af4ec214cb845010fdc6029adda20a1b5649867effaeb0db162aaa2f174182a8bddd77a9c203e72814092756c58e02ba2e3d7
+  metadata.gz: 65b5aca85d57b98f4761e8c7c766a388d2ab55a4e1ecce7b3c8e985e0e2534ad6a9836e3ad03512e177c7bdc9aa15aa9d9d40f6f5369d8f3915e23f53300318c
+  data.tar.gz: c4101f3c3f72b29b935fd6c93f75d4d96af7825dc92cb7ee9e9a83f75d04be6dec57c4bba42db592d01727b4e2921a1bd67b722b0df98aa538f6b872bf089078

data/.github/CODEOWNERS

@@ -1 +1 @@
-* @EtienneDepaulis @rouaneta
+* @EtienneDepaulis @rouaneta @r3trofitted

data/README.md

@@ -376,9 +376,9 @@ Suivre les instructions du [guide de release](RELEASING.md).
 
 ## TODO
 
-- [ ] Ajouter rubocop-daemon (arriver à faire une bonne intégration aux IDE)
-- [ ] Ajouter le hook de pre-commit au CI
-- [ ] Ajouter un hook de pre-push ?
+- [ ] Prendre ce qu'il y a de pertinent dans le style_guide pour le mettre dans le guide de contribution Rails (Notion)
+- [ ] Dans le style_guide, mettre un lien vers le guide de contribution Rails (Notion).
+- [ ] Ajouter lien vers la config rubocop-daemon pour les utilisateurs de VSCode
 - [ ] Ajouter `fasterer` si pertinent
 - [ ] Ajouter `reek` si pertinent
 - [ ] Ajouter `slim_lint` si pertinent

data/default_rubocop.yml

@@ -1617,7 +1617,7 @@ Rails/EnumUniqueness:
   Enabled: true
 
 Rails/EnvironmentComparison:
-  Enabled: true
+  Enabled: false
 
 Rails/Exit:
   Enabled: true
@@ -1782,6 +1782,7 @@ Rails/UnknownEnv:
   Enabled: true
   Environments:
     - development
+    - post-prod
     - production
     - review
     - staging
@@ -2120,7 +2121,7 @@ RSpec/VariableName:
   Enabled: true
 
 RSpec/VerifiedDoubles:
-  Enabled: true
+  Enabled: false
 
 RSpec/VoidExpect:
   Enabled: true
@@ -2131,9 +2132,6 @@ RSpec/Yield:
 RSpec/Capybara/CurrentPathExpectation:
   Enabled: true
 
-RSpec/Capybara/FeatureMethods:
-  Enabled: true
-
 RSpec/Capybara/VisibilityMatcher:
   Enabled: true
 

data/lib/lifen/ruby_style/version.rb

@@ -3,7 +3,7 @@
 module Lifen
   module RubyStyle
 
-    VERSION = '1.1.4'
+    VERSION = '1.1.5'
 
   end
 end

data/style_guide.md

@@ -18,678 +18,3 @@ In this guide, we present the Lifen guidelines, the most important rules and the
 - Prefer using [ActiveRecord Bang (!) Methods](https://riptutorial.com/ruby-on-rails/example/9285/activerecord-bang-----methods), such as `#save!`, `#update!`, `.create!`. Careful, you must not use a Bang Method and then rescue an exception. You should prevent the app to get invalid inputs beforehand.
 - Always use `destroy!` or `destroy`. Never use `delete`, unless you know exactly why. Basically `destroy` runs any callbacks on the model while `delete` doesn't. More [info](https://api.rubyonrails.org/classes/ActiveRecord/Persistence.html#method-i-delete).
 - Prefer `Time` over `DateTime` since it supports proper time zones instead of UTC offsets. [More info](https://gist.github.com/pixeltrix/e2298822dd89d854444b).
-
-## RuboCop rules
-
-**All RuboCop rules are enforced by the linter: you don't have to memorize them all. This section is for documentation purposes only.**
-
-### Custom rules
-
-All the RuboCop rules overrided by Lifen are detailed below:
-
-<details><summary>Layout</summary>
-
-#### ArgumentAlignment
-
-```ruby
-# bad
-foo :bar,
-    :baz
-
-# good
-foo :bar,
-  :baz
-```
-
-#### CaseIndentation
-
-```ruby
-# bad
-case n
-  when 0
-    x * 2
-  else
-    y / 3
-end
-
-# good
-case n
-when 0
-  x * 2
-else
-  y / 3
-end
-
-# bad
-a = case n
-    when 0
-      x * 2
-    else
-      y / 3
-end
-
-# good
-a = case n
-when 0
-  x * 2
-else
-  y / 3
-end
-```
-
-#### EmptyLinesAroundClassBody
-
-```ruby
-# bad
-class Foo
-  def bar
-    # ...
-  end
-end
-
-# good
-class Foo
-
-  def bar
-    # ...
-  end
-
-end
-```
-
-#### EmptyLinesAroundModuleBody
-
-```ruby
-# bad
-module Foo
-  def bar
-    # ...
-  end
-end
-
-# good
-module Foo
-
-  def bar
-    # ...
-  end
-
-end
-```
-
-#### EndAlignment
-
-```ruby
-# bad
-variable = if true
-    end
-
-# good
-variable = if true
-end
-
-variable =
-  if true
-  end
-```
-
-#### FirstArgumentIndentation
-
-```ruby
-# bad
-some_method(
-first_param,
-second_param)
-# good
-some_method(
-  first_param,
-  second_param
-)
-
-# bad
-foo = some_method(
-first_param,
-second_param)
-# good
-foo = some_method(
-  first_param,
-  second_param
-)
-
-# bad
-foo = some_method(nested_call(
-nested_first_param),
-second_param)
-# good
-foo = some_method(nested_call(
-  nested_first_param
-),
-  second_param)
-
-# bad
-foo = some_method(
-nested_call(
-nested_first_param),
-second_param)
-# good
-foo = some_method(
-  nested_call(
-    nested_first_param
-  ),
-  second_param
-)
-
-# bad
-some_method nested_call(
-nested_first_param),
-second_param
-# good
-some_method nested_call(
-  nested_first_param
-),
-  second_param
-```
-
-#### FirstArrayElementIndentation
-
-```ruby
-#bad
-# consistent
-array = [
-  :value
-]
-but_in_a_method_call([
-                      :its_like_this
-])
-
-#good
-array = [
-  :value
-]
-and_in_a_method_call([
-  :no_difference
-])
-```
-
-#### FirstHashElementIndentation
-
-```ruby
-# bad
-hash = {
-  key: :value
-}
-but_in_a_method_call(
-                      its_like: :this
-                    )
-
-# good
-hash = {
-  key: :value
-}
-and_in_a_method_call(
-  no: :difference
-)
-```
-
-#### IndentationConsistency
-
-```ruby
-# bad
-class A
-
-  def test
-    puts 'hello'
-    puts 'world'
-  end
-
-  private
-
-  def bar
-    puts 'world'
-  end
-
-end
-
-# good
-class A
-
-  def test
-    puts 'hello'
-    puts 'world'
-  end
-
-  private
-
-    def bar
-      puts 'hello'
-    end
-
-end
-```
-
-#### LineLength
-
-Maximum of 120 characters
-
-#### MultilineMethodCallIndentation
-
-```ruby
-# bad
-while myvariable
-.b
-  # do something
-end
-
-# good
-while myvariables
-    .b
-  # do something
-end
-
-# bad
-def my_method
-  my_variable
-  .method_1
-  .method_2
-end
-
-# good
-def my_method
-  my_variable
-    .method_1
-    .method_2
-end
-```
-
-#### ParameterAlignment
-
-```ruby
-# bad
-def foo(bar,
-        baz)
-  puts bar + baz
-end
-
-# good
-def foo(bar,
-  baz)
-  puts bar + baz
-end
-
-# bad
-def foo(
-  bar,
-    baz)
-  puts bar + baz
-end
-
-# good
-def foo(
-  bar,
-  baz
-)
-  puts bar + baz
-end
-```
-
-</details>
-
-<details><summary>Linting</summary>
-
-#### RescueException
-
-```yaml
-Enabled: false // does not check for rescue blocks targeting the Exception class.
-```
-
-```ruby
-# NOT bad
-begin
-  do_something
-rescue Exception
-  handle_exception
-end
-
-# good
-begin
-  do_something
-rescue ArgumentError
-  handle_exception
-end
-```
-
-</details>
-
-<details><summary>Metrics</summary>
-
-#### AbcSize
-
-```yaml
-Enabled: false // does not check ABC size of methods
-```
-
-#### BlockLength
-
-```yaml
-Enabled: false // does not check if the length of a block exceeds some maximum value.
-```
-
-#### ClassLength
-
-```yaml
-Max: 250 // checks if the length of a class exceeds 250
-```
-
-#### CyclomaticComplexity
-
-```yaml
-Enabled: false // does not check the cyclomatic complexity
-```
-
-#### MethodLength
-
-```yaml
-Max: 40 // checks if the length of a method exceeds 40
-```
-
-#### ModuleLength
-
-```yaml
-Max: 250 // checks if the length of a module exceeds 250
-```
-
-#### PerceivedComplexity
-
-```yaml
-Enabled: false // does not check the perceived complexity
-```
-
-</details>
-
-<details><summary>Naming</summary>
-
-#### MemoizedInstanceVariableName
-
-```ruby
-# bad
-def foo
-  @something ||= calculate_expensive_thing
-end
-
-# bad
-def foo
-  @foo ||= calculate_expensive_thing
-end
-
-# good
-def foo
-  @_foo ||= calculate_expensive_thing
-end
-```
-
-</details>
-
-<details><summary>Style</summary>
-
-#### ClassAndModuleChildren
-
-```yaml
-Enabled: false // does not check the style of children definitions at classes and modules
-```
-
-```ruby
-# good
-class Foo
-  class Bar
-  end
-end
-# good
-class Foo::Bar
-end
-```
-
-#### Documentation
-
-```yaml
-Enabled: false // does not check for missing top-level documentation of classes and modules
-```
-
-```ruby
-# good
-class Person
-  # ...
-end
-
-# good
-# Description/Explanation of Person class
-class Person
-  # ...
-end
-```
-
-#### NumericLiterals
-
-```ruby
-# bad
-1000000
-1_00_000
-1_0000
-10_000_00 # typical representation of $10,000 in cents
-
-# good
-1_000_000
-1000
-```
-
-#### RegexpLiteral
-
-```ruby
-# bad
-snake_case = %r{^[\dA-Z_]+$}
-# good
-snake_case = /^[\dA-Z_]+$/
-
-# bad
-regex = %r{
-  foo
-  (bar)
-  (baz)
-}x
-# good
-regex = /
-  foo
-  (bar)
-  (baz)
-/x
-
-#bad
-x =~ %r{home/}
-# good
-x =~ /home\//
-```
-
-#### StructInheritance
-
-```yaml
-Enabled: false // does not check for inheritance from Struct.new.
-```
-
-```ruby
-# good
-class Person < Struct.new(:first_name, :last_name)
-
-  def age
-    42
-  end
-
-end
-
-# good
-Person = Struct.new(:first_name, :last_name) do
-  def age
-    42
-  end
-end
-```
-
-#### SymbolArray
-
-```ruby
-# bad
-%i[foo bar baz]
-
-# good
-[:foo, :bar, :baz]
-```
-
-#### WordArray
-
-```ruby
-# bad
-%w[foo bar baz]
-
-# good
-['foo', 'bar', 'baz']
-```
-
-</details>
-
-<details><summary>RSpec</summary>
-
-#### AnyInstance
-
-```yaml
-Enabled: false // instances can be stubbed globally.
-```
-
-```ruby
-# NOT bad
-describe MyClass do
-  before(:each) { allow_any_instance_of(MyClass).to receive(:foo) }
-end
-
-# good
-describe MyClass do
-  let(:my_instance) { instance_double(MyClass) }
-
-  before(:each) do
-    allow(MyClass).to receive(:new).and_return(my_instance)
-    allow(my_instance).to receive(:foo)
-  end
-end
-
-```
-
-#### DescribedClass
-
-```ruby
-# bad
-describe MyClass do
-  subject { described_class.do_something }
-end
-
-# good
-describe MyClass do
-  subject { MyClass.do_something }
-end
-```
-
-#### ExampleLength
-
-```yaml
-Enabled: false // does not check for long examples.
-```
-
-#### HookArgument
-
-```ruby
-# bad
-before(:example) do
-  # ...
-end
-
-# good
-before do
-  # ...
-end
-
-# good
-before(:each) do
-  # ...
-end
-```
-
-#### LetSetup
-
-```yaml
-Enabled: false //  does not check unreferenced let! calls being used for test setup
-```
-
-#### MultipleExpectations
-
-```yaml
-Enabled: false //  does not check if examples contain too many expect calls.
-```
-
-#### NestedGroups
-
-```yaml
-Max: 4 // checks if nested groups does not exceed 4 levels
-```
-
-#### NotToNot
-
-```ruby
-# bad
-it '...' do
-  expect(false).not_to be_true
-end
-
-# good
-it '...' do
-  expect(false).to_not be_true
-end
-```
-
-#### RepeatedDescription
-
-```yaml
-Enabled: false // example groups can have the same description string.
-```
-
-#### Block Delimiters
-
-##### EnforcedStyle: braces_for_chaining
-
-```ruby
-# bad
-words.each do |word|
-  word.flip.flop
-end.join("-")
-
-# good
-words.each { |word|
-  word.flip.flop
-}.join("-")
-```
-
-</details>
-
-### Default rules
-
-All other rules have the default configuration. They are detailed in the [RuboCop official documentation](https://docs.rubocop.org/en/stable/), in the [RSpec Extension official documentation](https://docs.rubocop.org/projects/rspec/en/stable/),in the [Performance Extension official documentation](https://docs.rubocop.org/projects/performance/en/stable/), and in the [Rails Extension official documentation](https://docs.rubocop.org/projects/rails/en/stable/).
-
-Below are documented the default RuboCop rules considered as particularly important. **They are also enforced by RuboCop!**
-
-#### Style/FrozenStringLiteralComment
-
-Freezing Strings feature improves apps performance by freezing Strings. So, Matz - Ruby’s creator - decided to make all String literals frozen (immutable) by default in Ruby 3.0.
-
-In order to have a transition path to this coming big change, we add a magic comment at the beginning of each file, which freezes strings by default:
-
-```ruby
-# frozen_string_literal: true
-class YourClass
-  # ...
-end
-```

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lifen-ruby-style
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.5
 platform: ruby
 authors:
 - Team Lifen
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-10 00:00:00.000000000 Z
+date: 2021-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: overcommit
@@ -122,7 +122,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: 
+description:
 email:
 - contact@lifen.fr
 executables: []
@@ -149,7 +149,7 @@ homepage: https://github.com/honestica/lifen-ruby-style
 licenses: []
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -164,8 +164,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
-signing_key: 
+rubygems_version: 3.2.28
+signing_key:
 specification_version: 4
 summary: Lifen style guides and shared style configs.
 test_files: []