trestle 0.8.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1da0a5de448522e343cd8c8f25e58f14533b7ea
-  data.tar.gz: f52dc44dba3f0abc4f1d89c655f0c21c677a9dd1
+  metadata.gz: 64b62775f02866abaf0937d6a4e0bec5d86a1a31
+  data.tar.gz: 7707fa64f42e4c771721b9c306c143ce2614e18f
 SHA512:
-  metadata.gz: 5c9e0a7742fb539291bec72dee7621a12a49fc84f46f60e8a864dc9ce67bfa0003b4e30a52e5e2d9c9b6507303b2f58c901faa8a36cf2a052225a0ffc061392e
-  data.tar.gz: aa7b9b0cd797638546ad2bbdbc479950bdf4d9576871a1c8b72232eee753dd6fad01e24044bf7a9d5f81426e70a67903542afd8db6b29788ee4c771f3b96b69a
+  metadata.gz: a7bed2fddf9f950463693e7ec502aaf08439240a27075e61d2fc575381e165da4b0c407406d4a02990524c37ea9ce730a76886bea2c57ebee03b0ab935d34b51
+  data.tar.gz: c0dcd718a1bb3ac020924d09bd99f1658da42c7b53122af829822837a1a0c1631bfc942bb6a274d4301e7de5b4e90d00ad32cb242c30485abf88450ba3186dab

data/README.md

@@ -11,7 +11,7 @@
 
 > A modern, responsive admin framework for Ruby on Rails
 
-<img src="https://trestle.io/images/Trestle-Screenshot-1.png?" width="50%" /><img src="https://trestle.io/images/Trestle-Screenshot-2.png?" width="50%" />
+<img src="https://trestle.io/images/Trestle-Screenshot-1-1x.png?" width="50%" /><img src="https://trestle.io/images/Trestle-Screenshot-2-1x.png?" width="50%" />
 
 
 ## Getting Started

data/app/assets/stylesheets/trestle/core/_defaults.scss

@@ -43,10 +43,10 @@ $headings-font-weight: 400 !default;
 $btn-default-bg:    #dbdbdb !default;
 $btn-default-color: white !default;
 
-$state-success-bg: lighten(#dff0d8, 2.5%) !default;
-$state-info-bg:    lighten(#d9edf7, 2.5%) !default;
-$state-warning-bg: lighten(#fcf8e3, 2.5%) !default;
-$state-danger-bg:  lighten(#f2dede, 2.5%) !default;
+$state-success-bg: lighten(#dff0d8, 5%) !default;
+$state-info-bg:    lighten(#d9edf7, 5%) !default;
+$state-warning-bg: lighten(#fcf8e3, 5%) !default;
+$state-danger-bg:  lighten(#f2dede, 5%) !default;
 
 $alert-padding:       20px !default;
 $alert-border-radius: 2px !default;

data/app/controllers/trestle/application_controller.rb

@@ -3,6 +3,24 @@ class Trestle::ApplicationController < ActionController::Base
 
   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)

data/app/helpers/trestle/container_helper.rb

@@ -0,0 +1,24 @@
+module Trestle
+  module ContainerHelper
+    def container(&block)
+      context = Context.new(self)
+      content = capture(context, &block)
+
+      content_tag(:div, class: "main-content-container") do
+        concat content_tag(:div, content, class: "main-content")
+        concat content_tag(:aside, context.sidebar, class: "main-content-sidebar") unless context.sidebar.blank?
+      end
+    end
+
+    class Context
+      def initialize(template)
+        @template = template
+      end
+
+      def sidebar(&block)
+        @sidebar = @template.capture(&block) if block_given?
+        @sidebar
+      end
+    end
+  end
+end

data/app/helpers/trestle/grid_helper.rb

@@ -1,7 +1,7 @@
 module Trestle
   module GridHelper
     def row
-      content_tag(:div, class: 'row') { yield }
+      content_tag(:div, class: "row") { yield }
     end
 
     def col(columns)

data/app/helpers/trestle/table_helper.rb

@@ -1,8 +1,6 @@
 module Trestle
   module TableHelper
     def table(collection, options={}, &block)
-      options = options.reverse_merge(admin: admin) if defined?(admin)
-
       table = Table::Builder.build(options, &block)
       render "trestle/table/table", table: table, collection: collection
     end

data/app/helpers/trestle/url_helper.rb

@@ -13,14 +13,15 @@ module Trestle
       end
 
       if admin
-        link_to(content, admin_url_for(instance, admin), options)
+        link_to(content, admin_url_for(instance, admin: admin), options)
       else
         content
       end
     end
 
-    def admin_url_for(instance, admin=self.admin)
-      admin.path(:show, id: admin.to_param(instance)) if admin
+    def admin_url_for(instance, options={})
+      admin = Trestle.lookup(options[:admin] || self.admin)
+      admin.path(options[:action] || :show, id: admin.to_param(instance)) if admin
     end
 
     def admin_for(instance)

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

@@ -15,6 +15,7 @@
     <%= 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 %>">
@@ -22,4 +23,5 @@
       </li>
     <% end %>
   </ol>
+  <% end %>
 </header>

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

@@ -1,19 +1,19 @@
-<%= render "header" %>
+<%= render "header", hide_breadcrumbs: local_assigns.fetch(:hide_breadcrumbs, false) if local_assigns.fetch(:header, true) %>
 
 <div class="main-content-area">
   <%= render "flash" %>
   <%= render "utilities" %>
   <%= render "tabs" %>
 
-  <div class="main-content-container">
-    <div class="main-content">
+  <% if local_assigns.fetch(:wrapper, true) %>
+    <%= container do |c| %>
       <%= yield %>
-    </div>
 
-    <% if content_for?(:sidebar) %>
-      <aside class="main-content-sidebar">
+      <% c.sidebar do %>
         <%= content_for(:sidebar) %>
-      </aside>
+      <% end if content_for?(:sidebar) %>
     <% end %>
-  </div>
+  <% else %>
+    <%= yield %>
+  <% end %>
 </div>

data/config/routes.rb

@@ -1,7 +1,7 @@
 Trestle::Engine.routes.draw do
-  root to: "trestle/dashboard#index"
-  
   Trestle.admins.each do |name, admin|
     instance_eval(&admin.routes)
   end
+
+  root to: "trestle/dashboard#index"
 end

data/lib/generators/trestle/admin/admin_generator.rb

@@ -0,0 +1,26 @@
+module Trestle
+  module Generators
+    class AdminGenerator < ::Rails::Generators::NamedBase
+      desc "Creates a non-resourceful Trestle admin"
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def create_admin
+        template "admin.rb.erb", File.join("app/admin", class_path, "#{singular_name}_admin.rb")
+      end
+
+      def create_template
+        template "index.html.erb", File.join("app/views/admin", class_path, singular_name, "index.html.erb")
+      end
+
+    protected
+      def module_name
+        class_name.deconstantize
+      end
+
+      def module?
+        module_name.present?
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+Trestle.admin(:<%= singular_name %><% if module? %>, scope: <%= module_name %><% end %>) do
+  menu do
+    item :<%= singular_name %>, icon: "fa fa-star"
+  end
+end

data/lib/generators/trestle/admin/templates/index.html.erb

@@ -0,0 +1,5 @@
+<%% content_for(:title, "<%= singular_name.titleize %>") %>
+
+<%%= render layout: "layout", locals: { wrapper: true, sidebar: false, hide_breadcrumbs: false } do %>
+  To customize this template, please edit <code><%= File.join("app/views/admin", class_path, singular_name, "index.html.erb") %></code>.
+<%% end %>

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

@@ -53,6 +53,26 @@ Trestle.configure do |config|
 
   # == Extension Options
   #
+  # Specify helper modules to expose to the admin.
+  #
+  # config.helper :all
+
+  # Register callbacks to run before, after or around all Trestle actions.
+  #
+  # config.before_action do |controller|
+  #   Rails.logger.debug("Before action")
+  # end
+  #
+  # config.after_action do |controller|
+  #   Rails.logger.debug("After action")
+  # end
+  #
+  # config.around_action do |controller, block|
+  #   Rails.logger.debug("Around action (before)")
+  #   block.call
+  #   Rails.logger.debug("Around ation (after)")
+  # end
+
   # Specify a custom hook to be injected into the admin.
   #
   # config.hook(:stylesheets) do

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

@@ -6,7 +6,7 @@ module Trestle
       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, "#{plural_name}_admin.rb")
       end
 
     protected

data/lib/trestle/adapters/active_record_adapter.rb

@@ -37,12 +37,8 @@ module Trestle
         scope.merge(other)
       end
 
-      def sort(collection, params)
-        if params[:sort]
-          collection.reorder(params[:sort] => params[:order] || "asc")
-        else
-          collection
-        end
+      def sort(collection, field, order)
+        collection.reorder(field => order)
       end
 
       def paginate(collection, params)

data/lib/trestle/admin/builder.rb

@@ -9,6 +9,8 @@ module Trestle
       class_attribute :controller
       self.controller = Controller
 
+      delegate :helper, :before_action, :after_action, :around_action, to: :@controller
+
       def initialize(name, options={})
         # Create admin subclass
         @admin = Class.new(admin_class)
@@ -37,7 +39,7 @@ module Trestle
       end
 
       def table(options={}, &block)
-        admin.table = Table::Builder.build(options.reverse_merge(sortable: true, admin: admin), &block)
+        admin.table = Table::Builder.build(options.reverse_merge(admin: admin, sortable: true), &block)
       end
 
       def form(&block)
@@ -50,18 +52,13 @@ module Trestle
       end
 
       def controller(&block)
-        @controller.class_eval(&block)
+        @controller.class_eval(&block) if block_given?
+        @controller
       end
 
       def routes(&block)
         @admin.additional_routes = block
       end
-
-      def helper(*helpers)
-        controller do
-          helper *helpers
-        end
-      end
     end
   end
 end

data/lib/trestle/configuration.rb

@@ -2,43 +2,116 @@ module Trestle
   class Configuration
     include Configurable
 
+    ## Customization Options
+
+    # Page title shown in the main admin header and <title> tag
     option :site_title, -> { I18n.t("trestle.title", default: "Trestle") }
-    option :footer, -> { I18n.t("trestle.footer", default: "Powered by Trestle") }
 
+    # Custom image in place of the site title for mobile and expanded/desktop navigation
     option :site_logo
+
+    # Custom image for the collapsed/tablet navigation
     option :site_logo_small
 
-    option :path, "/admin"
-    option :automount, true
+    # Text shown in the admin page footer
+    option :footer, -> { I18n.t("trestle.footer", default: "Powered by Trestle") }
 
-    option :turbolinks, defined?(Turbolinks)
 
-    option :display_methods, [:display_name, :full_name, :name, :title, :username, :login, :email, :to_s]
+    ## Mounting Options
 
-    option :persistent_params, [:sort, :order, :scope]
+    # Path at which to mount the Trestle admin
+    option :path, "/admin"
 
-    option :default_adapter, Adapters::Adapter.compose(Adapters::ActiveRecordAdapter, Adapters::DraperAdapter)
+    # Automatically mount the admin within the Rails application's routes
+    option :automount, true
 
+
+    ## Navigation Options
+
+    # Initial breadcrumbs to display in the breadcrumb trail
     option :root_breadcrumbs, -> { [Trestle::Breadcrumb.new(I18n.t("admin.breadcrumbs.home", default: "Home"), Trestle.config.path)] }
 
+    # Default icon class to use when it is not explicitly provided
     option :default_navigation_icon, "fa fa-arrow-circle-o-right"
 
-    option :javascript_i18n_keys, ["admin.confirmation.title", "admin.confirmation.delete", "admin.confirmation.cancel"]
-
+    # [Internal] List of navigation menu blocks
     option :menus, []
 
+    # Register a global navigation menu block
     def menu(&block)
       menus << Navigation::Block.new(&block)
     end
 
+
+    ## Extension Options
+
+    # [Internal] List of helper modules to include in all Trestle controllers
+    option :helpers, []
+
+    # [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.helper_module.module_eval(&block) if block_given?
+    end
+
+    # Enable or disable Turbolinks within the Trestle admin
+    option :turbolinks, defined?(Turbolinks)
+
+    # List of parameters that should persist across requests when paginating or reordering
+    option :persistent_params, [:sort, :order, :scope]
+
+    # List of methods to try calling on an instance when displayed by the `display` helper
+    option :display_methods, [:display_name, :full_name, :name, :title, :username, :login, :email, :to_s]
+
+    # Default adapter class used by all admin resources
+    option :default_adapter, Adapters::Adapter.compose(Adapters::ActiveRecordAdapter, Adapters::DraperAdapter)
+
+    # Register a custom form field class
+    def form_field(name, klass)
+      Form::Builder.register(name, klass)
+    end
+
+    # [Internal] List of registered hooks
     option :hooks, Hash.new { |h, k| h[k] = [] }
 
+    # Register an extension hook
     def hook(name, &block)
       hooks[name.to_s] << block
     end
 
-    def form_field(name, klass)
-      Form::Builder.register(name, klass)
+    # List of i18n keys to pass into the Trestle.i18n JavaScript object
+    option :javascript_i18n_keys, ["admin.confirmation.title", "admin.confirmation.delete", "admin.confirmation.cancel"]
+
+
+    ## Callbacks
+
+    Action = Struct.new(:options, :block)
+
+    # [Internal] List of global before actions
+    option :before_actions, []
+
+    # Register a global before action
+    def before_action(options={}, &block)
+      before_actions << Action.new(options, block)
+    end
+
+    # [Internal] List of global after actions
+    option :after_actions, []
+
+    # Register a global after action
+    def after_action(options={}, &block)
+      after_actions << Action.new(options, block)
+    end
+
+    # [Internal] List of global around actions
+    option :around_actions, []
+
+    # Register a global around action
+    def around_action(options={}, &block)
+      around_actions << Action.new(options, block)
     end
   end
 end

data/lib/trestle/resource/builder.rb

@@ -62,6 +62,10 @@ module Trestle
         admin.sort = block
       end
 
+      def sort_column(column, &block)
+        admin.column_sorts[column.to_sym] = block
+      end
+
       def paginate(&block)
         admin.paginate = block
       end

data/lib/trestle/resource.rb

@@ -49,7 +49,7 @@ module Trestle
       def prepare_collection(params)
         collection = initialize_collection(params)
         collection = apply_scopes(collection, params)
-        collection = sort(collection, params)
+        collection = apply_sorting(collection, params)
         collection = paginate(collection, params)
         collection = decorate_collection(collection)
         collection
@@ -87,6 +87,25 @@ module Trestle
         result
       end
 
+      def column_sorts
+        @column_sorts ||= {}
+      end
+
+      def apply_sorting(collection, params)
+        return collection unless params[:sort]
+
+        field = params[:sort].to_sym
+
+        order = params[:order].downcase
+        order = "asc" unless %w(asc desc).include?(order)
+
+        if column_sorts.has_key?(field)
+          instance_exec(collection, order, &column_sorts[field])
+        else
+          sort(collection, field, order)
+        end
+      end
+
       def table
         super || Table::Automatic.new(self)
       end
@@ -129,7 +148,7 @@ module Trestle
       def infer_model_class
         parent.const_get(admin_name.classify)
       rescue NameError
-        nil
+        raise NameError, "Unable to find model #{admin_name.classify}. Specify a different model using Trestle.resource(:#{admin_name}, model: MyModel)"
       end
 
       def default_model_name

data/lib/trestle/table/actions_column.rb

@@ -19,22 +19,25 @@ module Trestle
       end
 
       class ActionsBuilder
-        attr_reader :template, :instance
+        attr_reader :instance
 
-        def initialize(template, instance)
-          @template, @instance = template, instance
+        delegate :table, to: :@column
+
+        def initialize(column, template, instance)
+          @column, @template, @instance = column, template, instance
+        end
+
+        def delete
+          button(@template.icon("fa fa-trash"), @template.admin_url_for(instance, admin: table.options[:admin], action: :destroy), method: :delete, class: "btn-danger", data: { toggle: "confirm-delete", placement: "left" })
         end
 
         def button(content, url, options={})
           options[:class] = Array(options[:class])
           options[:class] << "btn" unless options[:class].include?("btn")
 
-          template.concat template.link_to(content, url, options)
-        end
-
-        def delete
-          button(template.icon("fa fa-trash"), template.admin.path(:destroy, id: template.admin.to_param(instance)), method: :delete, class: "btn-danger", data: { toggle: "confirm-delete", placement: "left" })
+          @template.concat @template.link_to(content, url, options)
         end
+        alias_method :link, :button
       end
 
       class Renderer < Column::Renderer
@@ -54,7 +57,7 @@ module Trestle
         end
 
         def content(instance)
-          builder = ActionsBuilder.new(@template, instance)
+          builder = ActionsBuilder.new(@column, @template, instance)
 
           @template.with_output_buffer do
             @template.instance_exec(builder, &@column.block)

data/lib/trestle/table/builder.rb

@@ -8,7 +8,7 @@ module Trestle
       end
 
       def row(options={}, &block)
-        table.row = Row.new(options, &block)
+        table.row = Row.new(table, options, &block)
       end
 
       def selectable_column

data/lib/trestle/table/row.rb

@@ -1,10 +1,10 @@
 module Trestle
   class Table
     class Row
-      attr_reader :options, :block
+      attr_reader :table, :options, :block
 
-      def initialize(options={}, &block)
-        @options = options
+      def initialize(table, options={}, &block)
+        @table, @options = table, options
         @block = block if block_given?
       end
 
@@ -13,16 +13,24 @@ module Trestle
       end
 
       class Renderer
+        delegate :table, to: :@row
+
         def initialize(row, template)
           @row, @template = row, template
         end
 
         def options(instance)
-          options = Trestle::Options.new(data: { url: @template.admin_url_for(instance) })
+          options = Trestle::Options.new
+          options.merge!(data: { url: admin_url_for(instance) }) if table.options[:admin]
           options.merge!(@row.options)
           options.merge!(@template.instance_exec(instance, &@row.block)) if @row.block
           options
         end
+
+      protected
+        def admin_url_for(instance)
+          @template.admin_url_for(instance, admin: table.options[:admin])
+        end
       end
     end
   end

data/lib/trestle/table.rb

@@ -26,7 +26,7 @@ module Trestle
     end
 
     def row
-      @row || Row.new
+      @row || Row.new(self)
     end
 
     class Renderer

data/lib/trestle/version.rb

@@ -1,3 +1,3 @@
 module Trestle
-  VERSION = "0.8.2"
+  VERSION = "0.8.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trestle
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
 platform: ruby
 authors:
 - Sam Pohlenz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-31 00:00:00.000000000 Z
+date: 2017-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -230,6 +230,7 @@ files:
 - app/controllers/trestle/application_controller.rb
 - app/controllers/trestle/dashboard_controller.rb
 - app/helpers/trestle/avatar_helper.rb
+- app/helpers/trestle/container_helper.rb
 - app/helpers/trestle/display_helper.rb
 - app/helpers/trestle/form_helper.rb
 - app/helpers/trestle/grid_helper.rb
@@ -277,6 +278,9 @@ files:
 - config/locales/en.rb
 - config/locales/en.yml
 - config/routes.rb
+- lib/generators/trestle/admin/admin_generator.rb
+- lib/generators/trestle/admin/templates/admin.rb.erb
+- lib/generators/trestle/admin/templates/index.html.erb
 - lib/generators/trestle/install/install_generator.rb
 - lib/generators/trestle/install/templates/_custom.scss
 - lib/generators/trestle/install/templates/_variables.scss