wolf_core 1.0.68 → 1.0.70

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fd91295408ff2f54a66a3c894a46c34cbf8ba9c79d0c5d2604cfcef554e2ab0
-  data.tar.gz: 28a7c16e6a124fa97cc80b1a9b8decc9d4446c72d92eb4905e712f0921fec22c
+  metadata.gz: bc7e1aed79786c312930031227ec5cbd339d3415a22178ec0539f606f43abb89
+  data.tar.gz: 4e3245f77f19ad9d00b1eb11258e4c0828694938a06bf647f45988488b7f6158
 SHA512:
-  metadata.gz: 44b79a76c0b17651d393a7bd523acf3adf14dc93211d7d7a9eb32a6a38759f5041dfa0ea1620bf8e8b95e6392c97eefefdca1b3d2cdbdf2e54c99853f3c6272b
-  data.tar.gz: f6b3a6515df0d2868071cc483b47fa166459b2aeb31cfef5c9b50c0509c6fb9cbd41ae9f642c95bea550943bba9177ea055ca402db5c132cc7ad2a0c07ef090d
+  metadata.gz: 7e1a7e8f0020bc1e1a4b1ed6edb861680cb543167d431b76b47153bd8ee9e536fe4e5662a26728d8205a4f282d9c32b382c1f3704c3f8d267b9c7a286a5741f2
+  data.tar.gz: dc29ae8cf0eb87f0c3bede9f273bbfb924d5fbc66df9d935b28863d92f8638553541df92e1671602e86501c594af157cc698abe94006618b95972262653fb6d2

data/lib/wolf_core/utils/friendly_model_id.rb

@@ -1,4 +1,9 @@
-# In order to use this module on a model you only need to include it and implement the friendly_id_candidates method.
+# frozen_string_literal: true
+
+# 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:
 #
@@ -6,12 +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
@@ -19,50 +27,59 @@ module WolfCore
     include WolfCore::StringUtils
 
     included do
-      unless column_names.include?('friendly_id')
-        raise "Model #{self.name} does not have a friendly_id column"
-      end
+      raise "Model #{name} does not have a friendly_id column" unless column_names.include?("friendly_id")
 
       scope :by_friendly_id, ->(friendly_id) { where(friendly_id: friendly_id) }
-  
+
       before_save :set_friendly_id
     end
 
     def set_friendly_id
-      return if self.friendly_id.present?
+      return if friendly_id.present?
 
-      friendly_id_id_candidates.each do |candidate|
-        friendly_id = convert_candidate_to_friendly_id(candidate)
-        next if friendly_id.blank?
+      self.friendly_id = generate_friendly_id
+    end
 
-        friendly_id_used = self.class.where.not(id: self.id).find_by(friendly_id: friendly_id).present?
-        next if field_value_used
+    def generate_friendly_id
+      friendly_id = find_unique_friendly_id
+      return friendly_id if friendly_id.present?
 
-        self.friendly_id = friendly_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_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
+      nil
+    end
 
-      return if self.friendly_id.present?
+    def friendly_id_candidates
+      [:id]
+    end
 
-      default_candidate = Array(friendly_id_id_candidates.first) + [:id]
-      self.friendly_id = convert_candidate_to_friendly_id(default_candidate)
+    def friendly_id_candidates_array
+      Array(friendly_id_candidates)
     end
 
     def convert_candidate_to_friendly_id(candidate)
       candidate = Array(candidate)
-      candidate.map! { |field| field.to_sym }.uniq!
+      candidate.map!(&:to_sym).uniq!
       candidate.map do |field|
         field_value = send(field)
         parse_field_value(field_value)
-      end.join('-')
+      end.join("-")
     end
 
-    def parse_field_value(field_value)
-      field_value = to_kebab_case(field_value)
-      remove_non_alphanumeric_chars(field_value, exceptions: '-')
+    def friendly_id_used?(friendly_id)
+      self.class.where.not(id: id).find_by(friendly_id: friendly_id).present?
     end
 
-    def friendly_id_candidates
-      [:id]
+    def parse_field_value(field_value)
+      field_value = to_kebab_case(field_value)
+      remove_non_alphanumeric_chars(field_value, exceptions: "-")
     end
   end
-end
+end

data/lib/wolf_core/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WolfCore
-  VERSION = "1.0.68"
+  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.68
+  version: 1.0.70
 platform: ruby
 authors:
 - Javier Roncallo