mobility-actiontext 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a1f65c8e64ed83c88b3a6c2d8ccba46d4bf4a2503eba6d1ea4f69d51c363fa7a
+  data.tar.gz: 07d9ea9ecc5c9cf06b9eb2d2d0d16e952b2754f2fc0f6dcfed1aa7151d757ce3
+SHA512:
+  metadata.gz: 778621cdbe8d1820c76e3770f74f0e2e2a1f67cadb49a39672ad2d8355cd93e4e155feb4925808f3bc1235f6c528eb43f46a5eef8de73e0fce34bb38e722690a
+  data.tar.gz: 0a0b1a8b171a252228669deb7bad1b409d091d999294e61edd69bf6f4366cb89965c7ac56dff6c90101d1fd76c75d74efc8110d00b776230a9b77467d993f025

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: CI
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+    - uses: actions/cache@v2
+      with:
+        path: vendor/bundle
+        key: bundle-use-ruby-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          bundle-use-ruby-${{ matrix.os }}-${{ matrix.ruby }}-
+    - run: test_app/bin/setup
+    - run: cd test_app && bundle exec rails test

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.0.0

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Mobility Action Text Changelog
+
+### 0.1.0
+- Initial release.

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,152 @@
+PATH
+  remote: .
+  specs:
+    mobility-actiontext (0.1.0)
+      mobility (~> 1.1)
+      rails (~> 6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.3)
+      actionpack (= 6.1.3)
+      activesupport (= 6.1.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.3)
+      actionpack (= 6.1.3)
+      activejob (= 6.1.3)
+      activerecord (= 6.1.3)
+      activestorage (= 6.1.3)
+      activesupport (= 6.1.3)
+      mail (>= 2.7.1)
+    actionmailer (6.1.3)
+      actionpack (= 6.1.3)
+      actionview (= 6.1.3)
+      activejob (= 6.1.3)
+      activesupport (= 6.1.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.3)
+      actionview (= 6.1.3)
+      activesupport (= 6.1.3)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.3)
+      actionpack (= 6.1.3)
+      activerecord (= 6.1.3)
+      activestorage (= 6.1.3)
+      activesupport (= 6.1.3)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.3)
+      activesupport (= 6.1.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.3)
+      activesupport (= 6.1.3)
+      globalid (>= 0.3.6)
+    activemodel (6.1.3)
+      activesupport (= 6.1.3)
+    activerecord (6.1.3)
+      activemodel (= 6.1.3)
+      activesupport (= 6.1.3)
+    activestorage (6.1.3)
+      actionpack (= 6.1.3)
+      activejob (= 6.1.3)
+      activerecord (= 6.1.3)
+      activesupport (= 6.1.3)
+      marcel (~> 0.3.1)
+      mimemagic (~> 0.3.2)
+    activesupport (6.1.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    builder (3.2.4)
+    concurrent-ruby (1.1.8)
+    crass (1.0.6)
+    erubi (1.10.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.9)
+      concurrent-ruby (~> 1.0)
+    loofah (2.9.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    minitest (5.14.3)
+    mobility (1.1.1)
+      i18n (>= 0.6.10, < 2)
+      request_store (~> 1.0)
+    nio4r (2.5.5)
+    nokogiri (1.11.1-x86_64-darwin)
+      racc (~> 1.4)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.3)
+      actioncable (= 6.1.3)
+      actionmailbox (= 6.1.3)
+      actionmailer (= 6.1.3)
+      actionpack (= 6.1.3)
+      actiontext (= 6.1.3)
+      actionview (= 6.1.3)
+      activejob (= 6.1.3)
+      activemodel (= 6.1.3)
+      activerecord (= 6.1.3)
+      activestorage (= 6.1.3)
+      activesupport (= 6.1.3)
+      bundler (>= 1.15.0)
+      railties (= 6.1.3)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.1.3)
+      actionpack (= 6.1.3)
+      activesupport (= 6.1.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (~> 1.0)
+    rake (13.0.3)
+    request_store (1.5.0)
+      rack (>= 1.4)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  mobility-actiontext!
+  sqlite3 (~> 1.4)
+
+BUNDLED WITH
+   2.2.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Sébastien Dubois
+
+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,91 @@
+# Mobility Action Text
+
+![Gem Version](https://badge.fury.io/rb/mobility-actiontext.svg)
+![Build Status](https://github.com/sedubois/mobility-actiontext/workflows/CI/badge.svg)
+
+Translate Rails [Action Text](https://guides.rubyonrails.org/action_text_overview.html) rich text with [Mobility](https://github.com/shioyama/mobility).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mobility-actiontext'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install mobility-actiontext
+
+Make sure that Action Text is [installed](https://guides.rubyonrails.org/action_text_overview.html#installation), then run this migration:
+
+```rb
+class TranslateRichTexts < ActiveRecord::Migration[6.1]
+  def change
+    # or null: true to allow untranslated rich text
+    add_column :action_text_rich_texts, :locale, :string, null: false
+
+    remove_index :action_text_rich_texts,
+                 column: [:record_type, :record_id, :name],
+                 name: :index_action_text_rich_texts_uniqueness,
+                 unique: true
+    add_index :action_text_rich_texts,
+              [:record_type, :record_id, :name, :locale],
+              name: :index_action_text_rich_texts_uniqueness,
+              unique: true
+  end
+end
+```
+
+## Usage
+
+```diff
+# app/models/message.rb
+class Message < ApplicationRecord
++  extend Mobility
++
+-  has_rich_text :content
++  translates :content, backend: :action_text
+end
+```
+
+### Plain text
+
+Although the main purpose of the `action_text_rich_texts` table is to store rich text, this gem allows using it for plain text as well. This could be useful to consolidate all text in a single table and to remove the need to migrate data when converting between one and the other.
+
+```diff
+# app/models/message.rb
+class Message < ApplicationRecord
+   extend Mobility
+
++  translates :title, backend: :action_text, plain: true
+   translates :content, backend: :action_text
+end
+```
+
+## Implementation note
+
+Action Text's rich text content is saved in its own model that can be associated with any existing Active Record model using a polymorphic relation. Likewise, Mobility's KeyValue backend allows to translate any model using a polymorphic relation. This gem makes use of this similarity by combining both features in a single step, thus offering rich text "for free", i.e. in theory at no extra performance cost compared to untranslated rich text or translated plain text.
+
+This is done through the `Mobility::Backends::ActionText::Translation` model extending `ActionText::RichText`. This model is backed by Action Text's existing `action_text_rich_texts` table and its existing `name`, `body` and `record` attributes, to which is added a new `locale` attribute.
+
+[Read more](https://github.com/shioyama/mobility/issues/385) on the genesis of this gem.
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests.
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sedubois/mobility-actiontext.
+
+## 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 @@
+require "bundler/gem_tasks"

data/lib/mobility/action_text.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'action_text/version'
+require_relative 'backends/action_text'

data/lib/mobility/action_text/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Mobility
+  module ActionText
+    VERSION = '0.1.0'
+  end
+end

data/lib/mobility/backends/action_text.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'mobility/backends/active_record/key_value'
+
+module Mobility
+  # -
+  module Backends
+    #
+    # Implements the {Mobility::Backends::KeyValue} backend for ActionText.
+    #
+    # @example
+    #   class Post < ApplicationRecord
+    #     extend Mobility
+    #     translates :content, backend: :action_text
+    #   end
+    #
+    #   post = Post.create(content: "<h1>My text is rich</h1>")
+    #   post.rich_text_translations
+    #   #=> #<ActionText::RichText::ActiveRecord_Associations_CollectionProxy ... >
+    #   post.rich_text_translations.first.to_s
+    #   #=> "<div class=\"trix-content\">\n  <h1>My text is rich</h1>\n</div>\n"
+    #   post.content
+    #   #=> "<div class=\"trix-content\">\n  <h1>My text is rich</h1>\n</div>\n"
+    #   post.rich_text_translations.first.class
+    #   #=> Mobility::Backends::ActionText::RichTextTranslation
+    #
+    class ActionText < ActiveRecord::KeyValue
+      # override to return record instead of value
+      def read(locale, **options)
+        return super if self.options[:plain]
+        translation_for(locale, **options)
+      end
+
+      class << self
+        def valid_keys
+          super.tap { |keys| keys.delete(:type) } << :plain
+        end
+
+        # @!group Backend Configuration
+        # @option (see Mobility::Backends::KeyValue::ClassMethods#configure)
+        def configure(options)
+          options[:plain] = false unless options.has_key?(:plain)
+          if options[:plain]
+            options[:association_name] ||= 'plain_text_translations'
+            options[:class_name]       ||= PlainTextTranslation
+          else
+            options[:association_name] ||= 'rich_text_translations'
+            options[:class_name]       ||= RichTextTranslation
+          end
+          options[:key_column]       ||= :name
+          options[:value_column]     ||= :body
+          options[:belongs_to]       ||= :record
+          super
+        end
+        # @!endgroup
+      end
+
+      setup do |attributes, _options|
+        attributes.each do |name|
+          has_one :"rich_text_#{name}", -> { where(name: name, locale: Mobility.locale) },
+                  class_name: 'Mobility::Backends::ActionText::RichTextTranslation',
+                  as: :record, inverse_of: :record, autosave: true, dependent: :destroy
+          scope :"with_rich_text_#{name}", -> { includes("rich_text_#{name}") }
+          scope :"with_rich_text_#{name}_and_embeds",
+                -> { includes("rich_text_#{name}": { embeds_attachments: :blob }) }
+        end unless _options[:plain]
+      end
+
+      module ActionTextValidations
+        extend ActiveSupport::Concern
+
+        included do
+          validates :name,
+                    presence: true,
+                    uniqueness: { scope: %i[record_id record_type locale], case_sensitive: true }
+          validates :record, presence: true
+          validates :locale, presence: true
+        end
+      end
+
+      # Model for translated rich text
+      class RichTextTranslation < ::ActionText::RichText
+        extend ActionTextValidations
+      end
+
+      # Model for translated plain text
+      class PlainTextTranslation < ::ActiveRecord::Base
+        self.table_name = "action_text_rich_texts"
+
+        belongs_to :record, polymorphic: true, touch: true
+
+        extend ActionTextValidations
+      end
+    end
+
+    register_backend(:action_text, ActionText)
+  end
+end

data/mobility-actiontext.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'lib/mobility/action_text/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mobility-actiontext'
+  spec.version       = Mobility::ActionText::VERSION
+  spec.authors       = ['Sébastien Dubois']
+  spec.email         = ['sedubois@users.noreply.github.com']
+
+  spec.summary       = 'Translate Rails Action Text rich text with Mobility.'
+  spec.homepage      = 'https://github.com/sedubois/mobility-actiontext'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.2')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/sedubois/mobility-actiontext'
+  spec.metadata['changelog_uri'] = 'https://github.com/sedubois/mobility-actiontext/blob/main/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'mobility', '~> 1.1'
+  spec.add_dependency 'rails', '~> 6.0'
+
+  spec.add_development_dependency 'sqlite3', '~> 1.4'
+end