internationalize 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f85c4969fc4c969bf8ad61c4cbdb76a5364c90b4c7853a446aaeb6a4ac629ff
-  data.tar.gz: 83c19c5597f26d23634cc37f3aaede5d7a58c62460c6a2cd5295a1d3e43c3017
+  metadata.gz: 25678f8238179260f1496807a1a68a20d86e09e72e7d7c4097c4b14f41b060ec
+  data.tar.gz: b713e70a91f521041975b86e6e22be2239ebfddbd3c9867691c55ecf8fbfb380
 SHA512:
-  metadata.gz: 02037bac922bbd2e7a7ccf82399e5892436a32f02970c87365935745ebc2858b16b4befbf11b26a9e70e54833ae0347a3d45a8450c839a95d93111dc92109035
-  data.tar.gz: 7dced1dca63327c7e66c527be390ac39bff028615f10696094b545514573000a52962fdbd807a77e7bb823b4c6151c56284b075e18be37bbea36d4140e10450d
+  metadata.gz: 433cc8be47c2df3d5e48abf8eaa6cd0550cbe4ceaaf3fde9700ad08c82be24488eb5b7a52d8ec4b6555880119d8c961a451841ddeed9a52d2a455792ae5eb69d
+  data.tar.gz: e6656a5c811920e9e4b4b2184ee5b981496296f3588182d3ce2f53e6bcb9328b0051c210830c01d2eb23a9fea5fe3151181a5adb7d08c5222eac08a67c2661ac

data/CHANGELOG.md

@@ -5,6 +5,29 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+## [0.2.0] - 2024-11-29
+
+### Added
+
+- ActionText support via `international_rich_text` (optional, requires ActionText)
+  - Generates `has_rich_text` for each locale with unified accessor
+  - Full attachment support per locale
+- Validation for `title_translations=` setter - rejects non-Hash values and invalid locales
+
+### Removed
+
+- `fallback: false` option - translations now always fallback to default locale
+- `set_translation(attr, locale, value)` - use `title_de = "value"` instead
+- `translation_for(attr, locale)` - use `title_de` instead
+
+## [0.1.1] - 2024-11-29
+
+### Fixed
+
+- Include `context/` directory in gem for `bake agent:context:install` support
+
 ## [0.1.0] - 2024-11-29
 
 ### Added
@@ -28,7 +51,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - `translation_for(attr, locale)`
   - `translated?(attr, locale)`
   - `translated_locales(attr)`
-- Fallback to default locale when translation missing (configurable)
+- Fallback to default locale when translation missing
 - SQLite adapter using `json_extract()`
 - PostgreSQL adapter using `->>` operator
 - MySQL 8+ adapter using `->>` operator (supports mysql2 and trilogy gems)

data/README.md

@@ -4,10 +4,14 @@ Lightweight, performant internationalization for Rails with JSON column storage.
 
 ## Why Internationalize?
 
+Internationalize is a focused, lightweight gem that does one thing well: JSON column translations. No backend abstraction layers, no plugin systems, no extra memory overhead.
+
 Unlike Globalize or Mobility which use separate translation tables requiring JOINs, Internationalize stores translations inline using JSON columns. This means:
 
 - **No JOINs** - translations live in the same table
 - **No N+1 queries** - data is always loaded with the record
+- **No backend overhead** - direct JSON column access, no abstraction layers
+- **~50% less memory** - no per-instance backend objects or plugin chains
 - **Direct method dispatch** - no `method_missing` overhead
 - **Multi-database support** - works with SQLite, PostgreSQL, and MySQL
 - **Visible in schema.rb** - translated fields appear directly in your model's schema
@@ -155,10 +159,6 @@ article.translated?(:title, :de)  # => true/false
 
 # Get all translated locales for an attribute
 article.translated_locales(:title)  # => [:en, :de]
-
-# Set/get translation for specific locale
-article.set_translation(:title, :de, "Hallo Welt")
-article.translation_for(:title, :de)  # => "Hallo Welt"
 ```
 
 ### Fallbacks
@@ -173,10 +173,29 @@ I18n.locale = :de
 article.title  # => "Hello" (falls back to :en)
 ```
 
-Disable fallbacks:
+### ActionText Support
+
+For rich text with attachments, use `international_rich_text` (requires ActionText):
 
 ```ruby
-international :title, fallback: false
+require "internationalize/rich_text"
+
+class Article < ApplicationRecord
+  include Internationalize::Model
+  include Internationalize::RichText
+
+  international_rich_text :content
+end
+```
+
+This generates `has_rich_text :content_en`, `has_rich_text :content_de`, etc. for each locale, with a unified accessor:
+
+```ruby
+article.content = "<p>Hello</p>"     # Sets for current locale
+article.content                       # Gets for current locale (with fallback)
+article.content_en                    # Direct access to English
+article.content.body                  # ActionText::Content object
+article.content.embeds                # Attachments work per-locale
 ```
 
 ## Configuration
