trestle 0.8.6 → 0.8.7

data/app/controllers/concerns/trestle/controller/breadcrumbs.rb

@@ -0,0 +1,21 @@
+module Trestle
+  module Controller
+    module Breadcrumbs
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :breadcrumbs
+        helper_method :breadcrumb
+      end
+
+    protected
+      def breadcrumbs
+        @breadcrumbs ||= Trestle::Breadcrumb::Trail.new(Trestle.config.root_breadcrumbs)
+      end
+
+      def breadcrumb(label, path=nil)
+        breadcrumbs.append(label, path)
+      end
+    end
+  end
+end

data/app/controllers/concerns/trestle/controller/callbacks.rb

@@ -0,0 +1,21 @@
+module Trestle
+  module Controller
+    module Callbacks
+      extend ActiveSupport::Concern
+
+      included do
+        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
+      end
+    end
+  end
+end

data/app/controllers/concerns/trestle/controller/dialog.rb

@@ -0,0 +1,16 @@
+module Trestle
+  module Controller
+    module Dialog
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :dialog_request?
+      end
+
+    protected
+      def dialog_request?
+        request.headers["X-Trestle-Dialog"]
+      end
+    end
+  end
+end

data/app/controllers/concerns/trestle/controller/helpers.rb

@@ -0,0 +1,18 @@
+module Trestle
+  module Controller
+    module Helpers
+      extend ActiveSupport::Concern
+
+      included do
+        # Allow inclusion of helpers from Rails application
+        self.helpers_path += Rails.application.helpers_paths
+
+        # Add helpers declared from configuration as blocks
+        helper Trestle.config.helper_module
+
+        # Add helpers declared from configuration as module references
+        helper *Trestle.config.helpers
+      end
+    end
+  end
+end

data/app/controllers/concerns/trestle/controller/layout.rb

@@ -0,0 +1,16 @@
+module Trestle
+  module Controller
+    module Layout
+      extend ActiveSupport::Concern
+
+      included do
+        layout :choose_layout
+      end
+
+    protected
+      def choose_layout
+        request.xhr? ? false : "trestle/admin"
+      end
+    end
+  end
+end

data/app/controllers/concerns/trestle/controller/location.rb

@@ -0,0 +1,15 @@
+module Trestle
+  module Controller
+    module Location
+      extend ActiveSupport::Concern
+
+      included do
+        after_action :set_trestle_location_header, unless: :dialog_request?
+      end
+
+      def set_trestle_location_header
+        headers["X-Trestle-Location"] = request.path
+      end
+    end
+  end
+end

data/app/controllers/trestle/application_controller.rb

@@ -1,38 +1,10 @@
 class Trestle::ApplicationController < ActionController::Base
   protect_from_forgery
 
-  layout :choose_layout
-
-  # 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
-
-  def choose_layout
-    request.xhr? ? false : "trestle/admin"
-  end
+  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/debug_helper.rb

@@ -0,0 +1,11 @@
+module Trestle
+  module DebugHelper
+    def debug_form_errors?
+      Trestle.config.debug_form_errors && instance_has_errors?
+    end
+
+    def instance_has_errors?
+      @instance && @instance.respond_to?(:errors) && @instance.errors.any?
+    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/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/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/url_helper.rb

@@ -1,5 +1,7 @@
 module Trestle
   module UrlHelper
+    DIALOG_ACTIONS = [:new, :show, :edit]
+
     def admin_link_to(content, instance_or_url=nil, options={}, &block)
       if block_given?
         instance_or_url, options = content, instance_or_url || {}
@@ -27,7 +29,7 @@ module Trestle
           params = options.delete(:params) || {}
           params[:id] ||= admin.to_param(instance_or_url) if instance_or_url
 
-          if [:show, :edit].include?(action) && admin.form.dialog?
+          if DIALOG_ACTIONS.include?(action) && admin.form.dialog?
             options[:data] ||= {}
             options[:data][:behavior] ||= "dialog"
           end

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

@@ -38,7 +38,7 @@
     <%= hook :head %>
   </head>
 
-  <body>
+  <body<%= " class=\"sidebar-#{cookies["trestle:sidebar"]}\"" if cookies["trestle:sidebar"] %>>
     <div class="app-wrapper">
       <%= render "trestle/shared/sidebar" %>
 

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

@@ -11,7 +11,7 @@
                title: t("trestle.flash.failure.title", default: "Warning!"),
                message: flash[:error]
              } do %>
-    <%- if Trestle.config.debug_form_errors && instance && instance.errors.any? -%>
+    <%- if debug_form_errors? -%>
       <%= link_to "Debug errors", "#debug-errors", class: "toggle-debug-errors small", data: { toggle: "collapse" } %>
       <div id="debug-errors" class="debug-errors collapse">
         <ul>

data/app/views/trestle/shared/_sidebar.html.erb

@@ -1,4 +1,4 @@
-<aside class="app-sidebar<%= " #{cookies["trestle:sidebar"]}" if cookies["trestle:sidebar"] %>">
+<aside class="app-sidebar">
   <header class="app-sidebar-header">
     <button class="navbar-toggle">
       <span class="sr-only"><%= t("admin.ui.toggle_navigation", default: "Toggle navigation") %></span>
@@ -13,7 +13,7 @@
   <div class="app-sidebar-inner">
     <nav class="app-nav">
       <% collapsed = cookies["trestle:navigation:collapsed"].try(:split, ",") || [] %>
-      <% Trestle.navigation.each do |group, items| %>
+      <% Trestle.navigation.visible(self).each do |group, items| %>
         <ul<% if group.present? && collapsed.include?(group.id) %> class="collapsed"<% end %>>
           <% if group.present? %>
             <li class="nav-header"><%= link_to group.label, "##{group.id}" %></li>

data/app/views/trestle/table/_table.html.erb

@@ -1,7 +1,7 @@
 <% table = table.renderer(self) %>
 
 <div class="table-container">
-  <%= content_tag(:table, class: table.classes, data: table.data) do %>
+  <%= content_tag(:table, id: table.id, class: table.classes, data: table.data) do %>
     <thead>
       <tr>
         <% table.columns.each do |column| %>
@@ -12,11 +12,7 @@
 
     <tbody>
       <% collection.each do |instance| %>
-        <%= content_tag(:tr, table.row.options(instance)) do %>
-          <% table.columns.each do |column| %>
-            <%= content_tag(:td, column.content(instance), class: column.classes, data: column.data) %>
-          <% end %>
-        <% end %>
+        <%= table.row.render(instance) %>
       <% end %>
     </tbody>
   <% end %>

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

@@ -13,7 +13,7 @@ Trestle.resource(:<%= plural_name %><% if module? %>, scope: <%= module_name %><
 
   # Customize the form fields shown on the new/edit views.
   #
-  # form do |<%= singular_name %>|
+  # form do |<%= singular_table_name %>|
   #   text_field :name
   #
   #   row do
@@ -30,6 +30,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_name %>).permit(:name, ...)
+  #   params.require(:<%= singular_table_name %>).permit(:name, ...)
   # end
 end

data/lib/trestle.rb

@@ -31,12 +31,14 @@ module Trestle
   self.admins = {}
 
   def self.admin(name, options={}, &block)
-    admin = Admin::Builder.build(name, options, &block)
-    self.admins[admin.admin_name] = admin
+    register(Admin::Builder.create(name, options, &block))
   end
 
   def self.resource(name, options={}, &block)
-    admin = Resource::Builder.build(name, options, &block)
+    register(Resource::Builder.create(name, options, &block))
+  end
+
+  def self.register(admin)
     self.admins[admin.admin_name] = admin
   end
 
@@ -54,7 +56,7 @@ module Trestle
   end
 
   def self.navigation
-    Navigation.new(config.menus + admins.values.map(&:menu).compact)
+    Navigation.build(config.menus + admins.values.map(&:menu).compact)
   end
 end
 

data/lib/trestle/adapters/active_record_adapter.rb

@@ -25,10 +25,6 @@ module Trestle
         instance.destroy
       end
 
-      def unscope(scope)
-        scope.unscoped
-      end
-
       def merge_scopes(scope, other)
         scope.merge(other)
       end

data/lib/trestle/adapters/adapter.rb

@@ -61,6 +61,18 @@ module Trestle
         raise NotImplementedError
       end
 
+      # Finalizes a collection so that it can be rendered within the index view.
+      #
+      # In most cases (e.g. ActiveRecord), no finalization is required. However if you are using a search library then
+      # you may need to explicitly execute the search, or access the models via a #records or #objects method.
+      #
+      # collection - The collection to finalize
+      #
+      # Returns an enumerable collection of instances.
+      def finalize_collection(collection)
+        collection
+      end
+
       # Decorates a collection for rendering by the index view.
       # Decorating is the final step in preparing the collection for the view.
       #
@@ -82,15 +94,6 @@ module Trestle
         instance.id
       end
 
-      # Unscopes a collection so that it can be merged with other scopes without duplication or interference.
-      #
-      # scope - The scope to unscope
-      #
-      # Returns a scope object.
-      def unscope(scope)
-        scope
-      end
-
       # Merges scopes together for Trestle scope application and counting.
       #
       # scope - The first scope
@@ -131,7 +134,9 @@ module Trestle
       # Returns a Kaminari-compatible scope corresponding to a single page.
       def paginate(collection, params)
         collection = Kaminari.paginate_array(collection.to_a) unless collection.respond_to?(:page)
-        collection.page(params[:page])
+        per_page = admin.pagination_options[:per]
+
+        collection.page(params[:page]).per(per_page)
       end
 
       # Filters the submitted form parameters and returns a whitelisted attributes 'hash'