effective_resources 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc5c9f80574e6e2e358159bd7b4bd8805f788f80
-  data.tar.gz: c673dbb171613323e3fd32cc3dfc4e9b4f67db2c
+  metadata.gz: 98eec49f950e3a5329e04edcdc12462a46511a64
+  data.tar.gz: 86cb3c947ff46aa3cad31418d7cd9fb0bbc0b9f0
 SHA512:
-  metadata.gz: 5c66fbaeb3387368ce66f4f7784e8b04084a3ad417b89c8b9a72055c3fd9a59d59683a1b542e6c5cb703ac7064bfc6d7cea659fc12c2a35056b5002b2d0ea5d5
-  data.tar.gz: d04261af330fdd6028405232143882eb82db90f8bdde0a080bd40e48318172dbb7273bf0b5b8ebf6179768a18b531aada8071cbde4ab9f8848c8e5d71f43f6da
+  metadata.gz: 79eaabdd4351233a3cb816127449a9c94b5ceab6d4e7e0267c631f8f4d232f7a6db174bfb3b618b7a9ceb824bb33aa59db7f2ca02ea763e38fa12c77e65aa12e
+  data.tar.gz: 806feda1c2f95426a79aafafac3adb353f506bb44d5660d6249b78b8fbde92282e5a22e8cdcd1396aca3cbb9d38fbab09a72c063407843e138bbb5a182b15220

data/app/helpers/effective_resources_private_helper.rb

@@ -11,8 +11,8 @@ module EffectiveResourcesPrivateHelper
 
       (args.key?(:only) ? args[:only].include?(page_action) : true) &&
       (args.key?(:except) ? !args[:except].include?(page_action) : true) &&
-      (args.key?(:if) ? controller.instance_exec(&args[:if]) : true) &&
-      (args.key?(:unless) ? !controller.instance_exec(&args[:unless]) : true) &&
+      (args.key?(:if) ? controller.instance_exec(resource, &args[:if]) : true) &&
+      (args.key?(:unless) ? !controller.instance_exec(resource, &args[:unless]) : true) &&
       EffectiveResources.authorized?(controller, action, resource)
     end.inject({}) do |h, (commit, args)|
       opts = args.except(:default, :only, :except, :if, :unless, :redirect, :success, :danger)

data/app/models/concerns/acts_as_archived.rb

@@ -0,0 +1,99 @@
+# ActsAsArchived
+#
+# Implements the dumb archived pattern
+# An archived object should not be displayed on index screens, or any related resource's #new pages
+# effective_select (from the effective_bootstrap gem) is aware of this concern, and calls .unarchived and .archived appropriately when passed an ActiveRecord relation
+# Use the cascade argument to cascade archived changes to any has_manys
+#
+# class Thing < ApplicationRecord
+#   has_many :comments
+#   acts_as_archivable cascade: :comments
+# end
+
+# Each controller needs its own archive and unarchive action.
+# To simplify this, use the following route concern.
+#
+# In your routes.rb:
+#
+# Rails.application.routes.draw do
+#   acts_as_archived
+#
+#   resource :things, concern: :acts_as_archived
+#   resource :comments, concern: :acts_as_archived
+# end
+#
+# and include Effective::CrudController in your resource controller
+
+module ActsAsArchived
+  extend ActiveSupport::Concern
+
+  module ActiveRecord
+    def acts_as_archived(cascade: [])
+      resource = new()
+
+      # Make sure we respond to archived attribute
+      # puts "WARNING: (acts_as_archived) expected #{name} to respond to archived" unless resource.respond_to?(:archived)
+
+      # Parse options
+      cascade = Array(cascade).compact
+
+      if cascade.any? { |obj| !obj.kind_of?(Symbol) }
+        raise 'expected cascade to be an Array of has_many symbols'
+      end
+
+      cascade.reject { |cascade| cascade.respond_to?(cascade) }.each do |cascade|
+        puts "WARNING: (acts_as_archived) expected #{name} to respond to #{cascade}."
+      end
+
+      @acts_as_archived_options = { cascade: cascade }
+
+      include ::ActsAsArchived
+    end
+  end
+
+  module RoutesConcern
+    def acts_as_archived
+      concern :acts_as_archived do
+        post :archive, on: :member
+        post :unarchive, on: :member
+      end
+    end
+  end
+
+  included do
+    scope :archived, -> { where(archived: true) }
+    scope :unarchived, -> { where(archived: false) }
+
+    effective_resource do
+      archived :boolean,  permitted: false
+    end
+
+    acts_as_archived_options = @acts_as_archived_options
+    self.send(:define_method, :acts_as_archived_options) { acts_as_archived_options }
+  end
+
+  module ClassMethods
+    def acts_as_archived?; true; end
+  end
+
+  # Instance methods
+  def archive!
+    transaction do
+      update!(archived: true) # Runs validations
+      acts_as_archived_options[:cascade].each { |obj| public_send(obj).update_all(archived: true) }
+    end
+  end
+
+  def unarchive!
+    transaction do
+      update_column(:archived, false) # Does not run validations
+      acts_as_archived_options[:cascade].each { |obj| public_send(obj).update_all(archived: false) }
+    end
+  end
+
+  def destroy
+    archive!
+  end
+
+end
+

data/app/models/effective/model_reader.rb

@@ -13,8 +13,6 @@ module Effective
     end
 
     def method_missing(m, *args, &block)
-      raise "#{m} has already been defined" if attributes[m]
-
       if m == :timestamps
         attributes[:created_at] = [:datetime]
         attributes[:updated_at] = [:datetime]

data/app/models/effective/resources/controller.rb

@@ -13,11 +13,11 @@ module Effective
           end
 
           if actions.find { |a| a == :index }
-            submits['Continue'] = { action: :save, redirect: :index, default: true, unless: -> { params[:_datatable_id] } }
+            submits['Continue'] = { action: :save, redirect: :index, default: true, unless: -> (resource) { params[:_datatable_id] } }
           end
 
           if actions.find { |a| a == :new }
-            submits['Add New'] = { action: :save, redirect: :new, default: true, unless: -> { params[:_datatable_id] } }
+            submits['Add New'] = { action: :save, redirect: :new, default: true, unless: -> (resource) { params[:_datatable_id] } }
           end
         end
       end
@@ -29,11 +29,19 @@ module Effective
           end
 
           (member_post_actions - crud_actions).each do |action| # default true means it will be overwritten by dsl methods
-            buttons[action.to_s.titleize] = { action: action, default: true, 'data-method' => :post, 'data-confirm' => "Really #{action} @reource?"}
+            buttons[action.to_s.titleize] = case action
+            when :archive
+              { action: action, default: true, if: -> (resource) { !resource.archived? }, class: 'btn btn-danger', 'data-method' => :post, 'data-confirm' => "Really #{action} @resource?"}
+            when :unarchive
+              { action: action, default: true, if: -> (resource) { resource.archived? }, 'data-method' => :post, 'data-confirm' => "Really #{action} @resource?" }
+            else
+              { action: action, default: true, 'data-method' => :post, 'data-confirm' => "Really #{action} @resource?"}
+            end
           end
 
           member_delete_actions.each do |action|
             if action == :destroy
+              next if buttons.values.find { |v| v[:action] == :archive }.present?
               buttons['Delete'] = { action: action, default: true, 'data-method' => :delete, 'data-confirm' => "Really delete @resource?" }
             else
               buttons[action.to_s.titleize] = { action: action, default: true, 'data-method' => :delete, 'data-confirm' => "Really #{action} @resource?" }
@@ -68,10 +76,20 @@ module Effective
 
           (member_post_actions - crud_actions).each do |action|
             actions[action.to_s.titleize] = { action: action, default: true, 'data-method' => :post, 'data-confirm' => "Really #{action} @resource?" }
+
+            actions[action.to_s.titleize] = case action
+            when :archive
+              { action: action, default: true, if: -> (resource) { !resource.archived? }, class: 'btn btn-danger', 'data-method' => :post, 'data-confirm' => "Really #{action} @resource?"}
+            when :unarchive
+              { action: action, default: true, if: -> (resource) { resource.archived? }, 'data-method' => :post, 'data-confirm' => "Really #{action} @resource?" }
+            else
+              { action: action, default: true, 'data-method' => :post, 'data-confirm' => "Really #{action} @resource?" }
+            end
           end
 
           member_delete_actions.each do |action|
             if action == :destroy
+              next if actions.values.find { |v| v[:action] == :archive }.present?
               actions['Delete'] = { action: action, default: true, 'data-method' => :delete, 'data-confirm' => "Really delete @resource?" }
             else
               actions[action.to_s.titleize] = { action: action, default: true, 'data-method' => :delete, 'data-confirm' => "Really #{action} @resource?" }

data/lib/effective_resources/engine.rb

@@ -9,6 +9,12 @@ module EffectiveResources
       eval File.read("#{config.root}/config/effective_resources.rb")
     end
 
+    # Register the acts_as_archived routes concern
+    # resources :things, concerns: :acts_as_archived
+    initializer 'effective_resources.routes_concern' do |app|
+      ActionDispatch::Routing::Mapper.include(ActsAsArchived::RoutesConcern)
+    end
+
     # Register the flash_messages concern so that it can be called in ActionController
     initializer 'effective_resources.action_controller' do |app|
       ActiveSupport.on_load :action_controller do
@@ -19,6 +25,7 @@ module EffectiveResources
     # Include acts_as_addressable concern and allow any ActiveRecord object to call it
     initializer 'effective_resources.active_record' do |app|
       ActiveSupport.on_load :active_record do
+        ActiveRecord::Base.extend(ActsAsArchived::ActiveRecord)
         ActiveRecord::Base.extend(ActsAsTokened::ActiveRecord)
         ActiveRecord::Base.extend(ActsAsSlugged::ActiveRecord)
         ActiveRecord::Base.extend(EffectiveResource::ActiveRecord)

data/lib/effective_resources/version.rb

@@ -1,3 +1,3 @@
 module EffectiveResources
-  VERSION = '1.0.6'.freeze
+  VERSION = '1.0.7'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_resources
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors:
 - Code and Effect
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-02 00:00:00.000000000 Z
+date: 2018-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -45,6 +45,7 @@ files:
 - app/controllers/concerns/effective/flash_messages.rb
 - app/helpers/effective_resources_helper.rb
 - app/helpers/effective_resources_private_helper.rb
+- app/models/concerns/acts_as_archived.rb
 - app/models/concerns/acts_as_slugged.rb
 - app/models/concerns/acts_as_tokened.rb
 - app/models/concerns/effective_resource.rb