@@ -184,11 +203,12 @@ international :title, fallback: false
 ```ruby
 # config/initializers/internationalize.rb
 Internationalize.configure do |config|
-  config.fallback_locale = :en
-  config.available_locales = [:en, :de, :fr]
+  config.available_locales = [:en, :de, :fr]  # Defaults to I18n.available_locales
 end
 ```
 
+Fallback uses `I18n.default_locale` automatically.
+
 ## Performance Comparison
 
 Benchmark with 1000 records, 2 translated attributes (title + body), 3 locales:

data/context/configuration.md

@@ -5,27 +5,12 @@
 ```ruby
 # config/initializers/internationalize.rb
 Internationalize.configure do |config|
-  # Override fallback locale (defaults to I18n.default_locale)
-  config.fallback_locale = :en
-
   # Override available locales (defaults to I18n.available_locales)
   config.available_locales = [:en, :de, :fr, :es]
 end
 ```
 
-## Per-Attribute Configuration
-
-```ruby
-class Article < ApplicationRecord
-  include Internationalize::Model
-
-  # With fallback (default)
-  international :title
-
-  # Without fallback
-  international :description, fallback: false
-end
-```
+Fallback locale is always `I18n.default_locale`.
 
 ## Database Setup
 
@@ -72,12 +57,10 @@ end
 
 ## I18n Integration
 
-Internationalize automatically uses Rails I18n settings:
+Internationalize uses Rails I18n settings directly:
 
 ```ruby
 I18n.locale           # Used for current locale
 I18n.default_locale   # Used for fallbacks
-I18n.available_locales # Used for locale-specific accessors
+I18n.available_locales # Used for locale-specific accessors (can be overridden)
 ```
-
-Override these with the configuration options above if needed.

data/context/getting-started.md

@@ -86,6 +86,7 @@ Article.international_order(:title, :desc)
 - No JOINs - data lives in the same table
 - Automatic fallback to default locale
 - Works with SQLite, PostgreSQL, and MySQL
+- ActionText support via `international_rich_text` (see Model API)
 
 ## Important: Column Defaults
 

data/context/model-api.md

@@ -9,16 +9,6 @@ class Article < ApplicationRecord
 end
 ```
 
-## Options
-
-```ruby
-# With fallback (default: true)
-international :title, fallback: true
-
-# Without fallback - returns nil if translation missing
-international :title, fallback: false
-```
-
 ## Generated Instance Methods
 
 For each `international :title` declaration:
@@ -31,7 +21,7 @@ For each `international :title` declaration:
 | `title=` | Set translation for current `I18n.locale` |
 | `title?` | Check if translation exists |
 | `title_translations` | Get raw hash of all translations |
-| `title_translations=` | Set all translations at once |
+| `title_translations=` | Set all translations at once (validates locale keys) |
 
 ### Locale-Specific Accessors
 
@@ -50,8 +40,6 @@ For each locale in `I18n.available_locales`:
 
 | Method | Description |
 |--------|-------------|
-| `set_translation(:title, :de, "Hallo")` | Set translation for attribute/locale |
-| `translation_for(:title, :de)` | Get translation without fallback |
 | `translated?(:title, :de)` | Check if translation exists |
 | `translated_locales(:title)` | Array of locales with translations |
 
@@ -84,7 +72,7 @@ Article.international_attributes  # => [:title, :description]
 
 ## Fallback Behavior
 
-When `fallback: true` (default):
+Translations automatically fall back to the default locale when missing:
 
 ```ruby
 article.title_en = "Hello"
@@ -92,10 +80,38 @@ I18n.locale = :de
 article.title  # => "Hello" (falls back to default locale)
 ```
 
-When `fallback: false`:
+## ActionText Support
+
+For rich text with attachments, use `international_rich_text` (requires ActionText):
 
 ```ruby
-article.title_en = "Hello"
-I18n.locale = :de
-article.title  # => nil
+require "internationalize/rich_text"
+
+class Article < ApplicationRecord
+  include Internationalize::Model
+  include Internationalize::RichText
+
+  international_rich_text :content
+end
+```
+
+This generates `has_rich_text :content_en`, `has_rich_text :content_de`, etc. for each locale.
+
+### Generated Methods
+
+| Method | Description |
+|--------|-------------|
+| `content` | Get rich text for current locale (with fallback) |
+| `content=` | Set rich text for current locale |
+| `content?` | Check if rich text exists |
+| `content_en` | Direct access to English rich text |
+| `content_de` | Direct access to German rich text |
+| `content_translated?(:de)` | Check if translation exists |
+| `content_translated_locales` | Array of locales with content |
+
+```ruby
+article.content = "<p>Hello</p>"  # Sets for current locale
+article.content                    # Gets for current locale (with fallback)
+article.content.body               # ActionText::Content object
+article.content.embeds             # Attachments work per-locale
 ```

data/lib/internationalize/model.rb

@@ -28,7 +28,6 @@ module Internationalize
       #
       # When called with Symbol arguments, declares attributes as internationalized:
       #   international :title, :description
-      #   international :title, fallback: false
       #
       # When called with keyword arguments, queries translated attributes:
       #   Article.international(title: "Hello")                      # exact match
@@ -37,16 +36,15 @@ module Internationalize
       #   Article.international(title: "Hello", match: :partial, case_sensitive: true)
       #
       # @param attributes [Array<Symbol>] attributes to declare as internationalized
-      # @param fallback [Boolean] whether to fallback to default locale (default: true)
       # @param locale [Symbol] locale to query (default: current locale)
       # @param match [Symbol] :exact or :partial (default: :exact)
       # @param case_sensitive [Boolean] for partial matching only (default: false)
       # @param conditions [Hash] attribute => value pairs to query
       #
-      def international(*attributes, fallback: true, locale: nil, match: :exact, case_sensitive: false, **conditions)
+      def international(*attributes, locale: nil, match: :exact, case_sensitive: false, **conditions)
         if attributes.any? && attributes.first.is_a?(Symbol) && conditions.empty?
           # Declaration mode: international :title, :description
-          declare_international_attributes(attributes, fallback: fallback)
+          declare_international_attributes(attributes)
         else
           # Query mode: Article.international(title: "Hello")
           international_query(conditions, locale: locale, match: match, case_sensitive: case_sensitive)
@@ -71,7 +69,7 @@ module Internationalize
             "Use standard ActiveRecord methods for non-translated attributes."
         end
 
-        locale ||= Internationalize.locale
+        locale ||= I18n.locale
         direction = direction.to_s.upcase
         direction = "ASC" unless VALID_DIRECTIONS.include?(direction)
 
@@ -91,7 +89,7 @@ module Internationalize
       #   Article.translated(:title, :description, locale: :de)
       #
       def translated(*attributes, locale: nil)
-        locale ||= Internationalize.locale
+        locale ||= I18n.locale
         adapter = Adapters.resolve(connection)
         scope = all
 
@@ -117,7 +115,7 @@ module Internationalize
       #   Article.untranslated(:title, locale: :de)
       #
       def untranslated(*attributes, locale: nil)
-        locale ||= Internationalize.locale
+        locale ||= I18n.locale
         adapter = Adapters.resolve(connection)
         scope = all
 
@@ -143,7 +141,7 @@ module Internationalize
       #   Article.international_not(title: "Entwurf", locale: :de)
       #
       def international_not(locale: nil, **conditions)
-        locale ||= Internationalize.locale
+        locale ||= I18n.locale
         adapter = Adapters.resolve(connection)
         scope = all
 
@@ -233,12 +231,12 @@ module Internationalize
       end
 
       # Declares attributes as internationalized
-      def declare_international_attributes(attributes, fallback:)
+      def declare_international_attributes(attributes)
         self.international_attributes = international_attributes | attributes.map(&:to_sym)
 
         attributes.each do |attr|
           warn_if_missing_default(attr)
-          define_translation_accessors(attr, fallback: fallback)
+          define_translation_accessors(attr)
           define_locale_accessors(attr)
         end
       end
@@ -258,7 +256,7 @@ module Internationalize
 
       # Query translated attributes with exact or partial matching
       def international_query(conditions, locale:, match:, case_sensitive:)
-        locale ||= Internationalize.locale
+        locale ||= I18n.locale
         adapter = Adapters.resolve(connection)
         scope = all
 
@@ -288,20 +286,19 @@ module Internationalize
       end
 
       # Defines the main getter/setter for an attribute
-      def define_translation_accessors(attr, fallback:)
+      def define_translation_accessors(attr)
         translations_column = "#{attr}_translations"
 
-        # Main getter - returns translation for current locale
-        # Cache default locale at definition time for faster fallback
-        default_locale_str = fallback ? Internationalize.default_locale.to_s : nil
+        # Main getter - returns translation for current locale with fallback to default locale
+        default_locale_str = I18n.default_locale.to_s
 
         define_method(attr) do |locale = nil|
           locale_str = (locale || I18n.locale).to_s
           translations = read_attribute(translations_column)
           value = translations[locale_str]
 
-          # Short-circuit: return early if value exists or no fallback needed
-          return value if !fallback || !value.nil? || locale_str == default_locale_str
+          # Short-circuit: return early if value exists or already querying default locale
+          return value if !value.nil? || locale_str == default_locale_str
 
           translations[default_locale_str]
         end
@@ -327,7 +324,21 @@ module Internationalize
 
         # Set all translations at once
         define_method("#{attr}_translations=") do |hash|
-          write_attribute(translations_column, hash&.stringify_keys || {})
+          return write_attribute(translations_column, {}) if hash.nil?
+
+          unless hash.is_a?(Hash)
+            raise ArgumentError, "#{attr}_translations must be a Hash, got #{hash.class}"
+          end
+
+          allowed_locales = Internationalize.locales.map(&:to_s)
+          hash.each_key do |key|
+            unless allowed_locales.include?(key.to_s)
+              raise ArgumentError, "Invalid locale '#{key}' for #{attr}_translations. " \
+                "Allowed locales: #{allowed_locales.join(', ')}"
+            end
+          end
+
+          write_attribute(translations_column, hash.stringify_keys)
         end
       end
 
@@ -362,23 +373,10 @@ module Internationalize
 
     # Instance methods
 
-    # Set translation for a specific locale
-    def set_translation(attr, locale, value)
-      column = "#{attr}_translations"
-      translations = read_attribute(column)
-      translations[locale.to_s] = value
-      write_attribute(column, translations)
-    end
-
-    # Get translation for a specific locale without fallback
-    def translation_for(attr, locale)
-      translations = read_attribute("#{attr}_translations")
-      translations[locale.to_s]
-    end
-
     # Check if a translation exists for a specific locale
     def translated?(attr, locale)
-      translation_for(attr, locale).present?
+      translations = read_attribute("#{attr}_translations")
+      translations[locale.to_s].present?
     end
 
     # Returns all locales that have a translation for an attribute

data/lib/internationalize/rich_text.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Internationalize
+  # Adds internationalization support for ActionText rich text attributes
+  #
+  # @example
+  #   class Article < ApplicationRecord
+  #     include Internationalize::Model
+  #     include Internationalize::RichText
+  #     international_rich_text :content
+  #   end
+  #
+  #   article.content = "<p>Hello</p>"  # Sets for current locale
+  #   article.content                    # Gets for current locale (with fallback)
+  #   article.content_de                 # Direct access to German content
+  #
+  module RichText
+    extend ActiveSupport::Concern
+
+    class_methods do
+      # Declares a rich text attribute as internationalized
+      #
+      # Creates a has_rich_text association for each available locale and
+      # provides locale-aware accessors.
+      #
+      # @param name [Symbol] the attribute name
+      #
+      def international_rich_text(name)
+        # Generate has_rich_text for each locale
+        Internationalize.locales.each do |locale|
+          rich_text_name = :"#{name}_#{locale}"
+          has_rich_text(rich_text_name)
+        end
+
+        default_locale_str = I18n.default_locale.to_s
+
+        # Main getter - returns rich text for current locale with fallback to default locale
+        define_method(name) do
+          locale_str = I18n.locale.to_s
+          rich_text = send(:"#{name}_#{locale_str}")
+
+          if rich_text.blank? && locale_str != default_locale_str
+            send(:"#{name}_#{default_locale_str}")
+          else
+            rich_text
+          end
+        end
+
+        # Main setter - sets rich text for current locale
+        define_method(:"#{name}=") do |value|
+          send(:"#{name}_#{I18n.locale}=", value)
+        end
+
+        # Predicate method
+        define_method(:"#{name}?") do
+          send(name).present?
+        end
+
+        # Check if translation exists for a specific locale
+        define_method(:"#{name}_translated?") do |locale|
+          send(:"#{name}_#{locale}").present?
+        end
+
+        # Get all locales that have this rich text
+        define_method(:"#{name}_translated_locales") do
+          Internationalize.locales.select do |locale|
+            send(:"#{name}_#{locale}").present?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/internationalize/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Internationalize
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

data/lib/internationalize.rb

@@ -10,22 +10,12 @@ require_relative "internationalize/model"
 module Internationalize
   class << self
     # Configuration
-    attr_accessor :fallback_locale, :available_locales
+    attr_accessor :available_locales
 
     def configure
       yield self
     end
 
-    # Returns the current locale, defaulting to I18n.locale
-    def locale
-      I18n.locale
-    end
-
-    # Returns the default locale for fallbacks
-    def default_locale
-      fallback_locale || I18n.default_locale
-    end
-
     # Returns available locales, defaulting to I18n.available_locales
     def locales
       available_locales || I18n.available_locales

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: internationalize
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Sampo Kuokkanen
@@ -63,6 +63,7 @@ files:
 - lib/internationalize/adapters/postgresql.rb
 - lib/internationalize/adapters/sqlite.rb
 - lib/internationalize/model.rb
+- lib/internationalize/rich_text.rb
 - lib/internationalize/version.rb
 homepage: https://github.com/sampokuokkanen/internationalize
 licenses: