rubocop-isucon 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c235faec7d2edaadc48681992ad139ffc81d0745e010d923132a509f8012daa3
+  data.tar.gz: eecb16448d52f4a48860171045e9fc6b6108ce68db7d5aa4601a6fcc865828b0
+SHA512:
+  metadata.gz: 2a82eca957548836926ef797d18ed5e014ab26c03407b1bdfd82a659b082479f1d5ede81c05baacd0c172b5856b38b839262fb9ba238618b03597f524f2ddeda
+  data.tar.gz: 3571157d23e59636c0af87617111d0146c00dedfe3da74f4b64fd4e4e108886ef32d1fa56f65f531578be251eca6f0c8182a263cec18c098c497cd9fcc8be6a3

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

@@ -0,0 +1,44 @@
+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 }}

data/.github/workflows/test.yml

@@ -0,0 +1,91 @@
+name: test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+  schedule:
+    - cron: "0 10 * * 5" # JST 19:00 (Fri)
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+
+      matrix:
+        ruby:
+          - "2.6"
+          - "2.7"
+          - "3.0"
+          - "3.1"
+        gemfile:
+          - activerecord_6_1
+          - activerecord_7_0
+        exclude:
+          # activerecord 7.0+ requires Ruby 2.7+
+          - ruby:    "2.6"
+            gemfile: activerecord_7_0
+
+    env:
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
+
+    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: ${{ matrix.ruby }}
+          bundler-cache: true
+          cache-version: ${{ matrix.gemfile }}
+
+      - name: bundle update
+        run: |
+          set -xe
+          bundle config path vendor/bundle
+          bundle update --jobs $(nproc) --retry 3
+
+      - run: bundle exec rspec
+      - run: bundle exec rubocop
+      - run: bundle exec yard --fail-on-warning
+
+      - name: Slack Notification (not success)
+        uses: lazy-actions/slatify@master
+        if: "! success()"
+        continue-on-error: true
+        with:
+          job_name: ${{ format('*build* ({0}, {1})', matrix.ruby, matrix.gemfile) }}
+          type: ${{ job.status }}
+          icon_emoji: ":octocat:"
+          url: ${{ secrets.SLACK_WEBHOOK }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+  notify:
+    needs:
+      - test
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Slack Notification (success)
+        uses: lazy-actions/slatify@master
+        if: always()
+        continue-on-error: true
+        with:
+          job_name: '*build*'
+          type: ${{ job.status }}
+          icon_emoji: ":octocat:"
+          url: ${{ secrets.SLACK_WEBHOOK }}
+          token: ${{ secrets.GITHUB_TOKEN }}

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,43 @@
+require:
+  - rubocop-performance
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.6
+  Exclude:
+    - 'gemfiles/vendor/**/*'
+    - 'benchmark/**/*'
+
+    # https://github.com/rubocop/rubocop/blob/v1.20.0/config/default.yml
+    - 'node_modules/**/*'
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+    - '.git/**/*'
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/LineLength:
+  Max: 130
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+    - "*.gemspec"
+
+Naming/FileName:
+ Exclude:
+   - lib/rubocop-isucon.rb
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/.yardopts

@@ -0,0 +1,7 @@
+--markup markdown
+--markup-provider redcarpet
+--no-private
+--hide-void-return
+-
+CHANGELOG.md
+LICENSE.txt

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## [Unreleased]
+[full changelog](http://github.com/sue445/rubocop-isucon/compare/v0.1.0...main)
+
+## [0.1.0] - 2022-07-23
+
+- Initial release

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rubocop-isucon.gemspec
+gemspec
+
+# eval_gemfile "#{__dir__}/gemfiles/common.gemfile"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 sue445
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,108 @@
+# RuboCop ISUCON
+RuboCop plugin for ruby reference implementation of [ISUCON](https://github.com/isucon)
+
+[![Build Status](https://github.com/sue445/rubocop-isucon/workflows/test/badge.svg?branch=main)](https://github.com/sue445/rubocop-isucon/actions?query=workflow%3Atest)
+
+## Installation
+At first, install [libgda](https://gitlab.gnome.org/GNOME/libgda)
+
+### for Mac (recommended)
+```bash
+brew install libgda
+```
+
+### for Ubuntu, Debian (recommended)
+```bash
+apt-get install -y libgda-5.0
+```
+
+### for CentOS 7
+```bash
+yum install -y epel-release
+yum --enablerepo=epel install -y libgda-devel
+```
+
+### for CentOS 8+
+```bash
+dnf install -y https://pkgs.dyn.su/el8/base/x86_64/raven-release-1.0-2.el8.noarch.rpm
+dnf --enablerepo=raven install -y libgda-devel
+```
+
+### Installing gem
+Add this line to your application's Gemfile:
+
+```ruby
+group :development do
+  gem 'rubocop-isucon', require: false
+end
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rubocop-isucon
+
+## Usage
+
+Add this line to your application's `.rubocop.yml`
+
+```yaml
+require:
+  - rubocop-isucon
+
+inherit_gem:
+  rubocop-isucon:
+    # Disable default cops (except Performance cops)
+    - "config/enable-only-performance.yml"
+
+AllCops:
+  NewCops: enable
+  DisplayStyleGuide: true
+  # TargetRubyVersion: 3.1
+
+Isucon/Mysql2:
+  Database:
+    adapter: mysql2
+    host: # TODO: Fix this
+    database: # TODO: Fix this
+    username: isucon
+    password: isucon
+    encoding: utf8
+    port: 3306
+```
+
+`Database` isn't configured in `.rubocop.yml`, some cops doesn't work
+
+| cop                               | offense detection          | auto-correct               |
+|-----------------------------------|----------------------------|----------------------------|
+| `Isucon/Mysql2/JoinWithoutIndex`  | `Database` is **required** | Not supported              |
+| `Isucon/Mysql2/NPlusOneQuery`     | `Database` is optional     | `Database` is **required** |
+| `Isucon/Mysql2/SelectAsterisk`    | `Database` is optional     | `Database` is **required** |
+| `Isucon/Mysql2/WhereWithoutIndex` | `Database` is **required** | Not supported              |
+
+## Documentation
+See. https://sue445.github.io/rubocop-isucon/
+
+* `Isucon/Mysql2` department docs : https://sue445.github.io/rubocop-isucon/RuboCop/Cop/Isucon/Mysql2.html
+* `Isucon/Shell` department docs : https://sue445.github.io/rubocop-isucon/RuboCop/Cop/Isucon/Shell.html
+* `Isucon/Sinatra` department docs : https://sue445.github.io/rubocop-isucon/RuboCop/Cop/Isucon/Sinatra.html
+
+## Benchmark
+See [benchmark/](benchmark/)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sue445/rubocop-isucon.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList["spec/**/*_spec.rb"]
+end
+
+desc "Generate a new cop with a template"
+task :new_cop, [:cop] do |_task, args|
+  require "rubocop"
+
+  cop_name = args.fetch(:cop) do
+    warn "usage: bundle exec rake new_cop[Department/Name]"
+    exit!
+  end
+
+  generator = RuboCop::Cop::Generator.new(cop_name)
+
+  generator.write_source
+  generator.write_spec
+  generator.inject_require(root_file_path: "lib/rubocop/cop/isucon_cops.rb")
+  generator.inject_config(config_file_path: "config/default.yml")
+
+  puts generator.todo
+end

data/benchmark/README.md

@@ -0,0 +1,69 @@
+# Benchmark report
+## [parse_table.rb](parse_table.rb)
+```bash
+$ ruby -v
+ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) [x86_64-darwin21]
+
+$ bundle exec ruby benchmark/parse_table.rb
+Warming up --------------------------------------
+SqlParser.parse_tables
+                         3.315k i/100ms
+RuboCop::Isucon::GDA::Client#table_names
+                        31.000  i/100ms
+Calculating -------------------------------------
+SqlParser.parse_tables
+                         31.672k (± 7.5%) i/s -    159.120k in   5.056991s
+RuboCop::Isucon::GDA::Client#table_names
+                        418.846  (± 9.8%) i/s -      2.077k in   5.023313s
+
+Comparison:
+SqlParser.parse_tables:    31671.6 i/s
+RuboCop::Isucon::GDA::Client#table_names:      418.8 i/s - 75.62x  (± 0.00) slower
+```
+
+## [memorize.rb](memorize.rb)
+```bash
+$ ruby -v
+ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) [x86_64-darwin21]
+
+$ bundle exec ruby benchmark/memorize.rb
+Warming up --------------------------------------
+DefineMethodWithInstanceVariableMemorizer
+                        79.346k i/100ms
+DefineMethodWithHashMemorizer
+                       158.601k i/100ms
+  ClassEvalMemorizer   497.389k i/100ms
+Calculating -------------------------------------
+DefineMethodWithInstanceVariableMemorizer
+                        701.502k (±13.8%) i/s -      3.491M in   5.087557s
+DefineMethodWithHashMemorizer
+                          1.549M (± 2.3%) i/s -      7.771M in   5.018555s
+  ClassEvalMemorizer      4.866M (± 8.1%) i/s -     24.372M in   5.061882s
+
+Comparison:
+  ClassEvalMemorizer:  4865569.7 i/s
+DefineMethodWithHashMemorizer:  1549386.5 i/s - 3.14x  (± 0.00) slower
+DefineMethodWithInstanceVariableMemorizer:   701502.0 i/s - 6.94x  (± 0.00) slower
+```
+
+## [shell.rb](shell.rb)
+```bash
+$ ruby -v
+ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) [x86_64-darwin21]
+
+$ bundle exec ruby benchmark/shell.rb
+Warming up --------------------------------------
+digest_with_shell_openssl
+                         4.000  i/100ms
+digest_with_ruby_openssl
+                        36.540k i/100ms
+Calculating -------------------------------------
+digest_with_shell_openssl
+                         92.458  (±22.7%) i/s -    424.000  in   4.985251s
+digest_with_ruby_openssl
+                        453.025k (±10.1%) i/s -      2.265M in   5.057335s
+
+Comparison:
+digest_with_ruby_openssl:   453024.6 i/s
+digest_with_shell_openssl:       92.5 i/s - 4899.78x  (± 0.00) slower
+```

data/benchmark/memorize.rb

@@ -0,0 +1,86 @@
+require "benchmark/ips"
+
+class DefineMethodWithInstanceVariableMemorizer
+  def self.memorize(method_name)
+    define_method "#{method_name}_with_cache" do
+      if (ret = instance_variable_get("@#{method_name}_with_cache"))
+        ret
+      else
+        ret = send("#{method_name}_without_cache")
+        instance_variable_set("@#{method_name}_with_cache", ret)
+        ret
+      end
+    end
+
+    alias_method "#{method_name}_without_cache", method_name
+    alias_method method_name, "#{method_name}_with_cache"
+  end
+
+  def value
+    1
+  end
+
+  memorize :value
+end
+
+class DefineMethodWithHashMemorizer
+  def self.memorize(method_name)
+    define_method "#{method_name}_with_cache" do
+      @__cache ||= {}
+      @__cache[method_name] ||= send("#{method_name}_without_cache")
+    end
+
+    alias_method "#{method_name}_without_cache", method_name
+    alias_method method_name, "#{method_name}_with_cache"
+  end
+
+  def value
+    1
+  end
+
+  memorize :value
+end
+
+# @note This is the current #{RuboCop::Isucon::MemorizeMethods#memorize} implementation
+class ClassEvalMemorizer
+  def self.memorize(method_name)
+    class_eval <<~RUBY, __FILE__, __LINE__ + 1
+      # def foo_with_cache
+      #   @foo_with_cache ||= foo_without_cache
+      # end
+      def #{method_name}_with_cache
+        @#{method_name}_with_cache ||= #{method_name}_without_cache
+      end
+    RUBY
+    alias_method "#{method_name}_without_cache", method_name
+    alias_method method_name, "#{method_name}_with_cache"
+  end
+
+  def value
+    1
+  end
+
+  memorize :value
+end
+
+Benchmark.ips do |x|
+  x.report("DefineMethodWithInstanceVariableMemorizer") do
+    m = DefineMethodWithInstanceVariableMemorizer.new
+    m.value
+    m.value
+  end
+
+  x.report("DefineMethodWithHashMemorizer") do
+    m = DefineMethodWithHashMemorizer.new
+    m.value
+    m.value
+  end
+
+  x.report("ClassEvalMemorizer") do
+    m = ClassEvalMemorizer.new
+    m.value
+    m.value
+  end
+
+  x.compare!
+end

data/benchmark/parse_table.rb

@@ -0,0 +1,103 @@
+require "benchmark/ips"
+require "rubocop-isucon"
+
+# SQL Parser
+#
+# @deprecated Use {RuboCop::Isucon::GDA::Client}
+module SqlParser
+  # Parse table names in SQL (SELECT, UPDATE, INSERT, DELETE)
+  # @param sql [String]
+  # @return [Array<String>]
+  #
+  # @deprecated Use {RuboCop::Isucon::GDA::Client#table_names}
+  def self.parse_tables(sql)
+    # Remove `FOR UPDATE` in `SELECT`
+    sql = sql.gsub(/FOR\s+UPDATE/i, "")
+
+    # Remove `ON DUPLICATE KEY UPDATE` in `INSERT`
+    sql = sql.gsub(/ON\s+DUPLICATE\s+KEY\s+UPDATE/i, "")
+
+    sql.scan(/(?:FROM|INTO|UPDATE|JOIN)\s+([^(]+?)[\s(]/i).
+      map { |matched| matched[0].strip.delete("`") }.reject(&:empty?).uniq
+  end
+end
+
+# c.f. https://github.com/isucon/isucon10-final/blob/e858b2588a199f9c7407baacf48b53126b8aeed6/webapp/ruby/app.rb#L250-L318
+sql = <<~SQL
+  SELECT
+    `teams`.`id` AS `id`,
+    `teams`.`name` AS `name`,
+    `teams`.`leader_id` AS `leader_id`,
+    `teams`.`withdrawn` AS `withdrawn`,
+    `team_student_flags`.`student` AS `student`,
+    (`best_score_jobs`.`score_raw` - `best_score_jobs`.`score_deduction`) AS `best_score`,
+    `best_score_jobs`.`started_at` AS `best_score_started_at`,
+    `best_score_jobs`.`finished_at` AS `best_score_marked_at`,
+    (`latest_score_jobs`.`score_raw` - `latest_score_jobs`.`score_deduction`) AS `latest_score`,
+    `latest_score_jobs`.`started_at` AS `latest_score_started_at`,
+    `latest_score_jobs`.`finished_at` AS `latest_score_marked_at`,
+    `latest_score_job_ids`.`finish_count` AS `finish_count`
+  FROM
+    `teams`
+    -- latest scores
+    LEFT JOIN (
+      SELECT
+        MAX(`id`) AS `id`,
+        `team_id`,
+        COUNT(*) AS `finish_count`
+      FROM
+        `benchmark_jobs`
+      WHERE
+        `finished_at` IS NOT NULL
+        -- score freeze
+        AND (`team_id` = ? OR (`team_id` != ? AND (? = TRUE OR `finished_at` < ?)))
+      GROUP BY
+        `team_id`
+    ) `latest_score_job_ids` ON `latest_score_job_ids`.`team_id` = `teams`.`id`
+    LEFT JOIN `benchmark_jobs` `latest_score_jobs` ON `latest_score_job_ids`.`id` = `latest_score_jobs`.`id`
+    -- best scores
+    LEFT JOIN (
+      SELECT
+        MAX(`j`.`id`) AS `id`,
+        `j`.`team_id` AS `team_id`
+      FROM
+        (
+          SELECT
+            `team_id`,
+            MAX(`score_raw` - `score_deduction`) AS `score`
+          FROM
+            `benchmark_jobs`
+          WHERE
+            `finished_at` IS NOT NULL
+            -- score freeze
+            AND (`team_id` = ? OR (`team_id` != ? AND (? = TRUE OR `finished_at` < ?)))
+          GROUP BY
+            `team_id`
+        ) `best_scores`
+        LEFT JOIN `benchmark_jobs` `j` ON (`j`.`score_raw` - `j`.`score_deduction`) = `best_scores`.`score`
+          AND `j`.`team_id` = `best_scores`.`team_id`
+      GROUP BY
+        `j`.`team_id`
+    ) `best_score_job_ids` ON `best_score_job_ids`.`team_id` = `teams`.`id`
+    LEFT JOIN `benchmark_jobs` `best_score_jobs` ON `best_score_jobs`.`id` = `best_score_job_ids`.`id`
+    -- check student teams
+    LEFT JOIN (
+      SELECT
+        `team_id`,
+        (SUM(`student`) = COUNT(*)) AS `student`
+      FROM
+        `contestants`
+      GROUP BY
+        `contestants`.`team_id`
+    ) `team_student_flags` ON `team_student_flags`.`team_id` = `teams`.`id`
+  ORDER BY
+    `latest_score` DESC,
+    `latest_score_marked_at` ASC
+SQL
+
+Benchmark.ips do |x|
+  x.report("SqlParser.parse_tables") { SqlParser.parse_tables(sql) }
+  x.report("RuboCop::Isucon::GDA::Client#table_names") { RuboCop::Isucon::GDA::Client.new(sql).table_names }
+
+  x.compare!
+end

data/benchmark/shell.rb

@@ -0,0 +1,26 @@
+require "benchmark/ips"
+require "openssl"
+require "securerandom"
+require "shellwords"
+
+def digest_with_shell_openssl(src)
+  `printf "%s" #{Shellwords.shellescape(src)} | openssl dgst -sha512 | sed 's/^.*= //'`.strip
+end
+
+def digest_with_ruby_openssl(src)
+  OpenSSL::Digest::SHA512.hexdigest(src)
+end
+
+SOURCE_TEXT = SecureRandom.alphanumeric(256)
+
+Benchmark.ips do |x|
+  x.report("digest_with_shell_openssl") do
+    digest_with_shell_openssl(SOURCE_TEXT)
+  end
+
+  x.report("digest_with_ruby_openssl") do
+    digest_with_ruby_openssl(SOURCE_TEXT)
+  end
+
+  x.compare!
+end