trestle 0.9.9 → 0.10.0

data/lib/trestle/configuration.rb

@@ -22,8 +22,19 @@ module Trestle
     # Default timestamp precision
     option :timestamp_precision, :minutes
 
-    # Theme stylesheet compilation (requires Sass support)
-    option :theme, defined?(Sass) || defined?(SassC)
+    # Theme colors
+    option :theme, {}
+
+    def theme=(colors)
+      if [true, false].include?(colors)
+        Trestle.deprecator.warn("Passing a boolean to config.theme is deprecated. Please pass primary and secondary theme colors as a hash.")
+      else
+        original = fetch(:colors) || {}
+        colors = colors.transform_values { |color| Trestle::Color.parse(color) }
+
+        assign(:theme, original.merge(colors))
+      end
+    end
 
 
     ## Mounting Options
@@ -68,8 +79,8 @@ module Trestle
       self.helper_module.module_eval(&block) if block_given?
     end
 
-    # Enable or disable Turbolinks within the Trestle admin
-    option :turbolinks, defined?(Turbolinks)
+    # [DEPRECATED] Enable or disable Turbolinks within the Trestle admin
+    deprecated_option :turbolinks, "The config.turbolinks option is deprecated. Turbo is included and enabled by default within Trestle."
 
     # List of parameters that should persist across requests when paginating or reordering
     option :persistent_params, [:sort, :order, :scope]
@@ -94,10 +105,7 @@ module Trestle
     end
 
     # List of i18n keys to pass into the Trestle.i18n JavaScript object
-    option :javascript_i18n_keys, [
-      "trestle.confirmation.title", "trestle.confirmation.delete", "trestle.confirmation.cancel", "trestle.dialog.error",
-      "admin.buttons.ok", "admin.datepicker.formats.date", "admin.datepicker.formats.datetime", "admin.datepicker.formats.time"
-    ]
+    option :javascript_i18n_keys, []
 
     # List of load paths for where to find admin definitions
     option :load_paths, [

data/lib/trestle/engine.rb

@@ -1,17 +1,18 @@
-require "sprockets/railtie"
+require "turbo-rails"
 
 module Trestle
   class Engine < ::Rails::Engine
     isolate_namespace Trestle
     self.routes.default_scope = {}
 
-    # Application assets
-    config.assets.precompile << "trestle/admin.css" << "trestle/admin.js" << "trestle/custom.css"
+    initializer "trestle.sprockets" do |app|
+      # Sprockets manifest
+      config.assets.precompile << "trestle/manifest.js"
+    end if defined?(Sprockets)
 
-    # Vendor assets
-    %w(eot svg ttf woff woff2).each do |ext|
-      config.assets.precompile << "trestle/fa-*.#{ext}"
-    end
+    initializer "trestle.propshaft" do |app|
+      app.config.assets.excluded_paths << Trestle::Engine.root.join("app/assets/sprockets")
+    end if defined?(Propshaft)
 
     initializer "trestle.automount" do |app|
       if Trestle.config.automount
@@ -21,25 +22,16 @@ module Trestle
       end
     end
 
+    initializer "trestle.deprecator" do |app|
+      app.deprecators[:trestle] = Trestle.deprecator if app.respond_to?(:deprecators)
+    end
+
     initializer "trestle.draper" do |app|
       if defined?(Draper)
         Draper::CollectionDecorator.delegate :current_page, :total_pages, :limit_value, :entry_name, :total_count, :offset_value, :last_page?
       end
     end
 
-    initializer "trestle.theme" do |app|
-      # Enable theme compilation
-      if Trestle.config.theme
-        app.config.assets.paths << root.join("frontend/theme").to_s
-        app.config.assets.precompile << "trestle/theme.css"
-      end
-    end
-
-    initializer "trestle.turbolinks" do |app|
-      # Optional turbolinks
-      app.config.assets.precompile << "turbolinks.js" if Trestle.config.turbolinks
-    end
-
     config.to_prepare do
       Engine.reset_helpers!
     end
@@ -49,6 +41,22 @@ module Trestle
       reloader.install(app) unless app.config.eager_load
     end
 
+    # For compatibility with the `sassc-rails`` gem, register a custom compressor that excludes the
+    # Trestle admin stylesheets as a) they are already minimized and b) libsass is not compatible with
+    # some of the newer CSS syntax that is used.
+    #
+    # To avoid this being necessary, it is recommended that either
+    #   1) `sassc-rails` is removed from the Gemfile (if not required),
+    #   2) the `sassc-embedded` gem is added to the Gemfile, or
+    #   3) `sassc-rails` is replaced with `dartsass-sprockets`
+    config.assets.configure do |env|
+      if original_compressor = config.assets.css_compressor
+        require "trestle/sprockets_compressor"
+        original_compressor = Sprockets.compressors['text/css'][original_compressor] if original_compressor.is_a?(Symbol)
+        config.assets.css_compressor = Trestle::SprocketsCompressor.new(original_compressor)
+      end
+    end if defined?(SassC::Rails)
+
     def reset_helpers!
       @helpers = nil
     end

data/lib/trestle/form/fields/check_box_helpers.rb

@@ -2,10 +2,6 @@ module Trestle
   class Form
     module Fields
       module CheckBoxHelpers
-        def custom?
-          options[:custom] != false
-        end
-
         def switch?
           options[:switch]
         end
@@ -15,26 +11,19 @@ module Trestle
         end
 
         def default_wrapper_class
-          if custom?
-            [
-              "custom-control",
-              switch? ? "custom-switch" : "custom-checkbox",
-              ("custom-control-inline" if inline?)
-            ].compact
-          else
-            [
-              "form-check",
-              ("form-check-inline" if inline?)
-            ].compact
-          end
+          [
+            "form-check",
+            ("form-switch" if switch?),
+            ("form-check-inline" if inline?)
+          ].compact
         end
 
         def input_class
-          custom? ? ["custom-control-input"] : ["form-check-input"]
+          ["form-check-input"]
         end
 
         def label_class
-          custom? ? ["custom-control-label"] : ["form-check-label"]
+          ["form-check-label"]
         end
 
         def defaults

data/lib/trestle/form/fields/collection_select.rb

@@ -16,7 +16,7 @@ module Trestle
         end
 
         def default_html_options
-          Trestle::Options.new(class: ["form-control"], disabled: disabled? || readonly?, data: { enable_select2: true })
+          Trestle::Options.new(class: ["form-select"], disabled: disabled? || readonly?, data: { controller: "select" })
         end
       end
     end

data/lib/trestle/form/fields/color_field.rb

@@ -2,6 +2,10 @@ class Trestle::Form::Fields::ColorField < Trestle::Form::Fields::FormControl
   def field
     builder.raw_color_field(name, options)
   end
+
+  def defaults
+    super.merge(class: ["form-control-color"])
+  end
 end
 
 Trestle::Form::Builder.register(:color_field, Trestle::Form::Fields::ColorField)

data/lib/trestle/form/fields/date_field.rb

@@ -4,6 +4,10 @@ class Trestle::Form::Fields::DateField < Trestle::Form::Fields::FormControl
   def field
     builder.raw_date_field(name, options)
   end
+
+  def controller
+    "datepicker"
+  end
 end
 
 Trestle::Form::Builder.register(:date_field, Trestle::Form::Fields::DateField)

data/lib/trestle/form/fields/date_picker.rb

@@ -4,13 +4,15 @@ module Trestle::Form::Fields::DatePicker
       options[:prepend] ||= options.delete(:icon) { default_icon }
     end
 
-    if enable_date_picker?
-      options.reverse_merge!(data: { picker: true, allow_clear: true })
-    end
-
     super
   end
 
+  def defaults
+    defaults = super
+    defaults.merge!(data: { controller: controller, allow_clear: true }) if enable_date_picker?
+    defaults
+  end
+
   def default_icon
     icon("fa fa-calendar")
   end
@@ -18,4 +20,8 @@ module Trestle::Form::Fields::DatePicker
   def enable_date_picker?
     !disabled? && !readonly? && options[:picker] != false
   end
+
+  def controller
+    "datepicker"
+  end
 end

data/lib/trestle/form/fields/date_select.rb

@@ -17,7 +17,7 @@ module Trestle
         end
 
         def default_html_options
-          Trestle::Options.new(class: ["form-control"], disabled: readonly?, data: { enable_select2: true })
+          Trestle::Options.new(class: ["form-select"], disabled: readonly?, data: { controller: "select" })
         end
       end
     end

data/lib/trestle/form/fields/datetime_field.rb

@@ -4,6 +4,10 @@ class Trestle::Form::Fields::DatetimeField < Trestle::Form::Fields::FormControl
   def field
     builder.raw_datetime_field(name, options)
   end
+
+  def controller
+    "datetimepicker"
+  end
 end
 
 Trestle::Form::Builder.register(:datetime_field, Trestle::Form::Fields::DatetimeField)

data/lib/trestle/form/fields/datetime_select.rb

@@ -17,7 +17,7 @@ module Trestle
         end
 
         def default_html_options
-          Trestle::Options.new(class: ["form-control"], disabled: readonly?, data: { enable_select2: true })
+          Trestle::Options.new(class: ["form-select"], disabled: readonly?, data: { controller: "select" })
         end
       end
     end

data/lib/trestle/form/fields/file_field.rb

@@ -1,31 +1,6 @@
-module Trestle
-  class Form
-    module Fields
-      class FileField < Field
-        def field
-          if custom?
-            content_tag(:div, class: "custom-file") do
-              concat builder.raw_file_field(name, options.merge(class: "custom-file-input"))
-              concat builder.label(name, choose_file_text, class: "custom-file-label", data: { browse: browse_text })
-            end
-          else
-            builder.raw_file_field(name, options)
-          end
-        end
-
-        def custom?
-          options[:custom] != false
-        end
-
-        def choose_file_text
-          I18n.t("trestle.file.choose_file", default: "Choose file...")
-        end
-
-        def browse_text
-          I18n.t("trestle.file.browse", default: "Browse")
-        end
-      end
-    end
+class Trestle::Form::Fields::FileField < Trestle::Form::Fields::FormControl
+  def field
+    builder.raw_file_field(name, options)
   end
 end
 

data/lib/trestle/form/fields/form_control.rb

@@ -13,9 +13,9 @@ module Trestle
         def input_group
           if @prepend || @append
             content_tag(:div, class: "input-group") do
-              concat content_tag(:div, input_group_addon(@prepend), class: "input-group-prepend") if @prepend
+              concat input_group_addon(@prepend) if @prepend
               concat yield
-              concat content_tag(:div, input_group_addon(@append), class: "input-group-append") if @append
+              concat input_group_addon(@append) if @append
             end
           else
             yield

data/lib/trestle/form/fields/form_group.rb

@@ -42,7 +42,7 @@ module Trestle
         end
 
         def label
-          builder.label(name, options[:label], class: ["control-label", ("sr-only" if options[:hide_label])].compact)
+          builder.label(name, options[:label], class: ["form-label", ("visually-hidden" if options[:hide_label])].compact)
         end
 
         def defaults

data/lib/trestle/form/fields/grouped_collection_select.rb

@@ -16,7 +16,7 @@ module Trestle
         end
 
         def default_html_options
-          Trestle::Options.new(class: ["form-control"], disabled: disabled? || readonly?, data: { enable_select2: true })
+          Trestle::Options.new(class: ["form-select"], disabled: disabled? || readonly?, data: { controller: "select" })
         end
       end
     end

data/lib/trestle/form/fields/radio_button_helpers.rb

@@ -2,35 +2,23 @@ module Trestle
   class Form
     module Fields
       module RadioButtonHelpers
-        def custom?
-          options[:custom] != false
-        end
-
         def inline?
           options[:inline]
         end
 
         def default_wrapper_class
-          if custom?
-            [
-              "custom-control",
-              "custom-radio",
-              ("custom-control-inline" if inline?)
-            ].compact
-          else
-            [
-              "form-check",
-              ("form-check-inline" if inline?)
+          [
+            "form-check",
+            ("form-check-inline" if inline?)
           ].compact
-          end
         end
 
         def input_class
-          custom? ? ["custom-control-input"] : ["form-check-input"]
+          ["form-check-input"]
         end
 
         def label_class
-          custom? ? ["custom-control-label"] : ["form-check-label"]
+          ["form-check-label"]
         end
       end
     end

data/lib/trestle/form/fields/range_field.rb

@@ -6,12 +6,8 @@ module Trestle
           builder.raw_range_field(name, options)
         end
 
-        def custom?
-          options[:custom] != false
-        end
-
         def defaults
-          custom? ? super.merge(class: ["custom-range"]) : super
+          super.merge(class: ["form-range"])
         end
       end
     end

data/lib/trestle/form/fields/select.rb

@@ -18,13 +18,29 @@ module Trestle
         end
 
         def default_html_options
-          Trestle::Options.new(class: ["form-control"], disabled: disabled? || readonly?, data: { enable_select2: true })
+          Trestle::Options.new(class: ["form-select"], disabled: disabled? || readonly?, data: { controller: "select", placeholder: placeholder, allow_clear: clearable? })
         end
 
         def default_choices
           builder.object.send(name) if builder.object
         end
 
+        def placeholder
+          prompt = options[:prompt] || options[:include_blank]
+
+          if prompt.kind_of?(String)
+            prompt
+          elsif options[:prompt]
+            I18n.translate("helpers.select.prompt", default: "Please select")
+          elsif options[:include_blank]
+            ""
+          end
+        end
+
+        def clearable?
+          options[:allow_clear] || options[:prompt].present? || options[:include_blank].present?
+        end
+
         # Allows an array of model instances (or a scope) to be
         # passed to the select field as the list of choices.
         class Choices

data/lib/trestle/form/fields/time_field.rb

@@ -8,6 +8,10 @@ class Trestle::Form::Fields::TimeField < Trestle::Form::Fields::FormControl
   def default_icon
     icon("fa fa-clock-o")
   end
+
+  def controller
+    "timepicker"
+  end
 end
 
 Trestle::Form::Builder.register(:time_field, Trestle::Form::Fields::TimeField)

data/lib/trestle/form/fields/time_select.rb

@@ -17,7 +17,7 @@ module Trestle
         end
 
         def default_html_options
-          Trestle::Options.new(class: ["form-control"], disabled: readonly?, data: { enable_select2: true })
+          Trestle::Options.new(class: ["form-select"], disabled: readonly?, data: { controller: "select" })
         end
       end
     end

data/lib/trestle/form/fields/time_zone_select.rb

@@ -16,7 +16,7 @@ module Trestle
         end
 
         def default_html_options
-          Trestle::Options.new(class: ["form-control"], disabled: disabled? || readonly?, data: { enable_select2: true })
+          Trestle::Options.new(class: ["form-select"], disabled: disabled? || readonly?, data: { controller: "select" })
         end
       end
     end

data/lib/trestle/form/renderer.rb

@@ -14,7 +14,7 @@ module Trestle
       include Hook::Helpers
 
       # Whitelisted helpers will concatenate their result to the output buffer when called.
-      WHITELISTED_HELPERS = [:row, :col, :render, :tab, :table, :divider, :h1, :h2, :h3, :h4, :h5, :h6, :card, :panel, :well]
+      WHITELISTED_HELPERS = [:row, :col, :render, :tab, :table, :divider, :h1, :h2, :h3, :h4, :h5, :h6, :card, :panel, :well, :turbo_frame_tag]
 
       # Raw block helpers will pass their block argument directly to the method without wrapping it in a new output buffer.
       RAW_BLOCK_HELPERS = [:table, :toolbar]
@@ -23,6 +23,9 @@ module Trestle
       # that they can be delegated to the form builder or template by method_missing.
       undef_method :select, :display
 
+      # These methods defined in ActionView::Helpers::CaptureHelper should be called directly on the existing template object.
+      delegate :content_for, :content_for?, :provide, to: :@template
+
       delegate :concat, to: :output_buffer
 
       def initialize(template, form=nil)

data/lib/trestle/form.rb

@@ -10,10 +10,25 @@ module Trestle
 
     def initialize(options={}, &block)
       @options, @block = options, block
+
+      if @options[:modal] == true
+        @options[:modal] = {}
+      end
+
+      if options[:dialog]
+        Trestle.deprecator.warn("`form dialog: true` is deprecated. Please use `form modal: true` instead.", caller_locations(3))
+        @options.delete(:dialog)
+        @options[:modal] = {}
+      end
+    end
+
+    def modal?
+      options[:modal]
     end
 
     def dialog?
-      options[:dialog] == true
+      Trestle.deprecator.warn("`Trestle::Form#dialog?` is deprecated. Please use `modal?` instead.")
+      options[:modal]
     end
 
     def render(template, instance)

data/lib/trestle/resource/toolbar.rb

@@ -5,20 +5,30 @@ module Trestle
         delegate :admin, :instance, to: :@template
         delegate :translate, :t, to: :admin
 
-        def new
-          link(t("buttons.new", default: "New %{model_name}"), action: :new, style: :light, icon: "fa fa-plus", class: "btn-new-resource") if action?(:new)
+        def new(label: t("buttons.new", default: "New %{model_name}"), **attrs)
+          return unless action?(:new)
+
+          defaults = { action: :new, style: :light, icon: "fa fa-plus", class: "btn-new-resource" }
+          link(label, defaults.merge(attrs))
         end
 
-        def save
-          button(t("buttons.save", default: "Save %{model_name}"), style: :success)
+        def save(label: t("buttons.save", default: "Save %{model_name}"), **attrs)
+          defaults = { style: :success }
+          button(label, defaults.merge(attrs))
         end
 
-        def delete
-          link(t("buttons.delete", default: "Delete %{model_name}"), instance, action: :destroy, method: :delete, style: :danger, icon: "fa fa-trash", data: { toggle: "confirm-delete", placement: "bottom" }) if action?(:destroy)
+        def delete(label: t("buttons.delete", default: "Delete %{model_name}"), **attrs)
+          return unless action?(:destroy)
+
+          defaults = Trestle::Options.new(action: :destroy, style: :danger, icon: "fa fa-trash", data: { turbo_method: "delete", turbo_frame: "_top", controller: "confirm-delete", confirm_delete_placement_value: "bottom" })
+          link(label, instance, defaults.merge(attrs))
         end
 
-        def dismiss
-          button(t("buttons.ok", default: "OK"), style: :light, data: { dismiss: "modal" }) if @template.dialog_request?
+        def dismiss(label: t("buttons.ok", default: "OK"), **attrs)
+          return unless @template.modal_request?
+
+          defaults = Trestle::Options.new(type: :button, style: :light, data: { bs_dismiss: "modal" })
+          button(label, defaults.merge(attrs))
         end
         alias ok dismiss
 

data/lib/trestle/sprockets_compressor.rb

@@ -0,0 +1,16 @@
+module Trestle
+  class SprocketsCompressor
+    def initialize(original_compressor, excluded_files: ["trestle/admin"])
+      @original_compressor = original_compressor
+      @excluded_files = excluded_files
+    end
+
+    def call(input)
+      if @excluded_files.include?(input[:name])
+        input[:data]
+      else
+        @original_compressor.call(input)
+      end
+    end
+  end
+end

data/lib/trestle/table/actions_column.rb

@@ -42,7 +42,7 @@ module Trestle
         end
 
         def delete
-          link(t("buttons.delete", default: "Delete"), instance, admin: admin, action: :destroy, method: :delete, icon: "fa fa-trash", style: :danger, data: { toggle: "confirm-delete", placement: "left" })
+          link(t("buttons.delete", default: "Delete"), instance, admin: admin, action: :destroy, icon: "fa fa-trash", style: :danger, data: { turbo_method: "delete", controller: "confirm-delete", confirm_delete_placement_value: "left" })
         end
 
         builder_method :show, :edit, :delete
@@ -67,7 +67,7 @@ module Trestle
         end
 
         def classes
-          super + ["actions"]
+          super + ["table-actions"]
         end
 
         def content(instance)

data/lib/trestle/table/row.rb

@@ -33,8 +33,9 @@ module Trestle
           options = Trestle::Options.new
 
           if @table.admin && @table.autolink? && @table.admin.actions.include?(:show)
+            options.merge!(data: { controller: "follow-url", action: "click->follow-url#follow" })
             options.merge!(data: { url: admin_url_for(instance) })
-            options.merge!(data: { behavior: "dialog" }) if @table.admin.form.dialog?
+            options.merge!(data: { modal: true }) if @table.admin.form.modal?
           end
 
           options.merge!(@row.options)

data/lib/trestle/table/select_column.rb

@@ -13,11 +13,11 @@ module Trestle
 
       class Renderer < Column::Renderer
         def header
-          checkbox "", nil, id: checkbox_id("all")
+          checkbox "", nil, id: checkbox_id("all"), data: { checkbox_select_target: "selectAll", action: "change->checkbox-select#toggleAll" }
         end
 
         def content(instance)
-          checkbox "selected[]", instance.to_param, id: checkbox_id(instance.to_param)
+          checkbox "selected[]", instance.to_param, id: checkbox_id(instance.to_param), data: { checkbox_select_target: "checkbox", action: "change->checkbox-select#toggle" }
         end
 
         def classes
@@ -34,10 +34,7 @@ module Trestle
         end
 
         def checkbox(name, value="1", options={})
-          @template.content_tag(:div, class: "custom-control custom-checkbox") do
-            @template.check_box_tag(name, value, false, options.merge(class: "custom-control-input")) +
-              @template.tag(:label, for: options.fetch(:id), class: "custom-control-label")
-          end
+          @template.check_box_tag(name, value, false, options.merge(class: "form-check-input"))
         end
       end
     end

data/lib/trestle/table.rb

@@ -70,7 +70,12 @@ module Trestle
       end
 
       def data
-        options[:data]
+        data = options[:data] || {}
+
+        controllers = Array(data[:controller])
+        controllers << "checkbox-select"
+
+        data.merge(controller: controllers.join(" "))
       end
     end
   end

data/lib/trestle/toolbar/context.rb

@@ -21,11 +21,10 @@ module Trestle
       end
 
     private
-      def respond_to_missing?(name, include_all=false)
-        builder.respond_to?(name) || super
-      end
+      def self.ruby2_keywords(*)
+      end unless respond_to?(:ruby2_keywords, true)
 
-      def method_missing(name, *args, &block)
+      ruby2_keywords def method_missing(name, *args, &block)
         result = builder.send(name, *args, &block)
 
         if builder.builder_methods.include?(name)
@@ -34,6 +33,10 @@ module Trestle
           result
         end
       end
+
+      def respond_to_missing?(name, include_all=false)
+        builder.respond_to?(name) || super
+      end
     end
   end
 end