active_record_better_dependent_error_messages 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 505842e6cb841ae76e2e4954fde49e8706d99bae
+  data.tar.gz: 3c61dcc6fdbe1c8fd7fcd75d2d06993ac34550f8
+SHA512:
+  metadata.gz: 9fd9c9f00dd1a054eea940da731fcd190c3b3d3f9364b5f566fa3bbfd1457a1f1653ddb11f1cfceb775e454f9c2494b154f7fd1fbf971c6d9e718d69d518fd04
+  data.tar.gz: 430de6c63eb4c5fe81af967f4432f86535b25ed8aa2488c3f885a27c5628bdca98cd5c95340860e2e540076dbd3b76f5bd80c8be92f2cd15f596ca86700dd83f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 kaspernj
+
+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 @@
+# ActiveRecordBetterDependentErrorMessages
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "active_record_better_dependent_error_messages"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install active_record_better_dependent_error_messages
+```
+
+Include it in the models where you want it to inspect the relationships upon destroy like this:
+```ruby
+class MyModel < ApplicationRecord
+  include ActiveRecordBetterDependentErrorMessages::DestroyModule
+end
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,26 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActiveRecordBetterDependentErrorMessages'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+

data/app/assets/config/active_record_better_dependent_error_messages_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/active_record_better_dependent_error_messages .js
+//= link_directory ../stylesheets/active_record_better_dependent_error_messages .css

data/app/assets/javascripts/active_record_better_dependent_error_messages/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/active_record_better_dependent_error_messages/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/active_record_better_dependent_error_messages/application_controller.rb

@@ -0,0 +1,5 @@
+module ActiveRecordBetterDependentErrorMessages
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/active_record_better_dependent_error_messages/application_helper.rb

@@ -0,0 +1,4 @@
+module ActiveRecordBetterDependentErrorMessages
+  module ApplicationHelper
+  end
+end

data/app/jobs/active_record_better_dependent_error_messages/application_job.rb

@@ -0,0 +1,4 @@
+module ActiveRecordBetterDependentErrorMessages
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/active_record_better_dependent_error_messages/application_mailer.rb

@@ -0,0 +1,6 @@
+module ActiveRecordBetterDependentErrorMessages
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/active_record_better_dependent_error_messages/application_record.rb

@@ -0,0 +1,5 @@
+module ActiveRecordBetterDependentErrorMessages
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/active_record_better_dependent_error_messages/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Active record better dependent error messages</title>
+  <%= stylesheet_link_tag    "active_record_better_dependent_error_messages/application", media: "all" %>
+  <%= javascript_include_tag "active_record_better_dependent_error_messages/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+ActiveRecordBetterDependentErrorMessages::Engine.routes.draw do
+end

data/lib/active_record_better_dependent_error_messages.rb

@@ -0,0 +1,8 @@
+require "active_record_better_dependent_error_messages/engine"
+
+module ActiveRecordBetterDependentErrorMessages
+  path = "#{File.dirname(__FILE__)}/active_record_better_dependent_error_messages"
+
+  autoload :DestroyModule, "#{path}/destroy_module"
+  autoload :DestroyValidator, "#{path}/destroy_validator"
+end

data/lib/active_record_better_dependent_error_messages/destroy_module.rb

@@ -0,0 +1,7 @@
+module ActiveRecordBetterDependentErrorMessages::DestroyModule
+  def destroy
+    ActiveRecordBetterDependentErrorMessages::DestroyValidator.(model: self)
+    return false if errors.any?
+    super
+  end
+end

data/lib/active_record_better_dependent_error_messages/destroy_validator.rb

@@ -0,0 +1,62 @@
+class ActiveRecordBetterDependentErrorMessages::DestroyValidator
+  attr_reader :args, :root_model, :model, :trace
+
+  def initialize(root_model:, model:, trace:, args:)
+    @args = args
+    @root_model = root_model
+    @model = model
+    @trace = trace
+  end
+
+  def self.call(root_model: nil, model:, trace: nil, **args)
+    root_model ||= model
+    trace ||= [model]
+
+    ActiveRecordBetterDependentErrorMessages::DestroyValidator.new(root_model: root_model, model: model, trace: trace, args: args).()
+  end
+
+  def call
+    model.class.reflect_on_all_associations.each do |association|
+      if association.options[:dependent] == :restrict_with_error || association.options[:dependent] == :restrict_with_exception
+        check_restrict_association(association)
+      elsif association.options[:dependent] == :destroy
+        check_sub_destroy_association(association)
+      end
+    end
+  end
+
+private
+
+  def check_restrict_association(association)
+    if association.macro == :has_one
+      has_one_model = model.__send__(association.name)
+
+      if has_one_model
+        root_model.errors.add(:base, "Cannot delete because of #{trace_as_string} has dependent record: #{association.name} with ID: #{has_one_model.id}")
+      end
+    elsif association.macro == :has_many
+      ids = model.__send__(association.name).pluck(:id)
+      if ids.any?
+        root_model.errors.add(:base, "Cannot delete because of #{trace_as_string} has dependent records: #{association.name} with IDs: #{ids.join(", ")}")
+      end
+    end
+  end
+
+  def check_sub_destroy_association(association)
+    if association.macro == :has_one
+      sub_model = model.__send__(association.name)
+      ActiveRecordBetterDependentErrorMessages::DestroyValidator.(root_model: root_model, model: sub_model, trace: trace + [sub_model]) if sub_model
+    elsif association.macro == :has_many
+      sub_models = model.__send__(association.name)
+      sub_models.find_each do |sub_model_i|
+        ActiveRecordBetterDependentErrorMessages::DestroyValidator.(root_model: root_model, model: sub_model_i, trace: trace + [sub_model_i])
+      end
+    end
+  end
+
+  def trace_as_string
+    trace.map do |model|
+      "#{model.class.name}(#{model.id})"
+    end.join(" -> ")
+  end
+end

data/lib/active_record_better_dependent_error_messages/engine.rb

@@ -0,0 +1,5 @@
+module ActiveRecordBetterDependentErrorMessages
+  class Engine < ::Rails::Engine
+    isolate_namespace ActiveRecordBetterDependentErrorMessages
+  end
+end

data/lib/active_record_better_dependent_error_messages/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordBetterDependentErrorMessages
+  VERSION = "0.0.0"
+end

data/lib/tasks/active_record_better_dependent_error_messages_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :active_record_better_dependent_error_messages do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: active_record_better_dependent_error_messages
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- kaspernj
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.3
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: A gem that makes better dependent error messages telling exactly which
+  relationship tree failed with which ID's.
+email:
+- kaspernj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/active_record_better_dependent_error_messages_manifest.js
+- app/assets/javascripts/active_record_better_dependent_error_messages/application.js
+- app/assets/stylesheets/active_record_better_dependent_error_messages/application.css
+- app/controllers/active_record_better_dependent_error_messages/application_controller.rb
+- app/helpers/active_record_better_dependent_error_messages/application_helper.rb
+- app/jobs/active_record_better_dependent_error_messages/application_job.rb
+- app/mailers/active_record_better_dependent_error_messages/application_mailer.rb
+- app/models/active_record_better_dependent_error_messages/application_record.rb
+- app/views/layouts/active_record_better_dependent_error_messages/application.html.erb
+- config/routes.rb
+- lib/active_record_better_dependent_error_messages.rb
+- lib/active_record_better_dependent_error_messages/destroy_module.rb
+- lib/active_record_better_dependent_error_messages/destroy_validator.rb
+- lib/active_record_better_dependent_error_messages/engine.rb
+- lib/active_record_better_dependent_error_messages/version.rb
+- lib/tasks/active_record_better_dependent_error_messages_tasks.rake
+homepage: https://github.com/kaspernj/active-record-better-dependent-error-messages
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: A gem that makes better dependent error messages telling exactly which relationship
+  tree failed with which ID's.
+test_files: []