wovnrb 2.2.3 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7142c7b987c9c606c3e49258ed9e0aff9948da0fb72b20f0cc830e3c0c65de1
-  data.tar.gz: 70868e06450c6e67a01c277403993c75432793f2a985bfdd76dac92731cc6e4a
+  metadata.gz: 0b52fa4c2f9eb449a733283bbe12420dcf4f60dd606ade7f919ffa43274659d4
+  data.tar.gz: e5b4113a7e9e09aa352efc2a53cbafa26930f3aca5f4ade9e2fe0b46e7754686
 SHA512:
-  metadata.gz: 7b3667f117278b2646b38b80488aa74f18af0bec771d3ba09bd3232a83d6175fbed349ab2ff6912f2e3201000be11590a4a83a9cb015c8cebbc2a388f66cbac3
-  data.tar.gz: c162e510d61ab75be43cb0e1ee8fa1e6ffd3b986b200d90b65cb1744128e87f6bc433fa4a231c69ef825a07de500c58ed3ce2c20d962fb3c2a84ae4b8157f9c6
+  metadata.gz: 9010845d1a66b75de3093a5446571081598092183db5c02b8299492bc09319ab9372782467c694c2c86f62d4dd21238c31770267871542c819c87748ac4f4c20
+  data.tar.gz: 712d54ef68e854dec1017ef57bb147924fcbc4ecdb456af2d797aeb497a8d469045c35b9e5dd41d6dda0c74c6659f32c7560c236c0b1a3c4c1baa9961c479df9

data/.rubocop_todo.yml

@@ -308,3 +308,8 @@ Style/NumericPredicate:
 
 Style/SafeNavigation:
   Enabled: false
+
+AllCops:
+  Exclude:
+    - 'docker/**/*'
+    - 'vendor/**/*'

data/README.en.md

@@ -0,0 +1,198 @@
+# WOVN.io Ruby Library
+
+The WOVN.io Ruby library is a library that uses WOVN.io in order to provide translations. The WOVN.io Ruby Library is packaged as Rack Middleware.
+
+This document explains the process of installing WOVN.io Ruby, as well as set up and configuration process.
+
+## 1. Install
+
+### 1.1. Creating a WOVN.io account.
+
+In order to use the WOVN.io Ruby Library, you need a WOVN.io account. If you do not have an account, please first sign up for one at WOVN.io.
+
+### 1.2. Adding a Page
+
+After logging into WOVN.io, add a page that you would like translated.
+
+### 1.3. Ruby Application Settings
+
+To use the WOVN.io Ruby Library, insert the following line into your Ruby Application's Gemfile. WOVN.io currently supports version 2.0.1 and up.
+
+```ruby
+gem 'wovnrb', '>= 2.0.1'
+```
+
+After setting the above, execute the following command to install the WOVN.io Ruby Library.
+
+```bash
+bundle install
+```
+
+After installing the library, insert the following into your Ruby Application's settings file.
+
+* If you're using Ruby on Rails
+
+Insert the following into either config/application.rb or config/environments/.
+
+```ruby
+...
+
+config.wovnrb = {
+  :project_token => 'EnS!t3',
+  :default_lang => 'en',
+  :supported_langs => ['en'],
+  :url_pattern => 'path'
+}
+
+...
+```
+
+The WOVN.rb Rails middleware must also be installed. See [2.10 - install_middleware](#2.10-install_middleware)
+
+* If you're using Sinatra
+
+Insert the following into either the Application File or config.ru.
+
+```ruby
+...
+
+require 'wovnrb'
+
+use Wovnrb::Interceptor, {
+  :project_token => 'EnS!t3',
+  :default_lang => 'en',
+  :supported_langs => ['en'],
+  :url_pattern => 'path'
+}
+
+...
+```
+
+After completing setup, start the Ruby Application, and make sure the WOVN.io library is working correctly.
+
+## 2. Parameter Setting
+
+The following is a list of the WOVN.io Ruby Library's valid parameters.
+
+Parameter Name     | Required | Default Setting
+------------------ | -------- | ----------------
+project_token      | yes      | ''
+default_lang       | yes      | 'en'
+supported_langs    | yes      | ['en']
+url_pattern        | yes      | 'path'
+lang_param_name    |          | 'wovn'
+query              |          | []
+ignore_class       |          | []
+translate_fragment |          | true
+ignore_paths       |          | []
+install_middleware |          | true
+
+### 2.1. project_token
+
+Set your WOVN.io Account's Project token. This parameter is required.
+
+### 2.2. default_lang
+
+This sets the Ruby application's default language. The default value is English ('en').
+
+If, for a requested page, the default language parameter is included in the URL, the request is redirected before translating. The default_lang parameter is used for this purpose.
+
+If the default_lang is set to 'en', when receiving a request for the following URL,
+
+	https://wovn.io/en/contact
+
+Then the library will redirect to the following URL.
+
+	https://wovn.io/contact
+
+### 2.3. supported_langs
+This tells the library which languages are being used on the website (including
+the original language). This setting allows for inserting metadata necessary for
+SEO (Search Engine Optimization).
+
+If your website is in English and you are using WOVN.io to localize it in
+Japanese, then you should use the following setting:
+```
+:supported_langs => ['en', 'ja']
+```
+**Note:** The order of the languages in the list does not matter.
+
+### 2.4. url_pattern
+
+The Library works in the Ruby Application by adding new URLs to be translated. You can set the type of url with the `url_pattern` parameter. There are 3 types that can be set.
+
+parameters  | Translated page's URL           | Notes
+----------- | ------------------------------- | -------
+'path'      | https://wovn.io/ja/contact      | Default Value. If no settings have been set, url_pattern defaults to this value.
+'subdomain' | https://ja.wovn.io/contact      | DNS settings must be set.
+'query'     | https://wovn.io/contact?wovn=ja | The least amount of changes to the application required to complete setup.
+
+※ The following is an example of a URL that has been translated by the library using the above URLs.
+
+	https://wovn.io/contact
+
+### 2.5 lang_param_name
+This parameter is only valid for when `url_pattern` is set to `'query'`.
+
+It allows you to set the query parameter name for declaring the language of the
+page. The default value for this setting is `'wovn'`, such that a page URL in
+translated language English has the form
+`https://my-website.com/index.php?wovn=en`. If you instead set the value to
+`'lang'`, then the later URL example would have the form
+`https://my-website.com/index.php?lang=en`.
+
+### 2.6. query
+
+WOVN.io ignores query parameters when searching a translated page. If you want to add a query parameter to translated page's URL, you should configure the `query` parameter. (You need to configure WOVN.io too)
+
+	https://wovn.io/ja/contact?os=mac&keyboard=us
+
+If the `default_lang` is 'en', and the query is set to '', the above URL will be modified into the following URL to search for the page's translation.
+
+	https://wovn.io/contact
+
+If the `default_lang` is 'en', and the query is set to 'os', the above URL will be modified into the following URL to search for the page's translation.
+
+	https://wovn.io/contact?os=mac
+
+### 2.7. ignore_class
+
+This sets "Ignore class" which prevents WOVN from translating HTML elements that have a class contained in this array.
+
+### 2.8. translate_fragment
+
+This option allows to disable translating partial HTML content. By default,
+partial HTML content is translated but no widget snippet is added. Set
+`translate_fragment` to `false` to prevent translating partial HTML content.
+
+### 2.9 ignore_paths
+
+This parameter tells WOVN.rb to not localize content withing given directories.
+
+The directories given will only be matched against the beginning of the URL path.
+
+For instance, if you want to not localize the admin directory of your website, you should add the following to you WOVN.rb configuration.
+```
+'ignore_paths' => ['/admin/']
+```
+
+### 2.10 install_middleware
+
+When using WOVN.rb in a Rails environment, this parameter controls whether the WOVN.rb middleware will be automatically installed or not.
+
+By default, WOVN.rb is automatically installed as the first middleware.
+If you are using Rack::Deflater or other middleware that needs to be executed first, set this parameter to `false` and manually insert the middleware appropriately.
+WOVN.rb needs to be added after any compression middleware.
+
+```ruby
+  config.middleware.use Rack::Deflater
+  config.middleware.insert_after Rack::Deflater, Wovnrb::Interceptor
+
+  config.wovnrb = {
+    :project_token => 'EnS!t3',
+    :default_lang => 'en',
+    :supported_langs => ['en'],
+    :url_pattern => 'path',
+    :install_middleware => false
+  }
+```

data/README.ja.md

@@ -0,0 +1,180 @@
+# WOVN.io Ruby Library
+
+For English users: [English](README.en.md)
+
+WOVN.io Rubyライブラリは、翻訳を提供するためにWOVN.ioを利用したライブラリです。  
+WOVN.io Ruby ライブラリは Rack Middleware としてパッケージ化されています。
+
+このドキュメントでは、WOVN.io Rubyをインストールするまでの手順や、セットアップ・設定の流れを説明しています。
+
+## 1. インストール
+
+### 1.1. WOVN.ioアカウントを作成
+
+WOVN.io Ruby Libraryを利用するには、WOVN.ioのアカウントが必要です。  
+アカウントをお持ちでない方は、まずはWOVN.ioに登録してください。
+
+### 1.2. ページ追加
+
+WOVN.ioにログイン後、翻訳したいページを追加します。
+
+### 1.3. Rubyアプリケーションの設定
+
+WOVN.io Ruby ライブラリを使用するには、以下の行を Ruby アプリケーションの Gemfile に挿入します。  
+WOVN.ioは現在、バージョン2.0.1以上をサポートしています。
+
+```ruby
+gem 'wovnrb', '>= 2.0.1'
+```
+
+以上の設定を行った後、以下のコマンドを実行して、WOVN.io Rubyライブラリをインストールします。
+
+```bash
+bundle install
+```
+
+ライブラリをインストールしたら、Rubyアプリケーションの設定ファイルに以下を挿入します。
+
+* Ruby on Rails を使っている場合
+
+`config/application.rb` または `config/environments/` に以下を挿入します。
+
+```ruby
+...
+
+config.wovnrb = {
+  :project_token => 'EnS!t3',
+  :default_lang => 'en',
+  :supported_langs => ['en'],
+  :url_pattern => 'path'
+}
+
+...
+```
+
+* Sinatra を使っている場合
+
+アプリケーション・ファイルまたは `config.ru` のいずれかに以下を挿入します。
+
+```ruby
+...
+
+require 'wovnrb'
+
+use Wovnrb::Interceptor, {
+  :project_token => 'EnS!t3',
+  :default_lang => 'en',
+  :supported_langs => ['en'],
+  :url_pattern => 'path'
+}
+
+...
+```
+
+セットアップが完了したら、Rubyアプリケーションを起動し、WOVN.ioライブラリが正常に動作していることを確認します。
+
+## 2. パラメータ設定
+
+以下に、WOVN.io Ruby ライブラリの有効なパラメータの一覧を示します。
+
+パラメータ名       | 必須     | デフォルト設定
+------------------ | -------- | ----------------
+project_token      | yes      | ''
+default_lang       | yes      | 'en'
+supported_langs    | yes      | ['en']
+url_pattern        | yes      | 'path'
+lang_param_name    |          | 'wovn'
+query              |          | []
+ignore_class       |          | []
+translate_fragment |          | true
+ignore_paths       |          | []
+
+### 2.1. project_token
+
+WOVN.ioアカウントのプロジェクトトークンを設定します。このパラメータは必須です。
+
+### 2.2. default_lang
+
+これはRubyアプリケーションのデフォルト言語を設定します。デフォルト値は英語（'en'）です。
+
+リクエストされたページで、デフォルトの言語パラメータが URL に含まれている場合、リクエストは翻訳前にリダイレクトされます。  
+このために `default_lang` パラメータを使用します。
+
+`default_lang` が 'en' に設定されている時に、以下のURLへのリクエストを受信した場合。
+
+	https://wovn.io/en/contact
+
+ライブラリは以下のURLにリダイレクトされます。
+
+	https://wovn.io/contact
+
+### 2.3. supported_langs
+
+これは、ウェブサイトで使用されている言語（翻訳元を含む）をライブラリに伝えます。  
+この設定では、SEO（検索エンジン最適化）に必要なメタデータを挿入することができます。
+
+ウェブサイトが英語で、WOVN.ioを使って日本語にローカライズしている場合は、以下の設定にしてください。
+```
+:supported_langs => ['en', 'ja']
+```
+**注意:** 配列の言語の順番は関係ありません。
+
+### 2.4. url_pattern
+
+ライブラリはRubyアプリケーションの中で、翻訳されるURLを新たに追加することで動作します。  
+urlの種類は `url_pattern` パラメータで設定できます。設定できるタイプは3種類。
+
+
+パラメータ  | 翻訳されたページのURL           | 備考
+----------- | ------------------------------- | -------
+'path'      | https://wovn.io/ja/contact      | デフォルト値、何も設定されていない場合、 `url_pattern` のデフォルト値はこの値になります
+'subdomain' | https://ja.wovn.io/contact      | DNSの設定が必要です
+'query'     | https://wovn.io/contact?wovn=ja | セットアップを完了するために必要なアプリケーションへの変更の最小量
+
+※ 上記は、以下のURLを使用してライブラリが翻訳したURLの例です。
+
+	https://wovn.io/contact
+
+### 2.5 lang_param_name
+
+このパラメータは `url_pattern` が `query` に設定されている場合のみ有効です。
+
+ページの言語を指定するためのクエリパラメータ名を設定することができます。
+
+この設定のデフォルト値は `wovn` であり、翻訳された英語のページのURLが `https://my-website.com/index.php?wovn=en` という形式になります。  
+代わりに `lang` に値を設定すると、URLの例は `https://my-website.com/index.php?lang=en` という形式になります。
+
+### 2.6. query
+
+WOVN.ioは翻訳されたページを検索する際にクエリパラメータを無視します。  
+翻訳ページのURLにクエリパラメータを追加したい場合は、`query` パラメータを設定する必要があります。(WOVN.ioも設定する必要があります)
+
+	https://wovn.io/ja/contact?os=mac&keyboard=us
+
+`default_lang` が `en` でクエリが空に設定されている場合、上記のURLは以下のURLに変更され、ページの翻訳を検索するようになります。
+
+	https://wovn.io/contact
+
+`default_lang` が `en` でクエリが `os` に設定されている場合、上記のURLは以下のURLに変更され、ページの翻訳を検索するようになります。
+
+	https://wovn.io/contact?os=mac
+
+### 2.7. ignore_class
+
+これは「無視するクラス」を設定し、WOVNがこの配列に含まれるクラスを持つHTML要素を変換できないようにします。
+
+### 2.8. translate_fragment
+
+このオプションでは、部分的なHTMLコンテンツの翻訳を無効にすることができます。  
+デフォルトでは、部分的なHTMLコンテンツは翻訳されますが、ウィジェットのスニペットは追加されません。  
+`translate_fragment` を `false` に設定すると、HTMLの一部が翻訳されないようになります。
+
+### 2.9 ignore_paths
+
+このパラメータは、WOVN.rbが指定されたディレクトリ内のコンテンツをローカライズしないように指示します。  
+指定されたディレクトリは、URLパスの先頭にのみマッチします。  
+例えば、ウェブサイトの管理者ディレクトリをローカライズしたくない場合は、WOVN.rbの設定に次のように追加します。
+
+```
+'ignore_paths' => ['/admin/']
+```

data/README.md

@@ -0,0 +1 @@
+./README.ja.md

data/docker/docker-compose.yml

@@ -0,0 +1,11 @@
+version: '3'
+services:
+  rails:
+    container_name: wovntest-rails
+    build:
+      context: ./rails
+      dockerfile: Dockerfile
+    ports:
+      - 4000:4000
+    volumes:
+      - ../:/usr/src/app/wovnrb

data/docker/rails/Dockerfile

@@ -0,0 +1,6 @@
+FROM ruby:2.6.5
+
+WORKDIR /usr/src/app
+
+COPY ./TestSite/ .
+CMD ["/bin/bash", "start.sh"]

data/docker/rails/TestSite/.browserslistrc

@@ -0,0 +1 @@
+defaults

data/docker/rails/TestSite/.gitignore

@@ -0,0 +1,63 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/db/*.sqlite3-*
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/
+!/tmp/pids/.keep
+
+# Ignore uploaded files in development.
+/storage/*
+!/storage/.keep
+
+/public/assets
+.byebug_history
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key
+
+/public/packs
+/public/packs-test
+/node_modules
+/yarn-error.log
+yarn-debug.log*
+.yarn-integrity
+/.bundle/
+/vendor
+.yardoc/
+/Gemfile.lock
+/_yardoc/
+/coverage/
+doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.swp
+mkmf.log
+.idea/
+*.iml
+.ruby-version
+/*.gem
+wovn_error.log
+.byebug_history