wolf_core 1.0.69 → 1.0.70

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d5fa238459aefb14f513bd81c063aff7227a31f27ff2b3d56fbc98b4cfcd38b
-  data.tar.gz: ec08c21d261cde65e3107cde28b3d297d797ee27724df5996b5aea23e43b4755
+  metadata.gz: bc7e1aed79786c312930031227ec5cbd339d3415a22178ec0539f606f43abb89
+  data.tar.gz: 4e3245f77f19ad9d00b1eb11258e4c0828694938a06bf647f45988488b7f6158
 SHA512:
-  metadata.gz: 7a5f7d94c752f04cef2bd762cfef9ba6ae77ff3c57e5d0913fbce580fa8f88a18e29c2c40cb6c287540cfa193fa95b4ef42335824050390fc52f9c1585ed9d64
-  data.tar.gz: cf5ad9f109e43bbb6beac1f24eaba663515a83f0c955a949c29469067c433c6637c870dc35c7a1c9e89d42bd8bbddae61ad90099503e11e403939b45b0791ce3
+  metadata.gz: 7e1a7e8f0020bc1e1a4b1ed6edb861680cb543167d431b76b47153bd8ee9e536fe4e5662a26728d8205a4f282d9c32b382c1f3704c3f8d267b9c7a286a5741f2
+  data.tar.gz: dc29ae8cf0eb87f0c3bede9f273bbfb924d5fbc66df9d935b28863d92f8638553541df92e1671602e86501c594af157cc698abe94006618b95972262653fb6d2

data/lib/wolf_core/utils/friendly_model_id.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
-# In order to use this module on a model you only need to include it and implement the friendly_id_candidates method.
+# Steps to use this module:
+# 1. Create a migration to add the friendly_id column to your model.
+# 2. Include the WolfCore::FriendlyModelId in your model.
+# 3. Implement the friendly_id_candidates method in your model.
 #
 # Example:
 #
@@ -8,13 +11,15 @@
 #   include WolfCore::FriendlyModelId
 #
 #   def friendly_id_candidates
-#     [[:name], [:name, :id]]
+#     [:fullname, :address]
 #   end
 # end
-# This will generate a friendly_id based on the name field.
-# If it is not unique it will append the id to the friendly_id.
 #
-# You can also override the set_friendly_id method to customize the friendly_id generation
+# This will generate a friendly_id based on the fullname field.
+# If the fullname is not unique, it will attempt to use the address field instead.
+# If neither can be used to generate a unique friendly_id, it will append the id to
+# the value of the first field name in the array returned by the friendly_id_candidates
+# method, which is fullname in this case.
 
 module WolfCore
   module FriendlyModelId
@@ -39,12 +44,12 @@ module WolfCore
       friendly_id = find_unique_friendly_id
       return friendly_id if friendly_id.present?
 
-      default_candidate = Array(friendly_id_candidates.first) + [:id]
+      default_candidate = friendly_id_candidates_array.first + [:id]
       convert_candidate_to_friendly_id(default_candidate)
     end
 
     def find_unique_friendly_id
-      friendly_id_candidates.each do |candidate|
+      friendly_id_candidates_array.each do |candidate|
         friendly_id = convert_candidate_to_friendly_id(candidate)
         return friendly_id if friendly_id.present? && !friendly_id_used?(friendly_id)
       end
@@ -55,6 +60,10 @@ module WolfCore
       [:id]
     end
 
+    def friendly_id_candidates_array
+      Array(friendly_id_candidates)
+    end
+
     def convert_candidate_to_friendly_id(candidate)
       candidate = Array(candidate)
       candidate.map!(&:to_sym).uniq!

data/lib/wolf_core/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WolfCore
-  VERSION = "1.0.69"
+  VERSION = "1.0.70"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wolf_core
 version: !ruby/object:Gem::Version
-  version: 1.0.69
+  version: 1.0.70
 platform: ruby
 authors:
 - Javier Roncallo