lifen-ruby-style 1.0.0 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1f86ee33406608d1b9b2cf8d14d80585a09dcb798a2528c1b06a7205d61bb47
-  data.tar.gz: 42914e1c8155e225d5fcedce3d9d14ef8d5116b51df50213cd24f899aca039c8
+  metadata.gz: 98bf06dfd5e89c45b0db61d216c7bebf02d9c0c2c3f5b0f5bf541d7f7ac04549
+  data.tar.gz: fe187d143ebf8f45d14aaa4840036f07e298e50a685779b4fa5d7cf4146d75d1
 SHA512:
-  metadata.gz: b86279d1645d36567b71689f3f5b634086975cf0be3f0f29436da8ff9171d3739df1017aa21b8f4323ff423dab23410b315cbb12f11008a081fa9e6e31d3dadc
-  data.tar.gz: 28df7786610a74fe2b4bdc7534409f857962020002c7bce2271c18dfd10bf717e25ddaf0d4f3bfcf1785d2430f36feb4cf80ed700585ce812180fc2c3943ce4e
+  metadata.gz: 0bbfa947d38b858e4b7f16f5b20d4fb3c6e09916c2541c246b43fb50b9ee0e3c12a3f5c227b86475588046a71cdacce1b9a30bc59dd03f366b5e040606863dd9
+  data.tar.gz: 194a8cd141680f1acbad8e0eb2e5f247cf17b06e65f92066232d3b5832397a0ec9625afa9692bd92a2395b0683249160c9ee7f346690c45c790f9d2bfc58b729

data/.overcommit.yml

@@ -16,8 +16,10 @@
 # Uncomment the following lines to make the configuration take effect.
 
 PreCommit:
-  Pronto:
+  RuboCop:
     enabled: true
+    command: ["bundle", "exec", "rubocop"]
+    problem_on_unmodified_line: ignore
 
   GoFmt:
     enabled: false
@@ -32,16 +34,11 @@ CommitMsg:
 
   TextWidth:
     enabled: true
-    on_warn: fail
 
   TrailingPeriod:
     enabled: true
     on_warn: fail
 #PreCommit:
-#  RuboCop:
-#    enabled: true
-#    on_warn: fail # Treat all warnings as failures
-#
 #  TrailingWhitespace:
 #    enabled: true
 #    exclude:

data/README.md

@@ -10,17 +10,14 @@
    - [Rubocop-rspec](https://github.com/rubocop-hq/rubocop-rspec) pour l'analyse des tests RSpec
    - [Rubocop-rails](https://github.com/rubocop-hq/rubocop-rails) pour les vérifications spécifiques à Rails.
 
-3. [Pronto](https://github.com/prontolabs/pronto) permet de lancer simultanément **plusieurs outils d'analyse** (e.g. Rubocop, Reek, Fasterer) **sur un sous-ensemble de lignes** (e.g. le contenu de l'index ou le diff entre 2 commits). Nous ne l'utilisons pour le moment que pour l'analyse Rubocop. [Pronto Rubocop](https://github.com/prontolabs/pronto-rubocop) est l'extension qui va permettre de lancer RuboCop via Pronto.
-
-4. [Overcommit](https://github.com/sds/overcommit) permet de gérer et paramétrer les hooks Git.
+3. [Overcommit](https://github.com/sds/overcommit) permet de gérer et paramétrer les hooks Git.
 
 ## Sommaire
 
 - [Installation](#installation)
 - [Usage](#usage)
-  - [Rubocop](#rubocop)
-  - [Pronto](#pronto)
-  - [Overcommit](#overcommit)
+  - [Rubocop](#commandes-rubocop)
+  - [Overcommit](#commandes-overcommit)
 - [Utilisation d'une version locale](#utilisation-dune-version-locale)
 - [Contributions](#contributions)
 - [TODO](#todo)
@@ -28,10 +25,6 @@
 
 ## Installation
 
-<details>
-
-<summary>Pour un nouveau projet ou un repo Lifen non configuré</summary>
-
 ### 1. Ajout de la gem au projet
 
 Ajouter dans le `Gemfile` :
@@ -58,36 +51,31 @@ inherit_gem:
     - default_rubocop.yml
 ```
 
-### 3. Config Overcommit
-
-Créer le fichier `.overcommit.yml` à partir du contenu de [ce fichier](./default_overcommit.yml).
-
-Note : Il n'est pas nécessaire d'ajouter Rubocop dans les dépendances de l'application.
+Forcer rubocop à respecter les exclusions définies dans le fichier de paramétrage :
 
-</details>
-
-<details>
-<summary>Pour un repo Lifen déjà configuré</summary>
+```bash
+$ cd my_project                          # aller à la racine du projet
+$ echo '--force-exclusion' > .rubocop
+```
 
-### 1. Installer les dépendences :
+### 3. Config Overcommit
 
 ```bash
-$ bundle install
+$ curl https://raw.githubusercontent.com/honestica/lifen-ruby-style/master/default_overcommit.yml > .overcommit_test.yml
 ```
 
-En cas de problème avec l'installation de la sous-dépendance `rugged` il faudra vous assurer que `cmake` est installé sur votre machine. Si elle n'est pas installée il faudra le faire de la façon suivante :
+### 4. Installer les dépendances
+
 ```bash
-brew install cmake
+$ bundle install
 ```
 
-### 2. Installer les hooks Git :
+### 5. Installer les hooks Git
 
 ```bash
 $ bundle exec overcommit --install
 ```
 
-</details>
-
 <details>
 <summary>Recommandations spécifiques pour VSCode</summary>
 
@@ -128,23 +116,27 @@ $ bundle exec overcommit --install
 - **FORCER RUBOCOP À RESPECTER LES EXCLUSIONS DÉFINIES DANS LE FICHIER DE PARAMÉTRAGE :**
 
   ```bash
+  $ cd my_project                          # aller à la racine du projet
   $ echo '--force-exclusion' > .rubocop
   ```
 
 - Paramétrage recommandé pour l'auto-formatting :
 
   ```json
+    "editor.formatOnPaste": true,  // global auto-format code when pasting
+    "editor.formatOnSave": true,   // global auto-format code when saving
     "[ruby]": {
-      "editor.formatOnPaste": true,       // auto-format ruby code when pasting
-      "editor.formatOnSave": true         // auto-format ruby code when saving
+      "editor.formatOnSave": false // disable auto-format on save only for ruby files
     },
   ```
 
   ou
 
   ```json
-    "editor.formatOnPaste": true,  // auto-format code when pasting
-    "editor.formatOnSave": true,   // auto-format code when saving
+    "[ruby]": {
+      "editor.formatOnPaste": true,       // auto-format ruby code when pasting
+      "editor.formatOnSave": false         // auto-format ruby code when saving
+    },
   ```
 
 ### 3. Bonus - Autres extensions utiles :
@@ -161,7 +153,9 @@ $ bundle exec overcommit --install
 <summary>Recommandations spécifiques pour Sublime Text</summary>
 
 ### Configuration de Sublime Text
+
 Il faut aller dans `Preferences > Settings` et modifier le fichier `Preferences.sublime-settings -- User` et y ajouter les paramètres suivants :
+
 ```json
 {
   ...,
@@ -179,10 +173,13 @@ Il faut aller dans `Preferences > Settings` et modifier le fichier `Preferences.
 ```
 
 ### Configuration de Rubocop
+
 #### 1. Installation du plugin
+
 Il faut installer l'extension [sublime_rubocop](https://packagecontrol.io/packages/RuboCop)
 
 Et tout devrait marcher par défaut si votre système n'utilise pas rvm ou rbenv. Le cas échéant il faut personnaliser la configuration en allant dans `Preferences > Package Settings > Rubocop > Settings - User` et mettre la configuration qui va bien dans le fichier, par exemple ceci si vous utilisez Rbenv :
+
 ```
 {
     "check_for_rvm": false,
@@ -192,7 +189,9 @@ Et tout devrait marcher par défaut si votre système n'utilise pas rvm ou rbenv
 ```
 
 #### 2. Utilisation
+
 Une fois le plugin installé vous accéderez à des commandes supplémentaires liées à Rubocop et vous pourrez par exemple :
+
 - Corriger automatiquement des fichiers
 - Activer/Désactiver l'auto-check des fichiers
 
@@ -254,11 +253,27 @@ https://github.com/dense-analysis/ale
 ### Workflow
 
 - Je code ma feature en local. Mon environnement (projet + IDE) étant configuré, je suis alerté en direct des règles de style que j'enfreins. Certaines sont mêmes corrigées automatiquement, lors de la sauvegarde du fichier.
+- Pour ignorer manuellement RuboCop sur des lignes données :
+
+  ```ruby
+  "I want to ignore the Style/StringLiterals rule on this line only" # rubocop:disable Style/StringLiterals
+
+  # rubocop:disable Style/StringLiterals
+  "I want to ignore the Style/StringLiterals rule on this line."
+  "and also on this one, because I like double quotes."
+  # rubocop:enable Style/StringLiterals
+  ```
+
 - Je commit :
-  - Un hook de pre-commit lance une analyse Pronto (= RuboCop pour le moment) sur les lignes "staged". D'autres vérifications fournies par défaut par la gem `overcommit` sont également faites. Si l'analye renvoie des erreurs, le commit est bloqué.
+  - Un hook de pre-commit lance une analyse RuboCop sur les fichiers "staged". Si l'analye renvoie des erreurs, le commit est bloqué.
   - Un hook vérifie le message de commit
   - Si je veux bypasser les hooks (déconseillé) : `OVERCOMMIT_DISABLE=1 git commit ...`
-- Je push (pas de hooks paramétrés pour l'instant)
+- Je push (pas de hooks de pre-push paramétrés pour l'instant)
+
+Attention :
+
+- si vous faites "Ctrl+C" pendant qu'un hook overcommit tourne, overcommit fait un `git stash save` et vous pouvez retrouver ce qui a disparu avec `git stast list / show / pop`
+- dans le même registre, ne faites pas de `watch .git/hooks/pre-commit`, si vous éditez vos fichiers dans une autre fenêtre, overcommit va régulièrement stasher vos modifs, et vous allez tourner en rond à éditer des fichiers qui changent sous vos pieds.
 
 ### Commandes Rubocop
 
@@ -286,33 +301,11 @@ Liste des commandes disponibles :
 $ bundle exec rubocop --help
 ```
 
-### Commandes Pronto
-
-```bash
-$ bundle exec pronto run [PATH]       # Runs Pronto on the diff between last commit and master
-```
-
-Vous pouvez ajouter les options suivantes :
-
-```bash
--c, [--commit=COMMIT]      # Runs Pronto on the diff between last commit and specified commit
--i, --index                # Analyze changes not staged for commit (does not include untracked files)
---unstaged, --no-unstaged  # Analyze only untracked files
---staged, --no-staged      # Analyze changes to be committed (git staging area)
-```
-
-Liste des commandes disponibles :
-
-```bash
-$ bundle exec pronto --help
-$ bundle exec pronto help run
-```
-
 ### Commandes Overcommit
 
 ```bash
 $ OVERCOMMIT_DISABLE=1 git [command] # Executes the git command without running the hooks
-$ bundle exec overcommit --run                   # Run pre-commit hook against all git tracked files
+$ bundle exec overcommit --run       # Run pre-commit hook against all git tracked files
 ```
 
 Liste des commandes disponibles :
@@ -352,7 +345,7 @@ Pour utiliser une version locale de la gem `lifen-ruby-style` :
 
 - Créer le fichier `.overcommit.yml` et coller le contenu du fichier `lifen-ruby-style/default_overcommit.yml`
 
-- Installer les dépendences et les hooks Git :
+- Installer les dépendances et les hooks Git :
 
   ```bash
   $ bundle install
@@ -377,14 +370,13 @@ Vous allez vouloir tester localement les modifications de règle de style que vo
 
 ## TODO
 
-[ ] Recommandations spécifiques pour Sublime Text
-[ ] Lier la configuration d'overcommit aux repos
-[ ] Ajouter un hook de pre-push ?
+[ ] Ajouter rubocop-daemon (arriver à faire une bonne intégration aux IDE)
 [ ] Ajouter le hook de pre-commit au CI
-[ ] Ajouter `pronto-faster` si pertinent
-[ ] Ajouter `pronto-reek` si pertinent
-[ ] Ajouter `pronto-slim_lint` si pertinent
-[ ] Ajouter `pronto-scss` si pertinent
+[ ] Ajouter un hook de pre-push ?
+[ ] Ajouter `fasterer` si pertinent
+[ ] Ajouter `reek` si pertinent
+[ ] Ajouter `slim_lint` si pertinent
+[ ] Ajouter `scss` si pertinent
 
 ## Archives
 

data/default_overcommit.yml

@@ -16,8 +16,10 @@
 # Uncomment the following lines to make the configuration take effect.
 
 PreCommit:
-  Pronto:
+  RuboCop:
     enabled: true
+    command: ["bundle", "exec", "rubocop"]
+    problem_on_unmodified_line: ignore
 
   GoFmt:
     enabled: false
@@ -32,16 +34,11 @@ CommitMsg:
 
   TextWidth:
     enabled: true
-    on_warn: fail
 
   TrailingPeriod:
     enabled: true
     on_warn: fail
 #PreCommit:
-#  RuboCop:
-#    enabled: true
-#    on_warn: fail # Treat all warnings as failures
-#
 #  TrailingWhitespace:
 #    enabled: true
 #    exclude:

data/default_rubocop.yml

@@ -17,6 +17,10 @@ AllCops:
     - "node_modules/**/*"
 
 # Waiting for default config
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
 Style/HashEachMethods:
   Enabled: true
 Style/HashTransformKeys:
@@ -87,12 +91,23 @@ Metrics/PerceivedComplexity:
 Naming/MemoizedInstanceVariableName:
   EnforcedStyleForLeadingUnderscores: required
 
+RSpec/DescribeClass:
+  Exclude:
+    - spec/lib/tasks/deployment/**/*
+
+Style/BlockDelimiters:
+  EnforcedStyle: braces_for_chaining
+
 Style/ClassAndModuleChildren:
   Enabled: false
 
 Style/Documentation:
   Enabled: false
 
+Style/IfUnlessModifier:
+  Enabled: true
+  AutoCorrect: false
+
 Style/NumericLiterals:
   Strict: true
 
@@ -108,6 +123,17 @@ Style/SymbolArray:
 Style/WordArray:
   EnforcedStyle: brackets
 
+Rails/DynamicFindBy:
+  Enabled: true
+  AutoCorrect: false
+
+Rails/UnknownEnv:
+  Environments:
+    - production
+    - development
+    - test
+    - staging
+
 RSpec/AnyInstance:
   Enabled: false
 
@@ -120,11 +146,14 @@ RSpec/ExampleLength:
 RSpec/HookArgument:
   EnforcedStyle: each
 
+RSpec/LetSetup:
+  Enabled: false
+
 RSpec/MultipleExpectations:
   Enabled: false
 
 RSpec/NestedGroups:
-  Max: 4
+  Max: 5
 
 RSpec/NotToNot:
   EnforcedStyle: to_not

data/lib/lifen/ruby_style/version.rb

@@ -3,7 +3,7 @@
 module Lifen
   module RubyStyle
 
-    VERSION = '1.0.0'
+    VERSION = '1.0.5'
 
   end
 end

data/lifen-ruby-style.gemspec

@@ -30,9 +30,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'overcommit'
-  spec.add_dependency 'pronto', '~> 0.1'
-  spec.add_dependency 'pronto-rubocop', '~> 0.1'
-  spec.add_dependency 'rubocop', '~> 0.8'
+  spec.add_dependency 'rubocop', '0.81'
   spec.add_dependency 'rubocop-performance', '~> 1.5'
   spec.add_dependency 'rubocop-rails', '~> 2.4'
   spec.add_dependency 'rubocop-rspec', '~> 1.38'

data/style_guide.md

@@ -619,6 +619,12 @@ before(:each) do
 end
 ```
 
+#### LetSetup
+
+```yaml
+Enabled: false //  does not check unreferenced let! calls being used for test setup
+```
+
 #### MultipleExpectations
 
 ```yaml
@@ -651,6 +657,22 @@ end
 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lifen-ruby-style
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.5
 platform: ruby
 authors:
 - Team Lifen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-04 00:00:00.000000000 Z
+date: 2020-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: overcommit
@@ -24,48 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pronto
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: pronto-rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.81'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.81'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement