rubocop-isucon 1.0.2 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (17) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/pages.yml +6 -9
  3. data/.github/workflows/test.yml +10 -17
  4. data/.rubocop.yml +4 -2
  5. data/CHANGELOG.md +17 -1
  6. data/README.md +2 -2
  7. data/gemfiles/{activerecord_7_1.gemfile → activerecord_8_0.gemfile} +3 -3
  8. data/lib/rubocop/isucon/gda/client.rb +4 -4
  9. data/lib/rubocop/isucon/memorize_methods.rb +1 -1
  10. data/lib/rubocop/isucon/plugin.rb +31 -0
  11. data/lib/rubocop/isucon/version.rb +1 -1
  12. data/lib/rubocop-isucon.rb +1 -3
  13. data/rubocop-isucon.gemspec +7 -5
  14. metadata +27 -17
  15. data/gemfiles/activerecord_6_1.gemfile +0 -14
  16. data/gemfiles/activerecord_7_0.gemfile +0 -14
  17. data/lib/rubocop/isucon/inject.rb +0 -20
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: aab150e156e21e700479dc453477e496e056bbc10ff5b6e512c7bbdc4a0c6e19
4
- data.tar.gz: cae10ca2b0787a5a85a4959e376874a009b22951180c99de19bf8a477a0f5e13
3
+ metadata.gz: b7155cd097d4bd931ebaf01c090066d7a1fa90dc4424acfe36f27e2c8c92d942
4
+ data.tar.gz: 4b2e9da17cedf4922ca08506e2304b46619c94b6e38392628a0ef5f3ae1f5f9f
5
5
  SHA512:
6
- metadata.gz: 6b5955edce0eac57d1c097b5d0babb5ead48a99043f7d231cbbf8e66d4034bde4b49234a7dd24c90fa50e907379145059eb44744f0f186e5ac8432831bd84cac
7
- data.tar.gz: 47d40e8be7da3cfbd5f448922571ca41718e4fdcc2225cc70eea5150a275e34daac534c2fd446da15038c0114956b9b1a8f87a539843e4baa326cdad879be4b5
6
+ metadata.gz: 68c9c2a527e66e3ac9a64ad71998282c080dbf66f995b2ecbd803747658063c933a1bfd7cf29315f66ec13126226816d7ac9a7ecb83e677c9a81d92c8ae27b76
7
+ data.tar.gz: c6cd8b923b26a4eb8419bdfe4092bcfd64b4fcd0718663636a1fb0a3bc1833952a9d2e4a8062fcd3e9e8b9d2cf619b5922715793e05ea342d1106c6853e621ba
data/.github/workflows/pages.yml CHANGED
@@ -46,23 +46,20 @@ jobs:
46
46
  - run: bundle exec yard
47
47
 
48
48
  - name: Setup Pages
49
- uses: actions/configure-pages@v4
49
+ uses: actions/configure-pages@v5
50
50
  - name: Upload artifact
51
- uses: actions/upload-pages-artifact@v2
51
+ uses: actions/upload-pages-artifact@v3
52
52
  with:
53
53
  # Upload entire repository
54
54
  path: './doc'
55
55
  - name: Deploy to GitHub Pages
56
56
  id: deployment
57
- uses: actions/deploy-pages@main
57
+ uses: actions/deploy-pages@v4
58
58
 
59
59
  - name: Slack Notification (not success)
60
- uses: lazy-actions/slatify@master
60
+ uses: act10ns/slack@v2
61
61
  if: "! success()"
62
62
  continue-on-error: true
63
63
  with:
64
- job_name: "*pages*"
65
- type: ${{ job.status }}
66
- icon_emoji: ":octocat:"
67
- url: ${{ secrets.SLACK_WEBHOOK }}
68
- token: ${{ secrets.GITHUB_TOKEN }}
64
+ status: ${{ job.status }}
65
+ webhook-url: ${{ secrets.SLACK_WEBHOOK }}
data/.github/workflows/test.yml CHANGED
@@ -21,13 +21,11 @@ jobs:
21
21
 
22
22
  matrix:
23
23
  ruby:
24
- - "3.0"
25
- - "3.1"
26
24
  - "3.2"
25
+ - "3.3"
26
+ - "3.4"
27
27
  gemfile:
28
- - activerecord_6_1
29
- - activerecord_7_0
30
- - activerecord_7_1
28
+ - activerecord_8_0
31
29
 
32
30
  env:
33
31
  BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
@@ -58,15 +56,13 @@ jobs:
58
56
  - run: bundle exec yard --fail-on-warning
59
57
 
60
58
  - name: Slack Notification (not success)
61
- uses: lazy-actions/slatify@master
59
+ uses: act10ns/slack@v2
62
60
  if: "! success()"
63
61
  continue-on-error: true
64
62
  with:
65
- job_name: ${{ format('*build* ({0}, {1})', matrix.ruby, matrix.gemfile) }}
66
- type: ${{ job.status }}
67
- icon_emoji: ":octocat:"
68
- url: ${{ secrets.SLACK_WEBHOOK }}
69
- token: ${{ secrets.GITHUB_TOKEN }}
63
+ status: ${{ job.status }}
64
+ webhook-url: ${{ secrets.SLACK_WEBHOOK }}
65
+ matrix: ${{ toJson(matrix) }}
70
66
 
71
67
  notify:
72
68
  needs:
@@ -76,12 +72,9 @@ jobs:
76
72
 
77
73
  steps:
78
74
  - name: Slack Notification (success)
79
- uses: lazy-actions/slatify@master
75
+ uses: act10ns/slack@v2
80
76
  if: always()
81
77
  continue-on-error: true
82
78
  with:
83
- job_name: '*build*'
84
- type: ${{ job.status }}
85
- icon_emoji: ":octocat:"
86
- url: ${{ secrets.SLACK_WEBHOOK }}
87
- token: ${{ secrets.GITHUB_TOKEN }}
79
+ status: ${{ job.status }}
80
+ webhook-url: ${{ secrets.SLACK_WEBHOOK }}
data/.rubocop.yml CHANGED
@@ -1,11 +1,13 @@
1
- require:
1
+ plugins:
2
2
  - rubocop-performance
3
+
4
+ require:
3
5
  - rubocop-yard
4
6
 
5
7
  AllCops:
6
8
  NewCops: enable
7
9
  SuggestExtensions: false
8
- TargetRubyVersion: 3.0
10
+ TargetRubyVersion: 3.2
9
11
  Exclude:
10
12
  - 'gemfiles/vendor/**/*'
11
13
  - 'benchmark/**/*'
data/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  ## [Unreleased]
2
- [full changelog](http://github.com/sue445/rubocop-isucon/compare/v1.0.2...main)
2
+ [full changelog](http://github.com/sue445/rubocop-isucon/compare/v2.0.0...main)
3
+
4
+ ## [2.0.0](https://github.com/sue445/rubocop-isucon/releases/tag/v2.0.0) - 2025-03-23
5
+ [full changelog](http://github.com/sue445/rubocop-isucon/compare/v1.0.3...v2.0.0)
6
+
7
+ * :bomb: **[BREAKING CHANGE]** Requires Ruby 3.2+ and activesupport 8.0+
8
+ * https://github.com/sue445/rubocop-isucon/pull/262
9
+ * Pluginfy RuboCop ISUCON
10
+ * https://github.com/sue445/rubocop-isucon/pull/260
11
+ * Requires rubocop-performance 1.24.0+
12
+ * https://github.com/sue445/rubocop-isucon/pull/263
13
+
14
+ ## [1.0.3] - 2023-12-28
15
+ [full changelog](http://github.com/sue445/rubocop-isucon/compare/v1.0.2...v1.0.3)
16
+
17
+ * Requires rubocop-performance 1.20.1+
18
+ * https://github.com/sue445/rubocop-isucon/pull/248
3
19
 
4
20
  ## [1.0.2] - 2023-12-22
5
21
  [full changelog](http://github.com/sue445/rubocop-isucon/compare/v1.0.1...v1.0.2)
data/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
  RuboCop plugin for ruby reference implementation of [ISUCON](https://github.com/isucon)
3
3
 
4
4
  [![Gem Version](https://badge.fury.io/rb/rubocop-isucon.svg)](https://badge.fury.io/rb/rubocop-isucon)
5
- [![Build Status](https://github.com/sue445/rubocop-isucon/workflows/test/badge.svg?branch=main)](https://github.com/sue445/rubocop-isucon/actions?query=workflow%3Atest)
5
+ [![test](https://github.com/sue445/rubocop-isucon/actions/workflows/test.yml/badge.svg)](https://github.com/sue445/rubocop-isucon/actions/workflows/test.yml)
6
6
 
7
7
  ## Installation
8
8
  At first, install [libgda](https://gitlab.gnome.org/GNOME/libgda)
@@ -51,7 +51,7 @@ Or install it yourself as:
51
51
  Add this line to your application's `.rubocop.yml`
52
52
 
53
53
  ```yaml
54
- require:
54
+ plugins:
55
55
  - rubocop-isucon
56
56
 
57
57
  inherit_gem:
data/gemfiles/{activerecord_7_1.gemfile → activerecord_8_0.gemfile} RENAMED
@@ -2,11 +2,11 @@
2
2
 
3
3
  source "https://rubygems.org"
4
4
 
5
- gem "activerecord", "~> 7.1.0"
5
+ gem "activerecord", "~> 8.0.0"
6
6
 
7
7
  group :sqlite3 do
8
- # c.f. https://github.com/rails/rails/blob/v7.1.0/activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb#L14
9
- gem "sqlite3", "~> 1.4"
8
+ # c.f. https://github.com/rails/rails/blob/v8.0.0/activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb#L14
9
+ gem "sqlite3", ">= 2.1"
10
10
  end
11
11
 
12
12
  # eval_gemfile "#{__dir__}/common.gemfile"
data/lib/rubocop/isucon/gda/client.rb CHANGED
@@ -86,7 +86,7 @@ module RuboCop
86
86
  end
87
87
 
88
88
  # @yieldparam gda [RuboCop::Isucon::GDA::Client]
89
- def visit_subquery_recursive(&block)
89
+ def visit_subquery_recursive(...)
90
90
  return unless from_targets?
91
91
 
92
92
  ast.from.targets.each do |target|
@@ -94,14 +94,14 @@ module RuboCop
94
94
 
95
95
  gda = Client.new(nil, ast: target.expr.select)
96
96
  yield(gda)
97
- gda.visit_subquery_recursive(&block)
97
+ gda.visit_subquery_recursive(...)
98
98
  end
99
99
  end
100
100
 
101
101
  # @yieldparam gda [RuboCop::Isucon::GDA::Client]
102
- def visit_all(&block)
102
+ def visit_all(&)
103
103
  yield(self)
104
- visit_subquery_recursive(&block)
104
+ visit_subquery_recursive(&)
105
105
  end
106
106
 
107
107
  # @return [Boolean]
data/lib/rubocop/isucon/memorize_methods.rb CHANGED
@@ -31,7 +31,7 @@ module RuboCop
31
31
  RUBY
32
32
 
33
33
  alias_method :"#{method_name}_without_cache", method_name
34
- alias_method method_name, "#{method_name}_with_cache"
34
+ alias_method method_name, :"#{method_name}_with_cache"
35
35
  end
36
36
  end
37
37
  end
data/lib/rubocop/isucon/plugin.rb ADDED
@@ -0,0 +1,31 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "lint_roller"
4
+
5
+ module RuboCop
6
+ module Isucon
7
+ # A plugin that integrates RuboCop Performance with RuboCop's plugin system.
8
+ class Plugin < LintRoller::Plugin
9
+ def about
10
+ LintRoller::About.new(
11
+ name: "rubocop-isucon",
12
+ version: VERSION,
13
+ homepage: "https://github.com/sue445/rubocop-isucon",
14
+ description: "RuboCop plugin for ruby reference implementation of ISUCON",
15
+ )
16
+ end
17
+
18
+ def supported?(context)
19
+ context.engine == :rubocop
20
+ end
21
+
22
+ def rules(_context)
23
+ LintRoller::Rules.new(
24
+ type: :path,
25
+ config_format: :rubocop,
26
+ value: Pathname.new(__dir__).join("../../../config/default.yml"),
27
+ )
28
+ end
29
+ end
30
+ end
31
+ end
data/lib/rubocop/isucon/version.rb CHANGED
@@ -2,6 +2,6 @@
2
2
 
3
3
  module RuboCop
4
4
  module Isucon
5
- VERSION = "1.0.2"
5
+ VERSION = "2.0.0"
6
6
  end
7
7
  end
data/lib/rubocop-isucon.rb CHANGED
@@ -6,11 +6,9 @@ require "gda"
6
6
 
7
7
  require_relative "rubocop/isucon"
8
8
  require_relative "rubocop/isucon/version"
9
- require_relative "rubocop/isucon/inject"
9
+ require_relative "rubocop/isucon/plugin"
10
10
  require_relative "rubocop/isucon/database_connection"
11
11
  require_relative "rubocop/isucon/memorize_methods"
12
12
  require_relative "rubocop/isucon/gda"
13
13
 
14
- RuboCop::Isucon::Inject.defaults!
15
-
16
14
  require_relative "rubocop/cop/isucon_cops"
data/rubocop-isucon.gemspec CHANGED
@@ -12,13 +12,14 @@ Gem::Specification.new do |spec|
12
12
  spec.description = "RuboCop plugin for ruby reference implementation of ISUCON"
13
13
  spec.homepage = "https://github.com/sue445/rubocop-isucon"
14
14
  spec.license = "MIT"
15
- spec.required_ruby_version = ">= 3.0.0"
15
+ spec.required_ruby_version = ">= 3.2.0"
16
16
 
17
17
  spec.metadata["homepage_uri"] = spec.homepage
18
18
  spec.metadata["source_code_uri"] = "https://github.com/sue445/rubocop-isucon"
19
19
  spec.metadata["changelog_uri"] = "https://github.com/sue445/rubocop-isucon/blob/main/CHANGELOG.md"
20
20
  spec.metadata["documentation_uri"] = "https://sue445.github.io/rubocop-isucon/"
21
21
  spec.metadata["rubygems_mfa_required"] = "true"
22
+ spec.metadata["default_lint_roller_plugin"] = "RuboCop::Isucon::Plugin"
22
23
 
23
24
  # Specify which files should be added to the gem when it is released.
24
25
  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -35,10 +36,11 @@ Gem::Specification.new do |spec|
35
36
  # For more information and examples about making a new gem, checkout our
36
37
  # guide at: https://bundler.io/guides/creating_gem.html
37
38
 
38
- spec.add_runtime_dependency "activerecord", ">= 6.1.0"
39
- spec.add_runtime_dependency "gda", "!= 1.1.2"
40
- spec.add_runtime_dependency "rubocop", ">= 1.49.0"
41
- spec.add_runtime_dependency "rubocop-performance", ">= 1.20.0"
39
+ spec.add_dependency "activerecord", ">= 8.0.0"
40
+ spec.add_dependency "gda", "!= 1.1.2"
41
+ spec.add_dependency "lint_roller"
42
+ spec.add_dependency "rubocop", ">= 1.72.0"
43
+ spec.add_dependency "rubocop-performance", ">= 1.24.0"
42
44
 
43
45
  spec.add_development_dependency "benchmark-ips"
44
46
  spec.add_development_dependency "pry-byebug"
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rubocop-isucon
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.2
4
+ version: 2.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - sue445
8
- autorequire:
9
8
  bindir: exe
10
9
  cert_chain: []
11
- date: 2023-12-22 00:00:00.000000000 Z
10
+ date: 2025-03-23 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: activerecord
@@ -16,14 +15,14 @@ dependencies:
16
15
  requirements:
17
16
  - - ">="
18
17
  - !ruby/object:Gem::Version
19
- version: 6.1.0
18
+ version: 8.0.0
20
19
  type: :runtime
21
20
  prerelease: false
22
21
  version_requirements: !ruby/object:Gem::Requirement
23
22
  requirements:
24
23
  - - ">="
25
24
  - !ruby/object:Gem::Version
26
- version: 6.1.0
25
+ version: 8.0.0
27
26
  - !ruby/object:Gem::Dependency
28
27
  name: gda
29
28
  requirement: !ruby/object:Gem::Requirement
@@ -38,34 +37,48 @@ dependencies:
38
37
  - - "!="
39
38
  - !ruby/object:Gem::Version
40
39
  version: 1.1.2
40
+ - !ruby/object:Gem::Dependency
41
+ name: lint_roller
42
+ requirement: !ruby/object:Gem::Requirement
43
+ requirements:
44
+ - - ">="
45
+ - !ruby/object:Gem::Version
46
+ version: '0'
47
+ type: :runtime
48
+ prerelease: false
49
+ version_requirements: !ruby/object:Gem::Requirement
50
+ requirements:
51
+ - - ">="
52
+ - !ruby/object:Gem::Version
53
+ version: '0'
41
54
  - !ruby/object:Gem::Dependency
42
55
  name: rubocop
43
56
  requirement: !ruby/object:Gem::Requirement
44
57
  requirements:
45
58
  - - ">="
46
59
  - !ruby/object:Gem::Version
47
- version: 1.49.0
60
+ version: 1.72.0
48
61
  type: :runtime
49
62
  prerelease: false
50
63
  version_requirements: !ruby/object:Gem::Requirement
51
64
  requirements:
52
65
  - - ">="
53
66
  - !ruby/object:Gem::Version
54
- version: 1.49.0
67
+ version: 1.72.0
55
68
  - !ruby/object:Gem::Dependency
56
69
  name: rubocop-performance
57
70
  requirement: !ruby/object:Gem::Requirement
58
71
  requirements:
59
72
  - - ">="
60
73
  - !ruby/object:Gem::Version
61
- version: 1.20.0
74
+ version: 1.24.0
62
75
  type: :runtime
63
76
  prerelease: false
64
77
  version_requirements: !ruby/object:Gem::Requirement
65
78
  requirements:
66
79
  - - ">="
67
80
  - !ruby/object:Gem::Version
68
- version: 1.20.0
81
+ version: 1.24.0
69
82
  - !ruby/object:Gem::Dependency
70
83
  name: benchmark-ips
71
84
  requirement: !ruby/object:Gem::Requirement
@@ -233,9 +246,7 @@ files:
233
246
  - bin/setup
234
247
  - config/default.yml
235
248
  - config/enable-only-performance.yml
236
- - gemfiles/activerecord_6_1.gemfile
237
- - gemfiles/activerecord_7_0.gemfile
238
- - gemfiles/activerecord_7_1.gemfile
249
+ - gemfiles/activerecord_8_0.gemfile
239
250
  - lib/rubocop-isucon.rb
240
251
  - lib/rubocop/cop/isucon/correctors/n_plus_one_query_corrector.rb
241
252
  - lib/rubocop/cop/isucon/correctors/n_plus_one_query_corrector/correctable_methods.rb
@@ -279,8 +290,8 @@ files:
279
290
  - lib/rubocop/isucon/gda/node_patcher.rb
280
291
  - lib/rubocop/isucon/gda/where_condition.rb
281
292
  - lib/rubocop/isucon/gda/where_operand.rb
282
- - lib/rubocop/isucon/inject.rb
283
293
  - lib/rubocop/isucon/memorize_methods.rb
294
+ - lib/rubocop/isucon/plugin.rb
284
295
  - lib/rubocop/isucon/version.rb
285
296
  - rubocop-isucon.gemspec
286
297
  homepage: https://github.com/sue445/rubocop-isucon
@@ -292,7 +303,7 @@ metadata:
292
303
  changelog_uri: https://github.com/sue445/rubocop-isucon/blob/main/CHANGELOG.md
293
304
  documentation_uri: https://sue445.github.io/rubocop-isucon/
294
305
  rubygems_mfa_required: 'true'
295
- post_install_message:
306
+ default_lint_roller_plugin: RuboCop::Isucon::Plugin
296
307
  rdoc_options: []
297
308
  require_paths:
298
309
  - lib
@@ -300,15 +311,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
300
311
  requirements:
301
312
  - - ">="
302
313
  - !ruby/object:Gem::Version
303
- version: 3.0.0
314
+ version: 3.2.0
304
315
  required_rubygems_version: !ruby/object:Gem::Requirement
305
316
  requirements:
306
317
  - - ">="
307
318
  - !ruby/object:Gem::Version
308
319
  version: '0'
309
320
  requirements: []
310
- rubygems_version: 3.4.10
311
- signing_key:
321
+ rubygems_version: 3.6.2
312
322
  specification_version: 4
313
323
  summary: RuboCop plugin for ruby reference implementation of ISUCON
314
324
  test_files: []
data/gemfiles/activerecord_6_1.gemfile DELETED
@@ -1,14 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- source "https://rubygems.org"
4
-
5
- gem "activerecord", "~> 6.1.0"
6
-
7
- group :sqlite3 do
8
- # c.f. https://github.com/rails/rails/blob/v6.1.0/activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb#L13
9
- gem "sqlite3", "~> 1.4"
10
- end
11
-
12
- # eval_gemfile "#{__dir__}/common.gemfile"
13
-
14
- gemspec path: "../"
data/gemfiles/activerecord_7_0.gemfile DELETED
@@ -1,14 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- source "https://rubygems.org"
4
-
5
- gem "activerecord", "~> 7.0.1"
6
-
7
- group :sqlite3 do
8
- # c.f. https://github.com/rails/rails/blob/v7.0.1/activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb#L13
9
- gem "sqlite3", "~> 1.4"
10
- end
11
-
12
- # eval_gemfile "#{__dir__}/common.gemfile"
13
-
14
- gemspec path: "../"
data/lib/rubocop/isucon/inject.rb DELETED
@@ -1,20 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # The original code is from https://github.com/rubocop-hq/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
4
- # See https://github.com/rubocop-hq/rubocop-rspec/blob/master/MIT-LICENSE.md
5
- module RuboCop
6
- module Isucon
7
- # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
8
- # bit of our configuration.
9
- module Inject
10
- def self.defaults!
11
- path = CONFIG_DEFAULT.to_s
12
- hash = ConfigLoader.send(:load_yaml_configuration, path)
13
- config = Config.new(hash, path).tap(&:make_excludes_absolute)
14
- puts "configuration from #{path}" if ConfigLoader.debug?
15
- config = ConfigLoader.merge_with_default(config, path)
16
- ConfigLoader.instance_variable_set(:@default_configuration, config)
17
- end
18
- end
19
- end
20
- end