sort_param 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78cff5e96b34b0697aa50227db7186cbbbaac54290cdaf88ff6201ae35afda6e
-  data.tar.gz: 025b26afa452522750032d2be80f83dca0c0343ff00416e2a6d2299e47680980
+  metadata.gz: fb0d8250b0a318bf85f2031f497b703e044387bb9b0ce53588a7bd8aefe42cc1
+  data.tar.gz: e48ff69e8d9f9d1eeb188222abceb7368b1fc928bf36e52b6f9822321b854782
 SHA512:
-  metadata.gz: 8c191c86a31f9a9c300ab3064d3b44b9be8f273fc4578de139482f7434bb07b5c69d44ef12077b262a2832757450f7ded50ced460e501cf602328a29e6e2d2ad
-  data.tar.gz: 788302acfbcf086d426fe2adebb1c5ee59aa85ece7e5e78e956e6ea81987b04efef002ed052d7b0615736648b17552a46c7a5d85c44e94a2f0d6f416ebf4b94e
+  metadata.gz: e99bca609530200771778839f406bf270d2fa4a11041f9f44f095f2d6e81882fbf7f814e1a14699aa7b194ed6fa907eb69cb804824c85f5bcf4c3f85ca34ed65
+  data.tar.gz: 884b4a6af691fb6782c9b9f4db453d5e7f904e9b4ddf309c3e07999a51e136eae363acb5dbd2c60368ed315f17e707eacd8d2aa2c21f1bc8ad85dc91e4fa5765

data/CHANGELOG.md

@@ -6,3 +6,6 @@
 
 ## [1.0.0]
 - Rename :formatted_name option to :rename
+
+## [1.1.0]
+- Introduce definition#load to silently ignore non-whitelisted sort fields

data/README.md

@@ -124,7 +124,18 @@ sort_param.load!("+first_name:nulls_last,-last_name:nulls_first", mode: :pg)
 
 => "first_name asc nulls last, last_name desc nulls first"
 ```
-<br/>
+
+### Ignoring non-whitelisted sort fields instead of raising error
+Use `#load` method instead:
+
+```ruby
+  sort_param = SortParam.define do
+    field :first_name
+  end
+
+  sort_param.load("+first_name,+last_name", mode: :pg)
+  => "first_name asc"
+```
 
 ### Render a different field name in the output
 Set the `:rename` field option to output a different field name:
@@ -207,7 +218,7 @@ end
 
 | Class | Description |
 | ----------- | ----------- |
-| `SortParam::UnsupportedSortField` | Raised when a sort field from the parameter isn't included in the whitelisted sort fields. |
+| `SortParam::UnsupportedSortField` | Raised when loading sort string via `#load!` and a sort field from the parameter isn't included in the whitelisted sort fields. |
 
 ## Development
 

data/lib/sort_param/definition.rb

@@ -49,6 +49,20 @@ module SortParam
       @fields_hash[name].dup
     end
 
+    # Parse then translate a sort string expression and raise an error if the sort string includes
+    # a non-whitelisted sort field.
+    #
+    # @see #load
+    #
+    # @raise [SortParam::UnsupportedSortField] if :sort_string includes a non-whitelisted sort field.
+    #
+    def load!(sort_string, mode: :hash)
+      fields = Fields.new(sort_string)
+      validate_fields!(fields)
+
+      format_fields(mode, fields)
+    end
+
     # Parse then translate a sort string expression
     #
     # @param sort_string [String] Sort expression. Comma-separated sort fields.
@@ -71,18 +85,27 @@ module SortParam
     # @return [Hash, String, NilClass] Translated to SQL or Hash.
     #   Returns nil if there is no column to sort.
     #
-    def load!(sort_string, mode: :hash)
+    def load(sort_string, mode: :hash)
       fields = Fields.new(sort_string)
-      validate_fields!(fields)
+      fields = fields.reject { |field| non_whitelisted_fields(fields).include?(field.name) }
 
-      formatter = Formatters::Formatter.for(mode)
-      formatter.new(self).format(*fields)
+      format_fields(mode, fields)
     end
 
     private
 
-    def validate_fields!(fields)
-      unknown_field = (fields.names - fields_hash.keys).first
+    def format_fields(mode, fields)
+      Formatters::Formatter.for(mode)
+                           .new(self)
+                           .format(*fields)
+    end
+
+    def non_whitelisted_fields(loaded_fields)
+      loaded_fields.names - fields_hash.keys
+    end
+
+    def validate_fields!(loaded_fields)
+      unknown_field = non_whitelisted_fields(loaded_fields).first
       return true if unknown_field.nil?
 
       raise SortParam::UnsupportedSortField.new("Unsupported sort field: #{unknown_field}")

data/lib/sort_param/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SortParam
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sort_param
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Uy Jayson B
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-14 00:00:00.000000000 Z
+date: 2023-06-20 00:00:00.000000000 Z
 dependencies: []
 description: Sort records using a sort query parameter à la JSON-API style
 email: