i18n-callbacks 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae3d088f84070a37a78555a10a1204db1dd1a4a0
-  data.tar.gz: ce8b40ef7a18a5c6cec0b8e99f1df79537cd1464
+  metadata.gz: 49c2ce75710545c387cd79fe44ac93eb819ab084
+  data.tar.gz: 840f8dafc369a0c7c7be9c5e3f94c1f06f2804fc
 SHA512:
-  metadata.gz: 7aeff25f7a8655937b9304d0e218352f16f69b704cf15cc04b489e6bc8e809068971cc8b52a7f7d7ec903693ae9f864c85017a47c54b1d7cef80f0273d8942ac
-  data.tar.gz: 611036153f983d64034ded43492523f2472cccee484a3f6043c76f3c01e3efc155e1a806eb068e2674a0f16f45cce7114e4d88e7f92c03419bbd641435e31024
+  metadata.gz: 2092f3d9e02d80ca01a126e75dc7725b6de6010f2e08d79a582fd67658fb71ce599e085330fe94ffa353c67cb41d043d64940a4bd488ab9acf8c9c9bac938e08
+  data.tar.gz: f16d457f2e03e3be225461d792188fc08958315b7e2d6590ce56814538b199b0a72dd6be0b102e95d426001ed66315c1b93537748ba66194d66b8175d6ccd0dc

data/README.md

@@ -41,7 +41,7 @@ require "i18n/callbacks"
 
 wrapped = I18n::Backend::Simple.new
 
-# ...load you translations (normally from YAML files)
+# ...load your translations (normally from YAML files)
 wrapped.store_translations(:en, {foo: "bar"})
 
 I18n.backend = I18n::Backend::Callbacks.new(
@@ -52,6 +52,8 @@ I18n.backend = I18n::Backend::Callbacks.new(
 I18n.t(:foo) # => "foo: bar"
 ```
 
+See also the `examples` directory.
+
 ## Development
 
 Run `rake spec` to run the tests.

data/examples/rails-18n-key-debug.md

@@ -0,0 +1,50 @@
+# Rails I18n Key Debug
+
+Often the strings used in a Rails app come from many different places: from
+your app and from various different gems (i.e. 'activerecord', 'devise',
+or 'kaminari').
+
+When this happens, you often want to know what keys are producing the
+translations you are seeing in your views.
+
+# Setup
+
+Add an initializer for I18n (config/initializers/i18n.rb):
+
+```
+if Rails.env.development?
+  I18n.backend = I18n::Backend::Callbacks.new(I18n::Backend::Simple.new)
+end
+```
+
+Add an around hook in ApplicationController:
+
+```
+class ApplicationController < ActionController::Base
+  around_action :debug_i18n
+
+  private
+
+  def debug_i18n
+    if !Rails.env.development?
+      yield
+      return
+    end
+
+    if params[:debug_i18n]
+      I18n.backend.after = ->(locale, key, options={}, result) do
+        "[#{key}] #{result}"
+      end
+    end
+
+    yield
+
+    I18n.backend.after = nil
+  end
+end
+```
+
+# Use
+
+When you want to see which keys are in use, add `?debug_i18n=1` in your
+browser's address bar.

data/lib/i18n/backend/callbacks.rb

@@ -2,8 +2,8 @@ require "i18n"
 
 class I18n::Backend::Callbacks < Delegator
   attr_reader :wrapped
-  attr_reader :before
-  attr_reader :after
+  attr_accessor :before
+  attr_accessor :after
 
   def initialize(wrapped, before: nil, after: nil)
     super(wrapped)

data/lib/i18n/callbacks/version.rb

@@ -1,5 +1,5 @@
 module I18n
   module Callbacks
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/spec/backend/callbacks_spec.rb

@@ -42,7 +42,25 @@ describe I18n::Backend::Callbacks do
 
   context "without hooks defined" do
     it "proxies to the backend" do
-      expect(I18n.t("hello")).to eq(original)
+      expect(I18n.t(key)).to eq(original)
+    end
+  end
+
+  context "setting hooks via attributes" do
+    it "works for the pre hook" do
+      I18n.backend.before = ->(locale, key, options = {}) do
+        [:fr, key, options]
+      end
+
+      I18n.t(key)
+
+      expect(wrapped).to have_received(:translate).with(:fr, key, {})
+    end
+
+    it "works for the post hook" do
+      I18n.backend.after = ->(*args) { "ciao" }
+
+      expect(I18n.t(key)).to eq("ciao")
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-callbacks
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Joe Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-19 00:00:00.000000000 Z
+date: 2016-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -81,6 +81,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/rails-18n-key-debug.md
 - i18n-callbacks.gemspec
 - lib/i18n/backend/callbacks.rb
 - lib/i18n/callbacks.rb