query_rule_engine 0.1.0.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d428caaf6d25e1f4d59a3e313989a5e161e1493b0f0953e16455a094343a35db
+  data.tar.gz: 98e8480d007a6c9d42a973c27675856dd651d8bdc1b94bc722e86ca79ed7342a
+SHA512:
+  metadata.gz: d4833614a76bdbd7c37d1762eab7d972b2a706a4d1bdba10b12382f36f96a29bdc049160671e79c3b2d9e70c3db21cf8e6aa24fd47fd1a74937f0f9c290b9566
+  data.tar.gz: d588e2f602ac8c07951694b70fcb6e33a8638f9203c374103e69f09c0be831bdf579ef1ee95aa3bba1f1f3f0fe754fd8cc5d26391db42db31500d4b2fdf6c2a6

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.4.1
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+        bundle exec rake

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,10 @@
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# Change Log
+All notable changes to this project will be documented in this file.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at striker.aryu56@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in query_rule_engine.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 0.80"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 strikeraryu
+
+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,43 @@
+# QueryRuleEngine
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/query_rule_engine`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'query_rule_engine'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install query_rule_engine
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/query_rule_engine. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/query_rule_engine/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the QueryRuleEngine project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/query_rule_engine/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# 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]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "query_rule_engine"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/query_rule_engine/analysis/dynamic_message.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module QueryRuleEngine
+  class Analysis
+    # Module to define methods related to dynamic message
+    module DynamicMessage
+      private
+
+      LISTED_VAR = %w[amount column impact table tag value].freeze
+
+      # to pretty print the analysis with warnings and suggestions
+      # @param opts [Hash] opts to get specifc dyanmic message
+      # eg. {"table" => "users", "column" => "select_type", "tag" => "SIMPLE", "type" => "message"}
+      # @return [String]
+      def dynamic_message(opts)
+        table, column, tag, type = opts.values_at("table", "column", "tag", "type")
+        message = self.tables.dig(table, "analysis", column, "tags", tag, type) || ""
+
+        variables = message.scan(/\$(\w+)/).uniq.map { |var| var[0] }
+        variables.each do |var|
+          value = dynamic_value_of(var, opts)
+
+          message.gsub!(/\$#{var}/, value.to_s) if value.present?
+        end
+
+        message
+      end
+
+      def dynamic_value_of(var, opts)
+        LISTED_VAR.include?(var) ? send(var, opts) : relative_value_of(var, opts.dig("table"))
+      end
+
+      def relative_value_of(var, table)
+        value_type = var.match(/amount_/).present? ? "amount" : "value"
+        self.tables.dig(table, "analysis", var.gsub(/amount_/, ""), value_type)
+      end
+
+      # dynamic variable methods
+      def amount(opts)
+        table, column = opts.values_at("table", "column")
+
+        self.tables.dig(table, "analysis", column, "amount")
+      end
+
+      def column(opts)
+        opts.dig("column")
+      end
+
+      def impact(opts)
+        table, column, tag = opts.values_at("table", "column", "tag")
+
+        impact = self.tables.dig(table, "analysis", column, "tags", tag, "impact")
+
+        opts.dig("colours").present? ? impact.send(IMPACTS[impact].colour) : impact
+      end
+
+      def table(opts)
+        opts.dig("table")
+      end
+
+      def tag(opts)
+        opts.dig("tag")
+      end
+
+      def value(opts)
+        table, column = opts.values_at("table", "column")
+
+        self.tables.dig(table, "analysis", column, "value")
+      end
+    end
+  end
+end

data/lib/query_rule_engine/analysis.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+require_relative 'analysis/dynamic_message'
+
+module QueryRuleEngine
+  # This class is used to store analysis of a query and provide methods over them
+  class Analysis
+    include DynamicMessage
+
+    IMPACTS = {
+      "negative" => { "colour" => "red" },
+      "positive" => { "colour" => "green" },
+      "caution" => { "colour" => "yellow" }
+    }.freeze
+
+    # initialize analysis object
+    # tables [Array] Array of table analysis
+    # Eg.
+    # {
+    #   "users" => {
+    #     "id"=>1,
+    #     "name"=>"users",
+    #     "analysis"=>{
+    #       "type"=>{
+    #         "value" => "all",
+    #         "tags" => {
+    #           "all" => {
+    #             "impact"=>"negative",
+    #             "warning"=>"warning to represent the issue",
+    #             "suggestions"=>"some follow up suggestions"
+    #           }
+    #         }
+    #       }
+    #     }
+    #   }
+    # }
+    # summary [Hash] hash of analysis summary
+    # Eg.
+    #  {
+    #    "cardinality"=>{
+    #      "amount"=>10,
+    #      "warning"=>"warning to represent the issue",
+    #      "suggestions"=>"some follow up suggestions"
+    #    }
+    #  }
+    def initialize
+      @table_count = 0
+      @tables = {}
+      @summary = {}
+    end
+
+    attr_accessor :tables, :table_count, :summary
+
+    # register a table analysis in analysis object
+    # @param name [String] name of the table
+    # @param table_analysis [Hash] analysis of a table
+    # Eg.
+    #  {
+    #    "id"=>1,
+    #    "name"=>"users",
+    #    "analysis"=>{
+    #      "type"=>[
+    #        {
+    #          "tag"=>"all",
+    #          "impact"=>"negative",
+    #          "warning"=>"warning to represent the issue",
+    #          "suggestions"=>"some follow up suggestions"
+    #        }
+    #      ]
+    #    }
+    #  }
+    def register_table(name, table_analysis)
+      self.table_count += 1
+      self.tables.merge!(
+        {
+          name => {
+            "id" => self.table_count,
+            "name" => name,
+            "analysis" => table_analysis
+          }
+        }
+      )
+    end
+
+    # register summary based in different attributes
+    # @param summary [Hash] hash of summary of analysis
+    def register_summary(summary)
+      self.summary.merge!(summary)
+    end
+
+    # to get analysis in pretty format with warnings and suggestions
+    # @param opts [Hash] - possible options [positive: <boolean>, negative: <boolean>, caution: <boolean>]
+    # @return [String] pretty analysis 
+    def pretty_analysis(opts)
+      final_message = ""
+
+      opts.slice(*IMPACTS.keys).each do |impact, value|
+        final_message += pretty_analysis_for(impact) if value.present?
+      end
+
+      final_message
+    end
+
+    # to get analysis in pretty format with warnings and suggestions for a impact
+    # @param impact [String]
+    # @return [String] pretty analysis 
+    def pretty_analysis_for(impact)
+      final_message = ""
+
+      self.tables.keys.each do |table|
+        table_message = table_pretty_analysis(table, {impact => true})
+
+        final_message += "table: #{table}\n#{table_message}\n" if table_message.present?
+      end
+
+      final_message
+    end
+
+    # to get analysis in pretty format with warnings and suggestions for a table
+    # @param table [String] - table name
+    # @param opts [Hash] - possible options [positive: <boolean>, negative: <boolean>, caution: <boolean>]
+    # @return [String] pretty analysis 
+    def table_pretty_analysis(table, opts)
+      table_message = ""
+
+      self.tables.dig(table, "analysis").each do |column, column_analysis|
+        tags_message = ""
+        column_analysis.dig("tags").each do |tag, tag_analysis|
+          next unless opts.dig(tag_analysis.dig("impact")).present?
+
+          tags_message += tag_pretty_analysis(table, column, tag)
+        end
+
+        table_message += "column: #{column}\n#{tags_message}" if tags_message.present?
+      end
+
+      table_message
+    end
+
+    private
+
+    def tag_pretty_analysis(table, column, tag)
+      tag_message = ""
+
+      opts = { "table" => table, "column" => column, "tag" => tag }
+      message = dynamic_message(opts.merge({ "type" => "message" }))
+      suggestion = dynamic_message(opts.merge({ "type" => "suggestion" }))
+      tag_message += "impact: #{impact(opts.merge({ "colours" => true }))}\n"
+      tag_message += "message: #{message}\n"
+      tag_message += "suggestion: #{suggestion}\n" if suggestion.present?
+
+      tag_message
+    end
+  end
+end

data/lib/query_rule_engine/config.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module QueryRuleEngine
+  # This class is used for configuration of query rule engine
+  class Config
+    def initialize(detailed, rules_path)
+      @detailed = detailed
+      @rules_path = rules_path
+    end
+
+    def detailed?
+      @detailed.present?
+    end
+
+    attr_accessor :detailed, :rules_path
+  end
+end

data/lib/query_rule_engine/constants.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module QueryRuleEngine
+  module Constants
+    DEFAULT_COLUMN_RULES = {
+      "value_type" => "string"
+    }.freeze
+    DEFAULT_DETAILED = true
+    DEFAULT_LOGGER_CONFIG = {
+      "negative" => true
+    }.freeze
+    DEFAULT_RULES_PATH =  File.join(File.dirname(__FILE__), "rules.json")
+  end
+end

data/lib/query_rule_engine/explain.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative "helper"
+
+module QueryRuleEngine
+  # This module provides tools to explain queries and ActiveRecord::Relation
+  module Explain
+    # to get explain result in parsable format
+    # @param relation [ActiveRecord::Relation, String] active record relation or raw sql query
+    # @return [Array] parsed_result - array of hashes representing EXPLAIN result for each row
+    def full_explain(relation, detailed = true)
+      explain_result = explain(relation)
+      return explain_result unless detailed
+
+      detailed_explain_result = detailed_explain(relation)
+
+      [*explain_result.keys, *detailed_explain_result.keys].uniq.map do |key|
+        (
+          explain_result.dig(key)&.merge(
+            detailed_explain_result.dig(key) || {}
+          ) || detailed_explain_result.dig(key)
+        )
+      end
+    end
+
+    # to get explain result in parsable format using "EXPLAIN <query>"
+    # @param relation [ActiveRecord::Relation, String] active record relation or raw sql query
+    # @return [Array] parsed_result - array of hashes representing EXPLAIN result for each row
+    def explain(relation)
+      query = load_query(relation)
+      explain_result = ActiveRecord::Base.connection.execute("EXPLAIN #{query}")
+      parsed_result = {}
+
+      explain_result.each(as: :json) do |ele|
+        parsed_result[ele.dig("table")] = ele
+      end
+
+      parsed_result
+    end
+
+    # to get detailed explain result in parsable format using "EXPLAIN format=JSON <query>"
+    # @param relation [ActiveRecord::Relation, String] active record relation or raw sql query
+    # @param prefix [String] prefix to append before each key "prefix#<key>"
+    # @return [Array] parsed_result - array of flatten hashes representing EXPLAIN result for each row
+    def detailed_explain(relation, prefix = "detailed")
+      query = load_query(relation)
+      explain_result = ActiveRecord::Base.connection.execute("EXPLAIN format=json #{query}")
+      explain_result = parse_detailed_explain(explain_result)
+
+      explain_result.map { |ele| [ele.dig("table_name"), Helper.flatten_hash(ele, prefix)] }.to_h
+    end
+
+    class << self
+      private
+
+      def load_query(relation)
+        relation.class.name == "ActiveRecord::Relation" ? relation.to_sql : relation
+      end
+
+      def parse_detailed_explain(explain_result)
+        parsed_result = JSON.parse(explain_result&.first&.first || "{}").dig("query_block")
+        return parsed_result.dig("nested_loop").map { |e| e.dig("table") } if parsed_result.key?("nested_loop")
+
+        parsed_result.key?("table") ? [parsed_result.dig("table")] : []
+      end
+    end
+
+    module_function :full_explain, :explain, :detailed_explain
+  end
+end

data/lib/query_rule_engine/helper.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module QueryRuleEngine
+  # This module define helper methods for query rule engine
+  module Helper
+    def flatten_hash(hash, prefix_key = "")
+      flat_hash = {}
+
+      hash.each do |key, value|
+        key = prefix_key.present? ? "#{prefix_key}##{key}" : key.to_s
+
+        flat_hash.merge!(value.is_a?(Hash) ? flatten_hash(value, key) : { key => value })
+      end
+
+      flat_hash
+    end
+
+    def logger(message, type="info")
+      if defined?(Rails) && Rails.logger
+        Rails.logger.send(type, message)
+      else
+        puts "#{type.upcase}: #{message}"
+      end
+    end
+
+    def load_config(rules_path)
+      unless File.exists?(rules_path)
+        raise Error.new(
+          "Failed to load the rule file from '#{rules_path}'. " \
+          "The file may be missing or there is a problem with the path. " \
+          "Please ensure that the file exists and the path is correct."
+        )
+      end
+
+      rules_config = JSON.parse(File.read(rules_path))
+
+      rules_config
+    end
+
+    module_function :flatten_hash, :logger, :load_config
+  end
+
+  private_constant :Helper
+end

data/lib/query_rule_engine/rules.json

@@ -0,0 +1,171 @@
+{
+  "select_type": {
+    "description": "Type of select used in the table.",
+    "value_type": "string",
+    "rules": {
+      "SIMPLE": {
+        "impact": "positive",
+        "message": "A simple query without subqueries or unions.",
+        "suggestion": ""
+      }
+    }
+  },
+  "type": {
+    "description": "Join used in the query for a specific table.",
+    "value_type": "string",
+    "rules": {
+      "system": {
+        "impact": "positive",
+        "message": "Table has zero or one row, no change required.",
+        "suggestion": ""
+      },
+      "const": {
+        "impact": "positive",
+        "message": "Table has only one indexed matching row, fastest join type.",
+        "suggestion": ""
+      },
+      "eq_ref": {
+        "impact": "positive",
+        "message": "All index parts used in join and index is primary_key or unique not null.",
+        "suggestion": ""
+      },
+      "ref": {
+        "impact": "caution",
+        "message": "All matching rows of an indexed column read for each combination of rows from previous table.",
+        "suggestion": "Ensure the referenced column is indexed and look for null values, dupilcates. Upgrade to eq_ref join type if possible.\nYou can acheive eq_ref by adding unique and not null to the index - $key used in $table table table."
+      },
+      "fulltext": {
+        "impact": "caution",
+        "message": "Join uses table FULLTEXT index, index key used - $key.",
+        "suggestion": "Should only be used for text heavy columns."
+      },
+      "ref_or_null": {
+        "impact": "caution",
+        "message": "Using ref index with Null value in $table table.",
+        "suggestion": "Please check if you can upgrade to eq_ref, you can acheive eq_ref by adding unique and not null to the index - $key used in $table table."
+      },
+      "index_merge": {
+        "impact": "caution",
+        "message": "Join uses list of indexes, keys used: $key.",
+        "suggestion": "Slow if the indexes are not well-chosen or if there are too many indexes being used."
+      },
+      "range": {
+        "impact": "caution",
+        "message": "Index used to find matching rows in specific range.",
+        "suggestion": "Please check the range it should not be too broad."
+      },
+      "index": {
+        "impact": "caution",
+        "message": "Entire index tree scanned to find matching rows.",
+        "suggestion": "Can be slow for large indexes(Your key length: $key_len), use carefully."
+      },
+      "ALL": {
+        "impact": "negative",
+        "message": "Entire $table table is scanned to find matching rows, you have $amount_possible_keys possible keys to use.",
+        "suggestion": "Use index here. You can use index from possible key: $possible_keys or add new one to $table table as per the requirements."
+      }
+    }
+  },
+  "rows": {
+    "description": "Estimated number of rows scanned to find matching rows.",
+    "value_type": "number",
+    "rules": {
+      "threshold": {
+        "amount": 100,
+        "impact": "negative",
+        "message": "$value rows are being scanned per join for $table table.",
+        "suggestion": "Please see if it is possible to use index from $possible_keys or add new one to $table table as per the requirements to reduce the number of rows scanned."
+      }
+    }
+  },
+  "possible_keys": {
+    "description": "Index keys possible for a specifc table",
+    "value_type": "array",
+    "delimiter": ",",
+    "rules": {
+      "absent": {
+        "impact": "negative",
+        "message": "There are no possible keys for $table table to be used, can result into full scan",
+        "suggestion": "Please add index keys for $table table"
+      },
+      "threshold": {
+        "amount": 5,
+        "impact": "negative",
+        "message": "There are $amount possible keys for $table table, having too many index keys can be unoptimal",
+        "suggestion": "Please check if there are extra indexes in $table table."
+      }
+    }
+  },
+  "key": {
+    "description": "",
+    "value_type": "string",
+    "rules": {
+      "absent": {
+        "impact": "negative",
+        "message": "There is no index key used for $table table, and can result into full scan of the $table table",
+        "suggestion": "Please use index from possible_keys: $possible_keys or add new one to $table table as per the requirements."
+      }
+    }
+  },
+  "key_len": {
+    "description": "Length of the key index used",
+    "value_type": "number",
+    "rules": {}
+  },
+  "filtered": {
+    "description": "Indicates percentage of rows appearing from the total.",
+    "value_type": "number",
+    "rules": {}
+  },
+  "extra": {
+    "description": "Additional information about the plan",
+    "value_type": "array",
+    "delimiter": ";",
+    "rules": {
+      "Using temporary": {
+        "impact": "",
+        "message": "",
+        "suggestion": ""
+      },
+      "Using filesort": {
+        "impact": "negative",
+        "message": "A file-based algorithm in being applied over your result, This can be inefficient and result into long query time.",
+        "suggestion": "Please ensure either result set is small or use proper index."
+      },
+      "Using join buffer": {
+        "impact": "",
+        "message": "",
+        "suggestion": ""
+      },
+      "Using index condition": {
+        "impact": "",
+        "message": "",
+        "suggestion": ""
+      }
+    }
+  },
+  "detailed#used_columns": {
+    "description": "",
+    "value_type": "array",
+    "rules": {
+      "threshold": {
+        "amount": 7,
+        "impact": "negative",
+        "message": "You have selected $amount columns, You should not select too many columns.",
+        "suggestion": "Please only select required columns."
+      }
+    }
+  },
+  "cardinality": {
+    "description": "",
+    "value_type": "number",
+    "rules": {
+      "threshold": {
+        "amount": 100,
+        "impact": "negative",
+        "message": "The cardinality of table is $amount, and its too high.",
+        "suggestion": "Please use proper index, query only requried data and ensure you are using proper joins."
+      }
+    }
+  }
+}

data/lib/query_rule_engine/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module QueryRuleEngine
+  VERSION = "0.1.0.beta"
+end

data/lib/query_rule_engine.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "active_support/notifications"
+require "active_support/core_ext"
+require "json"
+require "forwardable"
+
+require_relative "query_rule_engine/analysis"
+require_relative "query_rule_engine/constants"
+require_relative "query_rule_engine/config"
+require_relative "query_rule_engine/explain"
+require_relative "query_rule_engine/helper"
+require_relative "query_rule_engine/version"
+
+# This module provides tools to analyse your queries based on custom rules
+module QueryRuleEngine
+  extend Forwardable
+
+  class Error < StandardError; end
+
+  @config = Config.new(
+    Constants::DEFAULT_DETAILED, Constants::DEFAULT_RULES_PATH
+  )
+
+  CONFIG_METHODS = %i[
+    detailed detailed? detailed= rules_path rules_path=
+  ].freeze
+
+  def_delegators :config, *CONFIG_METHODS
+
+  # to create analysis for ActiveRecord::Relation or a query string
+  # @param relation [ActiveRecord::Relation, String]
+  # @return [QueryRuleEngine::Analysis] analysis - contains the analysis of the query
+  def analyse(relation)
+    rules_config = Helper.load_config(config.rules_path)
+    analysis = Analysis.new
+    summary = {}
+
+    query_plan = Explain.full_explain(relation, config.detailed?)
+
+    query_plan.each do |table|
+      table_analysis, summary = analyse_table(table, summary, rules_config)
+
+      analysis.register_table(table.dig("table"), table_analysis)
+    end
+
+    analysis.register_summary(generate_summary_analysis(rules_config, summary))
+
+    analysis
+  end
+
+  # to add a logger to print analysis after each query
+  # @param silent [Boolean] silent errors for logger
+  # @param logger_config [Hash] possible options [positive: <boolean>, negative: <boolean>, caution: <boolean>]
+  def subscribe_logger(silent: false, logger_config: Constants::DEFAULT_LOGGER_CONFIG)
+    ActiveSupport::Notifications.subscribe("sql.active_record") do |_, _, _, _, payload|
+      begin
+        if !payload[:exception].present? && payload[:name] =~ /.* Load/
+          analysis = analyse(payload[:sql])
+          
+          Helper.logger(analysis.pretty_analysis(logger_config))
+        end
+      rescue => error
+        if silent.present?
+          Helper.logger("#{error.class}: #{error.message}", "error")
+        else
+          raise error
+        end
+      end
+    end
+  end
+
+  class << self
+    attr_accessor :config
+
+    private
+
+    def add_summary(summary, column_name, value)
+      summary["cardinality"] = (summary.dig("cardinality") || 1) + value.to_f if column_name.eql?("rows")
+
+      summary
+    end
+
+    def analyse_table(table, summary, rules_config)
+      table_analysis = {}
+
+      table.each do |column, value|
+        summary = add_summary(summary, column, value)
+        next unless rules_config.dig(column).present?
+
+        table_analysis.merge!({ column => apply_rules(rules_config.dig(column), value) })
+      end
+
+      [table_analysis, summary]
+    end
+
+    def apply_rules(column_rules, value)
+      column_rules = Constants::DEFAULT_COLUMN_RULES.merge(column_rules)
+      value = transform_value(value, column_rules)
+      amount = transform_amount(value, column_rules)
+
+      column_analyse = { "value" => value, "amount" => amount, "tags" => {} }
+
+      [*value].each do |tag|
+        tag_rule = column_rules.dig("rules", tag)
+        next unless tag_rule.present?
+
+        column_analyse["tags"].merge!({ tag => transform_tag_rule(tag_rule) })
+      end
+
+      column_analyse["tags"].merge!(apply_threshold_rule(column_rules, amount))
+
+      column_analyse
+    end
+
+    def apply_threshold_rule(column_rules, amount)
+      threshold_rule = column_rules.dig("rules", "threshold")
+
+      if threshold_rule.present? && amount >= threshold_rule.dig("amount")
+        return {
+          "threshold" => transform_tag_rule(threshold_rule).merge(
+            { "amount" => amount }
+          )
+        }
+      end
+
+      {}
+    end
+
+    def generate_summary_analysis(rules_config, summary)
+      summary_analysis = {}
+
+      summary.each do |column, value|
+        next unless rules_config.dig(column).present?
+
+        summary_analysis.merge!({ column => apply_rules(rules_config.dig(column), value) })
+      end
+
+      summary_analysis
+    end
+
+    def transform_amount(value, column_rules)
+      column_rules.dig("value_type").eql?("number") ? value.to_f : value.size
+    end
+
+    def transform_tag_rule(tag_rule)
+      tag_rule.slice("impact", "suggestion", "message")
+    end
+
+    def transform_value(value, column_rules)
+      value ||= "absent"
+
+      if column_rules.dig("value_type").eql?("array") && column_rules.dig("delimiter").present?
+        value = value.split(column_rules.dig("delimiter")).map(&:strip)
+      end
+
+      value
+    end
+  end
+
+  module_function :analyse, :subscribe_logger, *CONFIG_METHODS
+end

data/query_rule_engine.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+
+require_relative "lib/query_rule_engine/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "query_rule_engine"
+  spec.version       = QueryRuleEngine::VERSION
+  spec.authors       = ["strikeraryu"]
+  spec.email         = ["striker.aryu56@gmail.com"]
+
+  spec.summary       = "This gem provides tools to analyze your queries based on custom rules."
+  spec.homepage      = "https://github.com/strikeraryu/query_rule_engine.git"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_rubygems_version = Gem::Requirement.new(">= 3.2.3")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/strikeraryu/query_rule_engine.git"
+  spec.metadata["changelog_uri"] = "https://github.com/strikeraryu/tree/master/CHANGELOG.md"
+
+  # 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_runtime_dependency "activesupport", ">= 3.0.0", "< 6.0.0"
+  spec.add_runtime_dependency "activerecord", ">= 3.0.0", "< 6.0.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: query_rule_engine
+version: !ruby/object:Gem::Version
+  version: 0.1.0.beta
+platform: ruby
+authors:
+- strikeraryu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+description: 
+email:
+- striker.aryu56@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/query_rule_engine.rb
+- lib/query_rule_engine/analysis.rb
+- lib/query_rule_engine/analysis/dynamic_message.rb
+- lib/query_rule_engine/config.rb
+- lib/query_rule_engine/constants.rb
+- lib/query_rule_engine/explain.rb
+- lib/query_rule_engine/helper.rb
+- lib/query_rule_engine/rules.json
+- lib/query_rule_engine/version.rb
+- query_rule_engine.gemspec
+homepage: https://github.com/strikeraryu/query_rule_engine.git
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/strikeraryu/query_rule_engine.git
+  source_code_uri: https://github.com/strikeraryu/query_rule_engine.git
+  changelog_uri: https://github.com/strikeraryu/tree/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.3
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: This gem provides tools to analyze your queries based on custom rules.
+test_files: []