rewritten 0.13.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec0125862e538037c12d709768eda65cf08e3cb6
-  data.tar.gz: d02def0f2df7280603224f60e4c709844c1b56fe
+  metadata.gz: 183b54cd40ae90c9d26c6a4a2c804535003746a6
+  data.tar.gz: da104eb558ac511ef8ac843b9d25fd62ba8830db
 SHA512:
-  metadata.gz: c02e89f98798a7e84e2bab137f3ef0d54c99376928adaac861c398434df0c18704155ca4b7bd4a9860df4bd169443b08a9b585d6ccef682148c6ed8306a84012
-  data.tar.gz: a4d30fd8357c5ff63cac5de1592d52c3cc0bf95450d1da298ed68b12a602de080cb36206f6dbd7577f04975d0cb233966825dc6387454f3dcb53b55dd1f1c6d4
+  metadata.gz: e65d6785aadee1b61335933615ae6bdd3d702e47164103703a755f7aa5ad0da9cfce84ed2e66777b865db879d762a9e27208fdd0fd857f0bd723ec25335d55a8
+  data.tar.gz: 63a5a104a68963b837ddc220bd7c98776ef01676eb04d4bd886c527a07feb7ebe78652ac12bd00a638f99b4504bae66170e4c57cd60e38d3704794e0abd00876

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.2
+services:
+  - redis-server
+

data/HISTORY.rdoc

@@ -1,3 +1,6 @@
+== 0.14.0
+  * Extract canonical to own rack app
+
 == 0.13.0
   * Find translations even for absolute urls and urls with query parameters
 

data/lib/rack/canonical.rb

@@ -0,0 +1,45 @@
+require 'rack'
+
+module Rack
+
+  module Rewritten
+
+    class Canonical
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        req = Rack::Request.new(env)
+
+        status, headers, response = @app.call(req.env)
+
+        if status == 200 && headers["Content-Type"] =~ /text\/html|application\/xhtml\+xml/
+          body = ""
+          response.each { |part| body << part }
+          index = body.rindex("</head>")
+          if index
+            # go with a request duplicate since infinitive works on translations
+	    target_req = req.dup
+	    target_req.path_info = ::Rewritten.infinitive( ::Rewritten.get_current_translation(req.path) )
+	    target_req.env['QUERY_STRING'] = ''
+	    #target = ::Rewritten.get_current_translation(target_req.url)
+	    target = target_req.url
+
+            body.insert(index, %Q|<link rel="canonical" href="#{target}"/>| )
+            headers["Content-Length"] = body.length.to_s
+            response = [body]
+          end
+
+          [status, headers, response]
+        end
+      end
+
+    end
+
+  end
+
+end
+
+

data/lib/rack/url.rb

@@ -11,11 +11,10 @@ module Rack
         @translate_backwards = false
         @downcase_before_lookup = false
         @translate_partial = false
-
         instance_eval(&block) if block_given?
       end
 
-      def call(env, tail=nil)
+      def call(env)
         req = Rack::Request.new(env)
 
         subdomain = env["SUBDOMAIN"] ? "#{env["SUBDOMAIN"]}:" : ""
@@ -23,7 +22,7 @@ module Rack
         path = "#{subdomain}#{req.path_info}"
         path.downcase! if downcase_before_lookup?
 
-        if ::Rewritten.includes?(path.chomp("/")) or translate_backwards? && ::Rewritten.exist_translation_for?(path) 
+        if ::Rewritten.includes?(path.chomp("/")) or backwards=( translate_backwards? && ::Rewritten.exist_translation_for?(path) )
 
           to = ::Rewritten.includes?(path.chomp("/")) || path
 
@@ -31,30 +30,13 @@ module Rack
           current_path = current_path.split(":").last
           current_path = current_path.split('?')[0]
 
-          if current_path == req.path_info or ::Rewritten.has_flag?(path, 'L')
+          if (current_path == req.path_info) or (::Rewritten.base_from(req.path_info) == current_path) or ::Rewritten.has_flag?(path, 'L')
             # if this is the current path, rewrite path and parameters
             tpath, tparams = split_to_path_params(to)
 
             env['QUERY_STRING'] = Rack::Utils.build_query(tparams.merge(req.params))
-            req.path_info = tpath + (tail ? "/"+tail : "")
-            #@app.call(req.env)
-            
-            # add the canonical tag to the body
-            status, headers, response = @app.call(req.env)
-
-            if status == 200 && headers["Content-Type"] =~ /text\/html|application\/xhtml\+xml/
-              body = ""
-              response.each { |part| body << part }
-              index = body.rindex("</head>")
-              if index
-                body.insert(index, %Q|<link rel="canonical" href="#{path}"/>| )
-                headers["Content-Length"] = body.length.to_s
-                response = [body]
-              end
-            end
-
-            [status, headers, response]
-
+            req.path_info = tpath + ::Rewritten.appendix(req.path_info)
+            @app.call(req.env)
           else
             # if this is not the current path, redirect to current path
             # NOTE: assuming redirection is always to non-subdomain-path
@@ -64,23 +46,15 @@ module Rack
             new_path = env["rack.url_scheme"].dup
             new_path << "://"
             new_path << env["HTTP_HOST"].dup.sub(/^#{subdomain.chomp(':')}\./, '')
-            new_path << current_path + (tail ? "/"+tail : "")
+            new_path << current_path
+            new_path << ::Rewritten.appendix(path) unless backwards
             new_path << '?' << env["QUERY_STRING"] unless (env["QUERY_STRING"]||'').empty?
 
             r.redirect(new_path, 301)
             a = r.finish
           end
         else
-          # Translation of partials (e.g. /some/path/tail -> /translated/path/tail)
-          if(path).count('/') > 1 && translate_partial?
-            parts = path.split('/')
-            req.path_info = parts.slice(0, parts.size-1).join('/')
-            self.call(req.env, parts.last + (tail ? "/" + tail : ""))
-          else
-            req.path_info = (tail ? req.path_info+"/"+tail : req.path_info)
-            @app.call(req.env)
-
-          end
+          @app.call(req.env)
         end
       end
 
@@ -89,7 +63,6 @@ module Rack
         [path, Rack::Utils.parse_query(query_string)] 
       end
 
-
       private
 
       def translate_backwards?
@@ -113,7 +86,8 @@ module Rack
       end
 
       def translate_partial=(yes_or_no)
-        @translate_partial = yes_or_no
+        $stderr.puts "DEPRECATED. Please use Rewritten.translate_partial"
+        Rewritten.translate_partial = yes_or_no
       end
     end
   end

data/lib/rewritten/version.rb

@@ -1,4 +1,4 @@
 module Rewritten
-  VERSION = "0.13.1"
+  VERSION = "0.14.0"
 end
 

data/lib/rewritten.rb

@@ -6,6 +6,7 @@ require 'rack/url'
 require 'rack/record'
 require 'rack/html'
 require 'rack/subdomain'
+require 'rack/canonical'
 require 'rewritten/document'
 
 module Rewritten
@@ -40,6 +41,14 @@ module Rewritten
     end
   end
 
+  def translate_partial=(yes_or_no)
+    @translate_partial = yes_or_no
+  end
+
+  def translate_partial?
+    @translate_partial
+  end
+
   # Returns the current Redis connection. If none has been created, will
   # create a new one.
   def redis
@@ -186,26 +195,75 @@ module Rewritten
     Rewritten.redis.zrange("to:#{to}", 0, -1)
   end
 
-  def get_current_translation(path)
+  def get_current_translation(path, tail=nil)
 
     uri = URI.parse(path)
 
+    # find directly
     translation = Rewritten.z_range("to:#{path}", -1)
-
+   
     unless translation 
       translation = Rewritten.z_range("to:#{uri.path}", -1)
     end
 
-    # return path as is if no translation found
-    return path unless translation
+    if translation.nil?
+      if translate_partial? && path.count('/') > 1
+        parts = path.split('/')
+        shorter_path = parts.slice(0, parts.size-1).join('/')
+        appendix = parts.last + (tail ? "/" + tail : "")
+        return get_current_translation(shorter_path, appendix) 
+      else
+        return path
+      end
+    end
 
-    translated_uri = URI.parse(translation)
+    complete_path = (tail ? translation+"/"+tail : translation)
+    translated_uri = URI.parse(complete_path)
     uri.path = translated_uri.path
     uri.query = [translated_uri.query, uri.query].compact.join('&')
     uri.query = nil if uri.query == ''
     uri.to_s
   end
 
+
+  # infinitive for translations only!
+  def infinitive(some_from)
+
+    conjugated = some_from.chomp('/')
+
+    to = translate(conjugated)
+    to = translate(conjugated.split('?')[0]) unless to
+
+    if to.nil? && translate_partial? && conjugated.count('/') > 1 
+      parts = conjugated.split('/')
+      shorter_path = parts.slice(0, parts.size-1).join('/')
+      infinitive(shorter_path)
+    else
+      conjugated = get_current_translation(to) if to
+      conjugated.split('?')[0].chomp('/')
+    end
+  end
+
+  def base_from(some_from)
+    base_from = some_from.split('?')[0].chomp('/')
+    if translate(some_from)
+      some_from
+    elsif translate(base_from)
+      base_from
+    elsif translate_partial? && base_from.count('/') > 1
+      parts = base_from.split('/')
+      base_from(parts.slice(0,parts.size-1).join('/'))
+    else
+      nil
+    end
+  end
+
+  def appendix(some_from)
+    base = base_from(some_from) || ''
+    result = some_from.partition( base ).last
+    result.chomp('/')
+  end
+
   def get_flag_string(from)
     Rewritten.redis.hget("from:#{from}", :flags)||""
   end
@@ -240,7 +298,17 @@ module Rewritten
   end
 
   def includes?(path)
-    Rewritten.redis.hget("from:#{path}", :to)
+
+    result = Rewritten.redis.hget("from:#{path.chomp('/')}", :to)
+    result = Rewritten.redis.hget("from:#{path.split('?')[0]}", :to) unless result
+
+    if result.nil? && translate_partial? && path.count('/') > 1
+      parts = path.split('/')
+      includes?( parts.slice(0,parts.size-1).join('/') )
+    else
+      result
+    end
+
   end
 
   # return the number of froms

data/test/rack/rewritten_canonical_test.rb

@@ -0,0 +1,65 @@
+require 'test_helper'
+
+describe Rack::Rewritten::Canonical do
+
+  def call_args(overrides={})
+    {'HTTP_HOST' => 'www.example.org',
+      'REQUEST_URI' => '/foo/with/params',
+      'SCRIPT_INFO'=> '',
+      'PATH_INFO' => '/foo/with/params',
+      'QUERY_STRING' => '',
+      'SERVER_PORT' => 80,
+      'rack.input' => '',
+      'rack.url_scheme' => 'http'}.merge(overrides)
+  end
+  
+  def request_url(url, params={})
+    call_args.merge({'REQUEST_URI' => url, 'PATH_INFO' => url}.merge(params) )
+  end
+
+
+  before do
+    Rewritten.add_translation '/foo/bar', '/products/1'
+    Rewritten.add_translation '/foo/baz', '/products/1'
+    Rewritten.add_translation '/foo/with/params', '/products/2?w=1'
+
+    @html_body = <<-HTML
+    <html>
+      <head></head>
+      <body>Hello</body>
+    </html>
+    HTML
+    @rack = Rack::Rewritten::Canonical.new(lambda{|env| [200, {'Content-Type' => 'text/html'}, [@html_body]]})
+
+  end
+
+  describe 'canonical tag' do 
+
+    it "must add the canonical tag to current translation if on non-translated page" do
+      res,env,body = @rack.call request_url('/products/1')
+      html = body.join("")
+      html.must_include  '<link rel="canonical" href="http://www.example.org/foo/baz"/>'
+    end
+
+    it "the target of the canonical tag must have no params" do
+      res,env,body = @rack.call request_url('/products/1').merge('QUERY_STRING' => 'some=param' )
+      html = body.join("")
+      html.must_include  '<link rel="canonical" href="http://www.example.org/foo/baz"/>'
+    end
+
+    describe 'context partial' do
+      before{ Rewritten.translate_partial = true }
+      after{ Rewritten.translate_partial = false }
+
+      it "must add the canonical tag to pages with tail" do
+        res,env,body = @rack.call request_url('/products/1/with/tail')
+        html = body.join("")
+        html.must_include  '<link rel="canonical" href="http://www.example.org/foo/baz"/>'
+      end
+
+    end
+
+  end
+
+end
+

data/test/rack/rewritten_url_test.rb

@@ -8,6 +8,7 @@ describe Rack::Rewritten::Url do
       'SCRIPT_INFO'=> '',
       'PATH_INFO' => '/foo/with/params',
       'QUERY_STRING' => '',
+      'SERVER_PORT' => 80,
       'rack.input' => '',
       'rack.url_scheme' => 'http'}.merge(overrides)
   end
@@ -62,18 +63,20 @@ describe Rack::Rewritten::Url do
 
     describe "partial translation" do
 
-      before {
+      before do 
         @request_str = '/foo/baz/with_tail'
         @env = request_url(@request_str)
-        @html_body = <<-HTML
-        <html>
-          <head></head>
-          <body>Hello</body>
-        </html>
-        HTML
-        }
+        Rewritten.translate_partial = true 
+      end 
+      
+      after do
+        Rewritten.translate_partial = false
+      end
+
+      after{ Rewritten.translate_partial = false }
 
       it "must not translate partials by default" do
+        Rewritten.translate_partial = false
         @app.expect :call, [200, {'Content-Type' => 'text/plain'},[""]], [Hash]
         ret = @rack.call @env
         @app.verify
@@ -81,21 +84,14 @@ describe Rack::Rewritten::Url do
       end
 
       it "must translate partials if enabled" do
-        @rack = Rack::Rewritten::Url.new(@app) do
-          self.translate_partial = true
-        end
-
+        Rewritten.translate_partial = true 
         @app.expect :call, [200, {'Content-Type' => 'text/html'},[]], [Hash]
-
         ret = @rack.call @env
         @app.verify
         @env['PATH_INFO'].must_equal '/products/1/with_tail'
       end
 
       it "must work on long, non-translated urls with partial translation enabled" do
