lifen-ruby-style 1.0.1 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9380924908467fe4fe452a0755c80569b75475e8b166cd042a0eb593739dfa39
-  data.tar.gz: 1c76b423b5b15c06539baf770e4a291d13aba7f9d04ab82fdb97c826208aec13
+  metadata.gz: 20241f5f06c6ce3ee92e87f234e659542f0565687e1e7102a79f837226c912fc
+  data.tar.gz: 7e58e92ccb1990f69f7aa22dacf6cdba5b3e95de1768a2b7b0213be9b7df3c8d
 SHA512:
-  metadata.gz: 743a7c56568a5e721006fff6080377ecb53dfad03b91e11085122df8b1be243235350477699d43fce47e594fa4eef9b9e997386c5a5c17462a57928fa972566a
-  data.tar.gz: e4000d1f5fe3d49347c90cbede0e5b8264ea02551784abf699212018c5f969fa6195216ffa76c6b43166e3b777d9ee3d35a3c11fda9a86723b4d892b367f59dd
+  metadata.gz: 4bbb9623066e0401253254f700006ea14d257f3aa3e0e2a2be563015d3a18a837f0844abb073558e2277825ddddaa46b9582caf107e26b85776faf10ae8d7f08
+  data.tar.gz: 5987a28429905604738cd997de2cd3e505069dba0bd26744bc25b7e6314dc25b80db503a92c28e95307418e5ce5995116abc0fb98bdb706e99014aca95394cba

data/.overcommit.yml

@@ -19,6 +19,7 @@ PreCommit:
   RuboCop:
     enabled: true
     command: ["bundle", "exec", "rubocop"]
+    problem_on_unmodified_line: ignore
 
   GoFmt:
     enabled: false
@@ -33,7 +34,6 @@ CommitMsg:
 
   TextWidth:
     enabled: true
-    on_warn: fail
 
   TrailingPeriod:
     enabled: true

data/README.md

@@ -61,7 +61,7 @@ $ echo '--force-exclusion' > .rubocop
 ### 3. Config Overcommit
 
 ```bash
-$ curl https://raw.githubusercontent.com/honestica/lifen-ruby-style/master/default_overcommit.yml > .overcommit_test.yml
+$ curl https://raw.githubusercontent.com/honestica/lifen-ruby-style/master/default_overcommit.yml > .overcommit.yml
 ```
 
 ### 4. Installer les dépendances
@@ -123,17 +123,20 @@ $ bundle exec overcommit --install
 - 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 :
@@ -250,12 +253,28 @@ 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 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 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
 
 Pour de la vérification :
@@ -286,7 +305,7 @@ $ bundle exec rubocop --help
 
 ```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 :
@@ -351,6 +370,7 @@ Vous allez vouloir tester localement les modifications de règle de style que vo
 
 ## 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 ?
 [ ] Ajouter `fasterer` si pertinent

data/default_overcommit.yml

@@ -19,6 +19,7 @@ PreCommit:
   RuboCop:
     enabled: true
     command: ["bundle", "exec", "rubocop"]
+    problem_on_unmodified_line: ignore
 
   GoFmt:
     enabled: false
@@ -33,7 +34,6 @@ CommitMsg:
 
   TextWidth:
     enabled: true
-    on_warn: fail
 
   TrailingPeriod:
     enabled: true

data/default_rubocop.yml

@@ -17,12 +17,68 @@ AllCops:
     - "node_modules/**/*"
 
 # Waiting for default config
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
 Style/HashEachMethods:
   Enabled: true
 Style/HashTransformKeys:
   Enabled: true
 Style/HashTransformValues:
   Enabled: true
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/DuplicateElsifCondition:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Style/AccessorGrouping:
+  Enabled: true
+Style/ArrayCoercion:
+  Enabled: true
+Style/BisectedAttrAccessor:
+  Enabled: true
+Style/CaseLikeIf:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashAsLastArrayItem:
+  Enabled: true
+Style/HashLikeCase:
+  Enabled: true
+Style/RedundantAssignment:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true
+Performance/AncestorsInclude:
+  Enabled: true
+Performance/BigDecimalWithNumericArgument:
+  Enabled: true
+Performance/RedundantSortBlock:
+  Enabled: true
+Performance/RedundantStringChars:
+  Enabled: true
+Performance/ReverseFirst:
+  Enabled: true
+Performance/SortReverse:
+  Enabled: true
+Performance/Squeeze:
+  Enabled: true
+Performance/StringInclude:
+  Enabled: true
 
 Layout/ArgumentAlignment:
   EnforcedStyle: with_fixed_indentation
@@ -87,12 +143,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 +175,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 +198,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.1'
+    VERSION = '1.0.6'
 
   end
 end

data/lifen-ruby-style.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'overcommit'
-  spec.add_dependency 'rubocop', '~> 0.8'
+  spec.add_dependency 'rubocop', '0.88'
   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.1
+  version: 1.0.6
 platform: ruby
 authors:
 - Team Lifen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-05 00:00:00.000000000 Z
+date: 2020-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: overcommit
@@ -28,16 +28,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.88'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.88'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement