rubocop-isucon 0.1.0

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Isucon
+    module GDA
+      # response of {RuboCop::Isucon::GDA::Client#where_conditions}
+      class WhereCondition
+        # @!attribute [rw] operator
+        #   @return [String]
+        attr_accessor :operator
+
+        # @!attribute [rw] operands
+        #   @return [Array<RuboCop::Isucon::GDA::WhereOperand>]
+        attr_accessor :operands
+
+        # @param operator [String]
+        # @param operands [Array<RuboCop::Isucon::GDA::WhereOperand>]
+        def initialize(operator: nil, operands: [])
+          @operator = operator
+          @operands = operands
+        end
+
+        # @return [String,nil]
+        def column_operand
+          operand0_value = operands[0].value
+
+          return operand0_value if operands.count == 1
+
+          operand1_value = operands[1].value
+
+          operand0_type = operand_type(operand0_value)
+          operand1_type = operand_type(operand1_value)
+
+          return operand0_value if operand0_type == :column || operand1_type == :value
+          return operand1_value if operand1_type == :column || operand0_type == :value
+
+          nil
+        end
+
+        # @return [String,nil]
+        def value_operand
+          return nil if operands.count == 1
+
+          operand0_value = operands[0].value
+          operand1_value = operands[1].value
+
+          operand0_type = operand_type(operand0_value)
+          operand1_type = operand_type(operand1_value)
+
+          return operand0_value if operand0_type == :value || operand1_type == :column
+          return operand1_value if operand1_type == :value || operand0_type == :column
+
+          nil
+        end
+
+        private
+
+        # @param operand [String]
+        # @return [Symbol]
+        def operand_type(operand)
+          case operand
+          when PRACEHOLDER, /^'.+'$/, /^[0-9.]+$/
+            :value
+          when /^[A-Za-z0-9_$]*$/
+            :column
+          else
+            :unknown
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Isucon
+    module GDA
+      # response of {RuboCop::Isucon::GDA::Client#where_conditions}
+      class WhereOperand
+        # @!attribute [rw] value
+        #   @return [String]
+        attr_accessor :value
+
+        # @!attribute [rw] node
+        #   @return [GDA::Nodes::Expr]
+        attr_accessor :node
+
+        # @param value [String]
+        # @param node [GDA::Nodes::Expr]
+        def initialize(value: nil, node: nil)
+          @value = value
+          @node = node
+        end
+
+        # @param other [RuboCop::Isucon::GDA::WhereOperand]
+        # @return [Boolean]
+        def ==(other)
+          other.is_a?(WhereOperand) &&
+            value == other.value
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/isucon/gda.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "gda/client"
+require_relative "gda/gda_ext"
+require_relative "gda/join_condition"
+require_relative "gda/join_operand"
+require_relative "gda/node_location"
+require_relative "gda/node_patcher"
+require_relative "gda/where_condition"
+require_relative "gda/where_operand"
+
+module RuboCop
+  module Isucon
+    # `GDA` helper classes
+    #
+    # @see https://github.com/tenderlove/gda
+    # @see https://gitlab.gnome.org/GNOME/libgda
+    module GDA
+      PRACEHOLDER = "0"
+
+      # @param sql [String]
+      # @return [String]
+      def self.normalize_sql(sql)
+        sql.tr("`", " ").gsub("?", PRACEHOLDER)
+      end
+    end
+  end
+end

data/lib/rubocop/isucon/inject.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# The original code is from https://github.com/rubocop-hq/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
+# See https://github.com/rubocop-hq/rubocop-rspec/blob/master/MIT-LICENSE.md
+module RuboCop
+  module Isucon
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+    # bit of our configuration.
+    module Inject
+      def self.defaults!
+        path = CONFIG_DEFAULT.to_s
+        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        config = Config.new(hash, path).tap(&:make_excludes_absolute)
+        puts "configuration from #{path}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, path)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/isucon/memorize_methods.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Isucon
+    # Memorize helper
+    #
+    module MemorizeMethods
+      # Define memorize method
+      #
+      # @param method_name [String,Symbol]
+      #
+      # @example Usage
+      #   extends RuboCop::Isucon::MemorizeMethods
+      #
+      #   memorize :foo
+      #
+      # @example Generated followings
+      #   def foo_with_cache
+      #     @foo_with_cache ||= foo_without_cache
+      #   end
+      #   alias_method :foo_without_cache, :foo
+      #   alias_method :foo, :foo_with_cache
+      def 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
+    end
+  end
+end

data/lib/rubocop/isucon/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Isucon
+    VERSION = "0.1.0"
+  end
+end

data/lib/rubocop/isucon.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "isucon/version"
+
+module RuboCop
+  # RuboCop Isucon project namespace
+  module Isucon
+    class Error < StandardError; end
+
+    # `Database` isn't configured in `.rubocop.yml`
+    class DatabaseConfigurationError < Error; end
+
+    # Your code goes here...
+    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join("config", "default.yml").freeze
+    CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+  end
+end

