trestle 0.8.4 → 0.8.11

data/gemfiles/rails-edge.gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'coveralls', require: false
+  gem 'simplecov', require: false
+
+  gem 'capybara'
+  gem 'capybara-selenium'
+  gem 'selenium-webdriver'
+  gem 'chromedriver-helper'
+  gem 'puma'
+end
+
+gem 'rails', github: 'rails/rails'
+gem 'arel', github: 'rails/arel'
+
+gemspec :path => "../"

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

@@ -20,6 +20,11 @@ Trestle.configure do |config|
   #
   # config.footer = "Powered by Trestle"
 
+  # Sets the default precision for timestamps (either :minutes or :seconds).
+  # Defaults to :minutes.
+  #
+  # config.timestamp_precision = :minutes
+
   # == Mounting Options
   #
   # Set the path at which to mount the Trestle admin. Defaults to /admin.
@@ -33,10 +38,15 @@ Trestle.configure do |config|
 
   # == Navigation Options
   #
+  # Set the path to consider the application root (for title links and breadcrumbs).
+  # Defaults to the same value as `config.path`.
+  #
+  # config.root = "/"
+
   # Set the initial breadcrumbs to display in the breadcrumb trail.
-  # Defaults to a breadcrumb labeled 'Home' linking to to the admin root.
+  # Defaults to a breadcrumb labeled 'Home' linking to to the application root.
   #
-  # config.root_breadcrumbs = -> { [Trestle::Breadcrumb.new("Home", Trestle.config.path)] }
+  # config.root_breadcrumbs = -> { [Trestle::Breadcrumb.new("Home", Trestle.config.root)] }
 
   # Set the default icon class to use when it is not explicitly provided.
   # Defaults to "fa fa-arrow-circle-o-right".
@@ -105,4 +115,10 @@ Trestle.configure do |config|
   # end
   #
   # config.form_field :custom, CustomFormField
+
+  # == Debugging Options
+  #
+  # Enable debugging of form errors. Defaults to true in development mode.
+  #
+  # config.debug_form_errors = true
 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 %>).require(:name, ...)
+  #   params.require(:<%= singular_table_name %>).permit(:name, ...)
   # end
 end

data/lib/trestle/adapters/active_record_adapter.rb

@@ -17,18 +17,14 @@ module Trestle
         instance.assign_attributes(attrs)
       end
 
-      def save_instance(instance)
+      def save_instance(instance, params={})
         instance.save
       end
 
-      def delete_instance(instance)
+      def delete_instance(instance, params={})
         instance.destroy
       end
 
-      def unscope(scope)
-        scope.unscoped
-      end
-
       def merge_scopes(scope, other)
         scope.merge(other)
       end

data/lib/trestle/adapters/adapter.rb

@@ -4,8 +4,9 @@ module Trestle
       attr_reader :admin
       delegate :model, to: :admin
 
-      def initialize(admin)
+      def initialize(admin, context=nil)
         @admin = admin
+        @context = context
       end
 
       # Loads the initial collection for use by the index action.
@@ -46,21 +47,35 @@ module Trestle
       # Saves an instance (used by the create and update actions).
       #
       # instance - The instance to save
+      # params   - Unfiltered params hash from the controller
       #
       # Returns a boolean indicating the success/fail status of the save.
-      def save_instance(instance)
+      def save_instance(instance, params={})
         raise NotImplementedError
       end
 
       # Deletes an instance (used by the destroy action).
       #
       # instance - The instance to delete
+      # params   - Unfiltered params hash from the controller
       #
       # Returns a boolean indicating the success/fail status of the deletion.
-      def delete_instance(instance)
+      def delete_instance(instance, params={})
         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 +97,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
@@ -130,8 +136,10 @@ 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])
+        collection = Kaminari.paginate_array(collection.to_a) unless collection.respond_to?(Kaminari.config.page_method_name)
+        per_page = admin.pagination_options[:per]
+
+        collection.public_send(Kaminari.config.page_method_name, params[:page]).per(per_page)
       end
 
       # Filters the submitted form parameters and returns a whitelisted attributes 'hash'
@@ -144,7 +152,7 @@ module Trestle
       #
       # Returns the permitted set of parameters as a ActionController::Parameters object.
       def permitted_params(params)
-        params.require(admin.admin_name.singularize).permit!
+        params.require(admin.parameter_name).permit!
       end
 
       # Produces a human-readable name for a given attribute, applying I18n where appropriate.
@@ -171,6 +179,23 @@ module Trestle
       def default_form_attributes
         raise NotImplementedError
       end
+
+    protected
+      # Missing methods are called on the given context if available.
+      #
+      # We include private methods as methods such as current_user
+      # are usually declared as private or protected.
+      def method_missing(name, *args, &block)
+        if @context && @context.respond_to?(name, true)
+          @context.send(name, *args, &block)
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(name, include_private=false)
+        (@context && @context.respond_to?(name, true)) || super
+      end
     end
   end
 end

data/lib/trestle/adapters/sequel_adapter.rb

@@ -26,18 +26,14 @@ module Trestle
         instance.set(attrs)
       end
 
-      def save_instance(instance)
+      def save_instance(instance, params={})
         instance.save
       end
 
-      def delete_instance(instance)
+      def delete_instance(instance, params={})
         instance.destroy
       end
 
-      def unscope(scope)
-        scope.unfiltered
-      end
-
       def merge_scopes(scope, other)
         scope.intersect(other)
       end

data/lib/trestle/admin/builder.rb

@@ -11,23 +11,32 @@ module Trestle
 
       delegate :helper, :before_action, :after_action, :around_action, to: :@controller
 
-      def initialize(name, options={})
+      def initialize(admin)
+        @admin, @controller = admin, admin.const_get(:AdminController)
+      end
+
+      def self.create(name, options={}, &block)
         # Create admin subclass
-        @admin = Class.new(admin_class)
-        @admin.options = options
+        admin = Class.new(admin_class)
+        admin.options = options
 
         # Define a constant based on the admin name
         scope = options[:scope] || Object
-        scope.const_set("#{name.to_s.camelize}Admin", @admin)
+        scope.const_set("#{name.to_s.camelize}Admin", admin)
 
         # 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 < #{self.class.controller.name}; end")
+        admin.class_eval("class AdminController < #{controller.name}; end")
 
         # Set a reference on the controller class to the admin class
-        @controller = @admin.const_get("AdminController")
-        @controller.instance_variable_set("@admin", @admin)
+        controller = admin.const_get(:AdminController)
+        controller.instance_variable_set("@admin", admin)
+
+        admin.build(&block)
+        admin.validate!
+
+        admin
       end
 
       def menu(*args, &block)
@@ -38,16 +47,17 @@ module Trestle
         end
       end
 
-      def table(options={}, &block)
-        admin.table = Table::Builder.build(options.reverse_merge(admin: admin, sortable: true), &block)
+      def table(name_or_options={}, options={}, &block)
+        name, options = normalize_table_options(name_or_options, options)
+        admin.tables[name] = Table::Builder.build(options, &block)
       end
 
-      def form(&block)
-        admin.form = Form.new(&block)
+      def form(options={}, &block)
+        admin.form = Form.new(options, &block)
       end
 
       def admin(&block)
-        @admin.singleton_class.class_eval(&block) if block_given?
+        @admin.instance_eval(&block) if block_given?
         @admin
       end
 
@@ -59,6 +69,26 @@ module Trestle
       def routes(&block)
         @admin.additional_routes = block
       end
+
+      def breadcrumb(label=nil, path=nil, &block)
+        if block_given?
+          @admin.breadcrumb = block
+        elsif label
+          @admin.breadcrumb = -> { Breadcrumb.new(label, path) }
+        else
+          @admin.breadcrumb = -> { false }
+        end
+      end
+
+    protected
+      def normalize_table_options(name, options)
+        if name.is_a?(Hash)
+          # Default index table
+          name, options = :index, name
+        end
+
+        [name, options]
+      end
     end
   end
 end

data/lib/trestle/admin/controller.rb

@@ -12,7 +12,9 @@ module Trestle
         end
       end
 
-      delegate :admin, to: :class
+      def admin
+        @_admin ||= self.class.admin.new(self)
+      end
       helper_method :admin
 
     protected

data/lib/trestle/admin.rb

@@ -5,32 +5,93 @@ module Trestle
     autoload :Builder
     autoload :Controller
 
+    delegate :to_param, to: :class
+
+    def initialize(context=nil)
+      @context = context
+    end
+
+    # Delegate all missing methods to corresponding class method if available
+    def method_missing(name, *args, &block)
+      if self.class.respond_to?(name)
+        self.class.send(name, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(name, include_private=false)
+      self.class.respond_to?(name, include_private) || super
+    end
+
     class << self
       attr_accessor :menu
 
-      attr_accessor :table
       attr_accessor :form
 
       attr_accessor :additional_routes
 
       attr_writer :options
+      attr_writer :breadcrumb
 
       def options
         @options ||= {}
       end
 
+      def tables
+        @tables ||= {}
+      end
+
+      # Deprecated: Use `tables[:index]` instead
+      def table
+        tables[:index]
+      end
+
+      # Deprecated: Use `tables[:index]=` instead
+      def table=(table)
+        tables[:index] = table
+      end
+
       def breadcrumbs
         Breadcrumb::Trail.new(Array(Trestle.config.root_breadcrumbs) + [breadcrumb])
       end
 
       def breadcrumb
-        Breadcrumb.new(admin_name.titleize, path)
+        if @breadcrumb
+          Breadcrumb.cast(@breadcrumb.call)
+        else
+          default_breadcrumb
+        end
+      end
+
+      def default_breadcrumb
+        Breadcrumb.new(human_admin_name, path)
       end
 
       def admin_name
         name.underscore.sub(/_admin$/, '')
       end
 
+      def i18n_key
+        admin_name
+      end
+
+      def human_admin_name
+        I18n.t("admin.breadcrumbs.#{i18n_key}", default: name.demodulize.underscore.sub(/_admin$/, '').titleize)
+      end
+
+      def translate(key, options={})
+        defaults = [:"admin.#{i18n_key}.#{key}", :"admin.#{key}"]
+        defaults << options[:default] if options[:default]
+
+        I18n.t(defaults.shift, options.merge(default: defaults))
+      end
+      alias t translate
+
+      def parameter_name
+        admin_name.singularize
+      end
+
       def route_name
         "#{admin_name.tr('/', '_')}_admin"
       end
@@ -43,10 +104,22 @@ module Trestle
         "#{name.underscore}/admin"
       end
 
-      def path(action=:index, options={})
+      def path(action=root_action, options={})
         Engine.routes.url_for(options.merge(controller: controller_namespace, action: action, only_path: true))
       end
 
+      def to_param(*)
+        raise NoMethodError, "#to_param called on non-resourceful admin. You may need to explicitly specify the admin."
+      end
+
+      def actions
+        [:index]
+      end
+
+      def root_action
+        :index
+      end
+
       def routes
         admin = self
 
@@ -62,6 +135,14 @@ module Trestle
       def railtie_routes_url_helpers(include_path_helpers=true)
         Trestle.railtie_routes_url_helpers(include_path_helpers)
       end
+
+      def build(&block)
+        Admin::Builder.build(self, &block)
+      end
+
+      def validate!
+        # No validations by default. This can be overridden in subclasses.
+      end
     end
   end
 end

data/lib/trestle/breadcrumb.rb

@@ -10,11 +10,26 @@ module Trestle
       label == other.label && path == other.path
     end
 
+    def self.cast(obj)
+      case obj
+      when Breadcrumb
+        obj
+      when String
+        new(obj)
+      when Array
+        new(*obj)
+      when NilClass, false
+        nil
+      else
+        raise ArgumentError, "Unable to cast #{obj.inspect} to Breadcrumb"
+      end
+    end
+
     class Trail
       include Enumerable
 
       def initialize(breadcrumbs=[])
-        @breadcrumbs = Array(breadcrumbs)
+        @breadcrumbs = Array(breadcrumbs).compact
       end
 
       def ==(other)

data/lib/trestle/configurable.rb

@@ -17,6 +17,12 @@ module Trestle
       @options ||= {}
     end
 
+    def as_json(options=nil)
+      @options.each_with_object({}) do |(k, v), h|
+        h[k] = v.as_json(options)
+      end
+    end
+
     def inspect
       "#<#{self.class.name || "Anonymous(Trestle::Configurable)"}>"
     end

data/lib/trestle/configuration.rb

@@ -16,6 +16,9 @@ module Trestle
     # Text shown in the admin page footer
     option :footer, -> { I18n.t("trestle.footer", default: "Powered by Trestle") }
 
+    # Default timestamp precision
+    option :timestamp_precision, :minutes
+
 
     ## Mounting Options
 
@@ -28,8 +31,11 @@ module Trestle
 
     ## Navigation Options
 
+    # Path to consider the application root (for title links and breadcrumbs)
+    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.path)] }
+    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"
@@ -64,7 +70,7 @@ module Trestle
     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]
+    option :display_methods, [:display_name, :full_name, :name, :title, :username, :login, :email]
 
     # Default adapter class used by all admin resources
     option :default_adapter, Adapters.compose(Adapters::ActiveRecordAdapter, Adapters::DraperAdapter)
@@ -78,12 +84,29 @@ module Trestle
     option :hooks, Hash.new { |h, k| h[k] = [] }
 
     # Register an extension hook
-    def hook(name, &block)
-      hooks[name.to_s] << block
+    def hook(name, options={}, &block)
+      hooks[name.to_s] << Hook.new(name.to_s, options, &block)
     end
 
     # 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"]
+    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"
+    ]
+
+    # List of load paths for where to find admin definitions
+    option :load_paths, [
+      -> { 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
+
+
+    ## Debugging
+
+    # Enable debugging of form errors
+    option :debug_form_errors, Rails.env.development?
 
 
     ## Callbacks

data/lib/trestle/display.rb

@@ -14,7 +14,7 @@ module Trestle
 
   private
     def display_method
-      @display_method ||= Trestle.config.display_methods.find { |m| @instance.respond_to?(m) }
+      @display_method ||= Trestle.config.display_methods.find { |m| @instance.respond_to?(m) } || :to_s
     end
   end
 end

data/lib/trestle/engine.rb

@@ -7,9 +7,11 @@ module Trestle
     config.assets.precompile << "trestle/admin.css" << "trestle/admin.js"
 
     # Vendor assets
-    config.assets.precompile << %r(trestle/bootstrap-sass/assets/fonts/bootstrap/glyphicons-halflings-regular\.(?:eot|svg|ttf|woff|woff2)$)
-    config.assets.precompile << %r(trestle/font-awesome/fonts/fontawesome-webfont\.(?:eot|svg|ttf|woff|woff2)$)
-    config.assets.precompile << %r(trestle/ionicons/fonts/ionicons\.(?:eot|svg|ttf|woff)$)
+    %w(eot svg ttf woff woff2).each do |ext|
+      config.assets.precompile << "trestle/bootstrap-sass/assets/fonts/bootstrap/glyphicons-halflings-regular.#{ext}"
+      config.assets.precompile << "trestle/font-awesome/fonts/fontawesome-webfont.#{ext}"
+      config.assets.precompile << "trestle/ionicons/fonts/ionicons.#{ext}"
+    end
 
     initializer "trestle.automount" do |app|
       if Trestle.config.automount
@@ -35,7 +37,11 @@ module Trestle
     end
 
     config.to_prepare do
-      Engine.reloader.execute_if_updated
+      if Trestle.config.reload == :always
+        Engine.reloader.execute
+      else
+        Engine.reloader.execute_if_updated
+      end
     end
 
     def reloader

data/lib/trestle/form/automatic.rb

@@ -2,7 +2,7 @@ module Trestle
   class Form
     class Automatic < Form
       def initialize(admin)
-        @block = Proc.new do |instance|
+        super() do |instance|
           admin.default_form_attributes.each do |attribute|
             if attribute.array?
               if [:string, :text].include?(attribute.type)
@@ -13,8 +13,11 @@ module Trestle
               when :association
                 if attribute.polymorphic?
                   static_field attribute.name do
-                    associated_instance = instance.public_send(attribute.association_name)
-                    admin_link_to format_value(associated_instance), associated_instance
+                    if associated_instance = instance.public_send(attribute.association_name)
+                      admin_link_to format_value(associated_instance), associated_instance
+                    else
+                      content_tag(:span, I18n.t("admin.format.blank"), class: "blank")
+                    end
                   end
                 else
                   prompt = I18n.t("admin.form.select.prompt", default: "- Select %{attribute_name} -", attribute_name: admin.human_attribute_name(attribute.association_name))

data/lib/trestle/form/builder.rb

@@ -10,7 +10,11 @@ module Trestle
       self.fields = {}
 
       def errors(name)
-        object.errors[name].to_a
+        if object.respond_to?(:errors) && object.errors.respond_to?(:[])
+          object.errors[name].to_a
+        else
+          []
+        end
       end
 
       def self.register(name, klass)

data/lib/trestle/form/field.rb

@@ -39,7 +39,7 @@ module Trestle
       end
 
       def extract_options!
-        @wrapper = extract_wrapper_options(:help, :label, :hide_label).merge(options.delete(:wrapper))
+        @wrapper = extract_wrapper_options(*Fields::FormGroup::WRAPPER_OPTIONS).merge(options.delete(:wrapper))
       end
 
     private

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

@@ -1,7 +1,7 @@
 module Trestle::Form::Fields::DatePicker
   def extract_options!
-    options[:prepend] ||= options.key?(:icon) ? options.delete(:icon) : default_icon
-    options.merge!(data: { picker: options.key?(:picker) ? options.delete(:picker) : true })
+    options[:prepend] ||= options.delete(:icon) { default_icon }
+    options.reverse_merge!(data: { picker: options.delete(:picker) { true }, allow_clear: true })
 
     super
   end