strict-loading 1.0.0

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+ENV["RAILS_ENV"] ||= "test"
+
+require "combustion"
+
+Combustion.initialize! :active_record do
+  if config.active_record.sqlite3
+    config.active_record.sqlite3.represent_boolean_as_integer = true
+  end
+end
+
+require "strict-loading"
+require "rspec/rails"
+require "database_cleaner"
+
+module StrictLoading
+  module SpecHelpers
+    def with_violation_action(action)
+      old_action = ActiveRecord::Base.action_on_strict_loading_violation
+      ActiveRecord::Base.action_on_strict_loading_violation = action
+      yield
+    ensure
+      ActiveRecord::Base.action_on_strict_loading_violation = old_action
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include(StrictLoading::SpecHelpers)
+
+  DatabaseCleaner.strategy = :transaction
+
+  config.before(:suite) { DatabaseCleaner.clean_with :truncation }
+
+  config.before { DatabaseCleaner.start }
+  config.after  { DatabaseCleaner.clean }
+end

data/spec/strict_loading_spec.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "pry-byebug"
+
+describe StrictLoading do
+  before(:each) do
+    list = TodoList.create(name: "Groceries")
+    list.todo_items.create(name: "Celery")
+    list.todo_items.create(name: "Carrots")
+  end
+
+  describe "#strict_loading" do
+    it "raises an error when attempting to access an unloaded relation" do
+      list = TodoList.first
+      list.strict_loading!
+
+      expect { list.todo_items.to_a }.to raise_error(ActiveRecord::StrictLoadingViolationError) do |err|
+        expect(err.message).to eq(
+          "`TodoList` is marked for strict_loading. The TodoItem association named `:todo_items` cannot be lazily loaded."
+        )
+      end
+    end
+
+    it "logs violations instead of raising" do
+      list = TodoList.first
+      list.strict_loading!
+
+      with_violation_action(:log) do
+        events = []
+
+        callback = lambda do |_name, _start, _finish, _id, payload|
+          events << payload
+        end
+
+        ActiveSupport::Notifications.subscribed(callback, "strict_loading_violation.active_record") do
+          list.todo_items.to_a
+        end
+
+        expect(events.size).to be > 0
+
+        event = events[0]
+        expect(event[:owner]).to eq(TodoList)
+        expect(event[:reflection]).to eq(TodoList.reflect_on_association(:todo_items))
+      end
+    end
+  end
+
+  describe ".strict_loading" do
+    it "raises an error when attempting to access an unloaded relation" do
+      list = TodoList.strict_loading.first
+
+      expect { list.todo_items.to_a }.to raise_error(ActiveRecord::StrictLoadingViolationError) do |err|
+        expect(err.message).to eq(
+          "`TodoList` is marked for strict_loading. The TodoItem association named `:todo_items` cannot be lazily loaded."
+        )
+      end
+    end
+  end
+end

data/strict-loading.gemspec

@@ -0,0 +1,19 @@
+$:.unshift File.join(File.dirname(__FILE__), "lib")
+require "strict-loading/version"
+
+Gem::Specification.new do |s|
+  s.name     = "strict-loading"
+  s.version  = ::StrictLoading::VERSION
+  s.authors  = ["Cameron Dutro"]
+  s.email    = ["camertron@gmail.com"]
+  s.homepage = "http://github.com/camertron"
+
+  s.description = s.summary = "A backport of ActiveRecord strict loading feature for Rails < 6.1."
+  s.platform = Gem::Platform::RUBY
+
+  s.add_dependency "railties", ">= 4.2.0", "< 6.1"
+  s.add_dependency "activerecord", ">= 4.2.0", "< 6.1"
+
+  s.require_path = "lib"
+  s.files = Dir["{lib,spec}/**/*", "Gemfile", "CHANGELOG.md", "README.md", "Rakefile", "strict-loading.gemspec"]
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: strict-loading
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cameron Dutro
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+description: A backport of ActiveRecord strict loading feature for Rails < 6.1.
+email:
+- camertron@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/strict-loading.rb
+- lib/strict-loading/abstract_reflection.rb
+- lib/strict-loading/association.rb
+- lib/strict-loading/core.rb
+- lib/strict-loading/query_methods.rb
+- lib/strict-loading/railtie.rb
+- lib/strict-loading/relation.rb
+- lib/strict-loading/version.rb
+- lib/strict_loading.rb
+- spec/internal/app/models/todo_item.rb
+- spec/internal/app/models/todo_list.rb
+- spec/internal/config/database.yml
+- spec/internal/db/combustion_test.sqlite
+- spec/internal/db/schema.rb
+- spec/internal/log/test.log
+- spec/spec_helper.rb
+- spec/strict_loading_spec.rb
+- strict-loading.gemspec
+homepage: http://github.com/camertron
+licenses: []
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: A backport of ActiveRecord strict loading feature for Rails < 6.1.
+test_files: []