wovnrb 3.6.0 → 3.7.2

data/lib/wovnrb/headers.rb

@@ -5,9 +5,9 @@ module Wovnrb
     # Generates new instance of Wovnrb::Headers.
     # Its parameters are set by parsing env variable.
 
-    def initialize(env, settings)
+    def initialize(env, settings, url_lang_switcher)
       request = Rack::Request.new(env)
-
+      @url_lang_switcher = url_lang_switcher
       @env = env
       @settings = settings
       @protocol = request.scheme
@@ -31,11 +31,11 @@ module Wovnrb
               else
                 @env['HTTP_HOST']
               end
-      @host = settings['url_pattern'] == 'subdomain' ? remove_lang(@host, lang_code) : @host
+      @host = settings['url_pattern'] == 'subdomain' ? @url_lang_switcher.remove_lang_from_uri_component(@host, lang_code) : @host
       @pathname, @query = @env['REQUEST_URI'].split('?')
-      @pathname = settings['url_pattern'] == 'path' ? remove_lang(@pathname, lang_code) : @pathname
+      @pathname = settings['url_pattern'] == 'path' ? @url_lang_switcher.remove_lang_from_uri_component(@pathname, lang_code) : @pathname
       @query ||= ''
-      @url = "#{@host}#{@pathname}#{(@query.empty? ? '' : '?') + remove_lang(@query, lang_code)}"
+      @url = "#{@host}#{@pathname}#{(@query.empty? ? '' : '?') + @url_lang_switcher.remove_lang_from_uri_component(@query, lang_code)}"
       if settings['query'].empty?
         @query = ''
       else
@@ -51,7 +51,7 @@ module Wovnrb
                    "?#{query_vals.sort.join('&')}"
                  end
       end
-      @query = remove_lang(@query, lang_code)
+      @query = @url_lang_switcher.remove_lang_from_uri_component(@query, lang_code)
       @pathname_with_trailing_slash_if_present = @pathname
       @pathname = @pathname.gsub(/\/$/, '')
     end
@@ -103,81 +103,38 @@ module Wovnrb
     def redirect_location(lang)
       if lang == @settings['default_lang']
         # IS THIS RIGHT??
-        "#{protocol}://#{url}"
-        # return remove_lang("#{@env['HTTP_HOST']}#{@env['REQUEST_URI']}", lang)
-      else
-        # TODO test
-        lang_code = Store.instance.settings['custom_lang_aliases'][lang] || lang
-        location = url
-        case @settings['url_pattern']
-        when 'query'
-          lang_param_name = @settings['lang_param_name']
-          location = if /\?/.match?(location)
-                       "#{location}&#{lang_param_name}=#{lang_code}"
-                     else
-                       "#{location}?#{lang_param_name}=#{lang_code}"
-                     end
-        when 'subdomain'
-          location = "#{lang_code.downcase}.#{location}"
-        # when 'path'
-        else
-          location = location.sub(/(\/|$)/, "/#{lang_code}/")
-        end
-        "#{protocol}://#{location}"
+        return url_with_scheme
       end
+
+      @url_lang_switcher.add_lang_code(url_with_scheme, lang, self)
     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')
-        @env['QUERY_STRING'] = remove_lang(@env['QUERY_STRING']) if @env.key?('QUERY_STRING')
-        @env['ORIGINAL_FULLPATH'] = remove_lang(@env['ORIGINAL_FULLPATH']) if @env.key?('ORIGINAL_FULLPATH')
+        @env['REQUEST_URI'] = @url_lang_switcher.remove_lang_from_uri_component(@env['REQUEST_URI'], lang_code) if @env.key?('REQUEST_URI')
+        @env['QUERY_STRING'] = @url_lang_switcher.remove_lang_from_uri_component(@env['QUERY_STRING'], lang_code) if @env.key?('QUERY_STRING')
+        @env['ORIGINAL_FULLPATH'] = @url_lang_switcher.remove_lang_from_uri_component(@env['ORIGINAL_FULLPATH'], lang_code) if @env.key?('ORIGINAL_FULLPATH')
       when 'subdomain'
         if @settings['use_proxy'] && @env.key?('HTTP_X_FORWARDED_HOST')
-          @env['HTTP_X_FORWARDED_HOST'] = remove_lang(@env['HTTP_X_FORWARDED_HOST'])
+          @env['HTTP_X_FORWARDED_HOST'] = @url_lang_switcher.remove_lang_from_uri_component(@env['HTTP_X_FORWARDED_HOST'], lang_code)
         else
-          @env['HTTP_HOST'] = remove_lang(@env['HTTP_HOST'])
-          @env['SERVER_NAME'] = remove_lang(@env['SERVER_NAME'])
+          @env['HTTP_HOST'] = @url_lang_switcher.remove_lang_from_uri_component(@env['HTTP_HOST'], lang_code)
+          @env['SERVER_NAME'] = @url_lang_switcher.remove_lang_from_uri_component(@env['SERVER_NAME'], lang_code)
         end
