sort_param 0.2.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c05d893490a180c3cb1ce696d8fbddf77f9e7a0f323434c755408f54f239c427
-  data.tar.gz: 672ae31570afece8e8a18c504f7bbe47390d83c8e7485934edb473ace88e11db
+  metadata.gz: fb0d8250b0a318bf85f2031f497b703e044387bb9b0ce53588a7bd8aefe42cc1
+  data.tar.gz: e48ff69e8d9f9d1eeb188222abceb7368b1fc928bf36e52b6f9822321b854782
 SHA512:
-  metadata.gz: 0dbaff8fc1c00aa5903ab1e75576b6af6d99ba37a3d90d41d8a2ef1ed4928d183a278d31552924aa94ba2aa0b395639d176a477cc50a0ed9379e61cc069c2ddb
-  data.tar.gz: fe8ca1f676f8f4ff66a5e3a9395457218725eb440b37f1ee253752a5f77a1ae761e79136521735c0b291f92f54e6e3c02ec6e7416d3baa1a79840498c3e78c85
+  metadata.gz: e99bca609530200771778839f406bf270d2fa4a11041f9f44f095f2d6e81882fbf7f814e1a14699aa7b194ed6fa907eb69cb804824c85f5bcf4c3f85ca34ed65
+  data.tar.gz: 884b4a6af691fb6782c9b9f4db453d5e7f904e9b4ddf309c3e07999a51e136eae363acb5dbd2c60368ed315f17e707eacd8d2aa2c21f1bc8ad85dc91e4fa5765

data/CHANGELOG.md

@@ -4,3 +4,8 @@
 ## [0.2.0]
 - Support setting a different field name in the formatted output
 
+## [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,6 +124,37 @@ sort_param.load!("+first_name:nulls_last,-last_name:nulls_first", mode: :pg)
 
 => "first_name asc nulls last, last_name desc nulls first"
 ```
+
+### 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:
+
+```ruby
+  sort_param = SortParam.define do
+    field :first_name, rename: 'users.name'
+  end
+  
+  sort_param.load!("+first_name", mode: :pg)
+  => "users.name asc"
+  
+  sort_param.load!("+first_name", mode: :mysql)
+  => "users.name asc"
+  
+  sort_param.load!("+first_name")
+  => {"users.name"=>{:direction=>:asc}}
+```
+
 <br/>
 
 ### Rails example
@@ -187,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

@@ -26,7 +26,7 @@ module SortParam
     # @param name [String, Symbol] column name
     # @param defaults [Hash] column default options:
     #   * nulls (Symbol) nulls sort order. `:last` or `:first`
-    #   * formatted_name (String) field name in formatted output
+    #   * rename (String) field name in formatted output
     #
     # @return [self] Definition instance
     def field(name, defaults = {})
@@ -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/formatters/formatter.rb

@@ -38,7 +38,7 @@ module SortParam
       end
 
       def formatted_field_name(field)
-        formatted_name = definition.field_defaults(field.name)[:formatted_name]
+        formatted_name = definition.field_defaults(field.name)[:rename]
 
         blank?(formatted_name) ? field.name : formatted_name
       end

data/lib/sort_param/formatters/hash.rb

@@ -18,7 +18,7 @@ module SortParam
         data = definition.field_defaults(field.name) || {}
         data.merge!(direction: field.direction)
         data.merge!(nulls: field.nulls) unless field.nulls.nil?
-        data.delete(:formatted_name)
+        data.delete(:rename)
         data
       end
     end

data/lib/sort_param/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sort_param
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Uy Jayson B
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-13 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: