flexi_admin 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f7899a2bba48f2ff003b6b90de70a6df1b61a05fc37e07dc47e07f4d3a3a9cc7
+  data.tar.gz: c22ed4d803e860e4b250ac55670737c5df158705d3b5c3dd0d425646b4155adf
+SHA512:
+  metadata.gz: 2d80c1451c28a1d842e2eb24660f5489184bb403a1eec4eb740eeda5f7eb11d3592ddd9a4cc9f80866664af28552aaaf2f70f07ddab18ca635fa551106f56f0e
+  data.tar.gz: 7677d9ab7f7fdc1980066ec248e52725db1f4b017a1baaf0ae700cdb69f9cd06d81bdeee9271f51ab86617459aa278e433077f4cb56a65bea23f509e7bfb5f38

data/README.md

@@ -0,0 +1,42 @@
+# FlexiAdmin Rails
+
+Steps required to get FlexiAdmin working with a Rails app:
+
+**Gemfile**
+
+1. add `gem 'flexi_admin', git: 'https://github.com/landovsky/flexi_admin.git', branch: 'main'` to the `Gemfile`
+
+**Stylesheets**
+
+2. add `@import "flexi_admin.scss";` to the `app/assets/stylesheets/application.scss` file
+
+**JavaScript**
+
+3. add `import "flexi_admin";` to the `app/javascript/application.js` file
+
+# Temporary (workaround) requirements
+
+- can't get stylesheets to load from gem, so adding to host app:
+
+```scss
+// Production
+// @import "flexi_admin.scss";
+// Local dev
+// @import "../../flexi_admin/app/assets/stylesheets/flexi_admin";
+```
+
+- add modals controller:
+
+```
+# frozen_string_literal: true
+
+class ModalsController < AdminController
+  include FlexiAdmin::Controllers::ModalsController
+end
+```
+
+```ruby
+  resources :modals, only: [] do
+    get :show, on: :collection
+  end
+```

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake"
+
+# Load all rake tasks from lib/tasks
+Dir.glob('lib/tasks/**/*.rake').each { |r| load r }

data/lib/flexi_admin/components/actions/checkbox_component.html.slim

@@ -0,0 +1,8 @@
+.form-check.bulk-action-checkbox
+  input [class="form-check-input"
+         type="checkbox"
+         value="#{id}"
+         id="checkbox-#{id}"
+         name="#{scope}"
+         data-action="#{select_all ? 'change->bulk-action#toggleAll' : 'change->bulk-action#toggle'}"]
+  = content

data/lib/flexi_admin/components/actions/checkbox_component.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module FlexiAdmin::Components::Actions
+  class CheckboxComponent < FlexiAdmin::Components::BaseComponent
+    attr_reader :id, :scope, :select_all
+
+    def initialize(id:, scope:, select_all: false)
+      @id = id
+      @scope = scope
+      @select_all = select_all
+    end
+  end
+end

data/lib/flexi_admin/components/actions/select_component.html.slim

@@ -0,0 +1,11 @@
+div data-bulk-action-scope-value="#{scope}"
+  .dropdown
+    button.btn.btn-outline-secondary.dropdown-toggle [type="button"
+                                                      data-bs-toggle="dropdown"
+                                                      aria-expanded="false"
+                                                      aria-haspopup="true"]
+      | Akce
+    ul.dropdown-menu
+      - actions.each do |action|
+        li
+          = action

data/lib/flexi_admin/components/actions/select_component.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module FlexiAdmin::Components::Actions
+  class SelectComponent < FlexiAdmin::Components::BaseComponent
+    attr_reader :scope, :label
+
+    renders_many :actions
+
+    def initialize(context: nil, scope: nil, label: "Akce")
+      @context = context
+      @scope = scope || context&.scope
+      @label = label
+
+      raise ArgumentError, "context or scope is required" if context.blank? && scope.blank?
+    end
+  end
+end

data/lib/flexi_admin/components/base_component.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module FlexiAdmin
+  module Components
+    class BaseComponent < ViewComponent::Base
+      include FlexiAdmin::Helpers::ApplicationHelper
+
+      # Delegate main_app to view context
+      delegate :main_app, to: :helpers
+
+      # def render(*args)
+      #   super(*args)
+      # rescue StandardError => e
+      #   binding.pry if Rails.env.development? && !defined?(@@once)
+      #   @@once = true
+      # end
+    end
+  end
+end

data/lib/flexi_admin/components/form/field_component.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "view_component"
+
+module FlexiAdmin::Components::Form
+  class FieldComponent < FlexiAdmin::Components::BaseComponent
+    def call
+      content_tag :div, content, class: "field-wrapper relative flex flex-col grow pb-2 md:pb-0 leading-tight min-h-14 h-full field-wrapper-layout-inline md:flex-row md:items-center field-wrapper-size-regular field-width-regular"
+    end
+  end
+end

data/lib/flexi_admin/components/form/label_component.html.slim

@@ -0,0 +1,2 @@
+div class="pt-4 flex self-start items-center flex-shrink-0 px-6 uppercase font-semibold text-gray-500 text-sm h-full md:pt-0 md:h-14" style="width: 30%"
+  = form.label name, **options

data/lib/flexi_admin/components/form/label_component.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module FlexiAdmin::Components::Form
+  class LabelComponent < FlexiAdmin::Components::BaseComponent
+    attr_reader :form, :name, :options
+
+    def initialize(form, name, options = {})
+      @form = form
+      @name = name
+      @options = options
+    end
+  end
+end

data/lib/flexi_admin/components/form/rows_component.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module FlexiAdmin::Components::Form
+  class RowsComponent < FlexiAdmin::Components::BaseComponent
+    def call
+      content_tag :div, content, class: "divide-y overflow-auto"
+    end
+  end
+end

data/lib/flexi_admin/components/form/text_input_component.html.slim

@@ -0,0 +1,5 @@
+// Input column
+div.flex-1.flex.flex-row.md:min-h-inherit.py-2.px-6
+  // Input wrapper
+  div.self-center.w-full.has-sidebar:w-full
+    = form.text_field name, class: input_classes, **options

data/lib/flexi_admin/components/form/text_input_component.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module FlexiAdmin::Components::Form
+  class TextInputComponent < FlexiAdmin::Components::BaseComponent
+    attr_reader :form, :name, :options
+
+    def initialize(form, name, options = {})
+      @form = form
+      @name = name
+      @options = options
+    end
+
+    def input_classes
+      "appearance-none inline-flex bg-gray-25 disabled:cursor-not-allowed text-gray-600 disabled:opacity-50 rounded py-2 px-3 leading-tight border focus:border-gray-600 focus-visible:ring-0 focus:text-gray-700 placeholder:text-gray-300 border-gray-200 w-full"
+    end
+  end
+end

data/lib/flexi_admin/components/helpers/action_button_helper.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module FlexiAdmin::Components::Helpers::ActionButtonHelper
+  def button(label, icon: nil)
+    @button = label
+    @button_icon = icon
+  end
+
+  def button_text
+    @button
+  end
+
+  def button_icon
+    @button_icon
+  end
+
+  def button_icon_class
+    "bi-#{button_icon}"
+  end
+
+  def title(title)
+    @title = title
+  end
+
+  def title_text
+    @title
+  end
+end

data/lib/flexi_admin/components/helpers/action_helper.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module FlexiAdmin::Components::Helpers::ActionHelper
+  # Context overrides the context normally given by the class including this module
+  # Example - adding action button to a custom view form
+  def action(action_component, disabled: true, selection_dependent: true, context: nil)
+    render FlexiAdmin::Components::Resources::BulkAction::ButtonComponent.new(context || self.context,
+                                                                              action_component,
+                                                                              disabled:,
+                                                                              selection_dependent:)
+  end
+end

data/lib/flexi_admin/components/helpers/icon_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module FlexiAdmin::Components::Helpers::IconHelper
+  def icon
+    self.class.instance_variable_get(:@icon_value) || options[:icon]
+  end
+
+  def icon_class
+    "bi-#{icon}" if icon.present?
+  end
+end

data/lib/flexi_admin/components/helpers/link_helper.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module FlexiAdmin::Components::Helpers::LinkHelper
+  def navigate_to(title, resource)
+    helpers.link_to title, [:admin, resource], "data-turbo-frame": "_top"
+    # content_tag(:a, title, href: resource, "data-turbo-frame": "_top")
+  end
+end

data/lib/flexi_admin/components/helpers/resource_helper.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module FlexiAdmin::Components::Helpers::ResourceHelper
+  include FlexiAdmin::Components::Helpers::UrlHelper
+
+  def autocomplete_path(action:, fields:, parent: nil)
+    payload = {
+      ac_action: action,
+      ac_path: resource__path,
+      fa_parent: parent&.gid_param,
+      ac_fields: fields
+    }
+    main_app.send("autocomplete_admin_#{scope_plural}_path", params: payload)
+  end
+
+  def datalist_path(action:, fields:, parent: nil)
+    payload = {
+      ac_action: action,
+      ac_fields: fields
+    }
+
+    main_app.send("datalist_admin_#{scope_plural}_path", params: payload)
+  end
+
+  def edit_resource_path(resource, **params)
+    main_app.send("edit_admin_#{scope_singular}_path", resource, params:)
+  end
+
+  def bulk_action_path(scope, **params)
+    raise 'Scope is not defined' if scope.blank?
+
+    main_app.send("bulk_action_admin_#{scope}_path", params:)
+  end
+
+  def resource_path(resource, **params)
+    main_app.send("admin_#{scope_singular}_path", resource, params:)
+  end
+
+  def resource__path
+    "admin_#{scope_singular}_path"
+  end
+
+  def resources_path(**params)
+    main_app.send("admin_#{scope_plural}_path", params:)
+  end
+
+  def resource_input_name
+    "#{scope_singular}_id"
+  end
+
+  def scope_plural
+    scope.gsub('/', '_')
+  end
+
+  def scope_singular
+    scope.singularize
+  end
+
+  def scope
+    @scope ||= begin
+      return context.scope if defined?(context)
+      return resource.model_name.try(:plural) if defined?(resource)
+
+      raise 'Scope is not defined'
+    end
+  end
+
+  def paginate(resource, per_page: 10)
+    resource.paginate(page: params[:page], per_page:)
+  end
+end

data/lib/flexi_admin/components/helpers/selectable.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module FlexiAdmin::Components::Helpers::Selectable
+  def selectable
+    @is_selectable = true
+  end
+
+  def selectable?
+    @is_selectable
+  end
+end

data/lib/flexi_admin/components/helpers/url_helper.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "action_view"
+
+module FlexiAdmin::Components::Helpers::UrlHelper
+  include ::ActionView::Helpers::UrlHelper
+  include ::ActionView::RoutingUrlFor
+end

data/lib/flexi_admin/components/helpers/value_formatter.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module FlexiAdmin::Components::Helpers::ValueFormatter
+
+  def as_text(value)
+    value.to_s
+  end
+
+  def as_date(value, format: nil)
+    return nil if value.blank?
+
+    I18n.l(value, format:)
+  end
+
+  def as_navigation(value)
+    helpers.link_to value, value, 'data-turbo-frame': '_top'
+    # content_tag(:a, value, href: value, 'data-turbo-frame': '_top')
+  end
+
+  def format(formatter)
+    case formatter.to_sym
+    when :date
+      proc { |value| as_date(value) }
+    when :text
+      proc { |value| as_text(value) }
+    when :navigation
+      proc { |value| as_navigation(value) }
+    else
+      raise ArgumentError, "Unknown formatter: #{@formatter}"
+    end
+  end
+end

data/lib/flexi_admin/components/nav/floating_toc_component.html.slim

@@ -0,0 +1,2 @@
+nav.navbar.sticky-top.bg-white data-controller="floating-toc"
+  ul.nav.nav-pills.mb-2.mb-lg-0 data-floating-toc-target="toc"

data/lib/flexi_admin/components/nav/floating_toc_component.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module FlexiAdmin::Components::Nav
+  class FloatingTocComponent < FlexiAdmin::Components::BaseComponent
+  end
+end

data/lib/flexi_admin/components/resource/autocomplete_component.html.slim

@@ -0,0 +1,30 @@
+.autocomplete [data-controller="#{ disabled ? '' : 'autocomplete' }"]
+  - if disabled && data_list?
+    = value
+  - elsif disabled && !data_list?
+      a href="#{resource_path(resource)}" data-turbo-frame="_top" = resource&.ac_title
+      /= helpers.link_to resource&.ac_title, resource_path(resource), data: { turbo_frame: '_top' }
+  - else
+    .input-group style="width: #{width || '100%'}"
+      .input-group-text id="button-addon1"
+        i.bi class="#{icon_class}"
+
+      = text_field_tag name, resource&.ac_title,
+                        class: 'form-control',
+                        placeholder: 'hledat',
+                        'aria-describedby': 'button-addon1',
+                        value: ,
+                        required:,
+                        **autocomplete_options
+      .invalid-feedback.d-none
+      - if select?
+        input [type="hidden"
+              name="#{name}"
+              data-autocomplete-target="resourceId"
+              value="#{resource&.id}"]
+      .clear-icon.d-none data-autocomplete-target="clearIcon" data-action="click->autocomplete#clear"
+        i.bi.bi-x-circle.me-2
+      .loading-icon.d-none data-autocomplete-target="loadingIcon"
+        .icon
+
+      ul.collapse.show data-autocomplete-target="list"

data/lib/flexi_admin/components/resource/autocomplete_component.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+# Independent component.
+module FlexiAdmin::Components::Resource
+  class AutocompleteComponent < FlexiAdmin::Components::BaseComponent
+    include FlexiAdmin::Components::Helpers::ResourceHelper
+
+    attr_reader :resource, :disabled, :action, :parent, :fields, :required,
+                :name, :html_options, :path, :width, :value
+
+    def initialize(resource = nil, scope:, fields: [:title],
+                  action: :select, parent: nil, path: nil,
+                  value: nil, **html_options)
+      @resource = resource
+      @scope = scope
+      @parent = parent
+      @fields = fields
+      @path = path
+      @action = action
+      @value = value
+
+      @html_options = html_options
+      @width = html_options.delete(:width)
+      @required = html_options[:required]
+      @style = html_options.delete(:style)
+      @disabled = html_options.key?(:disabled) ? html_options[:disabled] : false
+      @name = html_options[:name] || resource_input_name
+
+      validate_action!
+    end
+
+    def autocomplete_options
+      {
+        style: 'border-top-right-radius: 0.4rem; border-bottom-right-radius: 0.4rem;',
+        data: { autocomplete_target: 'input',
+                action: 'keyup->autocomplete#keyup focusout->autocomplete#onFocusOut',
+                autocomplete_search_path: get_path,
+                autocomplete_is_disabled: disabled,
+                field_type: kind }.merge(html_options)
+      }
+    end
+
+    private
+
+    def icon_class
+      case action
+      when :input
+        'bi-alphabet'
+      else
+        'bi-search'
+      end
+    end
+
+    def select?
+      action == :select
+    end
+
+    def data_list?
+      action == :input
+    end
+
+    def kind
+      data_list? ? :text : :autocomplete
+    end
+
+    def get_path
+      return path if path.present?
+
+      case action
+      when :input
+        datalist_path(action: :input, parent:, fields:)
+      else
+        autocomplete_path(action:, parent:, fields:)
+      end
+    end
+
+    def validate_action!
+      return if %i[select show input].include?(@action)
+
+      raise "Invalid action: #{@action}"
+    end
+  end
+end

data/lib/flexi_admin/components/resource/button_select_component.html.slim

@@ -0,0 +1,13 @@
+div.button-select data-controller="button-select" data-button-select-disabled-value="#{disabled}"
+  .btn-group
+    - if disabled
+      button.btn.btn-outline-secondary.text-nowrap data-value=value data-button-select-target="button" disabled=true
+        = value || '-'
+    - else
+      - options.each do |option|
+        button.btn.btn-outline-secondary.text-nowrap data-action="click->button-select#select" data-value=option data-button-select-target="button"
+          = option
+  = hidden_field_tag html_options[:name] || attr_name, value, data: { 'button-select-target': 'input' }
+  - if form
+    .invalid-feedback data-button-select-target="invalid-feedback"
+      = resource.errors[attr_name].first

data/lib/flexi_admin/components/resource/button_select_component.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Requirement is handled by the model
+module FlexiAdmin::Components::Resource
+  class ButtonSelectComponent < FlexiAdmin::Components::BaseComponent
+    attr_reader :resource, :attr_name, :options, :form, :label, :value, :html_options, :disabled
+
+    def initialize(resource, attr_name, options, form:, label: nil, value: nil, disabled: false, **html_options)
+      @resource = resource
+      @attr_name = attr_name
+      @options = options
+      @form = form
+      @label = label
+      @value = value
+      @html_options = html_options
+      @disabled = disabled
+    end
+  end
+end

data/lib/flexi_admin/components/resource/form_component.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module FlexiAdmin::Components::Resource
+  class FormComponent < FlexiAdmin::Components::BaseComponent
+    include FlexiAdmin::Components::Resource::FormMixin
+
+    attr_reader :resource
+
+    def initialize(resource, disabled: true)
+      @resource = resource
+      @disabled = disabled
+    end
+
+    def disabled
+      !helpers.current_ability&.can?(:update, resource) || @disabled
+    end
+  end
+end

data/lib/flexi_admin/components/resource/form_element_component.html.slim

@@ -0,0 +1,3 @@
+turbo-frame id="#{resource.try(:form_id) || 'form_frame'}"
+  = form_tag(url, method: , id: form_id, class: css_class, data: merged_data, **html_options_except_data) do
+    = fields

data/lib/flexi_admin/components/resource/form_element_component.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module FlexiAdmin::Components::Resource
+  class FormElementComponent < FlexiAdmin::Components::BaseComponent
+    include FlexiAdmin::Components::Helpers::ResourceHelper
+
+    renders_one :fields
+
+    attr_reader :resource, :url, :css_class, :method, :html_options_except_data, :merged_data
+
+    def initialize(resource, url:, css_class:, method: :post, **html_options)
+      @resource = resource
+      @url = url
+      @css_class = css_class
+      @method = method
+      data = html_options[:data] || {}
+      @merged_data = merge_data_keys(data)
+      @html_options_except_data = html_options.except(:data)
+    end
+
+    def form_id
+      resource.try(:identifier) || "form"
+    end
+
+    def merge_data_keys(data)
+      controller = data[:controller]
+      controllers = controller.present? ? [controller, "form-validation"] : ["form-validation"]
+      data.merge(controller: controllers.join(" "))
+    end
+  end
+end