plutonium 0.26.6 → 0.26.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13438498e4ed22a7e815bd5f850a48007b17418ae5bf9226c68c360bf41a6a9e
-  data.tar.gz: d23d68ced086dbb49c5777ef8ee4a206a1c29c1b6c12a5efcb068b5c0b8c4cc5
+  metadata.gz: 25a972b402c936a681cd59984869f8fa9fd08e6c5ad240578bc18c95c57cac45
+  data.tar.gz: ed73139eafd20795cb9a4be658c3f32a01c3546d51c37fd1f279eb9175697209
 SHA512:
-  metadata.gz: 95c11cf8731208462dc152b1f31161e578cfdcc276502853d57112cf4694b370c191e8fc3412beef8255deae9211491b3dbe8ef86f30492467936bdfa9213833
-  data.tar.gz: a0263fa147b67cc0435feba73311f0f1d7d54d5fd6d11379f5f3855113ff35e6ec3d67e24b941582925168f5115a1a1a18795690f931fdda5a626f6dd4b225fd
+  metadata.gz: c9fd52c2b932a4cc852935d03cfe3a3a3e00453d7a73aaeba698219fee78dcd354ea5a7f6443ef7c5273e401b6ad746fa50dec03ab469f178958f17231368f94
+  data.tar.gz: 81075c91ca822c5dd4b7f8866b6b75e4f1557aae08dc70af8096ed167141e02269749f5e57b920bb0036a9cb9c8ca58fb4b0f090f923aae252b431310a7842bc

data/docs/guide/deep-dive/resources.md

@@ -190,6 +190,9 @@ class BlogDefinition < Plutonium::Resource::Definition
   # Configure sorting
   sort :title
   sort :published_at
+  
+  # Configure default sorting (newest first)
+  default_sort :published_at, :desc
 end
 ```
 

data/docs/modules/query.md

@@ -43,6 +43,9 @@ class PostDefinition < Plutonium::Resource::Definition
   sort :title
   sort :created_at
   sort :view_count
+  
+  # Define default sort (when no sort params are provided)
+  default_sort :created_at, :desc  # or default_sort { |scope| scope.order(featured: :desc, created_at: :desc) }
 end
 ```
 
@@ -273,6 +276,13 @@ end
 - Consider performance impact of JOINs in search queries
 - Use `.distinct` when searching across associations
 
+### Default Sorting
+- Define a default sort to show newest items first by default: `default_sort :id, :desc`
+- Use field and direction: `default_sort :created_at, :desc`
+- Or use a block for complex sorting: `default_sort { |scope| scope.order(featured: :desc, created_at: :desc) }`
+- The default sort is only applied when no sort parameters are provided by the user
+- Child definitions inherit the default sort from parent definitions
+
 ### URL Structure
 - The `q` parameter namespace keeps query params organized
 - All filter inputs are nested under their filter name

data/docs/modules/table.md

@@ -31,6 +31,9 @@ class PostDefinition < Plutonium::Resource::Definition
   # Define sorting
   sort :title
   sort :published_at
+  
+  # Define default sort (newest first)
+  default_sort :created_at, :desc
 
   # Enable search
   search do |scope, query|
@@ -200,6 +203,11 @@ class PostDefinition < Plutonium::Resource::Definition
   sort :author_name, using: "users.name" do |scope, direction:|
     scope.joins(:author).order("users.name #{direction}")
   end
+  
+  # Default sort when no user sorting is applied
+  default_sort :created_at, :desc  # Simple form
+  # or with a block for complex sorting:
+  # default_sort { |scope| scope.order(featured: :desc, created_at: :desc) }
 end
 ```
 

data/lib/plutonium/definition/sorting.rb

@@ -6,9 +6,27 @@ module Plutonium
       included do
         defineable_props :sort
 
+        class_attribute :_default_sort, instance_writer: false, instance_predicate: false
+
         def self.sorts(*names)
           names.each { |name| sort name }
         end
+
+        def self.default_sort(field = nil, direction = :asc, &block)
+          self._default_sort = if block_given?
+            block
+          elsif field
+            [field, direction]
+          end
+          _default_sort
+        end
+
+        # Set a sensible default: newest items first
+        default_sort :id, :desc
+      end
+
+      def default_sort
+        self.class._default_sort
       end
     end
   end

data/lib/plutonium/resource/controllers/queryable.rb

@@ -25,6 +25,10 @@ module Plutonium
                 query_object.define_sorter key, value[:block], **value[:options]
               end
 
+              if current_definition.respond_to?(:default_sort) && current_definition.default_sort
+                query_object.default_sort_config = current_definition.default_sort
+              end
+
               current_definition.defined_filters.each do |key, value|
                 with = value[:options][:with]
                 if with.is_a?(Class) && with < Plutonium::Query::Filter

data/lib/plutonium/resource/query_object.rb

@@ -2,6 +2,7 @@ module Plutonium
   module Resource
     class QueryObject
       attr_reader :search_filter, :search_query
+      attr_accessor :default_sort_config
 
       # Initializes a QueryObject with the given resource_class and parameters.
       #
@@ -221,12 +222,20 @@ module Plutonium
       # @return [Object] The modified scope.
       def apply_sorts(scope, params)
         selected_sort_directions = extract_sort_directions(params)
-        selected_sort_fields.each do |name|
-          next unless (sorter = sort_definitions[name])
 
-          direction = selected_sort_directions[name] || "ASC"
-          scope = sorter.apply(scope, direction:)
+        if selected_sort_fields.any?
+          # Apply user-selected sorts
+          selected_sort_fields.each do |name|
+            next unless (sorter = sort_definitions[name])
+
+            direction = selected_sort_directions[name] || "ASC"
+            scope = sorter.apply(scope, direction:)
+          end
+        elsif default_sort_config
+          # Apply default sort when no sorts are selected
+          scope = apply_default_sort(scope)
         end
+
         scope
       end
 
@@ -250,6 +259,24 @@ module Plutonium
           end
         end.compact
       end
+
+      # Applies the default sort to the given scope
+      #
+      # @param scope [Object] The initial scope
+      # @return [Object] The sorted scope
+      def apply_default_sort(scope)
+        case default_sort_config
+        when Proc
+          # Block form: default_sort { |scope| scope.order(...) }
+          default_sort_config.call(scope)
+        when Array
+          # Field/direction form: default_sort :created_at, :desc
+          field, direction = default_sort_config
+          scope.order(field => direction)
+        else
+          scope
+        end
+      end
     end
   end
 end

data/lib/plutonium/version.rb

@@ -1,5 +1,5 @@
 module Plutonium
-  VERSION = "0.26.6"
+  VERSION = "0.26.7"
   NEXT_MAJOR_VERSION = VERSION.split(".").tap { |v|
     v[1] = v[1].to_i + 1
     v[2] = 0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plutonium
 version: !ruby/object:Gem::Version
-  version: 0.26.6
+  version: 0.26.7
 platform: ruby
 authors:
 - Stefan Froelich