rails_db_admin 3.0.0 → 3.2.0

data/lib/rails_db_admin/services/report_helper.rb

@@ -0,0 +1,241 @@
+module RailsDbAdmin
+  module Services
+    class ReportHelper < AbstractController::Base
+      include AbstractController::Rendering
+      include AbstractController::Helpers
+      include AbstractController::Translation
+      include AbstractController::AssetPaths
+
+      class Cache
+        cattr_accessor :report_resolvers
+      end
+
+      # Renders report for formats
+      #
+      # @param report_iid [String] IID of Report
+      # @param format [Symbol] Format to render the report in (:pdf, :csv)
+      # @param report_params [Hash] Parameters for report
+      def build_report(report_iid, formats=[:pdf, :csv], report_params={})
+        begin
+          @formats = formats
+
+          database_connection_class = RailsDbAdmin::ConnectionHandler.create_connection_class(Rails.env)
+          @query_support = RailsDbAdmin::QuerySupport.new(database_connection_class, Rails.env)
+
+          @report = Report.find_by_internal_identifier(report_iid)
+          @report_params = report_params
+
+          add_report_view_paths
+          build_report_data
+
+          missing_params = check_required_params
+
+          if missing_params.count > 0
+            if missing_params.count == 1
+              "#{missing_params.join(', ')} is required"
+            else
+              "#{missing_params.join(', ')} are required"
+            end
+
+          else
+            file_attachments = []
+
+            if @data[:error]
+              @data[:error]
+            else
+              @formats.each do |format|
+                case format
+                  when :html
+                    data = render inline: @report.template,
+                                  locals: build_tpl_locals
+
+                    file_attachments.push({name: "#{@report.name}.html", data: data})
+
+                  when :pdf
+                    data = render_to_string({
+                                                template: 'base.html.erb',
+                                                locals: build_tpl_locals
+                                            })
+
+                    file_attachments << {
+                        name: "#{@report.name}.pdf",
+                        data: WickedPdf.new.pdf_from_string(data, build_pdf_config)
+                    }
+
+                  when :csv
+                    business_module = @report_params[:business_module_id].present? ? BusinessModule.where(id: @report_params[:business_module_id]).first : nil
+
+                    csv_data = CSV.generate do |csv|
+        
+                      custom_data_columns = []
+                      if @data[:columns].include?('custom_fields')
+
+                        custom_data = JSON.parse(@data[:rows].first['custom_fields'])
+
+                        if business_module
+                          custom_data.each do |field_name, field_value|
+                            custom_data_columns << business_module.organizer_view.selected_fields.where('field_name = ?', field_name).first.label
+                          end
+                        else
+                          custom_data_columns = custom_data.keys
+                        end
+
+                        # remove the custom_fields column if it exists
+                        @data[:columns].delete('custom_fields')
+                      end
+
+                      csv << @data[:columns] + custom_data_columns
+
+                      @data[:rows].each do |row|
+                        custom_values = []
+
+                        custom_fields = row.delete('custom_fields')
+
+                        unless custom_fields.blank?
+                          custom_data = JSON.parse(custom_fields)
+
+                          if business_module
+                            custom_data.each do |field_name, field_value|
+                              case business_module.organizer_view.selected_fields.where('field_name = ?', field_name).first.field_type.internal_identifier
+                                when 'address'
+                                  if field_value.blank?
+                                    custom_values << ''
+                                  else
+                                    custom_values << "#{field_value['address_line_1']} #{field_value['address_line_2']} #{field_value['city']} #{field_value['state']}, #{field_value['zip']} #{field_value['country']}"
+                                  end
+                                else
+                                  custom_values << field_value
+                              end
+
+                            end
+                          else
+                            custom_values = custom_data.values
+                          end
+                        end
+
+                        csv << row.values + custom_values
+                      end
+                    end
+
+                    file_attachments << {
+                        name: "#{@report.name}.csv",
+                        data: csv_data
+                    }
+                  else
+                    raise 'Invalid Format'
+                end
+              end
+
+              file_attachments
+            end
+
+          end
+
+        rescue StandardError => ex
+          Rails.logger.error ex.message
+          Rails.logger.error ex.backtrace.join("\n")
+
+          # email notification
+          ExceptionNotifier.notify_exception(ex) if defined? ExceptionNotifier
+
+          "Error running report"
+        end
+      end
+
+      protected
+
+      # Get the report data by running executing the sql
+      #
+      def build_report_data
+        query = RailsDbAdmin::ErbStringParser.render(
+            @report.query,
+            locals: @report_params
+        )
+        columns, values, error = @query_support.execute_sql(query)
+
+        @data = {:columns => columns, :rows => values, error: error}
+      end
+
+      # build configuration to render a pdf of a report
+      #
+      def build_pdf_config
+        {
+            page_size: @report.meta_data['print_page_size'] || 'A4',
+            orientation: @report.meta_data['print_orientation'] || 'Portrait',
+            margin: {
+                top: (@report.meta_data['print_margin_top'].blank? ? 10 : @report.meta_data['print_margin_top'].to_i),
+                bottom: (@report.meta_data['print_margin_bottom'].blank? ? 10 : @report.meta_data['print_margin_bottom'].to_i),
+                left: (@report.meta_data['print_margin_left'].blank? ? 10 : @report.meta_data['print_margin_left'].to_i),
+                right: (@report.meta_data['print_margin_right'].blank? ? 10 : @report.meta_data['print_margin_right'].to_i),
+
+            },
+            footer: {
+                right: 'Page [page] of [topage]'
+            }
+        }
+      end
+
+      def add_report_view_paths
+        ReportHelper::Cache.report_resolvers = [] if ReportHelper::Cache.report_resolvers.nil?
+
+        report_path = current_report_path
+        resolver = case Rails.application.config.erp_tech_svcs.file_storage
+                     when :s3
+                       path = File.join(report_path[:url], "templates")
+                       cached_resolver = ReportHelper::Cache.report_resolvers.find { |cached_resolver| cached_resolver.to_path == path }
+                       if cached_resolver.nil?
+                         resolver = ActionView::S3Resolver.new(path)
+                         ReportHelper::Cache.report_resolvers << resolver
+                         resolver
+                       else
+                         cached_resolver
+                       end
+                     when :filesystem
+                       path = "#{report_path[:path]}/templates"
+                       cached_resolver = ReportHelper::Cache.report_resolvers.find { |cached_resolver| cached_resolver.to_path == path }
+                       if cached_resolver.nil?
+                         resolver = ActionView::CompassAeFileResolver.new(path)
+                         ReportHelper::Cache.report_resolvers << resolver
+                         resolver
+                       else
+                         cached_resolver
+                       end
+                   end
+
+        prepend_view_path(resolver)
+      end
+
+      def current_report_path
+        {:url => @report.url.to_s, :path => @report.base_dir.to_s}
+      end
+
+      def build_tpl_locals
+        @report_params.merge({
+                                 time_helper: ErpBaseErpSvcs::Helpers::Time::Client.new(@report_params[:client_utc_offset]),
+                                 formats: @formats,
+                                 unique_name: @report,
+                                 title: @report.name,
+                                 columns: @data[:columns],
+                                 rows: @data[:rows]
+                             })
+      end
+
+      def check_required_params
+        missing_params = []
+
+        if @report.meta_data['params']
+          required_params = @report.meta_data['params'].select { |item| item['required'] === true }
+
+          required_params.each do |required_param|
+            if @report_params[required_param['name'].to_sym].blank? || @report_params[required_param['name'].to_sym] == 'null'
+              missing_params.push(required_param['display_name'])
+            end
+          end
+        end
+
+        missing_params
+      end
+
+    end # ReportHelper
+  end # Services
+end # RailsDbAdmin

data/lib/rails_db_admin/version.rb

@@ -1,7 +1,7 @@
 module RailsDbAdmin
   module VERSION #:nodoc:
     MAJOR = 3
-    MINOR = 0
+    MINOR = 2
     TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].compact.join('.')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_db_admin
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Rick Koloski, Russell Holmes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-19 00:00:00.000000000 Z
+date: 2016-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erp_app
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: erp_dev_svcs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
 description: RailsDB Admin is similar in functionality to PHPMyAdmin and other database
   browsing and data editing tools. It uses the CompassAE database connection information
   to discover the schema for an installation, and generates Extjs UIs for creating
@@ -51,51 +51,62 @@ files:
 - GPL-3-LICENSE
 - README.md
 - Rakefile
-- app/assets/javascripts/rails_db_admin/application.js
-- app/assets/stylesheets/rails_db_admin/application.css
+- app/assets/images/icons/rails_db_admin/rails_db_admin_16x16.png
+- app/assets/images/icons/rails_db_admin/rails_db_admin_24x24.png
+- app/assets/images/icons/rails_db_admin/rails_db_admin_32x32.png
+- app/assets/images/icons/rails_db_admin/rails_db_admin_64x64.png
+- app/assets/images/icons/rails_db_admin/rails_db_admin_light_16x16.png
+- app/assets/images/splash/db_admin_splash.png
+- app/assets/images/splash/images/console-icon.png
+- app/assets/images/splash/images/data-model-icon.png
+- app/assets/javascripts/erp_app/desktop/applications/rails_db_admin/app.js
+- app/assets/javascripts/erp_app/desktop/applications/rails_db_admin/database_combo.js
+- app/assets/javascripts/erp_app/desktop/applications/rails_db_admin/module.js
+- app/assets/javascripts/erp_app/desktop/applications/rails_db_admin/queries_tree_menu.js
+- app/assets/javascripts/erp_app/desktop/applications/rails_db_admin/query_panel.js
+- app/assets/javascripts/erp_app/desktop/applications/rails_db_admin/readonly_table_data_grid.js
+- app/assets/javascripts/erp_app/desktop/applications/rails_db_admin/reports/ParamWindow.js
+- app/assets/javascripts/erp_app/desktop/applications/rails_db_admin/reports/ParamsManager.js
+- app/assets/javascripts/erp_app/desktop/applications/rails_db_admin/reports/RolesPanel.js
+- app/assets/javascripts/erp_app/desktop/applications/rails_db_admin/reports/SetDefaultWindow.js
+- app/assets/javascripts/erp_app/desktop/applications/rails_db_admin/reports/Settings.js
+- app/assets/javascripts/erp_app/desktop/applications/rails_db_admin/reports/TreePanel.js
+- app/assets/javascripts/erp_app/desktop/applications/rails_db_admin/splash_screen.js
+- app/assets/javascripts/erp_app/desktop/applications/rails_db_admin/tables_tree_menu.js
+- app/assets/javascripts/erp_app/shared/MultiOption.js
+- app/assets/javascripts/erp_app/shared/ReportsParams.js
+- app/assets/javascripts/erp_app/shared/rails_db_admin_shared.js
+- app/assets/stylesheets/erp_app/shared/rails_db_admin_shared.css
 - app/controllers/rails_db_admin/erp_app/desktop/base_controller.rb
 - app/controllers/rails_db_admin/erp_app/desktop/queries_controller.rb
 - app/controllers/rails_db_admin/erp_app/desktop/reports_controller.rb
 - app/controllers/rails_db_admin/reports/base_controller.rb
+- app/mailers/report_mailer.rb
 - app/models/report.rb
+- app/views/rails_db_admin/reports/base/error_report.erb
 - app/views/rails_db_admin/reports/base/no_report.erb
-- app/views/rails_db_admin/reports/base/show_report.erb
+- app/views/report_mailer/email_report.html.erb
 - config/routes.rb
 - db/data_migrations/20110816005525_rails_db_admin_application.rb
+- db/data_migrations/20151015093724_add_report_role_type.rb
 - db/migrate/20121210160131_add_reports.rb
-- db/migrate/20131112013053_add_rails_db_admin_missing_indexes.rb
+- db/migrate/20150926061259_add_meta_data_to_reports.rb
 - lib/rails_db_admin.rb
 - lib/rails_db_admin/config.rb
 - lib/rails_db_admin/connection_handler.rb
 - lib/rails_db_admin/engine.rb
+- lib/rails_db_admin/erp_string_parser.rb
 - lib/rails_db_admin/extensions/railties/action_view/base.rb
 - lib/rails_db_admin/extensions/railties/action_view/helpers/report_helper.rb
 - lib/rails_db_admin/extjs.rb
 - lib/rails_db_admin/extjs/json_column_builder.rb
 - lib/rails_db_admin/extjs/json_data_builder.rb
+- lib/rails_db_admin/query_params.rb
 - lib/rails_db_admin/query_support.rb
-- lib/rails_db_admin/report_support.rb
+- lib/rails_db_admin/services/report_helper.rb
 - lib/rails_db_admin/table_support.rb
 - lib/rails_db_admin/version.rb
 - lib/tasks/rails_db_admin_tasks.rake
-- public/images/icons/rails_db_admin/rails_db_admin_16x16.png
-- public/images/icons/rails_db_admin/rails_db_admin_24x24.png
-- public/images/icons/rails_db_admin/rails_db_admin_32x32.png
-- public/images/icons/rails_db_admin/rails_db_admin_64x64.png
-- public/images/icons/rails_db_admin/rails_db_admin_light_16x16.png
-- public/images/splash/images/console-icon.png
-- public/images/splash/images/data-model-icon.png
-- public/images/splash/splash.png
-- public/javascripts/erp_app/desktop/applications/rails_db_admin/database_combo.js
-- public/javascripts/erp_app/desktop/applications/rails_db_admin/module.js
-- public/javascripts/erp_app/desktop/applications/rails_db_admin/queries_tree_menu.js
-- public/javascripts/erp_app/desktop/applications/rails_db_admin/query_panel.js
-- public/javascripts/erp_app/desktop/applications/rails_db_admin/readonly_table_data_grid.js
-- public/javascripts/erp_app/desktop/applications/rails_db_admin/report_panel.js
-- public/javascripts/erp_app/desktop/applications/rails_db_admin/reports_tree_panel.js
-- public/javascripts/erp_app/desktop/applications/rails_db_admin/splash_screen.js
-- public/javascripts/erp_app/desktop/applications/rails_db_admin/tables_tree_menu.js
-- public/stylesheets/erp_app/desktop/applications/rails_db_admin/rails_db_admin.css
 - spec/controllers/rails_db_admin/erp_app/desktop/base_controller_spec.rb
 - spec/controllers/rails_db_admin/erp_app/desktop/queries_controller_spec.rb
 - spec/dummy/Rakefile
@@ -149,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: RailsDB Admin is similar in functionality to PHPMyAdmin and other database

data/app/assets/javascripts/rails_db_admin/application.js

@@ -1,9 +0,0 @@
-// This is a manifest file that'll be compiled into including all the files listed below.
-// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
-// be included in the compiled file accessible from http://example.com/assets/application.js
-// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// the compiled file.
-//
-//= require jquery
-//= require jquery_ujs
-//= require_tree .

data/app/assets/stylesheets/rails_db_admin/application.css

@@ -1,7 +0,0 @@
-/*
- * This is a manifest file that'll automatically include all the stylesheets available in this directory
- * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
- * the top of the compiled file, but it's generally better to create a new file per style scope.
- *= require_self
- *= require_tree . 
-*/

data/app/views/rails_db_admin/reports/base/show_report.erb

@@ -1,11 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title><%= @report.name %></title>
-</head>
-<body>
-
-<%= render_report(@report.internal_identifier) %>
-
-</body>
-</html>

data/db/migrate/20131112013053_add_rails_db_admin_missing_indexes.rb

@@ -1,17 +0,0 @@
-class AddRailsDbAdminMissingIndexes < ActiveRecord::Migration
-  def up
-
-    if indexes(:reports).select {|index| index.name == 'reports_internal_identifier_idx'}.empty?
-      add_index :reports, :internal_identifier, :name => 'reports_internal_identifier_idx'
-    end
-
-  end
-
-  def down
-
-    unless indexes(:reports).select {|index| index.name == 'reports_internal_identifier_idx'}.empty?
-      remove_index :reports, :internal_identifier
-    end
-
-  end
-end

data/lib/rails_db_admin/report_support.rb

@@ -1,52 +0,0 @@
-require 'fileutils'
-require 'csv'
-
-module RailsDbAdmin
-  class ReportSupport < QuerySupport
-
-    def initialize()
-      @connection = RailsDbAdmin::ConnectionHandler.create_connection_class(Rails.env).connection
-    end
-
-    def render_report(iid, format=:html)
-      report = Report.find_by_internal_identifier(iid.to_s)
-
-      if report.nil? or report.query.nil?
-        "Invalid Report, make sure report exists and query is valid"
-      else
-        data = get_report_data(iid)
-
-        case format
-          when :html
-            ActionView::Base.new().render(:inline => report.template, :locals =>
-                {:unique_name => iid, :title => report.name, :columns => data[:columns], :rows => data[:rows]}
-            )
-          when :pdf
-            html = ActionView::Base.new().render(:inline => report.template, :locals =>
-                {:unique_name => iid, :title => report.name, :columns => data[:columns], :rows => data[:rows]}
-            )
-
-            kit = PDFKit.new(html, :page_size => 'Letter')
-            kit.to_pdf
-          when :csv
-            CSV.generate do |csv|
-              csv << data[:columns]
-              data[:rows].each do |row|
-                csv << row.values
-              end
-            end
-        end
-      end
-
-    end
-
-    def get_report_data(iid)
-      report = Report.find_by_internal_identifier(iid.to_s)
-      columns, values = self.execute_sql(report.query)
-
-      return {:columns => columns, :rows => values}
-    end
-
-
-  end #ReportSupport
-end #RailsDbAdmin