motor-admin 0.1.42 → 0.1.48

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b5c8de183eb4dca0deba15c13f4e17a5cd4b6042ba2aa72e69e4056f0dd07bb
-  data.tar.gz: 5696598a4d1a461fb401b6bd6b9036dbe8ac8d31ce71d8e19edabb0e68b4fa91
+  metadata.gz: 55c1bf8c2fc221d84cbb142204893b6625d980d9c9966fe08cab12b1b8b9e9f6
+  data.tar.gz: 25c3c29dac2b0abd4414cf5c90ada44e4af357efb43ddd63fad4a632321bf89f
 SHA512:
-  metadata.gz: 05e81845c5be4540e7062b945b7ca21a51c197a6c540da1ce747fc478f8105e4e80b375bcf708a1e2b634fffe732c6024fa0626a77baaddfc99eb8bdbdcc6d4e
-  data.tar.gz: 581692e4333bdcde696190897b810206cc7cc222d8a82796d8ba098130b76801b843e6a72b791ba0b8a1aca1686ed88cb14c5c0161953f21273628ae811c55c5
+  metadata.gz: 6faa1ebe8212cf8855b064f4c80df93b6f8a4ef93b09ba98d5565a24a86d6e4274f746511c28ffc5fca2da67710572ee53b2aaa384199ef3fa6de908cf774330
+  data.tar.gz: 737e7e1768be0721d825029176e3397007feb21794eb1eeec2ebe777c0a5c3880b3942f23be50476bdf7f12f564fd03fa3aadb8a69a31d8b06ba2dfb1111e845

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2021 Pete Matsyburka
+Copyright (c) 2021 Pete Matsyburka <pete.matsy@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,9 +1,10 @@
-# Motor
+# ⚡ Motor Admin
 
-Admin UI and Business Analytics.
+Low-code Admin panel and Business intelligence Rails engine **(no DSL - configurable from the UI)**.
 
-## Usage
-How to use my plugin.
+🤓 [Demo App](https://motor-admin.herokuapp.com/demo) | [Features overview](https://www.youtube.com/watch?v=ngVoci8Hll4&list=PLu7llEMh0KcOkR3Uy_RJT0cXPZQKAYVsq&index=1)
+
+[![Admin Panel](https://user-images.githubusercontent.com/5418788/119318538-1f30e300-bc82-11eb-94a4-107c31c93b13.png)](https://motor-admin.herokuapp.com/demo)
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -17,16 +18,135 @@ And then execute:
 $ bundle install
 ```
 
-Or install it yourself as:
+Create and run migration:
 ```bash
-$ gem install motor-admin
+$ rails motor:install && rake db:migrate
 ```
 
-Create and run migration:
+## Features
+
+* [Customizable CRUD](#customizable-crud)
+* [Custom actions](#custom-actions)
+* [Forms builder](#forms-builder)
+* [SQL queries](#sql-queries)
+* [Data visualization](#data-visualization)
+* [Dashboards](#dashboards)
+* [Email alerts](#email-alerts)
+* [Intelligence search](#intelligence-search)
+* [Optimized for mobile](#optimized-for-mobile)
+* [Configurations sync between environments](#configurations-sync)
+
+### Customizable CRUD
+
+![Resource settings](https://user-images.githubusercontent.com/5418788/119318569-2a840e80-bc82-11eb-9ba3-f3964eb6f997.png)
+
+![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.
+
+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).
+
+### Custom Actions
+
+![Custom actions](https://user-images.githubusercontent.com/5418788/119266132-3c1dd580-bbf2-11eb-9666-09e1640eaf7b.png)
+
+Custom resource actions can be added via Active Record method call, API endpoint, or [custom forms](#forms-builder). Also, it's possible to override default create/update/delete actions.
+
+### Forms Builder
+
+![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`
+
+### 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.
+
+### Data Visualization
+
+![motor-visualization](https://user-images.githubusercontent.com/5418788/119264625-a2075e80-bbec-11eb-986c-6106dd6e47ce.png)
+
+Data from the SQL query can be represented as: [table](https://motor-admin.herokuapp.com/demo/queries/12), [number](https://motor-admin.herokuapp.com/demo/queries/6), [line chart](https://motor-admin.herokuapp.com/demo/queries/3), [bar chart](https://motor-admin.herokuapp.com/demo/queries/1), [pie chart](https://motor-admin.herokuapp.com/demo/queries/9), [funnel](https://motor-admin.herokuapp.com/demo/queries/7), [markdown](https://motor-admin.herokuapp.com/demo/queries/8)
+
+### Dashboards
+
+![Dashboard](https://user-images.githubusercontent.com/5418788/119264726-f579ac80-bbec-11eb-852e-8055f8aba200.png)
+
+SQL queries can be organized into dashboards to create a convenient representation of the data.
+
+### Email Alerts
+
+![Email alert](https://user-images.githubusercontent.com/5418788/119265049-feb74900-bbed-11eb-8070-bcc8d6113b9b.png)
+
+Query data can be sent via email periodically using the alerts feature. Interval of the alert email can be specified using natural language, e.g., `every day at midnight`, `every Monday at 8 PM`, `every weekday at 6AM and 6PM`, `every minute`.
+
+The sender address can be specified using `MOTOR_ALERTS_FROM_ADDRESS` environment variable.
+
+### Intelligence Search
+
+![Intelligence search](https://user-images.githubusercontent.com/5418788/119266559-eea26800-bbf3-11eb-8cb3-d0538aa386a9.png)
+
+Intelligence search can be opened via the top right corner button or using <kbd>Cmd</kbd> + <kbd>P</kbd> shortcut.
+
+
+### Optimized for Mobile
+
+![motor-mobile](https://user-images.githubusercontent.com/5418788/119269566-03392d00-bc01-11eb-9e9d-1f6a58fe0749.png)
+
+
+### Configurations Sync
+
+All admin panel configurations are automatically stored in the `config/motor.yml` file. It's recommended to include this file in the application git repository to always have the admin panel configurations in sync across different local and remote environments.
+
+It's possible to sync local development admin panel configurations with remote production application via `rake motor:sync` task:
+
+```bash
+MOTOR_SYNC_REMOTE_URL=https://remote-app-url/ MOTOR_SYNC_API_KEY=secure-random-string rake motor:sync
+```
+
+
+## Authentication
+
+Admin panel can be secured with 'Basic authentication' by specifying `MOTOR_AUTH_USERNAME` and `MOTOR_AUTH_PASSWORD` environment variables.
+
+Alternatively, it can be secured with [devise](https://github.com/heartcombo/devise/wiki/How-To:-Define-resource-actions-that-require-authentication-using-routes.rb) or any other authentication library used by the application:
+
+```ruby
+authenticate :admin_user do
+  mount Motor::Admin => '/admin'
+end
+```
+
+## Development
+
+Start webpack dev server:
+
 ```bash
-$ rails generate motor:install && rake db:migrate
+yarn install && yarn serve
 ```
 
+Setup development database:
+
+```bash
+rake app:db:create && rake app:db:setup
+```
+
+Start example application in development mode:
+
+```bash
+MOTOR_DEVELOPMENT=true rails s
+```
+
+## Comming Soon
+
+* User groups
+* Row-level permissions
+* 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://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://github.com/omohokcoj/motor-admin/blob/master/LICENSE).

data/Rakefile

@@ -2,19 +2,10 @@
 
 require 'bundler/setup'
 
-APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+
 load 'rails/tasks/engine.rake'
 
 load 'rails/tasks/statistics.rake'
 
 require 'bundler/gem_tasks'
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-task default: :test

data/app/controllers/concerns/motor/current_user_method.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Motor
+  module CurrentUserMethod
+    def current_user
+      if defined?(current_admin)
+        current_admin
+      elsif defined?(current_admin_user)
+        current_admin_user
+      elsif defined?(super)
+        super
+      end
+    end
+  end
+end

data/app/controllers/motor/active_storage_attachments_controller.rb

@@ -26,7 +26,7 @@ module Motor
     end
 
     def file_params
-      params.require(:data).require(:file).permit(:io, :filename).to_h
+      params.require(:data).require(:file).permit(:io, :filename).to_h.symbolize_keys
     end
 
     def attachment_params

data/app/controllers/motor/api_base_controller.rb

@@ -2,24 +2,24 @@
 
 module Motor
   class ApiBaseController < ActionController::API
-    def current_user
-      if defined?(current_admin)
-        current_admin
-      elsif defined?(current_admin_user)
-        current_admin_user
-      elsif defined?(super)
-        super
-      end
-    end
+    include Motor::CurrentUserMethod
 
-    def current_ability
-      klass = Class.new
-      klass.include(CanCan::Ability)
-      klass.define_method(:initialize) do |_user|
+    class CanCanAbilityManageAll
+      include CanCan::Ability
+
+      def initialize(_)
         can :manage, :all
       end
+    end
 
-      klass.new(current_user)
+    rescue_from StandardError do |e|
+      Rails.logger.error(e)
+
+      render json: { errors: [e.message] }, status: :internal_server_error
+    end
+
+    def current_ability
+      CanCanAbilityManageAll.new(current_user)
     end
   end
 end

data/app/controllers/motor/application_controller.rb

@@ -2,5 +2,6 @@
 
 module Motor
   class ApplicationController < ActionController::Base
+    include Motor::CurrentUserMethod
   end
 end

data/app/controllers/motor/assets_controller.rb

@@ -6,19 +6,21 @@ module Motor
 
     GZIP_TYPES = [
       'application/javascript',
-      'text/css'
+      'text/css',
+      'image/svg+xml'
     ].freeze
 
     MIME_TYPES = {
       '.js' => 'application/javascript',
       '.css' => 'text/css',
+      '.svg' => 'image/svg+xml',
       '.woff2' => 'font/woff2'
     }.freeze
 
     def show
       filename = params[:filename]
 
-      return [404, {}, ''] unless Motor::Assets.manifest.values.include?(filename)
+      return [404, {}, ''] unless Motor::Assets.manifest.value?(filename)
 
       assign_headers(filename)
 

data/app/controllers/motor/data_controller.rb

@@ -26,8 +26,6 @@ module Motor
       render json: { data: Motor::ApiQuery::BuildJson.call(@resource, params) }
     rescue ActiveRecord::RecordInvalid
       render json: { errors: @resource.errors }, status: :unprocessable_entity
-    rescue StandardError => e
-      render json: { errors: [e.message] }, status: :unprocessable_entity
     end
 
     def update
@@ -36,8 +34,6 @@ module Motor
       render json: { data: Motor::ApiQuery::BuildJson.call(@resource, params) }
     rescue ActiveRecord::RecordInvalid
       render json: { errors: @resource.errors }, status: :unprocessable_entity
-    rescue StandardError => e
-      render json: { errors: [e.message] }, status: :unprocessable_entity
     end
 
     def destroy
@@ -54,8 +50,6 @@ module Motor
       @resource.public_send(params[:method].to_sym)
 
       head :ok
-    rescue StandardError => e
-      render json: { message: e.message }, status: :unprocessable_entity
     end
 
     private

data/app/controllers/motor/icons_controller.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Motor
+  class IconsController < ApiBaseController
+    CACHE_STORE = ActiveSupport::Cache::MemoryStore.new
+
+    def index
+      data = CACHE_STORE.fetch('icons') do
+        Motor::Assets.icons.map do |icon|
+          svg = Motor::Assets.load_asset("icons/#{icon}", gzip: !Motor.development?)
+          svg = ActiveSupport::Gzip.decompress(svg) unless Motor.development?
+
+          [icon, svg]
+        end
+      end
+
+      render json: { data: data }
+    end
+  end
+end

data/app/controllers/motor/ui_controller.rb

@@ -4,6 +4,8 @@ module Motor
   class UiController < ApplicationController
     layout 'motor/application'
 
+    helper_method :current_user
+
     def index
       Motor.reload! if Motor.development?
 

data/app/mailers/motor/alerts_mailer.rb

@@ -26,13 +26,13 @@ module Motor
     end
 
     def from_address
-      from = ENV['MOTOR_ADMIN_FROM_ADDRESS'].presence
+      from = ENV['MOTOR_ALERTS_FROM_ADDRESS'].presence
 
       from ||= application_mailer_default_from
       from ||= mailer_config_from_address
-      from ||= "reports@#{ENV['HOST'].sub(/\Awww\./, '')}" if ENV['HOST'].present?
+      from ||= "reports@#{ENV['HOST'].delete_prefix('www.')}" if ENV['HOST'].present?
 
-      from
+      from || 'reports@example.com'
     end
 
     def application_mailer_default_from
@@ -42,9 +42,9 @@ module Motor
     end
 
     def mailer_config_from_address
-      return if Rails.application.config.action_mailer.default_url_options[:host].blank?
+      return if Rails.application.config.action_mailer.default_url_options&.dig(:host).blank?
 
-      "reports@#{Rails.application.config.action_mailer.default_url_options[:host].sub(/\Awww\./, '')}"
+      "reports@#{Rails.application.config.action_mailer.default_url_options[:host].delete_prefix('www.')}"
     end
   end
 end

data/app/models/motor/tag.rb

@@ -2,6 +2,6 @@
 
 module Motor
   class Tag < ::Motor::ApplicationRecord
-    has_many :taggable_tags
+    has_many :taggable_tags, dependent: :destroy
   end
 end

data/app/views/motor/alerts_mailer/alert_email.html.erb

@@ -92,7 +92,7 @@
                                   <th><%= column[:name] %></th>
                                 <% end %>
                               </tr>
-                              <% @query_result.data.first(100).each do |row| %>
+                              <% @query_result.data.first(40).each do |row| %>
                                 <tr>
                                   <% row.each do |col| %>
                                     <td><%= col.respond_to?(:strftime) ? l(col, format: :long) : col.to_s.truncate(100) %></th>

data/app/views/motor/ui/show.html.erb

@@ -1 +1 @@
-<%= raw(Motor::Configs::BuildUiAppTag.call) %>
+<%= raw(Motor::Configs::BuildUiAppTag.call(current_user)) %>

data/config/routes.rb

@@ -13,6 +13,7 @@ Motor::Admin.routes.draw do
       resources :dashboards, only: %i[index show create update destroy]
       resources :forms, only: %i[index show create update destroy]
       resources :alerts, only: %i[index show create update destroy]
+      resources :icons, only: %i[index]
       resources :active_storage_attachments, only: %i[create], path: 'data/active_storage__attachments'
       resource :schema, only: %i[show update]
       resources :audits, only: %i[index]
@@ -47,5 +48,3 @@ Motor::Admin.routes.draw do
     end
   end
 end
-
-ActiveSupport::Notifications.instrument('motor.routes.loaded')

data/lib/motor/active_record_utils.rb

@@ -7,3 +7,4 @@ require_relative './active_record_utils/types'
 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'

data/lib/motor/active_record_utils/active_storage_blob_patch.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Motor
+  module ActiveRecordUtils
+    module ActiveStorageBlobPatch
+      KEYWORD_ARGS = %i[io filename content_type metadata identify].freeze
+
+      def build_after_upload(hash)
+        super(**hash.with_indifferent_access.slice(*KEYWORD_ARGS).symbolize_keys)
+      end
+
+      def build_after_unfurling(hash)
+        super(**hash.with_indifferent_access.slice(*KEYWORD_ARGS).symbolize_keys)
+      end
+
+      def create_after_unfurling!(hash)
+        super(**hash.with_indifferent_access.slice(*KEYWORD_ARGS).symbolize_keys)
+      end
+
+      def create_and_upload!(hash)
+        super(**hash.with_indifferent_access.slice(*KEYWORD_ARGS).symbolize_keys)
+      end
+    end
+  end
+end