awesome_model_translations 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d685fdb24edf2a610296eeaed9b1451d77a3c740a5e795f34349aa26fb08e5b5
+  data.tar.gz: bd45b672348ca62bf79685c9d61dcc0f4714cf40ef6f2aa47f2360c5deb7de26
+SHA512:
+  metadata.gz: 4a624e297b2322973cee6abdeda2235bb725d2f96436d6210cc5a75d59e58b4759b30e5bac8bbcc18ae445e2f0279486317282ada8dd42ac0965b778a913b984
+  data.tar.gz: 1ff917307cc959031d9a57d62fade905cccc2fea0979be8a5a98408de6c0ea429b366fe21a43719c13ecb539237ab0f93a39bc66f4c59265840652e5ebd893c9

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 kaspernj
+
+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,51 @@
+# AwesomeModelTranslations
+Short description and motivation.
+
+## Usage
+
+Add a translated attribute to your model:
+```ruby
+class Project < ApplicationRecord
+  translates :name
+end
+```
+
+You can set the name in the current locale like this:
+```ruby
+I18n.locale = :en
+project.name = "English name"
+project.name #=> "English name"
+```
+
+Or set the name for a specific locale like this:
+```ruby
+I18n.locale = :en
+project.name_da = "Dansk navn"
+project.name #=> "Dansk navn"
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "awesome_model_translations"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install awesome_model_translations
+```
+
+Install the migrations and run them:
+```bash
+rake railties:install:migrations
+rails db:migrate
+```
+
+## 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,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/awesome_model_translations_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/awesome_model_translations .css

data/app/assets/stylesheets/awesome_model_translations/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/awesome_model_translations/application_controller.rb

@@ -0,0 +1,2 @@
+class AwesomeModelTranslations::ApplicationController < ActionController::Base
+end

data/app/helpers/awesome_model_translations/application_helper.rb

@@ -0,0 +1,2 @@
+module AwesomeModelTranslations::ApplicationHelper
+end

data/app/jobs/awesome_model_translations/application_job.rb

@@ -0,0 +1,2 @@
+class AwesomeModelTranslations::ApplicationJob < ActiveJob::Base
+end

data/app/mailers/awesome_model_translations/application_mailer.rb

@@ -0,0 +1,4 @@
+class AwesomeModelTranslations::ApplicationMailer < ActionMailer::Base
+  default from: "from@example.com"
+  layout "mailer"
+end

data/app/models/awesome_model_translations/application_record.rb

@@ -0,0 +1,3 @@
+class AwesomeModelTranslations::ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/app/models/awesome_model_translations/slug.rb

@@ -0,0 +1,7 @@
+class AwesomeModelTranslations::Slug < AwesomeModelTranslations::ApplicationRecord
+  self.table_name = "slugs"
+
+  belongs_to :sluggable, polymorphic: true
+
+  validates :slug, presence: true
+end

data/app/views/layouts/awesome_model_translations/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Awesome model translations</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "awesome_model_translations/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+AwesomeModelTranslations::Engine.routes.draw do # rubocop:disable Lint/EmptyBlock
+end

data/db/migrate/20231216092051_create_slugs.rb

@@ -0,0 +1,16 @@
+class CreateSlugs < ActiveRecord::Migration[7.0]
+  def change
+    create_table :slugs do |t|
+      t.string "slug", null: false
+      t.string "scope"
+      t.datetime "created_at"
+      t.string "locale", null: false
+      t.references :sluggable, null: false, polymorphic: true
+      t.index ["locale"], name: "index_slugs_on_locale"
+      t.index ["slug", "sluggable_type", "locale"], name: "index_slugs_on_slug_and_sluggable_type_and_locale"
+      t.index ["slug", "sluggable_type", "scope", "locale"], name: "index_slugs_uniqueness", unique: true
+      t.index ["sluggable_id"], name: "index_slugs_on_sluggable_id"
+      t.index ["sluggable_type"], name: "index_slugs_on_sluggable_type"
+    end
+  end
+end

data/lib/awesome_model_translations/current_translation_scope.rb

@@ -0,0 +1,27 @@
+module AwesomeModelTranslations::CurrentTranslationScope
+  def self.included(base)
+    translation_class_name = "#{base.name}::Translation"
+    translation_class = translation_class_name.constantize
+    table_name = translation_class.table_name
+    foreign_key_name = base.reflections["translations"].foreign_key
+
+    scope_proc = proc do
+      locales_list = I18n.available_locales.join("', '")
+      sub_query_sql = "#{table_name}.#{translation_class.primary_key} = (" \
+                      "SELECT #{table_name}.#{translation_class.primary_key} " \
+                      "FROM #{table_name} " \
+                      "WHERE #{table_name}.#{foreign_key_name} = #{base.table_name}.#{base.primary_key} AND " \
+                      "#{table_name}.locale IN ('#{locales_list}') " \
+                      "ORDER BY " \
+                      "CASE WHEN #{table_name}.locale = '#{I18n.locale}' THEN 1 " \
+                      "ELSE 2 " \
+                      "END " \
+                      "LIMIT 1" \
+                      ")"
+
+      where(sub_query_sql)
+    end
+
+    base.has_one :current_translation, scope_proc, class_name: translation_class_name
+  end
+end

data/lib/awesome_model_translations/engine.rb

@@ -0,0 +1,3 @@
+class AwesomeModelTranslations::Engine < Rails::Engine
+  isolate_namespace AwesomeModelTranslations
+end

data/lib/awesome_model_translations/model_extensions.rb

@@ -0,0 +1,131 @@
+module AwesomeModelTranslations::ModelExtensions
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def translates(*attributes) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+      translations_class_name = "#{name}::Translation"
+      translations_table_name = "#{table_name.singularize}_translations"
+
+      translation_model_class = Class.new(AwesomeModelTranslations::Translation) do
+        self.table_name = translations_table_name
+      end
+
+      translation_model_class.define_singleton_method(:name) do
+        translations_class_name
+      end
+
+      define_singleton_method(:translated_attribute_names) do
+        attributes
+      end
+
+      translation_model_class.belongs_to :globalized_model, class_name: model_name.name, foreign_key: "#{model_name.element}_id", inverse_of: :translations,
+        optional: true
+
+      const_set(:Translation, translation_model_class)
+
+      has_many :translations, autosave: true, class_name: translations_class_name, dependent: :destroy, inverse_of: :globalized_model
+
+      define_method(:attributes) do |*args, &blk|
+        original_attributes = super(*args, &blk).clone
+        translated_attributes = {}
+
+        self.class.translated_attribute_names.each do |translated_attribute_name|
+          original_attributes.delete(translated_attribute_name.to_s)
+        end
+
+        association(:translations).target.each do |translation|
+          self.class.translated_attribute_names.each do |translated_attribute_name|
+            if translation.attributes.key?(translated_attribute_name.to_s)
+              translated_attributes["#{translated_attribute_name}_#{translation.locale}"] = translation.attributes.fetch(translated_attribute_name.to_s)
+            end
+          end
+        end
+
+        original_attributes.merge(translated_attributes)
+      end
+
+      define_method(:changed?) do |*args, &blk|
+        super(*args, &blk) || translations.target.any?(&:changed?)
+      end
+
+      define_method(:changes) do |*args, &blk|
+        original_changes = super(*args, &blk).clone
+        translated_changes = {}
+
+        self.class.translated_attribute_names.each do |translated_attribute_name|
+          original_changes.delete(translated_attribute_name.to_s)
+        end
+
+        association(:translations).target.each do |translation|
+          self.class.translated_attribute_names.each do |translated_attribute_name|
+            if translation.changes.key?(translated_attribute_name.to_s)
+              translated_changes["#{translated_attribute_name}_#{translation.locale}"] = translation.changes.fetch(translated_attribute_name.to_s)
+            end
+          end
+        end
+
+        original_changes.merge(translated_changes)
+      end
+
+      define_method(:saved_changes) do |*args, &blk|
+        original_saved_changes = super(*args, &blk).clone
+        translated_saved_changes = {}
+
+        self.class.translated_attribute_names.each do |translated_attribute_name|
+          original_saved_changes.delete(translated_attribute_name.to_s)
+        end
+
+        association(:translations).target.each do |translation|
+          self.class.translated_attribute_names.each do |translated_attribute_name|
+            if translation.saved_changes.key?(translated_attribute_name.to_s)
+              translated_saved_changes["#{translated_attribute_name}_#{translation.locale}"] = translation.saved_changes.fetch(translated_attribute_name.to_s)
+            end
+          end
+        end
+
+        original_saved_changes.merge(translated_saved_changes)
+      end
+
+      attributes.each do |attribute_name|
+        attribute attribute_name.to_sym
+
+        define_method(attribute_name) do
+          fallbacks = I18n.fallbacks[I18n.locale]
+          value = nil
+
+          fallbacks&.each do |locale|
+            value = __send__(:"#{attribute_name}_#{locale}")
+
+            break if value.present?
+          end
+
+          value
+        end
+
+        define_method(:"#{attribute_name}=") do |new_value|
+          __send__(:"#{attribute_name}_#{I18n.locale}=", new_value)
+        end
+
+        I18n.available_locales.each do |locale|
+          current_locale = locale.to_s
+
+          define_method(:"#{attribute_name}_#{locale}") do
+            translations.detect { |translation| translation.locale == current_locale }&.__send__(attribute_name)
+          end
+
+          define_method(:"#{attribute_name}_#{locale}=") do |new_value|
+            translation = translations.detect { |translation_i| translation_i.locale == current_locale }
+            translation ||= translations.build(locale: current_locale)
+            old_value = translation.__send__(attribute_name)
+            translation.assign_attributes(attribute_name => new_value)
+            __send__(:attribute_will_change!, attribute_name) if old_value != new_value
+          end
+        end
+      end
+
+      include AwesomeModelTranslations::CurrentTranslationScope
+    end
+  end
+end

data/lib/awesome_model_translations/sluggable.rb

@@ -0,0 +1,80 @@
+module AwesomeModelTranslations::Sluggable
+  def self.included(base)
+    base.extend ClassMethods
+    base.has_many :slugs, as: :sluggable, class_name: "AwesomeModelTranslations::Slug", dependent: :destroy
+    base.after_save :__set_slug
+
+    base.scope :where_current_slug, lambda { |slug|
+      joins(:slugs)
+        .where(slugs: {locale: I18n.locale}).where("slugs.slug = :slug OR #{table_name}.id = :slug", slug:)
+    }
+  end
+
+  module ClassMethods
+    def find_by_sluggable!(param)
+      return find(param) if UuidTester.uuid?(param)
+
+      locales = I18n.fallbacks[I18n.locale]&.map(&:to_s) || [I18n.locale.to_]
+      slugs = AwesomeModelTranslations::Slug
+        .select(:locale, :sluggable_id, :sluggable_type)
+        .where(
+          slug: param,
+          sluggable_type: name
+        )
+        .to_a
+
+      locales.each do |locale|
+        slug_with_locale = slugs.find { |slug| slug.locale == locale }
+
+        return slug_with_locale.sluggable if slug_with_locale
+      end
+
+      raise ActiveRecord::RecordNotFound, "No #{name} found with that slug: #{param}"
+    end
+  end
+
+  def __current_slug
+    locales = I18n.fallbacks[I18n.locale].map(&:to_s) || [I18n.locale.to_s]
+    slugs_to_check = slugs.to_a.sort_by(&:created_at).reverse
+
+    locales.each do |locale|
+      slug_with_locale = slugs_to_check.find { |slug| slug.locale == locale }
+
+      return slug_with_locale.slug if slug_with_locale
+    end
+
+    id
+  end
+
+  def __generate_slug
+    name_for_slug = if respond_to?(:sluggable_slug, true) && sluggable_slug.present?
+      sluggable_slug
+    elsif name.present?
+      name
+    end
+
+    return nil if name_for_slug.blank?
+
+    name_for_slug.downcase.gsub(/(\s+|\/)/, "-")
+  end
+
+  def __set_slug
+    I18n.available_locales.each do |locale|
+      I18n.with_locale(locale) do
+        slug = __generate_slug
+
+        next if slug.blank?
+
+        slugs.find_or_create_by!(locale:, slug:)
+      end
+    end
+  end
+
+  def slug
+    __current_slug
+  end
+
+  def to_param
+    __current_slug
+  end
+end

data/lib/awesome_model_translations/translation.rb

@@ -0,0 +1,3 @@
+class AwesomeModelTranslations::Translation < AwesomeModelTranslations::ApplicationRecord
+  self.abstract_class = true
+end

data/lib/awesome_model_translations/version.rb

@@ -0,0 +1,3 @@
+module AwesomeModelTranslations
+  VERSION = "0.1.0".freeze
+end

data/lib/awesome_model_translations.rb

@@ -0,0 +1,9 @@
+require "awesome_model_translations/version"
+require "awesome_model_translations/engine"
+
+module AwesomeModelTranslations
+  autoload :CurrentTranslationScope, "#{__dir__}/awesome_model_translations/current_translation_scope"
+  autoload :ModelExtensions, "#{__dir__}/awesome_model_translations/model_extensions"
+  autoload :Sluggable, "#{__dir__}/awesome_model_translations/sluggable"
+  autoload :Translation, "#{__dir__}/awesome_model_translations/translation"
+end

data/lib/tasks/awesome_model_translations_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :awesome_model_translations do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: awesome_model_translations
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kaspernj
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+description: Model translations for ActiveRecord.
+email:
+- kasper@diestoeckels.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/awesome_model_translations_manifest.js
+- app/assets/stylesheets/awesome_model_translations/application.css
+- app/controllers/awesome_model_translations/application_controller.rb
+- app/helpers/awesome_model_translations/application_helper.rb
+- app/jobs/awesome_model_translations/application_job.rb
+- app/mailers/awesome_model_translations/application_mailer.rb
+- app/models/awesome_model_translations/application_record.rb
+- app/models/awesome_model_translations/slug.rb
+- app/views/layouts/awesome_model_translations/application.html.erb
+- config/routes.rb
+- db/migrate/20231216092051_create_slugs.rb
+- lib/awesome_model_translations.rb
+- lib/awesome_model_translations/current_translation_scope.rb
+- lib/awesome_model_translations/engine.rb
+- lib/awesome_model_translations/model_extensions.rb
+- lib/awesome_model_translations/sluggable.rb
+- lib/awesome_model_translations/translation.rb
+- lib/awesome_model_translations/version.rb
+- lib/tasks/awesome_model_translations_tasks.rake
+homepage: https://github.com/kaspernj/awesome_model_translations
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kaspernj/awesome_model_translations
+  source_code_uri: https://github.com/kaspernj/awesome_model_translations
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.5
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Model translations for ActiveRecord.
+test_files: []