super 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfd2be7e756bd5000efcf53557039621d67df3705df3a35c5806256c66ee4e96
-  data.tar.gz: eccb74df362766a46c1fc951ca327168a4febb06cacd11f3297201e898576053
+  metadata.gz: a8e7ba2e6b5845517d94684e487bdfed0779dcade517e3e3e89bff55fee6f258
+  data.tar.gz: 62e2a405ed8d99a95de077babfdc9eb3b654d651b1887e8776d1dba609058f8e
 SHA512:
-  metadata.gz: 85ab056714996f2030f786e4f9498761b41374614078a7fd27155a1200cce25b583361d5b44f02c7f1bf88b6792e83ea40c9985bd6f5c51f3e117b0950732b7c
-  data.tar.gz: 5e7dc0e1216c67fb5a24cb392dc5d5f1193dbc4ac8acafc39afadd42809ba7cd15c813b729fef9e3026a87cdfaf69eadfe3ef670b9099b62d75fde1c8d14c058
+  metadata.gz: 76bd34e08d34ea8797f0ed197b062a6be056247204a5f6badfea5a82f119c196d37b04a65ad2b1f25535885c013a1ebed7175399090078888cc528b997b57371
+  data.tar.gz: 5933d518932ea142b70aa5ac3c844d497a5bea951ee7bd72ad1a128fabc911212e2c09b63857900b2eec881a97f28aff5682b6e5c9457a25f2d0dba431887900

data/README.md

@@ -1,7 +1,8 @@
 # Super
 
 Super is an admin framework for Ruby on Rails applications. Super helps you make
-powerful admin pages quickly.
+powerful admin pages quickly so that you can concentrate on the parts of your
+app that make it great.
 
 Super strives to let engineers build great admin pages quickly and easily by:
 
@@ -57,16 +58,21 @@ as ActiveAdmin, but it's nice and feels like developing a normal Rails app.
 There's no DSL.
 
 
-## Professional edition
+## Paid editions
 
-Super Professional is a paid add-on that provides additional benefits:
+If you have additional requirements, there are some paid editions to consider:
+
+**Super Premium** provides:
 
-* Productivity improvements and quality of life features for admins
 * Priority email support
-* Supporting long term development of Super
+* Ensuring long term development of Super
+
+**Super Professional** provides everything in Premium and:
+
+* Productivity improvements and quality of life features for admins
 * An LGPL exemption
 
-It isn't available yet. Contact me if you're interested, or subscribe to the
+They aren't available yet. Contact me if you're interested, or subscribe to the
 [newsletter][newsletter] to be notified of its availability and for brief,
 occasional updates to Super.
 

data/app/controllers/super/application_controller.rb

@@ -2,7 +2,6 @@ module Super
   # Provides a default implementation for each of the resourceful actions
   class ApplicationController < ActionController::Base
     include ClientError::Handling
-    include Pluggable.new(:super_application_controller)
 
     helper_method :action_inquirer
     helper_method :controls
@@ -10,21 +9,22 @@ module Super
     # Displays a list of records to the user
     def index
       @records = controls.load_records(action: action_inquirer, params: params)
-      @pagination = controls.initialize_pagination(action: action_inquirer, records: @records, query_params: request.GET)
-      @records = controls.paginate_records(action: action_inquirer, records: @records, pagination: @pagination)
       @display = controls.display_schema(action: action_inquirer)
+      @view = controls.build_index_view
     end
 
     # Displays a specific record to the user
     def show
       @record = controls.load_record(action: action_inquirer, params: params)
       @display = controls.display_schema(action: action_inquirer)
+      @view = controls.build_show_view
     end
 
     # Displays a form to allow the user to create a new record
     def new
       @record = controls.build_record(action: action_inquirer)
       @form = controls.form_schema(action: action_inquirer)
+      @view = controls.build_new_view
     end
 
     # Creates a record, or shows the validation errors
@@ -35,6 +35,7 @@ module Super
         redirect_to polymorphic_path(Super.configuration.path_parts(@record))
       else
         @form = controls.form_schema(action: action_inquirer_for("new"))
+        @view = controls.build_new_view
         render :new, status: :bad_request
       end
     end
@@ -43,6 +44,7 @@ module Super
     def edit
       @record = controls.load_record(action: action_inquirer, params: params)
       @form = controls.form_schema(action: action_inquirer)
+      @view = controls.build_edit_view
     end
 
     # Updates a record, or shows validation errors
@@ -53,6 +55,7 @@ module Super
         redirect_to polymorphic_path(Super.configuration.path_parts(@record))
       else
         @form = controls.form_schema(action: action_inquirer_for("edit"))
+        @view = controls.build_edit_view
         render :edit, status: :bad_request
       end
     end

data/app/views/super/application/_filter.html.erb

@@ -0,0 +1,14 @@
+<%= render(Super::Panel.new) do %>
+  <h1 class="text-xl">Filters</h1>
+  <%= form_for(filter, url: filter.url, method: :get, as: :q, html: { class: "mt-4" }) do |form| %>
+    <% filter.each_field do |filter_field| %>
+      <div class="mt-4">
+        <%= render(filter_field, form: form) %>
+      </div>
+    <% end %>
+
+    <div>
+      <%= form.submit "Filter", class: "super-button super-button--border-gray mt-6" %>
+    </div>
+  <% end %>
+<% end %>

data/app/views/super/application/_filter_type_select.html.erb

@@ -0,0 +1,31 @@
+<div class="super-field-group">
+  <%= form.fields_for(filter_type_select.field_name, filter_type_select) do |form_field| %>
+    <%= form_field.label(:q, filter_type_select.humanized_field_name) %>
+    <div class="super-input-select inline-block">
+      <%= form_field.select(
+        :op,
+        filter_type_select.operators,
+        {},
+        { class: "super-input super-input-select-field" }
+      ) %>
+      <div class="super-input-select-icon text-gray-700">
+        <span class="h-4 w-4">
+          <%= render "super/feather/chevron_down" %>
+        </span>
+      </div>
+    </div>
+    <div class="super-input-select mt-3">
+      <%= form_field.select(
+        :q,
+        filter_type_select.field_type.collection,
+        { include_blank: true },
+        { class: "super-input super-input-select-field" }
+      ) %>
+      <div class="super-input-select-icon text-gray-700">
+        <span class="h-4 w-4">
+          <%= render "super/feather/chevron_down" %>
+        </span>
+      </div>
+    </div>
+  <% end %>
+</div>

data/app/views/super/application/_filter_type_text.html.erb

@@ -0,0 +1,22 @@
+<div class="super-field-group">
+  <%= form.fields_for(filter_type_text.field_name, filter_type_text) do |form_field| %>
+    <%= form_field.label(:q, filter_type_text.humanized_field_name) %>
+    <div class="relative inline-block">
+      <%= form_field.select(
+        :op,
+        filter_type_text.operators,
+        {},
+        { class: "super-input super-input-select-field" }
+      ) %>
+      <div class="super-input-select-icon text-gray-700">
+        <span class="h-4 w-4">
+          <%= render "super/feather/chevron_down" %>
+        </span>
+      </div>
+    </div>
+    <%= form_field.text_field(
+      :q,
+      class: "super-input w-full mt-3"
+    ) %>
+  <% end %>
+</div>

data/app/views/super/application/_filter_type_timestamp.html.erb

@@ -0,0 +1,35 @@
+<div class="super-field-group">
+  <%= form.fields_for(filter_type_timestamp.field_name, filter_type_timestamp) do |form_field| %>
+    <%= form_field.label(:q0, filter_type_timestamp.humanized_field_name) %>
+    <div class="relative inline-block mt-2">
+      <%= form_field.select(
+        :op,
+        filter_type_timestamp.operators,
+        {},
+        { class: "super-input super-input-select-field" }
+      ) %>
+      <div class="super-input-select-icon text-gray-700">
+        <span class="h-4 w-4">
+          <%= render "super/feather/chevron_down" %>
+        </span>
+      </div>
+    </div>
+    <div class="flex items-center mt-3">
+      <div class="flex-initial">
+        <%= form_field.text_field(
+          :q0,
+          class: "super-input w-full"
+        ) %>
+      </div>
+      <div class="flex-initial px-2">
+        &ndash;
+      </div>
+      <div class="flex-initial">
+        <%= form_field.text_field(
+          :q1,
+          class: "super-input w-full"
+        ) %>
+      </div>
+    </div>
+  <% end %>
+</div>

data/app/views/super/application/_super_layout.html.erb

@@ -1,29 +1,29 @@
 <% super_layout.resolve(self) %>
 
 <% super_layout.resolved_headers.each do |partial| %>
-  <%= super_render_partialish(partial) %>
+  <%= Super::Partial.render(partial, template: self) %>
 <% end %>
 
 <% if super_layout.resolved_asides.empty? %>
   <% super_layout.resolved_mains.each do |partial| %>
-    <%= super_render_partialish(partial) %>
+    <%= Super::Partial.render(partial, template: self) %>
   <% end %>
 <% else %>
   <div class="clearfix -mx-2">
     <div class="md:float-left md:w-9/12 px-2">
       <% super_layout.resolved_mains.each do |partial| %>
-        <%= super_render_partialish(partial) %>
+        <%= Super::Partial.render(partial, template: self) %>
       <% end %>
     </div>
 
     <div class="md:float-right md:w-3/12 px-2">
       <% super_layout.resolved_asides.each do |partial| %>
-        <%= super_render_partialish(partial) %>
+        <%= Super::Partial.render(partial, template: self) %>
       <% end %>
     </div>
   </div>
 <% end %>
 
 <% super_layout.resolved_footers.each do |partial| %>
-  <%= super_render_partialish(partial) %>
+  <%= Super::Partial.render(partial, template: self) %>
 <% end %>

data/app/views/super/application/_super_pagination.html.erb

@@ -0,0 +1,16 @@
+<% if @pagination.necessary? %>
+  <div class="flex justify-end mr-2">
+    <div class="mt-4">
+      <% @pagination.each do |page_query_params, is_current_page, display| %>
+        <%= link_to(
+          display,
+          polymorphic_path(
+            Super.configuration.path_parts(controls.model),
+            page_query_params
+          ),
+          class: "inline-block ml-2 text-lg #{is_current_page ? " text-gray-900" : ""}"
+        ) %>
+      <% end %>
+    </div>
+  </div>
+<% end %>

data/app/views/super/application/_super_panel.html.erb

@@ -1,7 +1,7 @@
 <% if super_panel.resolve(self, block_given? ? Proc.new : nil).resolved_parts.any? %>
   <div class="border rounded shadow border-gray-400 bg-white px-5 pt-4 pb-8 mt-6">
     <% super_panel.resolved_parts.each do |partial| %>
-      <%= super_render_partialish(partial) %>
+      <%= Super::Partial.render(partial, template: self) %>
     <% end %>
   </div>
 <% end %>

data/app/views/super/application/_super_schema_display_index.html.erb

@@ -1,9 +1,11 @@
-<div class="mt-4 overflow-x-auto">
-  <table class="w-full border-separate" cellspacing="0" cellpadding="0">
-    <thead>
+<div class="mt-4 overflow-x-auto lg:overflow-x-visible">
+  <table class="w-full border-separate relative" cellspacing="0" cellpadding="0">
+    <thead class="">
       <tr class="">
         <% super_schema_display_index.field_keys.each do |column| %>
-          <th class="p-2 first:pl-6 border-b border-b-2 border-gray-400 text-gray-600 text-left text-sm font-normal"><%= column.to_s.humanize %></th>
+          <th class="p-2 first:pl-6 border-b border-b-2 border-gray-400 text-gray-600 text-left text-sm font-normal bg-white sticky top-0 z-10">
+            <%= controls.model.human_attribute_name(column) %>
+          </th>
         <% end %>
       </tr>
     </thead>
@@ -11,8 +13,8 @@
       <% @records.each.with_index do |record, row_index| %>
         <tr id="record-pk-<%= record.id %>" class="group">
           <% super_schema_display_index.field_keys.each do |column| %>
-            <td class="py-1 px-2 first:pl-5 border-transparent border-t border-b group-hover:bg-blue-200 first:border-l first:rounded-l-lg last:border-r last:rounded-r-lg <%= Super::ViewHelper.classes(["bg-gray-100", row_index.odd?]) %>">
-              <%= super_format_for_display(super_schema_display_index, record, column) %>
+            <td class="py-1 px-2 first:pl-5 border-transparent border-t border-b group-hover:bg-blue-200 first:border-l first:rounded-l-lg last:border-r last:rounded-r-lg bg-white <%= Super::ViewHelper.classes(["bg-gray-100", row_index.odd?]) %>">
+              <%= super_schema_display_index.schema_type.render_field(template: self, record: record, column: column) %>
             </td>
           <% end %>
         </tr>
@@ -20,20 +22,3 @@
     </tbody>
   </table>
 </div>
-
-<% if @pagination.necessary? %>
-  <div class="flex justify-end mr-2">
-    <div class="mt-4">
-      <% @pagination.each do |page_query_params, is_current_page, display| %>
-        <%= link_to(
-          display,
-          polymorphic_path(
-            Super.configuration.path_parts(controls.model),
-            page_query_params
-          ),
-          class: "inline-block ml-2 text-lg #{is_current_page ? " text-gray-900" : ""}"
-        ) %>
-      <% end %>
-    </div>
-  </div>
-<% end %>

