effective_reports 0.1.0

data/app/views/admin/reports/_form_report.html.haml

@@ -0,0 +1,194 @@
+= effective_form_with(model: [:admin, report], engine: true) do |f|
+  = f.text_field :title
+  = f.text_area :description
+
+  - if f.object.new_record?
+    = f.select :reportable_class_name, EffectiveReports.reportable_classes.map(&:name), label: 'Resource',
+      'data-load-ajax-url': effective_reports.new_admin_report_path,
+      'data-load-ajax-div': '#effective-reports-ajax'
+  - else
+    = f.static_field :reportable_class_name, label: 'Resource'
+
+  #effective-reports-ajax
+    -# Attributes
+    - attributes = f.object.reportable_attributes
+    - attributes_collection = reportable_attributes_collection(attributes)
+
+    - value_booleans = attributes.select { |_, type| type == :boolean }.keys
+    - value_dates = attributes.select { |_, type| type == :date }.keys
+    - value_decimals = attributes.select { |_, type| type == :decimal }.keys
+    - value_integers = attributes.select { |_, type| type == :integer }.keys
+    - value_prices = attributes.select { |_, type| type == :price }.keys
+    - value_strings = attributes.select { |_, type| type == :string }.keys
+
+    - value_belong_tos = attributes.select { |_, type| type == :belongs_to }.keys
+    - value_belong_to_polymorphics = attributes.select { |_, type| type == :belongs_to_polymorphic }.keys
+    - value_has_manys = attributes.select { |_, type| type == :has_many }.keys
+    - value_has_ones = attributes.select { |_, type| type == :has_one }.keys
+
+    -# Scopes
+    - scopes = f.object.reportable_scopes
+    - scopes_collection = reportable_scopes_collection(scopes)
+
+    - if attributes.present?
+      %h2 Report Columns
+
+      = f.has_many :report_columns do |frc|
+        .card.mb-2
+          .card-body.pb-2
+            .row
+              .col-md-4
+                = frc.select :name, attributes_collection, grouped: true, required: false, label: false
+              .col
+                = frc.show_if_any(:name, value_booleans) do
+
+                  .row
+                    .col.mt-2
+                      = frc.check_box :filter, label: 'Filter by this column'
+                      = frc.hidden_field :as, value: :boolean
+
+                    .col.effective-report-filter{style: ('display: none;' unless frc.object.filter?)}
+                      = frc.select :operation, reportable_operations_collection(:boolean), label: false
+
+                    .col.effective-report-filter{style: ('display: none;' unless frc.object.filter?)}
+                      = frc.radios :value_boolean, reportable_boolean_collection, label: false, buttons: true
+
+                = frc.show_if_any(:name, value_dates) do
+                  .row
+                    .col.mt-2
+                      = frc.check_box :filter, label: 'Filter by this column'
+                      = frc.hidden_field :as, value: :date
+
+                    .col.effective-report-filter{style: ('display: none;' unless frc.object.filter?)}
+                      = frc.select :operation, reportable_operations_collection(:date), label: false
+
+                    .col.effective-report-filter{style: ('display: none;' unless frc.object.filter?)}
+                      = frc.date_field :value_date, label: false
+
+                = frc.show_if_any(:name, value_decimals) do
+                  .row
+                    .col.mt-2
+                      = frc.check_box :filter, label: 'Filter by this column'
+                      = frc.hidden_field :as, value: :decimal
+
+                    .col.effective-report-filter{style: ('display: none;' unless frc.object.filter?)}
+                      = frc.select :operation, reportable_operations_collection(:decimal), label: false
+
+                    .col.effective-report-filter{style: ('display: none;' unless frc.object.filter?)}
+                      = frc.float_field :value_decimal, label: false
+
+                = frc.show_if_any(:name, value_integers) do
+                  .row
+                    .col.mt-2
+                      = frc.check_box :filter, label: 'Filter by this column'
+                      = frc.hidden_field :as, value: :integer
+
+                    .col.effective-report-filter{style: ('display: none;' unless frc.object.filter?)}
+                      = frc.select :operation, reportable_operations_collection(:integer), label: false
+
+                    .col.effective-report-filter{style: ('display: none;' unless frc.object.filter?)}
+                      = frc.integer_field :value_integer, label: false
+
+                = frc.show_if_any(:name, value_prices) do
+                  .row
+                    .col.mt-2
+                      = frc.check_box :filter, label: 'Filter by this column'
+                      = frc.hidden_field :as, value: :price
+
+                    .col.effective-report-filter{style: ('display: none;' unless frc.object.filter?)}
+                      = frc.select :operation, reportable_operations_collection(:price), label: false
+
+                    .col.effective-report-filter{style: ('display: none;' unless frc.object.filter?)}
+                      = frc.price_field :value_price, label: false
+
+                = frc.show_if_any(:name, value_strings) do
+                  .row
+                    .col.mt-2
+                      = frc.check_box :filter, label: 'Filter by this column'
+                      = frc.hidden_field :as, value: :string
+
+                    .col.effective-report-filter{style: ('display: none;' unless frc.object.filter?)}
+                      = frc.select :operation, reportable_operations_collection(:string), label: false
+
+                    .col.effective-report-filter{style: ('display: none;' unless frc.object.filter?)}
+                      = frc.text_field :value_string, label: false
+
+                = frc.show_if_any(:name, value_belong_tos) do
+                  .row
+                    .col.mt-2
+                      = frc.check_box :filter, label: 'Filter by this column'
+                      = frc.hidden_field :as, value: :belongs_to
+
+                    .col.effective-report-filter{style: ('display: none;' unless frc.object.filter?)}
+                      = frc.select :operation, reportable_operations_collection(:belongs_to), label: false
+
+                    .col.effective-report-filter{style: ('display: none;' unless frc.object.filter?)}
+                      = frc.text_field :value_associated, label: false
+
+                = frc.show_if_any(:name, value_belong_to_polymorphics) do
+                  .row
+                    .col.mt-2
+                      = frc.check_box :filter, label: 'Filter by this column'
+                      = frc.hidden_field :as, value: :belongs_to_polymorphic
+
+                    .col.effective-report-filter{style: ('display: none;' unless frc.object.filter?)}
+                      = frc.select :operation, reportable_operations_collection(:belongs_to_polymorphic), label: false
+
+                    .col.effective-report-filter{style: ('display: none;' unless frc.object.filter?)}
+                      = frc.text_field :value_associated, label: false
+
+
+                = frc.show_if_any(:name, value_has_manys) do
+                  .row
+                    .col.mt-2
+                      = frc.check_box :filter, label: 'Filter by this column'
+                      = frc.hidden_field :as, value: :has_many
+
+                    .col.effective-report-filter{style: ('display: none;' unless frc.object.filter?)}
+                      = frc.select :operation, reportable_operations_collection(:has_many), label: false
+
+                    .col.effective-report-filter{style: ('display: none;' unless frc.object.filter?)}
+                      = frc.text_field :value_associated, label: false
+
+                = frc.show_if_any(:name, value_has_ones) do
+                  .row
+                    .col.mt-2
+                      = frc.check_box :filter, label: 'Filter by this column'
+                      = frc.hidden_field :as, value: :has_one
+
+                    .col.effective-report-filter{style: ('display: none;' unless frc.object.filter?)}
+                      = frc.select :operation, reportable_operations_collection(:has_one), label: false
+
+                    .col.effective-report-filter{style: ('display: none;' unless frc.object.filter?)}
+                      = frc.text_field :value_associated, label: false
+
+    - if scopes.present?
+      %h2 Report Scopes
+
+      = f.has_many :report_scopes do |frs|
+        .card.mb-2
+          .card-body.pb-2
+            .row
+              .col
+                = frs.select :name, scopes_collection, grouped: true, required: false, label: false
+              .col
+                - scopes.select { |scope, type| type.present? }.each do |scope, type|
+                  = frs.show_if(:name, scope) do
+                    = frs.hidden_field :advanced, value: true
+
+                    - if type == :boolean
+                      = frs.radios :value_boolean, reportable_boolean_collection, label: 'Value', buttons: true, required: true, label: false
+                    - elsif type == :date
+                      = frs.date_field :value_date, label: 'Value', required: true, label: false
+                    - elsif type == :decimal
+                      = frs.date_field :value_decimal, label: 'Value', required: true, label: false
+                    - elsif type == :integer
+                      = frs.integer_field :value_integer, label: 'Value', required: true, label: false
+                    - elsif type == :price
+                      = frs.price_field :value_price, label: 'Value', required: true, label: false
+                    - elsif type == :string
+                      = frs.text_field :value_string, label: 'Value', required: true, label: false
+                    - else
+                      - raise("Unexpected scope datatype: #{type || 'nil'}")
+
+  = effective_submit(f)

data/app/views/admin/reports/_layout.html.haml

@@ -0,0 +1,2 @@
+.effective-reports
+  = yield

data/app/views/admin/reports/_report.html.haml

@@ -0,0 +1,17 @@
+- if report.description.present?
+  %p= report.description.to_s
+
+- if report.filtered_report_columns.present? || report.report_scopes.present?
+  %p The results of this report have been filtered by the following:
+
+- if report.filtered_report_columns.present?
+  %p= badges(report.filtered_report_columns.map(&:to_s))
+
+- if report.report_scopes.present?
+  %p= badges(report.report_scopes.map(&:to_s))
+
+= collapse('Show SQL') do
+  %p= report.collection.to_sql
+
+- datatable = EffectiveReportDatatable.new(report: report)
+= render_datatable(datatable)

data/config/effective_reports.rb

@@ -0,0 +1,37 @@
+EffectiveReports.setup do |config|
+  config.reports_table_name = :reports
+  config.report_columns_table_name = :report_columns
+  config.report_scopes_table_name = :report_scopes
+
+  # Layout Settings
+  # Configure the Layout per controller, or all at once
+  # config.layout = { application: 'application', admin: 'admin' }
+
+  # Reports Settings
+  # Configure the class responsible for the reports.
+  # This should extend from Effective::Reports
+  # config.reports_class_name = 'Effective::Reports'
+
+  # Reportable Class Names
+  # The following classes will be available to build reports from
+  # They must define acts_as_reportable to be included
+  config.reportable_class_names = ['User', 'Effective::Order']
+
+  # Mailer Settings
+  # Please see config/initializers/effective_reports.rb for default effective_* gem mailer settings
+  #
+  # Configure the class responsible to send e-mails.
+  # config.mailer = 'Effective::ReportsMailer'
+  #
+  # Override effective_resource mailer defaults
+  #
+  # config.parent_mailer = nil      # The parent class responsible for sending emails
+  # config.deliver_method = nil     # The deliver method, deliver_later or deliver_now
+  # config.mailer_layout = nil      # Default mailer layout
+  # config.mailer_sender = nil      # Default From value
+  # config.mailer_admin = nil       # Default To value for Admin correspondence
+  # config.mailer_subject = nil     # Proc.new method used to customize Subject
+
+  # Will work with effective_email_templates gem
+  config.use_effective_email_templates = true
+end

data/config/routes.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+Rails.application.routes.draw do
+  mount EffectiveReports::Engine => '/', as: 'effective_reports'
+end
+
+EffectiveReports::Engine.routes.draw do
+  # Public routes
+  scope module: 'effective' do
+  end
+
+  namespace :admin do
+    resources :reports
+  end
+
+end

data/db/migrate/01_create_effective_reports.rb.erb

@@ -0,0 +1,54 @@
+class CreateEffectiveReports < ActiveRecord::Migration[6.0]
+  def change
+    create_table <%= @reports_table_name %> do |t|
+      t.integer :created_by_id
+      t.string :created_by_type
+
+      t.string :title
+      t.text :description
+
+      t.string :reportable_class_name
+
+      t.timestamps
+    end
+
+    create_table <%= @report_columns_table_name %> do |t|
+      t.integer :report_id
+
+      t.string :name
+      t.integer :position
+
+      t.string :as
+
+      t.boolean :filter
+      t.string :operation
+
+      t.text :value_associated
+      t.boolean :value_boolean
+      t.date :value_date
+      t.decimal :value_decimal
+      t.integer :value_integer
+      t.integer :value_price
+      t.string :value_string
+
+      t.timestamps
+    end
+
+    create_table <%= @report_scopes_table_name %> do |t|
+      t.integer :report_id
+
+      t.string :name
+      t.boolean :advanced
+
+      t.boolean :value_boolean
+      t.date :value_date
+      t.decimal :value_decimal
+      t.integer :value_integer
+      t.integer :value_price
+      t.string :value_string
+
+      t.timestamps
+    end
+
+  end
+end

data/db/seeds.rb

@@ -0,0 +1 @@
+puts "Running effective_reports seeds"

data/lib/effective_reports/engine.rb

@@ -0,0 +1,18 @@
+module EffectiveReports
+  class Engine < ::Rails::Engine
+    engine_name 'effective_reports'
+
+    # Set up our default configuration options.
+    initializer 'effective_reports.defaults', before: :load_config_initializers do |app|
+      eval File.read("#{config.root}/config/effective_reports.rb")
+    end
+
+    # Include acts_as_reportable concern and allow any ActiveRecord object to call it
+    initializer 'effective_reports.active_record' do |app|
+      app.config.to_prepare do
+        ActiveRecord::Base.extend(ActsAsReportable::Base)
+      end
+    end
+
+  end
+end

data/lib/effective_reports/version.rb

@@ -0,0 +1,3 @@
+module EffectiveReports
+  VERSION = '0.1.0'.freeze
+end

data/lib/effective_reports.rb

@@ -0,0 +1,27 @@
+require 'effective_resources'
+require 'effective_datatables'
+require 'effective_reports/engine'
+require 'effective_reports/version'
+
+module EffectiveReports
+
+  def self.config_keys
+    [
+      # Database Tables
+      :reports_table_name, :report_columns_table_name, :report_scopes_table_name,
+
+      :reportable_class_names,
+
+      # Effective Gem
+      :layout,
+      :mailer, :parent_mailer, :deliver_method, :mailer_layout, :mailer_sender, :mailer_admin, :mailer_subject, :use_effective_email_templates
+    ]
+  end
+
+  include EffectiveGem
+
+  def self.reportable_classes
+    Array(reportable_class_names).map(&:safe_constantize).select { |klass| klass.try(:acts_as_reportable?) }
+  end
+
+end

data/lib/generators/effective_reports/install_generator.rb

@@ -0,0 +1,32 @@
+module EffectiveReports
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc 'Creates an EffectiveReports initializer in your application.'
+
+      source_root File.expand_path('../../templates', __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 copy_initializer
+        template ('../' * 3) + 'config/effective_reports.rb', 'config/initializers/effective_reports.rb'
+      end
+
+      def create_migration_file
+        @reports_table_name  = ':' + EffectiveReports.reports_table_name.to_s
+        @report_columns_table_name  = ':' + EffectiveReports.report_columns_table_name.to_s
+        @report_scopes_table_name  = ':' + EffectiveReports.report_scopes_table_name.to_s
+
+        migration_template ('../' * 3) + 'db/migrate/01_create_effective_reports.rb.erb', 'db/migrate/create_effective_reports.rb'
+      end
+
+    end
+  end
+end

data/lib/generators/templates/effective_reports_mailer_preview.rb

@@ -0,0 +1,4 @@
+# Visit http://localhost:3000/rails/mailers
+
+class EffectiveReportsMailerPreview < ActionMailer::Preview
+end

data/lib/tasks/effective_reports_tasks.rake

@@ -0,0 +1,8 @@
+namespace :effective_reports do
+
+  # bundle exec rake effective_reports:seed
+  task seed: :environment do
+    load "#{__dir__}/../../db/seeds.rb"
+  end
+
+end