order_cop 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 83506d77c88c7d0fb5f3b5b0b779bdb33262adb7645951127fd2feb1668db52f
+  data.tar.gz: ee2e8013a24a8078e87455a2aa88e98aae921137a870d9c3d29bdb1dbc067a76
+SHA512:
+  metadata.gz: 40dc1ee7a51ded6c68b4c44e68d0ce96c5a97f53ce95de5f68fb8651aab44c357f72564de56b623b853bba01867a8faf9dc7221c830a70ed5f961a1e61865a28
+  data.tar.gz: 11eb778fdc25c1bbc1e164ec27a1c2738a2d3541d49b7c53a0a5e5ca8a13f06e07a298332a859080787eb0351281b2bb999b756532dde3aa4ac330bccf4a48b1

data/.rspec

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

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in order_cop.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "standard", "~> 1.3"
+
+gem "rails", "~> 7.0.0"
+gem "sqlite3"

data/Gemfile.lock

@@ -0,0 +1,221 @@
+PATH
+  remote: .
+  specs:
+    order_cop (0.1.0)
+      binding_of_caller (~> 1.0)
+      rails (~> 7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.0.7)
+      actionpack (= 7.0.7)
+      activesupport (= 7.0.7)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (7.0.7)
+      actionpack (= 7.0.7)
+      activejob (= 7.0.7)
+      activerecord (= 7.0.7)
+      activestorage (= 7.0.7)
+      activesupport (= 7.0.7)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.7)
+      actionpack (= 7.0.7)
+      actionview (= 7.0.7)
+      activejob (= 7.0.7)
+      activesupport (= 7.0.7)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.0)
+    actionpack (7.0.7)
+      actionview (= 7.0.7)
+      activesupport (= 7.0.7)
+      rack (~> 2.0, >= 2.2.4)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (7.0.7)
+      actionpack (= 7.0.7)
+      activerecord (= 7.0.7)
+      activestorage (= 7.0.7)
+      activesupport (= 7.0.7)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.0.7)
+      activesupport (= 7.0.7)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (7.0.7)
+      activesupport (= 7.0.7)
+      globalid (>= 0.3.6)
+    activemodel (7.0.7)
+      activesupport (= 7.0.7)
+    activerecord (7.0.7)
+      activemodel (= 7.0.7)
+      activesupport (= 7.0.7)
+    activestorage (7.0.7)
+      actionpack (= 7.0.7)
+      activejob (= 7.0.7)
+      activerecord (= 7.0.7)
+      activesupport (= 7.0.7)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    binding_of_caller (1.0.0)
+      debug_inspector (>= 0.0.1)
+    builder (3.2.4)
+    concurrent-ruby (1.2.2)
+    crass (1.0.6)
+    date (3.3.3)
+    debug_inspector (1.1.0)
+    diff-lcs (1.5.0)
+    erubi (1.12.0)
+    globalid (1.1.0)
+      activesupport (>= 5.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    loofah (2.21.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.5)
+    minitest (5.19.0)
+    net-imap (0.3.7)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.1)
+      timeout
+    net-smtp (0.3.3)
+      net-protocol
+    nio4r (2.5.9)
+    nokogiri (1.15.4-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rack (2.2.8)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails (7.0.7)
+      actioncable (= 7.0.7)
+      actionmailbox (= 7.0.7)
+      actionmailer (= 7.0.7)
+      actionpack (= 7.0.7)
+      actiontext (= 7.0.7)
+      actionview (= 7.0.7)
+      activejob (= 7.0.7)
+      activemodel (= 7.0.7)
+      activerecord (= 7.0.7)
+      activestorage (= 7.0.7)
+      activesupport (= 7.0.7)
+      bundler (>= 1.15.0)
+      railties (= 7.0.7)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.0.7)
+      actionpack (= 7.0.7)
+      activesupport (= 7.0.7)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.52.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.18.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    sqlite3 (1.6.3-x86_64-linux)
+    standard (1.30.1)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.52.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.1.0)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.1.2)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.18.0)
+    thor (1.2.2)
+    timeout (0.4.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.11)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  order_cop!
+  rails (~> 7.0.0)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  sqlite3
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.4.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Gauthier Monserand
+
+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,35 @@
+# OrderCop
+
+TODO: Delete this and the text below, and describe your gem
+
+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/order_cop`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## 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]/order_cop.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/order_cop/version.rb

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

data/lib/order_cop.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+require_relative "order_cop/version"
+require "active_record"
+require "active_support"
+require "rails"
+require "ostruct"
+require "binding_of_caller"
+
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+module OrderCop
+  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)
+    #  we don't patch sort because it specifically doesn't need an order
+    #  we don't patch select as it's a query method
+
+    def each(...)
+      detect_missing_order(:each) if order_values.empty?
+      super(...)
+    end
+
+    def to_a
+      detect_missing_order(:to_a) if order_values.empty?
+      super
+    end
+
+    def map(...)
+      detect_missing_order(:map) if order_values.empty?
+      super(...)
+    end
+
+    def find_each(...)
+      detect_missing_order(:find_each) if order_values.empty?
+      super(...)
+    end
+
+    def find_in_batches(...)
+      detect_missing_order(:find_in_batches) if order_values.empty?
+      super(...)
+    end
+
+    def reject(...)
+      detect_missing_order(:reject) if order_values.empty?
+      super(...)
+    end
+
+    def reject!(&block)
+      detect_missing_order(:reject!) if order_values.empty?
+      super(&block)
+    end
+
+    private
+
+    def detect_missing_order(method)
+      return if OrderCop.disabled?
+      level = 1.upto(binding.frame_count).find do |i|
+        lbinding = binding.of_caller(i)
+        lmethod = lbinding.eval("__method__")
+        next if lmethod.nil?
+        if OrderCop::WHITELIST.include?(lmethod)
+          puts "whitelisted #{lmethod}"
+          return nil
+        end
+        location = lbinding.source_location[0]
+        location.include?(Rails.root.to_s) && !location.include?(Rails.root.join("config").to_s)
+      end
+
+      if level
+        location = binding.of_caller(level - 1).source_location
+        file_path = location.first.gsub(Rails.root.to_s, "")
+        line_number = location.last
+        msg = "Missing Order for :#{method} at #{file_path}:#{line_number}"
+      else
+        msg = "Missing Order for :#{method}"
+      end
+
+      if OrderCop.rails_logger?
+        Rails.logger.error order_cop_red("Missing order for #{method}")
+        caller.each do |line|
+          Rails.logger.error order_cop_red("  #{line}") if line.include?(Rails.root.to_s)
+        end
+      end
+      if OrderCop.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
+        prepend OrderCopMixin
+      end
+      model.const_get(:ActiveRecord_Relation).class_eval do
+        prepend OrderCopMixin
+      end
+      model.const_get(:ActiveRecord_AssociationRelation).class_eval do
+        prepend OrderCopMixin
+      end
+    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
+
+  if defined?(Rails::Railtie)
+    class OrderCopRailtie < Rails::Railtie
+      initializer "ordercop.patch" do |app|
+        return if OrderCop.disabled?
+
+        app.config.to_prepare do
+          app&.eager_load!
+
+          OrderCop.apply(app)
+        end
+      end
+    end
+  end
+end
+
+ActiveSupport::Reloader.to_prepare do
+  OrderCop.apply(Rails.application)
+end
+# OrderCop.setup(rails_logger: true) unless Rails.env.production?

data/sig/order_cop.rbs

@@ -0,0 +1,4 @@
+module OrderCop
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: order_cop
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gauthier Monserand
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: binding_of_caller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Bullet-like gem to detect missing order clauses
+email:
+- gauthier@squadracer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/order_cop.rb
+- lib/order_cop/version.rb
+- sig/order_cop.rbs
+homepage: https://github.com/squadracer/order_cop
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/squadracer/order_cop
+  source_code_uri: https://github.com/squadracer/order_cop
+  changelog_uri: https://github.com/squadracer/order_cop
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Bullet-like gem to detect missing order clauses
+test_files: []