retrieva-cop 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e818a721e09f9a3139b1fc097f794682a71e70e
-  data.tar.gz: 86125f726503eac7723be849012ae0ac5ff031a6
+  metadata.gz: 6cccf221159a0171982ba08358c49c55bd2ea8eb
+  data.tar.gz: 35cb868289422a9d1eefdb75523f4c073352c5dd
 SHA512:
-  metadata.gz: 0dd2acef70b76353a1563f8b4a12d6e7b5118502db45d8d56b1a50f0c2d747604e05437eb9b91a95ed317eca47784b8675fd47efaf64aca23651204028001067
-  data.tar.gz: a27c16d72e9cea119b6d9ddbefc321310e355120cf7a117a933c365d5383a5372854f9f9339233b2ab163f142c5b73b6882a9a9cd0f71731818510ed16dfdaf5
+  metadata.gz: ad45240deacf892f73379c14378344e600014732d555cf40dd4add1f1dd09d8f9876a8e5fb43ce4ff3446537375a256620c6c057696bec405c93161e978cf5bd
+  data.tar.gz: f06f4e198906909712714323a272fb09e91229861c702892c475cf5f15efb115dcbaf22a838eefdfdec1056e69c86f71cfe38e44aacb3495e85bd38c10c546c6

data/README.md

@@ -3,10 +3,6 @@
 Retrieva::Cop is a RuboCop configuration gem for Retrieva, inc.
 Highly inspiered by [onkcop](https://github.com/onk/onkcop/) and [deka_eiwakun](https://github.com/esminc/deka_eiwakun/)
 
-## Usage
-
-TODO: Write usage instructions here
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -17,6 +13,29 @@ group :development do
 end
 ```
 
+## Usage
+
+Add the following directive to your `.rubocop.yml`:
+
+```yaml
+inherit_gem:
+  retrieva-cop:
+    - "config/rubocop.yml"
+    # comment unless use rails cops
+    - "config/rails.yml"
+    # comment unless use rspec cops
+    - "config/rspec.yml"
+
+AllCops:
+  TargetRubyVersion: 2.4
+  # comment unless use rails cops
+  TargetRailsVersion: 5.1
+```
+
+```
+bundle exec rubocop <options...>
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/retrieva/retrieva-cop.

data/config/rspec.yml

@@ -1,5 +1,9 @@
 require: "rubocop-rspec"
 
+# feature spec で scenario を使っても良い
+Capybara/FeatureMethods:
+  Enabled: false
+
 # 短い subject は一行で書いて良い
 RSpec/EmptyLineAfterSubject:
   Enabled: false

data/config/rubocop.yml

@@ -6,6 +6,10 @@ AllCops:
     - "vendor/**/*" # rubocop config/default.yml
     - "db/schema.rb"
     - "node_modules/**/*"
+    - "config.ru"
+    - "config/puma.rb"
+    - "config/unicorn.rb"
+    - "Capfile"
   DisplayCopNames: true
 
 #################### Layout ################################
@@ -24,6 +28,16 @@ Layout/ExtraSpacing:
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented_relative_to_receiver
 
+# Rails の生成するファイルに存在するので除外
+Layout/SpaceInsideBrackets:
+  Exclude:
+    - "config/environments/*"
+
+# Rails の生成するファイルに存在するので除外
+Layout/SpaceInsidePercentLiteralDelimiters:
+  Exclude:
+    - "config/initializers/*"
+
 #################### Lint ##################################
 
 # Style/EmptyCaseCondition と同じく網羅の表現力が empty when を認めた方が高いし、
@@ -84,6 +98,11 @@ Metrics/MethodLength:
 Style/AsciiComments:
   Enabled: false
 
+# RSpec の生成するファイルに存在するので除外
+Style/BlockComments:
+  Exclude:
+    - "spec/spec_helper.rb"
+
 # do .. end から更にメソッドチェーンすると見づらいので
 # auto-correct せず、自分で修正する
 # spec 内は見た目が綺麗になるので許可
@@ -105,6 +124,11 @@ Style/Documentation:
 Style/DoubleNegation:
   Enabled: false
 
+# 空メソッドの場合だけ1行で書かなければいけない理由が無い
+# 「セミコロンは使わない」に寄せた方がルールがシンプル
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
 # まだ対応するには早い
 Style/FrozenStringLiteralComment:
   Enabled: false
@@ -115,10 +139,19 @@ Style/HashSyntax:
     - "**/*.rake"
     - "Rakefile"
 
+# 条件式の方を意識させたい場合には後置の if/unless を使わない方が分かりやすい
+Style/IfUnlessModifier:
+  Enabled: false
+
 # 特に model 内において、ローカル変数とメソッド呼び出しの区別をつけた方が分かりやすい場合が多い
 Style/RedundantSelf:
   Enabled: false
 
+# 以下のような rescue はそもそも raise して良いのかチェックするべきなので、AutoCorrect しない
+#   something rescue nil
+Style/RescueModifier:
+  AutoCorrect: false
+
 # Rubocop は %w[] を押すが、%w() で問題ないとする
 Style/PercentLiteralDelimiters:
   PreferredDelimiters:
@@ -137,6 +170,10 @@ Style/NumericLiterals:
 Style/NumericPredicate:
   Enabled: false
 
+# 無理して使うモンじゃない
+Style/SafeNavigation:
+  Enabled: false
+
 # spec 内は見た目が綺麗になるので許可
 Style/Semicolon:
   Exclude:
@@ -149,6 +186,10 @@ Style/StringLiterals:
   Exclude:
     - "db/migrate/*"
 
+# AutoCorrect すると .to_s するが、実際には .to_s が必要ない場合が多いので、手動で行う
+Style/UnneededInterpolation:
+  AutoCorrect: false
+
 # 条件式で arr.size > 0 が使われた時に
 #   if !arr.empty?
 #   else

data/lib/retrieva/cop/version.rb

@@ -1,5 +1,5 @@
 module Retrieva
   module Cop
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: retrieva-cop
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Kei Shiratsuchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-06 00:00:00.000000000 Z
+date: 2017-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop