text_helpers 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac32959a133d4a65ade46dea9d8759d4d19931eb
-  data.tar.gz: e3ab723bb5263bfbd2e4747a14cea556ee5d07ea
+  metadata.gz: 903554bdd7d36e4e370e3ee49c9b4fea2ce583c0
+  data.tar.gz: a44bc31df0e1ee330828bc7fce8c744cef1b851a
 SHA512:
-  metadata.gz: 703ddbb7c992573ec5ca3cbd01d9960fc981fce5e2fd1fff76f556fd5ab1d07d3f57c99ecc1c3d6a8c33e9c550486fadb908677fbbf10549c3edc4a0830f0619
-  data.tar.gz: fb75432396bebdb2ba283f572187c5ebb4616563dbad3c6653340034f781c3076c70cbd76628db4533b530c7e56f33e5efd1b7ba609ea450db2b7318460a69ea
+  metadata.gz: cd7cbf44933933fde4fef80f20346ce5f69acef7c5faf5842f73397db143ec3a13b59b2ada6ced119fc9500b76f0a1ff832d81d3bce9cf8f4054168c8f712a1b
+  data.tar.gz: ce8278cd00a6b9ec4df5e4aaaf9ae6486fb5a4e7212b9f4d0528647f05a32104958b01df0fe2e333ef0350130070f41357f8ec011c8e0a6b7094e94077c3b74d

data/README.md

@@ -1,7 +1,6 @@
 # TextHelpers
 
-`TextHelpers` is a library intended to make working with static text in Rails
-projects as painless as possible.
+`TextHelpers` is a library intended to make working with static text in Rails projects as painless as possible.
 
 Include it in your `Gemfile` with:
 
@@ -11,50 +10,23 @@ gem "text_helpers"
 
 ## Suggested Use
 
-All static text should be placed in locale files, in a directory
-structure mirroring the app directory structure. The text for
-`app/views/some/_partial.html.haml` would go in
-`config/locales/views/some/partial.en.yml`, for example. This is not a strict
-requirement, but will go a long way toward keeping your locales easily
-maintainable.
+All static text should be placed in locale files, in a directory structure mirroring the app directory structure. The text for `app/views/some/_partial.html.haml` would go in `config/locales/views/some/partial.en.yml`, for example. This is not a strict requirement, but will go a long way toward keeping your locales easily maintainable.
 
-If you're using this within a Rails project, you'll probably want to add the
-following line to your application.rb to ensure that Rails loads any locale
-files organized this way:
-
-```ruby
-config.i18n.load_path += Dir[Rails.root.join('config', 'locales', '**', '*.{rb,yml}').to_s]
-```
-
-In any locale file entry, you can reference another key in the locale file by
-using the syntax `!scope.to.key!`. For the sake of maintainability, I
-recommend restricting the use of this feature to small, highly-recycled
-fragments of static text. `I18n`'s built-in `%{value}` interpolation can be
-used for variable text.
+In any locale file entry, you can reference another key in the locale file by using the syntax `!scope.to.key!`. For the sake of maintainability, I recommend restricting the use of this feature to small, highly-recycled fragments of static text. `I18n`'s built-in `%{value}` interpolation can be used for variable text.
 
 ### In Views
 
-To access this text in views, two helpers are available, `text` and `html`.
-Both helpers take a lookup key, used to identify the desired piece of text,
-and an argument hash, which is forwarded to the `I18n.t` call.
+To access this text in views, two helpers are available, `text` and `html`. Both helpers take a lookup key, used to identify the desired piece of text, and an argument hash, which is forwarded to the `I18n.t` call.
 
-`text` returns the requested text, with special values interpolated, and made
-html_safe (so HTML can be used here, when absolutely necessary).
+`text` returns the requested text, with special values interpolated, and made html_safe (so HTML can be used here, when absolutely necessary).
 
-`html` parses the requested text using Markdown, making it useful for rendering
-larger pieces of text involving multiple paragraphs, list items or links.
+`html` parses the requested text using Markdown, making it useful for rendering larger pieces of text involving multiple paragraphs, list items or links.
 
-`html` automatically parses Markdown using
-[`SmartyPants`-style](http://daringfireball.net/projects/smartypants/)
-character conversions, so you can write plain text and have the proper
-typographical elements generated for you without having to explicitly insert
-HTML entities for common cases.
+`html` automatically parses Markdown using [`SmartyPants`-style](http://daringfireball.net/projects/smartypants/) character conversions, so you can write plain text and have the proper typographical elements generated for you without having to explicitly insert HTML entities for common cases.
 
-If you want to render a small fragment of Markdown without `p` tag wrappers,
-you can pass `inline: true` as an option to `html`.
+If you want to render a small fragment of Markdown without `p` tag wrappers, you can pass `inline: true` as an option to `html`.
 
-`text` and `html` will escape all arguments passed to it in order to prevent XSS
-attacks. If you want to pass html content, you should ensure you mark it as .html_safe
+`text` and `html` will escape all arguments passed to it in order to prevent XSS attacks. If you want to pass html content, you should ensure you mark it as .html_safe
 
 Example: `text('welcome_user', username)` will escape html characters in username
 ```ruby
@@ -68,14 +40,11 @@ Welcome <b>Bob</b>
 
 ### In Controllers
 
-The same helpers are available in controllers, with the translation scope based
-on the controller name rather than the view directory. This will typically be
-used for flash messages or alerts of some kind.
+The same helpers are available in controllers, with the translation scope based on the controller name rather than the view directory. This will typically be used for flash messages or alerts of some kind.
 
 ## Testing
 
-Some shared `RSpec` contexts are available to allow the same locale
-abstractions for testing. You can include these contexts with:
+Some shared `RSpec` contexts are available to allow the same locale abstractions for testing. You can include these contexts with:
 
 ```
 require "text_helpers/contexts"
@@ -83,18 +52,15 @@ require "text_helpers/contexts"
 
 ### Views
 
-The view text helpers described above can be accessed in view
-specs by adding `view: true` to the spec metadata.
+The view text helpers described above can be accessed in view specs by adding `view: true` to the spec metadata.
 
 ### Controllers
 
-The controller text helpers described above can be accessed in controller
-specs by adding `controller: true` to your 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.
+`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:
@@ -124,35 +90,30 @@ set_translation('models.user.attributes.name', 'Name')
 
 ### Initialization
 
-`TextHelpers` performs some setup during your application's initialization. Four
-initializers are installed:
+`TextHelpers` performs some setup during your application's initialization. Five initializers are installed:
 
 #### `text_helpers.action_view.extend_base`
 
-This initializer includes the `TextHelpers::Translation` module into
-`ActionView::Base` and adds an appropriate `#translation_scope` method.
+This initializer includes the `TextHelpers::Translation` module into `ActionView::Base` and adds an appropriate `#translation_scope` method.
 
 #### `text_helpers.action_mailer.extend_base`
 
-This initializer includes the `TextHelpers::Translation` module into
-`ActionMailer::Base` and adds an appropriate `#translation_scope` method.
+This initializer includes the `TextHelpers::Translation` module into `ActionMailer::Base` and adds an appropriate `#translation_scope` method.
 
 #### `text_helpers.action_controller.extend_base`
 
-This initializer includes the `TextHelpers::Translation` module into
-`ActionController::Base` and adds an appropriate `#translation_scope` method.
+This initializer includes the `TextHelpers::Translation` module into `ActionController::Base` and adds an appropriate `#translation_scope` method.
+
+#### `text_helpers.i18n.add_load_paths`
+
+This initializer updates the default I18n locale file load paths for your Rails application to recursively include files within directories and subdirectories. This enables a more hierarchical organization of your locale files.
 
 #### `text_helpers.setup_exception_handling`
 
-This initializer configures exception handling so that exceptions are raised
-if `config.text_helpers.raise_on_missing_translations` is set to `true`, which
-it is by default in the `test` or `development` environments.
+This initializer configures exception handling so that exceptions are raised if `config.text_helpers.raise_on_missing_translations` is set to `true`, which it is by default in the `test` or `development` environments.
 
 ### Configuration
 
 #### `config.text_helpers.raise_on_missing_translations`
 
-This configuration value defaults to `true` in `test` or `development`
-environments. If set to `false`, your own exception handling can be configured
-by setting `config.action_view.raise_on_missing_translations` and
-`I18n.exception_handler` as appropriate.
+This configuration value defaults to `true` in `test` or `development` environments. If set to `false`, your own exception handling can be configured by setting `config.action_view.raise_on_missing_translations` and `I18n.exception_handler` as appropriate.

data/lib/text_helpers/contexts.rb

@@ -1,4 +1,4 @@
-shared_context "a controller spec", controller: true do
+RSpec.shared_context "a controller spec", controller: true do
   include TextHelpers::Translation
 
   def translation_scope
@@ -7,7 +7,7 @@ shared_context "a controller spec", controller: true do
   end
 end
 
-shared_context "a mailer spec", mailer: true do
+RSpec.shared_context "a mailer spec", mailer: true do
   include TextHelpers::Translation
 
   def translation_scope
@@ -16,7 +16,7 @@ shared_context "a mailer spec", mailer: true do
   end
 end
 
-shared_context "a view spec", view: true do
+RSpec.shared_context "a view spec", view: true do
   include TextHelpers::Translation
 
   def translation_scope

data/lib/text_helpers/railtie.rb

@@ -57,6 +57,11 @@ module TextHelpers
       end
     end
 
+    initializer "text_helpers.i18n.add_load_paths" do |app|
+      locales = Rails.root.join('config', 'locales', '**', '*.{rb,yml}').to_s
+      app.config.i18n.load_path += Dir[locales]
+    end
+
     initializer "text_helpers.setup_exception_handling", after: 'after_initialize' do
       next unless config.text_helpers.raise_on_missing_translations
 

data/lib/text_helpers/version.rb

@@ -1,3 +1,3 @@
 module TextHelpers
-  VERSION = "0.6.1"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: text_helpers
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Andrew Horner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-01 00:00:00.000000000 Z
+date: 2016-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport