cm-admin 4.1.2 → 4.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08cb28438df1f6c84b31f95bf13779e18a2900e4973fcd7591744284ba791b93'
-  data.tar.gz: 68ecf1bb6702de4a04486dd65213dd997828be32506cf9479322baf853c79fa0
+  metadata.gz: c44311ddd3f0ebf6e1d4f95955770a545780720121c06fda39b9c54d9c9d0daa
+  data.tar.gz: cb582aaa8202e30c06d7c60bdc880d240d6175b4fb7b44d6636509a0a4da9c63
 SHA512:
-  metadata.gz: a5fbf72b4cbef166f981864eba01a34477f72b53171b6745efdf360dacf8b5f3f5e19a4b0d57b31f5eb27d9c821bbcbc5dc750a47468528b293792d8ea435e43
-  data.tar.gz: cc020e41b2cd42e924bb4d2fb9410d30aab5fbcb95baf4366c48ae0ab0e64781584a901e1b83d578a4f726a8e03b7681763be8ebd5d26815d903f9d5782fe8a0
+  metadata.gz: 756da465d4b28250f4f2fd9ea258660fde6fe75354c39c44d29c5081e47f07dbdaf12a42b2adfcd69f4c12cf6ff37c78f67e486ada7d5e34a1967083f3b4894d
+  data.tar.gz: 84d6e56e30f677f9dc996ff708bf43d0a754f2e776a3185ca22771a985a9bb471d7f1d44a62f959c194fc864f32556a45d3142b842a396d0e5e4455ffb82c2d6

data/.gem/credentials

@@ -0,0 +1,5 @@
+---
+:hosts:
+  d83830bbef49f4bc@cm-gems.commutatus.com:
+    :username: d83830bbef49f4bc
+    :password: d83830bbef49f4bc

data/.github/workflows/linters.yml

@@ -19,9 +19,11 @@ jobs:
           rubocop_extensions: rubocop-rails:2.26.2
           github_token: ${{ secrets.GITHUB_TOKEN }}
           reporter: github-pr-check # Possible values are github-pr-check, github-pr-review
+          fail_level: none
+          fail_on_error: false
       - uses: actions/checkout@v4
       - name: stylelint
         uses: reviewdog/action-stylelint@v1
         with:
-         reporter: github-pr-review # Change reporter.
-         stylelint_input: '**/*.scss'
+          reporter: github-pr-review # Change reporter.
+          stylelint_input: "**/*.scss"

data/.github/workflows/release-cm-gem.yml

@@ -0,0 +1,105 @@
+name: Bump Gem to CM Gems
+
+on:
+  workflow_dispatch:
+    inputs:
+      bump_type:
+        type: choice
+        description: "Bump Type ( Choosing None will bump build number and keep the same version )"
+        default: "patch"
+        options:
+          - patch
+          - minor
+          - major
+
+permissions:
+  contents: read
+
+jobs:
+  # build:
+  #   name: Build gem
+  #   runs-on: ubuntu-latest
+
+  #   permissions:
+  #     id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
+  #     contents: write # IMPORTANT: this permission is required for `rake release` to push the release tag
+
+  #   steps:
+  #     # Set up
+  #     - uses: actions/checkout@v4
+
+  #     - name: set git config
+  #       env:
+  #         GH_TOKEN: ${{ github.token }}
+  #       run: |
+  #         git config --global user.email "${GITHUB_ACTOR_ID}+${GITHUB_ACTOR}@users.noreply.github.com"
+  #         git config --global user.name "$(gh api /users/${GITHUB_ACTOR} | jq .name -r)"
+  #         git config -l
+  #     - name: Set up Ruby
+  #       uses: ruby/setup-ruby@v1
+  #       with:
+  #         bundler-cache: true
+  #         ruby-version: ruby
+
+  #     - name: Install the gem-release
+  #       run: gem install gem-release
+
+  #     - name: Bump the gem
+  #       run: gem bump --version ${{ github.event.inputs.bump_type }} -p
+
+  #     - name: Remove lock on bundle
+  #       run: bundle config set frozen false
+
+  #     - name: Bundle Install
+  #       run: bundle install
+
+  #     - name: Git Add files
+  #       run: git add Gemfile.lock
+
+  #     - name: Git Commit
+  #       run: git commit -m "Add bundle files"
+
+  #     - name: Push the new version
+  #       run: git push origin ${{ github.ref_name }}
+
+  release:
+    name: Release gem
+    runs-on: ubuntu-latest
+    # needs: build
+    permissions:
+      id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
+      contents: write # IMPORTANT: this permission is required for `rake release` to push the release tag
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Git Pull
+        run: git pull
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby
+          bundler-cache: true
+
+      - name: Remove lock on bundle
+        run: bundle config set frozen false
+
+      - name: Update Rubygems
+        run: |
+          gem install rubygems-update
+          update_rubygems
+          gem update --system
+
+      - name: Build gem
+        run: |
+          gem build cm_admin.gemspec
+          GEM_FILE=$(ls *.gem | tail -n 1)
+          echo "GEM_FILE=$GEM_FILE" >> $GITHUB_ENV
+
+      - name: Push gem
+        env:
+          GEM_FILE: ${{ env.GEM_FILE }}
+          CM_GEMS_HOST: ${{ vars.CM_GEMS_HOST }}
+        run: |
+          gem push $GEM_FILE --host $CM_GEMS_HOST

data/.rubocop.yml

@@ -1,2 +1,2 @@
 inherit_from:
-  - https://raw.githubusercontent.com/commutatus/cm-linters/main/rubocop.yml
+  - https://raw.githubusercontent.com/commutatus/cm-linters/main/rubocop.yml

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    cm-admin (4.1.2)
+    cm-admin (4.2.1)
       caxlsx_rails
       cocoon (~> 1.2.15)
-      csv-importer (~> 0.8.2)
+      csv (>= 3.3.0)
+      csv-importer (>= 0.8.2)
       importmap-rails
       local_time (~> 3.0.2)
       pagy (~> 4.11.0)
@@ -111,6 +112,7 @@ GEM
     concurrent-ruby (1.3.4)
     connection_pool (2.4.1)
     crass (1.0.6)
+    csv (3.3.0)
     csv-importer (0.8.2)
       virtus
     date (3.3.4)

data/app/assets/javascripts/cm_admin/exports.js

@@ -1,33 +1,52 @@
-$(document).on('click', '.export-to-file-btn', function(e) {
-  e.preventDefault();
-  var query_param = window.location.href.split("?")[1]
-  var action = $('#export-to-file-form').get(0).getAttribute('action')
-  $('#export-to-file-form').get(0).setAttribute('action', action + '?' + query_param);
-  $("#export-to-file-form").submit();
+$(document).on("click", '[data-behaviour="export-select-all"]', function (e) {
+  if ($(this).is(":checked")) {
+    $('[data-behaviour="export-checkbox"]').prop("checked", true);
+  } else {
+    $('[data-behaviour="export-checkbox"]').prop("checked", false);
+  }
 });
 
-$(document).on(
-  "click",
-  '[data-behaviour="export-select-all"]',
-  function (e) {
-    if($(this).is(':checked')){
-      $('[data-behaviour="export-checkbox"]').prop('checked', true)
-      
-    } else {
-      $('[data-behaviour="export-checkbox"]').prop('checked', false)
-    }
+$(document).on("click", '[data-behaviour="export-checkbox"]', function (e) {
+  const container = $(this).closest(".row");
+  if (
+    container.find('[data-behaviour="export-checkbox"]:checked').length ==
+    container.find('[data-behaviour="export-checkbox"]').length
+  ) {
+    $('[data-behaviour="export-select-all"]').prop("checked", true);
+  } else {
+    $('[data-behaviour="export-select-all"]').prop("checked", false);
   }
-);
+});
 
-$(document).on(
-  "click",
-  '[data-behaviour="export-checkbox"]',
-  function (e) {
-    const container = $(this).closest('.row');
-    if (container.find('[data-behaviour="export-checkbox"]:checked').length == container.find('[data-behaviour="export-checkbox"]').length) {
-      $('[data-behaviour="export-select-all"]').prop('checked', true);
-    } else {
-      $('[data-behaviour="export-select-all"]').prop('checked', false);
-    }
-  }
-);
+$(document).on("click", '[data-behaviour="export-submit"]', function (e) {
+  $('[data-behaviour="export-form-submit"]').submit();
+  const exportFormBody = $("[data-behaviour='export-form-container']");
+  const exportProcessing = $("[data-behaviour='export-processing']");
+  const exportTitle = $("[data-behaviour='export-modal-title']");
+  const exportFooter = $("[data-behaviour='export-modal-footer']");
+  const exportContent = $("[data-behaviour='export-modal-content']");
+  exportTitle.html("Export Processing");
+  exportFormBody.addClass("hidden");
+  exportFooter.addClass("hidden");
+  exportProcessing.removeClass("hidden");
+  exportContent.removeClass("export-modal-content");
+  exportContent.addClass("modal-content");
+});
+
+document.addEventListener("turbo:load", function () {
+  document
+    .querySelector('[data-behaviour="export-modal"]')
+    .addEventListener("hidden.bs.modal", function () {
+      const exportFormBody = $("[data-behaviour='export-form-container']");
+      const exportProcessing = $("[data-behaviour='export-processing']");
+      const exportTitle = $("[data-behaviour='export-modal-title']");
+      const exportFooter = $("[data-behaviour='export-modal-footer']");
+      const exportContent = $("[data-behaviour='export-modal-content']");
+      exportTitle.html("Export Data");
+      exportProcessing.addClass("hidden");
+      exportFormBody.removeClass("hidden");
+      exportFooter.removeClass("hidden");
+      exportContent.addClass("export-modal-content");
+      exportContent.removeClass("modal-content");
+    });
+});

data/app/assets/stylesheets/cm_admin/base/form.scss

@@ -50,10 +50,11 @@
 
 .field-label {
   @extend .form-label;
-  &.required-label::after {
-    content: " *";
-    color: $red;
-  }
+}
+
+.required-label::after {
+  content: " *";
+  color: $red;
 }
 
 .field-control {
@@ -77,8 +78,6 @@
   }
 }
 
-
-
 //Form card UI
 .form-card {
   @extend .card, .mt-3;
@@ -164,7 +163,7 @@
 
   .bulk-action-button {
     @extend .d-flex, .align-items-center, .gap-2;
-  
+
     &:hover {
       text-decoration: none;
     }
@@ -175,4 +174,4 @@
     gap: 8px;
     align-items: center;
   }
-}
+}

data/app/assets/stylesheets/cm_admin/base/navbar.scss

@@ -7,30 +7,17 @@
       line-height: 22px;
     }
   }
-
   &__actions {
-    @extend .d-flex.align-items-start;
-    .export-container {
-      position: relative;
-      .export-popup {
-        top: 45px;
-        width: 156px;
-        padding: 8px 0;
-        animation: fadeIn 0.2s ease-in-out;
-        .popup-option {
-          padding: 8px 16px;
-          @include font($size: $t4-text, $color: $primary-text-clr);
-          line-height: 22px;
-          transition: all 0.2s linear;
-          cursor: pointer;
-          &:hover {
-            background-color: $grey-lighter-clr;
-          }
-          span {
-            margin-right: 8px;
-          }
-        }
-      }
-    }
+    @include flex();
   }
 }
+
+.export-container {
+  position: relative;
+  margin: 0 24px 0 auto;
+}
+
+.export-modal-content {
+  @extend .modal-content;
+  height: 80vh;
+}

data/app/assets/stylesheets/cm_admin/base/show.scss

@@ -52,7 +52,7 @@
       }
     }
   }
-  .filters-bar {
+  .cm-index-page__filters {
     background-color: $grey-lightest-clr;
   }
 }

data/app/assets/stylesheets/cm_admin/base/table.scss

@@ -16,7 +16,7 @@
   }
 
   &__filters {
-    // If you want to overwrite filters styles ---> add styles here
+    @include flex(row, space-between, center);
   }
 
   &__table-container {

data/app/assets/stylesheets/cm_admin/components/_buttons.scss

@@ -40,6 +40,10 @@
   @extend .btn, .btn-primary, .btn-sm, .btn-icon-spacing, .disabled;
 }
 
+.cm-admin .btn-dark {
+  @extend .btn, .btn-outline-dark, .btn-sm;
+}
+
 // button mixin - We can use if needed
 // @include button-variant($background: #6554e0, $border: #6554e0);
 

data/app/controllers/cm_admin/application_controller.rb

@@ -1,13 +1,5 @@
 module CmAdmin
   class ApplicationController < ::ActionController::Base
-    
-    # before_action :check_cm_admin
     layout 'cm_admin'
-
-
-    def check_cm_admin
-      redirect_to CmAdmin::Engine.mount_path + '/access-denied' unless defined?(::Current) && ::Current.cm_admin_user
-    end
-
   end
 end

data/app/controllers/cm_admin/exports_controller.rb

@@ -6,9 +6,20 @@ require 'cm_admin/view_helpers'
 
 module CmAdmin
   class ExportsController < ApplicationController
-    def export
-      file_path = CmAdmin::Models::Export.generate_excel(params[:class_name], params, helpers)
-      send_file file_path, disposition: 'attachment'
+    before_action :set_current_user_permission
+
+    def send_export_email
+      export_params = params.permit(:select_all, :class_name, :associated_class_name, :parent_id, :child_records,
+                                    :action_name, :filters, columns: []).to_h
+      associated_model_name = params[:associated_class_name].presence || params[:class_name]
+      expires_at = DateTime.now + 1.day
+      FileExport.create!(associated_model_name:, exported_by: Current.user, expires_at:, params: export_params)
+    end
+
+    private
+
+    def set_current_user_permission
+      CmCurrent.user_permissions = Current.user.cm_role.cm_permissions if Current.user.cm_role.present?
     end
   end
 end

data/app/controllers/cm_admin/resource_controller.rb

@@ -8,11 +8,6 @@ module CmAdmin
     skip_before_action :verify_authenticity_token, only: :reset_sort_columns
     before_action :set_current_user_permission
 
-
-    def set_current_user_permission
-      CmCurrent.user_permissions = Current.user.cm_role.cm_permissions if Current.user.cm_role.present?
-    end
-
     def cm_index(params)
       @current_action = CmAdmin::Models::Action.find_by(@model, name: 'index')
       # Based on the params the filter and pagination object to be set
@@ -138,7 +133,7 @@ module CmAdmin
 
           if @action.execution_mode.to_sym == :individual
             flash[:bulk_action_success] = "#{@bulk_action_processor.success_records.size} rows were successful for #{action_name}" if @bulk_action_processor.success_records.present?
-            flash[:alert] = "<b>#{@bulk_action_processor.invalid_records.size} rows were unsuccessful for #{action_name}</b>"  
+            flash[:alert] = "<b>#{@bulk_action_processor.invalid_records.size} rows were unsuccessful for #{action_name}</b>"
             flash[:bulk_action_error] = "<div>
               <div>
                 <div><b>#{@bulk_action_processor.invalid_records.size} rows were unsuccessful for #{action_name}</b></div>
@@ -151,7 +146,7 @@ module CmAdmin
               <div><b>#{action_name} encountered the following errors:</b></div>
               <ul>#{error_messages}</ul>
             </div>"
-          end          
+          end
           format.html { redirect_to request.referrer}
         end
       end
@@ -322,7 +317,6 @@ module CmAdmin
                           end
 
       @associated_ar_object = if child_records.is_a? ActiveRecord::Relation
-
                                 filter_by(params, child_records, parent_record: @ar_object, filter_params: @associated_model.filter_params(params))
                               else
                                 child_records
@@ -444,6 +438,10 @@ module CmAdmin
 
     private
 
+    def set_current_user_permission
+      CmCurrent.user_permissions = Current.user.cm_role.cm_permissions if Current.user.cm_role.present?
+    end
+
     def attachment_fields(model_object)
       model_object.reflect_on_all_associations.map do |reflection|
         next if reflection.options[:polymorphic]

data/app/jobs/generate_export_file_job.rb

@@ -0,0 +1,15 @@
+class GenerateExportFileJob < ApplicationJob
+  queue_as :default
+
+  def perform(file_export)
+    Current.user = file_export.exported_by
+    CmCurrent.user_permissions = Current.user.cm_role.cm_permissions if Current.user.cm_role.present?
+
+    file_export.attach_export_file
+    ExportMailer.export_email(file_export).deliver_now
+    file_export.success!
+  rescue StandardError => e
+    file_export&.failed!
+    raise e
+  end
+end

data/app/mailers/export_mailer.rb

@@ -0,0 +1,22 @@
+class ExportMailer < ApplicationMailer
+  def export_email(file_export)
+    set_current_for_development
+    expires_in = (file_export.expires_at - Time.now).to_i
+    @model = file_export.associated_model_name&.pluralize
+    @link = file_export.export_file.url(expires_in:)
+    @expires_at = file_export.expires_at.utc
+    mail(to: file_export&.exported_by&.email, subject: "#{@model} Export is ready for download")
+  end
+
+  private
+
+  def set_current_for_development
+    return unless Rails.env.development?
+
+    url = Rails.application.credentials[:be_url]
+    host = URI.parse(url).host
+    protocol = URI.parse(url).scheme
+    port = URI.parse(url).port
+    ActiveStorage::Current.url_options = { host:, protocol:, port: }
+  end
+end

data/app/models/concerns/exportable.rb

@@ -0,0 +1,97 @@
+module Exportable
+  extend ActiveSupport::Concern
+
+  def attach_export_file
+    file_path = generate_excel
+    filename = file_path&.split('/')&.last
+    export_file.attach(io: File.open(file_path), filename:)
+  rescue StandardError => e
+    failed!
+    raise e
+  end
+
+  def generate_excel
+    params = self.params.with_indifferent_access
+    klass_name = params[:class_name]
+    associated_klass_name = params[:associated_class_name]
+    action_name = params[:action_name] || 'index'
+
+    model = CmAdmin::Model.find_by({ name: klass_name })
+    klass = klass_name.constantize
+    current_action = CmAdmin::Models::Action.find_by(model, name: action_name)
+
+    if associated_klass_name.present? && params[:parent_id].present?
+      scoped_model = "CmAdmin::#{model.name}Policy::#{action_name.classify}Scope".constantize.new(Current.user, klass).resolve
+      parent_model = model
+      model = CmAdmin::Model.find_by({ name: associated_klass_name })
+      parent_record = fetch_ar_object(scoped_model, params[:parent_id])
+      child_records = parent_record.send(params[:child_records])
+    end
+    selected_column_names = params[:columns] || []
+    records = if associated_klass_name.present?
+                child_records
+              else
+                "CmAdmin::#{klass_name}Policy::Scope".constantize.new(Current.user, klass).resolve
+              end
+    records.includes(current_action.eager_load_associations) if current_action.eager_load_associations.present?
+    filter_params = JSON.parse(params[:filters] || '{}')
+    filtered_data = CmAdmin::Models::Filter.filtered_data(filter_params, records, model.filters)
+    formatted_data = format_records(filtered_data, model, selected_column_names, parent_model:, action_name:)
+    file_path = "#{Rails.root}/tmp/#{model.name}_data_#{DateTime.now.strftime('%Y-%m-%d_%H-%M-%S')}.xlsx"
+    create_workbook(model, formatted_data, file_path)
+    file_path
+  end
+
+  def exportable_columns(klass, action_name: :index)
+    klass.available_fields[action_name].select(&:exportable)
+  end
+
+  private
+
+  def fetch_ar_object(model_object, id)
+    return model_object.friendly.find(id) if model_object.respond_to?(:friendly)
+
+    model_object.find(id)
+  end
+
+  def format_records(records, model, selected_column_names, parent_model:, action_name: :index)
+    deserialized_columns = CmAdmin::Utils.deserialize_csv_columns(selected_column_names, :as_json_params)
+    main_model = parent_model || model
+    available_fields = main_model.available_fields[action_name.to_sym]
+    # This includes isn't recursve, a full solution should be recursive
+    records_arr = []
+    records.includes(deserialized_columns[:include].keys).find_each do |record|
+      record_hash = record.as_json({ only: selected_column_names.map(&:to_sym) })
+      selected_column_names.each do |column_name|
+        break unless available_fields.map(&:field_name).include?(column_name.to_sym)
+
+        column = CmAdmin::Models::Column.find_by(model, :index, { name: column_name.to_sym })
+        record_hash[column.field_name] = if column.field_type == :custom
+                                           send(column.helper_method, record, column.field_name).to_s
+                                         else
+                                           record.send(column.field_name).to_s
+                                         end
+      end
+      records_arr << record_hash
+    end
+    records_arr
+  end
+
+  def create_workbook(cm_model, records, file_path)
+    flattened_records = records.map { |record| CmAdmin::Utils.flatten_hash(record) }
+    columns = exportable_columns(cm_model).select do |column|
+      flattened_records.first.keys.include?(column.field_name.to_s)
+    end
+    size_arr = []
+    columns.size.times { size_arr << 22 }
+    xl = Axlsx::Package.new
+    xl.workbook.add_worksheet do |sheet|
+      sheet.add_row columns&.map(&:header), b: true
+      flattened_records.each do |record|
+        sheet.add_row(columns.map { |column| record[column.field_name.to_s] })
+      end
+      sheet.column_widths(*size_arr)
+    end
+    xl.serialize(file_path)
+  end
+end

data/app/models/file_export.rb

@@ -0,0 +1,17 @@
+class FileExport < ApplicationRecord
+  include CmAdmin::CustomHelper
+  include Exportable
+
+  enum :status, { in_progress: 0, success: 1, failed: 2 }
+
+  has_one_attached :export_file
+  belongs_to :exported_by, polymorphic: true
+
+  after_create :generate_export_file
+
+  private
+
+  def generate_export_file
+    GenerateExportFileJob.perform_later(self)
+  end
+end

data/app/views/cm_admin/main/_associated_table.html.slim

@@ -60,3 +60,5 @@
   .pagination-bar
     p.count-text.m-0 Showing #{number_with_delimiter(@associated_ar_object.pagy.from.to_i)} to #{number_with_delimiter(@associated_ar_object.pagy.to.to_i)} out of #{number_with_delimiter(@associated_ar_object.pagy.count.to_i)}
     == render partial: 'cm_admin/main/cm_pagy_nav', locals: { pagy: @associated_ar_object.pagy }
+
+= export_modal(@model, action_name: @action.name.to_sym, associated_klass: @associated_model)

data/app/views/cm_admin/main/_card.html.slim

@@ -55,5 +55,5 @@
     p.count-text.m-0 Showing #{@ar_object.pagy.from} to #{@ar_object.pagy.to} out of #{@ar_object.pagy.count}
     == render partial: 'cm_admin/main/cm_pagy_nav', locals: { pagy: @ar_object.pagy }
 
-= column_pop_up(@model)
+= export_modal(@model)
 = manage_column_pop_up(@model)

data/app/views/cm_admin/main/_kanban.html.slim

@@ -13,5 +13,5 @@
   .btn.btn-primary.kanban-show-more data-page=1 Show more
 = render partial: 'cm_admin/main/show_as_drawer'
 
-= column_pop_up(@model)
+= export_modal(@model)
 = manage_column_pop_up(@model)

data/app/views/cm_admin/main/_table.html.slim

@@ -53,5 +53,5 @@
     p.count-text.m-0 Showing #{number_with_delimiter(@ar_object.pagy.from.to_i)} to #{number_with_delimiter(@ar_object.pagy.to.to_i)} out of #{number_with_delimiter(@ar_object.pagy.count.to_i)}
     == render partial: 'cm_admin/main/cm_pagy_nav', locals: { pagy: @ar_object.pagy }
 
-= column_pop_up(@model)
+= export_modal(@model)
 = manage_column_pop_up(@model)

data/app/views/cm_admin/main/_top_navbar.html.slim

@@ -6,16 +6,6 @@
     h4 = action_title
   .entity-header__actions
     - if @model.current_action.name == 'index'
-      - if has_valid_policy(@ar_object, :export)
-        .export-container
-          .dropdown
-            button.btn-secondary.dropdown-toggle data-bs-toggle='dropdown'
-              i.fa.fa-arrow-down
-              | Export
-            ul.dropdown-menu.export-popup
-              li
-                .popup-option.pointer data-bs-toggle='modal' data-bs-target='#exportmodal'
-                  span Export
       - if @model.importer && has_valid_policy(@ar_object, :importable)
         = link_to 'Import', cm_admin.send(:"cm_import_#{@model.name.underscore}_path"), class: 'btn-primary ms-2'
       - new_action = @model.available_actions.select{|act| act if act.action_type.eql?(:default) && act.name.eql?('new')}

data/app/views/cm_admin/main/associated_index.html.slim

@@ -1,5 +1,3 @@
 .cm-index-page.associated-index
-	.cm-index-page__table-container
-		== render partial: 'cm_admin/main/associated_table'
-
-	// = column_pop_up(@associated_model)
+  .cm-index-page__table-container
+    == render partial: 'cm_admin/main/associated_table'

data/app/views/cm_admin/main/index.html.slim

@@ -1,15 +1,19 @@
-
 = hidden_field_tag :view_type, (@current_action.view_type || params[:view_type])
 .cm-index-page.cm-page-container
   .sticky-container.page-top-bar
     == render 'cm_admin/main/top_navbar'
-    - if @model.filters.present? && @action.partial.nil?
+    - if (@model.filters.present? || has_valid_policy(@ar_object, :export)) && @action.partial.nil?
       .cm-index-page__filters
         == render partial: 'cm_admin/main/filters', locals: { filters: @model.filters }
+        - if has_valid_policy(@ar_object, :export)
+          .export-container
+            button.btn-dark data-bs-toggle="modal" data-bs-target="#exportModal"
+              i.fa-regular.fa-file-export.me-1
+              | Export
   .cm-index-page__table-container
     - if @action.partial
       == render @action.partial
-    - elsif params[:view_type] == 'table' || @current_action.view_type == :table 
+    - elsif params[:view_type] == 'table' || @current_action.view_type == :table
       == render 'cm_admin/main/table'
     - elsif params[:view_type] == 'card' || @current_action.view_type == :card
       == render "cm_admin/#{@model.name.underscore}/card"

data/app/views/export_mailer/export_email.html.slim

@@ -0,0 +1,19 @@
+table style="background: #F2F4F6; padding: 56px 0px; width: 100%; border-spacing: 24px;"
+  tr
+    td colspan="3" style="text-align: center; margin-bottom: 24px;"
+      img src="#{Rails.configuration.x.project_settings.logo_url}" alt="logo" style="height: auto; width: 50px;"
+  tr style="width: fit-content; style=width: 100px;"
+    td
+    td style="background: #fff; padding: 40px; padding-bottom: 56px;"
+      p style="color: #333333; font-weight: 700; font-size: 24px; line-height: 36px; margin: 0; margin-bottom: 24px;"
+        = "#{@model} Export is ready"
+      div style="margin-bottom: 40px;"
+        p
+          | The download link will expire at <strong>#{@expires_at.strftime("%H:%M:%S")} UTC</strong> on <strong>#{@expires_at.strftime("%d %B %Y")}.</strong>
+        p Make sure to save the file before the link expires.
+      a style="border: none; background: #6D0094; color: #fff; padding: 16px 32px; width: fit-content; border-radius: 5px; text-decoration: none;" href="#{@link}"
+        | Download Excel
+    td
+  tr
+    td colspan="3" style="text-align: center; color: #5F6166; font-size: 16px; margin-top: 24px;"
+      = "© #{Time.current.year} #{Rails.configuration.x.project_settings.name}"

data/app/views/layouts/cm_admin.html.slim

@@ -26,12 +26,12 @@ html
     script src="https://kit.fontawesome.com/9c93dde7a7.js" data-mutate-approach="sync"
     = stylesheet_link_tag 'cm_admin/custom', media: 'all', 'data-turbo-track': 'reload'
     link href="https://cdn.jsdelivr.net/npm/select2@4.1.0-rc.0/dist/css/select2.min.css" rel="stylesheet" /
-    
+
     script src="https://raw.githack.com/SortableJS/Sortable/master/Sortable.js"
 
     link[rel="stylesheet" href="https://cdn.jsdelivr.net/npm/select2-bootstrap-5-theme@1.3.0/dist/select2-bootstrap-5-theme.min.css"]
     link[rel="stylesheet" href="https://cdn.jsdelivr.net/npm/select2-bootstrap-5-theme@1.3.0/dist/select2-bootstrap-5-theme.rtl.min.css"]
