query_police 0.1.0.beta → 0.1.2.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89db06f142d97fcf351d3c2bdadb121a66a4684e9570293ebe15655cb2cbd62d
-  data.tar.gz: d5d235f590005a175512b9b807afb606634ab28635c4b466220f537e981567d2
+  metadata.gz: b3ba602c5b4a73be62b2660559a20d3314acbe30215cdb501163d4ced4851112
+  data.tar.gz: defbfd46a5b7702205e0a3acd7c426374eea75ceb477e8e403972ef8519fb9e8
 SHA512:
-  metadata.gz: 9ebdfdcdf9fd986143cab1e481a38260294b7588530a2ce79b6e5066651fc0c38dff8d7c3caf445789da9c5d115e75eab5bb4a136ece64647006687b8ecb0e70
-  data.tar.gz: f98f685595b74e8e0c45a0308f9f933ecd647de4268a6505184fed24649497d9aee3e0636269347f78ca15bf4d6b32fb56b0149b2653243c048f4be49163c252
+  metadata.gz: 06dde4464e7020f9bfb187980f77463b96e7b18d25dacfaf6b58f42cfe538d49ad27e49e62a3294b1b8f312e573d8b252a8c7163c83a0f7ee21c59fd95ee2888
+  data.tar.gz: 94950f4b507c314b9cd2f8966516826034028a02d38e089a506067f4466f8273031c94b41c6c998299ca24c5315f061ca5315a79504d921bb7b5f1058d74ae9a

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.4.1
 
 Style/StringLiterals:
   Enabled: true
@@ -9,5 +9,11 @@ Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: double_quotes
 
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/AbcSize:
+  Max: 17
+
 Layout/LineLength:
   Max: 120

data/Gemfile

@@ -9,4 +9,4 @@ gem "rake", "~> 13.0"
 
 gem "rspec", "~> 3.0"
 
-gem "rubocop", "~> 1.12"
+gem "rubocop", "~> 0.80.0"

data/lib/query_police/analysis/dynamic_message.rb

@@ -14,7 +14,7 @@ module QueryPolice
       # @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) || ""
+        message = tables.dig(table, "analysis", column, "tags", tag, type) || ""
 
         variables = message.scan(/\$(\w+)/).uniq.map { |var| var[0] }
         variables.each do |var|
@@ -32,14 +32,14 @@ module QueryPolice
 
       def relative_value_of(var, table)
         value_type = var.match(/amount_/).present? ? "amount" : "value"
-        self.tables.dig(table, "analysis", var.gsub(/amount_/, ""), value_type)
+        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")
+        tables.dig(table, "analysis", column, "amount")
       end
 
       def column(opts)
@@ -49,7 +49,7 @@ module QueryPolice
       def impact(opts)
         table, column, tag = opts.values_at("table", "column", "tag")
 
-        impact = self.tables.dig(table, "analysis", column, "tags", tag, "impact")
+        impact = tables.dig(table, "analysis", column, "tags", tag, "impact")
 
         opts.dig("colours").present? ? impact.send(IMPACTS[impact].colour) : impact
       end
@@ -65,7 +65,7 @@ module QueryPolice
       def value(opts)
         table, column = opts.values_at("table", "column")
 
-        self.tables.dig(table, "analysis", column, "value")
+        tables.dig(table, "analysis", column, "value")
       end
     end
   end

data/lib/query_police/analysis.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'analysis/dynamic_message'
+require_relative "analysis/dynamic_message"
 
 module QueryPolice
   # This class is used to store analysis of a query and provide methods over them
@@ -49,7 +49,7 @@ module QueryPolice
       @summary = {}
     end
 
-    attr_accessor :tables, :table_count, :summary
+    attr_accessor :table_count, :tables, :summary
 
     # register a table analysis in analysis object
     # @param name [String] name of the table
@@ -71,7 +71,7 @@ module QueryPolice
     #  }
     def register_table(name, table_analysis)
       self.table_count += 1
-      self.tables.merge!(
+      tables.merge!(
         {
           name => {
             "id" => self.table_count,
@@ -90,7 +90,7 @@ module QueryPolice
 
     # 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 
+    # @return [String] pretty analysis
     def pretty_analysis(opts)
       final_message = ""
 
@@ -103,12 +103,12 @@ module QueryPolice
 
     # to get analysis in pretty format with warnings and suggestions for a impact
     # @param impact [String]
-    # @return [String] pretty analysis 
+    # @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})
+      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
@@ -119,11 +119,11 @@ module QueryPolice
     # 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 
+    # @return [String] pretty analysis
     def table_pretty_analysis(table, opts)
       table_message = ""
 
-      self.tables.dig(table, "analysis").each do |column, column_analysis|
+      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?

data/lib/query_police/constants.rb

@@ -9,6 +9,6 @@ module QueryPolice
     DEFAULT_LOGGER_CONFIG = {
       "negative" => true
     }.freeze
-    DEFAULT_RULES_PATH =  File.join(File.dirname(__FILE__), "rules.json")
+    DEFAULT_RULES_PATH = File.join(File.dirname(__FILE__), "rules.json")
   end
 end

data/lib/query_police/helper.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# QueryPolice::Helper
 module QueryPolice
   # This module define helper methods for query police
   module Helper
@@ -15,7 +16,7 @@ module QueryPolice
       flat_hash
     end
 
-    def logger(message, type="info")
+    def logger(message, type = "info")
       if defined?(Rails) && Rails.logger
         Rails.logger.send(type, message)
       else
@@ -24,17 +25,13 @@ module QueryPolice
     end
 
     def load_config(rules_path)
-      unless File.exists?(rules_path)
-        raise Error.new(
-          "Failed to load the rule file from '#{rules_path}'. " \
+      unless File.exist?(rules_path)
+        raise Error, "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
+      JSON.parse(File.read(rules_path))
     end
 
     module_function :flatten_hash, :logger, :load_config

data/lib/query_police/version.rb

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

data/lib/query_police.rb

@@ -58,15 +58,13 @@ module QueryPolice
       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
+      rescue StandardError => e
+        raise e unless silent.present?
+
+        Helper.logger("#{e.class}: #{e.message}", "error")
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: query_police
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta
+  version: 0.1.2.beta
 platform: ruby
 authors:
 - strikeraryu
@@ -11,7 +11,7 @@ cert_chain: []
 date: 2023-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -31,7 +31,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 6.0.0
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -90,7 +90,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="