effective_trash 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5861ff673da253d2c1b764bad5f96c21c4ede0f
-  data.tar.gz: 619b6e251bc29e258dfb2daddcb7e022a7efc4bd
+  metadata.gz: d48b6ae4a747e8d6d2567827966736aff26b6b53
+  data.tar.gz: e4eb0078becab79191be39d8bb2b0d94159e43f7
 SHA512:
-  metadata.gz: 0cc1f9d9d136367ca6777e4f81733a4bc97e6518efee7f8186292a4eb106ae95c4f4f931350485f2d40eeb4369040904076316db05c9910cbc4016feaf267b8b
-  data.tar.gz: 198377e4829662be812a8bdbb21eafd8b4e8432954a2311347afc45eb64d38ec7e6f926331d3efb89217e4df695d9f3fea898ce668e649884d9af37878aaa9e3
+  metadata.gz: 0ff0bc35b9b92526df5bd06991f872f57a5a831779524774490e353160f9cc06c7ed6e46077e4d284d3af8e5a3ace5f5a47d814f540eec77c52a40998b5f9dd1
+  data.tar.gz: 208dfa88a8522b943c9135e138a5040ce58916bc2ac21e11bb6609145e20e047244562847fa833e9690896a271a63d2778831d62159fd5f9c265e7e1f1538dfd

data/README.md

@@ -81,6 +81,23 @@ can :admin, :effective_trash
 
 The user must be permitted to to `:update` an `Effective::Trash` in order to restore the trashed item.
 
+## Upgrade database from archived booleans
+
+Use the following generator, to produce a database migration:
+
+```
+rails generate effective_trash:trash_archived_booleans
+```
+
+The migration will trash all `archived?` objects, delete them, and replace the archived boolean on the corresponding database table.
+
+This upgrades from this gem author's previous archived implementation, which was:
+
+- Use an `archived` boolean on each model.
+- Call the model by a scope (or default scope, yuck) somehting like `Post.where(archived: false)`.
+
+Don't do that.
+
 ## License
 
 MIT License.  Copyright [Code and Effect Inc.](http://www.codeandeffect.com/)

data/app/controllers/admin/trash_controller.rb

@@ -18,7 +18,7 @@ module Admin
 
     def show
       @trash = Effective::Trash.all.find(params[:id])
-      @page_title = "Trash item - #{@trash.to_s}"
+      @page_title = "Trash item - #{@trash.trashed_to_s}"
 
       EffectiveTrash.authorized?(self, :show, @trash)
       EffectiveTrash.authorized?(self, :admin, :effective_trash)

data/app/controllers/effective/trash_controller.rb

@@ -28,8 +28,7 @@ module Effective
 
       Effective::Trash.transaction do
         begin
-          @trash.restore_trash!
-          @trash.destroy!
+          @trash.restore!
           flash[:success] = "Successfully restored #{@trash}"
         rescue => e
           flash[:danger] = "Unable to restore: #{e.message}"

data/app/helpers/effective_trash_helper.rb

@@ -10,21 +10,23 @@ module EffectiveTrashHelper
   # Any other options are sent to the table tag
   def tableize_hash(hash, options = {})
     if hash.present? && hash.kind_of?(Hash)
-      content_tag(:table, options) do
-        hash.map do |k, v|
-          content_tag(:tr) do
-            content_tag((options[:th] ? :th : :td), k) +
-            content_tag(:td) do
-              if v.kind_of?(Hash)
-                tableize_hash(v, options.merge({:class => 'table table-bordered', :th => (options.key?(:sub_th) ? options[:sub_th] : options[:th])}))
-              elsif v.kind_of?(Array)
-                '[' + v.join(', ') + ']'
-              else
-                v.to_s
+      content_tag(:table, class: options[:class]) do
+        content_tag(:tbody) do
+          hash.map do |k, v|
+            content_tag(:tr) do
+              content_tag((options[:th] ? :th : :td), k) +
+              content_tag(:td) do
+                if v.kind_of?(Hash)
+                  tableize_hash(v, options.merge({class: 'table table-hover', th: (options.key?(:sub_th) ? options[:sub_th] : options[:th])}))
+                elsif v.kind_of?(Array)
+                  '[' + v.join(', ') + ']'
+                else
+                  v.to_s
+                end
               end
             end
-          end
-        end.join('').html_safe
+          end.join('').html_safe
+        end
       end.html_safe
     else
       hash.to_s.html_safe

data/app/models/concerns/acts_as_trashable.rb

@@ -17,14 +17,7 @@ module ActsAsTrashable
     has_one :trash, as: :trashed, class_name: Effective::Trash
 
     before_destroy do
-      trash = Effective::Trash.new(
-        trashed: self,
-        user: EffectiveTrash.current_user,
-        trashed_to_s: to_s,
-        trashed_extra: (trashed_extra if respond_to?(:trashed_extra)),
-
-        details: EffectiveTrash::ActiveRecordSerializer.new(self, acts_as_trashable_options).attributes
-      ).save!
+      EffectiveTrash.trash!(self)
     end
 
     # Parse Options

data/app/models/effective/datatables/trash.rb

@@ -11,14 +11,14 @@ if defined?(EffectiveDatatables)
           table_column :id, visible: false
 
           unless attributes[:user_id] || attributes[:user] || (attributes[:user] == false)
-            table_column :user, label: 'Destroyed by', visible: false
+            table_column :user, label: 'Destroyed by'
           end
 
           table_column :trashed_type, label: 'Type'
           table_column :trashed_id, label: 'Original Id', visible: false
           table_column :trashed_to_s, label: 'Item'
 
-          table_column :details, visible: true, sortable: false do |trash|
+          table_column :details, visible: false, sortable: false do |trash|
             tableize_hash(trash.details, th: true, sub_th: false, width: '100%')
           end
 

data/app/models/effective/trash.rb

@@ -19,7 +19,7 @@ module Effective
     default_scope -> { order(updated_at: :desc) }
 
     def to_s
-      [trashed_type, trashed_id].join(' ').presence || 'New Trash item'
+      trashed_to_s.presence || [trashed_type, trashed_id].join(' ').presence || 'New Trash item'
     end
 
     def details
@@ -28,9 +28,24 @@ module Effective
 
     # So this is a Trash item
     # When we delete ourselves, we restore this trash item first
-    def restore_trash!
+    def restore!
       raise 'no attributes to restore from' unless details.kind_of?(Hash) && details[:attributes].present?
-      trashed_type.constantize.new(details[:attributes]).save!
+
+      resource = Effective::Resource.new(trashed_type)
+      object = trashed_type.constantize.new(details[:attributes])
+
+      resource.nested_resources.each do |association|
+        if details[association.name].present? && object.respond_to?("#{association.name}_attributes=")
+          nested_attributes = details[association.name].inject({}) do |h, (index, nested)|
+            h[index] = nested[:attributes].except('id', association.inverse_of.foreign_key); h
+          end
+
+          object.send("#{association.name}_attributes=", nested_attributes)
+        end
+      end
+
+      object.save!(validate: false)
+      destroy!
     end
 
   end

data/db/trash/trash_archived_booleans.rb

@@ -0,0 +1,28 @@
+class TrashArchivedBooleans < ActiveRecord::Migration[4.2]
+  def self.up
+    Rails.application.eager_load!
+    klasses = ActiveRecord::Base.descendants
+      .reject { |klass| klass.abstract_class? }
+      .select { |klass| (klass.new.respond_to?(:archived?) rescue false) }
+
+    klasses.each do |klass|
+      puts "Trashing #{klass.table_name}"
+
+      ids = [] # to delete
+
+      klass.unscoped.where(archived: true).find_each do |resource|
+        print '.'
+        EffectiveTrash.trash!(resource)
+        ids << resource.id
+      end
+
+      klass.where(id: ids).delete_all
+    end
+
+    klasses.each { |klass| remove_column(klass.table_name, :archived) }
+  end
+
+  def self.down
+    raise 'TODO: this could be written'
+  end
+end

data/lib/effective_trash/version.rb

@@ -1,3 +1,3 @@
 module EffectiveTrash
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.2.2'.freeze
 end

data/lib/effective_trash.rb

@@ -1,4 +1,5 @@
 require 'haml-rails'
+require 'effective_resources'
 require 'effective_trash/engine'
 require 'effective_trash/version'
 
@@ -31,4 +32,16 @@ module EffectiveTrash
     @effective_trash_current_user
   end
 
+  # Trash it - Does not delete the original object.
+  # This is run in a before_destroy, or through a script.
+  def self.trash!(obj)
+    trash = Effective::Trash.new(
+      trashed: obj,
+      user: EffectiveTrash.current_user,
+      trashed_to_s: obj.to_s,
+      trashed_extra: (trashed_extra if obj.respond_to?(:trashed_extra)),
+      details: Effective::Resource.new(obj).instance_attributes
+    ).save!
+  end
+
 end

data/lib/generators/effective_trash/trash_archived_booleans_generator.rb

@@ -0,0 +1,25 @@
+# bundle exec rails generate effective_trash:trash_archived_booleans
+
+module EffectiveTrash
+  module Generators
+    class TrashArchivedBooleansGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc 'Upgrade all tables from boolean archived implementation. Trash all previously archived records'
+
+      source_root File.expand_path('../../template', __FILE__)
+
+      def self.next_migration_number(dirname)
+        if not ActiveRecord::Base.timestamped_migrations
+          Time.new.utc.strftime('%Y%m%d%H%M%S')
+        else
+          '%.3d' % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def create_migration_file
+        migration_template ('../' * 3) + 'db/trash/trash_archived_booleans.rb', 'db/migrate/trash_archived_booleans.rb'
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_trash
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Code and Effect
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-09 00:00:00.000000000 Z
+date: 2017-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: effective_resources
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: coffee-rails
   requirement: !ruby/object:Gem::Requirement
@@ -105,12 +119,13 @@ files:
 - config/effective_trash.rb
 - config/routes.rb
 - db/migrate/01_create_effective_trash.rb.erb
+- db/trash/trash_archived_booleans.rb
 - lib/effective_trash.rb
-- lib/effective_trash/active_record_serializer.rb
 - lib/effective_trash/engine.rb
 - lib/effective_trash/set_current_user.rb
 - lib/effective_trash/version.rb
 - lib/generators/effective_trash/install_generator.rb
+- lib/generators/effective_trash/trash_archived_booleans_generator.rb
 homepage: https://github.com/code-and-effect/effective_trash
 licenses:
 - MIT

data/lib/effective_trash/active_record_serializer.rb

@@ -1,61 +0,0 @@
-module EffectiveTrash
-  class ActiveRecordSerializer
-    attr_accessor :resource, :options
-
-    def initialize(resource, options = {})
-      raise ArgumentError.new('options must be a Hash') unless options.kind_of?(Hash)
-
-      @resource = resource
-      @options = options
-    end
-
-    def attributes
-      attributes = { attributes: resource.attributes }
-
-      # Collect to_s representations of all belongs_to associations
-      (resource.class.try(:reflect_on_all_associations, :belongs_to) || []).each do |association|
-        attributes[association.name] = resource.send(association.name).to_s.presence
-      end
-
-      # Collect to_s representations for all has_one associations
-      (resource.class.try(:reflect_on_all_associations, :has_one) || []).each do |association|
-        next if association.name == :trash && resource.respond_to?(:acts_as_trashable_options) # We skip our own association
-        attributes[association.name] = resource.send(association.name).to_s.presence
-      end
-
-      # Collects attributes for all accepts_as_nested_parameters has_many associations
-      (resource.class.try(:reflect_on_all_autosave_associations) || []).each do |association|
-        attributes[association.name] = {}
-
-        Array(resource.send(association.name)).each_with_index do |child, index|
-          attributes[association.name][index+1] = ActiveRecordLogger.new(child, options).attributes
-        end
-      end
-
-      attributes.delete_if { |k, v| v.blank? }
-    end
-
-    private
-
-    # TODO: Make this work better with nested objects
-    def applicable(attributes)
-      atts = if options[:only].present?
-        attributes.slice(*options[:only])
-      elsif options[:except].present?
-        attributes.except(*options[:except])
-      else
-        attributes.except(:updated_at, :created_at)
-      end
-
-      (options[:additionally] || []).each do |attribute|
-        value = (resource.send(attribute) rescue :effective_trash_nope)
-        next if attributes[attribute].present? || value == :effective_trash_nope
-
-        atts[attribute] = value
-      end
-
-      atts
-    end
-
-  end
-end