card_load_reports.rb

[geekelo]

FILE

require 'prawn'
require 'prawn/table'

ActiveAdmin.register Card::Load, as: 'CardLoadReport' do
  menu parent: 'Reports', label: 'Card Load Reports'

  config.filters = false
  config.batch_actions = false

  index title: "Card Load Reports by Date Range" do
    panel "Filter Card Load Reports" do
      render 'admin/card_loads/transactions_by_date_form'
    end
    panel "Report Downloads" do
      div do
        link_to "Download Detailed CSV", admin_card_load_reports_path(format: :csv), method: :get
        para "The CSV file contains detailed data for each card load record for the range selected."
        br
        link_to "Download Summary PDF", admin_card_load_reports_path(format: :pdf), method: :get
        para "The PDF file provides a summary overview of the card load for the range selected."
      end
    end
  end

  controller do
    before_action :set_date_range, only: [:index]

    def set_date_range
      @start_date = params.dig(:report, :start_date).present? ? Date.parse(params[:report][:start_date]) : Time.zone.today
      @end_date = params.dig(:report, :end_date).present? ? Date.parse(params[:report][:end_date]) : Time.zone.today
    rescue ArgumentError
      @start_date = Time.zone.today
      @end_date = Time.zone.today
    end

    def index
      @transactions_by_date_range = Card::Load.between_dates(@start_date, @end_date)
      if params.dig(:report, :status).present?
        @transactions_by_date_range = @transactions_by_date_range.where(status: params[:report][:status])
      end

      respond_to do |format|
        format.html
        format.csv { send_data generate_csv(@transactions_by_date_range), filename: "card_load_report.csv" }
        format.pdf { send_data generate_pdf(@transactions_by_date_range), filename: "card_load_summary_report.pdf", type: 'application/pdf' }
      end
    end

    private

    def generate_csv(transactions)
      CSV.generate(headers: true) do |csv|
        csv << ["User ID", "External Id", "Status", "Name", "Email", "Amount", "Total Provider Amount", "Provider Fee", "Bananacrystal Fee", "Total Amount"]
        transactions.each do |cl|
          csv << [
            cl.user_id,
            cl.external_id,
            cl.status,
            cl.user.name,
            cl.user.email,
            cl.amount,
            cl.total_provider_fee,
            cl.provider_fee,
            cl.total_bananacrystal_fee,
            cl.total_amount
          ]
        end
      end
    end

    def generate_pdf(transactions)
      Prawn::Document.new do |pdf|
        pdf.text "Card Load Report Summary", size: 20, style: :bold
        pdf.move_down 10
        pdf.text "Date Range: #{@start_date.strftime('%Y-%m-%d')} to #{@end_date.strftime('%Y-%m-%d')}"
        pdf.move_down 10

        data = [
          ["Metric", "Count"],
          ["Number of Pending Card Loads", transactions.pending.between_dates(@start_date, @end_date).count],
          ["Number of Approved Card Loads", transactions.completed.between_dates(@start_date, @end_date).count],
          ["Total Card Requests", transactions.count]
        ]

        pdf.table(data, header: true) do
          row(0).font_style = :bold
          columns(0..1).align = :center
          self.header = true
          self.column_widths = [200, 200]
          self.row_colors = ["DDDDDD", "FFFFFF"]
        end
      end.render
    end
  end
end

[geekelo]

This file configures the ActiveAdmin interface for managing and generating reports on Card::Load records, referred to as "Card Load Reports." Here's a detailed explanation:

File: card_load_report.rb

1. Dependencies

• require 'prawn' and require 'prawn/table': These are required for generating PDF files using the Prawn library, which is a popular Ruby tool for creating PDFs.

2. ActiveAdmin.register Card::Load, as: 'CardLoadReport' do

• Registers the Card::Load model with ActiveAdmin under the alias CardLoadReport, which will be used for reporting purposes rather than direct CRUD operations.

3. menu parent: 'Reports', label: 'Card Load Reports'

• Places the CardLoadReport resource under the "Reports" menu with the label "Card Load Reports" in the ActiveAdmin interface.

4. config.filters = false

• Disables the default ActiveAdmin filters for this page, as custom filters are implemented.

5. config.batch_actions = false

• Disables batch actions, meaning you can't perform actions on multiple records simultaneously on this page.

Index Page Layout

6. index title: "Card Load Reports by Date Range" do

• Customizes the index page title to "Card Load Reports by Date Range."

• panel "Filter Card Load Reports" do

  • Displays a custom filter panel using a partial view transactions_by_date_form, which presumably allows the user to filter reports by date range and status.

• panel "Report Downloads" do

  • Provides links to download the report in CSV or PDF formats:
    • Download Detailed CSV: Generates and downloads a CSV file with detailed card load data.
    • Download Summary PDF: Generates and downloads a PDF file with a summary of the card load data.

Controller Logic

7. controller do

• This block defines custom controller actions and filters for handling requests.

• before_action :set_date_range, only: [:index]

  • Sets the date range for filtering card loads before the index action runs.

• def set_date_range

  • Extracts the start_date and end_date from the request parameters. If the dates are invalid or missing, it defaults to today's date.

• def index

  • Retrieves Card::Load records within the specified date range and filters them by status if provided.
  • Responds with different formats:
    • HTML: Renders the default HTML view.
    • CSV: Generates a CSV report using the generate_csv method and sends it as a file download.
    • PDF: Generates a PDF summary report using the generate_pdf method and sends it as a file download.

Helper Methods

8. def generate_csv(transactions)

• Generates a CSV file from the given transactions. It includes headers like "User ID", "External Id", "Status", etc., and iterates over each transaction to populate the rows.

9. def generate_pdf(transactions)

• Generates a summary PDF using Prawn. The PDF includes:

  • A title ("Card Load Report Summary") and the date range.
  • A summary table showing:
    • The number of pending card loads.
    • The number of approved card loads.
    • The total number of card requests.

• The table is styled with bold headers, centered text, and alternating row colors.

Summary:

• This file is designed to create a custom report generation tool within the ActiveAdmin interface for Card::Load records.
• The interface allows administrators to filter card load records by date and status and then download detailed or summary reports in CSV or PDF formats.
• The reports are generated on the fly, with data being retrieved based on the user-specified date range and status, ensuring that the information is up-to-date and relevant.
• The use of Prawn for PDF generation allows for customized and well-formatted PDF reports, which can be useful for presenting summarized data in a professional manner.

This setup is ideal for a system that requires detailed and summarized reporting on card load transactions, providing administrators with flexible tools to analyze and export data.