chaotic_order 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 220de14116403b35c368efe5aaf9cb436820fddf6775022d935ccc1db0078c34
+  data.tar.gz: 68c6559a4ff1dd7eecd696990e96329e0d9697c03c3b69c07bcba0dbde98fe57
+SHA512:
+  metadata.gz: 629d7d0be79fb53b14c058c0eb5e84f20e5eb07c661f169aa205a6f84201370303eded527922c4ff05e5517a425d57aff1268c3209963775e604e2551387b1ed
+  data.tar.gz: 549e41e62010cc51c9868bff1824d17e97fdd08c5fec28f34bc29b9b522397db677a8f10df61fe37b438d17defe5eea3942e9b25a0adfd162dbd1e838c1e16f5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Santiago Bartesaghi
+
+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,53 @@
+# ChaoticOrder
+
+Chaotic Order helps you detect queries that are missing an order.
+
+Sometimes we forget to add an order to our queries, or we don't add it because we assume that by default they will be returned ordered by `id`, but that is not guaranteed by the DBMS. By forcing a randomic order to the unordered queries, we can help you detect them more easily.
+
+This gem can be useful helping detect intermittent tests that otherwise are hard to replicate.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development, :test do
+  gem 'chaotic_order'
+end
+```
+
+Note that this gem is not recommended to be used in production.
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install chaotic_order
+
+## Usage
+
+By default the gem is turned off, and there are two ways to turn it on:
+1. By setting an environment variable `CHAOTIC_ORDER=true`
+1. By calling `ChaoticOrder::Config.enable!` in a initializer
+
+In either option, make sure that you are only enabling it in development and/or test environments, depending on your needs.
+
+## 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/santib/chaotic_order. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/santib/chaotic_order/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ChaoticOrder project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/santib/chaotic_order/blob/master/CODE_OF_CONDUCT.md).

data/lib/chaotic_order/config.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ChaoticOrder
+  class Config
+    def self.enable!
+      @enabled = true
+    end
+
+    def self.disable!
+      @enabled = false
+    end
+
+    def self.enabled?
+      !!@enabled
+    end
+  end
+end

data/lib/chaotic_order/manager.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ChaoticOrder
+  class Manager
+    attr_reader :arel, :adapter_name
+
+    def initialize(arel, adapter_name)
+      @arel = arel
+      @adapter_name = adapter_name
+    end
+
+    def set_random_order
+      return unless set_random_order?
+
+      arel.order(random_for_adapter)
+    end
+
+    private
+
+    def set_random_order?
+      !order_set? && !distinct_set?
+    end
+
+    def order_set?
+      arel.orders.present?
+    end
+
+    def distinct_set?
+      arel.to_sql =~ /^SELECT DISTINCT/i
+    end
+
+    def random_for_adapter
+      if adapter_name =~ /mysql/i
+        "RAND()"
+      else
+        "RANDOM()"
+      end
+    end
+  end
+end

data/lib/chaotic_order/railtie.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ChaoticOrder
+  class Railtie < Rails::Railtie
+    config.to_prepare do
+      if ChaoticOrder::Config.enabled? || ENV["CHAOTIC_ORDER"] == "true"
+        ::ActiveRecord::Relation.prepend(
+          Module.new do
+            def exec_queries(*)
+              ChaoticOrder::Manager.new(arel, connection.adapter_name).set_random_order
+              super
+            end
+          end
+        )
+      end
+    end
+  end
+end

data/lib/chaotic_order/version.rb

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

data/lib/chaotic_order.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "rails"
+require_relative "chaotic_order/config"
+require_relative "chaotic_order/manager"
+require_relative "chaotic_order/railtie"
+require_relative "chaotic_order/version"
+
+module ChaoticOrder
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: chaotic_order
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Santiago Bartesaghi
+- Martin Jaime
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description:
+email:
+- santib@hey.com
+- martinmoron7@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/chaotic_order.rb
+- lib/chaotic_order/config.rb
+- lib/chaotic_order/manager.rb
+- lib/chaotic_order/railtie.rb
+- lib/chaotic_order/version.rb
+homepage: https://github.com/santib/chaotic_order
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/santib/chaotic_order
+  source_code_uri: https://github.com/santib/chaotic_order
+  bug_tracker_uri: https://github.com/santib/chaotic_order/issues
+  changelog_uri: https://github.com/santib/chaotic_order/releases
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Add random order to queries that do not have a specific order
+test_files: []