i18n_utils 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3058acc71077f5c2d064469f749c63e585860c77
-  data.tar.gz: e9c27d338b8a81519b215f68fc9808d2c3065682
+  metadata.gz: b6b5a9200ee6ddbcbe323f65bf5831ad09606073
+  data.tar.gz: a1787e8442dc6f5a65c9008ba7eaf276d08d5fdc
 SHA512:
-  metadata.gz: e5e195979160b88bd89bf0e2425415b716f8f44df86ef05959d83d559edeccc92f13a9eda76b3f2fd29c44b0a3ed5c7010952ca628c6b0fd087343ceeaf5446a
-  data.tar.gz: c7bc80e4b039bc0dc44682820b84463ded6d3f640e0a34013167bacc5c23660f404bb035fceb08251091d7cf886fd453ec345ed36dc4d239326fd7467252262b
+  metadata.gz: d984d9cac645e36a92baf65e5c0317d3ab5c30c5c6edb18e5109a790814d5dcc505abae0cff2cee3df2800060947635099e8c34cd6c783cbf7b9520442d1f6d2
+  data.tar.gz: 9effedf6df34082d6763e33640452709c94a63b7ee4e2506528322d5591dc95f76cd7defe2da5f6d9e7a2f5a949b0778263db856ebd99130abfc936d86dcbd60

data/README.md

@@ -5,19 +5,44 @@ I18n utilities for Ruby on Rails.
 
 ## Usage
 
+Just `include I18nUtils::All` in e.g. your `ApplicationHelper` to get all the things.
+
+Or see under each section to only get that part.
+
+
 ### `t_model`, `t_attribute`
 
-I think the Rails way to translate attributes and models is ugly and on the wrong object.
+Get this part with `include I18nUtils::Model` in e.g. your `ApplicationHelper`.
 
-Just `include I18nUtils::Helpers` in e.g. your `ApplicationHelper`.
+I think the Rails way to translate attributes and models is ugly and on the wrong object.
 
-Now, your views can do `t_model(User)` instead of `User.model_name.human`.
+With this, your views can do `t_model(User)` instead of `User.model_name.human`.
 
 Also `t_attribute(User, :email)` instead of `User.human_attribute_name(:email)`.
 
 Want to use them outside views? Feel free to include the module anywhere you like, or call them via the `I18nUtils` object, e.g. `I18nUtils.t_model(User)`.
 
-You could even do `I18n.extend I18nUtils::Helpers` to get e.g. `I18n.t_model(User)`.
+You could even do `I18n.extend(I18nUtils::Model)` to get e.g. `I18n.t_model(User)`.
+
+
+### `t_scope`
+
+Get this part with `include I18nUtils::Scope` in e.g. your `ApplicationHelper`.
+
+Links or other markup in the middle of a translation is tricky. Either you put the HTML straight in the translation and risk the translator messing it up, or it becomes a mess:
+
+``` slim
+= t(:"welcome.sign_in_now.text",
+  sign_in: link_to(t(:"welcome.sign_in_now.sign_in"), sign_in_url))
+```
+
+The `t_scope` helper lets you use blocks for interpolated values, in your regular template:
+
+``` slim
+= t_scope(:"welcome.sign_in_now.text") do |scope|
+  scope.sign_in do
+    = link_to(scope.t(:sign_in), sign_in_url))
+```
 
 
 ## Installation

data/i18n_utils.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "i18n"
+  spec.add_dependency "active_support"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/lib/i18n_utils.rb

@@ -1,7 +1,10 @@
 require "i18n_utils/version"
 
+# For html_safe/SafeBuffer.
+require "active_support/all"
+
 module I18nUtils
-  module Helpers
+  module Model
     def t_attribute(klass, attribute)
       klass.human_attribute_name(attribute)
     end
@@ -11,5 +14,40 @@ module I18nUtils
     end
   end
 
-  extend Helpers
+  module Scope
+    def t_scope(key)
+      base_key = key.to_s.rpartition(".").first
+      scope = ScopeContext.new(base_key, self)
+      yield(scope)
+      t(key, scope.to_hash).html_safe
+    end
+  end
+
+  module All
+    include Model
+    include Scope
+  end
+
+  extend Model
+
+  class ScopeContext
+    def initialize(base_key, helper)
+      @base_key = base_key
+      @helper = helper
+      @hash = {}
+    end
+
+    def to_hash
+      @hash
+    end
+
+    def t(key, opts = {})
+      @helper.t("#{@base_key}.#{key}", opts)
+    end
+
+    def method_missing(name, *args, &block)
+      html = @helper.capture(&block)
+      @hash[name] = html
+    end
+  end
 end

data/lib/i18n_utils/version.rb

@@ -1,3 +1,3 @@
 module I18nUtils
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/helpers_spec.rb

@@ -1,13 +1,13 @@
 require "i18n_utils"
 
-describe I18nUtils::Helpers do
-  let(:view) { double.extend(described_class) }
+describe I18nUtils do
+  include I18nUtils::All
 
   describe "t_attribute" do
     it "uses human_attribute_name" do
       klass = double
       allow(klass).to receive(:human_attribute_name).with(:foo).and_return("foux du fafa")
-      view.t_attribute(klass, :foo).should == "foux du fafa"
+      t_attribute(klass, :foo).should == "foux du fafa"
       I18nUtils.t_attribute(klass, :foo).should == "foux du fafa"
     end
   end
@@ -16,8 +16,34 @@ describe I18nUtils::Helpers do
     it "uses model_name.human" do
       klass = double
       klass.stub_chain(:model_name, :human).and_return("Clase")
-      view.t_model(klass).should == "Clase"
+      t_model(klass).should == "Clase"
       I18nUtils.t_model(klass).should == "Clase"
     end
   end
+
+  # Not as integrated as I might like to really trust these tests, but simple.
+  # Suggestions for improvement are very welcome.
+  describe "t_scope" do
+    def link_to(text, url)
+      %{<a href="#{url}">#{text}</a>}
+    end
+
+    it "captures content and abbreviates scopes" do
+      expect(self).to receive(:capture) { |&block| block.call }
+
+      expect(self).to receive(:t).
+        with("sign_in_now.text", sign_in: %{<a href="url">Sign in</a>}).
+        and_return("output")
+
+      expect(self).to receive(:t).
+        with("sign_in_now.sign_in", {}).
+        and_return("Sign in")
+
+      t_scope("sign_in_now.text") do |scope|
+        scope.sign_in do
+          link_to(scope.t(:sign_in), "url")
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18n_utils
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Henrik Nyh
@@ -24,6 +24,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement