order_cop 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eec6b83744b3873a01b1e5bbc3babf32c5d7a0ba76608b0aeacdd91094263eb2
-  data.tar.gz: 3c2a4a792e2670544a4cd327ee094aab10f8212a3017cb937464ee3e3cea0dec
+  metadata.gz: e9db33624c2eb202e4a077391905aff8c3d2719ba36743ef86c169a3ebb44eab
+  data.tar.gz: 499e5fa4966beccfcfe5f8dde8db48bff9f9d364bddcc2618b70240e25f76cca
 SHA512:
-  metadata.gz: f3e2281df0bbbc4ed5e17a9b2fb671b91af40c016fde050a6bb23d2969feee877b62c720255f49de9544756472692fb9df4fa8d957ff97540821263a31693d4b
-  data.tar.gz: 3247b3dc2bd877226cd03437acb5cac3bf66712d7a7bfdc5d17357a41460dcf5783e265667394c1df0055958be2c7a3bcfa18cc534127761eb20dedf59a308d3
+  metadata.gz: f883d3cd5e17aa8d612542585fe490bbcce29bfd239a039a738ebb22bcc55bf01ee07bcdd816ed650169cbc6b5c8ceeed5cb84530078c2571b8c7275bb502e66
+  data.tar.gz: 9b4a1e48a5de4e49068cb9223dbab2e224453e81a26577bc2b7877800d06a985f0012ae1cacc5800db5e8f7b58d83a0a44b33142f60f776afa503da64a4728fa

data/Gemfile

@@ -12,4 +12,5 @@ gem "rspec", "~> 3.0"
 gem "standard", "~> 1.3"
 
 gem "rails", "~> 7.0.0"
+
 gem "sqlite3"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    order_cop (0.1.0)
+    order_cop (0.2.0)
       binding_of_caller (~> 1.0)
       rails (~> 7.0)
 

data/lib/order_cop/version.rb

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

data/lib/order_cop.rb

@@ -11,6 +11,42 @@ require "zeitwerk"
 loader = Zeitwerk::Loader.for_gem
 loader.setup
 module OrderCop
+  class OrderCopConfig
+    def initialize
+      @enabled = true
+      @raise = true
+      @debug = false
+      @rails_logger = false
+      @whitelist_methods = %i[sum any? none? inspect method_missing not load_target reindex attachment attachments attributes_table with_current_arbre_element]
+    end
+    attr_accessor :enabled, :raise, :debug, :rails_logger, :whitelist_methods
+  end
+
+  def self.config(**options, &block)
+    @config ||= OrderCopConfig.new
+    options.each do |key, value|
+      @config.send("#{key}=", value)
+    end
+    yield @config if block
+    @config
+  end
+
+  def self.disable(&block)
+    old_enabled = @config.enabled
+    @config.enabled = false
+    yield
+  ensure
+    @config.enabled = old_enabled
+  end
+
+  def self.disabled?
+    !@config.enabled
+  end
+
+  def self.enabled?
+    @config.enabled
+  end
+
   module OrderCopMixin
     # patch all methods which iterate over the collection and return several records
     #  we don't patch `first` and `last`, take or others because they return a single record)
@@ -54,15 +90,29 @@ module OrderCop
 
     private
 
-    def detect_missing_order(method)
-      return if OrderCop.disabled?
-      level = 1.upto(binding.frame_count).find do |i|
+    def stack_is_whitelisted?
+      1.upto(binding.frame_count).each do |i|
         lbinding = binding.of_caller(i)
         lmethod = lbinding.eval("__method__")
         next if lmethod.nil?
-        if OrderCop::WHITELIST.include?(lmethod)
-          return nil
+        puts "lmethod: #{lmethod}" if OrderCop.config.debug
+        if OrderCop.config.whitelist_methods.include?(lmethod)
+          puts "#{lmethod} is whitelisted, ignoring" if OrderCop.config.debug
+          return true
         end
+      end
+      false
+    end
+
+    def detect_missing_order(method)
+      return if OrderCop.disabled?
+      puts "missing order, detect if allowed" if OrderCop.config.debug
+      puts "stack size: #{binding.frame_count}" if OrderCop.config.debug
+
+      return if stack_is_whitelisted?
+
+      level = 1.upto(binding.frame_count).find do |i|
+        lbinding = binding.of_caller(i)
         location = lbinding.source_location[0]
         location.include?(Rails.root.to_s) && !location.include?(Rails.root.join("config").to_s)
       end
@@ -76,42 +126,22 @@ module OrderCop
         msg = "Missing Order for :#{method}"
       end
 
-      if OrderCop.rails_logger?
-        Rails.logger.error order_cop_red("Missing order for #{method}")
+      red = ->(msg) { ActiveSupport::LogSubscriber.new.send(:color, msg, :red) }
+
+      if OrderCop.config.rails_logger
+        Rails.logger.error red.call(msg)
         caller.each do |line|
-          Rails.logger.error order_cop_red("  #{line}") if line.include?(Rails.root.to_s)
+          Rails.logger.error red.call("  #{line}") if line.include?(Rails.root.to_s)
         end
       end
-      if OrderCop.raise?
+      if OrderCop.config.raise
         raise OrderCop::Error.new(msg)
       end
     end
-
-    def order_cop_red(msg)
-      ActiveSupport::LogSubscriber.new.send(:color, msg, :red)
-    end
   end
 
   class Error < StandardError; end
 
-  WHITELIST = %i[sum any? none? inspect method_missing not load_target reindex attachment attachments attributes_table with_current_arbre_element].freeze
-
-  def self.disable(&block)
-    old_enabled = @enabled
-    @enabled = false
-    yield
-  ensure
-    @enabled = old_enabled
-  end
-
-  def self.disabled?
-    @enabled == false
-  end
-
-  def self.enabled?
-    @enabled != false
-  end
-
   def self.patch_active_record(app)
     ActiveRecord::Base.descendants.each do |model|
       model.const_get(:ActiveRecord_Associations_CollectionProxy).class_eval do
@@ -126,27 +156,6 @@ module OrderCop
     end
   end
 
-  def self.rails_logger?
-    config.rails_logger
-  end
-
-  def self.raise?
-    config.raise
-  end
-
-  def self.config(**options)
-    @config ||= OpenStruct.new(rails_logger: false, raise: true, enabled: true)
-    options.each do |k, v|
-      @config[k] = v
-    end
-    @enabled = @config.enabled
-    @config
-  end
-
-  def self.setup(**options)
-    config(**options)
-  end
-
   def self.apply(app = Rails.application)
     patch_active_record(app) if enabled?
   end
@@ -169,4 +178,3 @@ end
 ActiveSupport::Reloader.to_prepare do
   OrderCop.apply(Rails.application)
 end
-# OrderCop.setup(rails_logger: true) unless Rails.env.production?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: order_cop
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Gauthier Monserand
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-16 00:00:00.000000000 Z
+date: 2023-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails