RubyGems - tranzu-rack-tranzu - Versions diffs - 0.0.1 - Mend

tranzu-rack-tranzu 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (4) hide show

data/README ADDED Viewed

File without changes

data/lib/rack/tranzu.rb ADDED Viewed

@@ -0,0 +1,107 @@
+require 'nokogiri'
+require 'lib/text_block'
+module Rack
+  class Tranzu
+    def initialize(app, site_key)
+      @app, @site_key = app, site_key
+    end
+    def call(env)
+      status, headers, response = @app.call(env)
+      if headers["Content-Type"].include? "text/html"
+        translate_page(status, headers, response)
+      else
+        [status, headers, response]
+      end
+    end
+    private
+    def translate_page(status, headers, response)
+      doc = parse_web_page(response)
+      doc.traverse do |dom_element|
+        if dom_element.text? && !dom_element.inner_text.blank?
+          record_text_block_if_new(dom_element.inner_text.strip)
+        end
+      end
+      doc.traverse do |dom_element|
+        if dom_element.text? && !dom_element.inner_text.blank?
+          replace_text_with_applicable_translations(dom_element)
+        end
+      end
+      html = serialized_html(doc)
+      [status, headers, [html]]
+    end
+    def serialized_html(doc)
+      html = doc.search("html").to_html
+      html.gsub(/\>\n\</,"><")
+    end
+    def replace_text_with_applicable_translations(text_element)
+      new_text = text_element.inner_text
+      all_stored_text_blocks.each do |key, value|
+        new_text.gsub!(/#{key}/, value) if value # TODO: escape key for Regexp
+      end
+      text_element.parent.content = new_text
+    end
+    def parse_web_page(response)
+      all_content = ""
+      response.each do |content|
+        all_content << content
+      end
+      doc = Nokogiri::HTML(all_content)
+    end
+    def all_stored_text_blocks
+      unless @mapping
+        @mapping = {}
+        text_blocks = TextBlock.find(:all, :params => {:site_key => @site_key})
+        text_blocks.each do |text_block|
+          @mapping[text_block.source_text] = text_block.target_text
+        end
+      end
+      @mapping
+    end
+    def text_blocks_with_translations
+      all_stored_text_blocks.delete_if{|key, value| value.nil?}
+    end
+    def untranslated_text_blocks
+      all_stored_text_blocks.select{|key, value| value.nil?}.map{|pair| pair.first}
+    end
+    def record_text_block_if_new(source_text)
+      text_block = TextBlock.find(:one, :params => {:site_key => @site_key, :source_text => source_text})
+      unless text_block
+        text_block = TextBlock.create(:site_key => @site_key, :source_text => source_text)
+        unless text_block
+          raise Exception.new("unable to create text block")
+        end
+      end
+    end
+    def record_text_block_with_translation(source_text, target_text)
+      text_block = TextBlock.find(:one, :params => {:site_key => @site_key, :source_text => source_text})
+      text_block ||= TextBlock.new(:site_key => @site_key, :source_text => source_text)
+      text_block.target_text = target_text
+      unless text_block.save
+        raise Exception.new("unable to save text block")
+      end
+    end
+  end
+end

data/spec/tranzu_spec.rb ADDED Viewed

@@ -0,0 +1,99 @@
+require 'rack'
+require 'lib/text_block'
+require 'lib/rack/tranzu'
+describe Rack::Tranzu do
+  def delete_all_text_blocks
+    text_blocks = TextBlock.find(:all)
+    text_blocks.each do |text_block|
+      text_block.destroy
+    end
+  end
+  before (:each) do
+    delete_all_text_blocks
+    @response_strings = []
+    @client_app = lambda {|env| [200, {'Content-Type' => 'text/html'}, @response_strings] }
+    @app = Rack::Tranzu.new(@client_app, "1234ABCD")
+    @app.send(:record_text_block_with_translation, "This is an example of already translated text.", "Se ejemplifica texto ya traducido.")
+  end
+  it "should store all text blocks returned by the web site" do
+    delete_all_text_blocks # re-delete items for this test case only
+    @response_strings << "<html><body><p>This is an example of already translated text.</p><p>This is an example of untranslated text.</p><p>This is another example of untranslated text.</p></body></html>"
+    response = Rack::MockRequest.new(@app).get('/', 'HTTP_ACCEPT' => 'text/html')
+    source_text_items = TextBlock.find(:all).map {|text_block_translations| text_block_translations.source_text}
+    source_text_items.sort.should == ["This is an example of already translated text.", "This is an example of untranslated text.", "This is another example of untranslated text."].sort
+  end
+  it "should identify stored text blocks with no corresponding translations" do
+    @response_strings << "<html><body><p>This is an example of already translated text.</p><p>This is an example of untranslated text.</p><p>This is another example of untranslated text.</p></body></html>"
+    response = Rack::MockRequest.new(@app).get('/', 'HTTP_ACCEPT' => 'text/html')
+    untranslated_text_blocks = @app.send(:untranslated_text_blocks)
+    untranslated_text_blocks.sort.should == ["This is an example of untranslated text.", "This is another example of untranslated text."].sort
+  end
+  it "should identify stored text blocks with corresponding translations" do
+    @response_strings << "<html><body><p>This is an example of already translated text.</p><p>This is an example of untranslated text.</p><p>This is another example of untranslated text.</p></body></html>"
+    response = Rack::MockRequest.new(@app).get('/', 'HTTP_ACCEPT' => 'text/html')
+    text_blocks_with_translations = @app.send(:text_blocks_with_translations)
+    text_blocks_with_translations.should == {"This is an example of already translated text." => "Se ejemplifica texto ya traducido."}
+  end
+  it "should pass-through stored text blocks that lack translated equivalents" do
+    @response_strings << "<html><body><p>This is an example of untranslated text.</p></body></html>"
+    response = Rack::MockRequest.new(@app).get('/', 'HTTP_ACCEPT' => 'text/html')
+    response.body.should == @response_strings[0]
+  end
+  it "should replace stored text blocks with translated equivalents" do
+    @response_strings << "<html><body><p>This is an example of already translated text.</p></body></html>"
+    response = Rack::MockRequest.new(@app).get('/', 'HTTP_ACCEPT' => 'text/html')
+    response.body.should == "<html><body><p>Se ejemplifica texto ya traducido.</p></body></html>"
+  end
+  it "should replace text blocks with translated equivalents and leave those that lack translated equivalents untranslated" do
+    @response_strings << "<html><body><p>This is an example of already translated text.</p><p>This is an example of untranslated text.</p></body></html>"
+    response = Rack::MockRequest.new(@app).get('/', 'HTTP_ACCEPT' => 'text/html')
+    response.body.should == "<html><body><p>Se ejemplifica texto ya traducido.</p><p>This is an example of untranslated text.</p></body></html>"
+  end
+  it "should not translate any text blocks if the site id is not valid" do
+    @app = Rack::Tranzu.new(@client_app, "X1234ABCD")
+    source_text = "<html><body><p>This is an example of already translated text.</p><p>This is an example of untranslated text.</p></body></html>"
+    @response_strings << source_text
+    response = Rack::MockRequest.new(@app).get('/', 'HTTP_ACCEPT' => 'text/html')
+    response.body.should == source_text
+  end
+  describe "translating is partial to html" do
+    it "should attempt to translate html requests" do
+      @response_strings << "<html><body><p>This is an example of already translated text.</p></body></html>"
+      @app.should_receive(:translate_page).and_return([200, {'Content-Type' => 'text/html'}, @response_strings])
+      response = Rack::MockRequest.new(@app).get('/', 'HTTP_ACCEPT' => 'text/html')
+    end
+    it "should not attempt to translate non-html requests" do
+      @response_strings << "<adam>adam is studly</adam>"
+      @client_app = lambda {|env| [201, {'Content-Type' => 'text/xml', 'Content-Encoding' => 'gzip'}, @response_strings] }
+      @app = Rack::Tranzu.new(@client_app, "1234ABCD")
+      @app.should_not_receive(:translate_page)
+      response = Rack::MockRequest.new(@app).get('/', 'HTTP_ACCEPT' => 'text/xml')
+      response.body.should == @response_strings[0]
+      response.status.should == 201
+      response.headers.should == {'Content-Type' => 'text/xml', 'Content-Encoding' => 'gzip'}
+    end
+  end
+  it "should not strip out linefeeds from html"
+  it "should not strip out leading or trailing whitespace from text nodes"
+  it "should not change DOCTYPE if it exists in the application response'"
+  it "should not add DOCTYPE if it is not in the application response"
+end

metadata ADDED Viewed

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: tranzu-rack-tranzu
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Reitano
+- Adam King
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2009-09-01 00:00:00 -07:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  type: :runtime
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: "0.4"
+    version:
+description: Website translation middleware.
+email: tranzuapp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README
+- lib/rack/tranzu.rb
+has_rdoc: false
+homepage: http://github.com/tranzu/rack-tranzu
+licenses:
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+requirements: []
+rubyforge_project:
+rubygems_version: 1.3.5
+signing_key:
+specification_version: 2
+summary: Website translation middleware.
+test_files:
+- spec/tranzu_spec.rb