translated 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29074d491110db08e39419d73a816b72827cbcf43376d6767ca8b51db29ac282
-  data.tar.gz: 87902d648e5d79b93792174219dcc2b1aa4d5f8e2d8c165964bf9942f70ce87f
+  metadata.gz: d8e76f6a921836b0f1eaab3a9c216876050d70b2376b936c641863c88aa8979c
+  data.tar.gz: 6e2cb9f18f06f3d0408812eb42bd57053ccc9b2acc766a2d5f78dd249e503c7f
 SHA512:
-  metadata.gz: 6864357eddf64bb99813934c9984d35fa77a819c779eb109192ef18c414a70ec53cb9893f555277c102f82427be55464a41cd3ee2a07d0d4004ba3c98eaa06ef
-  data.tar.gz: a8cf2bc3c1193fa62067ccaf58fc18e469c8d939efa906933ee40502b050b1ddda87320b32625796026e2c3eabd66c41b0c8697682634da179c1b1af7da36af3
+  metadata.gz: f6bc895fb490fac8fe2c23a9bf7e000dde58330909c36a956d288a0b325583d21cf45dc6c7a897f0752a38e904f33486033e22b4f80efc4c7a7d548d4a79479b
+  data.tar.gz: c4912b58c78943cdf884be2d3bc5a993fdd7b04984adfba97eca41e00a999cf27e40e81e799f793966fe7f5ff8000a0780b1ce40a2c67565e3eeed1f8a9f886e

data/README.md

@@ -1,16 +1,18 @@
 # Translated
-Simple, automatic translations for your Rails app.
+Simple, automatic translations for your Rails app with https://translatedrb.com.
 
 ## Usage
-Translated can handle both plain text and rich text (using actiontext).
+Translated can handle both plain text and rich text (using Action Text).
 
-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.
+These helpers will let you work with the content attribute like you normally would. The return value of this attribute will always be in the language specified by `I18n.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
+  has_translated_text_field :content
 end
 ```
 
@@ -22,7 +24,7 @@ class Message < ApplicationRecord
 end
 ```
 
-You can use this attribute just like any other actiontext attribute.
+You can use this attribute just like any other Action Text attribute.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -33,13 +35,28 @@ gem "translated"
 
 And then execute:
 ```bash
-$ bundle
+bundle
 ```
 
 Install the migrations:
 ```bash