-        @env['HTTP_REFERER'] = remove_lang(@env['HTTP_REFERER']) if @env.key?('HTTP_REFERER')
+        @env['HTTP_REFERER'] = @url_lang_switcher.remove_lang_from_uri_component(@env['HTTP_REFERER'], lang_code) if @env.key?('HTTP_REFERER')
       # when 'path'
       else
-        @env['REQUEST_URI'] = remove_lang(@env['REQUEST_URI'])
-        @env['REQUEST_PATH'] = remove_lang(@env['REQUEST_PATH']) if @env.key?('REQUEST_PATH')
-        @env['PATH_INFO'] = remove_lang(@env['PATH_INFO'])
-        @env['ORIGINAL_FULLPATH'] = remove_lang(@env['ORIGINAL_FULLPATH']) if @env.key?('ORIGINAL_FULLPATH')
-        @env['HTTP_REFERER'] = remove_lang(@env['HTTP_REFERER']) if @env.key?('HTTP_REFERER')
+        @env['REQUEST_URI'] = @url_lang_switcher.remove_lang_from_uri_component(@env['REQUEST_URI'], lang_code)
+        @env['REQUEST_PATH'] = @url_lang_switcher.remove_lang_from_uri_component(@env['REQUEST_PATH'], lang_code) if @env.key?('REQUEST_PATH')
+        @env['PATH_INFO'] = @url_lang_switcher.remove_lang_from_uri_component(@env['PATH_INFO'], lang_code)
+        @env['ORIGINAL_FULLPATH'] = @url_lang_switcher.remove_lang_from_uri_component(@env['ORIGINAL_FULLPATH'], lang_code) if @env.key?('ORIGINAL_FULLPATH')
+        @env['HTTP_REFERER'] = @url_lang_switcher.remove_lang_from_uri_component(@env['HTTP_REFERER'], lang_code) if @env.key?('HTTP_REFERER')
       end
       @env
     end
 
-    # TODO: this should be in Lang for reusability
-    # Remove language code from the URI.
-    #
-    # @param uri  [String] original URI
-    # @param lang_code [String] language code
-    # @return     [String] removed URI
-    def remove_lang(uri, lang = path_lang)
-      lang_code = Store.instance.settings['custom_lang_aliases'][lang] || lang
-
-      # Do nothing if lang is empty.
-      return uri if lang_code.nil? || lang_code.empty?
-
-      case @settings['url_pattern']
-      when 'query'
-        lang_param_name = @settings['lang_param_name']
-        uri.sub(/(^|\?|&)#{lang_param_name}=#{lang_code}(&|$)/, '\1').gsub(/(\?|&)$/, '')
-      when 'subdomain'
-        rp = Regexp.new("(^|(//))#{lang_code}\\.", 'i')
-        uri.sub(rp, '\1')
-      # when 'path'
-      else
-        uri.sub(/\/#{lang_code}(\/|$)/, '/')
-      end
-    end
-
     def out(headers)
       r = Regexp.new("//#{@host}")
       lang_code = Store.instance.settings['custom_lang_aliases'][self.lang_code] || self.lang_code

data/lib/wovnrb/store.rb

@@ -151,7 +151,7 @@ module Wovnrb
       when 'query'
         @settings['url_pattern_reg'] = "((\\?.*&)|\\?)#{@settings['lang_param_name']}=(?<lang>[^&]+)(&|$)"
       when 'subdomain'
-        @settings['url_pattern_reg'] = "^(?<lang>[^.]+)\."
+        @settings['url_pattern_reg'] = '^(?<lang>[^.]+)\.'
       end
 
       @settings['test_mode'] = !(@settings['test_mode'] != true || @settings['test_mode'] != 'on')

data/lib/wovnrb/url_language_switcher.rb

@@ -9,7 +9,7 @@ module Wovnrb
 
     # Adds language code to URL in "href" variable by "pattern" variable and own lang_code.
     #  When lang_code is 'ja', add_lang_code('https://wovn.io', 'path', url) returns 'https://wovn.io/ja/'.
-    # @param  [String] href original URL.
+    # @param  [String] href original URL. (This condition is not validated against)
     # @param  [String] to_lang_code language code.
     def add_lang_code(href, to_lang_code, headers)
       return nil if href.nil?
@@ -26,6 +26,34 @@ module Wovnrb
       end
     end
 
+    # Removes language code from a URI component (path, hostname, query etc), and returns it.
+    #
+    # @param uri  [String] original URI component
+    # @param lang [String] language code
+    # @return     [String] removed URI
+    def remove_lang_from_uri_component(uri, lang)
+      lang_code = @store.settings['custom_lang_aliases'][lang] || lang
+
+      return uri if lang_code.blank?
+
+      case @store.settings['url_pattern']
+      when 'query'
+        lang_param_name = @store.settings['lang_param_name']
+        uri.sub(/(^|\?|&)#{lang_param_name}=#{lang_code}(&|$)/, '\1').gsub(/(\?|&)$/, '')
+      when 'subdomain'
+        rp = Regexp.new("(^|(//))#{lang_code}\\.", 'i')
+        uri.sub(rp, '\1')
+      when 'path'
+        # ^(.*://|//)?  1: schema (optional) like https://
+        # ([^/]*/)?     2: host (optional) like wovn.io, with trailing '/' (mandatory)
+        # (/|$)         3: path or end-of-string
+        lang_code_pattern = %r{^(.*://|//)?([^/]*/)?#{lang_code}(/|$)}
+        uri.sub(lang_code_pattern, '\1\2')
+      else
+        raise RuntimeError("Invalid URL pattern: #{@store.settings['url_pattern']}")
+      end
+    end
+
     private
 
     delegate :default_lang_alias, to: :@store

data/lib/wovnrb/version.rb

@@ -1,3 +1,3 @@
 module Wovnrb
-  VERSION = '3.6.0'.freeze
+  VERSION = '3.7.2'.freeze
 end

data/lib/wovnrb.rb

@@ -20,6 +20,7 @@ module Wovnrb
       @store = Store.instance
       opts = opts.transform_keys(&:to_s)
       @store.update_settings(opts)
+      @url_lang_switcher = Wovnrb::UrlLanguageSwitcher.new(@store)
     end
 
     def call(env)
@@ -30,7 +31,7 @@ module Wovnrb
       return @app.call(env) unless Store.instance.valid_settings?
 
       @env = env
-      headers = Headers.new(env, @store.settings)
+      headers = Headers.new(env, @store.settings, @url_lang_switcher)
       default_lang = @store.settings['default_lang']
       return @app.call(env) if @store.settings['test_mode'] && @store.settings['test_url'] != headers.url
 
@@ -77,8 +78,8 @@ module Wovnrb
       html_body = Helpers::NokogumboHelper.parse_html(string_body)
 
       if !wovn_ignored?(html_body) && !amp_page?(html_body)
-        url_lang_switcher = Wovnrb::UrlLanguageSwitcher.new(@store)
-        html_converter = HtmlConverter.new(html_body, @store, headers, url_lang_switcher)
+
+        html_converter = HtmlConverter.new(html_body, @store, headers, @url_lang_switcher)
 
         if needs_api?(html_body, headers)
           converted_html, marker = html_converter.build_api_compatible_html

data/test/lib/api_translator_test.rb

@@ -69,14 +69,15 @@ module Wovnrb
         'custom_lang_aliases' => { 'ja' => 'Japanese' },
         'default_lang' => 'en',
         'url_pattern' => 'subdomain',
-        'url_pattern_reg' => '^(?<lang>[^.]+).',
+        'url_pattern_reg' => '^(?<lang>[^.]+)\.',
         'lang_param_name' => 'lang'
       }
       store = Wovnrb::Store.instance
       store.update_settings(settings)
       headers = Wovnrb::Headers.new(
         Wovnrb.get_env('url' => 'http://fr.wovn.io/test', 'HTTP_USER_AGENT' => 'Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)'),
-        Wovnrb.get_settings(settings)
+        Wovnrb.get_settings(settings),
+        UrlLanguageSwitcher.new(store)
       )
       api_translator = ApiTranslator.new(store, headers, REQUEST_UUID)
       assert_equal(5.0, api_translator.send(:api_timeout))
@@ -88,7 +89,7 @@ module Wovnrb
         'custom_lang_aliases' => { 'ja' => 'Japanese' },
         'default_lang' => 'en',
         'url_pattern' => 'subdomain',
-        'url_pattern_reg' => '^(?<lang>[^.]+).',
+        'url_pattern_reg' => '^(?<lang>[^.]+)\.',
         'lang_param_name' => 'lang'
       }
       store = Wovnrb::Store.instance
@@ -97,7 +98,8 @@ module Wovnrb
       env.delete('HTTP_USER_AGENT')
       headers = Wovnrb::Headers.new(
         env,
-        Wovnrb.get_settings(settings)
+        Wovnrb.get_settings(settings),
+        UrlLanguageSwitcher.new(store)
       )
       api_translator = ApiTranslator.new(store, headers, REQUEST_UUID)
       assert_equal(1.0, api_translator.send(:api_timeout))
@@ -134,14 +136,15 @@ module Wovnrb
         'custom_lang_aliases' => { 'ja' => 'Japanese' },
         'default_lang' => 'en',
         'url_pattern' => 'subdomain',
-        'url_pattern_reg' => '^(?<lang>[^.]+).',
+        'url_pattern_reg' => '^(?<lang>[^.]+)\.',
         'lang_param_name' => 'lang'
       }
       store = Wovnrb::Store.instance
       store.update_settings(settings)
       headers = Wovnrb::Headers.new(
         Wovnrb.get_env('url' => 'http://fr.wovn.io/test'),
-        Wovnrb.get_settings(settings)
+        Wovnrb.get_settings(settings),
+        UrlLanguageSwitcher.new(store)
       )
       api_translator = ApiTranslator.new(store, headers, REQUEST_UUID)