awesome_delete 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a16663db45580e4f1a4faf0e97fd4b323020f238
+  data.tar.gz: ebeb2c214cb0f54345838c922d409c582c27ffa2
+SHA512:
+  metadata.gz: 333c0ddd99204473a3c2081dfb59cf45cf9c0336aca9b6ea0eb16d2466145347dd464ef4193d3b4cfb09d99baf5f7dd4df7dd2c80e1d14154b35114e2f53d232
+  data.tar.gz: 7048b3cc09be57ecf2c157e1f1d13cf0a5f0adee7758d435cbe7dad9726b47b454d4d400430847087f52e84408907756d264c1cead60325b4b9e3d75cee4a58f

data/.gitignore

@@ -0,0 +1,2 @@
+/spec/debug.log
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'pry'
+gem 'pry-nav'
+gem 'pg'
+
+gem 'nokogiri', '1.6.6.4'
+
+# gem "appraisal"

data/README.md

@@ -0,0 +1,39 @@
+# awesome_delete
+> Recursive delete appropriately
+
+Recursively delete a collection and its all assoication with less sqls.
+It thinks about the following
+- STI (delete the associations of subclass)
+- polymorphism
+- counter_cache, touch (avoid to unnecessary handle)
+- callbacks
+
+## Example
+
+```ruby
+class Form < ActiveRecord::Base
+  has_many :fields, dependent: :destroy
+end
+
+class Field < ActiveRecord::Base
+end
+
+Form.delete_collection [1,4,5]
+```
+The class method `execute_callbacks` will execute callbacks.
+Overwriting it maybe a better choice.
+eg:
+```ruby
+class CloudFile < ActiveRecord::Base
+  after_destroy :remove_file
+
+  def self.execute_callbacks ids
+    keys = where(id: ids).pluck(:key)
+    # do something with all keys
+  end
+
+  def remove_file key
+    HttpClient.send_request key
+  end
+end
+```

data/awesome_delete.gemspec

@@ -0,0 +1,25 @@
+require File.expand_path('../lib/awesome_delete/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['hw93']
+  gem.email         = ['676018683@qq.com']
+  gem.license       = 'MIT'
+  gem.version       = AwesomeDelete::VERSION
+  gem.summary       = 'Recursively delete appropriately'
+  gem.description   = 'Recursively delete a collection and its all assoication with less sqls'
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = 'awesome_delete'
+  gem.require_paths = ['lib']
+  gem.homepage      = 'https://github.com/hw676018683/awesome_delete'
+
+  gem.required_ruby_version = ">= 1.9.3"
+
+  gem.add_runtime_dependency 'activerecord', '>= 4.0.0', '< 5'
+
+  gem.add_development_dependency 'rspec-rails', '~> 3.0'
+  gem.add_development_dependency 'combustion', '>= 0.5.2'
+  gem.add_development_dependency 'database_cleaner'
+end

data/lib/awesome_delete.rb

@@ -0,0 +1,4 @@
+require 'active_record'
+require 'awesome_delete/delete_extension'
+
+ActiveRecord::Base.send :extend, AwesomeDelete::DeleteExtension

data/lib/awesome_delete/delete_extension.rb

@@ -0,0 +1,153 @@
+module AwesomeDelete
+  module DeleteExtension
+    def delete_collection ids, all_associations_name = []
+      return true if ids.blank?
+
+      #Not handle counter_cache or touch association in all_associations_name
+      @@all_associations_name = all_associations_name
+
+      if @@all_associations_name.blank?
+        @@all_associations_name = get_associations_name << self.name
+      end
+
+      delete_assoicated_collection(ids, deleted_associations)
+
+      # STI
+      if column_names.include? inheritance_column
+        where(id: ids).pluck(inheritance_column).uniq.each do |type|
+          subklass = type.constantize
+          subklass.delete_self_collection(ids)
+          delete_assoicated_collection(ids, subklass.deleted_associations - deleted_associations)
+        end
+      else
+        delete_self_collection(ids)
+      end
+    end
+
+    def deleted_associations
+      @deleted_associations ||= reflect_on_all_associations.select do |asso|
+                                  [:destroy, :delete_all].include? asso.options.deep_symbolize_keys[:dependent]
+                                end
+    end
+
+    def touch_associations
+      @touch_associations ||= reflect_on_all_associations.select do |asso|
+                                asso.options.deep_symbolize_keys[:touch]
+                              end
+    end
+
+    def counter_cache_associations
+      @counter_cache_associations ||= reflect_on_all_associations.select do |asso|
+                                        asso.options.deep_symbolize_keys[:counter_cache]
+                                      end
+    end
+
+    def delete_self_collection ids
+      #touch
+      need_handle_touch_associations = touch_associations.select do |asso|
+                                         !@@all_associations_name.include?(asso.class_name)
+                                       end
+      need_handle_touch_associations.each do |asso|
+        if asso.options[:polymorphic]
+          types_ids = where(id: ids).pluck(asso.foreign_type, asso.foreign_key).uniq
+          types = types_ids.map(&:first).uniq
+          types.each do |type|
+            type_ids = types_ids.select { |type_id| type_id.first == type }.map(&:last).uniq.compact
+            type.constantize.where(id: type_ids).update_all updated_at: Time.now
+          end
+        else
+          asso.klass.where(id: where(id: ids).pluck(asso.foreign_key)).update_all updated_at: Time.now
+        end
+      end
+
+      #counter_cache
+      need_handle_counter_cache_associations = counter_cache_associations.select do |asso|
+                                                 !@@all_associations_name.include?(asso.class_name)
+                                               end
+      cache_ids_with_possible_types = []
+      need_handle_counter_cache_associations.each do |asso|
+        if asso.options[:polymorphic]
+          cache_ids_with_possible_types << where(id: ids).pluck(asso.foreign_type, asso.foreign_key).uniq
+        else
+          cache_ids_with_possible_types << where(id: ids).pluck(asso.foreign_key).uniq
+        end
+      end
+
+      execute_callbacks(ids)
+
+      #counter_cache
+      need_handle_counter_cache_associations.each_with_index do |asso, index|
+        if asso.options[:polymorphic]
+          types_ids = cache_ids_with_possible_types[index]
+          types = types_ids.map(&:first).uniq
+          types.each do |type|
+            ids = types_ids.select { |type_id| type_id.first == type }.map(&:last).uniq.compact
+            ids.each do |id|
+              type.constantize.where(id: id).update_all asso.counter_cache_column => where(asso.foreign_key => id).count
+            end
+          end
+        else
+          asso_ids = cache_ids_with_possible_types[index]
+          asso_ids.each do |id|
+            asso.klass.where(id: id).update_all asso.counter_cache_column => where(asso.foreign_key => id).count
+          end
+        end
+      end
+    end
+
+    def delete_assoicated_collection ids, associations
+      associations.each do |association|
+        association_class = association.klass
+
+        #polymorphic
+        if association.type
+          association_class.delete_collection association_class.where(association.foreign_key => ids, association.type => self.name).pluck(:id), @@all_associations_name
+        else
+          association_class.delete_collection association_class.where(association.foreign_key => ids).pluck(:id), @@all_associations_name
+        end
+      end
+    end
+
+    def get_associations_name
+      return [] if deleted_associations.blank?
+      associations_name = []
+
+      deleted_associations.each do |association|
+        associations_name << association.class_name
+        associations_name += association.class_name.constantize.get_associations_name
+      end
+      associations_name
+    end
+
+    def execute_callbacks ids
+      #overwriting this method may be a better choice
+      collection = where(id: ids).to_a
+      befores = _destroy_callbacks.select { |callback| callback.kind == :before }
+      afters = _destroy_callbacks.select { |callback| callback.kind == :after }
+      commits = _commit_callbacks.select do |callback|
+        ifs = callback.instance_variable_get('@if')
+        ifs.empty? || ifs.include?("transaction_include_any_action?([:destroy])")
+      end
+
+      befores.each do |callback|
+        case callback.filter
+        when Symbol
+          collection.each { |item| item.send callback.filter }
+        end
+      end
+      where(id: ids).delete_all
+      afters.each do |callback|
+        case callback.filter
+        when Symbol
+          collection.each { |item| item.send callback.filter }
+        end
+      end
+      commits.each do |callback|
+        case callback.filter
+        when Symbol
+          collection.each { |item| item.send callback.filter }
+        end
+      end
+    end
+  end
+end

data/lib/awesome_delete/version.rb

@@ -0,0 +1,3 @@
+module AwesomeDelete
+  VERSION = '0.0.2'
+end

data/spec/db/database.yml

@@ -0,0 +1,10 @@
+postgresql:
+  adapter: postgresql
+  database: awesome_delete_test
+  encoding: unicode
+  pool: 10
+  username: skylark
+  password: skylark
+  host: localhost
+  port: 5432
+  min_messages: warning

data/spec/db/schema.rb

@@ -0,0 +1,55 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :projects, :force => true do |t|
+    t.string :title
+    t.integer :forms_count
+    t.datetime :created_at
+    t.datetime :updated_at
+  end
+
+  create_table :users, :force => true do |t|
+    t.string :name
+    t.integer :forms_count
+    t.datetime :created_at
+    t.datetime :updated_at
+  end
+
+  create_table :forms, :force => true do |t|
+    t.string :title
+    t.integer :user_id
+    t.integer :formable_id
+    t.string :formable_type
+    t.datetime :created_at
+    t.datetime :updated_at
+  end
+
+  create_table :responses, :force => true do |t|
+    t.integer :responseable_id
+    t.string :responseable_type
+    t.integer :entries_count
+    t.datetime :created_at
+    t.datetime :updated_at
+  end
+
+  create_table :fields, :force => true do |t|
+    t.string :title
+    t.integer :form_id
+    t.string :type
+    t.integer :options_count, default: 0
+    t.datetime :created_at
+    t.datetime :updated_at
+  end
+
+  create_table :options, :force => true do |t|
+    t.string :title
+    t.integer :field_id
+    t.datetime :created_at
+    t.datetime :updated_at
+  end
+
+  create_table :entries, :force => true do |t|
+    t.string :title
+    t.integer :response_id
+    t.datetime :created_at
+    t.datetime :updated_at
+  end
+end

data/spec/delete_extension_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+describe 'AwesomeDelete' do
+
+  before(:all) do
+    self.class.fixtures :projects, :forms, :fields, :options, :responses, :entries, :users
+  end
+
+  describe 'deleting forms' do
+    let!(:form_a) { forms(:form_a) }
+    let!(:form_b) { forms(:form_b) }
+
+    it 'decrements the forms count' do
+      expect {
+        Form.delete_collection [form_a.id, form_b.id]
+      }.to change { Form.count }.by -2
+    end
+
+    it 'touchs the project' do
+      expect(Logger).to receive(:project_touch).with("Touching")
+      expect {
+        Form.delete_collection [form_a.id, form_b.id]
+      }.to change { projects(:project_a).reload.updated_at }
+    end
+
+    it 'updates forms_count of project' do
+      expect(Logger).to receive(:project_update_counter).with("Updating counter")
+      expect {
+        Form.delete_collection [form_a.id, form_b.id]
+      }.to change { projects(:project_a).reload.forms_count }.by -2
+    end
+
+    it 'touchs the user' do
+      expect {
+        Form.delete_collection [form_a.id, form_b.id]
+      }.to change { users(:user_a).reload.updated_at }
+    end
+
+    it 'updates forms_count of user' do
+      expect {
+        Form.delete_collection [form_a.id, form_b.id]
+      }.to change { users(:user_a).reload.forms_count }.by -2
+    end
+
+    it 'decrements the fields count' do
+      expect {
+        Form.delete_collection [form_a.id, form_b.id]
+      }.to change { Field.count }.by -3
+    end
+
+    it 'decrements the options count' do
+      expect {
+        Form.delete_collection [form_a.id, form_b.id]
+      }.to change { Option.count }.by -3
+    end
+
+    it 'decrements the responses count' do
+      expect {
+        Form.delete_collection [form_a.id, form_b.id]
+      }.to change { Response.count }.by -3
+    end
+
+    it 'decrements the entries count' do
+      expect {
+        Form.delete_collection [form_a.id, form_b.id]
+      }.to change { Entry.count }.by -3
+    end
+
+    it 'doesnot touch forms' do
+      expect(Logger).not_to receive(:form_touch).with("Touching")
+      Form.delete_collection [form_a.id, form_b.id]
+    end
+
+    it 'doesnot updates entries of responses' do
+      expect(Logger).not_to receive(:response_update_counter).with("Updating counter")
+      Form.delete_collection [form_a.id, form_b.id]
+    end
+
+    it 'executes destroy callback' do
+      expect(Logger).to receive(:entry_before_destroy).with("Doing other things.").exactly(3).times
+      expect(Logger).to receive(:entry_after_destroy).with("Doing other things.").exactly(3).times
+      Form.delete_collection [form_a.id, form_b.id]
+    end
+
+    it 'executes commit callback' do
+      expect(Logger).to receive(:option_after_commit).with("Doing other things.").exactly(3).times
+      Form.delete_collection [form_a.id, form_b.id]
+    end
+  end
+
+  describe 'destroying fields' do
+    it 'touch the form' do
+      field_a = fields(:field_a)
+      field_b = fields(:field_b)
+      form_a = forms(:form_a)
+      expect {
+        Field.delete_collection [field_a.id, field_b.id]
+      }.to change { form_a.reload.updated_at }
+    end
+  end
+
+  describe 'destroying options' do
+    it 'update the options_count of the field' do
+      option_a = options(:option_a)
+      option_b = options(:option_b)
+      field_a = fields(:field_a)
+      field_b = fields(:field_b)
+      expect {
+        Option.delete_collection [option_a.id, option_b.id]
+      }.to change { field_a.reload.options.count }.by -1
+    end
+  end
+end

data/spec/fixtures/entries.yml

@@ -0,0 +1,11 @@
+entry_a:
+ id: 1
+ response_id: 1
+
+entry_b:
+ id: 2
+ response_id: 2
+
+entry_c:
+ id: 3
+ response_id: 3

data/spec/fixtures/fields.yml

@@ -0,0 +1,16 @@
+field_a:
+  id: 1
+  form_id: 1
+  type: 'Field::A'
+  options_count: 1
+
+field_b:
+  id: 2
+  form_id: 1
+  type: 'Field::B'
+  options_count: 2
+
+field_c:
+  id: 3
+  form_id: 1
+  type: 'Field::C'

data/spec/fixtures/forms.yml

@@ -0,0 +1,13 @@
+form_a:
+  id: 1
+  title: form_a
+  formable_id: 1
+  formable_type: Project
+  user_id: 1
+
+form_b:
+  id: 2
+  title: form_b
+  formable_id: 1
+  formable_type: Project
+  user_id: 1

data/spec/fixtures/options.yml

@@ -0,0 +1,14 @@
+option_a:
+  id: 1
+  title: option_a
+  field_id: 1
+
+option_b:
+  id: 2
+  title: option_b
+  field_id: 2
+
+option_c:
+  id: 3
+  title: option_c
+  field_id: 2

data/spec/fixtures/projects.yml

@@ -0,0 +1,3 @@
+project_a:
+  id: 1
+  forms_count: 2

data/spec/fixtures/responses.yml

@@ -0,0 +1,17 @@
+response_a:
+  id: 1
+  responseable_type: Form
+  responseable_id: 1
+  entries_count: 1
+
+response_b:
+  id: 2
+  responseable_type: Form
+  responseable_id: 1
+  entries_count: 1
+
+response_c:
+  id: 3
+  responseable_type: Form
+  responseable_id: 1
+  entries_count: 1

data/spec/fixtures/users.yml

@@ -0,0 +1,4 @@
+user_a:
+  id: 1
+  name: 'user_a'
+  forms_count: 2

data/spec/spec_helper.rb

@@ -0,0 +1,41 @@
+plugin_test_dir = File.dirname(__FILE__)
+
+require 'rubygems'
+require 'bundler/setup'
+require 'pry'
+
+require 'logger'
+require 'active_record'
+ActiveRecord::Base.logger = Logger.new(plugin_test_dir + "/debug.log")
+
+require 'yaml'
+require 'erb'
+
+ENV["DB"] = 'postgresql'
+ActiveRecord::Base.configurations = YAML::load(ERB.new(IO.read(plugin_test_dir + "/db/database.yml")).result)
+ActiveRecord::Base.establish_connection((ENV["DB"] ||= "sqlite3mem").to_sym)
+ActiveRecord::Migration.verbose = false
+
+require 'combustion/database'
+Combustion::Database.create_database(ActiveRecord::Base.configurations[ENV["DB"]])
+load(File.join(plugin_test_dir, "db", "schema.rb"))
+
+begin
+  require 'action_view'
+rescue LoadError; end # action_view doesn't exist in Rails 4.0, but we need this for the tests to run with Rails 4.1
+
+require 'awesome_delete'
+require 'support/models'
+
+require 'action_controller'
+require 'rspec/rails'
+require 'database_cleaner'
+RSpec.configure do |config|
+  config.fixture_path = "#{plugin_test_dir}/fixtures"
+  config.use_transactional_fixtures = true
+  config.after(:suite) do
+    unless /sqlite/ === ENV['DB']
+      Combustion::Database.drop_database(ActiveRecord::Base.configurations[ENV['DB']])
+    end
+  end
+end

data/spec/support/models.rb

@@ -0,0 +1,92 @@
+class Project < ActiveRecord::Base
+end
+
+class User < ActiveRecord::Base
+end
+
+class Form < ActiveRecord::Base
+  has_many :fields, dependent: :destroy
+  has_many :responses, as: :responseable, dependent: :destroy
+  belongs_to :formable, polymorphic: true, touch: true, counter_cache: true
+  belongs_to :user, touch: true, counter_cache: true
+end
+
+class Field < ActiveRecord::Base
+  belongs_to :form, touch: true
+end
+
+class Field::A < Field
+  has_many :options, dependent: :destroy, foreign_key: 'field_id'
+end
+
+class Field::B < Field
+  has_many :options, dependent: :destroy, foreign_key: 'field_id'
+end
+
+class Field::C < Field
+end
+
+class Option < ActiveRecord::Base
+  after_commit :test
+
+  def test
+    Logger.send "option_after_commit", 'Doing other things.'
+  end
+end
+
+class Response < ActiveRecord::Base
+  has_many :entries, dependent: :destroy
+  belongs_to :responseable, polymorphic: true
+end
+
+class Entry < ActiveRecord::Base
+  before_destroy :handle1
+  after_destroy :handle2
+  belongs_to :response, counter_cache: true
+
+  private
+
+  def handle1
+    Logger.send "entry_before_destroy", 'Doing other things.'
+  end
+
+  def handle2
+    Logger.send "entry_after_destroy", 'Doing other things.'
+  end
+end
+
+class ActiveRecord::Relation
+  def update_all updates
+    #for test
+    if updates[:updated_at]
+      Logger.send "#{model.name.downcase}_touch", 'Touching'
+    elsif updates.keys.find { |key| key =~ /.*_count$/ }
+      Logger.send "#{model.name.downcase}_update_counter", 'Updating counter'
+    end
+
+    raise ArgumentError, "Empty list of attributes to change" if updates.blank?
+
+    stmt = Arel::UpdateManager.new(arel.engine)
+
+    stmt.set Arel.sql(@klass.send(:sanitize_sql_for_assignment, updates))
+    stmt.table(table)
+    stmt.key = table[primary_key]
+
+    if joins_values.any?
+      @klass.connection.join_to_update(stmt, arel)
+    else
+      stmt.take(arel.limit)
+      stmt.order(*arel.orders)
+      stmt.wheres = arel.constraints
+    end
+
+    bvs = arel.bind_values + bind_values
+    @klass.connection.update stmt, 'SQL', bvs
+  end
+end
+
+class Logger
+  def self.method_missing(method, *args, &block)
+    args
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: awesome_delete
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- hw93
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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: Recursively delete a collection and its all assoication with less sqls
+email:
+- 676018683@qq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- awesome_delete.gemspec
+- lib/awesome_delete.rb
+- lib/awesome_delete/delete_extension.rb
+- lib/awesome_delete/version.rb
+- spec/db/database.yml
+- spec/db/schema.rb
+- spec/delete_extension_spec.rb
+- spec/fixtures/entries.yml
+- spec/fixtures/fields.yml
+- spec/fixtures/forms.yml
+- spec/fixtures/options.yml
+- spec/fixtures/projects.yml
+- spec/fixtures/responses.yml
+- spec/fixtures/users.yml
+- spec/spec_helper.rb
+- spec/support/models.rb
+homepage: https://github.com/hw676018683/awesome_delete
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Recursively delete appropriately
+test_files: []