translated 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 29074d491110db08e39419d73a816b72827cbcf43376d6767ca8b51db29ac282
+  data.tar.gz: 87902d648e5d79b93792174219dcc2b1aa4d5f8e2d8c165964bf9942f70ce87f
+SHA512:
+  metadata.gz: 6864357eddf64bb99813934c9984d35fa77a819c779eb109192ef18c414a70ec53cb9893f555277c102f82427be55464a41cd3ee2a07d0d4004ba3c98eaa06ef
+  data.tar.gz: a8cf2bc3c1193fa62067ccaf58fc18e469c8d939efa906933ee40502b050b1ddda87320b32625796026e2c3eabd66c41b0c8697682634da179c1b1af7da36af3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) Comfortly Inc.
+
+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,45 @@
+# Translated
+Simple, automatic translations for your Rails app.
+
+## Usage
+Translated can handle both plain text and rich text (using actiontext).
+
+These helpers will let you work with the content attribute like you normally would. The return of this attribute will always be in the language specified by I18n.current_locale. So if it's set to :es, then you'll get Spanish. When you set the value it will save that for the current_locale and then create translations for every locale listed in the I18n.available_locales list.
+
+For plain text, simply add this to your model:
+
+```ruby
+class Message < ApplicationRecord
+  has_translated_text :content
+end
+```
+
+For rich text:
+
+```ruby
+class Message < ApplicationRecord
+  has_translated_rich_text :content
+end
+```
+
+You can use this attribute just like any other actiontext attribute.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "translated"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Install the migrations:
+```bash
+$ bin/rails translated:install:migrations
+```
+
+## 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,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/app/jobs/translated/update_translations_job.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Translated
+  class UpdateTranslationsJob < ApplicationJob
+    queue_as :default
+
+    def perform(translated_text_field)
+      translated_text_field.update_translations
+    end
+  end
+end

data/app/models/concerns/translated/translatable.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Translated
+  module Translatable
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def has_translated_text_field(name, validates: {}) # rubocop:disable Naming/PredicateName
+        class_eval <<-CODE, __FILE__, __LINE__ + 1 # rubocop:disable Style/DocumentDynamicEvalDefinition
+        def #{name}
+          translation = #{name}_translation || build_#{name}_translation
+          translation&.for_locale(I18n.locale)
+        end
+
+        def #{name}?
+          #{name}.present?
+        end
+
+        def #{name}=(content)
+          translation = self.#{name}_translation || build_#{name}_translation
+          translation.set_locale(I18n.locale, content)
+          @_#{name}_translation_changed = true
+          content
+        end
+
+        private
+
+        def #{name}_translation_changed?
+          defined?(:@_#{name}_translation_changed) && @_#{name}_translation_changed
+        end
+        CODE
+
+        has_one :"#{name}_translation",
+                -> { where(field: name.to_s) },
+                class_name: 'Translated::TranslatedTextField',
+                as: :translatable,
+                dependent: :destroy,
+                inverse_of: :translatable
+        after_save -> { public_send(:"#{name}_translation").save }, if: :"#{name}_translation_changed?"
+
+        validates name, validates if validates.present?
+
+        scope :with_translations, -> { includes(:translated_text_fields) }
+      end
+
+      def has_translated_rich_text(name) # rubocop:disable Naming/PredicateName
+        class_eval <<-CODE, __FILE__, __LINE__ + 1 # rubocop:disable Style/DocumentDynamicEvalDefinition
+          def #{name}
+            public_send(:"#{name}_\#{I18n.locale}")
+          end
+
+          def #{name}?
+            #{name}.present?
+          end
+
+          def #{name}=(body)
+            self.public_send(:"#{name}_\#{I18n.locale}=", body)
+
+            I18n.available_locales.each do |locale|
+              next if locale == I18n.locale
+
+              generate_translation_for_#{name}(I18n.locale, locale)
+            end
+
+            body
+          end
+
+          private
+
+          def generate_translation_for_#{name}(from, to)
+            self.public_send(:"#{name}_\#{to}=", Translator.new.translate(public_send(:"#{name}_\#{from}").body.to_html, from:, to:))
+          end
+        CODE
+
+        I18n.available_locales.each do |locale|
+          has_rich_text :"#{name}_#{locale}"
+        end
+
+        scope :"with_rich_text_#{name}", lambda {
+                                           includes(I18n.available_locales.map do |locale|
+                                                      :"rich_text_#{name}_#{locale}"
+                                                    end)
+                                         }
+        scope :"with_rich_text_#{name}_and_embeds", lambda {
+                                                      includes(I18n.available_locales.to_h do |locale|
+                                                                 [:"rich_text_#{name}_#{locale}",
+                                                                  { embeds_attachments: :blob }]
+                                                               end)
+                                                    }
+      end
+    end
+  end
+end

data/app/models/translated/translated_text_field.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Translated
+  class TranslatedTextField < ApplicationRecord
+    serialize :content, coder: JSON
+
+    belongs_to :translatable, polymorphic: true
+
+    validates :language, presence: true, inclusion: { in: I18n.available_locales.map(&:to_s) }
+
+    after_commit :update_translations_later, if: :needs_translations?
+
+    after_initialize do
+      self.content ||= {}
+    end
+
+    def for_locale(locale)
+      content.fetch(locale.to_s, nil)
+    end
+
+    def set_locale(locale, value)
+      locale = locale.to_s
+      self.language = locale
+
+      self.content ||= {}
+      self.content[locale] = value
+
+      @_needs_translations = true
+      value
+    end
+
+    def update_translations
+      source = content[language]
+
+      I18n.available_locales.each do |locale|
+        next if locale == language.to_sym
+
+        content[locale.to_s] = source.presence && Translator.new.translate(source, from: language, to: locale.to_s)
+      end
+
+      save!
+    end
+
+    private
+
+    def needs_translations?
+      defined?(:@_needs_translations) && @_needs_translations
+    end
+
+    def update_translations_later
+      UpdateTranslationsJob.perform_later(self)
+    end
+  end
+end

data/app/models/translated/translator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'rest-client'
+
+module Translated
+  class Translator
+    API_HOST = ENV.fetch('TRANSLATOR_API_HOST', 'http://localhost:3000')
+
+    def translate(text, from:, to:)
+      response = RestClient.post(
+        "#{API_HOST}/translate",
+        { text: text, from: from, to: to }.to_json,
+        content_type: :json,
+        accept: :json
+      )
+      JSON.parse(response.body)['translated_text']
+    end
+  end
+end

data/db/migrate/202405031152_create_translated_translated_text_fields.rb

@@ -0,0 +1,12 @@
+class CreateTranslatedTranslatedTextFields < ActiveRecord::Migration[7.2]
+  def change
+    create_table :translated_translated_text_fields do |t|
+      t.references :translatable, polymorphic: true, null: false
+      t.string :field
+      t.string :language
+      t.text :content
+
+      t.timestamps
+    end
+  end
+end

data/lib/tasks/translated_tasks.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# desc "Explaining what the task does"
+# task :translated do
+#   # Task goes here
+# end

data/lib/translated/engine.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'rails/engine'
+
+module Translated
+  class Engine < Rails::Engine
+    isolate_namespace Translated
+    config.autoload_once_paths = %W(
+      #{root}/app/jobs
+      #{root}/app/models
+      #{root}/app/models/concerns
+    )
+
+    initializer 'translated.translatable' do
+      ActiveSupport.on_load :active_record do
+        include Translated::Translatable
+      end
+    end
+  end
+end

data/lib/translated/version.rb

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

data/lib/translated.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'translated/version'
+require 'translated/engine'
+
+module Translated
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: translated
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Trae Robrock
+- Andrew Katz
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: Simple, automatic translations for your Rails app.
+email:
+- trobrock@comfort.ly
+- andrew@comfort.ly
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/jobs/translated/update_translations_job.rb
+- app/models/concerns/translated/translatable.rb
+- app/models/translated/translated_text_field.rb
+- app/models/translated/translator.rb
+- db/migrate/202405031152_create_translated_translated_text_fields.rb
+- lib/tasks/translated_tasks.rake
+- lib/translated.rb
+- lib/translated/engine.rb
+- lib/translated/version.rb
+homepage: https://github.com/getcomfortly/translated
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://translatedrb.com
+  source_code_uri: https://github.com/getcomfortly/translated
+  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.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: Simple, automatic translations for your Rails app.
+test_files: []