required_query_attributes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9983089c7aaeb16d4d63ecf5054937faaeefd2c9
+  data.tar.gz: 0b58629ae1b2a85a0f8343fc0ad1657e5ac9624c
+SHA512:
+  metadata.gz: c17fd158de571d0cf5e2ede9cc015a6adb58ff28eef54b1a7584b782a43ec398d1b9aee8508fe0b2a0588224647cd6d3a55e9acace2ebf49e77f837bab00d298
+  data.tar.gz: 392a7d28d5a63c04b19cea264625357b961f296ef1d90345dc1761e810489f5d7ff933d7552771fa763e19ee424a114fc55cc9911cbb4241163a3f48b5feecc9

data/.circleci/config.yml

@@ -0,0 +1,14 @@
+# Ruby CircleCI 2.0 configuration file
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+version: 2
+jobs:
+  build:
+    docker:
+       - image: circleci/ruby:2.4.3
+    working_directory: ~/repo
+    steps:
+      - checkout
+      - run: bundle install --jobs=4 --retry=3 --path vendor/bundle
+      - run: bundle exec bundle-audit update && bundle exec bundle-audit check
+      - run: bundle exec rubocop
+      - run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_gem:
+  ws-style:
+    - default.yml
+
+AllCops:
+  # Specify your target Ruby version here (only major/minor versions):
+  TargetRubyVersion: 2.4

data/.ruby-version

@@ -0,0 +1 @@
+2.4.3

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in required_query_attributes.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Wealthsimple
+
+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,68 @@
+# RequiredQueryAttributes [![CircleCI](https://circleci.com/gh/wealthsimple/required_query_attributes.svg?style=svg)](https://circleci.com/gh/wealthsimple/required_query_attributes)
+
+Enforce presence of specific columns in ActiveRecord queries.
+
+## Description 
+
+If you have a `records` table like this:
+
+```ruby
+create_table 'records' do |t|
+  t.date     'date'
+  t.string   'text'
+end
+```
+
+You might want to make sure that `SELECT` queries always provide a predicate condition on `date`.
+
+It could be because you have a very large table, and your only good index is on `date`.
+
+Or maybe your data is partitioned by `date`, and thus not providing it will trigger full table scan.
+
+`RequiredQueryAttributes` ensures all `SELECT` queries provide at least one predicate condition on the desired columns, or they will fail with an exception:
+
+```ruby
+RequiredQueryAttributes::RequiredAttributeMissing:
+  Required attributes ["date"] missing from query:
+    SELECT "records".* FROM "records" WHERE "records"."text" = 'string_to_find'
+```
+
+## Installation
+
+Add this line to your application's `Gemfile` and execute `bundle`:
+
+```ruby
+gem 'required_query_attributes'
+```
+
+## Usage
+
+Using the same `records` example:
+
+```ruby
+create_table 'records' do |t|
+  t.date     'date'
+  t.string   'text'
+end
+```
+
+Configure your class:
+
+```ruby
+class Record < ActiveRecord::Base
+  include RequiredQueryAttributes
+ 
+  require_query_attribute :date
+ 
+  # Add additional attributes if desired
+  # require_query_attribute :text
+end
+```
+
+Profit.
+
+## FYI
+
+This gem tries to do its job as cleanly as possible, only changing `ActiveRecord` behaviour when necessary.
+
+There are no global changes to `ActiveRecord`: only models which you choose to install `RequiredQueryAttributes` are affected.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/required_query_attributes.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'active_record'
+
+require 'required_query_attributes/model'
+require 'required_query_attributes/relation'
+require 'required_query_attributes/version'
+
+module RequiredQueryAttributes
+  def self.included(base)
+    base.send :extend, Model::ClassMethods
+  end
+end

data/lib/required_query_attributes/model.rb

@@ -0,0 +1,32 @@
+module RequiredQueryAttributes
+  # Extensions to `ActiveRecord::Base`.
+  # We want to have the smallest possible footprint here.
+  module Model
+    module ClassMethods
+      # Declare this in your model to enforce that the provided attribute
+      # must be used in at least one condition on SELECT statements.
+      #
+      # Parameters:
+      #
+      # - name - Attribute to enforce presence in queries.
+      #
+      # @api public
+      def require_query_attribute(attribute)
+        @required_query_attributes ||= []
+        @required_query_attributes << attribute.to_s
+      end
+
+      attr_reader :required_query_attributes
+
+      def self.extended(base)
+        # Attach our own RequiredQueryAttributes::Relation
+        # to existing delegate factories
+        base.instance_eval do
+          @relation_delegate_cache.values.each do |klass|
+            klass.include Relation
+          end
+        end
+      end
+    end
+  end
+end

data/lib/required_query_attributes/relation.rb

@@ -0,0 +1,29 @@
+module RequiredQueryAttributes
+  class RequiredAttributeMissing < ActiveRecord::ActiveRecordError; end
+
+  module Relation
+    extend ActiveSupport::Concern
+
+    # Intercepts calls to 'load', validating for required attributes before execution
+    def load(*)
+      required_query_attributes = @klass.required_query_attributes
+      check_required_query_attributes(required_query_attributes) if required_query_attributes
+      super
+    end
+
+    private
+
+    def check_required_query_attributes(required_query_attributes)
+      predicate_attributes = where_clause.send(:predicates).
+        select { |node| node.left.relation.name == table_name }.
+        map { |node| node.left.name }
+
+      missing_names = required_query_attributes - predicate_attributes
+
+      if missing_names.present?
+        raise RequiredAttributeMissing,
+              "Required attributes #{missing_names} missing from query: #{to_sql.truncate(200)}"
+      end
+    end
+  end
+end

data/lib/required_query_attributes/version.rb

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

data/required_query_attributes.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'required_query_attributes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'required_query_attributes'
+  spec.version       = RequiredQueryAttributes::VERSION
+  spec.authors       = ['Marco Costa']
+  spec.email         = ['marco@marcotc.com']
+  spec.license = "MIT"
+
+  spec.summary       = 'Enforce presence of specific columns in ActiveRecord queries.'
+  spec.description   = <<~DESC
+    Enforces the presence of specific columns in SELECT queries. Useful when you have
+    performance restrictions when specific columns are not included in your WHERE clauses.
+    Indexed columns and partition keys are common examples of such columns.
+  DESC
+  spec.homepage      = 'https://github.com/wealthsimple/required_query_attributes'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.4'
+
+  spec.add_dependency 'activerecord', '~> 5'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'bundler-audit', '~> 0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '0.49.1' # Temporarily necessary to avoid breaking ws-style
+  spec.add_development_dependency 'sqlite3', '~> 1'
+  spec.add_development_dependency 'ws-style', '~> 0'
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: required_query_attributes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marco Costa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: ws-style
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  Enforces the presence of specific columns in SELECT queries. Useful when you have
+  performance restrictions when specific columns are not included in your WHERE clauses.
+  Indexed columns and partition keys are common examples of such columns.
+email:
+- marco@marcotc.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/required_query_attributes.rb
+- lib/required_query_attributes/model.rb
+- lib/required_query_attributes/relation.rb
+- lib/required_query_attributes/version.rb
+- required_query_attributes.gemspec
+homepage: https://github.com/wealthsimple/required_query_attributes
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Enforce presence of specific columns in ActiveRecord queries.
+test_files: []