trestle-mobility 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61f40dc820abfc72674027e455750a9c9b6011bed7a16ea257013407895cfe57
-  data.tar.gz: a6f35d96c0ce62a1b31de8441de8341a5372ea1657ce3b227256540d27ecde45
+  metadata.gz: 68e0287bd55e3ad8e8bfdc53fbb7c7dc50e79ad7a7059152a8d1c5012d3a8d77
+  data.tar.gz: cff3fc7d63c6933f0d5e76469b2ab6311c842b870c635a60539a0c4bf7425132
 SHA512:
-  metadata.gz: e3c4546221bf0a30e3d04bbf41b04513abe31177af38d1b5e9fe04b01d0ac30da33dc94e5ba96974a612badf78f7eaa70571905666ffb52e725fc211d8aa702e
-  data.tar.gz: bdf55d61911e8923ff421fc14a1d3bb80f42fcb8e08b500dfffd9bc3b0dc7a7a83134835d14b00c7672455ab995b77870eaf1c100d88cfc8cd94c6e118d4d02d
+  metadata.gz: a0fce0bba275227b9aeb0ae843bde24cd997404a9b2e498810e19ec2d0d6af73617cde24829499701bd7497eb832fc42bd1853191ce07c13435be661ee454bfd
+  data.tar.gz: b99ab55a32050210d38b6a5bd80758d4a4faf21299cf8945c9328193af4923a3a8d892283bee5186bfef8b554b89d12cfdd7a0f93ffbb6add8f731d38949e2d7

data/README.md

@@ -68,3 +68,9 @@ Trestle Mobility can automatically populate empty field values with translations
 ```ruby
 config.mobility.deepl_api_key = "YOUR-API-KEY"
 ```
+
+It is possible to pass any DeepL API options to the field (check out the [deepl-rb documentation](https://github.com/wikiti/deepl-rb#translate) section on params):
+
+```ruby
+mobility_text_area :content, rows: 14, deepl_query_params: { tag_handling: "xml" }
+```

data/app/assets/javascript/trestle/mobility.js

@@ -64,11 +64,13 @@ Trestle.init(function(e, root) {
   Mobility.prototype.deeplTranslate = function (fromLocale) {
     var self = this;
     var path = this.$deeplTranslationAction.data('remote-path');
+    var queryParams = this.$deeplTranslationAction.data('deepl-query-params');
     var data = {
       translation: {
         text: this.getFieldByLocale(fromLocale).val(),
         from_locale: fromLocale,
-        to_locale: this.activeLocale
+        to_locale: this.activeLocale,
+        query_params: queryParams
       }
     }
 

data/app/controllers/trestle/mobility/translations_controller.rb

@@ -3,7 +3,8 @@ class Trestle::Mobility::TranslationsController < Trestle::ApplicationController
     translation = Trestle::Mobility::Translators::DeeplTranslator.new.translate(
       translation_params[:text],
       translation_params[:from_locale],
-      translation_params[:to_locale]
+      translation_params[:to_locale],
+      translation_params[:query_params] || {}
     )
 
     render plain: translation
@@ -11,6 +12,6 @@ class Trestle::Mobility::TranslationsController < Trestle::ApplicationController
 
   private
     def translation_params
-      params.require(:translation).permit(:text, :from_locale, :to_locale)
+      params.require(:translation).permit(:text, :from_locale, :to_locale, query_params: {})
     end
 end

data/app/views/trestle/mobility/_deepl_translation_action.html.erb

@@ -1,4 +1,4 @@
-<div class="mobility__deepl" data-remote-path="<%= trestle.translate_path %>">
+<div class="mobility__deepl" data-remote-path="<%= trestle.translate_path %>" data-deepl-query-params="<%= deepl_query_params %>">
   <small class="mobility__deepl-progress">Translating…</small>
 
   <div class="btn-group">

data/app/views/trestle/mobility/_text_area.html.erb

@@ -9,10 +9,32 @@
       <% end %>
     </ul>
     <% locales.each do |locale, index| %>
-      <%= form.raw_text_area "#{field_name}_#{locale}", class: "form-control mobility-field#{locale == selected ? '' : ' hidden'}", placeholder: "#{label} (#{locale.upcase})", rows: rows, data: { locale: locale } %>
+      <%
+        value = instance.public_send(field_name)
+        value = value.try(:to_json) if options[:json]
+      %>
+
+      <%=
+        form.raw_text_area(
+          "#{field_name}_#{locale}",
+          options.merge(
+            value: value,
+            class: "form-control mobility-field#{locale == selected ? '' : ' hidden'}",
+            placeholder: "#{label} (#{locale.upcase})",
+            data: { locale: locale }
+          )
+        )
+      %>
     <% end %>
   </div>
 
-  <%= render(partial: "trestle/mobility/deepl_translation_action",
-             locals: { locales: locales }) if Trestle.config.mobility.deepl_api_key %>
+  <%=
+    render(
+      partial: "trestle/mobility/deepl_translation_action",
+      locals: {
+        locales: locales,
+        deepl_query_params: deepl_query_params.to_json
+      }
+    ) if Trestle.config.mobility.deepl_api_key
+  %>
 </div>

data/app/views/trestle/mobility/_text_field.html.erb

@@ -11,10 +11,26 @@
       </ul>
     </div>
     <% locales.each do |locale| %>
-      <%= form.raw_text_field "#{field_name}_#{locale}", class: "form-control mobility-field#{locale == selected ? '' : ' hidden'}", placeholder: "#{label} (#{locale.upcase})", data: { locale: locale } %>
+      <%=
+        form.raw_text_field(
+          "#{field_name}_#{locale}",
+          options.merge(
+            class: "form-control mobility-field#{locale == selected ? '' : ' hidden'}",
+            placeholder: "#{label} (#{locale.upcase})",
+            data: { locale: locale }
+          )
+        )
+      %>
     <% end %>
   </div>
 
-  <%= render(partial: "trestle/mobility/deepl_translation_action",
-             locals: { locales: locales }) if Trestle.config.mobility.deepl_api_key %>
+  <%=
+    render(
+      partial: "trestle/mobility/deepl_translation_action",
+      locals: {
+        locales: locales,
+        deepl_query_params: deepl_query_params.to_json
+      }
+    ) if Trestle.config.mobility.deepl_api_key
+  %>
 </div>

data/lib/trestle/mobility/fields/text_area.rb

@@ -2,19 +2,24 @@ module Trestle
   module Mobility
     module Fields
       class TextArea < Trestle::Form::Field
+        def defaults
+          super.merge(rows: 5)
+        end
+
         def field
           label = options[:label] || name.to_s.humanize
           locales = options[:locales] || I18n.available_locales.sort
           selected = options[:selected] || Trestle.config.mobility.selected.call || locales.first
-          rows = options[:rows] || 5
+          deepl_query_params =  options[:deepl_query_params] || {}
 
           @template.render partial: "trestle/mobility/text_area",
                            locals: {
+                             options: options,
                              field_name: name,
                              label: label,
                              locales: locales,
                              selected: selected,
-                             rows: rows
+                             deepl_query_params: deepl_query_params
                            }
         end
       end

data/lib/trestle/mobility/fields/text_field.rb

@@ -6,13 +6,16 @@ module Trestle
           label = options[:label] || name.to_s.humanize
           locales = options[:locales] || I18n.available_locales.sort
           selected = options[:selected] || Trestle.config.mobility.selected.call || locales.first
+          deepl_query_params =  options[:deepl_query_params] || {}
 
           @template.render partial: "trestle/mobility/text_field",
                            locals: {
+                             options: options,
                              field_name: name,
                              label: label,
                              locales: locales,
-                             selected: selected
+                             selected: selected,
+                             deepl_query_params: deepl_query_params
                            }
         end
       end

data/lib/trestle/mobility/translators/deepl_translator.rb

@@ -12,8 +12,8 @@ module Trestle::Mobility::Translators
       configure_api_key!
     end
 
-    def translate(text, from, to)
-      DeepL.translate(text, from, to)
+    def translate(text, from, to, query_params = {})
+      DeepL.translate(text, from, to, query_params)
     end
 
     private

data/lib/trestle/mobility/version.rb

@@ -1,5 +1,5 @@
 module Trestle
   module Mobility
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trestle-mobility
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Richard Venneman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-18 00:00:00.000000000 Z
+date: 2019-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: emoji_flag