cm-admin 0.2.0 → 0.4.2

data/lib/cm_admin/models/form_field.rb

@@ -0,0 +1,21 @@
+module CmAdmin
+  module Models
+    class FormField
+      attr_accessor :field_name, :label, :header, :input_type, :collection, :custom_value, :disabled
+      VALID_INPUT_TYPES = [:integer, :decimal, :string, :single_select, :multi_select, :date, :date_time, :text, :single_file_upload, :multi_file_upload, :hidden].freeze
+
+      def initialize(field_name, input_type, attributes = {})
+        raise ArgumentError, "Kindly select a valid filter type like #{VALID_INPUT_TYPES.sort.to_sentence(last_word_connector: ', or ')} instead of #{input_type} for column #{field_name}" unless VALID_INPUT_TYPES.include?(input_type.to_sym)
+        @field_name = field_name
+        set_default_values
+        attributes.each do |key, value|
+          self.send("#{key.to_s}=", value)
+        end
+      end
+
+      def set_default_values
+        self.disabled = false
+      end
+    end
+  end
+end

data/lib/cm_admin/models/tab.rb

@@ -0,0 +1,13 @@
+module CmAdmin
+  module Models
+    class Tab
+
+      attr_accessor :nav_item_name, :custom_action
+
+      def initialize(nav_item_name, custom_action)
+        @nav_item_name = nav_item_name
+        @custom_action = custom_action
+      end
+    end
+  end
+end

data/lib/cm_admin/utils.rb

@@ -0,0 +1,67 @@
+module CmAdmin::Utils
+  class << self
+    def serialize_csv_columns(*columns, **hashes)
+      # Turns an arbitrary list of args and kwargs into a list of params to be used in a form
+      # For example, turns CmAdmin::Utils.serialize_csv_columns(:a, :b, c: [:d, e: :h], f: :g)
+      # into [:a, :b, "c/d", "c/e/h", "f/g"]
+      columns.map(&:to_s) + hashes.map do |key, value|
+        serialize_csv_columns(*value).map do |column|
+          "#{key}/#{column}"
+        end
+      end.reduce([], :+)
+    end
+
+    def deserialize_csv_columns(list, method)
+      # Does the opposite operation of serialize_csv_columns
+      list.reduce(recursive_hash) do |acc, item|
+        tokens = item.to_s.split('/')
+        send(method, acc, tokens.shift, tokens)
+      end
+    end
+
+    def recursive_hash
+      func = ->(h, k) { h[k] = Hash.new(&func) }
+      # This hash creates a new hash, infinitely deep, whenever a value is not found
+      # recursive_hash[:a][:b][:c][:d] will never fail
+      Hash.new(&func)
+    end
+
+    def as_json_params(hash, key, tokens)
+      hash.empty? && hash = { only: [], methods: [], include: recursive_hash }
+      if tokens.empty?
+        # base case
+        hash[:methods] << key
+      else
+        # recursive case
+        # hash[:associations] ||= {}
+        hash[:include][key] = as_json_params(hash[:include][key], tokens.shift, tokens)
+      end
+      hash
+    end
+
+    def flatten_hash(hash, prefix="", separator="_")
+      hash.reduce({}) do |acc, item|
+        case item[1]
+        when Hash
+          acc.merge(flatten_hash(item[1], "#{prefix}#{item[0]}#{separator}"))
+        else
+          acc.merge("#{prefix}#{item[0]}" => item[1])
+        end
+      end
+    end
+
+    def base(hash, key, tokens) # recursive
+      hash.empty? && hash = { columns: [], associations: recursive_hash }
+      if tokens.empty?
+        # base case
+        hash[:columns] << key
+      else
+        # recursive case
+        # hash[:associations] ||= {}
+        hash[:associations][key] = base(hash[:associations][key], tokens.shift, tokens)
+      end
+      hash
+    end
+
+  end
+end

data/lib/cm_admin/version.rb

@@ -1,3 +1,3 @@
 module CmAdmin
-  VERSION = "0.2.0"
+  VERSION = "0.4.2"
 end

data/lib/cm_admin/view_helpers/column_field_helper.rb

@@ -0,0 +1,29 @@
+module CmAdmin
+  module ViewHelpers
+    module ColumnFieldHelper
+
+      #adds prefix and suffix to a value
+      def add_prefix_and_suffix_helper(value, prefix, suffix)
+        "#{prefix} #{value} #{suffix}"
+      end
+
+      #formats the column value a field
+      def column_for_field_helper(ar_object, column)
+        value = ar_object.send(column.db_column_name)
+        formatted_value = CmAdmin::Models::Column.format_data_type(column, value)
+        formatted_value = add_prefix_and_suffix_helper(formatted_value, column.prefix, column.suffix)
+        formatted_value = link_url_value_helper(column, value, formatted_value)
+        return formatted_value
+      end
+
+      #column's value is either linked with 'url' attribute's value or its own value
+      def link_url_value_helper(column, value, formatted_value)
+        return formatted_value unless column.column_type.to_s == 'link'
+        link_url_value = column.url.present? ? column.url : value
+        final_value = "<a href=#{link_url_value}>#{formatted_value}</a>".html_safe
+        return final_value
+      end
+
+    end
+  end
+end

data/lib/cm_admin/view_helpers/field_display_helper.rb

@@ -0,0 +1,65 @@
+module CmAdmin
+  module ViewHelpers
+    module FieldDisplayHelper
+
+      def show_field(ar_object, field)
+        content_tag(:div, class: "info-split") do
+          concat show_field_label(ar_object, field)
+          concat show_field_value(ar_object, field)
+        end
+      end
+
+      def show_field_label(ar_object, field)
+        content_tag(:div, class: "info-split__lhs") do
+          p = field.label.present? ? field.label.to_s : field.field_name.to_s.titleize
+        end
+      end
+      
+      def show_field_value(ar_object, field)
+        content_tag(:div, class: "info-split__rhs") do
+          case field.field_type || :string
+          when :integer
+            ar_object.send(field.field_name).to_s
+          when :decimal
+            ar_object.send(field.field_name).to_f.round(field.precision).to_s if ar_object.send(field.field_name)
+          when :string
+            ar_object.send(field.field_name).to_s
+          when :datetime
+            ar_object.send(field.field_name).strftime(field.format || "%d/%m/%Y").to_s if ar_object.send(field.field_name)
+          when :text
+            ar_object.send(field.field_name)
+          when :custom
+            send(field.helper_method, ar_object, field.field_name)
+          when :link
+            if field.custom_link
+              link = field.custom_link
+            else
+              link = ar_object.send(field.field_name)
+            end
+            content_tag :a, href: link do
+              ar_object.send(field.field_name).to_s
+            end 
+          when :attachment
+            concat show_attachment_value(ar_object, field)
+          end
+        end
+      end
+
+      def show_attachment_value(ar_object, field)
+        if ar_object.send(field.field_name).attached?
+          if ar_object.send(field.field_name).class.name.include?('One')
+            content_tag :a, href: rails_blob_path(ar_object.send(field.field_name), disposition: "attachment") do
+              ar_object.send(field.field_name).filename.to_s 
+            end
+          elsif ar_object.send(field.field_name).class.name.include?('Many')
+            ar_object.send(field.field_name).map do |asset|
+              content_tag :a, href: rails_blob_path(asset, disposition: "attachment") do
+                asset.filename.to_s 
+              end
+            end.join("\n").html_safe
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cm_admin/view_helpers/filter_helper.rb

@@ -0,0 +1,190 @@
+module CmAdmin
+  module ViewHelpers
+    module FilterHelper
+
+      def generate_filters(filters)
+        search_filter = filters.select{ |x| x.filter_type.eql?(:search) }.last
+        other_filters = filters.reject{ |x| x.filter_type.eql?(:search) }
+        concat(content_tag(:div, class: 'cm-filters-v2') do
+          concat(content_tag(:div, class: 'cm-filters-v2__inner') do
+            concat add_search_filter(search_filter) if search_filter
+            if other_filters.any?
+              concat filter_ui(other_filters)
+              concat add_filters_dropdown(other_filters)
+            end
+            concat clear_filters
+          end)
+        end)
+        return
+      end
+
+      def add_filters_dropdown(filters)
+        concat(content_tag(:div, class: 'dropdown add-filter-btn', data: {bs_toggle: 'dropdown'}) do
+          tag.span '+ Add filter'
+        end)
+
+        concat(content_tag(:div, class: 'dropdown-menu dropdown-popup') do
+          concat(content_tag(:div, class: 'popup-base') do
+            concat(content_tag(:div, class: 'popup-inner') do
+              concat(content_tag(:div, class: 'search-area') do
+                concat tag.input placeholder: 'Search for filter', data: {behaviour: 'dropdown-filter-search'}
+              end)
+              concat(content_tag(:div, class: 'list-area') do
+                filters.each do |filter|
+                  concat(content_tag(:div, class: 'pointer list-item', data: {behaviour: 'filter-option', filter_type: "#{filter.filter_type}", db_column: "#{filter.db_column_name}"}) do
+                    tag.span filter.db_column_name.to_s.titleize
+                  end)
+                end
+              end)
+            end)
+          end)
+        end)
+        return
+      end
+
+      def clear_filters
+        concat(content_tag(:div, class: "clear-btn #{params.dig(:filters) ? '' : 'hidden'}") do
+          tag.span 'Clear all'
+        end)
+        return
+      end
+
+      def filter_ui(filters)
+        filters.each do |filter|
+          case filter.filter_type
+          when :date
+            concat add_date_filter(filter)
+          when :range
+            concat add_range_filter(filter)
+          when :single_select
+            concat add_single_select_filter(filter)
+          when :multi_select
+            concat add_multi_select_filter(filter)
+          end
+        end
+        return
+      end
+
+      def filter_chip(value, filter)
+        data_hash = {behaviour: 'filter-input', filter_type: "#{filter.filter_type}", db_column: "#{filter.db_column_name}"}
+        data_hash.merge!(bs_toggle: 'dropdown') if filter.filter_type.to_s.eql?('single_select')
+
+        if value && filter.filter_type.to_s.eql?('multi_select')
+          truncated_value = value[0]
+          truncated_value += " + #{value.size - 1} more" if truncated_value.size > 1
+        end
+
+        concat(content_tag(:div, class: "filter-chip #{filter.filter_type.to_s.eql?('single_select') ? 'dropdown' : ''}", data: data_hash) do
+          concat tag.span "#{filter.db_column_name.to_s.titleize} is "
+          concat tag.span "#{filter.filter_type.to_s.eql?('multi_select') ? truncated_value : value}"
+          concat(content_tag(:div, class: "filter-chip-remove #{value ? '' : 'hidden'}") do
+            tag.i class: 'fa fa-times bolder'
+          end)
+        end)
+        return
+      end
+
+      def add_search_filter(filter)
+        tag.div class: 'filter-search mr-3' do
+          tag.div class: 'form-field' do
+            tag.div class: 'field-input-wrapper' do
+              concat(content_tag(:input, class: 'search-input', value: "#{params.dig(:filters, :search)}", placeholder: "#{filter.placeholder}", data: {behaviour: 'input-search'}) do
+                tag.span class: 'search-input-icon' do
+                  tag.i class: 'fa fa-search'
+                end
+              end)
+            end
+          end
+        end
+      end
+
+      def add_range_filter(filter)
+        value = params.dig(:filters, :range, :"#{filter.db_column_name}")
+        concat(content_tag(:div, class: "position-relative mr-3 #{value ? '' : 'hidden'}") do
+          concat filter_chip(value, filter)
+
+          concat(content_tag(:div, class: 'position-absolute mt-2 range-container hidden') do
+            concat tag.input type: 'number', min: '0', step: '1', class: 'range-item', value: "#{value ? value.split(' to ')[0] : ''}", placeholder: 'From', data: {behaviour: 'filter', filter_type: "#{filter.filter_type}", db_column: "#{filter.db_column_name}"}
+            concat tag.input type: 'number', min: '0', step: '1', class: 'range-item', value: "#{value ? value.split(' to ')[1] : ''}", placeholder: 'To', data: {behaviour: 'filter', filter_type: "#{filter.filter_type}", db_column: "#{filter.db_column_name}"}
+          end)
+        end)
+        return
+      end
+
+      def add_date_filter(filter)
+        value = params.dig(:filters, :date, :"#{filter.db_column_name}")
+        concat(content_tag(:div, class: "position-relative mr-3 #{value ? '' : 'hidden'}") do
+          concat filter_chip(value, filter)
+
+          concat(content_tag(:div, class: 'date-filter-wrapper w-100') do
+            concat tag.input class: 'w-100 pb-1', value: "#{value ? value : ''}", data: {behaviour: 'filter', filter_type: "#{filter.filter_type}", db_column: "#{filter.db_column_name}"}
+          end)
+        end)
+        return
+      end
+
+      def add_single_select_filter(filter)
+        value = params.dig(:filters, :"#{filter.filter_type}", :"#{filter.db_column_name}")
+        concat(content_tag(:div, class: "position-relative mr-3 #{value ? '' : 'hidden'}") do
+          concat filter_chip(value, filter)
+
+          concat(content_tag(:div, class: 'dropdown-menu dropdown-popup') do
+            concat(content_tag(:div, class: 'popup-base') do
+              concat(content_tag(:div, class: 'popup-inner') do
+                concat(content_tag(:div, class: 'search-area') do
+                  concat tag.input placeholder: "#{filter.placeholder}", data: {behaviour: 'dropdown-filter-search'}
+                end)
+                concat(content_tag(:div, class: 'list-area') do
+                  filter.collection.each do |val|
+                    concat(content_tag(:div, class: "pointer list-item #{(value.present? && value.eql?(val)) ? 'selected' : ''}", data: {behaviour: 'select-option', filter_type: "#{filter.filter_type}", db_column: "#{filter.db_column_name}", value: val}) do
+                      concat tag.span val.to_s
+                    end)
+                  end
+                end)
+              end)
+            end)
+          end)
+        end)
+        return
+      end
+
+      def add_multi_select_filter(filter)
+        value = params.dig(:filters, :"#{filter.filter_type}", :"#{filter.db_column_name}")
+
+        concat(content_tag(:div, class: "position-relative mr-3 #{value ? '' : 'hidden'}") do
+          concat filter_chip(value, filter)
+
+          concat(content_tag(:div, class: 'position-absolute mt-2 dropdown-popup hidden') do
+            concat(content_tag(:div, class: 'popup-base') do
+              concat(content_tag(:div, class: 'popup-inner') do
+                concat(content_tag(:div, class: "#{value ? 'search-with-chips' : 'search-area'}") do
+                  if value
+                    value.each do |val|
+                      concat(content_tag(:div, class: 'chip') do
+                        concat tag.span val
+                        concat(content_tag(:span, data: { behaviour: 'selected-chip' }) do
+                          tag.i class: 'fa fa-times'
+                        end)
+                      end)
+                    end
+                  end
+                  concat tag.input placeholder: "#{filter.placeholder}", data: {behaviour: 'dropdown-filter-search'}
+                end)
+                concat(content_tag(:div, class: 'list-area') do
+                  filter.collection.each do |val|
+                    concat(content_tag(:div, class: "pointer list-item #{(value && value.eql?(val)) ? 'selected' : ''}", data: {behaviour: 'select-option', filter_type: "#{filter.filter_type}", db_column: "#{filter.db_column_name}", value: val}) do
+                      concat tag.input class: 'cm-checkbox', type: 'checkbox', checked: value ? value.include?(val) : false
+                      concat tag.label val.to_s.titleize, class: 'pointer'
+                    end)
+                  end
+                end)
+                concat tag.div 'Apply', class: "apply-area #{value ? 'active' : ''}"
+              end)
+            end)
+          end)
+        end)
+        return
+      end
+    end
+  end
+end

data/lib/cm_admin/view_helpers/form_field_helper.rb

@@ -0,0 +1,33 @@
+module CmAdmin
+  module ViewHelpers
+    module FormFieldHelper
+      def input_field_for_column(f, field)
+        value = field.custom_value || f.object.send(field.field_name)
+        case field.input_type
+        when :integer
+          return f.text_field field.field_name, class: 'normal-input', disabled: field.disabled, value: value, data: {behaviour: 'integer-only'}
+        when :decimal
+          return f.number_field field.field_name, class: 'normal-input', disabled: field.disabled, value: value, data: {behaviour: 'decimal-only'}
+        when :string
+          return f.text_field field.field_name, class: 'normal-input', disabled: field.disabled, value: value
+        when :single_select
+          return f.select field.field_name, options_for_select(field.collection || []), {}, class: 'normal-input select-2', disabled: field.disabled
+        when :multi_select
+          return f.select field.field_name, options_for_select(field.collection || []), {}, class: 'normal-input select-2', disabled: field.disabled, multiple: true
+        when :date
+          return f.text_field field.field_name, class: 'normal-input', disabled: field.disabled, value: value, data: {behaviour: 'date-only'}
+        when :date_time
+          return f.text_field field.field_name, class: 'normal-input', disabled: field.disabled, value: value, data: {behaviour: 'date-time'}
+        when :text
+          return f.text_area field.field_name, class: 'normal-input'
+        when :single_file_upload
+          return f.file_field field.field_name, class: 'normal-input'
+        when :multi_file_upload
+          return f.file_field field.field_name, multiple: true, class: 'normal-input'
+        when :hidden
+          return f.hidden_field field.field_name, value: field.custom_value
+        end
+      end
+    end
+  end
+end

