rubocop-isucon 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 645e1a353538a4c8d8c8914ac76ac7fbb6f1338dbea8d10c16394a6711be725a
-  data.tar.gz: 450b780a05d2e4f5632bd2ffe35453390bfa1e1c4a240662e440b5cbb2e5390c
+  metadata.gz: 6bd0eac249a23368414a86aa1ab08826542cf644fa50b19017a2bcfd6648d594
+  data.tar.gz: 18e829ac97ac7c7cb9696a1078f36b8a958fd340ddbb9bc1b232b2630e683df2
 SHA512:
-  metadata.gz: 5c900d876a05963ec323cb6e9a4aec8b6b3b9f35c9bc76910e43c758cf0b6b5203b1d53ee2cf050a7ccfe5f304b4158f6d43a85b72441c42726270e0518b6f83
-  data.tar.gz: 0cea7082761dd2bdc38792b0cd60fbccafa886bded25475fa848fb6c2cbab58ea3a370d5fcbb793ca02402c95aab495bfee8e63b3617f3e5b9420fde4d18070e
+  metadata.gz: 58238a855da0596f653d47436977b44cc7722982a1b59e60850f79003b356d85071cba061cca6adae2b4cfa4b63ab489e121135e3c2954f366f5ca1c375e1bbf
+  data.tar.gz: b7747989e1219c7fee4f834b8811e419d3c9f6083336d5fab7e7b19a3f8e1f0dad86644e708b18b926b9de3a678edf8b31495097e319bff970599b80d0ab21d9

data/.github/dependabot.yml

@@ -0,0 +1,10 @@
+# c.f. https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+version: 2
+
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+    assignees:
+      - sue445

data/.github/workflows/pages.yml

@@ -0,0 +1,68 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches:
+      - main
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install packages
+        run: |
+          set -xe
+          sudo apt-get update
+          sudo apt-get install -y libgda-5.0
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby
+          bundler-cache: true
+
+      - run: bundle exec yard
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          # Upload entire repository
+          path: './doc'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@main
+
+      - name: Slack Notification (not success)
+        uses: lazy-actions/slatify@master
+        if: "! success()"
+        continue-on-error: true
+        with:
+          job_name: "*pages*"
+          type: ${{ job.status }}
+          icon_emoji: ":octocat:"
+          url: ${{ secrets.SLACK_WEBHOOK }}
+          token: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/test.yml

@@ -21,23 +21,19 @@ jobs:
 
       matrix:
         ruby:
-          - "2.6"
-          - "2.7"
           - "3.0"
           - "3.1"
+          - "3.2"
         gemfile:
           - activerecord_6_1
           - activerecord_7_0
-        exclude:
-          # activerecord 7.0+ requires Ruby 2.7+
-          - ruby:    "2.6"
-            gemfile: activerecord_7_0
+          - activerecord_7_1
 
     env:
       BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Install packages
         run: |

data/.rubocop.yml

@@ -1,10 +1,11 @@
 require:
   - rubocop-performance
+  - rubocop-yard
 
 AllCops:
   NewCops: enable
   SuggestExtensions: false
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.0
   Exclude:
     - 'gemfiles/vendor/**/*'
     - 'benchmark/**/*'
@@ -15,6 +16,9 @@ AllCops:
     - 'vendor/**/*'
     - '.git/**/*'
 
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
 Layout/DotPosition:
   EnforcedStyle: trailing
 

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
-[full changelog](http://github.com/sue445/rubocop-isucon/compare/v0.2.0...main)
+[full changelog](http://github.com/sue445/rubocop-isucon/compare/v1.0.0...main)
+
+## [1.0.0] - 2023-10-29
+[full changelog](http://github.com/sue445/rubocop-isucon/compare/v0.2.0...v1.0.0)
+
+* Requires Ruby 3.0+
+  * https://github.com/sue445/rubocop-isucon/pull/236
+
+## [0.2.0] - 2022-07-31
+[full changelog](http://github.com/sue445/rubocop-isucon/compare/v0.1.0...v0.2.0)
 
 * Add `Isucon/Sqlite3/SelectAsterisk`
   * https://github.com/sue445/rubocop-isucon/pull/202
@@ -12,9 +21,6 @@
 * Add `Isucon/Sqlite3/NPlusOneQuery`
   * https://github.com/sue445/rubocop-isucon/pull/210
 
-## [0.1.0] - 2022-07-31
-[full changelog](http://github.com/sue445/rubocop-isucon/compare/v0.1.0...v0.2.0)
-
 ## [0.1.0] - 2022-07-23
 
 - Initial release

data/README.md

@@ -117,3 +117,10 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/sue445
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+ISUCON is a trademark or registered trademark of LINE Corporation.
+
+https://isucon.net
+
+## Presentation
+* [Fix SQL N\+1 queries with RuboCop](https://speakerdeck.com/sue445/fix-sql-n-plus-one-queries-with-rubocop) at [RubyKaigi 2023](https://rubykaigi.org/2013/) :gem:

data/config/default.yml

@@ -16,7 +16,7 @@ Isucon/Mysql2/ManyJoinTable:
   CountTables: 3
 
 Isucon/Mysql2/NPlusOneQuery:
-  Description: 'Checks that N+1 query is not used'
+  Description: 'Checks that there’s no N+1 query'
   Enabled: true
   VersionAdded: '0.1.0'
   SafeAutoCorrect: false
@@ -100,7 +100,7 @@ Isucon/Sqlite3/ManyJoinTable:
   CountTables: 3
 
 Isucon/Sqlite3/NPlusOneQuery:
-  Description: 'Checks that N+1 query is not used'
+  Description: 'Checks that there’s no N+1 query'
   Enabled: true
   VersionAdded: '0.2.0'
   SafeAutoCorrect: false

data/gemfiles/activerecord_7_1.gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 7.1.0"
+
+group :sqlite3 do
+  # c.f. https://github.com/rails/rails/blob/v7.1.0/activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb#L14
+  gem "sqlite3", "~> 1.4"
+end
+
+# eval_gemfile "#{__dir__}/common.gemfile"
+
+gemspec path: "../"

data/lib/rubocop/cop/isucon/correctors/n_plus_one_query_corrector.rb

@@ -9,7 +9,7 @@ module RuboCop
       module Correctors
         # rubocop:disable Layout/LineLength
 
-        # Corrector for {RuboCop::Cop::Isucon::Mysql2::NPlusOneQuery}
+        # Corrector for {RuboCop::Cop::Isucon::Mysql2::NPlusOneQuery} and {RuboCop::Cop::Isucon::Sqlite3::NPlusOneQuery}
         #
         # @example Before
         #   courses.map do |course|

data/lib/rubocop/cop/isucon/mixin/select_asterisk_methods.rb

@@ -62,7 +62,7 @@ module RuboCop
           end
 
           # @param select_field_node [GDA::Nodes::SelectField]
-          # @return [Hash<Symbol, String>] table_name, column_name
+          # @return [Hash{Symbol => String}] table_name, column_name
           def parse_select_field_node(select_field_node)
             column_elements = select_field_node.expr.value.split(".", 2)
 

data/lib/rubocop/cop/isucon/mysql2/n_plus_one_query.rb

@@ -6,7 +6,7 @@ module RuboCop
       module Mysql2
         # rubocop:disable Layout/LineLength
 
-        # Checks that N+1 query is not used
+        # Checks that there’s no N+1 query
         #
         # @note If `Database` isn't configured, auto-correct will not be available. (Only offense detection can be used)
         #

data/lib/rubocop/cop/isucon/mysql2/where_without_index.rb

@@ -10,10 +10,10 @@ module RuboCop
         #
         # @example
         #   # bad (user_id is not indexed)
-        #   db.xquery('SELECT id, title FROM articles WHERE used_id = ?', user_id)
+        #   db.xquery('SELECT id, title FROM articles WHERE user_id = ?', user_id)
         #
         #   # good (user_id is indexed)
-        #   db.xquery('SELECT id, title FROM articles WHERE used_id = ?', user_id)
+        #   db.xquery('SELECT id, title FROM articles WHERE user_id = ?', user_id)
         #
         #   # good (id is primary key)
         #   db.xquery('SELECT id, title FROM articles WHERE id = ?', id)

data/lib/rubocop/cop/isucon/shell/backtick.rb

@@ -22,6 +22,13 @@ module RuboCop
         #     OpenSSL::Digest::SHA512.hexdigest(src)
         #   end
         #
+        #   # bad
+        #   `curl -s https://example.com`
+        #
+        #   # good
+        #   require "open-uri"
+        #   URI.open("https://example.com").read
+        #
         class Backtick < Base
           MSG = "Use pure-ruby code instead of external command execution if possible"
 

data/lib/rubocop/cop/isucon/sqlite3/n_plus_one_query.rb

@@ -6,7 +6,7 @@ module RuboCop
       module Sqlite3
         # rubocop:disable Layout/LineLength
 
-        # Checks that N+1 query is not used
+        # Checks that there’s no N+1 query
         #
         # @note If `Database` isn't configured, auto-correct will not be available. (Only offense detection can be used)
         #

data/lib/rubocop/cop/isucon/sqlite3/where_without_index.rb

@@ -10,10 +10,10 @@ module RuboCop
         #
         # @example
         #   # bad (user_id is not indexed)
-        #   db.execute('SELECT id, title FROM articles WHERE used_id = ?', [user_id])
+        #   db.execute('SELECT id, title FROM articles WHERE user_id = ?', [user_id])
         #
         #   # good (user_id is indexed)
-        #   db.execute('SELECT id, title FROM articles WHERE used_id = ?', [user_id])
+        #   db.execute('SELECT id, title FROM articles WHERE user_id = ?', [user_id])
         #
         #   # good (id is primary key)
         #   db.execute('SELECT id, title FROM articles WHERE id = ?', [id])

data/lib/rubocop/isucon/gda/client.rb

@@ -33,7 +33,7 @@ module RuboCop
 
           @table_names =
             if from_targets?
-              ast.from.targets.map(&:table_name).compact.uniq
+              ast.from.targets.filter_map(&:table_name).uniq
             else
               []
             end

data/lib/rubocop/isucon/gda/join_operand.rb

@@ -25,7 +25,7 @@ module RuboCop
         # @param column_name [String]
         # @param as [String]
         # @param node [GDA::Nodes::Expr]
-        def initialize(table_name: nil, column_name: nil, as: nil, node: nil) # rubocop:disable Naming/MethodParameterName
+        def initialize(table_name: nil, column_name: nil, as: nil, node: nil)
           @table_name = table_name
           @column_name = column_name
           @as = as

data/lib/rubocop/isucon/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Isucon
-    VERSION = "0.2.0"
+    VERSION = "1.0.0"
   end
 end

data/rubocop-isucon.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = "RuboCop plugin for ruby reference implementation of ISUCON"
   spec.homepage      = "https://github.com/sue445/rubocop-isucon"
   spec.license       = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.required_ruby_version = ">= 3.0.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/sue445/rubocop-isucon"
@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "activerecord", ">= 6.1.0"
   spec.add_runtime_dependency "gda", "!= 1.1.2"
-  spec.add_runtime_dependency "rubocop", ">= 1.29.0"
+  spec.add_runtime_dependency "rubocop", ">= 1.49.0"
   spec.add_runtime_dependency "rubocop-performance"
 
   spec.add_development_dependency "benchmark-ips"
@@ -47,6 +47,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-its"
   spec.add_development_dependency "rubocop_auto_corrector"
+  spec.add_development_dependency "rubocop-yard"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "yard"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-isucon
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - sue445
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-31 00:00:00.000000000 Z
+date: 2023-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.29.0
+        version: 1.49.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.29.0
+        version: 1.49.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-yard
+  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: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -199,7 +213,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/gh-pages.yml"
+- ".github/dependabot.yml"
+- ".github/workflows/pages.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
@@ -220,6 +235,7 @@ files:
 - config/enable-only-performance.yml
 - gemfiles/activerecord_6_1.gemfile
 - gemfiles/activerecord_7_0.gemfile
+- gemfiles/activerecord_7_1.gemfile
 - lib/rubocop-isucon.rb
 - lib/rubocop/cop/isucon/correctors/n_plus_one_query_corrector.rb
 - lib/rubocop/cop/isucon/correctors/n_plus_one_query_corrector/correctable_methods.rb
@@ -284,14 +300,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: RuboCop plugin for ruby reference implementation of ISUCON

data/.github/workflows/gh-pages.yml

@@ -1,44 +0,0 @@
-name: gh-pages
-
-on:
-  push:
-    branches:
-      - main
-
-jobs:
-  publish_yard:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Install packages
-        run: |
-          set -xe
-          sudo apt-get update
-          sudo apt-get install -y libgda-5.0
-
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: "3.1"
-          bundler-cache: true
-
-      - run: bundle exec yard
-
-      - name: Deploy to GitHub Pages
-        uses: peaceiris/actions-gh-pages@v3
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./doc
-          publish_branch: gh-pages
-
-      - name: Slack Notification (not success)
-        uses: lazy-actions/slatify@master
-        if: "! success()"
-        continue-on-error: true
-        with:
-          job_name: ${{ format('*publish_yard*') }}
-          type: ${{ job.status }}
-          icon_emoji: ":octocat:"
-          url: ${{ secrets.SLACK_WEBHOOK }}
-          token: ${{ secrets.GITHUB_TOKEN }}