motor-admin 0.1.60 → 0.1.65

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d709fb5b88f56a20cb9c2f906f3540b53278e04becc96598556dba70a0dcb4f
-  data.tar.gz: 5ffca9ae9451e2aa373957116c1b9b6607f5aba3bc1fa1cee555682c1a2987be
+  metadata.gz: b5f4c9fccf887dc60e81cb6bb4d2aacda0fbbf4e9aeac48474ef4c5067263873
+  data.tar.gz: 6eb4219e8ae7796991e3973b44daca3ec59d647ef4bb9471796558565ac49541
 SHA512:
-  metadata.gz: 944babec34990e1889a52e76f652ca725dda31f4bcbb75aefc47cb715beca9a1a6127d6c5aa1e70437beafdf6a0c9cfaaaf3cf29a901524980812e23134cefaa
-  data.tar.gz: c79c99d0491e3c02c05296f0ace0ace54bbeeef1cd11f927b49f5edd814503f3e5f0f5a017c184e97bbce9a4b02b7279db36333a8b3fb796fb6125f283e8604a
+  metadata.gz: 45bf72ec83403b6ac6fdb02a584d3edd71007f0be8edbd3d58177ca3ed1b4b2f4b527df4bac5d3389bb8f8931234a1498e82ca6ced50c12c1b3c4e6950dfe36e
+  data.tar.gz: 7aca3f7e224bc2dc0ed87d8554b769d238ecd8a573f256e080412c9498be33fe58b1b0bc30bb9189d5f0854bf19193ad61e71c18a514ee2b4311a25eeec4f877

data/README.md

@@ -43,9 +43,9 @@ $ rails motor:install && rake db:migrate
 
 ![Settings UI](https://user-images.githubusercontent.com/5418788/119263883-90708780-bbe9-11eb-9f9f-f76fed0b7f27.png)
 
-Everything in the admin panel can be configured using intuitive settings UI, which can be opened via the icon in the top right corner.
+Everything in the admin panel can be configured using the intuitive settings UI, which can be opened via the icon in the top right corner.
 
-Data displayed on the resource page can be completely custimized via [SQL queries](#sql-queries) and [dashboards](#dashboards) attached to the resource as a tab. Usually, queries used to display resource data should contain `{{resource_name_id}}` [variable](#sql-queries).
+Data displayed on the resource page can be completely customized via [SQL queries](#sql-queries) and [dashboards](#dashboards) attached to the resource as a tab. Usually, queries used to display resource data should contain `{{resource_name_id}}` [variable](#sql-queries).
 
 ### Custom Actions
 
@@ -57,13 +57,14 @@ Custom resource actions can be added via Active Record method call, API endpoint
 
 ![Custom form](https://user-images.githubusercontent.com/5418788/119264008-1391dd80-bbea-11eb-9f14-cb405e77fb60.png)
 
-Values from the form fields can be used in API path via `{field_name}` syntax: `/api/some-endpoint/{resource_id}/apply`
+Values from the form fields can be used in API path via `{field_name}` syntax: `/api/some-endpoint/{resource_id}/apply`.<br>
+[Learn more about custom forms builder](https://github.com/omohokcoj/motor-admin/blob/master/guides/building_custom_forms.md).
 
 ### SQL Queries
 
 ![SQL query](https://user-images.githubusercontent.com/5418788/119264127-84d19080-bbea-11eb-9903-ef465d1d2c97.png)
 
-Queries can include embeded variables via `{{variable}}` syntax ([mustache](https://mustache.github.io)). `{{#variable}} ... {{/variable}}` syntax allows to decide if conditions inside the scope should be included in the query.
+Queries can include embedded variables via `{{variable}}` syntax ([mustache](https://mustache.github.io)). `{{#variable}} ... {{/variable}}` syntax allows to decide if conditions inside the scope should be included in the query.
 
 ### Data Visualization
 
@@ -143,12 +144,6 @@ Start example application in development mode:
 MOTOR_DEVELOPMENT=true rails s
 ```
 
-## Comming Soon
-
-* Multiple databases
-* NoSQL data sources
-* Pro Bussines intelligence features
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://github.com/omohokcoj/motor-admin/blob/master/LICENSE).

data/app/controllers/motor/api_base_controller.rb

@@ -8,6 +8,7 @@ module Motor
     unless Rails.env.test?
       rescue_from StandardError do |e|
         Rails.logger.error(e)
+        Rails.logger.error(e.backtrace.join("\n"))
 
         render json: { errors: [e.message] }, status: :internal_server_error
       end

data/app/controllers/motor/run_queries_controller.rb

@@ -20,8 +20,9 @@ module Motor
     private
 
     def render_result
-      variables = params.fetch(:variables, {}).merge(current_user_variables)
-      query_result = Queries::RunQuery.call(@query, variables_hash: variables)
+      query_result = Queries::RunQuery.call(@query, variables_hash: variables_params,
+                                                    limit: params[:limit].presence,
+                                                    filters: filter_params)
 
       if query_result.error
         render json: { errors: [{ detail: query_result.error }] }, status: :unprocessable_entity
@@ -56,5 +57,13 @@ module Motor
     def query_params
       params.require(:data).permit(:sql_body, preferences: {})
     end
+
+    def variables_params
+      params.fetch(:variables, {}).merge(current_user_variables)
+    end
+
+    def filter_params
+      (params[:filter] || params[:filters])&.to_unsafe_h
+    end
   end
 end

data/lib/generators/motor/templates/install.rb

@@ -149,6 +149,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Mi
     drop_table :motor_audits
     drop_table :motor_alert_locks
     drop_table :motor_alerts
+    drop_table :motor_forms
     drop_table :motor_taggable_tags
     drop_table :motor_tags
     drop_table :motor_resources

data/lib/motor/active_record_utils.rb

@@ -20,4 +20,5 @@ require_relative './active_record_utils/fetch_methods'
 require_relative './active_record_utils/defined_scopes_extension'
 require_relative './active_record_utils/active_storage_links_extension'
 require_relative './active_record_utils/active_storage_blob_patch'
-require_relative './active_record_utils/active_record_filter'
+require_relative './active_record_utils/active_record_filter_patch'
+require_relative './active_record_utils/active_record_connection_column_patch'

data/lib/motor/active_record_utils/active_record_connection_column_patch.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+begin
+  require 'active_record/connection_adapters/deduplicable'
+rescue LoadError
+  nil
+end
+
+ActiveRecord::ConnectionAdapters::Column.class_eval do
+  def array
+    false
+  end
+end

data/lib/motor/admin.rb

@@ -45,6 +45,7 @@ module Motor
     initializer 'motor.alerts.scheduler' do
       config.after_initialize do
         next unless Motor.server?
+        next if Motor.development?
 
         Motor::Alerts::Scheduler::SCHEDULER_TASK.execute
       end

data/lib/motor/api_query.rb

@@ -5,9 +5,9 @@ module Motor
     module_function
 
     def call(rel, params)
-      rel = ApiQuery::Sort.call(rel, params[:sort])
+      rel = ApiQuery::Sort.call(rel, params[:sort] || params[:order])
       rel = ApiQuery::Paginate.call(rel, params[:page])
-      rel = ApiQuery::Filter.call(rel, params[:filter])
+      rel = ApiQuery::Filter.call(rel, params[:filter] || params[:filters])
       rel = ApiQuery::ApplyScope.call(rel, params[:scope])
 
       ApiQuery::Search.call(rel, params[:q] || params[:search] || params[:query])

data/lib/motor/api_query/filter.rb

@@ -4,6 +4,7 @@ module Motor
   module ApiQuery
     module Filter
       LIKE_FILTER_VALUE_REGEXP = /\A%?(.*?)%?\z/.freeze
+      DISTINCT_RESTRICTED_COLUMN_TYPES = %i[json point].freeze
 
       module_function
 
@@ -12,7 +13,10 @@ module Motor
 
         normalized_params = normalize_params(Array.wrap(params))
 
-        rel.filter(normalized_params).distinct
+        rel = rel.filter(normalized_params)
+        rel = rel.distinct if can_apply_distinct?(rel)
+
+        rel
       end
 
       def normalize_params(params)
@@ -47,6 +51,12 @@ module Motor
         end
       end
 
+      def can_apply_distinct?(rel)
+        rel.columns.none? do |column|
+          DISTINCT_RESTRICTED_COLUMN_TYPES.include?(column.type)
+        end
+      end
+
       def normalize_action(action, value)
         case action
         when 'includes'

data/lib/motor/queries/render_sql_template.rb

@@ -22,9 +22,19 @@ module Motor
             variable_name = Regexp.last_match[1]
 
             index = selected_variables.index { |name, _| name == variable_name }
-            selected_variables << [variable_name, variables[variable_name]] unless index
+            variable_values = variables[variable_name]
 
-            "$#{selected_variables.size}"
+            if variable_values.is_a?(Array)
+              first_variable_index = selected_variables.size + 1
+
+              variable_values.each { |value| selected_variables << [variable_name, value] } unless index
+
+              (first_variable_index..selected_variables.size).map { |i| "$#{i}" }.join(', ')
+            else
+              selected_variables << [variable_name, variables[variable_name]] unless index
+
+              "$#{selected_variables.size}"
+            end
           end
 
         [rendered, selected_variables]

data/lib/motor/queries/run_query.rb

@@ -7,13 +7,16 @@ module Motor
 
       QueryResult = Struct.new(:data, :columns, :error, keyword_init: true)
 
-      WITH_STATEMENT_START = 'WITH __query__ AS ('
+      CTE_NAME = '__query__'
+
+      WITH_STATEMENT_START = "WITH #{CTE_NAME} AS ("
 
       WITH_STATEMENT_TEMPLATE = <<~SQL
         #{WITH_STATEMENT_START}%<sql_body>s
-        ) SELECT * FROM __query__ LIMIT %<limit>s;
+        )
       SQL
 
+      STATEMENT_VARIABLE_REGEXP = /\$\d+/.freeze
       PG_ERROR_REGEXP = /\APG.+ERROR:/.freeze
 
       RESERVED_VARIABLES = %w[current_user_id current_user_email].freeze
@@ -23,11 +26,14 @@ module Motor
       # @param query [Motor::Query]
       # @param variables_hash [Hash]
       # @param limit [Integer]
+      # @param filters [Hash]
       # @return [Motor::Queries::RunQuery::QueryResult]
-      def call!(query, variables_hash: nil, limit: DEFAULT_LIMIT)
+      def call!(query, variables_hash: nil, limit: nil, filters: nil)
         variables_hash ||= {}
+        limit ||= DEFAULT_LIMIT
+        filters ||= {}
 
-        result = execute_query(query, limit, variables_hash)
+        result = execute_query(query, limit, variables_hash, filters)
 
         QueryResult.new(data: result.rows, columns: build_columns_hash(result))
       end
@@ -36,8 +42,8 @@ module Motor
       # @param variables_hash [Hash]
       # @param limit [Integer]
       # @return [Motor::Queries::RunQuery::QueryResult]
-      def call(query, variables_hash: nil, limit: DEFAULT_LIMIT)
-        call!(query, variables_hash: variables_hash, limit: limit)
+      def call(query, variables_hash: nil, limit: nil, filters: nil)
+        call!(query, variables_hash: variables_hash, limit: limit, filters: filters)
       rescue ActiveRecord::StatementInvalid => e
         QueryResult.new(error: build_error_message(e))
       end
@@ -51,10 +57,11 @@ module Motor
       # @param query [Motor::Query]
       # @param limit [Integer]
       # @param variables_hash [Hash]
+      # @param filters [Hash]
       # @return [ActiveRecord::Result]
-      def execute_query(query, limit, variables_hash)
+      def execute_query(query, limit, variables_hash, filters)
         result = nil
-        statement = prepare_sql_statement(query, limit, variables_hash)
+        statement = prepare_sql_statement(query, limit, variables_hash, filters)
 
         ActiveRecord::Base.transaction do
           result =
@@ -62,6 +69,8 @@ module Motor
             when 'ActiveRecord::ConnectionAdapters::PostgreSQLAdapter'
               PostgresqlExecQuery.call(ActiveRecord::Base.connection, statement)
             else
+              statement = normalize_statement_for_sql(statement)
+
               ActiveRecord::Base.connection.exec_query(*statement)
             end
 
@@ -88,27 +97,68 @@ module Motor
       # @param query [Motor::Query]
       # @param limit [Integer]
       # @param variables_hash [Hash]
+      # @param filters [Hash]
       # @return [Array]
-      def prepare_sql_statement(query, limit, variables_hash)
+      def prepare_sql_statement(query, limit, variables_hash, filters)
         variables = merge_variable_default_values(query.preferences.fetch(:variables, []), variables_hash)
 
         sql, query_variables = RenderSqlTemplate.call(query.sql_body, variables)
+        cte_sql = format(WITH_STATEMENT_TEMPLATE, sql_body: sql.strip.delete_suffix(';'))
+        cte_select_sql = build_cte_select_sql(limit, filters)
 
         attributes = build_statement_attributes(query_variables)
 
-        [format(WITH_STATEMENT_TEMPLATE, sql_body: sql.strip.delete_suffix(';'), limit: limit), 'SQL', attributes]
+        [[cte_sql, cte_select_sql].join, 'SQL', attributes]
+      end
+
+      # @param limit [Number]
+      # @param filters [Hash]
+      # @return [String]
+      def build_cte_select_sql(limit, filters)
+        table = Arel::Table.new(CTE_NAME)
+
+        arel_filters = build_filters_arel(filters)
+
+        expresion = table.project(table[Arel.star])
+        expresion = expresion.where(arel_filters) if arel_filters.present?
+
+        expresion.take(limit.to_i).to_sql
+      end
+
+      # @param filters [Hash]
+      # @return [Arel::Nodes, nil]
+      def build_filters_arel(filters)
+        return nil if filters.blank?
+
+        table = Arel::Table.new(CTE_NAME)
+
+        arel_filters = filters.map { |key, value| table[key].in(value) }
+
+        arel_filters[1..].reduce(arel_filters.first) { |acc, arel| acc.and(arel) }
       end
 
       # @param variables [Array<(String, Object)>]
       # @return [Array<ActiveRecord::Relation::QueryAttribute>]
       def build_statement_attributes(variables)
         variables.map do |variable_name, value|
-          ActiveRecord::Relation::QueryAttribute.new(
-            variable_name,
-            value,
-            ActiveRecord::Type::Value.new
-          )
-        end
+          [value].flatten.map do |val|
+            ActiveRecord::Relation::QueryAttribute.new(
+              variable_name,
+              val,
+              ActiveRecord::Type::Value.new
+            )
+          end
+        end.flatten
+      end
+
+      # @param array [Array]
+      # @return [Array]
+      def normalize_statement_for_sql(statement)
+        sql, _, attributes = statement
+
+        sql = ActiveRecord::Base.sanitize_sql([sql.gsub(STATEMENT_VARIABLE_REGEXP, '?'), attributes.map(&:value)])
+
+        [sql, 'SQL', attributes]
       end
 
       # @param variable_configs [Array<Hash>]

data/lib/motor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Motor
-  VERSION = '0.1.60'
+  VERSION = '0.1.65'
 end

data/ui/dist/manifest.json

@@ -2068,11 +2068,11 @@
   "mail-opened.svg": "icons/mail-opened.svg",
   "mail.svg": "icons/mail.svg",
   "mailbox.svg": "icons/mailbox.svg",
-  "main-96c4a62d2fb789ab1080.css.gz": "main-96c4a62d2fb789ab1080.css.gz",
-  "main-96c4a62d2fb789ab1080.js.LICENSE.txt": "main-96c4a62d2fb789ab1080.js.LICENSE.txt",
-  "main-96c4a62d2fb789ab1080.js.gz": "main-96c4a62d2fb789ab1080.js.gz",
-  "main.css": "main-96c4a62d2fb789ab1080.css",
-  "main.js": "main-96c4a62d2fb789ab1080.js",
+  "main-f6cb10fb0e14bdd1703b.css.gz": "main-f6cb10fb0e14bdd1703b.css.gz",
+  "main-f6cb10fb0e14bdd1703b.js.LICENSE.txt": "main-f6cb10fb0e14bdd1703b.js.LICENSE.txt",
+  "main-f6cb10fb0e14bdd1703b.js.gz": "main-f6cb10fb0e14bdd1703b.js.gz",
+  "main.css": "main-f6cb10fb0e14bdd1703b.css",
+  "main.js": "main-f6cb10fb0e14bdd1703b.js",
   "man.svg": "icons/man.svg",
   "manual-gearbox.svg": "icons/manual-gearbox.svg",
   "map-2.svg": "icons/map-2.svg",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: motor-admin
 version: !ruby/object:Gem::Version
-  version: 0.1.60
+  version: 0.1.65
 platform: ruby
 authors:
 - Pete Matsyburka
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-15 00:00:00.000000000 Z
+date: 2021-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord-filter
@@ -169,7 +169,8 @@ files:
 - lib/motor-admin.rb
 - lib/motor.rb
 - lib/motor/active_record_utils.rb
-- lib/motor/active_record_utils/active_record_filter.rb
+- lib/motor/active_record_utils/active_record_connection_column_patch.rb
+- lib/motor/active_record_utils/active_record_filter_patch.rb
 - lib/motor/active_record_utils/active_storage_blob_patch.rb
 - lib/motor/active_record_utils/active_storage_links_extension.rb
 - lib/motor/active_record_utils/defined_scopes_extension.rb
@@ -1490,8 +1491,8 @@ files:
 - ui/dist/icons/zoom-money.svg.gz
 - ui/dist/icons/zoom-out.svg.gz
 - ui/dist/icons/zoom-question.svg.gz
-- ui/dist/main-96c4a62d2fb789ab1080.css.gz
-- ui/dist/main-96c4a62d2fb789ab1080.js.gz
+- ui/dist/main-f6cb10fb0e14bdd1703b.css.gz
+- ui/dist/main-f6cb10fb0e14bdd1703b.js.gz
 - ui/dist/manifest.json
 homepage:
 licenses: