terrazzo 0.6.0 → 0.7.0

data/lib/terrazzo/field/has_many.rb

@@ -1,6 +1,8 @@
 module Terrazzo
   module Field
     class HasMany < Associative
+      DEFAULT_PER_PAGE = 5
+
       def serialize_value(mode)
         return nil if data.nil?
 
@@ -45,7 +47,8 @@ module Terrazzo
       end
 
       def per_page
-        (options[:per_page] || options[:limit] || 5).to_i
+        requested = (options[:per_page] || options[:limit] || DEFAULT_PER_PAGE).to_i
+        requested.positive? ? requested : DEFAULT_PER_PAGE
       end
 
       def current_page
@@ -62,7 +65,11 @@ module Terrazzo
       end
 
       def page_records
-        paginated.to_a
+        @page_records ||= begin
+          records = paginated.to_a
+          preload_record_associations(records)
+          records
+        end
       end
 
       private
@@ -75,8 +82,15 @@ module Terrazzo
         end
       end
 
+      def preload_record_associations(records, associations = options[:preload])
+        return unless associations.present? && records.any?
+
+        ActiveRecord::Associations::Preloader.new(records: records, associations: associations).call
+      end
+
       def serialize_show_value
         col_attrs = options[:collection_attributes] || resolve_default_collection_attributes
+        records = page_records
 
         meta = {
           total: total_count,
@@ -86,10 +100,11 @@ module Terrazzo
         }
 
         if col_attrs
-          { **serialize_with_collection_attributes(page_records, col_attrs), **meta }
+          preload_record_associations(records, collection_includes_for(col_attrs))
+          { **serialize_with_collection_attributes(records, col_attrs), **meta }
         else
           {
-            items: page_records.map { |r| { id: r.id.to_s, display: display_name(r) } },
+            items: records.map { |r| { id: r.id.to_s, display: display_name(r) } },
             **meta,
           }
         end
@@ -103,27 +118,75 @@ module Terrazzo
       end
 
       def serialize_with_collection_attributes(records, col_attrs)
-        dashboard_class = find_associated_dashboard
+        dashboard = find_associated_dashboard.new
 
         headers = col_attrs.map do |attr|
-          { attribute: attr.to_s, label: attr.to_s.humanize }
+          header = { attribute: attr.to_s, label: dashboard.attribute_label(attr, :index) }
+          header_options = serialized_header_options(dashboard, attr)
+          header[:headerOptions] = header_options if header_options.present?
+          header
         end
 
         rows = records.map do |record|
           cells = col_attrs.map do |attr|
-            field = dashboard_class.new.attribute_type_for(attr).new(attr, nil, :index, resource: record)
-            {
+            field = dashboard.attribute_type_for(attr).new(attr, nil, :index, resource: record)
+            cell = {
               attribute: attr.to_s,
               fieldType: field.field_type,
               value: field.serialize_value(:index)
             }
+            cell_options = serialized_cell_options(dashboard, attr, record)
+            cell[:cellOptions] = cell_options if cell_options.present?
+            cell
           end
-          { id: record.id.to_s, cells: cells }
+          row = { id: record.id.to_s, cells: cells }
+          row_options = serialized_row_options(dashboard, record)
+          row[:rowOptions] = row_options if row_options.present?
+          row
         end
 
         { headers: headers, rows: rows }
       end
 
+      def serialized_header_options(dashboard, attribute)
+        options = (dashboard.collection_header_options(attribute) || {}).to_h
+        class_name = options.delete(:class_name) ||
+          options.delete("class_name") ||
+          options.delete(:className) ||
+          options.delete("className")
+
+        {
+          className: class_name,
+          meta: options.presence,
+        }.compact
+      end
+
+      def serialized_row_options(dashboard, resource)
+        options = (dashboard.collection_row_options(resource) || {}).to_h
+        class_name = options.delete(:class_name) ||
+          options.delete("class_name") ||
+          options.delete(:className) ||
+          options.delete("className")
+
+        {
+          className: class_name,
+          meta: options.presence,
+        }.compact
+      end
+
+      def serialized_cell_options(dashboard, attribute, resource)
+        options = (dashboard.collection_cell_options(attribute, resource) || {}).to_h
+        class_name = options.delete(:class_name) ||
+          options.delete("class_name") ||
+          options.delete(:className) ||
+          options.delete("className")
+
+        {
+          className: class_name,
+          meta: options.presence,
+        }.compact
+      end
+
       def resource_options
         return [] unless associated_class
         scope = if options[:scope].is_a?(Proc)
@@ -135,8 +198,7 @@ module Terrazzo
         end
         scope = scope.includes(*options[:includes]) if options.key?(:includes)
         pk = association_primary_key
-        dashboard = associated_dashboard
-        scope.map { |r| [dashboard ? dashboard.display_resource(r) : display_name(r), r.public_send(pk).to_s] }
+        scope.map { |r| [display_name(r), r.public_send(pk).to_s] }
       end
 
       def apply_sorting(records)
@@ -157,6 +219,12 @@ module Terrazzo
         klass = associated_class
         "#{klass.name}Dashboard".constantize
       end
+
+      def collection_includes_for(col_attrs)
+        find_associated_dashboard.new.includes_for_attributes(col_attrs)
+      rescue NameError
+        []
+      end
     end
   end
 end

data/lib/terrazzo/field/password.rb

@@ -11,6 +11,12 @@ module Terrazzo
           data.present? ? MASKED : nil
         end
       end
+
+      class << self
+        def sortable?
+          false
+        end
+      end
     end
   end
 end

data/lib/terrazzo/field/rich_text.rb

@@ -17,10 +17,23 @@ module Terrazzo
           false
         end
 
+        def sortable?
+          false
+        end
+
         def eager_load?
           true
         end
 
+        def eager_load_association(attr, model_class = nil)
+          rich_text_association = :"rich_text_#{attr}"
+          if model_class&.reflect_on_association(rich_text_association)
+            rich_text_association
+          else
+            attr.to_sym
+          end
+        end
+
         def default_options
           { truncate: 100 }
         end

data/lib/terrazzo/generator_helpers.rb

@@ -12,7 +12,7 @@ module Terrazzo
       case column.type
       when :string
         if column.name.end_with?("_id")
-          "Field::Number"
+          "Field::String"
         elsif column.name.include?("email")
           "Field::Email"
         elsif column.name.include?("url") || column.name.include?("link")

data/lib/terrazzo/has_many_pagination.rb

@@ -1,18 +1,26 @@
 module Terrazzo
   module HasManyPagination
+    PARAM_PREFIX = "hm_".freeze
     PARAM_SUFFIX = "_page".freeze
 
     module_function
 
     def extract(params, attributes)
       attributes.each_with_object({}) do |attr, result|
-        value = params[param_key(attr)] || params[param_key(attr).to_sym]
+        value = params[param_key(attr)] ||
+          params[param_key(attr).to_sym] ||
+          params[legacy_param_key(attr)] ||
+          params[legacy_param_key(attr).to_sym]
         next if value.nil?
         result[attr.to_sym] = { _page: value.to_i }
       end
     end
 
     def param_key(attribute)
+      "#{PARAM_PREFIX}#{attribute}#{PARAM_SUFFIX}"
+    end
+
+    def legacy_param_key(attribute)
       "#{attribute}#{PARAM_SUFFIX}"
     end
   end

data/lib/terrazzo/namespace/resource.rb

@@ -23,6 +23,36 @@ module Terrazzo
         resource_name.to_sym
       end
 
+      def dashboard
+        @dashboard ||= dashboard_class&.new
+      end
+
+      def dashboard_class
+        Terrazzo::ResourceResolver.new(controller_path).dashboard_class
+      rescue NameError
+        nil
+      end
+
+      def navigation_label
+        dashboard&.navigation_label || resource_name.humanize.pluralize
+      end
+
+      def navigation_group
+        dashboard&.navigation_group || "Resources"
+      end
+
+      def navigation_order
+        dashboard&.navigation_order || navigation_label
+      end
+
+      def navigation_group_order
+        dashboard&.navigation_group_order || navigation_group
+      end
+
+      def show_in_navigation?
+        dashboard.nil? || dashboard.show_in_navigation?
+      end
+
       def ==(other)
         resource_name == other.resource_name
       end

data/lib/terrazzo/namespace.rb

@@ -21,14 +21,39 @@ module Terrazzo
       end.map { |route| Resource.new(route) }.uniq(&:controller_path)
     end
 
+    def navigation_resources
+      resources_with_index_route
+        .select(&:show_in_navigation?)
+        .sort_by do |resource|
+          [
+            navigation_sort_value(resource.navigation_group_order),
+            navigation_sort_value(resource.navigation_group),
+            navigation_sort_value(resource.navigation_order),
+            navigation_sort_value(resource.navigation_label),
+          ]
+        end
+    end
+
     private
 
     def routes_for_namespace
-      Rails.application.routes.routes.select do |route|
+      namespace_routes.select do |route|
         path = route.defaults[:controller].to_s
         path.start_with?("#{name}/") &&
           route.defaults[:action].present?
       end
     end
+
+    def namespace_routes
+      if router.respond_to?(:routes) && !router.equal?(Rails.application.routes.router)
+        router.routes
+      else
+        Rails.application.routes.routes
+      end
+    end
+
+    def navigation_sort_value(value)
+      value.is_a?(Numeric) ? [0, value] : [1, value.to_s]
+    end
   end
 end

data/lib/terrazzo/search.rb

@@ -18,7 +18,10 @@ module Terrazzo
 
     private
 
+    LIKE_ESCAPE = "\\"
+
     def search_results
+      @association_search_joined = false
       searchable_attributes = dashboard.search_attributes
       return scoped_resource if searchable_attributes.empty?
 
@@ -26,31 +29,48 @@ module Terrazzo
         type = dashboard.attribute_type_for(attr)
 
         if type.respond_to?(:associative?) && type.associative?
-          build_association_search(attr)
+          build_association_search(attr, type)
         else
           table = scoped_resource.model.arel_table
-          table[attr].matches("%#{sanitize(term)}%")
+          table[attr].matches(search_pattern, LIKE_ESCAPE)
         end
       end.compact
 
+      return scoped_resource if conditions.empty?
+
       combined = conditions.reduce(:or)
-      scoped_resource.where(combined)
+      results = scoped_resource.where(combined)
+      @association_search_joined ? results.distinct : results
     end
 
-    def build_association_search(attr)
+    def build_association_search(attr, type)
       reflection = scoped_resource.model.reflect_on_association(attr)
       return nil unless reflection
 
       assoc_table = reflection.klass.arel_table
-      name_column = [:name, :title, :email].find { |col| reflection.klass.column_names.include?(col.to_s) }
-      return nil unless name_column
+      columns = association_search_columns(type, reflection.klass)
+      return nil if columns.empty?
 
       @scoped_resource = scoped_resource.left_joins(attr)
-      assoc_table[name_column].matches("%#{sanitize(term)}%")
+      @association_search_joined = true
+      columns
+        .map { |column| assoc_table[column].matches(search_pattern, LIKE_ESCAPE) }
+        .reduce(:or)
+    end
+
+    def association_search_columns(type, associated_class)
+      configured = type.respond_to?(:options) ? Array(type.options[:searchable_fields]) : []
+      candidates = configured.presence || [:name, :title, :email]
+      column_names = associated_class.column_names
+
+      candidates
+        .map(&:to_s)
+        .select { |column| column_names.include?(column) }
+        .map(&:to_sym)
     end
 
-    def sanitize(term)
-      term.gsub(/[%_\\]/) { |m| "\\#{m}" }
+    def search_pattern
+      "%#{ActiveRecord::Base.sanitize_sql_like(term.to_s, LIKE_ESCAPE)}%"
     end
   end
 end

data/lib/terrazzo/version.rb

@@ -1,3 +1,3 @@
 module Terrazzo
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/lib/terrazzo.rb

@@ -11,6 +11,7 @@ module Terrazzo
   autoload :Search, "terrazzo/search"
   autoload :Order, "terrazzo/order"
   autoload :Filter, "terrazzo/filter"
+  autoload :CsvExport, "terrazzo/csv_export"
   autoload :Namespace, "terrazzo/namespace"
   autoload :GeneratorHelpers, "terrazzo/generator_helpers"
   autoload :HasManyPagination, "terrazzo/has_many_pagination"

data/terrazzo.gemspec

@@ -7,15 +7,24 @@ Gem::Specification.new do |spec|
   spec.email = []
   spec.summary = "A Rails admin framework powered by Superglue and React"
   spec.description = "Drop-in admin panel for Rails apps using the Administrate dashboard DSL with a React SPA frontend powered by Superglue."
-  spec.homepage = "https://github.com/gohypelab/terrazzo"
+  spec.homepage = "https://gohypelab.github.io/terrazzo/"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 3.1"
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => "https://github.com/gohypelab/terrazzo",
+    "documentation_uri" => "https://gohypelab.github.io/terrazzo/getting-started",
+    "changelog_uri" => "https://github.com/gohypelab/terrazzo/releases",
+    "bug_tracker_uri" => "https://github.com/gohypelab/terrazzo/issues",
+    "rubygems_mfa_required" => "true",
+  }
 
   spec.files = Dir[
     "app/**/*",
     "config/**/*",
     "lib/**/*",
     "LICENSE",
+    "README.md",
     "Rakefile",
     "terrazzo.gemspec"
   ]
@@ -25,6 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "kaminari", "~> 1.2"
   spec.add_dependency "superglue", "~> 1.1"
   spec.add_dependency "form_props", ">= 0.0.6"
+  spec.add_dependency "csv", ">= 3.3"
 
   spec.add_development_dependency "rspec-rails", "~> 7.0"
   spec.add_development_dependency "factory_bot_rails", "~> 6.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: terrazzo
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Terrazzo Contributors
@@ -65,6 +65,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.0.6
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -115,9 +129,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
+- README.md
 - Rakefile
 - app/controllers/terrazzo/application_controller.rb
 - app/helpers/terrazzo/collection_actions_helper.rb
+- app/helpers/terrazzo/resource_paths_helper.rb
 - app/views/terrazzo/application/_edit_base.json.props
 - app/views/terrazzo/application/_index_base.json.props
 - app/views/terrazzo/application/_navigation.json.props
@@ -141,26 +157,36 @@ files:
 - lib/generators/terrazzo/install/install_generator.rb
 - lib/generators/terrazzo/install/templates/admin.css
 - lib/generators/terrazzo/install/templates/application.js.erb
-- lib/generators/terrazzo/install/templates/application.json.props.erb
 - lib/generators/terrazzo/install/templates/application.json.props.tt
 - lib/generators/terrazzo/install/templates/application_controller.rb.erb
 - lib/generators/terrazzo/install/templates/application_visit.js.erb
+- lib/generators/terrazzo/install/templates/components.json.erb
+- lib/generators/terrazzo/install/templates/custom_page_mapping.js.erb
 - lib/generators/terrazzo/install/templates/flash_slice.js.erb
+- lib/generators/terrazzo/install/templates/generated_page_mapping.js.erb
+- lib/generators/terrazzo/install/templates/jsconfig.json
 - lib/generators/terrazzo/install/templates/page_to_page_mapping.js.erb
 - lib/generators/terrazzo/install/templates/store.js.erb
 - lib/generators/terrazzo/install/templates/superglue.html.erb.erb
 - lib/generators/terrazzo/routes/routes_generator.rb
 - lib/generators/terrazzo/views/edit_generator.rb
+- lib/generators/terrazzo/views/eject_compatibility.rb
 - lib/generators/terrazzo/views/field_generator.rb
+- lib/generators/terrazzo/views/generated_defaults_helper.rb
 - lib/generators/terrazzo/views/index_generator.rb
 - lib/generators/terrazzo/views/layout_generator.rb
 - lib/generators/terrazzo/views/navigation_generator.rb
 - lib/generators/terrazzo/views/new_generator.rb
 - lib/generators/terrazzo/views/page_mapping_helper.rb
 - lib/generators/terrazzo/views/show_generator.rb
+- lib/generators/terrazzo/views/templates/components/CollectionFilters.jsx
+- lib/generators/terrazzo/views/templates/components/CollectionItemActions.jsx
+- lib/generators/terrazzo/views/templates/components/CollectionToolbarActions.jsx
 - lib/generators/terrazzo/views/templates/components/FlashMessages.jsx
+- lib/generators/terrazzo/views/templates/components/HasManyPagination.jsx
 - lib/generators/terrazzo/views/templates/components/Layout.jsx
 - lib/generators/terrazzo/views/templates/components/Pagination.jsx
+- lib/generators/terrazzo/views/templates/components/ResourceTable.jsx
 - lib/generators/terrazzo/views/templates/components/SearchBar.jsx
 - lib/generators/terrazzo/views/templates/components/SortableHeader.jsx
 - lib/generators/terrazzo/views/templates/components/app-sidebar.jsx
@@ -184,7 +210,9 @@ files:
 - lib/generators/terrazzo/views/templates/components/ui/table.jsx
 - lib/generators/terrazzo/views/templates/components/ui/textarea.jsx
 - lib/generators/terrazzo/views/templates/components/ui/tooltip.jsx
-- lib/generators/terrazzo/views/templates/fields/FieldRenderer.jsx
+- lib/generators/terrazzo/views/templates/fields/asset/FormField.jsx
+- lib/generators/terrazzo/views/templates/fields/asset/IndexField.jsx
+- lib/generators/terrazzo/views/templates/fields/asset/ShowField.jsx
 - lib/generators/terrazzo/views/templates/fields/belongs_to/FormField.jsx
 - lib/generators/terrazzo/views/templates/fields/belongs_to/IndexField.jsx
 - lib/generators/terrazzo/views/templates/fields/belongs_to/ShowField.jsx
@@ -209,7 +237,6 @@ files:
 - lib/generators/terrazzo/views/templates/fields/hstore/FormField.jsx
 - lib/generators/terrazzo/views/templates/fields/hstore/IndexField.jsx
 - lib/generators/terrazzo/views/templates/fields/hstore/ShowField.jsx
-- lib/generators/terrazzo/views/templates/fields/index.js
 - lib/generators/terrazzo/views/templates/fields/number/FormField.jsx
 - lib/generators/terrazzo/views/templates/fields/number/IndexField.jsx
 - lib/generators/terrazzo/views/templates/fields/number/ShowField.jsx
@@ -248,6 +275,7 @@ files:
 - lib/generators/terrazzo/views/views_generator.rb
 - lib/terrazzo.rb
 - lib/terrazzo/base_dashboard.rb
+- lib/terrazzo/csv_export.rb
 - lib/terrazzo/engine.rb
 - lib/terrazzo/field/asset.rb
 - lib/terrazzo/field/associative.rb
@@ -287,10 +315,16 @@ files:
 - lib/terrazzo/uses_superglue.rb
 - lib/terrazzo/version.rb
 - terrazzo.gemspec
-homepage: https://github.com/gohypelab/terrazzo
+homepage: https://gohypelab.github.io/terrazzo/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://gohypelab.github.io/terrazzo/
+  source_code_uri: https://github.com/gohypelab/terrazzo
+  documentation_uri: https://gohypelab.github.io/terrazzo/getting-started
+  changelog_uri: https://github.com/gohypelab/terrazzo/releases
+  bug_tracker_uri: https://github.com/gohypelab/terrazzo/issues
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib

data/lib/generators/terrazzo/install/templates/application.json.props.erb

@@ -1,17 +0,0 @@
-json.data(search: request.path) do
-  yield
-end
-
-json.componentIdentifier local_assigns[:virtual_path_of_template]
-json.assets do
-  json.array! []
-end
-
-json.csrfToken form_authenticity_token
-json.restoreStrategy "fromCacheAndRevisitInBackground"
-
-json.flash do
-  flash.each do |type, message|
-    json.set!(type, message)
-  end
-end