text_helpers 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5996591783903a77aa42bf6661456c457408b437
-  data.tar.gz: 290c4f04de2c35b257dfeabcf7a3fa3044b106ad
+  metadata.gz: d68768849991fa2e1aef1064d10c70a0c106e3e1
+  data.tar.gz: 010c42fa301e3b113586a30ef7e6e1e2ae014059
 SHA512:
-  metadata.gz: 33242fb49efb10f6c229d2acc44e361e371ae548d61a017030c40a7085822b1613e1693cabadadedc01813cdbf2a116456acbde9287728056b7b179920d2a785
-  data.tar.gz: 6b6f8d31bf1b5b04cee1ddb5b0498d8c62c26caade7ac35f0e5e3e5992eb67be6fa8d54751807308585e68a7b6da39efcea22c40d76fefcc3ef26dff780face1
+  metadata.gz: 58bea6441da44a2a256ca9ed53a7bb1116a1c4b9d85250846f6e5e84e55d245d7ee626f5d1258556b3527d7ad1893ff8287da9a96e265a740a8d513ca3293bdd
+  data.tar.gz: 5ff92cc80d614a94f78c2852f0e8ef9008cc1e75bdbd2728f89fa35c89eb98d30a0526192fb378b450f88fbcba65af819706482c91ec31b0d2a7d4c73f25cbeb

data/README.md

@@ -91,6 +91,35 @@ specs by adding `view: true` to the spec metadata.
 The controller text helpers described above can be accessed in controller
 specs by adding `controller: true` to your spec metadata.
 
+### Temporary/Stub Localizations
+
+`text_helpers/rspec.rb` contains some helpers for setting up a test localization
+environment during your test runs.
+
+To configure it, `require "text_helpers/rspec"` and configure the `before` and
+`after` hooks appropriately:
+
+```
+require 'text_helpers/rspec'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    TextHelpers::RSpec.setup_spec_translations
+  end
+
+  config.after(:each) do
+    TextHelpers::RSpec.reset_spec_translations
+  end
+end
+```
+
+Temporary localizations can then be defined within your examples via the
+`#set_translation` method, like so:
+
+```
+set_translation('models.user.attributes.name', 'Name')
+```
+
 ## Configuration & Initialization
 
 ### Initialization

data/lib/text_helpers/rspec.rb

@@ -0,0 +1,59 @@
+module TextHelpers
+  # TextHelpers::RSpec contains some helpers for making testing around i18n
+  # easier, especially with tests that may generate keys that map to
+  # translations that aren't/should not be present in your production
+  # localization files.
+  module RSpec
+    class << self
+      attr_accessor :translation_backend
+    end
+
+    # Public: Set up the test translation environment.
+    #
+    # Should ideally be called in an RSpec `before(:suite)` hook.
+    #
+    # Returns the new I18n backend.
+    def self.setup_spec_translations
+      self.translation_backend = I18n::Backend::Simple.new
+      I18n.backend = I18n::Backend::Chain.new(self.translation_backend, I18n.backend)
+    end
+
+    # Public: Reset the test translations.
+    #
+    # Clears out any translations added during an example run.
+    #
+    # Returns nothing.
+    def self.reset_spec_translations
+      if self.translation_backend.nil?
+        raise "translation_backend is nil. Ensure .setup_spec_translations was called"
+      end
+
+      self.translation_backend.reload!
+    end
+
+    # TextHelpers::RSpec::TestHelpers contains helper methods to be used from
+    # within your examples.
+    module TestHelpers
+
+      # Public: Set a new translation in the test translations.
+      #
+      # path   - The path to the key, like 'models.user.attributes.title'.
+      # value  - The localized value.
+      # locale - The locale the translation should be defined in.
+      # scope  - The scope the translation should be defined under.
+      #
+      # Returns true on success.
+      def set_translation(path, value, locale: I18n.locale, scope: nil)
+        *hash_keys, last_key = I18n.normalize_keys(nil, path, scope)
+
+        data = {}
+        last_hash = hash_keys.inject(data) { |h,k| h[k] = Hash.new }
+        last_hash[last_key] = value
+
+        TextHelpers::RSpec.translation_backend.store_translations(locale, data)
+
+        true
+      end
+    end
+  end
+end

data/lib/text_helpers/version.rb

@@ -1,3 +1,3 @@
 module TextHelpers
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: text_helpers
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Andrew Horner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-23 00:00:00.000000000 Z
+date: 2015-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -95,6 +95,7 @@ files:
 - lib/text_helpers.rb
 - lib/text_helpers/contexts.rb
 - lib/text_helpers/railtie.rb
+- lib/text_helpers/rspec.rb
 - lib/text_helpers/translation.rb
 - lib/text_helpers/version.rb
 - test/lib/text_helpers/railtie_test.rb