trestle 0.9.0 → 0.9.8

data/frontend/js/components/pagination.js

@@ -0,0 +1,51 @@
+/* global history */
+
+import $ from 'jquery'
+
+import { triggerInit } from '../core/events'
+
+const REMOTE_PAGINATION_SELECTOR = '.page-link[data-remote]'
+
+$(document)
+  .on('ajax:send', function (e) {
+    const $context = $(e.target).closest('[data-context]')
+    const $table = $context.find('.table-container')
+    $table.addClass('loading')
+  })
+
+  .on('ajax:complete', function (e) {
+    const $context = $(e.target).closest('[data-context]')
+    const $table = $context.find('.table-container')
+    $table.removeClass('loading')
+  })
+
+  .on('ajax:success', REMOTE_PAGINATION_SELECTOR, function (e) {
+    const $link = $(e.target)
+    const $context = $link.closest('[data-context]')
+
+    // Update table and pagination
+    const $doc = $(e.detail[0])
+
+    const $table = $doc.find('.table-container')
+    $context.find('.table-container').replaceWith($table)
+
+    triggerInit($table)
+
+    const $pagination = $doc.find('.pagination-container')
+    $context.find('.pagination-container').replaceWith($pagination)
+
+    // Update the URL in the browser and context
+    const location = $link.attr('href')
+
+    if (location) {
+      // TODO: Implement URL updating with back button support
+      // if ($context.hasClass('app-main')) {
+      //   history.pushState({}, '', location)
+      // }
+
+      $context.data('context', location)
+    }
+
+    // Scroll to top of table
+    $table[0].scrollIntoView(true)
+  })

data/frontend/js/components/sidebar.js

@@ -3,6 +3,8 @@ import $ from 'jquery'
 import { ready } from '../core/events'
 import cookie from '../core/cookie'
 
+import Navigation from './navigation'
+
 ready(function () {
   const $body = $('body')
   const $wrapper = $('.app-wrapper')
@@ -24,10 +26,10 @@ ready(function () {
   // Interacting outside of the sidebar closes the navigation
 
   $wrapper.on('click touchstart', function (e) {
-    let navExpanded = $('body').hasClass('mobile-nav-expanded')
+    const navExpanded = $('body').hasClass('mobile-nav-expanded')
 
-    let clickInHeader = $(e.target).closest('.app-header').length
-    let clickInSidebar = $(e.target).closest('.app-sidebar').length
+    const clickInHeader = $(e.target).closest('.app-header').length
+    const clickInSidebar = $(e.target).closest('.app-sidebar').length
 
     if (navExpanded && !clickInHeader && !clickInSidebar) {
       e.stopPropagation()
@@ -60,18 +62,13 @@ ready(function () {
   $sidebar.find('.nav-header a').on('click', function (e) {
     e.preventDefault()
 
-    $(this).closest('ul').toggleClass('collapsed')
-
-    let collapsed = $sidebar.find('.collapsed .nav-header a').map(function () {
-      return $(this).attr('href').replace(/^#/, '')
-    }).toArray()
-
-    cookie.set('trestle:navigation:collapsed', collapsed.join(','))
+    const list = $(this).closest('ul')
+    Navigation.toggle(list)
   })
 
   // Scroll sidebar to active item
 
-  let $active = $sidebar.find('.active')
+  const $active = $sidebar.find('.active')
   if ($active.length) {
     $sidebar.find('.app-sidebar-inner').scrollTop($active.offset().top - 100)
   }

data/frontend/js/components/table.js

@@ -5,7 +5,7 @@ import visit from '../core/visit'
 // Allow clicking on any part of a table row to follow either the table's data-url
 // or the first link within the row (that is not in the actions column).
 $(document).on('click', 'tr[data-url]:not([data-behavior="dialog"])', function (e) {
-  let row = $(e.currentTarget)
+  const row = $(e.currentTarget)
 
   let url
 
@@ -25,6 +25,37 @@ $(document).on('click', 'tr[data-url]:not([data-behavior="dialog"])', function (
 })
 
 // Ignore the above event handler when clicking directly on a link or input element
-$(document).on('click', 'tr[data-url] a, tr[data-url] input', function (e) {
+$(document).on('click', 'tr[data-url] a, tr[data-url] input, .select-row', function (e) {
   e.stopPropagation()
 })
+
+// Handle clicking on select all checkbox in table header
+$(document).on('click', 'th.select-row input', function (e) {
+  const table = $(this).closest('table')
+  const checked = $(this).is(':checked')
+
+  table.find('td.select-row input').prop('checked', checked)
+})
+
+// Handle single row selection to update header row status
+$(document).on('click', 'td.select-row input', function (e) {
+  const table = $(this).closest('table')
+
+  const checkboxes = table.find('td.select-row input')
+  const selectedCheckboxes = checkboxes.filter(':checked')
+
+  const header = table.find('th.select-row input')
+
+  if (checkboxes.length === selectedCheckboxes.length) {
+    // All checked
+    header.prop('indeterminate', false)
+    header.prop('checked', true)
+  } else if (selectedCheckboxes.length === 0) {
+    // None checked
+    header.prop('indeterminate', false)
+    header.prop('checked', false)
+  } else {
+    // Some checked
+    header.prop('indeterminate', true)
+  }
+})

data/frontend/js/components/tabs.js

@@ -2,11 +2,11 @@
 
 import $ from 'jquery'
 
-import { init, ready } from '../core/events'
+import { init } from '../core/events'
 
 const TAB_SELECTOR = 'a[data-toggle="tab"]'
 const TAB_PANE_SELECTOR = '.tab-pane'
-const ERROR_SELECTOR = '.is-invalid:not([type="hidden"])'
+const ERROR_SELECTOR = '.has-error'
 
 // Save active tab to URL hash
 init(function (root) {
@@ -21,7 +21,7 @@ init(function (root) {
 })
 
 // Restore active tab when loading
-ready(function () {
+init(function () {
   focusActiveTab()
 })
 

data/frontend/js/core/events.js

@@ -1,5 +1,7 @@
 import $ from 'jquery'
 
+import turbolinks from './turbolinks'
+
 // The ready function sets up a callback to run on each page load.
 //
 //     Trestle.ready(function() {
@@ -41,6 +43,8 @@ ready(function () {
 })
 
 // Trigger the page load events.
-$(document).on('ready turbolinks:load', function () {
-  triggerReady()
-})
+if (turbolinks) {
+  $(document).on('turbolinks:load', triggerReady)
+} else {
+  $(document).ready(triggerReady)
+}

data/frontend/js/index.js

@@ -29,6 +29,7 @@ import Dialog from './components/dialog'
 import './components/file'
 import './components/form'
 import './components/gallery'
+import './components/pagination'
 import './components/select'
 import './components/sidebar'
 import './components/table'

data/frontend/theme/trestle/theme/_defaults.scss

@@ -8,7 +8,7 @@ $theme-colors: (
 $theme-color-interval: 8% !default;
 
 // The yiq lightness value that determines when the lightness of color changes from "dark" to "light". Acceptable values are between 0 and 255.
-$yiq-contrasted-threshold: 150 !default;
+$yiq-contrasted-threshold: 175 !default;
 
 // Customize the light and dark text colors for use in our YIQ color contrast function.
 $yiq-text-dark:  #212529 !default;
@@ -115,9 +115,9 @@ $badge-focus-width: $input-btn-focus-width !default;
 
 // Alerts
 
-$alert-bg-level:     -10 !default;
-$alert-border-level: -9 !default;
-$alert-color-level:  6 !default;
+$alert-bg-level:     2 !default;
+$alert-border-level: 3 !default;
+$alert-color-level:  -12 !default;
 
 
 // Progress bars

data/frontend/theme/trestle/theme/bootstrap/_buttons.scss

@@ -11,6 +11,9 @@
 
   &:focus,
   &.focus {
+    color: color-yiq($hover-background);
+    background-color: $hover-background;
+    border-color: $hover-border;
     box-shadow: 0 0 0 $btn-focus-width rgba(mix(color-yiq($background), $border, 15%), .5);
   }
 

data/lib/generators/trestle/install/install_generator.rb

@@ -10,8 +10,12 @@ module Trestle
       end
 
       def create_assets
-        template "_theme.scss",  "app/assets/stylesheets/trestle/_theme.scss"
-        template "_custom.scss", "app/assets/stylesheets/trestle/_custom.scss"
+        if defined?(Sass) || defined?(SassC)
+          template "_custom.scss", "app/assets/stylesheets/trestle/_custom.scss"
+          template "_theme.scss",  "app/assets/stylesheets/trestle/_theme.scss"
+        else
+          template "_custom.css", "app/assets/stylesheets/trestle/_custom.css"
+        end
 
         template "custom.js",    "app/assets/javascripts/trestle/custom.js"
       end

data/lib/generators/trestle/install/templates/_custom.css

@@ -0,0 +1,8 @@
+/* This file may be used for providing additional customizations to the Trestle
+ * admin. It will be automatically included within all admin pages.
+ *
+ * For organizational purposes, you may wish to define your customizations
+ * within individual partials in this folder and they'll be required below.
+ *
+ *= require_tree .
+*/

data/lib/generators/trestle/install/templates/_theme.scss

@@ -9,5 +9,5 @@
 //
 //   $theme-colors: (
 //     "primary":   #337ab7,
-//     "secondary": #b3b53d
+//     "secondary": #719dc3
 //   );

data/lib/generators/trestle/install/templates/trestle.rb.erb

@@ -15,7 +15,7 @@ Trestle.configure do |config|
   #
   # config.site_logo_small = "logo-small.png"
 
-  # Speficy a favicon to be used within the admin.
+  # Specify a favicon to be used within the admin.
   #
   # config.favicon = "favicon.ico"
 
@@ -70,6 +70,7 @@ Trestle.configure do |config|
   # Specify helper modules to expose to the admin.
   #
   # config.helper :all
+  # config.helper -> { CustomHelper }
 
   # Register callbacks to run before, after or around all Trestle actions.
   #
@@ -103,6 +104,11 @@ Trestle.configure do |config|
   #
   # config.persistent_params << :query
 
+  # List of methods to try calling on an instance when displayed by the `display` helper.
+  # Defaults to [:display_name, :full_name, :name, :title, :username, :login, :email].
+  #
+  # config.display_methods.unshift(:admin_label)
+
   # Customize the default adapter class used by all admin resources.
   # See the documentation on Trestle::Adapters::Adapter for details on
   # the adapter methods that can be customized.
@@ -118,7 +124,7 @@ Trestle.configure do |config|
   #   def render; end
   # end
   #
-  # config.form_field :custom, CustomFormField
+  # config.form_field :custom, -> { CustomFormField }
 
   # == Debugging Options
   #

data/lib/generators/trestle/resource/resource_generator.rb

@@ -3,10 +3,24 @@ module Trestle
     class ResourceGenerator < ::Rails::Generators::NamedBase
       desc "Creates a Trestle admin resource"
 
+      class_option :singular, type: :boolean, default: false, desc: "Generate a singular resource"
+
       source_root File.expand_path("../templates", __FILE__)
 
       def create_admin
-        template "admin.rb.erb", File.join("app/admin", class_path, "#{plural_name}_admin.rb")
+        template "admin.rb.erb", File.join("app/admin", class_path, "#{admin_name}_admin.rb")
+      end
+
+      def admin_name
+        singular? ? singular_name : plural_name
+      end
+
+      def parameter_name
+        singular_name.singularize
+      end
+
+      def singular?
+        options[:singular]
       end
 
     protected

data/lib/generators/trestle/resource/templates/admin.rb.erb

@@ -1,8 +1,14 @@
-Trestle.resource(:<%= plural_name %><% if module? %>, scope: <%= module_name %><% end %>) do
+Trestle.resource(:<%= admin_name %><% if module? %>, scope: <%= module_name %><% end %><% if singular? %>, singular: true<% end %>) do
   menu do
-    item :<%= plural_name %>, icon: "fa fa-star"
+    item :<%= admin_name %>, icon: "fa fa-star"
   end
 
+<%- if singular? -%>
+  instance do
+    # Override this block to define the instance that this resource represents.
+    raise NotImplementedError, "Singular resources must define an instance block."
+  end
+<%- else -%>
   # Customize the table columns shown on the index view.
   #
   # table do
@@ -10,19 +16,20 @@ Trestle.resource(:<%= plural_name %><% if module? %>, scope: <%= module_name %><
   #   column :created_at, align: :center
   #   actions
   # end
+<%- end -%>
 
-  # Customize the form fields shown on the new/edit views.
+  # Customize the form fields shown on the <% if singular? %>edit view<% else %>new/edit views<% end %>.
   #
-  # form do |<%= singular_table_name %>|
+  # form do |<%= parameter_name %>|
   #   text_field :name
   #
   #   row do
-  #     col(xs: 6) { datetime_field :updated_at }
-  #     col(xs: 6) { datetime_field :created_at }
+  #     col { datetime_field :updated_at }
+  #     col { datetime_field :created_at }
   #   end
   # end
 
-  # By default, all parameters passed to the update and create actions will be
+  # By default, all parameters passed to the <% if singular? %>update action<% else %>update and create actions<% end %> will be
   # permitted. If you do not have full trust in your users, you should explicitly
   # define the list of permitted parameters.
   #
@@ -30,6 +37,6 @@ Trestle.resource(:<%= plural_name %><% if module? %>, scope: <%= module_name %><
   #   http://guides.rubyonrails.org/action_controller_overview.html#strong-parameters
   #
   # params do |params|
-  #   params.require(:<%= singular_table_name %>).permit(:name, ...)
+  #   params.require(:<%= parameter_name %>).permit(:name, ...)
   # end
 end

data/lib/trestle/adapters/active_record_adapter.rb

@@ -30,7 +30,7 @@ module Trestle
       end
 
       def count(collection)
-        collection.count
+        collection.count(:all)
       end
 
       def sort(collection, field, order)
@@ -60,6 +60,8 @@ module Trestle
             Attribute::Association.new(column.name, class: -> { reflection.klass }, name: name, polymorphic: reflection.polymorphic?, type_column: reflection.foreign_type)
           elsif column.name.end_with?("_type") && (name = column.name.sub(/_type$/, '')) && (reflection = model.reflections[name])
             # Ignore type columns for polymorphic associations
+          elsif enum_column?(column)
+            Attribute.new(column.name, :enum, values: enum_values(column))
           else
             Attribute.new(column.name, column.type, array_column?(column) ? { array: true } : {})
           end
@@ -81,6 +83,20 @@ module Trestle
       def array_column?(column)
         column.respond_to?(:array?) && column.array?
       end
+
+      def enum_column?(column)
+        model.defined_enums.key?(column.name)
+      end
+
+      def enum_values(column)
+        model.defined_enums[column.name].map { |key, value|
+          [value, enum_human_name(column, key)]
+        }
+      end
+
+      def enum_human_name(column, value)
+        human_attribute_name([column.name.pluralize, value].join("."), default: value.humanize)
+      end
     end
   end
 end

data/lib/trestle/adapters.rb

@@ -2,7 +2,7 @@ module Trestle
   module Adapters
     extend ActiveSupport::Autoload
 
-    autoload :Adapter
+    require_relative "adapters/adapter"
 
     autoload :ActiveRecordAdapter
     autoload :DraperAdapter

data/lib/trestle/admin/builder.rb

@@ -7,7 +7,7 @@ module Trestle
       self.admin_class = Admin
 
       class_attribute :controller
-      self.controller = Controller
+      self.controller = -> { AdminController }
 
       delegate :helper, :before_action, :after_action, :around_action, to: :@controller
 
@@ -27,7 +27,7 @@ module Trestle
         # Define admin controller class
         # This is done using class_eval rather than Class.new so that the full
         # class name and parent chain is set when Rails' inherited hooks are called.
-        admin.class_eval("class AdminController < #{controller.name}; end")
+        admin.class_eval("class AdminController < #{controller.call.name}; end")
 
         # Set a reference on the controller class to the admin class
         controller = admin.const_get(:AdminController)
@@ -53,7 +53,11 @@ module Trestle
       end
 
       def form(options={}, &block)
-        admin.form = Form.new(options, &block)
+        if block_given?
+          admin.form = Form.new(options, &block)
+        else
+          admin.form = Form::Automatic.new(admin, options)
+        end
       end
 
       def hook(name, options={}, &block)

data/lib/trestle/admin.rb

@@ -1,9 +1,6 @@
 module Trestle
   class Admin
-    extend ActiveSupport::Autoload
-
-    autoload :Builder
-    autoload :Controller
+    require_relative "admin/builder"
 
     delegate :to_param, to: :class
 
@@ -67,7 +64,10 @@ module Trestle
       end
 
       def default_breadcrumb
-        Breadcrumb.new(human_admin_name, path)
+        deprecated = I18n.t(:"admin.breadcrumbs.#{i18n_key}", default: human_admin_name)
+        label = translate("breadcrumbs.index", default: deprecated)
+
+        Breadcrumb.new(label, path)
       end
 
       def admin_name
@@ -79,7 +79,7 @@ module Trestle
       end
 
       def human_admin_name
-        I18n.t("admin.breadcrumbs.#{i18n_key}", default: default_human_admin_name)
+        translate("name", default: default_human_admin_name)
       end
 
       def default_human_admin_name
@@ -90,12 +90,12 @@ module Trestle
         defaults = [:"admin.#{i18n_key}.#{key}", :"admin.#{key}"]
         defaults << options[:default] if options[:default]
 
-        I18n.t(defaults.shift, options.merge(default: defaults))
+        I18n.t(defaults.shift, **options.merge(default: defaults))
       end
       alias t translate
 
       def parameter_name
-        admin_name.singularize
+        unscope_path(admin_name.singularize)
       end
 
       def route_name
@@ -165,6 +165,16 @@ module Trestle
       def validate!
         # No validations by default. This can be overridden in subclasses.
       end
+
+    private
+      def unscope_path(path)
+        path = path.to_s
+        if i = path.rindex("/")
+          path[(i + 1)..-1]
+        else
+          path
+        end
+      end
     end
   end
 end

data/lib/trestle/configurable.rb

@@ -15,6 +15,12 @@ module Trestle
       options.fetch(name) {
         if defaults.key?(name)
           value = defaults[name]
+
+          # Avoid references to the same instance of a default value
+          if value.respond_to?(:dup) && !value.is_a?(Proc)
+            value = value.dup
+          end
+
           assign(name, value)
         end
       }
@@ -62,6 +68,16 @@ module Trestle
 
         defaults[name] = default
       end
+
+      def deprecated_option(name, message=nil)
+        define_method("#{name}=") do |value|
+          ActiveSupport::Deprecation.warn(message)
+        end
+
+        define_method(name) do |*args|
+          ActiveSupport::Deprecation.warn(message)
+        end
+      end
     end
 
     module Open

data/lib/trestle/configuration.rb

@@ -41,7 +41,7 @@ module Trestle
     option :root, -> { Trestle.config.path }
 
     # Initial breadcrumbs to display in the breadcrumb trail
-    option :root_breadcrumbs, -> { [Trestle::Breadcrumb.new(I18n.t("admin.breadcrumbs.home", default: "Home"), Trestle.config.root)] }
+    option :root_breadcrumbs, -> { [Trestle::Breadcrumb.new(I18n.t(:"admin.breadcrumbs.home", default: "Home"), Trestle.config.root)] }
 
     # Default icon class to use when it is not explicitly provided
     option :default_navigation_icon, "fa fa-arrow-circle-o-right"
@@ -54,18 +54,17 @@ module Trestle
       menus << Navigation::Block.new(&block)
     end
 
-
     ## Extension Options
 
     # [Internal] List of helper modules to include in all Trestle controllers
-    option :helpers, []
+    option :helpers, Lazy::List.new
 
     # [Internal] Container module for block-defined helpers
     option :helper_module, Module.new
 
     # Register global helpers available to all Trestle admins
     def helper(*helpers, &block)
-      self.helpers += helpers
+      self.helpers << helpers
       self.helper_module.module_eval(&block) if block_given?
     end
 
@@ -82,8 +81,8 @@ module Trestle
     option :default_adapter, Adapters.compose(Adapters::ActiveRecordAdapter, Adapters::DraperAdapter)
 
     # Register a custom form field class
-    def form_field(name, klass)
-      Form::Builder.register(name, klass)
+    def form_field(name, field)
+      Form::Builder.register(name, field)
     end
 
     # [Internal] List of registered hooks
@@ -105,8 +104,8 @@ module Trestle
       -> { ActiveSupport::Dependencies.autoload_paths.grep(/\/app\/admin\Z/) }
     ]
 
-    # When to reload Trestle admin within a to_prepare block (`:always` or `:on_update`)
-    option :reload, :on_update
+    # [DEPRECATED] When to reload Trestle admin within a to_prepare block
+    deprecated_option :reload, "The config.reload option is deprecated. Admins are now always reloaded when config.to_prepare is called."
 
 
     ## Debugging

data/lib/trestle/debug_errors.rb

@@ -0,0 +1,24 @@
+module Trestle
+  class DebugErrors
+    def initialize(errors)
+      @errors = errors
+    end
+
+    def any?
+      @errors.any?
+    end
+
+    def each
+      if defined?(ActiveModel::Error)
+        # Rails 6.1 introduces a unified Error class
+        @errors.each do |error|
+          yield error.attribute, error.message
+        end
+      else
+        @errors.each do |error, message|
+          yield error, message
+        end
+      end
+    end
+  end
+end

data/lib/trestle/engine.rb

@@ -44,16 +44,9 @@ module Trestle
       Engine.reset_helpers!
     end
 
-    config.to_prepare do
-      if Trestle.config.reload == :always
-        Engine.reloader.execute
-      else
-        Engine.reloader.execute_if_updated
-      end
-    end
-
-    def reloader
-      @reloader ||= Trestle::Reloader.new
+    config.after_initialize do |app|
+      reloader = Trestle::Reloader.new(*app.watchable_args)
+      reloader.install(app) unless app.config.eager_load
     end
 
     def reset_helpers!