wolf_core 1.0.66 → 1.0.68

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebc787c1df3765c741ea7eadaae3f24acaae3318a982266c1d421c8147ff6e92
-  data.tar.gz: 1b521b606a8ef09504d4444c6b3c6ae65f9504177a55c99a2b9945f3965838f5
+  metadata.gz: 1fd91295408ff2f54a66a3c894a46c34cbf8ba9c79d0c5d2604cfcef554e2ab0
+  data.tar.gz: 28a7c16e6a124fa97cc80b1a9b8decc9d4446c72d92eb4905e712f0921fec22c
 SHA512:
-  metadata.gz: 5ad0b112786b8f29b5b2eb3798f9128a573594f684393b915804767be41dd75b008f57cc688f3a254f129e29864dc2bde41b823c9c02f86f80b2d0f6df47c19c
-  data.tar.gz: 8506ca870e4fee626223ad32222c3fa4874496f7291ed4d2675b654d51d50f427db371593d7fe616e31b849a7bf3394b3791c288c7cc6ebc9b773803e3cb56ad
+  metadata.gz: 44b79a76c0b17651d393a7bd523acf3adf14dc93211d7d7a9eb32a6a38759f5041dfa0ea1620bf8e8b95e6392c97eefefdca1b3d2cdbdf2e54c99853f3c6272b
+  data.tar.gz: f6b3a6515df0d2868071cc483b47fa166459b2aeb31cfef5c9b50c0509c6fb9cbd41ae9f642c95bea550943bba9177ea055ca402db5c132cc7ad2a0c07ef090d

data/lib/wolf_core/utils/friendly_model_id.rb

@@ -0,0 +1,68 @@
+# In order to use this module on a model you only need to include it and implement the friendly_id_candidates method.
+#
+# Example:
+#
+# class MyModel < ApplicationRecord
+#   include WolfCore::FriendlyModelId
+#
+#   def friendly_id_candidates
+#     [[:name], [:name, :id]]
+#   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
+
+module WolfCore
+  module FriendlyModelId
+    extend ActiveSupport::Concern
+    include WolfCore::StringUtils
+
+    included do
+      unless column_names.include?('friendly_id')
+        raise "Model #{self.name} does not have a friendly_id column"
+      end
+
+      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?
+
+      friendly_id_id_candidates.each do |candidate|
+        friendly_id = convert_candidate_to_friendly_id(candidate)
+        next if friendly_id.blank?
+
+        friendly_id_used = self.class.where.not(id: self.id).find_by(friendly_id: friendly_id).present?
+        next if field_value_used
+
+        self.friendly_id = friendly_id
+      end
+
+      return if self.friendly_id.present?
+
+      default_candidate = Array(friendly_id_id_candidates.first) + [:id]
+      self.friendly_id = convert_candidate_to_friendly_id(default_candidate)
+    end
+
+    def convert_candidate_to_friendly_id(candidate)
+      candidate = Array(candidate)
+      candidate.map! { |field| field.to_sym }.uniq!
+      candidate.map do |field|
+        field_value = send(field)
+        parse_field_value(field_value)
+      end.join('-')
+    end
+
+    def parse_field_value(field_value)
+      field_value = to_kebab_case(field_value)
+      remove_non_alphanumeric_chars(field_value, exceptions: '-')
+    end
+
+    def friendly_id_candidates
+      [:id]
+    end
+  end
+end

data/lib/wolf_core/utils/string_utils.rb

@@ -5,6 +5,22 @@ module WolfCore
       str.gsub(/([A-Z])/, ' \1').strip.downcase.capitalize
     end
 
+    def to_snake_case(str)
+      str.gsub(/\s+/, '_').downcase
+    end
+
+    def to_kebab_case(str)
+      str.gsub(/\s+/, '-').downcase
+    end
+
+    def remove_non_alphanumeric_chars(str, exceptions: nil)
+      exceptions ||= []
+      exceptions = Array(exceptions)
+      escaped_exceptions = exceptions.map { |char| Regexp.escape(char) }.join
+      regex = /[^a-zA-Z0-9#{escaped_exceptions}]/
+      str.gsub(regex, '')
+    end
+
     def clean_phone_number(phone)
       return if phone.nil?
       cleaned_phone = phone.to_s.gsub(/\D/, '')
@@ -46,11 +62,5 @@ module WolfCore
       base64_regex = /^[A-Za-z0-9+\/]+={0,2}$/
       str.match?(base64_regex)
     end
-
-    def to_snake_case(str)
-      str.gsub(/[^a-zA-Z0-9\s_]/, '')
-         .gsub(/\s+/, '_')
-         .downcase
-    end
   end
 end

data/lib/wolf_core/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wolf_core
 version: !ruby/object:Gem::Version
-  version: 1.0.66
+  version: 1.0.68
 platform: ruby
 authors:
 - Javier Roncallo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-24 00:00:00.000000000 Z
+date: 2025-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -130,6 +130,7 @@ files:
 - lib/wolf_core/utils/array_utils.rb
 - lib/wolf_core/utils/async_utils.rb
 - lib/wolf_core/utils/file_utils.rb
+- lib/wolf_core/utils/friendly_model_id.rb
 - lib/wolf_core/utils/logging_utils.rb
 - lib/wolf_core/utils/result.rb
 - lib/wolf_core/utils/string_utils.rb