order_cop 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f04b2f958bd26504fa02f2a8c7933b34f6b2f32510c7bdd039741b968b4cf828
-  data.tar.gz: 2a5ce657241968b7fa4b3710efdd3171bab6b6f79371686985cf63afd440cfe4
+  metadata.gz: b8edfc0b999f13867cc3c91455d6054bd4ae551bad96b46035bac8942229efc7
+  data.tar.gz: cfbe8f395ff23161ae2dee5836ab8f608829c735cc47d8aacf30360b2336b546
 SHA512:
-  metadata.gz: 33bc928727bb612bc378e8627a1f768692db2186311ae13099751ce386867b5d91af8fc2c7d022c60a9670397e9f13809ffd3774dfd481e9eddeeeaffb5392bd
-  data.tar.gz: 29661cd6a332cf92870f5d7fe5b2283483a915f3ef6654159c6f56abaa492332adaefa5730ec6721463a6cb828b889cabf963989829f5047a6d98421901af95b
+  metadata.gz: d862643e34b5e836066c651ef155da4dd0dc91c21d0586346733697da9a09c47422ef20ede4b90740cce125cccdd599a2c76c0daa217c9507fbff57efd8a22fb
+  data.tar.gz: 231ce43da723ff0eb183be69e4c229bef0215c5bf9dd4292f5f44446145fa5b106dc8297c5ae0abaee1c16e3e3056c3576fa0bace94ff3722579185e526f51e9

data/Gemfile

@@ -14,3 +14,5 @@ gem "standard", "~> 1.3"
 gem "rails", "~> 7.0.0"
 
 gem "sqlite3"
+
+gem "simplecov"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    order_cop (0.2.0)
+    order_cop (0.2.3)
       binding_of_caller (~> 1.0)
       rails (~> 7.0)
 
@@ -82,6 +82,7 @@ GEM
     date (3.3.3)
     debug_inspector (1.1.0)
     diff-lcs (1.5.0)
+    docile (1.4.0)
     erubi (1.12.0)
     globalid (1.1.0)
       activesupport (>= 5.0)
@@ -183,6 +184,12 @@ GEM
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
     sqlite3 (1.6.3-x86_64-linux)
     standard (1.30.1)
       language_server-protocol (~> 3.17.0.2)
@@ -214,6 +221,7 @@ DEPENDENCIES
   rails (~> 7.0.0)
   rake (~> 13.0)
   rspec (~> 3.0)
+  simplecov
   sqlite3
   standard (~> 1.3)
 

data/lib/order_cop/install_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module OrderCop
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../../templates", __FILE__)
+    desc "Install OrderCop in your Ruby on Rails application"
+
+    def add_initializer
+      template "order_cop.rb.erb", "config/initializers/order_cop.rb"
+    end
+  end
+end

data/lib/order_cop/version.rb

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

data/lib/order_cop.rb

@@ -10,6 +10,7 @@ require "binding_of_caller"
 require "zeitwerk"
 loader = Zeitwerk::Loader.for_gem
 loader.setup
+
 module OrderCop
   class OrderCopConfig
     def initialize
@@ -18,8 +19,17 @@ module OrderCop
       @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]
+      @only_view = false
+      @view_paths = [
+        /app\/views/,
+        /app\/helpers/,
+        /\.erb/,
+        /\.haml/,
+        /\.slim/,
+        /\(erb\)/
+      ].freeze
     end
-    attr_accessor :enabled, :raise, :debug, :rails_logger, :whitelist_methods
+    attr_accessor :enabled, :raise, :debug, :rails_logger, :whitelist_methods, :only_view, :view_paths
   end
 
   def self.config(**options, &block)
@@ -104,12 +114,26 @@ module OrderCop
       false
     end
 
+    def stack_in_view?
+      1.upto(binding.frame_count).each do |i|
+        lbinding = binding.of_caller(i)
+        location = lbinding.source_location[0]
+        puts "location: #{location}" if OrderCop.config.debug
+        if OrderCop.config.view_paths.any? { location.match(_1) }
+          puts "#{location} is in view" 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?
+      return if OrderCop.config.only_view && !stack_in_view?
 
       level = 1.upto(binding.frame_count).find do |i|
         lbinding = binding.of_caller(i)
@@ -161,6 +185,8 @@ module OrderCop
   end
 
   if defined?(Rails::Railtie)
+    require_relative "order_cop/install_generator"
+
     class OrderCopRailtie < Rails::Railtie
       initializer "ordercop.patch" do |app|
         return if OrderCop.disabled?

data/lib/templates/order_cop.rb.erb

@@ -0,0 +1,21 @@
+if defined?(OrderCop)
+  OrderCop.config do |config|
+    # Enable or disable OrderCop (defaults to true)
+    # config.enabled = true
+
+    # Raise an error when a query is not ordered (defaults to true)
+    # config.raise = true
+
+    # Log missing order queries to Rails.logger (defaults to false)
+    # config.rails_logger = false
+
+    # Only raise if the query is in a view (defaults to false)
+    # config.only_view = false
+
+    # Whitelist methods that don't need to be ordered (defaults to <%= OrderCop.config.whitelist_methods %>)
+    # config.whitelist_methods = []
+
+    # Whitelist views that don't need to be ordered (defaults to <%= OrderCop.config.view_paths %>)
+    # config.view_paths = []
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: order_cop
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Gauthier Monserand
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-19 00:00:00.000000000 Z
+date: 2023-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -53,7 +53,9 @@ files:
 - README.md
 - Rakefile
 - lib/order_cop.rb
+- lib/order_cop/install_generator.rb
 - lib/order_cop/version.rb
+- lib/templates/order_cop.rb.erb
 - sig/order_cop.rbs
 homepage: https://github.com/squadracer/order_cop
 licenses: