pg_canary 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d97dd5cbefd1e0f736b3800993118237cb01c427e55d7c9dbc44a4296d63627
-  data.tar.gz: 1ebaec08d05be5f91fd6275b0236a4b5b6fbd53d826bfd319789cf8ee727f22d
+  metadata.gz: 3117b64abbdaf73701f98780b6dd794822d6bf19919365e3a7c4ffffa62b69a5
+  data.tar.gz: c1c73a9c77af75bdcbc7bd3b3685654387728986a5d1d7a880c69c7263dc4ca6
 SHA512:
-  metadata.gz: 539edfe1fe783b0d4619d331e527447054ffd44affc964c514fb6d09005c2f8ffc8b48478816ad1ca088a8ef53b0827165b4895892d50d2222b7f207e46fe29e
-  data.tar.gz: 3bae6b432546feb624e0f898f4d8a23e1a3050a25f47e20bbfff89a81e34bd3c4b37acc65fbeb9574fa35e40fd48aab6f23f9d4fa7d99e9593079054149720e6
+  metadata.gz: 17df21da5a3d3a6f221db4aa087d4627fac79de5e8a9d4c7cd96c77849df96a47a63ea4d681a9404bd0b52274cbf7424e926cb7a84769532b8e7b81dd0daa089
+  data.tar.gz: '08302281e57605688fd0eaded8f1a2d031ebae2b5e9499d67c564aecd81e420de5d8f015b495e3a5153297e0e3113366874fe13563c78eb403db7bd3a3eb40c5'

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [0.2.0] - 2026-07-18
+
+- Remove `config.table_size_hints` / `config.size_rule_threshold`. Tier 2 rules are already opt-in per rule; use `config.ignore_tables` to exclude small tables.
+
 ## [0.1.0] - 2026-07-14
 
 Initial release.

data/README.md

@@ -62,10 +62,7 @@ config.rules.query_complexity.max_joins = 12
 config.rules.select_star_with_heavy_columns.heavy_types = %w[bytea jsonb]
 ```
 
-Once opted in, you can keep false positives down two ways:
-
-1. List small tables in `config.ignore_tables`
-2. Provide approximate production row counts in `config.table_size_hints` — when hints are present, Tier 2 rules apply **only** to tables hinted at `size_rule_threshold` (default 10,000) or above. When hints are empty, Tier 2 rules apply to every table — which is precisely why they are off by default.
+Once opted in, keep false positives down by listing small tables in `config.ignore_tables`.
 
 ## Configuration
 
@@ -82,10 +79,6 @@ PgCanary.configure do |config|
 
   # Excluding tables
   config.ignore_tables = %w[prefectures plans schema_migrations ar_internal_metadata]
-
-  # For size-dependent (Tier 2) rules: approximate production row counts
-  config.table_size_hints = { "users" => 1_000_000, "orders" => 10_000_000 }
-  config.size_rule_threshold = 10_000  # apply Tier 2 rules only to tables hinted at or above this
 end
 ```
 

data/lib/pg_canary/configuration.rb

@@ -1,14 +1,13 @@
 # frozen_string_literal: true
 
 module PgCanary
-  # Global settings, exposed through PgCanary.configure.
   class Configuration
     # nil means "not explicitly configured" — the Railtie then enables
     # pg_canary in development/test only.
     attr_accessor :enabled
 
     # False-positive controls
-    attr_accessor :ignore_tables, :table_size_hints, :size_rule_threshold
+    attr_accessor :ignore_tables
 
     attr_accessor :logger, :app_root
     attr_reader :rules
@@ -16,8 +15,6 @@ module PgCanary
     def initialize
       @enabled = nil
       @ignore_tables = %w[schema_migrations ar_internal_metadata]
-      @table_size_hints = {}
-      @size_rule_threshold = 10_000
       @rules = RulesConfig.new
       @logger = nil
       @app_root = nil
@@ -26,16 +23,6 @@ module PgCanary
     def ignore_table?(table)
       table && ignore_tables.map(&:to_s).include?(table.to_s)
     end
-
-    # Whether a size-dependent (Tier 2) rule should look at this table.
-    # With no hints configured, every table qualifies (which is exactly why
-    # Tier 2 rules are opt-in).
-    def size_hint_allows?(table)
-      hints = table_size_hints || {}
-      return true if hints.empty?
-
-      hints[table.to_s].to_i >= size_rule_threshold
-    end
   end
 
   # Exposes one RuleConfig per built-in rule, both as methods and via [].

data/lib/pg_canary/rules/base.rb

@@ -42,23 +42,14 @@ module PgCanary
         raise NotImplementedError, "#{self.class} must declare #default_enabled (true for Tier 1, false for Tier 2)"
       end
 
-      def size_dependent?
-        raise NotImplementedError, "#{self.class} must declare #size_dependent?"
-      end
-
       private
 
       def rule_config(query)
         query.config.rules[self.class.rule_name]
       end
 
-      # Tier 2 gate: with size hints configured, only tables hinted as large
-      # are checked.
       def applicable_table?(query, table)
-        return false if query.config.ignore_table?(table)
-        return true unless size_dependent?
-
-        query.config.size_hint_allows?(table)
+        !query.config.ignore_table?(table)
       end
 
       def detection(query, message:, suggestion: nil, table: nil, columns: nil)

data/lib/pg_canary/rules/definitions/array_search_without_gin.rb

@@ -11,10 +11,6 @@ module PgCanary
         true
       end
 
-      def size_dependent?
-        false
-      end
-
       ARRAY_OPS = %w[@> <@ &&].freeze
 
       def check(query)

data/lib/pg_canary/rules/definitions/cartesian_join.rb

@@ -10,10 +10,6 @@ module PgCanary
         true
       end
 
-      def size_dependent?
-        false
-      end
-
       def check(query)
         detections = []
         query.each_scope do |scope|

data/lib/pg_canary/rules/definitions/correlated_subquery_in_select.rb

@@ -9,10 +9,6 @@ module PgCanary
         true
       end
 
-      def size_dependent?
-        false
-      end
-
       def check(query)
         detections = []
         query.each_scope do |scope|

data/lib/pg_canary/rules/definitions/count_star_without_where.rb

@@ -9,10 +9,6 @@ module PgCanary
         false
       end
 
-      def size_dependent?
-        true
-      end
-
       def check(query)
         detections = []
         query.each_scope do |scope|

data/lib/pg_canary/rules/definitions/deep_offset.rb

@@ -11,10 +11,6 @@ module PgCanary
         true
       end
 
-      def size_dependent?
-        false
-      end
-
       def self.options
         { threshold: 1000 }
       end

data/lib/pg_canary/rules/definitions/distinct_with_join.rb

@@ -11,10 +11,6 @@ module PgCanary
         false
       end
 
-      def size_dependent?
-        false
-      end
-
       def check(query)
         detections = []
         query.each_scope do |scope|

data/lib/pg_canary/rules/definitions/function_on_column.rb

@@ -11,10 +11,6 @@ module PgCanary
         true
       end
 
-      def size_dependent?
-        false
-      end
-
       CHECKED_KINDS = %i[AEXPR_OP AEXPR_LIKE AEXPR_ILIKE AEXPR_IN AEXPR_BETWEEN].freeze
 
       def check(query)

data/lib/pg_canary/rules/definitions/huge_in_list.rb

@@ -12,10 +12,6 @@ module PgCanary
         true
       end
 
-      def size_dependent?
-        false
-      end
-
       def self.options
         { threshold: 500 }
       end

data/lib/pg_canary/rules/definitions/implicit_cast.rb

@@ -10,10 +10,6 @@ module PgCanary
         true
       end
 
-      def size_dependent?
-        false
-      end
-
       INTEGER_TYPES = %w[smallint integer bigint].freeze
       NUMERIC_TYPE_NAMES = %w[numeric decimal float4 float8].freeze
 

data/lib/pg_canary/rules/definitions/jsonb_search_without_gin.rb

@@ -14,10 +14,6 @@ module PgCanary
         true
       end
 
-      def size_dependent?
-        false
-      end
-
       CONTAINMENT_OPS = %w[@> <@ ? ?| ?&].freeze
       EXTRACTION_OPS = %w[-> ->> #> #>>].freeze
 

data/lib/pg_canary/rules/definitions/leading_wildcard_like.rb

@@ -13,10 +13,6 @@ module PgCanary
         true
       end
 
-      def size_dependent?
-        false
-      end
-
       LIKE_KINDS = %i[AEXPR_LIKE AEXPR_ILIKE].freeze
 
       def check(query)

data/lib/pg_canary/rules/definitions/not_in_subquery.rb

@@ -10,10 +10,6 @@ module PgCanary
         true
       end
 
-      def size_dependent?
-        false
-      end
-
       def check(query)
         detections = []
         query.each_scope do |scope|

data/lib/pg_canary/rules/definitions/or_across_columns.rb

@@ -10,10 +10,6 @@ module PgCanary
         false
       end
 
-      def size_dependent?
-        true
-      end
-
       def check(query)
         detections = []
         query.each_scope do |scope|

data/lib/pg_canary/rules/definitions/order_by_random.rb

@@ -9,10 +9,6 @@ module PgCanary
         true
       end
 
-      def size_dependent?
-        false
-      end
-
       def check(query)
         detections = []
         query.each_scope do |scope|

data/lib/pg_canary/rules/definitions/query_complexity.rb

@@ -11,10 +11,6 @@ module PgCanary
         false
       end
 
-      def size_dependent?
-        false
-      end
-
       def self.options
         { max_joins: 8, max_depth: 4 }
       end

data/lib/pg_canary/rules/definitions/regex_without_trgm.rb

@@ -12,10 +12,6 @@ module PgCanary
         true
       end
 
-      def size_dependent?
-        false
-      end
-
       REGEX_OPS = %w[~ ~* !~ !~*].freeze
 
       def check(query)

data/lib/pg_canary/rules/definitions/select_star_with_heavy_columns.rb

@@ -11,10 +11,6 @@ module PgCanary
         false
       end
 
-      def size_dependent?
-        false
-      end
-
       def self.options
         { heavy_types: %w[bytea jsonb text].freeze }
       end

data/lib/pg_canary/rules/definitions/unindexed_join.rb

@@ -12,10 +12,6 @@ module PgCanary
         false
       end
 
-      def size_dependent?
-        true
-      end
-
       def check(query)
         detections = []
         query.each_scope do |scope|

data/lib/pg_canary/rules/definitions/unindexed_order_by_with_limit.rb

@@ -4,7 +4,7 @@ module PgCanary
   module Rules
     # Tier 2 (opt-in): ORDER BY x LIMIT n without an index led by x forces a
     # full sort before the limit can apply. Size-dependent, so disabled by
-    # default and gated by config.table_size_hints.
+    # default.
     class UnindexedOrderByWithLimit < Base
       include IndexPredicates
 
@@ -12,10 +12,6 @@ module PgCanary
         false
       end
 
-      def size_dependent?
-        true
-      end
-
       def check(query)
         detections = []
         query.each_scope do |scope|

data/lib/pg_canary/rules/definitions/unindexed_where.rb

@@ -5,16 +5,12 @@ module PgCanary
     # Tier 2 (opt-in): equality/range predicates on columns with no index
     # whose leading column could serve them. Depends on production table
     # size — a 30-row lookup table is fine without indexes — hence disabled
-    # by default and gated by config.table_size_hints.
+    # by default.
     class UnindexedWhere < Base
       def default_enabled
         false
       end
 
-      def size_dependent?
-        true
-      end
-
       def check(query)
         query.each_scope.with_object([]) do |scope, detections|
           next unless scope.where_clause

data/lib/pg_canary/rules/definitions/union_instead_of_union_all.rb

@@ -11,10 +11,6 @@ module PgCanary
         false
       end
 
-      def size_dependent?
-        false
-      end
-
       def check(query)
         union = query.scopes.find { |scope| scope.stmt.op == :SETOP_UNION && !scope.stmt.all }
         return [] unless union

data/lib/pg_canary/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PgCanary
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/pg_canary.rb

@@ -56,7 +56,6 @@ module PgCanary
   end
 
   if defined?(Rails::Railtie)
-    # Middleware insertion and automatic enabling in development/test.
     class Railtie < Rails::Railtie
       initializer "pg_canary.app_root", before: :load_config_initializers do
         PgCanary.config.app_root ||= Rails.root.to_s

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg_canary
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - kyuuri1791
@@ -119,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Detects SQL anti-patterns that can become slow queries in production, while
   you develop.