trestle 0.8.3 → 0.8.4

data/bower.json

@@ -8,7 +8,7 @@
       "ionicons":                "~2.0.1",
       "magnific-popup":          "~1.1.0",
       "bootstrap-confirmation2": "~2.4.0",
-      "flatpickr":               "~2.6.1",
+      "flatpickr":               "~3.0.7",
       "select2":                 "~4.0.3",
       "select2-bootstrap-theme": "~0.1.0"
   }

data/config/locales/en.yml

@@ -28,6 +28,12 @@ en:
         more_pages:
           display_entries: "Displaying %{entry_name} <strong>%{first}&nbsp;-&nbsp;%{last}</strong> of <b>%{total}</b>"
 
+    onboarding:
+      welcome: Welcome to Trestle
+      no_admins: To begin, please create an admin within <code>app/admin</code>.
+      no_template: To customize this template, please create <code>%{path}</code>.
+      no_form: Please define a form block or create a <code>_form.html</code> partial.
+
   admin:
     titles:
       index: Listing %{pluralized_model_name}
@@ -44,10 +50,18 @@ en:
       headers:
         id: ID
 
-      column:
-        blank: None
+    form:
+      select:
+        prompt: "- Select %{attribute_name} -"
 
     confirmation:
       title: Are you sure?
       delete: Delete
       cancel: Cancel
+
+    ui:
+      toggle_navigation: Toggle navigation
+      toggle_sidebar: Toggle sidebar
+
+    format:
+      blank: None

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

@@ -10,10 +10,10 @@ module Trestle
       end
 
       def create_assets
-        template "_variables.scss",   "app/assets/stylesheets/trestle/_variables.scss"
-        template "_custom.scss",      "app/assets/stylesheets/trestle/_custom.scss"
+        template "_variables.scss", "app/assets/stylesheets/trestle/_variables.scss"
+        template "_custom.scss",    "app/assets/stylesheets/trestle/_custom.scss"
 
-        template "custom.js.coffee",  "app/assets/javascripts/trestle/custom.js.coffee"
+        template "custom.js",       "app/assets/javascripts/trestle/custom.js"
       end
 
       def create_directory

data/lib/generators/trestle/install/templates/custom.js

@@ -0,0 +1,7 @@
+// 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 and `require` them here.
+//
+//  e.g. //= require "trestle/custom/my_custom_js"

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

@@ -70,7 +70,7 @@ Trestle.configure do |config|
   # config.around_action do |controller, block|
   #   Rails.logger.debug("Around action (before)")
   #   block.call
-  #   Rails.logger.debug("Around ation (after)")
+  #   Rails.logger.debug("Around action (after)")
   # end
 
   # Specify a custom hook to be injected into the admin.
@@ -93,7 +93,8 @@ Trestle.configure do |config|
   # See the documentation on Trestle::Adapters::Adapter for details on
   # the adapter methods that can be customized.
   #
-  # config.default_adapter.extend MyAdapterExtensions
+  # config.default_adapter = Trestle::Adapters.compose(Trestle::Adapters::SequelAdapter)
+  # config.default_adapter.include MyAdapterExtensions
 
   # Register a form field type to be made available to the Trestle form builder.
   # Field types should conform to the following method definition:

data/lib/trestle/adapters.rb

@@ -2,73 +2,16 @@ module Trestle
   module Adapters
     extend ActiveSupport::Autoload
 
+    autoload :Adapter
+
     autoload :ActiveRecordAdapter
     autoload :DraperAdapter
+    autoload :SequelAdapter
 
-    class Adapter
-      attr_reader :admin
-
-      def initialize(admin)
-        @admin = admin
-      end
-
-      def collection(params={})
-        raise NotImplementedError
-      end
-
-      def find_instance(params)
-        raise NotImplementedError
-      end
-
-      def build_instance(params={})
-        raise NotImplementedError
-      end
-
-      def update_instance(instance, params)
-        raise NotImplementedError
-      end
-
-      def save_instance(instance)
-        raise NotImplementedError
-      end
-
-      def delete_instance(instance)
-        raise NotImplementedError
-      end
-
-      def decorate_collection(collection)
-        collection
-      end
-
-      def merge_scopes(scope, other)
-        raise NotImplementedError
-      end
-
-      def sort(collection, params)
-        raise NotImplementedError
-      end
-
-      def paginate(collection, params)
-        raise NotImplementedError
-      end
-
-      def count(collection)
-        raise NotImplementedError
-      end
-
-      def permitted_params(params)
-        params.require(admin.admin_name.singularize).permit!
-      end
-
-      def default_attributes
-        raise NotImplementedError
-      end
-
-      # Creates a new Adapter class with the given modules mixed in
-      def self.compose(*modules)
-        Class.new(self) do
-          modules.each { |mod| include(mod) }
-        end
+    # Creates a new Adapter class with the given modules mixed in
+    def self.compose(*modules)
+      Class.new(Adapter) do
+        modules.each { |mod| include(mod) }
       end
     end
   end

data/lib/trestle/adapters/active_record_adapter.rb

@@ -2,19 +2,19 @@ module Trestle
   module Adapters
     module ActiveRecordAdapter
       def collection(params={})
-        admin.model.all
+        model.all
       end
 
       def find_instance(params)
-        admin.model.find(params[:id])
+        model.find(params[:id])
       end
 
-      def build_instance(params={})
-        admin.model.new(params)
+      def build_instance(attrs={}, params={})
+        model.new(attrs)
       end
 
-      def update_instance(instance, params)
-        instance.assign_attributes(params)
+      def update_instance(instance, attrs, params={})
+        instance.assign_attributes(attrs)
       end
 
       def save_instance(instance)
@@ -25,10 +25,6 @@ module Trestle
         instance.destroy
       end
 
-      def to_param(instance)
-        instance
-      end
-
       def unscope(scope)
         scope.unscoped
       end
@@ -37,27 +33,57 @@ module Trestle
         scope.merge(other)
       end
 
+      def count(collection)
+        collection.count
+      end
+
       def sort(collection, field, order)
         collection.reorder(field => order)
       end
 
-      def paginate(collection, params)
-        collection = Kaminari.paginate_array(collection) unless collection.respond_to?(:page)
-        collection.page(params[:page])
+      def human_attribute_name(attribute, options={})
+        model.human_attribute_name(attribute, options)
       end
 
-      def count(collection)
-        collection.count
+      def default_table_attributes
+        default_attributes.reject do |attribute|
+          inheritance_column?(attribute) || counter_cache_column?(attribute)
+        end
       end
 
+      def default_form_attributes
+        default_attributes.reject do |attribute|
+          primary_key?(attribute) || inheritance_column?(attribute) || counter_cache_column?(attribute)
+        end
+      end
+
+    protected
       def default_attributes
-        admin.model.columns.map do |column|
-          if column.name.end_with?("_id") && (reflection = admin.model.reflections[column.name.sub(/_id$/, '')])
-            Attribute::Association.new(admin, column.name, reflection.klass)
+        model.columns.map do |column|
+          if column.name.end_with?("_id") && (name = column.name.sub(/_id$/, '')) && (reflection = model.reflections[name])
+            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
           else
-            Attribute.new(admin, column.name, column.type)
+            Attribute.new(column.name, column.type, array_column?(column) ? { array: true } : {})
           end
-        end
+        end.compact
+      end
+
+      def primary_key?(attribute)
+        attribute.name.to_s == model.primary_key
+      end
+
+      def inheritance_column?(attribute)
+        attribute.name.to_s == model.inheritance_column
+      end
+
+      def counter_cache_column?(attribute)
+        attribute.name.to_s.end_with?("_count")
+      end
+
+      def array_column?(column)
+        column.respond_to?(:array?) && column.array?
       end
     end
   end

data/lib/trestle/adapters/adapter.rb

@@ -0,0 +1,176 @@
+module Trestle
+  module Adapters
+    class Adapter
+      attr_reader :admin
+      delegate :model, to: :admin
+
+      def initialize(admin)
+        @admin = admin
+      end
+
+      # Loads the initial collection for use by the index action.
+      #
+      # params - Unfiltered params hash from the controller
+      #
+      # Returns a scope object that can be chained with other methods (e.g. sort, paginate, count, etc).
+      def collection(params={})
+        raise NotImplementedError
+      end
+
+      # Finds (and returns) an individual instance for use by the show, edit, update, destroy actions.
+      #
+      # params - Unfiltered params hash from the controller
+      def find_instance(params)
+        raise NotImplementedError
+      end
+
+      # Builds (and returns) a new instance for new/create actions.
+      #
+      # attrs  - Permitted attributes to set on the new instance
+      # params - Unfiltered params hash from the controller
+      def build_instance(attrs={}, params={})
+        raise NotImplementedError
+      end
+
+      # Updates (but does not save) a given resource's attributes.
+      #
+      # instance - The instance to update
+      # attrs    - Permitted attributes to update on the instance
+      # params   - Unfiltered params hash from the controller
+      #
+      # The return value is ignored.
+      def update_instance(instance, attrs, params={})
+        raise NotImplementedError
+      end
+
+      # Saves an instance (used by the create and update actions).
+      #
+      # instance - The instance to save
+      #
+      # Returns a boolean indicating the success/fail status of the save.
+      def save_instance(instance)
+        raise NotImplementedError
+      end
+
+      # Deletes an instance (used by the destroy action).
+      #
+      # instance - The instance to delete
+      #
+      # Returns a boolean indicating the success/fail status of the deletion.
+      def delete_instance(instance)
+        raise NotImplementedError
+      end
+
+      # Decorates a collection for rendering by the index view.
+      # Decorating is the final step in preparing the collection for the view.
+      #
+      # collection - The collection to decorate
+      #
+      # Returns an enumerable collection of instances.
+      def decorate_collection(collection)
+        collection
+      end
+
+      # Converts an instance to a URL parameter. The result of this method is passed to the #find_instance
+      # adapter method as params[:id]. It is recommended to simply use the instance's #id, as other potential options
+      # such as a permalink/slug could potentially be changed during editing.
+      #
+      # instance - The instance to convert
+      #
+      # Returns the URL representation of the instance.
+      def to_param(instance)
+        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
+      # other - The second scope
+      #
+      # Returns a scope object representing the combination of the two given scopes.
+      def merge_scopes(scope, other)
+        raise NotImplementedError
+      end
+
+      # Counts the number of objects in a collection for use by scope links.
+      #
+      # collection - The collection to count
+      #
+      # Returns the total number (integer) of objects in the collection.
+      def count(collection)
+        raise NotImplementedError
+      end
+
+      # Sorts the collection by the given field and order.
+      # This method is called when an explicit sort column for the given field is not defined.
+      #
+      # collection - The collection to sort
+      # field      - The field to sort by
+      # order      - Symbol (:asc or :desc) representing the sort order (ascending or descending)
+      #
+      # Returns a scope object
+      def sort(collection, field, order)
+        raise NotImplementedError
+      end
+
+      # Paginates a collection for use by the index action.
+      #
+      # collection - The collection to paginate
+      # params     - Unfiltered params hash from the controller:
+      #              :page - current page number
+      #
+      # 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])
+      end
+
+      # Filters the submitted form parameters and returns a whitelisted attributes 'hash'
+      # that can be set or updated on a model instance.
+      #
+      # IMPORTANT: By default, all params are permitted, which assumes a trusted administrator. If this is not the
+      # case, a `params` block should be individually declared for each admin with the set of permitted parameters.
+      #
+      # params - Unfiltered params hash from the controller
+      #
+      # Returns the permitted set of parameters as a ActionController::Parameters object.
+      def permitted_params(params)
+        params.require(admin.admin_name.singularize).permit!
+      end
+
+      # Produces a human-readable name for a given attribute, applying I18n where appropriate.
+      # See ActiveModel::Translation for an implementation of this method.
+      #
+      # attribute - Attribute name (Symbol)
+      # options   - Hash of options [not currently used]
+      #
+      # Returns the human-readable name of the given attribute as a String.
+      def human_attribute_name(attribute, options={})
+        attribute.to_s.titleize
+      end
+
+      # Generates a list of attributes that should be rendered by the index (table) view.
+      #
+      # Returns an Array of Trestle::Attribute and/or Trestle::Attribute::Association objects.
+      def default_table_attributes
+        raise NotImplementedError
+      end
+
+      # Generates a list of attributes that should be rendered by the new/show/edit (form) views.
+      #
+      # Returns an Array of Trestle::Attribute and/or Trestle::Attribute::Association objects.
+      def default_form_attributes
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/trestle/adapters/sequel_adapter.rb

@@ -0,0 +1,85 @@
+begin
+  require "sequel"
+rescue LoadError
+  $stderr.puts "You don't have sequel installed in your application. Please add it to your Gemfile and run bundle install"
+  raise
+end
+
+Sequel::Model.plugin :active_model
+
+module Trestle
+  module Adapters
+    module SequelAdapter
+      def collection(params={})
+        model.dataset
+      end
+
+      def find_instance(params)
+        model[params[:id]]
+      end
+
+      def build_instance(attrs={}, params={})
+        model.new(attrs)
+      end
+
+      def update_instance(instance, attrs, params={})
+        instance.set(attrs)
+      end
+
+      def save_instance(instance)
+        instance.save
+      end
+
+      def delete_instance(instance)
+        instance.destroy
+      end
+
+      def unscope(scope)
+        scope.unfiltered
+      end
+
+      def merge_scopes(scope, other)
+        scope.intersect(other)
+      end
+
+      def count(collection)
+        collection.count
+      end
+
+      def sort(collection, field, order)
+        collection.order(Sequel.send(order, field))
+      end
+
+      def default_table_attributes
+        default_attributes.reject do |attribute|
+          inheritance_column?(attribute)
+        end
+      end
+
+      def default_form_attributes
+        default_attributes.reject do |attribute|
+          primary_key?(attribute) || inheritance_column?(attribute)
+        end
+      end
+
+    protected
+      def default_attributes
+        model.db_schema.map do |column_name, column_attrs|
+          if column_name.to_s.end_with?("_id") && (name = column_name.to_s.sub(/_id$/, '')) && (reflection = model.association_reflection(name.to_sym))
+            Attribute::Association.new(column_name, class: -> { reflection.associated_class }, name: name)
+          else
+            Attribute.new(column_name, column_attrs[:type])
+          end
+        end
+      end
+
+      def primary_key?(attribute)
+        attribute.name.to_s == model.primary_key.to_s
+      end
+
+      def inheritance_column?(attribute)
+        model.respond_to?(:sti_key) && attribute.name.to_s == model.sti_key.to_s
+      end
+    end
+  end
+end