mobility_uniqueness 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3dd8ef47b233d926aeeb738ea25c04dca1cb224447ba5345eab060bc28b2ed10
+  data.tar.gz: 03741c9831894edd706b383e706696d5fa070464d8c29c99aeecc1f4dd64c521
+SHA512:
+  metadata.gz: fc4928e9848303209517c4228e9f52dc46946bbce771aa1c975e548abf6b0404b0d58835346c83fffdd86dfde6b7b30ff8482f9099c0afa3d1c3b7e7e7571cc4
+  data.tar.gz: 86ee2f4453aad4980f65988e2f0e168b99a5976d3dad05f1f328122cdd580c2a452e190da82e1a2231bea17d41eed890e1b1b1e28ee1e885eb67ae7d1190738d

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 “egemen_ozturk”
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# Mobility Uniqueness
+
+Mobility Uniqueness is a Ruby gem that extends the [Mobility](https://github.com/shioyama/mobility) gem by enabling uniqueness validation on translated attributes across multiple locales. With this gem, you can validate the uniqueness of translations on attributes in ActiveRecord models, ensuring consistency and preventing duplicate entries in different languages. It's designed to work seamlessly with **Mobility's default :key_value backend**, integrating directly into your model validations.
+
+## Methods
+* `validates_uniqueness_of_translated(*args, message: 'custom message')` - Validates that the specified attributes are unique across all locales
+
+Default error message is _'violates uniqueness constraint'_ if the error message is not specified.
+
+## Usage
+
+### Basic Usage
+
+```rb
+class Book < ApplicationRecord
+  extend Mobility
+
+  translates :name, type: :string
+  translates :description, type: :text
+
+  validates_uniqueness_of_translated :name, :description
+end
+```
+
+### Custom Error Messages
+
+You can customize the error message for all:
+```rb
+class Book < ApplicationRecord
+  extend Mobility
+
+  translates :name, type: :string
+  translates :description, type: :text
+
+  validates_uniqueness_of_translated :name, :description, message: 'custom message'
+end
+```
+
+### Attribute-Specific Error Messages
+
+Specify different error messages per attribute for more granular feedback:
+```rb
+class Book < ApplicationRecord
+  extend Mobility
+
+  translates :name, type: :string
+  translates :description, type: :text
+
+  validates_uniqueness_of_translated :name, message: 'name is not unique'
+  validates_uniqueness_of_translated :description, message: 'description should be unique'
+end
+```
+
+## Purpose
+This gem was initially developed as a Rails concern but was later extracted into a standalone gem to support reuse across projects. Its purpose is to address the common requirement of enforcing uniqueness for multilingual content, especially when data is stored in different locales. By encapsulating this functionality in a gem, developers can easily enforce unique translations without having to implement custom validation logic repeatedly.
+
+As the Mobility gem maintainer stated in the issue comments that the gem has no support of validating uniqueness, so I went ahead and created this gem for all the developers who use mobility gem in their project.
+
+Below mobility issues were my main motivation to create this gem.
+
+* [Unique Validation didn't work with locale_accessors on every locales](https://github.com/shioyama/mobility/issues/603)
+
+* [Uniqueness validation does not work](https://github.com/shioyama/mobility/issues/20)
+
+# Summary
+
+This gem provides an easy way to add uniqueness validation to translated fields in ActiveRecord models that use the Mobility gem. It ensures that translations are unique across locales, improving data integrity in multilingual applications.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/egemen-dev/mobility_uniqueness.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/mobility_uniqueness/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MobilityUniqueness
+  VERSION = "0.1.0"
+end

data/lib/mobility_uniqueness.rb

@@ -0,0 +1,67 @@
+module MobilityUniqueness
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def validates_uniqueness_of_translated(*args)
+      return unless defined?(Mobility)
+
+      opitons = args.extract_options!
+
+      before_validation do
+        message = opitons[:message] || 'violates uniqueness constraint'
+
+        self.current_locales&.each do |locale|
+          args.each do |attr|
+            passed      = false
+            query_class = self.mobility_query_class(attr)
+
+            next unless query_class
+
+            records = query_class
+                        .where(locale: locale)
+                        .where(translatable_type: self.class.to_s)
+                        .where(key: attr, value: send(:"#{attr}_#{locale}"))
+
+            count = records.count
+
+            passed = if self.persisted?
+                        only_one_record = count <= 1
+                        belongs_to_self = count.zero? || id == records.first.translatable_id
+                        only_one_record && belongs_to_self
+                      else
+                        count.zero?
+                      end
+
+            self.errors.add(:"#{attr}_#{locale}", message) unless passed
+          end
+        end
+      end
+    end
+  end
+
+  def current_locales
+    locales = []
+
+    Mobility.available_locales.each do |locale|
+      locales << locale if self.send("language_code_#{locale}")&.present?
+    end
+
+    locales
+  end
+
+  def mobility_query_class(attr)
+    attr_type = self.class.attribute_types[attr&.to_s].type
+
+    translations = {
+      string: Mobility::Backends::ActiveRecord::KeyValue::StringTranslation,
+      text: Mobility::Backends::ActiveRecord::KeyValue::TextTranslation
+    }
+    
+    translations[attr_type]
+  end
+end
+
+# Automatically include the in all ActiveRecord models
+ActiveSupport.on_load(:active_record) do
+  include MobilityUniqueness
+end

data/sig/mobility_uniqueness.rbs

@@ -0,0 +1,4 @@
+module MobilityUniqueness
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: mobility_uniqueness
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- egemen öztürk
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-11-09 00:00:00.000000000 Z
+dependencies: []
+description: "    MobilityUniqueness extends the Mobility gem with locale-specific
+  uniqueness validation \n    for translated attributes in ActiveRecord models. It
+  allows you to ensure that a given attribute, \n    such as `name` in different locales,
+  is unique within the specified locale. \n\n    By using this validator, you can
+  enforce uniqueness for translations without needing to write \n    complex custom
+  validation code in your Rails models. The gem works seamlessly with Mobility’s \n
+  \   `KeyValue` backend to query translations and check for duplicates.\n"
+email:
+- egemenwasd@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mobility_uniqueness.rb
+- lib/mobility_uniqueness/version.rb
+- sig/mobility_uniqueness.rbs
+homepage: https://github.com/egemen-dev/mobility_uniqueness
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/egemen-dev/mobility_uniqueness
+  source_code_uri: https://github.com/egemen-dev/mobility_uniqueness
+  changelog_uri: https://github.com/egemen-dev/mobility_uniqueness
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key: 
+specification_version: 4
+summary: Adds locale-specific uniqueness validation for translated attributes in Mobility.
+test_files: []