trestle 0.8.4 → 0.8.11

data/app/controllers/trestle/application_controller.rb

@@ -1,34 +1,10 @@
 class Trestle::ApplicationController < ActionController::Base
   protect_from_forgery
 
-  layout 'trestle/admin'
-
-  # Global helpers
-  self.helpers_path += Rails.application.helpers_paths
-  helper Trestle.config.helper_module
-  helper *Trestle.config.helpers
-
-  # Global callbacks
-  Trestle.config.before_actions.each do |action|
-    before_action(action.options, &action.block)
-  end
-
-  Trestle.config.after_actions.each do |action|
-    after_action(action.options, &action.block)
-  end
-
-  Trestle.config.around_actions.each do |action|
-    around_action(action.options, &action.block)
-  end
-
-protected
-  def breadcrumbs
-    @breadcrumbs ||= Trestle::Breadcrumb::Trail.new(Trestle.config.root_breadcrumbs)
-  end
-  helper_method :breadcrumbs
-
-  def breadcrumb(label, path=nil)
-    breadcrumbs.append(label, path)
-  end
-  helper_method :breadcrumb
+  include Trestle::Controller::Breadcrumbs
+  include Trestle::Controller::Callbacks
+  include Trestle::Controller::Dialog
+  include Trestle::Controller::Helpers
+  include Trestle::Controller::Layout
+  include Trestle::Controller::Location
 end

data/app/helpers/trestle/avatar_helper.rb

@@ -1,10 +1,17 @@
 module Trestle
   module AvatarHelper
-    def avatar(&block)
-      content_tag(:div, class: "avatar", &block)
+    def avatar(options={})
+      fallback = options.delete(:fallback) if options[:fallback]
+
+      content_tag(:div, options.reverse_merge(class: "avatar")) do
+        concat content_tag(:span, fallback, class: "avatar-fallback") if fallback
+        concat yield if block_given?
+      end
     end
 
     def gravatar(email, options={})
+      options = { d: "mm" }.merge(options)
+
       url = "https://www.gravatar.com/avatar/#{Digest::MD5.hexdigest(email.to_s.downcase)}.png"
       url << "?#{options.to_query}" if options.any?
 

data/app/helpers/trestle/flash_helper.rb

@@ -0,0 +1,15 @@
+module Trestle
+  module FlashHelper
+    def normalize_flash_alert(flash)
+      flash.is_a?(Hash) ? flash.with_indifferent_access : { message: flash }
+    end
+
+    def debug_form_errors?
+      Trestle.config.debug_form_errors && instance_has_errors?
+    end
+
+    def instance_has_errors?
+      instance.errors.any? rescue false
+    end
+  end
+end

data/app/helpers/trestle/form_helper.rb

@@ -2,7 +2,10 @@ module Trestle
   module FormHelper
     def trestle_form_for(instance, options={}, &block)
       options[:builder] ||= Form::Builder
-      options[:as] ||= admin.admin_name.singularize
+      options[:as] ||= admin.parameter_name
+
+      options[:data] ||= {}
+      options[:data].reverse_merge!(remote: true, type: :html, behavior: "trestle-form", turbolinks: false)
 
       form_for(instance, options) do |f|
         with_form(f) { yield f }
@@ -20,12 +23,12 @@ module Trestle
       @_trestle_form
     end
 
-    def toolbar(name, &block)
-      content_for(:"#{name}_toolbar", &block)
-    end
-
     def sidebar(&block)
       content_for(:sidebar, &block)
     end
+
+    def render_sidebar_as_tab?
+      dialog_request? && content_for?(:sidebar)
+    end
   end
 end

data/app/helpers/trestle/format_helper.rb

@@ -13,7 +13,7 @@ module Trestle
       when :currency
         number_to_currency(value)
       when :tags
-        safe_join(value.map { |tag| content_tag(:span, tag, class: "tag") })
+        safe_join(Array(value).map { |tag| content_tag(:span, tag, class: "tag") })
       else
         value
       end
@@ -30,8 +30,12 @@ module Trestle
       when TrueClass, FalseClass
         status_tag(icon("fa fa-check"), :success) if value
       when NilClass
-        text = options.key?(:blank) ? options[:blank] : I18n.t("admin.format.blank")
-        content_tag(:span, text, class: "blank")
+        blank = options.key?(:blank) ? options[:blank] : I18n.t("admin.format.blank")
+        if blank.respond_to?(:call)
+          instance_exec(&blank)
+        else
+          content_tag(:span, blank, class: "blank")
+        end
       when String
         if value.html_safe? || options[:truncate] == false
           value

data/app/helpers/trestle/headings_helper.rb

@@ -0,0 +1,27 @@
+module Trestle
+  module HeadingsHelper
+    def h1(text, options={})
+      content_tag(:h1, text, options)
+    end
+
+    def h2(text, options={})
+      content_tag(:h2, text, options)
+    end
+
+    def h3(text, options={})
+      content_tag(:h3, text, options)
+    end
+
+    def h4(text, options={})
+      content_tag(:h4, text, options)
+    end
+
+    def h5(text, options={})
+      content_tag(:h5, text, options)
+    end
+
+    def h6(text, options={})
+      content_tag(:h6, text, options)
+    end
+  end
+end

data/app/helpers/trestle/hook_helper.rb

@@ -1,13 +1,22 @@
 module Trestle
   module HookHelper
     def hook(name)
-      safe_join(Trestle.config.hooks[name.to_s].map { |hook|
-        instance_exec(&hook)
-      }, "\n")
+      if hook?(name)
+        safe_join(hooks(name).map { |hook|
+          hook.evaluate(self)
+        }, "\n")
+      elsif block_given?
+        yield
+      end
     end
 
     def hook?(name)
-      Trestle.config.hooks[name.to_s].any?
+      Trestle.config.hooks.key?(name.to_s) && hooks(name).any?
+    end
+
+  protected
+    def hooks(name)
+      Trestle.config.hooks[name.to_s].select { |h| h.visible?(self) }
     end
   end
 end

data/app/helpers/trestle/i18n_helper.rb

@@ -0,0 +1,14 @@
+module Trestle
+  module I18nHelper
+    def i18n_fallbacks(locale=I18n.locale)
+      if I18n.respond_to?(:fallbacks)
+        I18n.fallbacks[locale]
+      elsif locale.to_s.include?("-")
+        fallback = locale.to_s.split("-").first
+        [locale, fallback]
+      else
+        [locale]
+      end
+    end
+  end
+end

data/app/helpers/trestle/panel_helper.rb

@@ -0,0 +1,24 @@
+module Trestle
+  module PanelHelper
+    def panel(options={}, &block)
+      html_class = options.fetch(:class) { "panel-default" }
+
+      content_tag(:div, class: ["panel", html_class]) do
+        if options[:title]
+          concat content_tag(:div, options[:title], class: "panel-heading")
+        end
+
+        concat content_tag(:div, class: "panel-body", &block)
+
+        if options[:footer]
+          concat content_tag(:div, options[:footer], class: "panel-footer")
+        end
+      end
+    end
+
+    def well(options={}, &block)
+      html_class = ["well", options[:class]].compact
+      content_tag(:div, options.merge(class: html_class), &block)
+    end
+  end
+end

data/app/helpers/trestle/tab_helper.rb

@@ -5,9 +5,9 @@ module Trestle
     end
 
     def tab(name, options={})
-      tabs[name] = Tab.new(name, options)
+      tabs[name] = tab = Tab.new(name, options)
 
-      content_tag(:div, id: "tab-#{name}", class: ["tab-pane", ('active' if name == tabs.keys.first)], role: "tabpanel") do
+      content_tag(:div, id: tab.id(("modal" if dialog_request?)), class: ["tab-pane", ('active' if name == tabs.keys.first)], role: "tabpanel") do
         if block_given?
           yield
         elsif options[:partial]

data/app/helpers/trestle/table_helper.rb

@@ -1,7 +1,46 @@
 module Trestle
   module TableHelper
-    def table(collection, options={}, &block)
-      table = Table::Builder.build(options, &block)
+    # Renders an existing named table or builds and renders a custom table if a block is provided.
+    #
+    # name    - The (optional) name of the table to render (as a Symbol), or the actual Trestle::Table instance itself.
+    # options - Hash of options that will be passed to the table builder (default: {}):
+    #           :collection - The collection that should be rendered within the table. It should be an
+    #                         Array-like object, but will most likely be an ActiveRecord scope. It can
+    #                         also be a callable object (i.e. a Proc) in which case the result of calling
+    #                         the block will be used as the collection.
+    #           See Trestle::Table::Builder for additional options.
+    # block   - An optional block that is passed to Trestle::Table::Builder to define a custom table.
+    #           One of either the name or block must be provided, but not both.
+    #
+    # Examples
+    #
+    #   <%= table collection: -> { Account.all }, admin: :accounts do %>
+    #     <% column(:name) %>
+    #     <% column(:balance) { |account| account.balance.format } %>
+    #     <% column(:created_at, align: :center)
+    #   <% end %>
+    #
+    #   <%= table :accounts %>
+    #
+    # Returns the HTML representation of the table as a HTML-safe String.
+    def table(name=nil, options={}, &block)
+      if block_given?
+        if name.is_a?(Hash)
+          options = name
+        else
+          collection = name
+        end
+
+        table = Table::Builder.build(options, &block)
+      elsif name.is_a?(Trestle::Table)
+        table = name
+      else
+        table = admin.tables.fetch(name) { raise ArgumentError, "Unable to find table named #{name.inspect}" }
+      end
+
+      collection ||= options[:collection] || table.options[:collection]
+      collection = collection.call if collection.respond_to?(:call)
+
       render "trestle/table/table", table: table, collection: collection
     end
   end

data/app/helpers/trestle/timestamp_helper.rb

@@ -1,17 +1,59 @@
 module Trestle
   module TimestampHelper
-    def timestamp(time)
-      time_tag(time, class: "timestamp") do
+    # Renders a Time object as a formatted timestamp (using a <time> tag)
+    #
+    # time    - The Time object to format.
+    # options - Hash of options (default: {}):
+    #           :class       - Additional HTML classes to add to the <time> tag.
+    #           :precision   - Time precision, either :minutes or :seconds (default: :minutes).
+    #           :date_format - I18n date format to use for the date (default: :trestle_date).
+    #           :time_format - I18n time format to use for the time (default: :trestle_time).
+    #
+    # Examples
+    #
+    #   <%= timestamp(article.created_at) %>
+    #
+    #   <%= timestamp(Time.current, class: "timestamp-inline", precision: :seconds) %>
+    #
+    # Returns the HTML representation of the given Time.
+    def timestamp(time, options={})
+      return unless time
+
+      classes     = ["timestamp", options[:class]].compact
+      precision   = options.fetch(:precision) { Trestle.config.timestamp_precision }
+      date_format = options.fetch(:date_format) { :trestle_date }
+      time_format = options.fetch(:time_format) { precision == :seconds ? :trestle_time_with_seconds : :trestle_time }
+
+      time_tag(time, class: classes) do
         safe_join([
-          l(time, format: :trestle_date, default: proc { |date| "#{date.day.ordinalize} %b %Y" }),
-          content_tag(:small, l(time, format: :trestle_time_with_seconds, default: "%l:%M:%S %p"))
+          l(time, format: date_format, default: proc { |date| "#{date.day.ordinalize} %b %Y" }),
+          content_tag(:small, l(time, format: time_format, default: "%l:%M:%S %p"))
         ], "\n")
       end
     end
 
-    def datestamp(date)
-      time_tag(date, class: "datestamp") do
-        l(date, format: :trestle_calendar, default: "%-m/%-d/%Y")
+    # Renders a Date object as formatted datestamp (using a <time> tag)
+    #
+    # date    - The Date object to format.
+    # options - Hash of options (default: {}):
+    #           :class  - Additional HTML classes to add to the <time> tag.
+    #           :format - I18n date format to use (default: :trestle_calendar).
+    #
+    # Examples
+    #
+    #   <%= datestamp(Date.current) %>
+    #
+    #   <%= datestamp(article.created_at, format: :trestle_date, class: "custom-datestamp") %>
+    #
+    # Returns the HTML representation of the given Date.
+    def datestamp(date, options={})
+      return unless date
+
+      classes = ["datestamp", options[:class]].compact
+      format  = options.fetch(:format) { :trestle_calendar}
+
+      time_tag(date, class: classes) do
+        l(date, format: format, default: "%-m/%-d/%Y")
       end
     end
   end

data/app/helpers/trestle/toolbars_helper.rb

@@ -0,0 +1,34 @@
+module Trestle
+  module ToolbarsHelper
+    def toolbar(name, &block)
+      toolbar = (toolbars[name.to_s] ||= Toolbar.new)
+      toolbar.prepend(&block) if block_given?
+      toolbar
+    end
+
+    def toolbars
+      @_toolbars ||= {}
+    end
+
+    def render_toolbar(toolbar, *args)
+      result = toolbar.groups(self, *args).map do |items|
+        if items.many?
+          content_tag(:div, class: "btn-group", role: "group") do
+            safe_join(items, "\n")
+          end
+        else
+          items.first
+        end
+      end
+
+      safe_join(result, "\n")
+    end
+
+    def deprecated_toolbar(name)
+      if content_for?(:"#{name}_toolbar")
+        ActiveSupport::Deprecation.warn("Using content_for(:#{name}_toolbar) is deprecated. Please use toolbar(:#{name}) instead.")
+        content_for(:"#{name}_toolbar")
+      end
+    end
+  end
+end

data/app/helpers/trestle/url_helper.rb

@@ -1,25 +1,89 @@
 module Trestle
   module UrlHelper
-    def admin_link_to(content, instance=nil, options={}, &block)
+    DIALOG_ACTIONS = [:new, :show, :edit]
+
+    def admin_link_to(content, instance_or_url=nil, options={}, &block)
+      # Block given - ignore content parameter and capture content from block
       if block_given?
-        instance, options = content, instance || {}
+        instance_or_url, options = content, instance_or_url || {}
         content = capture(&block)
       end
 
-      if admin = (options.key?(:admin) ? Trestle.lookup(options.delete(:admin)) : admin_for(instance))
-        link_to(content, admin_url_for(instance, admin: admin), options)
+      if instance_or_url.is_a?(String)
+        # Treat string URL as regular link
+        link_to(content, instance_or_url, options)
       else
-        content
+        # Normalize options if instance is not provided
+        if instance_or_url.is_a?(Hash)
+          instance, options = nil, instance_or_url
+        else
+          instance = instance_or_url
+        end
+
+        # Determine admin
+        if options.key?(:admin)
+          admin = Trestle.lookup(options.delete(:admin))
+        elsif instance
+          admin = admin_for(instance)
+        end
+
+        admin ||= self.admin if respond_to?(:admin)
+
+        if admin
+          # Ensure admin has controller context
+          admin = admin.new(self) if admin.is_a?(Class)
+
+          # Generate path
+          action = options.delete(:action) || :show
+          params = options.delete(:params) || {}
+
+          if admin.respond_to?(:instance_path) && instance
+            path = admin.instance_path(instance, params.reverse_merge(action: action))
+          else
+            params[:id] ||= admin.to_param(instance) if instance
+            path = admin.path(action, params)
+          end
+
+          # Determine link data options
+          if DIALOG_ACTIONS.include?(action) && admin.form.dialog?
+            options[:data] ||= {}
+            options[:data][:behavior] ||= "dialog"
+          end
+
+          link_to(content, path, options)
+        else
+          raise ActionController::UrlGenerationError, "An admin could not be inferred. Please specify an admin using the :admin option."
+        end
       end
     end
 
     def admin_url_for(instance, options={})
-      admin = options.key?(:admin) ? Trestle.lookup(options[:admin]) : admin_for(instance)
-      admin.path(options[:action] || :show, id: admin.to_param(instance)) if admin
+      admin = Trestle.lookup(options.delete(:admin)) if options.key?(:admin)
+      admin ||= admin_for(instance)
+      return unless admin
+
+      # Ensure admin has controller context
+      admin = admin.new(self) if admin.is_a?(Class)
+
+      if admin.respond_to?(:instance_path)
+        admin.instance_path(instance, options)
+      else
+        admin.path(options[:action] || :show, id: admin.to_param(instance))
+      end
     end
 
     def admin_for(instance)
-      Trestle.admins[instance.class.name.underscore.pluralize]
+      klass = instance.class
+
+      while klass
+        admin = Trestle.admins[klass.name.underscore.pluralize]
+        return admin if admin
+
+        klass = klass.superclass
+      end
+
+      # No admin found
+      nil
     end
   end
 end

data/app/views/layouts/trestle/admin.html.erb

@@ -26,9 +26,7 @@
       Trestle.i18n['<%= key %>'] = "<%= escape_javascript(t(key, default: t(key, locale: :en))) %>";
       <% end %>
 
-      if (flatpickr.l10ns['<%= I18n.locale %>']) {
-        flatpickr.localize(flatpickr.l10ns['<%= I18n.locale %>']);
-      }
+      Trestle.localize(<%= i18n_fallbacks.map { |l| "'#{l}'" }.join(", ").html_safe %>);
     </script>
 
     <%= hook :javascripts %>
@@ -38,14 +36,14 @@
     <%= hook :head %>
   </head>
 
-  <body>
+  <body<%=raw " class=\"sidebar-#{cookies["trestle:sidebar"]}\"" if cookies["trestle:sidebar"] %>>
     <div class="app-wrapper">
       <%= render "trestle/shared/sidebar" %>
 
       <div class="app-container">
         <%= render "trestle/shared/header" %>
 
-        <main class="app-main">
+        <main class="app-main" data-context="<%= request.fullpath %>">
           <%= yield %>
         </main>
 

data/app/views/trestle/application/_dialog.html.erb

@@ -0,0 +1,34 @@
+<div class="modal-header">
+  <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
+  <h4 class="modal-title"><%= content_for(:title) %></h4>
+</div>
+
+<div class="modal-flash">
+  <%= render "trestle/flash/flash" %>
+</div>
+
+<div class="modal-tabs">
+  <%= render "tabs" %>
+</div>
+
+<div class="modal-body">
+  <%= yield %>
+
+  <% if content_for?(:sidebar) %>
+    <div id="tab-sidebar" class="tab-pane" role="tabpanel">
+      <%= content_for(:sidebar) %>
+    </div>
+  <% end %>
+</div>
+
+<div class="modal-footer">
+  <div class="btn-toolbar secondary-toolbar">
+    <%= render_toolbar(toolbar(:secondary)) %>
+    <%= deprecated_toolbar(:secondary) %>
+  </div>
+
+  <div class="btn-toolbar primary-toolbar">
+    <%= render_toolbar(toolbar(:primary)) %>
+    <%= deprecated_toolbar(:primary) %>
+  </div>
+</div>

data/app/views/trestle/application/_header.html.erb

@@ -1,27 +1,29 @@
 <header class="content-header">
-  <% if content_for?(:primary_toolbar) %>
+  <div class="content-header-title">
+    <h1>
+      <%= content_for(:title) %>
+    </h1>
+
+    <% unless local_assigns.fetch(:hide_breadcrumbs, false) %>
+    <ol class="breadcrumb">
+      <% breadcrumbs.each do |breadcrumb| %>
+        <li class="breadcrumb-item<% if breadcrumb == breadcrumbs.last %> active<% end %>">
+          <%= link_to breadcrumb.label, breadcrumb.path %>
+        </li>
+      <% end %>
+    </ol>
+    <% end %>
+  </div>
+
+  <div class="content-header-toolbars">
     <div class="btn-toolbar primary-toolbar">
-      <%= content_for(:primary_toolbar) %>
+      <%= render_toolbar(toolbar(:primary)) %>
+      <%= deprecated_toolbar(:primary) %>
     </div>
-  <% end %>
 
-  <% if content_for?(:secondary_toolbar) %>
     <div class="btn-toolbar secondary-toolbar">
-      <%= content_for(:secondary_toolbar) %>
+      <%= render_toolbar(toolbar(:secondary)) %>
+      <%= deprecated_toolbar(:secondary) %>
     </div>
-  <% end %>
-
-  <h1>
-    <%= content_for(:title) %>
-  </h1>
-
-  <% unless local_assigns.fetch(:hide_breadcrumbs, false) %>
-  <ol class="breadcrumb">
-    <% breadcrumbs.each do |breadcrumb| %>
-      <li class="breadcrumb-item<% if breadcrumb == breadcrumbs.last %> active<% end %>">
-        <%= link_to breadcrumb.label, breadcrumb.path %>
-      </li>
-    <% end %>
-  </ol>
-  <% end %>
+  </div>
 </header>

data/app/views/trestle/application/_layout.html.erb

@@ -1,7 +1,7 @@
 <%= render "header", hide_breadcrumbs: local_assigns.fetch(:hide_breadcrumbs, false) if local_assigns.fetch(:header, true) %>
 
 <div class="main-content-area">
-  <%= render "flash" %>
+  <%= render "trestle/flash/flash" %>
   <%= render "utilities" %>
   <%= render "tabs" %>
 

data/app/views/trestle/application/_tabs.html.erb

@@ -1,8 +1,14 @@
-<% if tabs.size > 1 -%>
+<% if tabs.size > 1 || render_sidebar_as_tab? -%>
   <ul class="nav nav-tabs">
     <% tabs.each do |name, tab| %>
       <li<% if name == tabs.keys.first %> class="active"<% end %>>
-        <%= link_to tab.label, "#tab-#{name}", role: "tab", data: { toggle: "tab" } %>
+        <%= link_to tab.label, "##{tab.id(("modal" if dialog_request?))}", role: "tab", data: { toggle: "tab" } %>
+      </li>
+    <% end %>
+
+    <% if render_sidebar_as_tab? %>
+      <li class="pull-right">
+        <%= link_to icon("fa fa-list-alt"), "#tab-sidebar", role: "tab", data: { toggle: "tab" } %>
       </li>
     <% end %>
   </ul>

data/app/views/trestle/{application → flash}/_alert.html.erb

@@ -4,7 +4,12 @@
   <%= icon %>
 
   <div class="alert-content">
-    <h3><%= title %></h3>
-    <p><%= message %></p>
+    <% if alert[:title] %>
+      <h3><%= alert[:title] %></h3>
+    <% end %>
+
+    <p><%= alert[:message] %></p>
+
+    <%= yield if block_given? %>
   </div>
 </div>

data/app/views/trestle/flash/_debug.html.erb

@@ -0,0 +1,8 @@
+<%= link_to "Debug errors", "#debug-errors", class: "toggle-debug-errors small", data: { toggle: "collapse" } %>
+<div id="debug-errors" class="debug-errors collapse">
+  <ul>
+    <% instance.errors.each do |key, message| %>
+      <li class="small"><tt><%= key %>:</tt> <%= message %></li>
+    <% end %>
+  </ul>
+</div>

data/app/views/trestle/flash/_flash.html.erb

@@ -0,0 +1,7 @@
+<% if flash[:message] -%>
+  <%= render "trestle/flash/alert", html_class: "alert-success", icon: icon("alert-icon ion-ios-checkmark-outline"), alert: normalize_flash_alert(flash[:message]) %>
+<% elsif flash[:error] -%>
+  <%= render layout: "trestle/flash/alert", locals: { html_class: "alert-danger", icon: icon("alert-icon ion-ios-close-outline"), alert: normalize_flash_alert(flash[:error]) } do %>
+    <%= render "trestle/flash/debug" if debug_form_errors? %>
+  <% end %>
+<% end -%>