data/lib/cm_admin/view_helpers/form_helper.rb

@@ -0,0 +1,65 @@
+require_relative 'form_field_helper'
+module CmAdmin
+  module ViewHelpers
+    module FormHelper
+      include FormFieldHelper
+      REJECTABLE = %w(id created_at updated_at)
+
+      def generate_form(resource, cm_model)
+        if resource.new_record?
+          action = :new
+          method = :post
+        else
+          action = :edit
+          method = :patch
+        end
+        if cm_model.available_fields[action].empty?
+          return form_with_all_fields(resource, method)
+        else
+          return form_with_mentioned_fields(resource, cm_model.available_fields[action], method)
+        end
+      end
+
+      def form_with_all_fields(resource, method)
+        columns = resource.class.columns.dup
+        table_name = resource.class.table_name
+        columns.reject! { |i| REJECTABLE.include?(i.name) }
+        url = CmAdmin::Engine.mount_path + "/#{table_name}/#{resource.id}"
+        set_form_for_fields(resource, columns, url, method)
+      end
+
+      def form_with_mentioned_fields(resource, available_fields, method)
+        # columns = resource.class.columns.select { |i| available_fields.map(&:field_name).include?(i.name.to_sym) }
+        table_name = resource.class.table_name
+        # columns.reject! { |i| REJECTABLE.include?(i.name) }
+        url = CmAdmin::Engine.mount_path + "/#{table_name}/#{resource.id}"
+        set_form_for_fields(resource, available_fields, url, method)
+      end
+
+      def set_form_for_fields(resource, available_fields_hash, url, method)
+        form_for(resource, url: url, method: method) do |f|
+          available_fields_hash.each do |key, fields_array|
+            if key == :fields
+              fields_array.each do |field|
+                if field.input_type.eql?(:hidden)
+                  concat input_field_for_column(f, field)
+                else
+                  concat f.label field.field_name, class: 'field-label'
+                  concat tag.br
+                  concat(content_tag(:div, class: "datetime-wrapper") do
+                    concat input_field_for_column(f, field)  
+                  end)
+                  concat tag.p resource.errors[field.field_name].first if resource.errors[field.field_name].present?
+                end
+              end
+            else
+              concat(render partial: '/cm_admin/main/nested_table_form', locals: {f: f, table_name: key})
+            end
+          end
+          concat tag.br
+          concat f.submit 'Save', class: 'cta-btn mt-3'
+        end
+      end
+    end
+  end
+end

data/lib/cm_admin/view_helpers/manage_column_popup_helper.rb

@@ -0,0 +1,75 @@
+module CmAdmin
+  module ViewHelpers
+    module ManageColumnPopupHelper
+
+      def manage_column_pop_up(klass)
+        tag.div class: 'modal fade form-modal table-column-modal', id: 'columnActionModal', role: 'dialog' do
+          tag.div class: 'modal-dialog', role: 'document' do
+            tag.div class: 'modal-content' do
+              tag.div do
+                concat manage_column_header
+                concat manage_column_body(klass)
+                concat manage_column_footer
+              end
+            end
+          end
+        end
+      end
+
+      def manage_column_header
+        concat(content_tag(:div, class: 'modal-header') do
+          concat(content_tag(:button, class: 'close', data: {bs_dismiss: 'modal'}) do
+            tag.span 'X'
+          end)
+          concat tag.h5 'Manage columns', class: 'modal-title'
+        end)
+        return
+      end
+
+      def manage_column_body(klass)
+        tag.div class: 'modal-body' do
+          tag.div class: 'columns-list' do
+            klass.available_fields[:index].each do |column_name|
+              concat manage_column_body_list(column_name)
+            end
+          end
+        end
+      end
+
+      def manage_column_body_list(column_name)
+        tag.div class: 'column-item' do
+          concat manage_column_dragger(column_name.field_name)
+          concat manage_column_item_name(column_name)
+          concat manage_column_item_pointer(column_name.field_name)
+        end
+      end
+
+      def manage_column_dragger(default_column_name)
+        return if default_column_name == :id
+        tag.div class: 'dragger' do
+          tag.i class: 'fa fa-bars bolder'
+        end
+      end
+
+      def manage_column_item_name(column_name)
+        tag.div class: 'column-item__name' do
+          tag.p column_name.field_name.to_s.gsub('/', '_').humanize
+        end
+      end
+
+      def manage_column_item_pointer(default_column_name)
+        tag.div class: "column-item__action #{'pointer' if default_column_name != :id}" do
+          tag.i class: "fa #{default_column_name == :id ? 'fa-lock' : 'fa-times-circle'} bolder"
+        end
+      end
+
+      def manage_column_footer
+        concat(content_tag(:div, class: 'modal-footer') do
+          concat tag.button 'Close', class: 'gray-border-btn', data: {bs_dismiss: 'modal'}
+          concat tag.button 'Save', class: 'cta-btn'
+        end)
+        return
+      end
+    end
+  end
+end

data/lib/cm_admin/view_helpers/navigation_helper.rb

@@ -0,0 +1,34 @@
+require 'pagy'
+module CmAdmin
+  module ViewHelpers
+    module NavigationHelper
+      include Pagy::Frontend
+      def navigation_links(navigation_type)
+        CmAdmin.cm_admin_models.map { |model|
+          path = CmAdmin::Engine.mount_path + '/' + model.name.underscore.pluralize
+          if navigation_type == "sidebar"
+            content_tag(:a, href: path) do
+              content_tag(:div, class: 'menu-item') do
+                content_tag(:span, class: 'menu-icon') do
+                  concat tag.i class: 'fa fa-th-large'
+                end +
+                model.name
+              end
+            end
+          elsif navigation_type == "quick_links"
+            content_tag(:a, href: path, class: 'visible') do
+              content_tag(:div, class: 'result-item') do
+                content_tag(:span) do
+                  concat tag.i class: 'fa fa-th-large'
+                end +
+                content_tag(:span) do
+                  model.name
+                end
+              end
+            end
+          end
+        }.join.html_safe
+      end
+    end
+  end
+end

data/lib/cm_admin/view_helpers/page_info_helper.rb

@@ -0,0 +1,57 @@
+module CmAdmin
+  module ViewHelpers
+    module PageInfoHelper
+      def page_title
+        @action.title || @model.title || "#{@model.ar_model.name} | #{@action.name&.titleize} | Admin"
+      end
+
+      def action_title
+        if @model.current_action.page_title
+          title = @model.current_action.page_title
+        else
+          title = "#{@model.name}"
+          case action_name
+          when 'index'
+            title + " list record"
+          when 'show'
+            title + " detail"
+          when 'new'
+            title + " create record"
+          when 'edit'
+            title + " edit record"
+          end
+        end
+      end
+
+      def action_description
+        if @model.current_action.page_description
+          title = @model.current_action.page_description
+        else
+          title = "#{@model.name}"
+          case action_name
+          when 'index'
+            title + " list record"
+          when 'show'
+            title + " detail"
+          when 'new'
+            title + " new record"
+          when 'edit'
+            title + " edit record"
+          end
+        end
+      end
+
+      def page_url(action_name=@action.name, ar_object=nil)
+        base_path = CmAdmin::Engine.mount_path + '/' + @model.name.downcase.pluralize
+        case action_name
+        when 'index'
+          base_path
+        when 'new'
+          base_path + '/new'
+        when 'edit'
+          base_path + "/#{ar_object.id}" + '/edit'
+        end
+      end
+    end
+  end
+end