data/lib/rubocop-isucon.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "rubocop"
+require "active_record"
+require "gda"
+
+require_relative "rubocop/isucon"
+require_relative "rubocop/isucon/version"
+require_relative "rubocop/isucon/inject"
+require_relative "rubocop/isucon/database_connection"
+require_relative "rubocop/isucon/memorize_methods"
+require_relative "rubocop/isucon/gda"
+
+RuboCop::Isucon::Inject.defaults!
+
+require_relative "rubocop/cop/isucon_cops"

data/rubocop-isucon.gemspec

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative "lib/rubocop/isucon/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubocop-isucon"
+  spec.version       = RuboCop::Isucon::VERSION
+  spec.authors       = ["sue445"]
+  spec.email         = ["sue445@sue445.net"]
+
+  spec.summary       = "RuboCop plugin for ruby reference implementation of ISUCON"
+  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.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/sue445/rubocop-isucon"
+  spec.metadata["changelog_uri"] = "https://github.com/sue445/rubocop-isucon/blob/main/CHANGELOG.md"
+  spec.metadata["documentation_uri"] = "https://sue445.github.io/rubocop-isucon/"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+
+  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-performance"
+
+  spec.add_development_dependency "benchmark-ips"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "redcarpet"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "rubocop_auto_corrector"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "yard"
+end

metadata

@@ -0,0 +1,286 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-isucon
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sue445
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+- !ruby/object:Gem::Dependency
+  name: gda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.29.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.29.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  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: pry-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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: rubocop_auto_corrector
+  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
+    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: 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'
+description: RuboCop plugin for ruby reference implementation of ISUCON
+email:
+- sue445@sue445.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gh-pages.yml"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmark/README.md
+- benchmark/memorize.rb
+- benchmark/parse_table.rb
+- benchmark/shell.rb
+- bin/console
+- bin/setup
+- config/default.yml
+- config/enable-only-performance.yml
+- gemfiles/activerecord_6_1.gemfile
+- gemfiles/activerecord_7_0.gemfile
+- lib/rubocop-isucon.rb
+- lib/rubocop/cop/isucon/correctors/mysql2_n_plus_one_query_corrector.rb
+- lib/rubocop/cop/isucon/correctors/mysql2_n_plus_one_query_corrector/correctable_methods.rb
+- lib/rubocop/cop/isucon/correctors/mysql2_n_plus_one_query_corrector/replace_methods.rb
+- lib/rubocop/cop/isucon/mixin/database_methods.rb
+- lib/rubocop/cop/isucon/mixin/mysql2_xquery_methods.rb
+- lib/rubocop/cop/isucon/mixin/sinatra_methods.rb
+- lib/rubocop/cop/isucon/mysql2/join_without_index.rb
+- lib/rubocop/cop/isucon/mysql2/many_join_table.rb
+- lib/rubocop/cop/isucon/mysql2/n_plus_one_query.rb
+- lib/rubocop/cop/isucon/mysql2/prepare_execute.rb
+- lib/rubocop/cop/isucon/mysql2/select_asterisk.rb
+- lib/rubocop/cop/isucon/mysql2/where_without_index.rb
+- lib/rubocop/cop/isucon/shell/backtick.rb
+- lib/rubocop/cop/isucon/shell/system.rb
+- lib/rubocop/cop/isucon/sinatra/disable_logging.rb
+- lib/rubocop/cop/isucon/sinatra/logger.rb
+- lib/rubocop/cop/isucon/sinatra/rack_logger.rb
+- lib/rubocop/cop/isucon/sinatra/serve_static_file.rb
+- lib/rubocop/cop/isucon_cops.rb
+- lib/rubocop/isucon.rb
+- lib/rubocop/isucon/database_connection.rb
+- lib/rubocop/isucon/gda.rb
+- lib/rubocop/isucon/gda/client.rb
+- lib/rubocop/isucon/gda/gda_ext.rb
+- lib/rubocop/isucon/gda/join_condition.rb
+- lib/rubocop/isucon/gda/join_operand.rb
+- lib/rubocop/isucon/gda/node_location.rb
+- lib/rubocop/isucon/gda/node_patcher.rb
+- lib/rubocop/isucon/gda/where_condition.rb
+- lib/rubocop/isucon/gda/where_operand.rb
+- lib/rubocop/isucon/inject.rb
+- lib/rubocop/isucon/memorize_methods.rb
+- lib/rubocop/isucon/version.rb
+- rubocop-isucon.gemspec
+homepage: https://github.com/sue445/rubocop-isucon
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sue445/rubocop-isucon
+  source_code_uri: https://github.com/sue445/rubocop-isucon
+  changelog_uri: https://github.com/sue445/rubocop-isucon/blob/main/CHANGELOG.md
+  documentation_uri: https://sue445.github.io/rubocop-isucon/
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: RuboCop plugin for ruby reference implementation of ISUCON
+test_files: []