-$ bin/rails translated:install:migrations
+bin/rails translated:install:migrations
+```
+
+Get your API key from https://translatedrb.com
+
+Create an initializer `config/initializers/translated.rb`
+```ruby
+Translated.api_key = 'API KEY from translatedrb.com'
+
+# Optionally, you can configure which environments you would like translated.
+# By default, it will translate development and production
+# Translated.environments = %w(development production)
 ```
 
+## Example Project
+
+Check out an example Rails project with Translated already installed [here](https://github.com/getcomfortly/translated-example).
+
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/jobs/translated/update_rich_translations_job.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Translated
+  class UpdateRichTranslationsJob < ApplicationJob
+    queue_as :default
+
+    def perform(record, attribute_name)
+      record.public_send(:"generate_translations_for_#{attribute_name}")
+    end
+  end
+end

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

@@ -7,27 +7,27 @@ module Translated
     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}
+            translation = #{name}_translation || build_#{name}_translation
+            translation&.for_locale(I18n.locale)
+          end
 
-        def #{name}?
-          #{name}.present?
-        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
+          def #{name}=(content)
+            translation = self.#{name}_translation || build_#{name}_translation
+            translation.set_locale(I18n.locale, content)
+            @_#{name}_translation_changed = true
+            content
+          end
 
-        private
+          private
 
-        def #{name}_translation_changed?
-          defined?(:@_#{name}_translation_changed) && @_#{name}_translation_changed
-        end
+          def #{name}_translation_changed?
+            defined?(:@_#{name}_translation_changed) && @_#{name}_translation_changed
+          end
         CODE
 
         has_one :"#{name}_translation",
@@ -55,20 +55,30 @@ module Translated
 
           def #{name}=(body)
             self.public_send(:"#{name}_\#{I18n.locale}=", body)
+            @_#{name}_translation_changed = true
+            body
+          end
 
+          def generate_translations_for_#{name}
             I18n.available_locales.each do |locale|
               next if locale == I18n.locale
 
-              generate_translation_for_#{name}(I18n.locale, locale)
+              from = I18n.locale
+              to = locale
+              content = public_send(:"#{name}_\#{from}").body&.to_html
+              translation = content.present? ? Translator.new.translate(content, from:, to:) : nil
+              update("#{name}_\#{to}" => translation)
             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:))
+          def #{name}_translation_changed?
+            defined?(:@_#{name}_translation_changed) && @_#{name}_translation_changed
+          end
+
+          def generate_translations_for_#{name}_later
+            UpdateRichTranslationsJob.perform_later(self, :#{name})
           end
         CODE
 
@@ -76,6 +86,8 @@ module Translated
           has_rich_text :"#{name}_#{locale}"
         end
 
+        after_save :"generate_translations_for_#{name}_later", if: :"#{name}_translation_changed?"
+
         scope :"with_rich_text_#{name}", lambda {
                                            includes(I18n.available_locales.map do |locale|
                                                       :"rich_text_#{name}_#{locale}"

data/app/models/translated/translated_text_field.rb

@@ -25,7 +25,7 @@ module Translated
       self.content ||= {}
       self.content[locale] = value
 
-      @_needs_translations = true
+      @_needs_translations = content_changed?
       value
     end
 
@@ -44,7 +44,7 @@ module Translated
     private
 
     def needs_translations?
-      defined?(:@_needs_translations) && @_needs_translations
+      defined?(:@_needs_translations) && @_needs_translations && Translated.environments.include?(Rails.env)
     end
 
     def update_translations_later

data/app/models/translated/translator.rb

@@ -4,16 +4,25 @@ require 'rest-client'
 
 module Translated
   class Translator
-    API_HOST = ENV.fetch('TRANSLATOR_API_HOST', 'http://localhost:3000')
+    API_HOST = ENV.fetch('TRANSLATED_API_HOST', 'https://translatedrb.com')
 
     def translate(text, from:, to:)
       response = RestClient.post(
         "#{API_HOST}/translate",
         { text: text, from: from, to: to }.to_json,
-        content_type: :json,
-        accept: :json
+        accept: :json,
+        authorization: "Token token=\"#{api_key}\"",
+        content_type: :json
       )
       JSON.parse(response.body)['translated_text']
     end
+
+    private
+
+    def api_key
+      fail 'Translated API key is required' if Translated.api_key.blank?
+
+      Translated.api_key
+    end
   end
 end

data/lib/translated/configuration.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Translated
+  class Configuration
+    attr_accessor :api_key, :environments
+
+    def initialize
+      @environments = %w(development production)
+    end
+  end
+end

data/lib/translated/version.rb

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

data/lib/translated.rb

@@ -2,6 +2,17 @@
 
 require 'translated/version'
 require 'translated/engine'
+require 'translated/configuration'
 
 module Translated
+  @config = Configuration.new
+
+  class << self
+    extend Forwardable
+
+    attr_reader :config
+
+    def_delegators :@config, :api_key, :api_key=
+    def_delegators :@config, :environments, :environments=
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: translated
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Trae Robrock
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-09 00:00:00.000000000 Z
+date: 2024-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -92,6 +92,7 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/jobs/translated/update_rich_translations_job.rb
 - app/jobs/translated/update_translations_job.rb
 - app/models/concerns/translated/translatable.rb
 - app/models/translated/translated_text_field.rb
@@ -99,6 +100,7 @@ files:
 - db/migrate/202405031152_create_translated_translated_text_fields.rb
 - lib/tasks/translated_tasks.rake
 - lib/translated.rb
+- lib/translated/configuration.rb
 - lib/translated/engine.rb
 - lib/translated/version.rb
 homepage: https://github.com/getcomfortly/translated