fablicop 1.0.9 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e221bafa27300d5b7a6f2ac50fde2801067fe05a2d383d00ce4a92e85d42c436
-  data.tar.gz: ee8f711d1ac0d19543d615a395366d1ecae88a90bbb1b6b8612a500a8ee0795b
+  metadata.gz: fe2a343729be8bc5a9ff715f293c3f3916def3b911a1302bccd7adb2a68ca2e3
+  data.tar.gz: 5588496cc37ec53e17a98a97ccff2304c51b82851aae17b1327bf3e526b7c824
 SHA512:
-  metadata.gz: bc59b1d764b4d4aad55663c114babfb5a3a997025c4ce0b14e00da46bc95e8a0be33c65041c8696a528406c7bb1af72060182e702e821bbde7420815e31c7ad5
-  data.tar.gz: 8b7d45aad11ae241ff61b99bfd94d52441a66b80a21da26d8c1561451c5130c7b72a879e5ad12fc94bacd1d66ccc9d614a53cd29146ca1358c0cd2308005df50
+  metadata.gz: '08abd81328aba9fd74384bece20fdc80c8ed0cf9b10cb18a8712123e8c33a15d54999a706f154c20d937ab97712a5bae539fc298d7423b439a972539f1f830b7'
+  data.tar.gz: b3e31118f19b5c779afd35b258c77e91e65a8996cb2838ecf5c1a983ae43e40d9cab3617165708126e0b050635137dde123d7cabff8c244bebdf6a75d6669170

data/.github/dependabot.yml

@@ -0,0 +1,17 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "09:00"
+      timezone: Asia/Tokyo
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: weekly
+      time: "09:00"
+      timezone: Asia/Tokyo
+    ignore:
+      - dependency-name: "*"
+        update-types: ["version-update:semver-minor", "version-update:semver-patch"]

data/.github/workflows/run-ci.yml

@@ -0,0 +1,36 @@
+name: Run CI
+
+on:
+  push:
+    branches: ["master"]
+    tags: ["**"]
+  pull_request:
+
+jobs:
+  'run-ci':
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.5", "2.6", "2.7", "3.0"]
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle exec rspec
+
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.5", "2.6", "2.7", "3.0"]
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle exec rubocop

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -1,2 +1,4 @@
-inherit_gem:
-  fablicop: "config/base_rubocop.yml"
+inherit_from: config/.base_rubocop.yml
+
+Rails:
+  Enabled: false

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in fablicop.gemspec

data/README.md

@@ -1,39 +1,51 @@
 # fablicop
 
 fablicop is a RuboCop configration gem.
+It assumes your project is using Ruby on Rails and RSpec, so some Cops prefixed with `Rails` and `RSpec` are enabled out of the box.
+In other words, it's not appropriate to use it with non-Rails projects.
 
-## Usage
+## Installation
+
+You can install fablicop with this command:
+
+```console
+gem install fablicop
+```
+
+Or, run `bundle install` after adding this line to your application's Gemfile:
+
+```ruby
+gem 'fablicop', require: false
+```
+
+## Getting started
 
-Setup .rubocop.yml
+Set up `.rubocop.yml` with the command below.
 
-```sh
-bundle exec fablicop init
+```console
+fablicop init
 ```
 
-`init` generate the following directive to your `.rubocop.yml`:
+`init` generates the following directive to your `.rubocop.yml`:
 
 ```yaml
 inherit_gem:
   fablicop:
     - "config/.base_rubocop.yml"
-    # uncomment if use rails cops
-    # - "config/rails.yml"
-    # uncomment if use rspec cops
-    # - "config/rspec.yml"
 ```
 
-```sh
-bundle exec rubocop <options...>
-```
+## Usage
 
-## Installation
+After configuration, your RuboCop now sees fablicop's configuration. Just run `rubocop` as usual.
+
+```console
+rubocop
+```
 
-Add this line to your application's Gemfile:
+Or, prefix `bundle exec`.
 
-```ruby
-group :development do
-  gem "fablicop", require: false
-end
+```console
+bundle exec rubocop
 ```
 
 ## Contributing

data/Rakefile

@@ -1,2 +1,4 @@
-require "bundler/gem_tasks"
-task :default => :spec
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "fablicop"
+require 'bundler/setup'
+require 'fablicop'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "fablicop"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/config/.base_rubocop.yml

@@ -1,10 +1,11 @@
 require:
   - rubocop-rails
+  - rubocop-rspec
 
-# 自動生成されるものやテストデータはチェック対象から除外する
+# We exclude files that are generated automatically or test data.
 AllCops:
   Exclude:
-    - "vendor/**/*" # rubocop config/default.yml
+    - "vendor/**/*"
     - "db/schema.rb"
     - "db/migrate/*"
     - "db/fixtures/**/*"
@@ -13,12 +14,12 @@ AllCops:
     - "spec/test_app/db/*"
 
   DisplayCopNames: true
-  NewCops: enable # 新しい規約も随時取り入れる
+  NewCops: enable
 
 Rails:
   Enabled: true
 
-# rails >= 5 の設定のため
+# For rails >= 5. TODO: This should be enabled in my opinion.
 Rails/HttpPositionalArguments:
   Enabled: false
 
@@ -38,11 +39,11 @@ Gemspec/OrderedDependencies:
 
 ##################### Style ##################################
 
-# 日本語のコメントを許可する
+# We sometimes use non-ascii comments.
 Style/AsciiComments:
   Enabled: false
 
-# 複数行の場合は末尾にカンマを入れる
+# We prefer trailing comma all the time.
 Style/TrailingCommaInArrayLiteral:
   EnforcedStyleForMultiline: comma
 Style/TrailingCommaInHashLiteral:
@@ -50,32 +51,22 @@ Style/TrailingCommaInHashLiteral:
 Style/TrailingCommaInArguments:
   EnforcedStyleForMultiline: comma
 
-# class先頭のコメントを省略する
+# We sometimes omit the top-level documentation for classes/modules.
 Style/Documentation:
     Enabled: false
 
-# selfは省略しない
+# We sometimes want to use `self` anyway.
 Style/RedundantSelf:
     Enabled: false
 
-# 以下の2つのあわせ技で、こういうのを許可
+# We want to allow the code like this:
+#
 #   xs.select {
 #     f x
 #   }.map { |x|
 #     f x
 #     f x
 #   }.compact
-# Rubocopの意図としては、おそらく
-# * ブロックのあとにメソッドをチェインされると読みにくい(主観)
-# * ブロックの終わりを`}`ではなく`end`にすることで、defとかifとかと終了を揃える
-# だと思うけど、むしろ一旦変数に入れて改めてメソッド適用する方がかえって読みにくいと思うし(主観)、
-# 返り値を使う場合はブロックの終わりをendにせず}にしないとメソッド結合順序の関係などでやばいので
-# Style/BlockDelimitersとStyle/MultilineBlockChainはよくないと判断。
-#
-# 「返り値を目的とするブロック引数」には{}を、「副作用を目的とするブロック引数」にはdo/endを
-# 使うようにすると、可読性的にもメソッドの結合順序的にも実用上便利。
-# これが正しく運用されてるかどうかはgrammerではなくsemanticの話なので、レビュワーの人間が
-# 見ることになり、それは直感的な気がする (再び主観)
 Style/BlockDelimiters:
   Enabled: false
 Style/MultilineBlockChain:
@@ -83,7 +74,7 @@ Style/MultilineBlockChain:
 Style/EmptyMethod:
   Enabled: false
 
-# 候補が多いときはcondみたいに使いたい
+# We sometimes want to use empty case when there are many conditions.
 Style/EmptyCaseCondition:
   Enabled: false
 
@@ -99,19 +90,19 @@ Style/MethodCallWithoutArgsParentheses:
 Style/DefWithParentheses:
   Enabled: false
 
-# classが入れ子になった場合、テストの順番によってはエラーになりうる
+# This might not be a style cop because errors happen due to the order of tests with nested classes/modules.
 Style/ClassAndModuleChildren:
   Exclude:
     - "test/**/*.rb"
     - "spec/**/*.rb"
 
-# 3桁ごとに_を入れるとSQLの表示方法と乖離するためfixtureは対象外
+# This style differs from the expression of SQL.
 Style/NumericLiterals:
   Exclude:
     - "db/fixtures/*.rb"
 
 ##################### Layout ##################################
-# 引数前のスペースは複数許可
+# We sometimes want to put multiple spaces before arguments.
 Layout/SpaceBeforeFirstArg:
   Enabled: false
 Layout/SpaceInLambdaLiteral:
@@ -119,7 +110,8 @@ Layout/SpaceInLambdaLiteral:
 Layout/HeredocIndentation:
   Enabled: false
 
-# 引数の書き方の多様性を許可
+# We want to allow various expression for arguments.
+#
 # foo(a,
 #  b
 # )
@@ -134,7 +126,9 @@ Layout/HeredocIndentation:
 #  b)
 Layout/MultilineMethodCallBraceLayout:
   Enabled: false
-# メソッド指定の多様性を許可
+
+# We don't want to enforce various method calls.
+#
 # while a
 # .b
 #   something
@@ -153,27 +147,30 @@ Layout/MultilineMethodCallBraceLayout:
 Layout/MultilineMethodCallIndentation:
   Enabled: false
 
+# Sometimes, we want to write like this:
+#
 # aaa(bbb(
 #   ccc
 # ))
-# 的なのができないのは不便すぎるのでdisable
 Layout/FirstParameterIndentation:
   Enabled: false
 
-# 以下の両方を許容
+# We want to allow both of them:
+#
 #   aaa.
 #     bb().
 #     cc()
 #   aaa
 #     .bb()
 #     .cc()
-# 前者は途中にコメントをはさむことができて実用上圧倒的に便利.
-# 後者はデフォルトでrubocopがおすすめしてるやつ
+#
+# The first one allows us to insert comments, and it would be convenient.
+# The second one is the default of this Cop.
 Layout/DotPosition:
   Enabled: false
 
-# fixtureファイルの1行 -> DBの1レコードとして記述している
-# 複数行にまたがると直感的でなくなるため無効化
+# We want to consistently write fixture files with the rule: 1 line for 1 record.
+# It's not intuitive with multiple lines.
 Layout/ClosingParenthesisIndentation:
   Exclude:
     - "db/fixtures/*.rb"
@@ -181,30 +178,27 @@ Layout/ParameterAlignment:
   Exclude:
     - "db/fixtures/*.rb"
 
-# * 警告 120文字
-# * 禁止 160文字
-# のイメージ
 Layout/LineLength:
   Max: 160
   Exclude:
     - "db/migrate/*.rb"
-    - "db/fixtures/*.rb" # カラムが多い、もしくは文章が含まれるfixtureは一行が長くなってしまうため無効化
+    - "db/fixtures/*.rb" # Fixture files usually include long lines.
 
 ##################### Lint ##################################
 
-# 引数前のスペースを許容する
+# We sometimes want to put spaces before arguments.
 Lint/ParenthesesAsGroupedExpression:
     Enabled: false
 
 ##################### Metrics ##################################
 
-# 20 行超えるのは migration ファイル以外滅多に無い
+# There is something wrong with more than 20 lines aside from migration files.
 Metrics/MethodLength:
   Max: 20
   Exclude:
     - "db/migrate/*.rb"
 
-# キーワード引数は引数の数に含めない
+# We want to measure this metrics without keyword arguments.
 Metrics/ParameterLists:
   CountKeywordArgs: false
 
@@ -216,10 +210,22 @@ Metrics/BlockLength:
     - "app/admin/*.rb"
     - "config/**/*.rb"
 
+# We discussed internally about this parameter and decided to follow this configuration.
+# https://github.com/onk/onkcop/blob/8066859d3d00328146c1da9e57bdd4a951974ef2/config/rubocop.yml#L113-L116
 Metrics/AbcSize:
+  Max: 20
   Exclude:
     - "test/**/*.rb"
 
 Metrics/ClassLength:
   Exclude:
     - "test/**/*.rb"
+
+# Does the variable name for an exception object really matter?
+# There are many things to think about before taking care of it.
+Naming/RescuedExceptionsVariableName:
+  Enabled: false
+
+# disabling to not to show errors if there is no when/with/without in the context
+RSpec/ContextWording:
+  Enabled: false

data/exe/fablicop

@@ -1,10 +1,11 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-$LOAD_PATH.unshift File.dirname(__FILE__) + "/../lib"
+$LOAD_PATH.prepend File.join(__dir__.to_s, '..', 'lib')
 
 # Exit cleanly from an early interrupt
-Signal.trap("INT") { exit 1 }
+Signal.trap('INT') { exit 1 }
 
-require "fablicop"
+require 'fablicop'
 
 Fablicop::CLI.start(ARGV)

data/fablicop.gemspec

@@ -1,38 +1,43 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'fablicop/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "fablicop"
+  spec.name          = 'fablicop'
   spec.version       = Fablicop::VERSION
-  spec.authors       = ["tommy", "ujihisa", "sinamon129"]
-  spec.email         = ["kazushige_tominaga@fablic.co.jp", "tatsuhiro_ujihisa@fablic.co.jp", "shihomi_katayama@fablic.co.jp"]
+  spec.authors       = %w[tommy ujihisa sinamon129]
+  spec.email         = ['kazushige_tominaga@fablic.co.jp', 'tatsuhiro_ujihisa@fablic.co.jp', 'shihomi_katayama@fablic.co.jp']
 
-  spec.summary       = "fablicop is a RuboCop configration gem. "
-  spec.description   = "fablicop is a RuboCop configration gem."
-  spec.homepage      = "https://github.com/Fablic/fablicop"
-  spec.license       = "MIT"
+  spec.summary       = 'fablicop is a RuboCop configration gem. '
+  spec.description   = 'fablicop is a RuboCop configration gem.'
+  spec.homepage      = 'https://github.com/Fablic/fablicop'
+  spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
-  #if spec.respond_to?(:metadata)
+  # if spec.respond_to?(:metadata)
   #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-  #else
+  # else
   #  raise "RubyGems 2.0 or newer is required to protect against " \
   #    "public gem pushes."
-  #end
+  # end
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.5.0'
 
-  spec.add_dependency "rubocop", "~> 1.14.0"
-  spec.add_dependency "rubocop-rspec", ">= 1.15.1"
-  spec.add_dependency "rubocop-rails"
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
+  spec.add_dependency 'rubocop', '~> 1.14.0'
+  spec.add_dependency 'rubocop-rspec', '>= 1.15.1'
+  spec.add_dependency 'rubocop-rails'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'byebug'
 end

data/lib/fablicop/cli.rb

@@ -1,4 +1,7 @@
-require "fileutils"
+# frozen_string_literal: true
+
+require 'fileutils'
+
 module Fablicop
   class CLI
     def self.start(args)
@@ -17,26 +20,27 @@ module Fablicop
       puts "Could not find command #{action_name}."
       print_help
       exit(1)
-    rescue => e
+    rescue StandardError => e
       puts e.message
       exit(1)
     end
 
     def self.retrieve_command_name(args)
       meth = args.first.to_s unless args.empty?
-      args.shift if meth && (meth !~ /^\-/)
+      args.shift if meth && (meth !~ /^-/)
     end
 
     def self.print_help
-      puts "fablicop commands:"
-      puts "  init - Setup .rubocop.yml"
+      puts 'fablicop commands:'
+      puts '  init - Setup .rubocop.yml'
     end
 
-    CONFIG_FILE_NAME = ".rubocop.yml"
+    CONFIG_FILE_NAME = '.rubocop.yml'
     def init(args)
-      raise "usage: fablicop init" unless args.empty?
-      template_path = File.expand_path("../../templates", __dir__)
-      puts "#{File.exist?(CONFIG_FILE_NAME) ? "overwrite" : "create"} #{CONFIG_FILE_NAME}"
+      raise 'usage: fablicop init' unless args.empty?
+
+      template_path = File.expand_path('../../templates', __dir__)
+      puts "#{File.exist?(CONFIG_FILE_NAME) ? 'overwrite' : 'create'} #{CONFIG_FILE_NAME}"
       FileUtils.copy_file(File.join(template_path, CONFIG_FILE_NAME), CONFIG_FILE_NAME)
     end
   end

data/lib/fablicop/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fablicop
-  VERSION = '1.0.9'
+  VERSION = '1.2.0'
 end

data/lib/fablicop.rb

@@ -1,5 +1,7 @@
-require "fablicop/cli"
-require "fablicop/version"
+# frozen_string_literal: true
+
+require 'fablicop/cli'
+require 'fablicop/version'
 
 module Fablicop
   # Your code goes here...

data/templates/.rubocop.yml

@@ -1,7 +1,3 @@
 inherit_gem:
   fablicop:
     - "config/.base_rubocop.yml"
-    # uncomment if use rails cops
-    # - "config/rails.yml"
-    # uncomment if use rspec cops
-    # - "config/rspec.yml"

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: fablicop
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.2.0
 platform: ruby
 authors:
 - tommy
 - ujihisa
 - sinamon129
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-02 00:00:00.000000000 Z
+date: 2021-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -68,6 +68,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -82,6 +96,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: fablicop is a RuboCop configration gem.
 email:
 - kazushige_tominaga@fablic.co.jp
@@ -92,9 +120,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/run-ci.yml"
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
-- ".ruby-version"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -113,7 +143,7 @@ homepage: https://github.com/Fablic/fablicop
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -121,16 +151,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: fablicop is a RuboCop configration gem.
 test_files: []

data/.ruby-version

@@ -1 +0,0 @@
-2.5.5