-    
+
   body
     - if CmAdmin.config.enable_tracking
       / Google Tag Manager (noscript)
@@ -54,13 +54,20 @@ html
               == render 'cm_admin/main/top_navbar'
               - if @ar_object.model_name
                 == render 'cm_admin/main/tabs', via_xhr: false
-              - if @associated_model && @associated_model.filters.present?
-                .filters-bar
-                  == render partial: 'cm_admin/main/filters', locals: { filters: @associated_model.filters }
+              - if @associated_model && (@associated_model.filters.present? || has_valid_policy(@associated_ar_object, :export))
+                .cm-index-page__filters
+                  .filters-bar
+                    == render partial: 'cm_admin/main/filters', locals: { filters: @associated_model.filters }
+                  - if has_valid_policy(@associated_ar_object, :export)
+                    .export-container
+                      button.btn-dark data-bs-toggle="modal" data-bs-target="#exportModal"
+                        i.fa-regular.fa-file-export.me-1
+                        | Export
             = yield
         - else
           = yield
     div data-behaviour="flash-container"
     = render 'layouts/cm_flash_message'
+    div data-behaviour="export-modal-container"
     - unless (@current_action&.view_type == :kanban || params[:view_type] == 'kanban')
       = render 'layouts/custom_action_modals'

data/app/views/layouts/mailer.html.slim

@@ -0,0 +1,6 @@
+doctype html
+html
+  head
+    meta content="text/html; charset=UTF-8" http-equiv="Content-Type"
+  body
+    == yield

data/cm_admin.gemspec

@@ -10,13 +10,14 @@ Gem::Specification.new do |spec|
   spec.description   = 'CmAdmin providing a streamlined and efficient solution for building customized admin panels within the context of Rails applications. Its robust features empower developers to effortlessly generate and manage administrative interfaces with precision and ease.'
   spec.homepage      = 'https://github.com/commutatus/cm-admin'
   spec.license       = 'MIT'
-  spec.required_ruby_version = '>= 2.7.0'
+  spec.required_ruby_version = '>= 3.3.0'
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 
   spec.metadata = {
     'homepage_uri' => spec.homepage,
-    'source_code_uri' => 'https://github.com/commutatus/cm-admin'
+    'source_code_uri' => 'https://github.com/commutatus/cm-admin',
+    'github_repo' => 'ssh://github.com/commutatus/cm-admin'
   }
   # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
 
@@ -30,11 +31,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.add_runtime_dependency 'caxlsx_rails'
   spec.add_runtime_dependency 'cocoon', '~> 1.2.15'
-  spec.add_runtime_dependency 'csv-importer', '~> 0.8.2'
+  spec.add_runtime_dependency 'csv-importer', '>= 0.8.2'
   spec.add_runtime_dependency 'local_time', '~> 3.0.2'
   spec.add_runtime_dependency 'pagy', '~> 4.11.0'
   spec.add_runtime_dependency 'pundit', '~> 2.2.0'
   spec.add_runtime_dependency 'rails', '>= 7.0'
   spec.add_runtime_dependency 'slim', '>= 4.1.0'
+  spec.add_runtime_dependency 'csv', '>= 3.3.0'
   spec.add_dependency 'importmap-rails'
 end

data/config/routes.rb

@@ -5,7 +5,7 @@ CmAdmin::Engine.routes.draw do
   end
 
   controller 'exports' do
-    post '/export_to_file', action: 'export'
+    post '/send_export_email', action: 'send_export_email'
   end
 
   # Defining action routes for each model

data/lib/cm_admin/models/export.rb

@@ -2,62 +2,9 @@ module CmAdmin
   module Models
     class Export
       class << self
-        def generate_excel(klass_name, params, helpers)
-          klass = klass_name.constantize
-          selected_column_names = params[:columns] || []
-          # filter_params = params[:filters]
-          model = CmAdmin::Model.find_by({name: klass_name})
-          # records = get_records(klass, model, columns, helpers)
-          records = "CmAdmin::#{klass_name}Policy::Scope".constantize.new(Current.user, klass).resolve
-          filtered_data = CmAdmin::Models::Filter.filtered_data(model.filter_params(params), records, model.filters)
-          formatted_data = format_records(filtered_data, model, selected_column_names, helpers)
-          file_path = "#{Rails.root}/tmp/#{klass}_data_#{DateTime.now.strftime("%Y-%m-%d_%H-%M-%S")}.xlsx"
-          create_workbook(model, formatted_data, selected_column_names, file_path)
-          return file_path
+        def exportable_columns(klass, action_name: :index)
+          klass.available_fields[action_name].select(&:exportable)
         end
-
-        def format_records(records, model, selected_column_names, helpers)
-          deserialized_columns = CmAdmin::Utils.deserialize_csv_columns(selected_column_names, :as_json_params)
-          # This includes isn't recursve, a full solution should be recursive
-          records_arr = []
-          records.includes(deserialized_columns[:include].keys).find_each do |record|
-            record_hash = record.as_json({ only: selected_column_names.map(&:to_sym) })
-            selected_column_names.each do |column_name|
-              break unless model.available_fields[:index].map(&:field_name).include?(column_name.to_sym)
-
-              column = CmAdmin::Models::Column.find_by(model, :index, { name: column_name.to_sym })
-              if column.field_type == :custom
-                record_hash[column.field_name] = helpers.send(column.helper_method, record, column.field_name).to_s
-              else
-                record_hash[column.field_name] = record.send(column.field_name).to_s
-              end
-            end
-            records_arr << record_hash
-          end
-          records_arr
-        end
-
-        def create_workbook(cm_model, records, _class_name, file_path)
-          flattened_records = records.map { |record| CmAdmin::Utils.flatten_hash(record) }
-          # columns = flattened_records.map{|x| x.keys}.flatten.uniq.sort
-          columns = exportable_columns(cm_model).select { |column| flattened_records.first.keys.include?(column.field_name.to_s) }
-          size_arr = []
-          columns.size.times { size_arr << 22 }
-          xl = Axlsx::Package.new
-          xl.workbook.add_worksheet do |sheet|
-            sheet.add_row columns&.map(&:header), b: true
-            flattened_records.each do |record|
-              sheet.add_row(columns.map { |column| record[column.field_name.to_s] })
-            end
-            sheet.column_widths(*size_arr)
-          end
-          xl.serialize(file_path)
-        end
-
-        def exportable_columns(klass)
-          klass.available_fields[:index].select(&:exportable)
-        end
-
       end
     end
   end

data/lib/cm_admin/version.rb

@@ -1,3 +1,3 @@
 module CmAdmin
-  VERSION = '4.1.2'
+  VERSION = '4.2.1'
 end

data/lib/cm_admin/view_helpers.rb

@@ -15,66 +15,84 @@ module CmAdmin
     include ActionView::Helpers::TagHelper
     include ActionView::Helpers::NumberHelper
 
-    def exportable(_klass, html_class: [])
-      tag.a 'Export as excel', class: html_class.append('filter-btn modal-btn me-2'), data: { toggle: 'modal', target: '#exportmodal' } do
-        concat tag.i class: 'fa fa-download'
-        concat tag.span ' Export'
-      end
-    end
-
-    def column_pop_up(klass, required_filters = nil)
-      tag.div class: 'modal fade form-modal', id: 'exportmodal', role: 'dialog', aria: { labelledby: 'exportModal' } do
-        tag.div class: 'modal-dialog modal-lg', role: 'document' do
-          tag.div class: 'modal-content' do
-            concat pop_ups(klass, required_filters)
+    def export_modal(klass, action_name: :index, associated_klass: nil, required_filters: nil)
+      has_default_email = Rails.configuration.x.project_settings.default_from_email.present?
+      tag.div class: 'modal fade form-modal', id: 'exportModal', role: 'dialog', data: { behaviour: 'export-modal' },  aria: { labelledby: 'exportModalLabel' } do
+        tag.div class: 'modal-dialog modal-dialog-centered modal-dialog-scrollable', role: 'document' do
+          tag.div class: "#{has_default_email ? 'export-modal-content' : 'modal-content'}", data: { behaviour: 'export-modal-content' } do
+            if has_default_email
+              modal_content(klass, action_name, associated_klass, required_filters)
+            else
+              modal_content_with_error
+            end
           end
         end
       end
     end
 
-    def pop_ups(klass, required_filters)
-      tag.div do
-        concat pop_up_header
-        concat pop_up_body(klass, required_filters)
-      end
+    def modal_content(klass, action_name, associated_klass, required_filters)
+      concat modal_header
+      concat modal_body(klass, action_name, associated_klass)
+      concat modal_footer
     end
 
-    def pop_up_header
+    def modal_header
       tag.div class: 'modal-header' do
-        tag.button type: 'button', class: 'close', data: { dismiss: 'modal' }, aria: { label: 'Close' } do
-          tag.span 'X', aria: { hidden: 'true' }
-        end
-        tag.h4 'Select columns to export', class: 'modal-title', id: 'exportModal'
+        concat tag.h5 'Export Data', class: 'modal-title', id: 'exportModalLabel', data: { behaviour: 'export-modal-title' }
+        concat tag.button type: 'button', class: 'btn-close', data: { bs_dismiss: 'modal' }, aria: { label: 'Close' }
       end
     end
 
-    def pop_up_body(klass, _required_filters)
-      tag.div class: 'modal-body' do
-        form_tag cm_admin.send('export_to_file_path'), id: 'export-to-file-form', style: 'width: 100%;', class: 'cm-admin-csv-export-form' do
-          concat(content_tag(:div, class: 'column export-select-container') do
-            concat check_box_tag('select_all', '1', false, data: { behaviour: 'export-select-all' })
-            concat 'All'
+    def modal_body(klass, action_name, associated_klass)
+      tag.div class: 'modal-body', data: { behaviour: 'export-modal-body-form' } do
+        form_tag cm_admin.send('send_export_email_path'), id: 'export-to-file-form', style: 'width: 100%;', class: 'cm-admin-csv-export-form', data: { turbo: false, behaviour: 'export-form-submit' } do
+          concat tag.p 'You’ll receive the exported file in your email soon.', class: 'hidden', data: { behaviour: 'export-processing' }
+          concat(content_tag(:div, class: 'export-form-container', data: { behaviour: 'export-form-container' }) do
+            concat tag.label 'Select columns to export', class: 'required-label mb-2'
+            concat(content_tag(:div, class: 'column export-select-container') do
+              concat check_box_tag('select_all', '1', false, class: 'form-check-input', data: { behaviour: 'export-select-all' })
+              concat 'All'
+            end)
+            concat hidden_field_tag 'class_name', klass.name.to_s
+            concat hidden_field_tag 'associated_class_name', associated_klass&.name.to_s.presence
+            concat hidden_field_tag 'parent_id', params[:id]
+            concat hidden_field_tag 'child_records', @current_action.child_records
+            concat hidden_field_tag 'action_name', @current_action.name
+            concat hidden_field_tag 'filters', params[:filters].to_json
+            concat checkbox_row(klass, action_name)
           end)
-          concat hidden_field_tag 'class_name', klass.name.to_s, id: 'export-to-file-klass'
-          concat checkbox_row(klass)
-          concat tag.hr
-          # TODO: export-to-file-btn class is used for JS functionality, Have to remove
-          concat submit_tag 'Export', class: 'btn-primary export-to-file-btn'
         end
       end
     end
 
-    def checkbox_row(klass)
+    def modal_footer
+      tag.div class: 'modal-footer', data: { behaviour: 'export-modal-footer' } do
+        concat tag.button 'Close', type: 'button', class: 'btn btn-secondary', data: { bs_dismiss: 'modal' }
+        concat tag.button 'Export', type: 'submit', class: 'btn btn-primary', data: { behaviour: 'export-submit' }
+      end
+    end
+
+    def modal_content_with_error
+      concat(content_tag(:div, class: 'modal-header') do
+        concat tag.h5 'Export Data', class: 'modal-title', id: 'exportModalLabel', data: { behaviour: 'export-modal-title' }
+        concat tag.button type: 'button', class: 'btn-close', data: { bs_dismiss: 'modal' }, aria: { label: 'Close' }
+      end)
+      concat(content_tag(:div, class: 'modal-body') do
+        p "Your application does not have a default sender, so we can't send out any emails, please contact a developer."
+      end)
+    end
+
+    def checkbox_row(klass, action_name)
       tag.div class: 'row' do
-        CmAdmin::Models::Export.exportable_columns(klass).each do |column|
+        CmAdmin::Models::Export.exportable_columns(klass, action_name:).each do |column|
           concat create_checkbox(column)
         end
       end
     end
 
     def create_checkbox(column)
-      tag.div class: 'col-md-4' do
-        concat check_box_tag('columns[]', column.field_name, false, id: column.field_name.to_s.gsub('/', '-'), data: { behaviour: 'export-checkbox' })
+      tag.div do
+        concat check_box_tag('columns[]', column.field_name, false, id: column.field_name.to_s.gsub('/', '-'), class: 'form-check-input', data: { behaviour: 'export-checkbox' })
         concat " #{column.header.to_s.gsub('/', '_').humanize}"
       end
     end

data/lib/generators/cm_admin/install_generator.rb

@@ -14,6 +14,7 @@ module CmAdmin
         copy_file 'application_policy.rb', 'app/policies/application_policy.rb'
         route 'mount CmAdmin::Engine => "/admin"'
         generate 'migration', 'CreateFileImport associated_model_name:string added_by:references{polymorphic} error_report:jsonb completed_at:datetime status:integer'
+        generate 'migration', 'CreateFileExport associated_model_name:string exported_by:references{polymorphic} expires_at:datetime status:integer params:jsonb'
         rake 'db:migrate'
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cm-admin
 version: !ruby/object:Gem::Version
-  version: 4.1.2
+  version: 4.2.1
 platform: ruby
 authors:
 - Michael
@@ -11,10 +11,10 @@ authors:
 - Pranav
 - Mahaveer
 - Austin
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-03 00:00:00.000000000 Z
+date: 2024-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: caxlsx_rails
@@ -48,14 +48,14 @@ dependencies:
   name: csv-importer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.2
 - !ruby/object:Gem::Dependency
@@ -128,6 +128,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: importmap-rails
   requirement: !ruby/object:Gem::Requirement
@@ -158,17 +172,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gem/credentials"
 - ".github/CODEOWNERS"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/config.yml"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/workflows/deploy-yard-docs.yml"
 - ".github/workflows/linters.yml"
+- ".github/workflows/release-cm-gem.yml"
 - ".github/workflows/release-gem.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".rubocop-https---raw-githubusercontent-com-commutatus-cm-linters-main-rubocop-yml"
 - ".rubocop.yml"
 - ".stylelintrc.json"
 - ".vscode/settings.json"
@@ -347,12 +362,16 @@ files:
 - app/helpers/cm_admin/custom_helper.rb
 - app/helpers/cm_admin/permission_helper.rb
 - app/jobs/file_import_processor_job.rb
+- app/jobs/generate_export_file_job.rb
+- app/mailers/export_mailer.rb
 - app/models/cm_current.rb
 - app/models/cm_permission.rb
 - app/models/cm_role.rb
 - app/models/concerns/cm_admin/bulk_action_processor.rb
 - app/models/concerns/cm_admin/cm_role.rb
 - app/models/concerns/cm_admin/file_import.rb
+- app/models/concerns/exportable.rb
+- app/models/file_export.rb
 - app/models/file_import.rb
 - app/policies/cm_admin/file_import_policy.rb
 - app/views/cm_admin/main/_actions_dropdown.html.slim
@@ -387,6 +406,7 @@ files:
 - app/views/cm_admin/static/dashboard.html.slim
 - app/views/cm_admin/static/error_401.html.slim
 - app/views/cm_admin/static/error_403.html.slim
+- app/views/export_mailer/export_email.html.slim
 - app/views/layouts/_cm_flash_message.html.slim
 - app/views/layouts/_custom_action_modal.html.slim
 - app/views/layouts/_custom_action_modals.html.slim
@@ -395,6 +415,7 @@ files:
 - app/views/layouts/_left_sidebar_nav.html.slim
 - app/views/layouts/_quick_links.html.slim
 - app/views/layouts/cm_admin.html.slim
+- app/views/layouts/mailer.html.slim
 - app/views/layouts/static.html.slim
 - bin/console
 - bin/importmap
@@ -485,7 +506,8 @@ licenses:
 metadata:
   homepage_uri: https://github.com/commutatus/cm-admin
   source_code_uri: https://github.com/commutatus/cm-admin
-post_install_message: 
+  github_repo: ssh://github.com/commutatus/cm-admin
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -493,7 +515,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -501,7 +523,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.22
-signing_key: 
+signing_key:
 specification_version: 4
 summary: CmAdmin is a robust gem designed to assist in creating admin panels for Rails
   applications

data/.rubocop-https---raw-githubusercontent-com-commutatus-cm-linters-main-rubocop-yml

@@ -1,20 +0,0 @@
-AllCops:
-  DisabledByDefault: false
-
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Layout/IndentationStyle:
-  Enabled: false
-
-Layout/LineLength:
-  Enabled: false
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/AbcSize:
-  Enabled: false