-        @rack = Rack::Rewritten::Url.new(@app) do
-          self.translate_partial = true
-        end
 
         @app.expect :call, [200, {'Content-Type' => 'text/html'},[]], [Hash]
 
@@ -107,21 +103,8 @@ describe Rack::Rewritten::Url do
         @env['PATH_INFO'].must_equal url
       end
 
-      it "must add the canonical tag to pages with trail" do
-
-        @rack = Rack::Rewritten::Url.new(lambda{|env| [200, {'Content-Type' => 'text/html'}, [@html_body]]}) do
-          self.translate_partial = true
-        end
-
-        res,env,body = @rack.call(@env)
-        html = body.join("")
-        html.must_include  '<link rel="canonical" href="/foo/baz"/>'
-      end
-
+    
       it "won't translate segments not by separated by slashes" do
-        @rack = Rack::Rewritten::Url.new(@app) do
-          self.translate_partial = true
-        end
         @app.expect :call, [200, {'Content-Type' => 'text/plain'},[""]], [Hash]
         ret = @rack.call @env=request_url('/foo/bazzling')
         @app.verify
@@ -129,15 +112,11 @@ describe Rack::Rewritten::Url do
       end
 
       it "must carry on trail when redirecting" do
-        @rack = Rack::Rewritten::Url.new(@app) do
-          self.translate_partial = true
-        end
         ret = @rack.call request_url('/foo/bar/with_tail', 'QUERY_STRING' => 'w=1')
         @app.verify
         ret[0].must_equal 301
         ret[1]['Location'].must_equal "http://www.example.org/foo/baz/with_tail?w=1"
       end
-
     end
 
     describe "/ behavior" do

data/test/rewritten_test.rb

@@ -11,7 +11,7 @@ describe Rewritten do
     Rewritten.add_translation('/with/flags  [L12]', '/to3')
   }
 
-  describe 'Rewritten.get_current_translation' do
+  describe 'Rewritten.get_current_translation for to-target' do
 
     it "must give current_translation" do
       Rewritten.get_current_translation('/to').must_equal '/from2'
@@ -36,6 +36,31 @@ describe Rewritten do
 
   end
 
+  describe 'get_infinitive (always from conjugated for -> for)' do
+
+    it 'must remove query parameters from non translatable foreign path' do
+      Rewritten.infinitive('/no/translation').must_equal '/no/translation'
+      Rewritten.infinitive('/no/translation/').must_equal '/no/translation'
+      Rewritten.infinitive('/no/translation?some=param&another=2').must_equal '/no/translation'
+    end
+
+    it 'must remove query parameters from translatable foreign path' do
+      Rewritten.infinitive('/from').must_equal '/from2'
+      Rewritten.infinitive('/from/').must_equal '/from2'
+      Rewritten.infinitive('/from?some=param&another=2').must_equal '/from2'
+    end
+
+    describe 'context translate partial' do
+      before{ Rewritten.translate_partial = true }
+      after{ Rewritten.translate_partial = false }
+
+      it 'must remove trail if translpartial is enabled' do
+        Rewritten.infinitive('/from/with/trail?and=param').must_equal '/from2'
+      end
+    end
+
+  end
+
   describe "basic interface" do
 
     it "must translate froms" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rewritten
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Kai Rubarth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-15 00:00:00.000000000 Z
+date: 2014-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-namespace
@@ -149,6 +149,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - HISTORY.rdoc
 - README.md
@@ -158,6 +159,7 @@ files:
 - bin/rewritten-import.rb
 - bin/rewritten-web.rb
 - config.ru
+- lib/rack/canonical.rb
 - lib/rack/dummy.rb
 - lib/rack/html.rb
 - lib/rack/record.rb
@@ -197,6 +199,7 @@ files:
 - lib/rewritten/server/views/translations.erb
 - lib/rewritten/version.rb
 - rewritten.gemspec
+- test/rack/rewritten_canonical_test.rb
 - test/rack/rewritten_html_test.rb
 - test/rack/rewritten_url_test.rb
 - test/rewritten/document_test.rb