it 0.2.5 → 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c01da0126bc0960aa7ab5e43f96517aa82eb289d
+  data.tar.gz: 1b98dfc90fa506312640cdbb7f900b3534c3d780
+SHA512:
+  metadata.gz: 6146d71238cef1aa408fd743d68e371bcf3fb91dde5e32e94249d236640229af060a8c83987df01f8dd14f76e7ae2a628744921689405499d3960a960e157925
+  data.tar.gz: 34b7df378be392ecd5fa29ee174be79be7031687c25cdbbebe4bab81e6063a05edaf194b8b9dc32e66ad0ab217733e5dc0353e7eeb97fc9b18e2a5bd8230f70c

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Since 0.2.5
+
+* Make `It.plain` work with empty content [#14](https://github.com/iGEL/it/pull/14)  
+  *Emil Sågfors*
+* Pass though `:scope` & `:default` [#13](https://github.com/iGEL/it/pull/13)  
+  *Emil Sågfors*

data/README.md

@@ -0,0 +1,124 @@
+[![Code Climate](http://img.shields.io/codeclimate/github/iGEL/it.svg?style=flat)](https://codeclimate.com/github/iGEL/it)
+[![Build Status](http://img.shields.io/travis/iGEL/it/master.svg?style=flat)](https://travis-ci.org/iGEL/it)
+[![Coverage](http://img.shields.io/coveralls/iGEL/it/master.svg?style=flat)](https://coveralls.io/r/iGEL/it)
+[![Rubygems](http://img.shields.io/gem/v/it.svg?style=flat)](http://rubygems.org/gems/it)
+[![Github Issues](http://img.shields.io/github/issues/iGEL/it.svg?style=flat)](https://travis-ci.org/iGEL/it)
+[![Dependency Status](http://img.shields.io/gemnasium/iGEL/it.svg?style=flat)](https://gemnasium.com/iGEL/it)
+
+Tested against Ruby 2.2, 2.1, 2.0, head, rbx, and jruby and Rails 4.2, 4.1, and 3.2
+
+What is **it**?
+=============
+
+I18n is baked right into Rails, and it's great. But if you want to place markup or 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.
+
+```yaml
+en:
+  copy: "If you are already registered, %{login_link}!"
+  copy_login_link: "please sign in"
+```
+
+```erb
+<%=raw t("copy", login: link_to(t("copy_login_link"), login_path)) %>
+```
+
+Wouldn't it be much nicer and easier to understand for your translator to have the whole copy in single label? **it** lets you do that:
+
+```yaml
+en:
+  copy: "If you are already registered, %{login_link:please sign in}!"
+```
+
+```erb
+<%=it "copy", login_link: login_path %>
+```
+
+You may have noticed in the example above, that **it** doesn't require `raw` anymore. Of course, all HTML in the translation gets properly escaped, so you don't have to worry about XSS.
+
+Installation
+------------
+
+Just add the following line to your Gemfile & run `bundle install`:
+
+```ruby
+gem 'it'
+```
+
+Usage
+-----
+
+You may have as many links inside your translations as you like, and normal interpolations are possible as well:
+
+```yaml
+en:
+  copy: "Read the %{guide:Rails I18n guide} for more than %{advises} advises. Fork it at {repo:github}."
+```
+
+```erb
+<%=it "copy",
+  guide: It.link("http://guides.rubyonrails.org/i18n.html"),
+  advices: 100,
+  repo: It.link("https://github.com/lifo/docrails/tree/master/railties/guides") %>
+```
+
+As you see above, unless the interpolation name is `link` or starts with `link_` or ends with `_link`, you need to call `It.link` to create a link. The advantage of `It.link`: You may specify options like you would with `link_to`:
+
+```erb
+<%=it "copy",
+  link: It.link("http://rubyonrails.org", target: '_blank', class: "important") %>
+```
+
+You may pass any kind of object accepted by `link_to` as the link target, so your loved named routes like `article_path(id: article.id)` will all work fine.
+
+Want to introduce some markup into your sentences? **it** will help you:
+
+```yaml
+en:
+  advantages: There are %{b:many advantages} for registered users!
+```
+
+```erb
+<%=it "advantages", b: It.tag(:b, class: "red") %>
+```
+
+Even nested interpolations are possible:
+
+```yaml
+en:
+  copy: "Want to contact %{user}%? %{link:send %{b:%{user} a message}}!"
+```
+
+```erb
+<%=it "copy", link: "mailto:igel@igels.net", user: 'iGEL', b: It.tag(:b) %>
+```
+
+To use **it** outside of the view layer, just use `It.it`:
+
+```ruby
+flash[:notice] = It.it('flash.invitation_accepted_already', link: root_path)
+```
+
+If you would like to use the same translations in your html and plain text mails, you will like the `It.plain` method:
+```yaml
+en:
+  mail_copy: "Do you like %{link:Rails}?"
+```
+
+```erb
+https://github.com/lifo/docrails/tree/master/railties/guides
+<%= it "mail_copy", link: It.link("http://www.rubyonrails.org/") %>
+
+Plain mail:
+<%= it "mail_copy", link: It.plain("%s[http://www.rubyonrails.org/]") %>
+```
+
+The `%s` will be replaced with the label, in the example with Rails. You could provide any other string containing `%s`. The default is just `%s`, so it will return only the label itself.
+
+Contribute
+----------
+
+* Fork it
+* Create a feature branch (`git checkout -b my-new-feature`)
+* Create one or more failing specs. If you change code (feature or bug), I won't accept a pull request unless you changed specs.
+* Fix the specs by implementing the feature/bug fix
+* Push and open a pull request

data/Rakefile

@@ -1,5 +1,10 @@
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'reek/rake/task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+Reek::Rake::Task.new
 
 task default: :spec

data/it.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'it/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'it'
+  spec.version       = It::VERSION
+  spec.authors       = ['Johannes Barre']
+  spec.email         = ['igel@igels.net']
+
+  spec.summary       = 'A helper for links and other html tags in your translations'
+  spec.homepage      = 'https://github.com/igel/it'
+  spec.license       = 'MIT'
+
+  spec.files         = %w(MIT-LICENSE README.md Rakefile Gemfile CHANGELOG.md it.gemspec) + Dir['lib/**/*.rb']
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'actionpack', '>= 3.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'nokogiri'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'reek'
+end

data/lib/it.rb

@@ -4,6 +4,7 @@ require 'it/tag'
 require 'it/link'
 require 'it/plain'
 require 'it/helper'
+require 'it/version'
 
 ActiveSupport.on_load(:action_view) do
   include It::Helper
@@ -13,15 +14,17 @@ end
 module It
   # It outside of your views. See documentation at Helper#it
   def self.it(identifier, options = {})
-    options.stringify_keys!
-    Parser.new(I18n.t(identifier, locale: (options["locale"] || I18n.locale), default: options['default']), options).process
+    Parser.new(
+      I18n.t(identifier, Parser.backend_options(options)),
+      options.stringify_keys
+    ).process
   end
 
   # Creates a new link to be used in +it+.
   #
-  # * +href+: The url for the link. You may specify it as a String or as a named route like +article_path+. It's not possible to specify
-  #   a Hash like <code>{controller: "articles", action: "index"}</code> directly. Use the +url_for+ helper, if you would like to specify your
-  #   links like that.
+  # * +href+: The url for the link. You may specify it as a String or as a named route like +article_path+. It's not
+  #   possible to specify a Hash like <code>{controller: "articles", action: "index"}</code> directly. Use the
+  #   +url_for+ helper, if you would like to specify your links like that.
   # * +options+: The options as an Hash. Use them like you would with +link_to+. <em>(optional)</em>
   def self.link(href, options = {})
     It::Link.new(href, options)
@@ -29,9 +32,9 @@ module It
 
   # Creates a new plain replacement to be used in +it+.
   #
-  # * +template+: A string to be used as the template. An example would be <code>"%s[http://www.rubyonrails.org]"</code>. Defaults to
-  #   <code>"%s"</code>. <em>(optional)</em>
-  def self.plain(template = "%s")
+  # * +template+: A string to be used as the template. An example would be
+  #   <code>"%s[http://www.rubyonrails.org]"</code>. Defaults to <code>"%s"</code>. <em>(optional)</em>
+  def self.plain(template = '%s')
     It::Plain.new(template)
   end
 

data/lib/it/helper.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-
 module It
   # The helper will be available in the views.
   module Helper
@@ -15,32 +13,36 @@ module It
     #
     #   <%=it("translation", login_link: It.link(login_path))
     #
-    # If your link doesn't require additional attributes and the name is +link+, starts with +link_+ or ends with +_link+,
-    # you may specify the argument as a String or your helper.
+    # If your link doesn't require additional attributes and the name is +link+, starts with +link_+ or ends with
+    # +_link+, you may specify the argument as a String or your helper.
     #
     #   # translation: "Already signed up? %{login_link:Sign in}!"
     #
     #   <%=it("translation", login_link: login_path)
     #
-    # You may have as many tags inside of one translation as you like, and you even may nest them into each other. Also you
-    # may specify arguments to links and other tags.
+    # You may have as many tags inside of one translation as you like, and you even may nest them into each other.
+    # Also you may specify arguments to links and other tags.
     #
-    #   # translation: "The top contributor of %{wiki_link:our wiki} is currently %{user_link:%{b:%{name}}}. Thanks a lot, %{name}!"
+    #   # translation: "The top %{wiki_link:our wiki} contributor is %{user_link:%{b:%{name}}}. Thanks %{name}!"
     #
-    #   <%= it("translation", wiki_link: wiki_path, name: user.name, b: It.tag(:b, class: "user"), user_link: It.link(user_path(user), target: "_blank"))
+    #   <%= it("translation", wiki_link: wiki_path, name: user.name, b: It.tag(:b, class: "user"),
+    #       user_link: It.link(user_path(user), target: "_blank"))
     #
-    # I recommend to limit the use of +it+ as much as possible. You could use it for <code><div></code> or <code><br /></code>, but I think,
-    # things seperated over multiple lines should go into different translations. Use it for inline tags like links, <code><span></code>,
-    # <code><b></code>, <code><i></code>, <code><em></code> or <code><strong></code>.
+    # I recommend to limit the use of +it+ as much as possible. You could use it for <code><div></code> or
+    # <code><br /></code>, but I think, things seperated over multiple lines should go into different translations. Use
+    # it for inline tags like links, <code><span></code>, <code><b></code>, <code><i></code>, <code><em></code> or
+    # <code><strong></code>.
     #
-    # It's currently not possible to specify your links as an Hash. Use the +url_for+ helper, if you want to specify your
-    # link target as an Hash.
+    # It's currently not possible to specify your links as an Hash. Use the +url_for+ helper, if you want to specify
+    # your link target as an Hash.
     #
     # If you need to use it outside of your views, use +It.it+.
     #
     def it(identifier, options = {})
-      options.stringify_keys!
-      It::Parser.new(t(identifier, locale: (options["locale"] || I18n.locale)), options).process
+      It::Parser.new(
+        t(identifier, It::Parser.backend_options(options)),
+        options.stringify_keys
+      ).process
     end
   end
 end

data/lib/it/interpolation.rb

@@ -1,39 +1,51 @@
 module It
+  # Contains one interpolation and will delegate the work to the It::Tag (or subclass) or
+  # ERB::Util.h
   class Interpolation
-    attr_accessor :key, :label, :values
-    
+    attr_accessor :key, :label, :value
+
     def initialize(string, values)
       self.key, self.label = string[2..-2].split(':', 2)
-      self.values = values
+      validate_key_presence(values)
 
+      self.value = values[key]
       convert_links
     end
-    
+
     def process
-      check_input_values
+      validate_value_for_arguments
 
-      if label # Normal tags
-        values[key].process(label.html_safe)
-      elsif values[key].is_a?(It::Tag) # Empty tag
-        values[key].process
+      if value.is_a?(It::Tag) # Empty tag
+        process_it_tag
       else # Normal interpolations, as I18n.t would do it.
-        ERB::Util.h(values[key])
+        ERB::Util.h(value)
       end
     end
 
     private
+
     # Convert keys with String arguments into It::Links, if they are named link, link_* or *_link
     def convert_links
-      if key =~ /(\Alink\Z|_link\Z|\Alink_)/ && values[key].is_a?(String)
-        self.values[key] = It::Link.new(values[key])
+      if key =~ /(\Alink\z|_link\z|\Alink_)/ && value.is_a?(String)
+        self.value = It::Link.new(value)
+      end
+    end
+
+    def process_it_tag
+      if label
+        value.process(label.html_safe)
+      else
+        value.process
       end
     end
 
-    def check_input_values
-      if !values.has_key?(key)
-        raise KeyError, "key{#{key}} not found"
-      elsif label && !values[key].is_a?(It::Tag)
-        raise ArgumentError, "key{#{key}} has an argument, so it cannot resolved with a #{values[key].class}"
+    def validate_key_presence(values)
+      fail KeyError, "key{#{key}} not found" unless values.key?(key)
+    end
+
+    def validate_value_for_arguments
+      if label && !value.is_a?(It::Tag)
+        fail ArgumentError, "key{#{key}} has an argument, so it cannot resolved with a #{value.class}"
       end
     end
   end

data/lib/it/link.rb

@@ -2,17 +2,18 @@ module It
   # A class for links
   class Link < Tag
     include ActionView::Helpers::UrlHelper
-    
+
     # See It.link for details. You can do everything there and save 6 characters.
     def initialize(href, options = {})
-      raise TypeError, "Invalid href given" unless href.is_a?(Hash) || href.is_a?(String)
+      fail TypeError, 'Invalid href given' unless [Hash, String].include?(href.class)
+
       super(:a, options)
       @href = href
     end
-    
+
     # Will be called from inside the helper to return the tag with the given content.
     def process(content)
       link_to(content, @href, @options)
     end
   end
-end
+end

data/lib/it/parser.rb

@@ -1,9 +1,14 @@
 module It
+  # Parses the string and replaces all interpolations accordingly.
   class Parser
     attr_accessor :string, :options
 
     INTERPOLATION_REGEXP = /%\{[^{}}]+\}/
 
+    def self.backend_options(options)
+      options.with_indifferent_access.slice(:default, :locale, :scope)
+    end
+
     def initialize(string, options)
       self.string = string
       self.options = options
@@ -14,8 +19,8 @@ module It
       escape_string
 
       # For deep nesting, we repeat the process until we have no interpolations anymore
-      while has_interpolation?
-        self.string.gsub!(INTERPOLATION_REGEXP) do |interpolation|
+      while contains_interpolation?
+        string.gsub!(INTERPOLATION_REGEXP) do |interpolation|
           Interpolation.new(interpolation, options).process
         end
       end
@@ -23,12 +28,19 @@ module It
     end
 
     private
-    def has_interpolation?
+
+    def contains_interpolation?
       string =~ INTERPOLATION_REGEXP
     end
 
     def handle_pluralization
-      self.string = I18n.backend.send(:pluralize, (options['locale'] || I18n.locale), string, options['count']) if string.is_a?(Hash) && options['count']
+      return if !string.is_a?(Hash) || !options.key?('count')
+
+      self.string = I18n.backend.send(:pluralize, locale, string, options['count'])
+    end
+
+    def locale
+      options['locale'] || I18n.locale
     end
 
     def escape_string

data/lib/it/plain.rb

@@ -1,12 +1,14 @@
 module It
+  # Handles replacements in non HTML templates (e.g. mails)
   class Plain < Tag
-    def initialize(template = "%s")
-      raise TypeError, "expected a String, got #{template.class}" unless template.is_a?(String)
+    def initialize(template = '%s')
+      fail TypeError, "expected a String, got #{template.class}" unless template.is_a?(String)
+
       @template = template
     end
-    
-    def process(content)
-      sprintf(@template, content)
+
+    def process(content = '')
+      format(@template, content)
     end
   end
-end
+end

data/lib/it/tag.rb

@@ -2,24 +2,25 @@ module It
   # A generic class for html tags.
   class Tag
     include ActionView::Helpers::TagHelper
-    
+
     attr_reader :tag_name, :options
-    
+
     # See It.tag for details. You can do everything there and save 6 characters.
     def initialize(tag_name, options = {})
-      raise TypeError, "tag_name must be specified as a String or Symbol" unless tag_name.is_a?(String) || tag_name.is_a?(Symbol)
-      raise TypeError, "options must be specified as a Hash" unless options.is_a?(Hash)
+      fail TypeError, 'tag_name must be a String or Symbol' unless [String, Symbol].include?(tag_name.class)
+      fail TypeError, 'options must be a Hash' unless options.is_a?(Hash)
+
       @tag_name = tag_name.to_sym
       @options = options.symbolize_keys
     end
-    
+
     # Will be called from inside the helper to return the tag with the given content.
     def process(content = nil) # :nodoc:
-      if content.nil?
-        tag(@tag_name, @options)
-      else
+      if content
         content_tag(@tag_name, content, @options)
+      else
+        tag(@tag_name, @options)
       end
     end
   end
-end
+end

data/lib/it/version.rb

@@ -0,0 +1,3 @@
+module It
+  VERSION = '0.8.0'
+end

metadata

@@ -1,121 +1,170 @@
 --- !ruby/object:Gem::Specification
 name: it
 version: !ruby/object:Gem::Version
-  version: 0.2.5
-  prerelease: 
+  version: 0.8.0
 platform: ruby
 authors:
 - Johannes Barre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-15 00:00:00.000000000 Z
+date: 2015-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
-email: igel@igels.net
+email:
+- igel@igels.net
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.textile
+extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- Gemfile
 - MIT-LICENSE
-- README.textile
+- README.md
 - Rakefile
-- Gemfile
+- it.gemspec
+- lib/it.rb
 - lib/it/helper.rb
+- lib/it/interpolation.rb
 - lib/it/link.rb
-- lib/it/plain.rb
 - lib/it/parser.rb
+- lib/it/plain.rb
 - lib/it/tag.rb
-- lib/it/interpolation.rb
-- lib/it.rb
-- spec/it/link_spec.rb
-- spec/it/interpolation_spec.rb
-- spec/it/plain_spec.rb
-- spec/it/parser_spec.rb
-- spec/it/helper_spec.rb
-- spec/it/tag_spec.rb
-- spec/spec_helper.rb
-- spec/it_spec.rb
+- lib/it/version.rb
 homepage: https://github.com/igel/it
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.6
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A helper for links and other html tags in your translations
-test_files:
-- spec/it/link_spec.rb
-- spec/it/interpolation_spec.rb
-- spec/it/plain_spec.rb
-- spec/it/parser_spec.rb
-- spec/it/helper_spec.rb
-- spec/it/tag_spec.rb
-- spec/it_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/README.textile

@@ -1,76 +0,0 @@
-"!https://codeclimate.com/github/iGEL/it.png!":https://codeclimate.com/github/iGEL/it "!https://travis-ci.org/iGEL/it.png!":https://travis-ci.org/iGEL/it (Tests Ruby 1.9.2, 1.9.3, 2.0.0, Rubinius and Jruby)
-
-h1. What is *it*?
-
-I18n is baked right into Rails, and it's great. But if you want to place markup or 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: "If you are already registered, %{login_link}!"
-  copy_login_link: "please sign in"</code></pre>
-
-<pre><code><%=raw t("copy", login: link_to(t("copy_login_link"), login_path)) %></code></pre>
-
-Wouldn't it be much nicer and easier to understand for your translator to have the whole copy in single label? *it* lets you do that:
-
-<pre><code>en:
-  copy: "If you are already registered, %{login_link:please sign in}!"</code></pre>
-
-<pre><code><%=it "copy", login_link: login_path %></code></pre>
-
-You may have noticed in the example above, that *it* 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 & run @bundle install@:
-
-<pre><code>gem 'it'</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><%=it "copy", guide: It.link("http://guides.rubyonrails.org/i18n.html"), advices: 100, repo: It.link("https://github.com/lifo/docrails/tree/master/railties/guides") %></code></pre>
-
-As you see above, unless the interpolation name is @link@ or starts with @_link@ or ends with @_link@, you need to call @It.link@ to create a link. The advantage of @It.link@: You may specify options like you would with @link_to@:
-
-<pre><code><%=it "copy", guide: It.link("http://guides.rubyonrails.org/i18n.html", target: '_blank', class: "important") %></code></pre>
-
-You may pass any kind of object accepted by @link_to@ as the link target, so your loved named routes like @article_path(id: article.id)@ will all work fine.
-
-Want to introduce some markup into your sentences? *it* will help you:
-
-<pre><code>en:
-  advantages: There are %{b:many advantages} for registered users!</code></pre>
-
-<pre><code><%=it "advantages", b: It.tag(:b, class: "red") %></code></pre>
-
-Even nested interpolations are possible:
-
-<pre><code>en:
-  copy: "Want to contact %{user}%? %{link:send %{b:%{user} a message}}!"</code></pre>
-
-<pre><code><%=it "copy", link: "mailto:igel@igels.net", user: 'iGEL', b: It.tag(:b) %></code></pre>
-
-If you would like to use the same translations in your html and plain text mails, you will like the @It.plain@ method:
-<pre><code>en:
-  mail_copy: "Do you like %{link:Rails}?"</code></pre>
-
-<pre><code>HTML mail:
-<%= it "mail_copy", link: It.link("http://www.rubyonrails.org/") %>
-
-Plain mail:
-<%= it "mail_copy", link: It.plain("%s[http://www.rubyonrails.org/]") %>
-</code></pre>
-
-The @%s@ will be replaced with the label, in the example with Rails. You could provide any other string containing @%s@. The default is just @%s@, so it will return only the label itself.
-
-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 *it* 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.
-
-h2. Broken English?
-
-I'm not a native speaker, so you'll probably find some spelling errors or clumsy sentences above. If you do, please send me a message.

data/spec/it/helper_spec.rb

@@ -1,138 +0,0 @@
-# encoding: UTF-8
-
-require 'spec_helper'
-require 'it'
-require 'active_support/core_ext/string'
-
-describe It::Helper, "#it" do
-  before do
-    I18n.backend.store_translations(:en, test1: "I have a %{link:link to Rails} in the middle.")
-    I18n.backend.store_translations(:de, test1: "Ich habe 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
-    expect(@view.it("test1", link: It.link("http://www.rubyonrails.org"))).to eq('I have 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
-    expect(@view.it("test1", link: It.link("http://www.rubyonrails.org"))).to eq('Ich habe einen <a href="http://www.rubyonrails.org">Link zu Rails</a> in der Mitte.')
-  end
-
-  it "should allow link options to be set" do
-    expect(@view.it("test1", link: It.link("http://www.rubyonrails.org", target: "_blank"))).to eq('I have a <a href="http://www.rubyonrails.org" target="_blank">link to Rails</a> in the middle.')
-  end
-
-  it "should support the plain thing" do
-    expect(@view.it("test1", link: It.plain("%s[http://www.rubyonrails.org]"))).to eq('I have a link to Rails[http://www.rubyonrails.org] in the middle.')
-  end
-
-  it "should parse other tags as well" do
-    expect(@view.it("test1", link: It.tag(:b, class: "classy"))).to eq('I have a <b class="classy">link to Rails</b> in the middle.')
-  end
-
-  it "should mark the result as html safe" do
-    expect(@view.it("test1", link: It.link("http://www.rubyonrails.org")).html_safe?).to 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>.")
-    expect(@view.it("test2", link: It.link("http://www.rubyonrails.org"))).to eq('&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}.")
-    expect(@view.it("test3", link1: It.link("http://www.rubyonrails.org"), link2: It.link("http://www.github.com"))).to eq('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 interpolations" do
-    I18n.backend.store_translations(:en, test4: "I have a %{link:link to Rails} in the %{position}.")
-    expect(@view.it("test4", link: It.link("http://www.rubyonrails.org"), position: "middle")).to eq('I have a <a href="http://www.rubyonrails.org">link to Rails</a> in the middle.')
-  end
-
-  it "should allow Integers as normal interpolation" do
-    I18n.backend.store_translations(:en, test5: "Hello %{name}.")
-    expect(@view.it("test5", name: 2)).to eq('Hello 2.')
-  end
-
-  it "should escape the HTML in normal interpolations" do
-    I18n.backend.store_translations(:en, test5: "Hello %{name}.")
-    expect(@view.it("test5", name: '<a href="http://evil.haxor.com">victim</a>')).to eq('Hello &lt;a href=&quot;http://evil.haxor.com&quot;&gt;victim&lt;/a&gt;.')
-  end
-
-  it "should not escape html_safe interpolations" do
-    I18n.backend.store_translations(:en, test5: "Hello %{name}.")
-    expect(@view.it("test5", name: '<a href="http://www.rubyonrails.org">Rails</a>'.html_safe)).to eq('Hello <a href="http://www.rubyonrails.org">Rails</a>.')
-  end
-
-  it "should allow interpolations inside of links" do
-    I18n.backend.store_translations(:en, test6: "Did you read our %{link:nice %{article}}?")
-    expect(@view.it("test6", link: It.link("/article/2"), article: "article")).to eq('Did you read our <a href="/article/2">nice article</a>?')
-  end
-
-  it "should raise a KeyError, if the key was not given" do
-    expect { @view.it("test1", blubb: true) }.to raise_error(KeyError, "key{link} not found")
-  end
-
-  it "should raise an ArgumentError, if a String was given for an interpolation with argument" do
-    I18n.backend.store_translations(:en, test7: "Sign up %{asdf:here}!")
-    expect { @view.it("test7", asdf: "Heinz") }.to raise_error(ArgumentError, "key{asdf} has an argument, so it cannot resolved with a String")
-  end
-
-  it "should allow Strings, if the interpolation name is link" do
-    I18n.backend.store_translations(:en, test8: "Sign up %{link:here}!")
-    expect(@view.it("test8", link: "/register")).to eq('Sign up <a href="/register">here</a>!')
-  end
-
-  it "should allow Strings, if the interpolation name ends with _link" do
-    I18n.backend.store_translations(:en, test8: "Sign up %{register_link:here}!")
-    expect(@view.it("test8", register_link: "/register")).to eq('Sign up <a href="/register">here</a>!')
-  end
-
-  it "should allow Strings, if the interpolation name starts with link_" do
-    I18n.backend.store_translations(:en, test8: "Sign up %{link_to_register:here}!")
-    expect(@view.it("test8", link_to_register: "/register")).to eq('Sign up <a href="/register">here</a>!')
-  end
-
-  it "should work with tags without arguments" do
-    I18n.backend.store_translations(:en, test9: "We can %{br} do line breaks")
-    expect(@view.it("test9", br: It.tag(:br))).to eq('We can <br /> do line breaks')
-  end
-
-  it 'should support dot-prefixed keys' do
-    I18n.backend.store_translations(:en, widgets: { show: { all_widgets: "See %{widgets_link:all widgets}" } })
-    @view.instance_variable_set(:"@_virtual_path", "widgets/show") # For Rails 3.0
-    @view.instance_variable_set(:"@virtual_path", "widgets/show") # For Rails 3.1, 3.2 and probably 4.0
-    expect(@view.it('.all_widgets', widgets_link: '/widgets')).to eq('See <a href="/widgets">all widgets</a>')
-  end
-
-  it 'should support the locale option' do
-    expect(@view.it('test1', locale: "de", link: It.link("http://www.rubyonrails.org"))).to eq('Ich habe einen <a href="http://www.rubyonrails.org">Link zu Rails</a> in der Mitte.')
-  end
-
-  context "With a pluralized translation" do
-    before do
-      I18n.backend.store_translations(:en, test10: {zero: "You have zero messages.", one: "You have %{link:one message}.", other: "You have %{link:%{count} messages}."})
-    end
-
-    it 'should work with count = 0' do
-      expect(@view.it("test10", count: 0, link: "/messages")).to eq('You have zero messages.')
-    end
-
-    it 'should work with count = 1' do
-      expect(@view.it("test10", count: 1, link: "/messages")).to eq('You have <a href="/messages">one message</a>.')
-    end
-
-    it 'should work with count > 1' do
-      expect(@view.it("test10", count: 2, link: "/messages")).to eq('You have <a href="/messages">2 messages</a>.')
-    end
-  end
-end

data/spec/it/interpolation_spec.rb

@@ -1,80 +0,0 @@
-require 'spec_helper'
-require 'it'
-
-describe It::Interpolation do
-  subject(:interpolation) { It::Interpolation.new('%{key:label}', { 'key' => It.tag(:b) }) }
-
-  describe '.new' do
-    it 'throws an error with one argument' do
-      expect { It::Interpolation.new('%{key:label}') }.to raise_error(ArgumentError)
-    end
-
-    it 'extracts the key from the string' do
-      expect(interpolation.key).to eq('key')
-    end
-
-    it 'extracts the label from the string' do
-      expect(interpolation.label).to eq('label')
-    end
-
-    it 'assigns nil to the label if not present' do
-      expect(It::Interpolation.new('%{key}', {}).label).to be_nil
-    end
-
-    it 'converts string values to a It::Link if the key is named link' do
-      interpolation = It::Interpolation.new('%{link:label}', 'link' => 'http://github.com')
-
-      expect(interpolation.values['link']).to be_kind_of(It::Link)
-    end
-
-    it 'converts string values to a It::Link if the key starts with link_' do
-      interpolation = It::Interpolation.new('%{link_github:label}', 'link_github' => 'http://github.com')
-
-      expect(interpolation.values['link_github']).to be_kind_of(It::Link)
-    end
-
-    it 'converts string values to a It::Link if the key ends with _link' do
-      interpolation = It::Interpolation.new('%{github_link:label}', 'github_link' => 'http://github.com')
-
-      expect(interpolation.values['github_link']).to be_kind_of(It::Link)
-    end
-  end
-
-  describe '#process' do
-    it 'interpolates the string' do
-      expect(interpolation.process).to eq('<b>label</b>')
-    end
-
-    it 'interpolates the string to an empty tag if no label is present' do
-      interpolation.label = nil
-
-      expect(interpolation.process).to eq('<b />')
-    end
-
-    it 'does the normal interpolation if the value is not a Tag and no label is present' do
-      interpolation.label = nil
-      interpolation.values = { 'key' => 'string'}
-
-      expect(interpolation.process).to eq('string')
-    end
-
-    it 'escapes HTML in the normal interpolation' do
-      interpolation.label = nil
-      interpolation.values = { 'key' => '<b>hallo</b>'}
-
-      expect(interpolation.process).to eq('&lt;b&gt;hallo&lt;/b&gt;')
-    end
-
-    it 'raises an KeyError if the requested key was not provided' do
-      interpolation.values = {}
-
-      expect { interpolation.process }.to raise_error(KeyError)
-    end
-
-    it 'raises an ArgumentError, if a string should be interpolated with a label' do
-      interpolation.values = { 'key' => 'string'}
-
-      expect { interpolation.process }.to raise_error(ArgumentError)
-    end
-  end
-end

data/spec/it/link_spec.rb

@@ -1,42 +0,0 @@
-# encoding: UTF-8
-
-require 'spec_helper'
-require 'it'
-
-describe It::Link, '.new' do
-  it "should accept a String as frist param" do
-    expect { It::Link.new("http://www.rubyonrails.org/") }.not_to raise_error
-  end
-  
-  it "should accept a Hash as first param" do
-    expect { It::Link.new({controller: "articles", action: "index"}) }.not_to raise_error
-  end
-  
-  it "should raise a TypeError if the first param is an Integer" do
-    expect { It::Link.new(1) }.to raise_error(TypeError)
-  end
-  
-  it "should accept options as a Hash" do
-    expect { It::Link.new("http://www.rubyonrails.org/", {id: "identity", class: "classy"}) }.not_to raise_error
-  end
-  
-  it "should raise a TypeError, if the options are a String" do
-    expect { It::Link.new("http://www.rubyonrails.org/", "classy") }.to raise_error(TypeError)
-  end
-  
-  it "should raise ArgumentError, if called with three params" do
-    expect { It::Link.new("http://www.rubyonrails.org/", {}, :blubb) }.to raise_error(ArgumentError)
-  end
-end
-
-describe It::Link, '#tag_name' do
-  it "should always return a" do
-    expect(It::Link.new("http://www.rubyonrails.org/").tag_name).to eq(:a)
-  end
-end
-
-describe It::Link, '#process' do
-  it "should return a link with the options set and the content as label" do
-    expect(It::Link.new("http://www.rubyonrails.org", target: "_blank").process("Rails")).to eq('<a href="http://www.rubyonrails.org" target="_blank">Rails</a>')
-  end
-end

data/spec/it/parser_spec.rb

@@ -1,38 +0,0 @@
-require 'spec_helper'
-require 'it'
-
-describe It::Parser do
-  describe '#process' do
-    it 'calls the Interpolation as required' do
-      values = {'b' => It.tag(:b), 'link' => '/messages'}
-      parser = It::Parser.new('You have %{b:%{link:new messages}}!', values)
-
-      return1 = double('It::Interpolation', process: '<a href="/messages">new messages</a>')
-      It::Interpolation.should_receive(:new).with('%{link:new messages}', values).and_return(return1)
-
-      return2 = double('It::Interpolation', process: '<b><a href="/messages">new messages</a></b>')
-      It::Interpolation.should_receive(:new).with('%{b:<a href="/messages">new messages</a>}', values).and_return(return2)
-
-      expect(parser.process).to eq('You have <b><a href="/messages">new messages</a></b>!')
-    end
-
-    it 'escapes HTML in the string and the labels' do
-      parser = It::Parser.new('It is a <b>save</b> %{word:<i>world</i>}', 'word' => It.tag(:i))
-
-      expect(parser.process).to eq('It is a &lt;b&gt;save&lt;/b&gt; <i>&lt;i&gt;world&lt;/i&gt;</i>')
-    end
-
-    it 'marks the result as html safe' do
-      parser = It::Parser.new('test', {})
-
-      expect(parser.process).to be_html_safe
-    end
-
-    it 'delegates pluralization to I18n' do
-      I18n.backend.stub(:pluralize).with('en', {other: 'You have %{count} messages'}, 2) { 'This is the pluralized string' }
-      parser = It::Parser.new({other: 'You have %{count} messages'}, 'locale' => 'en', 'count' => 2)
-
-      expect(parser.process).to eq('This is the pluralized string')
-    end
-  end
-end

data/spec/it/plain_spec.rb

@@ -1,30 +0,0 @@
-require 'spec_helper'
-require 'it'
-
-describe It::Plain, '.new' do
-  it "should work with no params" do
-    expect { It::Plain.new }.not_to raise_error
-  end
-  
-  it "should work with a String" do
-    expect { It::Plain.new("%s[http://www.rubyonrails.org]") }.not_to raise_error
-  end
-  
-  it "should raise ArgumentError with 2 params" do
-    expect { It::Plain.new("asdf", "asdf")}.to raise_error(ArgumentError)
-  end
-  
-  it "should raise a TypeError, if the first param is not a String" do
-    expect { It::Plain.new(1)}.to raise_error(TypeError)
-  end
-end
-
-describe It::Plain, '#process' do
-  it "should return 'Ruby on Rails', if no param was given" do
-    expect(It::Plain.new.process("Ruby on Rails")).to eq('Ruby on Rails')
-  end
-  
-  it "should return 'Ruby on Rails[http://www.rubyonrails.org/]'" do
-    expect(It::Plain.new("%s[http://www.rubyonrails.org/]").process("Ruby on Rails")).to eq('Ruby on Rails[http://www.rubyonrails.org/]')
-  end
-end

data/spec/it/tag_spec.rb

@@ -1,68 +0,0 @@
-# encoding: UTF-8
-
-require 'spec_helper'
-require 'it'
-
-describe It::Tag, '.new' do
-  it "should work with a parameter (Symbol)" do
-    expect { It::Tag.new(:b) }.not_to raise_error
-  end
-
-  it "should work with a paramter (String)" do
-    expect { It::Tag.new("b") }.not_to raise_error
-  end
-
-  it "should raise TypeError if called with an Integer" do
-    expect { It::Tag.new(1) }.to raise_error(TypeError)
-  end
-
-  it "should accept an options Hash" do
-    expect { It::Tag.new(:b, class: "very_bold") }.not_to raise_error
-  end
-
-  it "should raise a TypeError if called with a String" do
-    expect { It::Tag.new(:b, "very_bold") }.to raise_error(TypeError)
-  end
-
-  it "should raise an ArgumentError if called with three params" do
-    expect { It::Tag.new(:b, {}, :blubb) }.to raise_error(ArgumentError)
-  end
-end
-
-describe It::Tag, '#tag_name' do
-  it "should return the tag as a Symbol if given as a Symbol" do
-    expect(It::Tag.new(:i).tag_name).to eq(:i)
-  end
-
-  it "should return the tag_name as a Symbol if given as a String" do
-    expect(It::Tag.new("i").tag_name).to eq(:i)
-  end
-end
-
-describe It::Tag, '#options' do
-  it "should return the options with symbolized keys" do
-    expect(It::Tag.new(:i, "id" => "cool", class: "classy").options).to eq({id: "cool", class: "classy"})
-  end
-end
-
-describe It::Tag, '#process' do
-  it "should return a tag with the options as attributes and the param as content" do
-    expect(It::Tag.new(:i, "id" => "cool", "class" => "classy").process("some text")).to eq('<i class="classy" id="cool">some text</i>')
-  end
-
-  it "should be marked as html safe" do
-    expect(It::Tag.new(:i).process("some text").html_safe).to be_true
-  end
-
-  it "should escape HTML" do
-    expect(It::Tag.new(:i).process("some text & <b>html</b>")).to eq('<i>some text &amp; &lt;b&gt;html&lt;/b&gt;</i>')
-  end
-
-  it "should not escape strings marked as HTML safe" do
-    expect(It::Tag.new(:i).process("some text & <b>html</b>".html_safe)).to eq('<i>some text & <b>html</b></i>')
-  end
-
-  it "should return an empty tag, if no content is provided" do
-    expect(It::Tag.new(:br, "id" => "cool").process).to eq('<br id="cool" />')
-  end
-end

data/spec/it_spec.rb

@@ -1,75 +0,0 @@
-# encoding: UTF-8
-
-require 'spec_helper'
-require 'it'
-
-describe It, '.it' do
-  it "should translate inside the controller as well" do
-    I18n.backend.store_translations(:en, test1: "I have a %{link:link to Rails} in the middle.")
-    expect(It.it("test1", link: It.link("http://www.rubyonrails.org"))).to eq('I have a <a href="http://www.rubyonrails.org">link to Rails</a> in the middle.')
-  end
-
-  it 'should use default key if no translation is present on specified key' do
-    I18n.backend.store_translations(:en, fallback: 'this is a fallback')
-    expect(It.it('a.missing.key', default: :fallback)).to eq('this is a fallback')
-  end
-
-  it 'should use default string if key is missing' do
-    expect(It.it('a.missing.key', default: 'this is a fallback string')).to eq('this is a fallback string')
-  end
-
-end
-
-describe It, '.link' do
-  it "should return an It::Link object" do
-    expect(It.link("https://www.github.com").class).to eq(It::Link)
-  end
-
-  it "should accept one param" do
-    expect { It.link("http://www.rubyonrails.org/") }.not_to raise_error
-  end
-
-  it "should accept two params" do
-    expect { It.link("http://www.rubyonrails.org/", {id: "identity", class: "classy"}) }.not_to raise_error
-  end
-
-  it "should raise ArgumentError, if called with three params" do
-    expect { It.link("http://www.rubyonrails.org/", {}, :blubb) }.to raise_error(ArgumentError)
-  end
-end
-
-describe It, '.tag' do
-  it "should return an It::Tag object" do
-    expect(It.tag(:b).class).to eq(It::Tag)
-  end
-
-  it "should work with a param" do
-    expect { It.tag(:b) }.not_to raise_error
-  end
-
-  it "should accept two params" do
-    expect { It.tag(:b, class: "very_bold") }.not_to raise_error
-  end
-
-  it "should raise an ArgumentError if called with three params" do
-    expect { It.tag(:b, {}, :blubb) }.to raise_error(ArgumentError)
-  end
-end
-
-describe It, '.plain' do
-  it "should return an It::Plain object" do
-    expect(It.plain.class).to eq(It::Plain)
-  end
-
-  it "should work without params" do
-    expect { It.plain }.not_to raise_error
-  end
-
-  it "should accept one param" do
-    expect { It.plain("%s[http://www.rubyonrails.org/]") }.not_to raise_error
-  end
-
-  it "should raise ArgumentError, if called with two params" do
-    expect { It.plain("%s[http://www.rubyonrails.org/]", :blubb) }.to raise_error(ArgumentError)
-  end
-end

data/spec/spec_helper.rb

@@ -1,13 +0,0 @@
-require 'rspec'
-require 'action_pack'
-require 'action_controller'
-require 'action_view'
-
-$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
-
-RSpec.configure do |config|
-
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
-  end
-end