data/app/views/super/application/_super_schema_display_show.html.erb

@@ -2,7 +2,7 @@
   <% super_schema_display_show.field_keys.each do |column| %>
     <tr>
       <th class="text-right px-4"><%= column.to_s.humanize %></th>
-      <td><%= super_format_for_display(super_schema_display_show, @record, column) %></td>
+      <td><%= super_schema_display_show.schema_type.render_field(template: self, record: @record, column: column) %></td>
     </tr>
   <% end %>
 </table>

data/app/views/super/application/edit.html.erb

@@ -1,6 +1 @@
-<%= render(
-  Super::Panel.new(
-    Super::Partial.new("member_header"),
-    @form
-  )
-) %>
+<%= render(@view) %>

data/app/views/super/application/index.html.erb

@@ -1,6 +1 @@
-<%= render(
-  Super::Panel.new(
-    Super::Partial.new("collection_header"),
-    @display
-  )
-) %>
+<%= render(@view) %>

data/app/views/super/application/new.html.erb

@@ -1,6 +1 @@
-<%= render(
-  Super::Panel.new(
-    Super::Partial.new("collection_header"),
-    @form
-  )
-) %>
+<%= render(@view) %>

data/app/views/super/application/show.html.erb

@@ -1,6 +1 @@
-<%= render(
-  Super::Panel.new(
-    Super::Partial.new("member_header"),
-    @display
-  )
-) %>
+<%= render(@view) %>

data/lib/super.rb

@@ -1,4 +1,6 @@
-require "active_support/concern"
+require "tsort"
+
+require "rails/engine"
 
 require "super/action_inquirer"
 require "super/assets"
@@ -7,8 +9,10 @@ require "super/compatibility"
 require "super/configuration"
 require "super/controls"
 require "super/display/schema_types"
-require "super/engine"
 require "super/error"
+require "super/filter"
+require "super/filter/operator"
+require "super/filter/schema_types"
 require "super/form"
 require "super/form/schema_types"
 require "super/layout"
@@ -21,3 +25,5 @@ require "super/plugin"
 require "super/schema"
 require "super/version"
 require "super/view_helper"
+
+require "super/engine"

data/lib/super/compatibility.rb

@@ -2,12 +2,24 @@ module Super
   module Compatability
     module_function
 
-    def rails_50_errable_fields(field)
+    # Rails 5.1 and after lets you find field errors using either a string or a
+    # symbol.
+    def errable_fields(field)
       if Rails::VERSION::MAJOR == 5 && Rails::VERSION::MINOR == 0
         [field.to_s, field.to_sym]
       else
         field
       end
     end
+
+    def sanitize_sql_like(query)
+      if ActiveRecord::VERSION::MAJOR == 4
+        ActiveRecord::Base.send(:sanitize_sql_like, query)
+      elsif ActiveRecord::VERSION::MAJOR == 5 && ActiveRecord::VERSION::MINOR <= 1
+        ActiveRecord::Base.send(:sanitize_sql_like, query)
+      else
+        ActiveRecord::Base.sanitize_sql_like(query)
+      end
+    end
   end
 end

data/lib/super/configuration.rb

@@ -32,6 +32,9 @@ module Super
 
           public_send("#{key}=", value)
         end
+
+        Plugin::Registry.controller.use(prepend: Super::Filter::ControllerMethods)
+        Plugin::Registry.controller.use(prepend: Super::Pagination::ControllerMethods)
       end
 
       def configured?(attr)
@@ -95,6 +98,10 @@ module Super
     # @!attribute [rw]
     configure :asset_handler, default: -> { Super::Assets.auto }
 
+    def controller_plugins
+      Plugin::Registry.controller
+    end
+
     # @api private
     def path_parts(*parts)
       route_namespace + parts

data/lib/super/controls/optional.rb

@@ -49,17 +49,6 @@ module Super
           end
         end
       end
-
-      # Specifies how many records to show per page
-      #
-      # @param action [ActionInquirer]
-      # @param query_params [Hash]
-      # @return [ActiveRecord::Relation]
-      def records_per_page(action:, query_params:)
-        default_for(:records_per_page, action: action, query_params: query_params) do
-          Super.configuration.index_records_per_page
-        end
-      end
     end
   end
 end