rails_admin_draft 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fedb5ecfd53550b653e9f7f657e25d50249340b1e2c91d9438f10a400d797e7b
-  data.tar.gz: 4fe1a560eb1ac34cce4cca876e7017f579203f79d68073bb5f9ebf638a62317f
+  metadata.gz: a0536b226a2009c0cea3563c66e3eb6e200a7b006cc211206a71c311f00e3964
+  data.tar.gz: ac2c6be6868bb2099ee3b8d68a3cb19efa5ce4e6e76850d164a1959cd9c17527
 SHA512:
-  metadata.gz: '009375e2a43f657dca86acfd1db71b6dd4e1cb2f39df18c02b26cb564bf5713ad4605670c1fc79098883d3f8c7fd5249be8bb3bb5283d82b0e05f63044961635'
-  data.tar.gz: e8878ea65561aa366b08e1a782efee1fe9395c4f22cf9590857ee9f90f2da4127f5786c3cd120545b68f92be16fc1f1e7d9ee649e84fadf00af7098bec313850
+  metadata.gz: 0c539d9f9642a1e39aff7fae1f90d406b30380f1b0d52392cb4ad9e447fcc2a9bf9693d3386454814340ef98404f843108b096acb05ac7f61acb53e27781c4eb
+  data.tar.gz: 78dd9721239eb16052a5f44ba685d37d9f915c6b923945b7dfa0ac7b379139ed2259644bf5213b6bf9abe2fe3b68119467ef78637a84f4969a2ec946ea4853fc

data/config/initializers/draft_status.rb

@@ -0,0 +1,4 @@
+class DraftStatus
+  DRAFT = 'draft'.freeze
+  PUBLISHED = 'published'.freeze
+end

data/config/locales/rails_admin_draft/en.yml

@@ -0,0 +1,36 @@
+en:
+  admin:
+    actions:
+      copy_as_draft:
+        title: Copy as draft "%{object_label}"
+        menu: Copy as draft
+        breadcrumb: Copy as draft
+        success: copied as draft
+      publish:
+        success: published
+      switch_to_draft:
+        success: switched to draft
+
+    scopes:
+      rails_admin_all: All
+      rails_admin_draft: Drafts
+      rails_admin_published: Published
+
+    form:
+      draft_header: Draft
+      buttons:
+        save_draft:
+          title: Save as draft
+          name: Save as draft
+        switch_to_draft:
+          title: Switch to draft
+          name: Switch to draft
+        copy_as_draft:
+          title: Copy as draft
+          name: Copy as draft
+        publish:
+          title: Publish
+          name: Publish
+
+    draft_status:
+      draft: Draft

data/config/locales/rails_admin_draft/fr.yml

@@ -0,0 +1,36 @@
+fr:
+  admin:
+    actions:
+      copy_as_draft:
+        title: Dupliquer en brouillon "%{object_label}"
+        menu: Dupliquer en brouillon
+        breadcrumb: Dupliquer en brouillon
+        success: dupliqué(e) en brouillon
+      publish:
+        success: publié(e)
+      switch_to_draft:
+        success: basculé(e) en brouillon
+
+    scopes:
+      rails_admin_all: Tous
+      rails_admin_draft: Brouillons
+      rails_admin_published: Publiés
+
+    form:
+      draft_header: Brouillon
+      buttons:
+        save_draft:
+          title: Enregistrer au statut brouillon. Ne sera pas visible sur le site public.
+          name: Enregistrer le brouillon
+        switch_to_draft:
+          title: Basculer au statut brouillon. Ne sera plus visible sur le site public.
+          name: Basculer en brouillon
+        copy_as_draft:
+          title: Faire une copie au statut brouillon. Cette copie remplacera l'originale lorsque publiée. L'originale reste visible sur le site public.
+          name: Dupliquer en brouillon
+        publish:
+          title: Rendre visible sur le site public.
+          name: Publier
+
+    draft_status:
+      draft: Brouillon

data/lib/generators/draft_migration_generator.rb

@@ -0,0 +1,22 @@
+class DraftMigrationGenerator < Rails::Generators::Base
+  class_option :table, type: :string, required: true
+
+  def create_draft_migration_file
+    table = options['table'].downcase
+    id_type = table.capitalize.constantize.columns_hash['id'].type
+    id_unsigned = table.capitalize.constantize.columns_hash['id'].sql_type.include?('unsigned')
+
+    filename = "db/migrate/#{Time.current.strftime("%Y%m%d%H%M%S")}_add_draft_to_#{table}.rb"
+    table_name = table.pluralize
+    create_file(filename, <<-FILE
+class AddDraftTo#{table_name.capitalize} < ActiveRecord::Migration[7.0]
+  def change
+    add_column :#{table_name}, :draft_status, :string, null: true, default: DraftStatus::DRAFT
+    add_column :#{table_name}, :draft_source_id, :#{id_type}, null: true#{id_unsigned ? ', unsigned: true' : nil }
+    add_foreign_key :#{table_name}, :#{table_name}, column: :draft_source_id, name: :fk_#{table_name}_draft_source_id, on_delete: :cascade, on_update: :cascade
+  end
+end
+    FILE
+    )
+  end
+end

data/lib/rails_admin_draft/concern/draft_concern.rb

@@ -0,0 +1,126 @@
+module DraftConcern
+  extend ActiveSupport::Concern
+
+  included do
+    amoeba do
+      enable
+    end
+
+    # == Attributes ===========================================================
+    enum draft_status: [DraftStatus::DRAFT, DraftStatus::PUBLISHED].index_with { |cs| cs.to_s }
+
+    # == Validations ==========================================================
+    validates_presence_of :draft_status
+
+    # == Scopes ===============================================================
+    scope :draft, -> { where(draft_status: DraftStatus::DRAFT) }
+    scope :published, -> { where(draft_status: DraftStatus::PUBLISHED) }
+    scope :rails_admin_all, -> { includes(:draft) }
+    scope :rails_admin_draft, -> { rails_admin_all.draft }
+    scope :rails_admin_published, -> { rails_admin_all.published }
+
+    # == Instance Methods =====================================================
+    # Adds 'draft' to your model's title if it's a draft. Used to display in rails_admin listing.
+    def title_with_draft_status
+      title = self.send(self.class.title_attribute)
+      return "#{title} - <i style='color: grey;'>#{I18n.t('admin.draft_status.draft')}</i>".html_safe if self.is_draft?
+      return title
+    end
+
+    # Returns whether the record is a draft
+    def is_draft?
+      return self.draft_status == DraftStatus::DRAFT
+    end
+
+    # Returns whether the record is published
+    def is_published?
+      return self.draft_status == DraftStatus::PUBLISHED
+    end
+
+    # Makes a draft copy of the record if it is published
+    def copy_as_draft
+      return if self.is_draft?
+
+      clone = Draft::CloneService.new(model: self).perform
+      clone.draft_status = DraftStatus::DRAFT
+      clone.draft_source_id = self.id
+      add_draft_on_unique_text_fields(clone)
+      clone.save!
+
+      return clone
+    end
+
+    # Publish the record. Overwrite the source record if present.
+    def publish
+      return if !self.is_draft?
+      model_to_publish = self
+
+      ActiveRecord::Base.transaction do
+        if self.draft_source_id.present?
+          model_to_publish = Draft::OverwriteService.new(source: self, destination: self.draft_source).perform
+          model_to_publish.slug = self.slug # Keep same slug
+          if Object.const_defined?('DiscardConcern') && self.class.include?('DiscardConcern'.constantize)
+            self.destroy(true)
+          else
+            self.destroy
+          end
+          remove_draft_on_unique_text_fields(model_to_publish)
+        end
+
+        model_to_publish.draft_status = DraftStatus::PUBLISHED
+        model_to_publish.save!
+      end
+
+      return model_to_publish
+    end
+
+    private
+
+      def add_draft_on_unique_text_fields(model)
+        return if !self.class.unique_text_fields.present?
+
+        self.class.unique_text_fields.each do |field|
+          next if !model[field].present? || !model[field].is_a?(String)
+          model[field] = "#{DraftStatus::DRAFT}-#{model[field]}"
+        end
+      end
+
+      def remove_draft_on_unique_text_fields(model)
+        return if !self.class.unique_text_fields.present?
+
+        self.class.unique_text_fields.each do |field|
+          next if !model[field].present? || !model[field].is_a?(String) || !model[field].match(/^#{Regexp.quote(DraftStatus::DRAFT)}-*./,)
+          model[field] = model[field].remove("#{DraftStatus::DRAFT}-")
+        end
+      end
+
+  end
+
+  class_methods do
+    # Creates bi-directional association for draft source.
+    def set_draft_relation(klass_name:)
+      association_class_name = klass_name.to_s
+      class_eval do
+        has_one :draft, class_name: "#{association_class_name}", foreign_key: :draft_source_id, inverse_of: :draft_source
+        belongs_to :draft_source, class_name: "#{association_class_name}", optional: true
+      end
+    end
+
+    # List of string fields that are unique. When you copy a published record as draft, the string 'draft-' will be added at the beginning of each field to avoid unique constraint errors. The string 'draft-' is removed when the record is published.
+    def unique_text_fields
+      return [:slug]
+    end
+
+    # When you copy a record as draft, its uploads are also copied. To prevent an upload of being copied, add it to this list. You can also add attributes in associated tables.
+    # Ex: [ :image, { relation_name: :sub_pages, attribute: :image } ]
+    def except_upload_attributes
+      return []
+    end
+
+    # The attribute that represent the title/name of the record. Used by the `title_with_draft_status` method.
+    def title_attribute
+      return :title
+    end
+
+  end
+end

data/lib/rails_admin_draft/configuration.rb

@@ -0,0 +1,19 @@
+module RailsAdminDraft
+  class Configuration
+
+    def initialize(abstract_model)
+      @abstract_model = abstract_model
+    end
+
+    def draft?
+      draft.present?
+    end
+
+    protected
+
+      def draft
+        @has_draft ||= ::RailsAdmin::Config.model(@abstract_model.model).has_draft
+      end
+
+  end
+end

data/lib/rails_admin_draft/engine.rb

@@ -0,0 +1,10 @@
+require 'rails'
+require 'rails_admin_draft'
+
+module RailsAdminDraft
+  class Engine < ::Rails::Engine
+    initializer "RailsAdminDraft precompile hook", group: :all do |app|
+      app.config.assets.precompile += %w(rails_admin/rails_admin_draft.css)
+    end
+  end
+end

data/lib/rails_admin_draft/model.rb

@@ -0,0 +1,12 @@
+
+module RailsAdmin
+  module Config
+    class Model
+
+      register_instance_option :has_draft do
+        nil
+      end
+
+    end
+  end
+end

data/lib/rails_admin_draft/rails_admin/config/actions/copy_as_draft.rb

@@ -0,0 +1,42 @@
+module RailsAdmin
+  module Config
+    module Actions
+      class CopyAsDraft < Base
+        RailsAdmin::Config::Actions.register(self)
+
+        register_instance_option :member do
+          true
+        end
+
+        register_instance_option :http_methods do
+          [:get]
+        end
+
+        register_instance_option :controller do
+          Proc.new do
+            new_draft = @object.copy_as_draft
+            action_message = t('admin.actions.copy_as_draft.success')
+            flash[:success] = t('admin.flash.successful', name: @model_config.label, action: action_message)
+            redirect_to edit_path(params[:model_name], new_draft.id)
+          end
+        end
+
+        register_instance_option :template_name do
+          :new
+        end
+
+        register_instance_option :link_icon do
+          'fas fa-file-circle-plus'
+        end
+
+        register_instance_option :pjax? do
+          false
+        end
+
+        register_instance_option :visible? do
+          bindings[:object].respond_to?(:is_published?) && bindings[:object].respond_to?(:draft_source_id) && bindings[:object].is_published? && !bindings[:object].draft.present?
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_draft/rails_admin/config/actions/edit.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module RailsAdmin
+  module Config
+    module Actions
+      class Edit < RailsAdmin::Config::Actions::Base
+        RailsAdmin::Config::Actions.register(self)
+
+        register_instance_option :member do
+          true
+        end
+
+        register_instance_option :http_methods do
+          %i[get put]
+        end
+
+        register_instance_option :controller do
+          proc do
+            if request.get? # EDIT
+              @draft_conf = ::RailsAdminDraft::Configuration.new @abstract_model
+
+              respond_to do |format|
+                format.html { render @action.template_name }
+                format.js   { render @action.template_name, layout: 'rails_admin/modal', content_type: Mime[:html].to_s }
+              end
+
+            elsif request.put? # UPDATE
+              sanitize_params_for!(request.xhr? ? :modal : :update)
+
+              @object.assign_attributes(params[@abstract_model.param_key])
+              @authorization_adapter&.authorize(:update, @abstract_model, @object)
+              changes = @object.changes
+
+              if params[:_publish]
+                @object = @object.publish
+                custom_action_name = 'publish'
+              elsif params[:_switch_to_draft]
+                @object.draft_status = DraftStatus::DRAFT
+                custom_action_name = 'switch_to_draft'
+              elsif params[:_copy_as_draft]
+                @object = @object.copy_as_draft
+                custom_action_name = 'copy_as_draft'
+              end
+
+              if @object.save
+                @auditing_adapter&.update_object(@object, @abstract_model, _current_user, changes)
+
+                if custom_action_name.present?
+                  flash[:success] = t('admin.flash.successful', name: @model_config.label, action: t("admin.actions.#{custom_action_name}.success"))
+                  redirect_to edit_path(params[:model_name], @object.id)
+                else
+                  respond_to do |format|
+                    format.html { redirect_to_on_success }
+                    format.json { render json: { id: @object.id.to_s, label: @model_config.with(object: @object).object_label } }
+                  end
+                end
+              else
+                handle_save_error :edit
+              end
+
+            end
+          end
+        end
+
+        register_instance_option :link_icon do
+          'fas fa-pencil-alt'
+        end
+
+        register_instance_option :writable? do
+          !(bindings[:object] && bindings[:object].readonly?)
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_draft/rails_admin/config/actions/new.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module RailsAdmin
+  module Config
+    module Actions
+      class New < RailsAdmin::Config::Actions::Base
+        RailsAdmin::Config::Actions.register(self)
+
+        register_instance_option :collection do
+          true
+        end
+
+        register_instance_option :http_methods do
+          %i[get post] # NEW / CREATE
+        end
+
+        register_instance_option :controller do
+          proc do
+            if request.get? # NEW
+
+              @object = @abstract_model.new
+              @action = @action.with(@action.bindings.merge(object: @object))
+              @authorization_adapter&.attributes_for(:new, @abstract_model)&.each do |name, value|
+                @object.send("#{name}=", value)
+              end
+              object_params = params[@abstract_model.param_key]
+              if object_params
+                sanitize_params_for!(request.xhr? ? :modal : :create)
+                @object.assign_attributes(@object.attributes.merge(object_params.to_h))
+              end
+              respond_to do |format|
+                format.html { render @action.template_name }
+                format.js   { render @action.template_name, layout: 'rails_admin/modal', content_type: Mime[:html].to_s }
+              end
+
+            elsif request.post? # CREATE
+
+              @modified_assoc = []
+              @object = @abstract_model.new
+              sanitize_params_for!(request.xhr? ? :modal : :create)
+
+              @object.assign_attributes(params[@abstract_model.param_key])
+              @authorization_adapter&.authorize(:create, @abstract_model, @object)
+
+              if params[:_publish]
+                @object.publish
+                custom_action_name = 'publish'
+              end
+
+              if @object.save
+                @auditing_adapter&.create_object(@object, @abstract_model, _current_user)
+
+                if custom_action_name.present?
+                  flash[:success] = t('admin.flash.successful', name: @model_config.label, action: t("admin.actions.#{custom_action_name}.success"))
+                  redirect_to edit_path(params[:model_name], @object.id)
+                else
+                  respond_to do |format|
+                    format.html { redirect_to_on_success }
+                    format.json { render json: { id: @object.id.to_s, label: @model_config.with(object: @object).object_label } }
+                  end
+                end
+              else
+                handle_save_error
+              end
+
+            end
+          end
+        end
+
+        register_instance_option :link_icon do
+          'fas fa-plus'
+        end
+
+        register_instance_option :writable? do
+          !(bindings[:object] && bindings[:object].readonly?)
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_draft/services/draft/clone_service.rb

@@ -0,0 +1,73 @@
+module Draft
+  class CloneService
+    DRAFT_ASSOCIATIONS = [:draft, :draft_source]
+
+    def initialize(model:)
+      @model = model
+    end
+
+    # Performs the clone. Handled by amoeba, except uploads which are handled manually.
+    def perform
+      clone = @model.amoeba_dup
+      clone_uploads(clone)
+
+      return clone
+    end
+
+    private
+
+      # Clone uploads for the model and its associations (has_one & has_many) excluding except_upload_attributes.
+      def clone_uploads(clone)
+        attributes = upload_attributes(clone.class)
+        return if attributes.blank?
+
+        attributes.each do |attribute|
+          next if !@model.send(attribute).present? || attribute_is_excluded?(attribute)
+          clone.send("#{attribute}=", File.open(@model.send(attribute).file.path))
+        end
+
+        clone_associations_uploads(clone, :has_one)
+        clone_associations_uploads(clone, :has_many)
+      end
+
+      # Clone uploads for the model's associations excluding except_upload_attributes.
+      def clone_associations_uploads(clone, association_type)
+        clone.class.reflect_on_all_associations(association_type).each do |association|
+          next if DRAFT_ASSOCIATIONS.include?(association.name) || association.options[:through].present?
+
+          attributes = upload_attributes(association.class_name.constantize)
+          next if attributes.blank?
+
+          attributes.each do |attribute|
+            relation = @model.send(association.name)
+            next if !relation.present? || attribute_is_excluded?(attribute, association.name)
+
+            if relation.is_a?(ActiveRecord::Associations::CollectionProxy)
+              relation.each_with_index do |relation_instance, index|
+                next if !relation_instance.send(attribute).present?
+                clone.send(association.name)[index].send("#{attribute}=", File.open(relation_instance.send(attribute).file.path))
+              end
+            else
+              next if !relation.send(attribute).present?
+              clone.send(association.name).send("#{attribute}=", File.open(relation.send(attribute).file.path))
+            end
+          end
+        end
+      end
+
+      # Returns the upload attributes for a given class.
+      def upload_attributes(klass)
+        return [] if !klass.respond_to?(:uploaders)
+        return klass.uploaders.keys
+      end
+
+      # Checks if a given attribute is excluded from the clone operation.
+      def attribute_is_excluded?(attribute, relation_name = nil)
+        except_upload_attributes = @model.class.except_upload_attributes
+        return false if !except_upload_attributes.present?
+        return except_upload_attributes.include?(attribute) if relation_name.nil?
+        return except_upload_attributes.include?({ relation_name: relation_name, attribute: attribute })
+      end
+
+  end
+end

data/lib/rails_admin_draft/services/draft/overwrite_service.rb

@@ -0,0 +1,62 @@
+module Draft
+  class OverwriteService
+    DRAFT_ASSOCIATIONS = [:draft, :draft_source]
+
+    def initialize(source:, destination:)
+      raise "Source must be an ActiveRecord::Base" if !source.is_a?(ActiveRecord::Base)
+      raise "Destination must be an ActiveRecord::Base" if !destination.is_a?(ActiveRecord::Base)
+      raise "Source and destination must be of the same type" if source.class != destination.class
+
+      @source = source
+      @destination = destination
+    end
+
+    # Performs the overwrite. Handles attributes, associations and uploads.
+    def perform
+      @destination.assign_attributes(@source.attributes.except("id", "draft_source_id", *upload_attributes.map(&:to_s)))
+      handle_associations(:has_one)
+      handle_associations(:has_many)
+      handle_associations(:has_and_belongs_to_many)
+      handle_uploads
+
+      @destination.save!
+      return @destination.reload
+    end
+
+    private
+
+      # Overwrites the destination associations with the source's. Handles has_one, has_many and has_and_belongs_to_many associations.
+      def handle_associations(association_type)
+        @source.class.reflect_on_all_associations(association_type).each do |association|
+          next if DRAFT_ASSOCIATIONS.include?(association.name) || association.options[:through].present?
+
+          if association_type == :has_and_belongs_to_many
+            @destination.send("#{association.plural_name}=", @source.send("#{association.plural_name}"))
+          else
+            association_model = association.class_name.constantize
+            association_model.where("#{association.foreign_key} = #{@destination.id}").destroy_all
+            association_model.where("#{association.foreign_key} = #{@source.id}").update_all("#{association.foreign_key} = #{@destination.id}")
+          end
+        end
+      end
+
+      # Overwrites the destination uploads with the source's.
+      def handle_uploads
+        attributes = upload_attributes
+        return if attributes.blank?
+
+        attributes.each do |attribute|
+          @destination.send(attribute).remove! if @destination.send(attribute).present?
+          new_upload = @source.send(attribute).present? ? File.open(@source.send(attribute).file.path) : nil
+          @destination.send("#{attribute}=", new_upload)
+        end
+      end
+
+      # Attributes that contain an uploader.
+      def upload_attributes
+        return [] if !@source.class.respond_to?(:uploaders)
+        return @source.class.uploaders.keys
+      end
+
+  end
+end

data/lib/rails_admin_draft/version.rb

@@ -0,0 +1,3 @@
+module RailsAdminDraft
+  VERSION = '0.1.1'.freeze
+end

data/lib/rails_admin_draft.rb

@@ -0,0 +1,16 @@
+require 'rails_admin_draft/version'
+require 'rails_admin/config/model'
+require 'rails_admin/config/actions'
+
+require 'rails_admin_draft/configuration'
+require 'rails_admin_draft/model'
+
+require 'rails_admin_draft/concern/draft_concern'
+require 'rails_admin_draft/services/draft/clone_service'
+require 'rails_admin_draft/services/draft/overwrite_service'
+
+require 'rails_admin_draft/rails_admin/config/actions/copy_as_draft'
+require 'rails_admin_draft/rails_admin/config/actions/edit'
+require 'rails_admin_draft/rails_admin/config/actions/new'
+
+load 'rails_admin_draft/engine.rb'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_admin_draft
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Grégory Huet
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-31 00:00:00.000000000 Z
+date: 2023-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -176,6 +176,21 @@ files:
 - app/assets/stylesheets/rails_admin/rails_admin_draft.css
 - app/views/rails_admin/main/_submit_buttons.html.erb
 - app/views/rails_admin/main/edit.html.erb
+- config/initializers/draft_status.rb
+- config/locales/rails_admin_draft/en.yml
+- config/locales/rails_admin_draft/fr.yml
+- lib/generators/draft_migration_generator.rb
+- lib/rails_admin_draft.rb
+- lib/rails_admin_draft/concern/draft_concern.rb
+- lib/rails_admin_draft/configuration.rb
+- lib/rails_admin_draft/engine.rb
+- lib/rails_admin_draft/model.rb
+- lib/rails_admin_draft/rails_admin/config/actions/copy_as_draft.rb
+- lib/rails_admin_draft/rails_admin/config/actions/edit.rb
+- lib/rails_admin_draft/rails_admin/config/actions/new.rb
+- lib/rails_admin_draft/services/draft/clone_service.rb
+- lib/rails_admin_draft/services/draft/overwrite_service.rb
+- lib/rails_admin_draft/version.rb
 homepage: https://github.com/ixmedia/rails_admin_draft
 licenses:
 - MIT