i18n_link 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Johannes Barre
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,52 @@
+h1. A helper for links in your translations
+
+h2. Why?
+
+I18n is backed right into Rails, and it's great. But if you want to place links inside your translated copies, things get a little messy.
+You need to specify the label of your links separately from the rest of the copy. Writing HTML in your translations is even worse.
+
+<pre><code>en:
+  copy: "Did you read the %{guide_link}?"
+  copy_guide_link: "Rails I18n guide"</code></pre>
+
+<pre><code><%=raw t("copy", guide_link: link_to(t("copy_guide_link"), "http://guides.rubyonrails.org/i18n.html")) %></code></pre>
+
+Wouldn't it be much nicer and easier to understand for your translator to have the whole copy in single label? I18n_link lets you do that:
+
+<pre><code>en:
+  copy: "Did you read the %{guide_link:Rails I18n guide}?"</code></pre>
+
+<pre><code><%=t_link "copy", guide_link: "http://guides.rubyonrails.org/i18n.html" %></code></pre>
+
+You may have noticed in the example above, that @t_link@ doesn't require @raw@ anymore. Of course, all HTML in the translation
+gets properly escaped, so you don't have to worry about XSS.
+
+h2. Installation
+
+Just add the following line to your Gemfile:
+
+<pre><code>gem 'i18n_link'</code></pre>
+
+h2. Usage
+
+You may have as many links inside your translations as you like, and normal interpolations are possible as well:
+
+<pre><code>en:
+  copy: "Did you read the %{guide:Rails I18n guide}? It has more than %{advises} useful advises. You may fork the repo at {repo:github}."</code></pre>
+
+<pre><code><%=t_link "copy", guide: "http://guides.rubyonrails.org/i18n.html", advices: 100, repo: "https://github.com/lifo/docrails/tree/master/railties/guides" %></code></pre>
+
+You may also specify options for link_to. Just give a second option named like the link + @_options@
+
+<pre><code><%=t_link "copy", guide_link: "http://guides.rubyonrails.org/i18n.html", guide_link_options: {target: '_blank', class: "important"} %></code></pre>
+
+h2. isit18.com?
+
+Sorry, I'm using Ruby 1.9.2 and didn't took the time to port i18n_link back to Ruby 1.8. You either might update to Ruby 1.9 as well
+or make the port yourself. It's probably a mater of minutes to do so, since the lib is small. Send me a pull request, if you have a port!
+
+h2. Abandoned & outdated?
+
+Everybody hates old and outdated gems, which don't work on with the latest Rails or Ruby version or haven't been updated for ages. 
+Sadly, rubygems is full of such gems. If you improved i18n_link, send me a pull request. If I have not time to support the lib
+anymore, I will happily hand the project over to a new maintainer.

data/lib/i18n_link.rb

@@ -0,0 +1,5 @@
+require 'i18n_link/helper'
+
+ActiveSupport.on_load(:action_view) do
+  include I18nLink::Helper
+end

data/lib/i18n_link/helper.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+
+module I18nLink
+  module Helper
+    include ActionView::Helpers::UrlHelper
+    include ERB::Util
+    
+    def t_link(translation, options = {})
+      options.symbolize_keys!
+      string = h(t(translation)).gsub(/%\{[^}]+\}/) do |tl|
+        if tl.include?(":")
+          token, label = tl[2..-2].split(":", 2)
+          addr = options.delete(token.to_sym)
+          if addr.nil?
+            tl
+          else
+            link_options = options.delete("#{token}_options".to_sym)
+            link_to(label, addr, link_options)
+          end
+        else
+          tl
+        end
+      end
+      raw(string % options)
+    end
+  end
+end

data/spec/i18n_link_helper_spec.rb

@@ -0,0 +1,55 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+require 'i18n_link'
+
+describe I18nLink::Helper, "#t_link" do
+  before do
+    I18n.backend.store_translations(:en, :test1 => "I'm containing a %{link:link to Rails} in the middle.")
+    I18n.backend.store_translations(:de, :test1 => "Ich enthalte einen %{link:Link zu Rails} in der Mitte.")
+    
+    @view = ActionView::Base.new
+    @controller = ActionController::Base.new
+    @view.controller = @controller
+  end
+  
+  after do
+    I18n.locale = :en
+  end
+  
+  it "should insert the link into the string" do
+    @view.t_link("test1", :link => "http://www.rubyonrails.org").should == 'I\'m containing a <a href="http://www.rubyonrails.org">link to Rails</a> in the middle.'
+  end
+  
+  it "should insert the link into the German translation" do
+    I18n.locale = :de
+    @view.t_link("test1", :link => "http://www.rubyonrails.org").should == 'Ich enthalte einen <a href="http://www.rubyonrails.org">Link zu Rails</a> in der Mitte.'
+  end
+  
+  it "should allow link options to be set" do
+    @view.t_link("test1", :link => "http://www.rubyonrails.org", :link_options => {:target => "_blank"}).should == 'I\'m containing a <a href="http://www.rubyonrails.org" target="_blank">link to Rails</a> in the middle.'
+  end
+  
+  it "should raise an error, if the link_options arn't an Hash" do
+    expect {@view.t_link("test1", :link => "http://www.rubyonrails.org", :link_options => 'target="_blank"')}.to raise_exception
+  end
+  
+  it "should mark the result as html safe" do
+    @view.t_link("test1", :link => "http://www.rubyonrails.org").html_safe?.should be_true
+  end
+  
+  it "should escape all html in the translation" do
+    I18n.backend.store_translations(:en, :test2 => "<a href=\"hax0r\"> & %{link:link -> Rails} in <b>the middle</b>.")
+    @view.t_link("test2", :link => "http://www.rubyonrails.org").should == '&lt;a href=&quot;hax0r&quot;&gt; &amp; <a href="http://www.rubyonrails.org">link -&gt; Rails</a> in &lt;b&gt;the middle&lt;/b&gt;.'
+  end
+  
+  it "should also work with 2 links" do
+    I18n.backend.store_translations(:en, :test3 => "I like %{link1:rails} and %{link2:github}.")
+    @view.t_link("test3", :link1 => "http://www.rubyonrails.org", :link2 => "http://www.github.com").should == 'I like <a href="http://www.rubyonrails.org">rails</a> and <a href="http://www.github.com">github</a>.'
+  end
+  
+  it "should allow normal I18n replacements" do
+    I18n.backend.store_translations(:en, :test4 => "I'm containing a %{link:link to Rails} in the %{position}.")
+    @view.t_link("test4", :link => "http://www.rubyonrails.org", :position => "middle").should == 'I\'m containing a <a href="http://www.rubyonrails.org">link to Rails</a> in the middle.'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+require 'action_pack'
+require 'action_controller'
+require 'action_view'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: i18n_link
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Johannes Barre
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-12 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.6.0
+  type: :development
+  version_requirements: *id002
+description: 
+email: igel@igels.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- MIT-LICENSE
+- README.textile
+- lib/i18n_link.rb
+- lib/i18n_link/helper.rb
+- spec/i18n_link_helper_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/igel/i18n_link
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: A helper for links in your translations
+test_files: 
+- spec/i18n_link_helper_spec.rb
+- spec/spec_helper.rb