wovnrb 2.2.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21db13334fd0ceefeba7a6d0f23a13c035d8ca2e97796f2c5342659369b4a5d9
-  data.tar.gz: 6453345eb832513563decad6050d3b44d2f100c203c8e0f3f9cbbd8d6cc833b5
+  metadata.gz: a1667b83e9b8a2a2a79d1c152c71fac66ecc1acfe98b53f062e6929dda1d267c
+  data.tar.gz: 6fe79d1445f3e87ebd65e9d5beca3c173da6e3ae25e92de97c9b85bed95c8547
 SHA512:
-  metadata.gz: a43841cb1cd9a2fcda906663b8c8a5d46e751e37d202591f42d7eea17603df6523e8eca82538c49b7db20e9d3b1d8fd51d5e64e482ee71422384f109f699eef3
-  data.tar.gz: 6e87c0aa31e2b6853d295e600ba6fef63beb3cc5d0154a872e19a51cdc3a6d7828b1bc7ea21346dfee72c888576885256d11c84e1085608e2a5c55e693312359
+  metadata.gz: 560317e910fdf2966f10919126b8e7ec255ce07a9325bcd24c610eda52bb2686347e76e7123e9ffe0c22d7373220aab5e270b3d63a324dda1acec6c5a1c0d9cb
+  data.tar.gz: dbcb9693c55eb8a5b7e77d1b98e53d1bd8ae15989d498e585505a2b04137bf068ab20f4efedf4205c1c412d2882e33774875ffa14294635e2e0f1772efbda08a

data/.rubocop_todo.yml

@@ -29,7 +29,7 @@ Layout/ExtraSpacing:
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, IndentationWidth.
 # SupportedStyles: special_inside_parentheses, consistent, align_braces
-Layout/IndentFirstHashElement:
+Layout/FirstHashElementIndentation:
   Exclude:
     - 'lib/wovnrb/text_caches/cache_base.rb'
 
@@ -37,7 +37,7 @@ Layout/IndentFirstHashElement:
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: auto_detection, squiggly, active_support, powerpack, unindent
-Layout/IndentHeredoc:
+Layout/HeredocIndentation:
   Exclude:
     - 'test/lib/lang_test.rb'
     - 'test/lib/wovnrb_test.rb'

data/README.en.md

@@ -0,0 +1,174 @@
+# 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'
+}
+
+...
+```
+
+* 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       |          | []
+
+### 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/']
+```

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/lib/wovnrb.rb

@@ -32,14 +32,21 @@ module Wovnrb
 
       @env = env
       headers = Headers.new(env, @store.settings)
+      default_lang = @store.settings['default_lang']
       return @app.call(env) if @store.settings['test_mode'] && @store.settings['test_url'] != headers.url
 
       # redirect if the path is set to the default language (for SEO purposes)
-      if headers.path_lang == @store.settings['default_lang']
-        redirect_headers = headers.redirect(@store.settings['default_lang'])
+      if headers.path_lang == default_lang
+        redirect_headers = headers.redirect(default_lang)
         return [307, redirect_headers, ['']]
       end
 
+      # if path containing language code is ignored, do nothing
+      if headers.lang_code != default_lang && ignore_path?(headers.unmasked_pathname_without_trailing_slash)
+        status, res_headers, body = @app.call(env)
+
+        return output(headers, status, res_headers, body)
+      end
       # pass to application
       status, res_headers, body = @app.call(headers.request_out)
 
@@ -51,7 +58,7 @@ module Wovnrb
       return output(headers, status, res_headers, body) if request.params['wovn_disable'] == true
 
       @store.settings.update_dynamic_settings!(request.params)
-      return output(headers, status, res_headers, body) if @store.settings['ignore_globs'].any? { |g| g.match?(headers.pathname) }
+      return output(headers, status, res_headers, body) if ignore_path?(headers.pathname)
 
       body = switch_lang(headers, body) unless status.to_s =~ /^1|302/
 
@@ -102,7 +109,11 @@ module Wovnrb
     end
 
     def wovn_ignored?(html_body)
-      !html_body.xpath('//html[@wovn-ignore]').empty?
+      !html_body.xpath('//html[@wovn-ignore or @data-wovn-ignore]').empty?
+    end
+
+    def ignore_path?(path)
+      @store.settings['ignore_globs'].ignore?(path)
     end
 
     # Checks if a given HTML body is an Accelerated Mobile Page (AMP).

data/lib/wovnrb/headers.rb

@@ -8,7 +8,6 @@ module Wovnrb
     attr_reader :unmasked_pathname
     attr_reader :pathname
     attr_reader :pathname_with_trailing_slash_if_present
-    attr_reader :redis_url
 
     # Generates new instance of Wovnrb::Headers.
     # Its parameters are set by parsing env variable.
@@ -30,7 +29,7 @@ module Wovnrb
       end
       # REQUEST_URI is expected to not contain the server name
       # heroku contains http://...
-      @env['REQUEST_URI'] = @env['REQUEST_URI'].sub(/^.*:\/\/[^\/]+/, '') if @env['REQUEST_URI'] =~ /:\/\//
+      @env['REQUEST_URI'] = @env['REQUEST_URI'].sub(/^https?:\/\/[^\/]+/, '') if @env['REQUEST_URI'] =~ /^https?:\/\//
       @unmasked_pathname = @env['REQUEST_URI'].split('?')[0]
       @unmasked_pathname += '/' unless @unmasked_pathname =~ /\/$/ || @unmasked_pathname =~ /\/[^\/.]+\.[^\/.]+$/
       @unmasked_url = "#{@protocol}://#{@unmasked_host}#{@unmasked_pathname}"
@@ -39,7 +38,6 @@ module Wovnrb
               else
                 @env['HTTP_HOST']
               end
-      @env['wovnrb.target_lang'] = lang_code
       @host = settings['url_pattern'] == 'subdomain' ? remove_lang(@host, lang_code) : @host
       @pathname, @query = @env['REQUEST_URI'].split('?')
       @pathname = settings['url_pattern'] == 'path' ? remove_lang(@pathname, lang_code) : @pathname
@@ -63,7 +61,10 @@ module Wovnrb
       @query = remove_lang(@query, lang_code)
       @pathname_with_trailing_slash_if_present = @pathname
       @pathname = @pathname.gsub(/\/$/, '')
-      @redis_url = "#{@host}#{@pathname}#{@query}"
+    end
+
+    def unmasked_pathname_without_trailing_slash
+      @unmasked_pathname.chomp('/')
     end
 
     # Get the language code of the current request
@@ -95,27 +96,7 @@ module Wovnrb
       @path_lang
     end
 
-    def browser_lang
-      if @browser_lang.nil?
-        match = (@env['HTTP_COOKIE'] || '').match(/wovn_selected_lang\s*=\s*(?<lang>[^;\s]+)/)
-        if match && match[:lang] && Lang.get_lang(match[:lang])
-          @browser_lang = match[:lang]
-        else
-          # IS THIS RIGHT?
-          @browser_lang = ''
-          accept_langs = (@env['HTTP_ACCEPT_LANGUAGE'] || '').split(/[,;]/)
-          accept_langs.each do |l|
-            if Lang.get_lang(l)
-              @browser_lang = l
-              break
-            end
-          end
-        end
-      end
-      @browser_lang
-    end
-
-    def redirect(lang = browser_lang)
+    def redirect(lang)
       redirect_headers = {}
       redirect_headers['location'] = redirect_location(lang)
       redirect_headers['content-length'] = '0'
@@ -150,6 +131,7 @@ module Wovnrb
     end
 
     def request_out(_def_lang = @settings['default_lang'])
+      @env['wovnrb.target_lang'] = lang_code
       case @settings['url_pattern']
       when 'query'
         @env['REQUEST_URI'] = remove_lang(@env['REQUEST_URI']) if @env.key?('REQUEST_URI')
@@ -189,13 +171,13 @@ module Wovnrb
       case @settings['url_pattern']
       when 'query'
         lang_param_name = @settings['lang_param_name']
-        return uri.sub(/(^|\?|&)#{lang_param_name}=#{lang_code}(&|$)/, '\1').gsub(/(\?|&)$/, '')
+        uri.sub(/(^|\?|&)#{lang_param_name}=#{lang_code}(&|$)/, '\1').gsub(/(\?|&)$/, '')
       when 'subdomain'
         rp = Regexp.new('(^|(//))' + lang_code + '\.', 'i')
-        return uri.sub(rp, '\1')
+        uri.sub(rp, '\1')
       # when 'path'
       else
-        return uri.sub(/\/#{lang_code}(\/|$)/, '/')
+        uri.sub(/\/#{lang_code}(\/|$)/, '/')
       end
     end
 
@@ -203,19 +185,21 @@ module Wovnrb
       r = Regexp.new('//' + @host)
       lang_code = Store.instance.settings['custom_lang_aliases'][self.lang_code] || self.lang_code
       if lang_code != @settings['default_lang'] && headers.key?('Location') && headers['Location'] =~ r
-        case @settings['url_pattern']
-        when 'query'
-          headers['Location'] += if headers['Location'] =~ /\?/
-                                   '&'
-                                 else
-                                   '?'
-                                 end
-          headers['Location'] += "#{@settings['lang_param_name']}=#{lang_code}"
-        when 'subdomain'
-          headers['Location'] = headers['Location'].sub(/\/\/([^.]+)/, '//' + lang_code + '.\1')
-        # when 'path'
-        else
-          headers['Location'] = headers['Location'].sub(/(\/\/[^\/]+)/, '\1/' + lang_code)
+        unless @settings['ignore_globs'].ignore?(headers['Location'])
+          case @settings['url_pattern']
+          when 'query'
+            headers['Location'] += if headers['Location'] =~ /\?/
+                                     '&'
+                                   else
+                                     '?'
+                                   end
+            headers['Location'] += "#{@settings['lang_param_name']}=#{lang_code}"
+          when 'subdomain'
+            headers['Location'] = headers['Location'].sub(/\/\/([^.]+)/, '//' + lang_code + '.\1')
+          # when 'path'
+          else
+            headers['Location'] = headers['Location'].sub(/(\/\/[^\/]+)/, '\1/' + lang_code)
+          end
         end
       end
       headers