sort_param 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c05d893490a180c3cb1ce696d8fbddf77f9e7a0f323434c755408f54f239c427
-  data.tar.gz: 672ae31570afece8e8a18c504f7bbe47390d83c8e7485934edb473ace88e11db
+  metadata.gz: 78cff5e96b34b0697aa50227db7186cbbbaac54290cdaf88ff6201ae35afda6e
+  data.tar.gz: 025b26afa452522750032d2be80f83dca0c0343ff00416e2a6d2299e47680980
 SHA512:
-  metadata.gz: 0dbaff8fc1c00aa5903ab1e75576b6af6d99ba37a3d90d41d8a2ef1ed4928d183a278d31552924aa94ba2aa0b395639d176a477cc50a0ed9379e61cc069c2ddb
-  data.tar.gz: fe8ca1f676f8f4ff66a5e3a9395457218725eb440b37f1ee253752a5f77a1ae761e79136521735c0b291f92f54e6e3c02ec6e7416d3baa1a79840498c3e78c85
+  metadata.gz: 8c191c86a31f9a9c300ab3064d3b44b9be8f273fc4578de139482f7434bb07b5c69d44ef12077b262a2832757450f7ded50ced460e501cf602328a29e6e2d2ad
+  data.tar.gz: 788302acfbcf086d426fe2adebb1c5ee59aa85ece7e5e78e956e6ea81987b04efef002ed052d7b0615736648b17552a46c7a5d85c44e94a2f0d6f416ebf4b94e

data/CHANGELOG.md

@@ -4,3 +4,5 @@
 ## [0.2.0]
 - Support setting a different field name in the formatted output
 
+## [1.0.0]
+- Rename :formatted_name option to :rename

data/README.md

@@ -126,6 +126,26 @@ sort_param.load!("+first_name:nulls_last,-last_name:nulls_first", mode: :pg)
 ```
 <br/>
 
+### 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
 
 ```ruby

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 = {})

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.0.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.0.0
 platform: ruby
 authors:
 - Uy Jayson B
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-13 00:00:00.000000000 Z
+date: 2023-06-14 00:00:00.000000000 Z
 dependencies: []
 description: Sort records using a sort query parameter à la JSON-API style
 email: