text_helpers 0.6.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ac32959a133d4a65ade46dea9d8759d4d19931eb
-  data.tar.gz: e3ab723bb5263bfbd2e4747a14cea556ee5d07ea
+SHA256:
+  metadata.gz: 97f5f8d490471d60b7cc9286f2fb49460862917a1ed6b6d36c984fb8f5a22ac3
+  data.tar.gz: a2fadb5cea94f89c87cf31ef1a7dbb8779739c6aab67d2b9f143968498cc25e7
 SHA512:
-  metadata.gz: 703ddbb7c992573ec5ca3cbd01d9960fc981fce5e2fd1fff76f556fd5ab1d07d3f57c99ecc1c3d6a8c33e9c550486fadb908677fbbf10549c3edc4a0830f0619
-  data.tar.gz: fb75432396bebdb2ba283f572187c5ebb4616563dbad3c6653340034f781c3076c70cbd76628db4533b530c7e56f33e5efd1b7ba609ea450db2b7318460a69ea
+  metadata.gz: 73f98e2a518aeafb35653d9d713a3b983d456d2e947bc98fcc1c519d9b8b7034f741eb2985475336e5b9fe6786ebc8502e2fe9994001a259c19c1c0800b769d2
+  data.tar.gz: 37a0c2ba7e0510dd38d720abafb43ba6342f1af8b578422b520d82956aa9a46df22b87a6774b615f1665a21b11618f185229face8e8c9b44513c44081cd1f2f0

data/.travis.yml

@@ -1,3 +1,4 @@
 language: ruby
 rvm:
-  - 2.2.2
+  - 2.6.2
+  - 2.7.0

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,17 @@ 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.
+environment during your test runs. You can enable the helper methods by adding
+the `:text_helpers` tag to the examples that require them.
 
 To configure it, `require "text_helpers/rspec"` and configure the `before` and
 `after` hooks appropriately:
@@ -103,11 +71,13 @@ To configure it, `require "text_helpers/rspec"` and configure the `before` and
 require 'text_helpers/rspec'
 
 RSpec.configure do |config|
+  config.include TextHelpers::RSpec::TestHelpers, text_helpers: true
+
   config.before(:suite) do
     TextHelpers::RSpec.setup_spec_translations
   end
 
-  config.after(:each) do
+  config.after(:each, :text_helpers) do
     TextHelpers::RSpec.reset_spec_translations
   end
 end
@@ -117,42 +87,43 @@ Temporary localizations can then be defined within your examples via the
 `#set_translation` method, like so:
 
 ```
-set_translation('models.user.attributes.name', 'Name')
+describe "with a translation set", :text_helpers do
+  before do
+    set_translation('models.user.attributes.name', 'Name')
+  end
+
+  it { ... }
+end
 ```
 
 ## Configuration & Initialization
 
 ### 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/Rakefile

@@ -4,6 +4,7 @@ require 'rake/testtask'
 
 Rake::TestTask.new do |t|
   t.pattern = "test/**/*_test.rb"
+  t.warning = false
 end
 
 task default: :test

data/lib/text_helpers.rb

@@ -5,10 +5,10 @@ require "text_helpers/railtie" if defined?(Rails)
 module TextHelpers
   # RaiseExceptionHandler just raises all exceptions, rather than swallowing
   # MissingTranslation ones. It's cribbed almost verbatim from
-  # http://edgeguides.rubyonrails.org/i18n.html#customize-your-i18n-setup.
+  # https://guides.rubyonrails.org/i18n.html#using-different-exception-handlers.
   class RaiseExceptionHandler < I18n::ExceptionHandler
     def call(exception, locale, key, options)
-      if exception.is_a?(I18n::MissingTranslation)
+      if exception.is_a?(I18n::MissingTranslation) && key.to_s != "i18n.plural.rule"
         raise exception.to_exception
       else
         super

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/translation.rb

@@ -22,7 +22,8 @@ module TextHelpers
 
   module Translation
 
-    ORPHAN_MATCHER = /\s(?![^<]*>)(\S+\s*<\/(?:p|li)>)/.freeze
+    ORPHAN_MATCHER = /(\w+)[ \t](?![^<]*>)(\S+\s*<\/(?:p|li)>)/.freeze
+    KEYPATH_MATCHER = /!([\w.\/]+)!/.freeze
 
     # Public: Get the I18n localized text for the passed key.
     #
@@ -34,17 +35,17 @@ module TextHelpers
     # Returns a String resulting from the I18n lookup.
     def text(key, options = {})
       options = html_safe_options(options)
-      text = I18n.t(key, {
+      text = I18n.t(key, **{
         scope: self.translation_scope,
-        default: "!#{key}!"
+        default: "!#{key}!",
+        cascade: true,
       }.merge(options)).strip
 
-      interpolation_options = options.dup
-      interpolation_options[:cascade] = true unless interpolation_options.has_key?(:cascade)
+      interpolation_options = { cascade: true }.merge(options)
 
       # Interpolate any keypaths (e.g., `!some.lookup.path/key!`) found in the text.
-      while text =~ /!([\w._\/]+)!/ do
-        text = text.gsub(/!([\w._\/]+)!/) { |match| I18n.t($1, interpolation_options) }
+      while text =~ KEYPATH_MATCHER do
+        text = text.gsub(KEYPATH_MATCHER) { |match| I18n.t($1, **interpolation_options) }
       end
 
       text = smartify(text) if options.fetch(:smart, true)
@@ -65,7 +66,7 @@ module TextHelpers
     def html(key, options = {})
       rendered = markdown(text(key, options.merge(smart: false)))
 
-      rendered = options[:orphans] ? rendered : rendered.gsub(ORPHAN_MATCHER, '&nbsp;\1')
+      rendered = options[:orphans] ? rendered : rendered.gsub(ORPHAN_MATCHER, '\1&nbsp;\2')
       rendered = rendered.gsub(/<\/?p>/, '') if options[:inline]
       rendered.html_safe
     end
@@ -82,7 +83,7 @@ module TextHelpers
       smartify(@renderer.render(text))
     end
 
-    # Protected: Auto-apply smart quotes and to the passed text.
+    # Internal: Auto-apply smart quotes to the passed text.
     #
     # text - A String which should be passed through the SmartyPants renderer.
     #
@@ -91,16 +92,16 @@ module TextHelpers
       Redcarpet::Render::SmartyPants.render(text)
     end
 
-    # Protected: The proper scope for I18n translation.
+    # Internal: The proper scope for I18n translation.
     #
     # Must be implemented by any classes which include this module.
     #
     # Raises NotImplementedError.
     def translation_scope
-      raise NotImplementedError
+      raise NotImplementedError, "must implement a public method `translation_scope` to determine I18n scope"
     end
 
-    # Protected: Convert all passed in arguments into html-safe strings
+    # Internal: Convert all passed in arguments into html-safe strings
     #
     # hash - a set of key-value pairs, which converts the second argument into an html-safe string
     #

data/lib/text_helpers/version.rb

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

data/test/lib/text_helpers/translation_test.rb

@@ -1,4 +1,4 @@
-require_relative '../../test_helper'
+require_relative "../../test_helper"
 
 describe TextHelpers::Translation do
   before do
@@ -9,6 +9,7 @@ describe TextHelpers::Translation do
     before do
       @scoped_text = "Scoped lookup"
       @global_text = "Global lookup"
+      @single_word_text = "Single"
       @email_address = "user@example.org"
       @multiline_text = <<-MULTI.gsub(/^[ \t]+/, '')
         This is some multiline text.
@@ -30,6 +31,8 @@ describe TextHelpers::Translation do
           email_key:               "<#{@email_address}>",
           test_key:                "*#{@scoped_text}*",
           list_key:                "* #{@scoped_text}",
+          single_word_list_key:    "* #{@single_word_text}",
+          prerendered_html_key:    "<ul>\n <li> Get everything you ever wanted</li>\n <li> Practically-guaranteed</li>\n </ul>",
           interpolated_key:        "Global? (!test_key!)",
           interpolated_scoped_key: "Global? (!test_scoped_key!)",
           interpol_arg_key:        "Interpolate global? (!interpolated_key!)",
@@ -74,6 +77,22 @@ describe TextHelpers::Translation do
         assert_equal expected, @helper.html(:list_key)
       end
 
+      it "does not inject `&nbsp;` entities in HTML list items unnecessarily" do
+        expected = <<-EXPECTED.gsub(/^[ \t]+/, '')
+        <ul>
+        <li>#{@single_word_text}</li>
+        </ul>
+        EXPECTED
+
+        assert_equal expected, @helper.html(:single_word_list_key)
+      end
+
+      it "correctly handles orphans in HTML with erratic whitespace" do
+        expected = "<ul>\n <li> Get everything you ever&nbsp;wanted</li>\n <li> Practically-guaranteed</li>\n </ul>\n"
+
+        assert_equal expected, @helper.html(:prerendered_html_key)
+      end
+
       it "does not modify HTML tags" do
         expected = "<p><a href=\"mailto:#{@email_address}\">#{@email_address}</a></p>\n"
         assert_equal expected, @helper.html(:email_key)
@@ -152,10 +171,32 @@ describe TextHelpers::Translation do
         assert_equal "This is what <b>Han</b> Solo said", @helper.text(:argument_key, user: "<b>Han</b> Solo".html_safe)
       end
 
-      it "correctly handles non-string params" do
+      it "correctly handles pluralized keys" do
         assert_equal "A single piece of text", @helper.text(:pluralized_key, count: 1)
         assert_equal "2 pieces of text", @helper.text(:pluralized_key, count: 2)
       end
+
+      describe "when the pluralization backend is configured and the exception handler is enabled" do
+        before do
+          @original_backend = I18n.backend
+          new_backend = @original_backend.dup
+          new_backend.extend(I18n::Backend::Pluralization)
+          I18n.backend = new_backend
+
+          @original_exception_handler = I18n.exception_handler
+          I18n.exception_handler = TextHelpers::RaiseExceptionHandler.new
+        end
+
+        after do
+          I18n.backend = @original_backend
+          I18n.exception_handler = @original_exception_handler
+        end
+
+        it "correctly handles pluralized keys" do
+          assert_equal "A single piece of text", @helper.text(:pluralized_key, count: 1)
+          assert_equal "2 pieces of text", @helper.text(:pluralized_key, count: 2)
+        end
+      end
     end
 
     describe "when no valid scope is provided" do
@@ -201,6 +242,14 @@ describe TextHelpers::Translation do
           I18n.backend = @original_backend
         end
 
+        it "cascades the requested key by default" do
+          I18n.backend.store_translations(:en, {test_scoped_key: "a translation"})
+          assert_equal "a translation", @helper.text(:test_scoped_key, scope: "some.unnecessary.scope")
+
+          I18n.backend.store_translations(:en, {some: {test_scoped_key: "a scoped translation"}})
+          assert_equal "a scoped translation", @helper.text(:test_scoped_key, scope: "some.unnecessary.scope")
+        end
+
         it "cascades the interpolated key by default" do
           I18n.backend.store_translations(:en, {test_scoped_key: "a translation"})
 

data/test/lib/text_helpers/version_test.rb

@@ -3,6 +3,6 @@ require_relative "../../test_helper"
 describe TextHelpers do
 
   it "defines a version" do
-    TextHelpers::VERSION.wont_be_nil
+    assert TextHelpers::VERSION
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: text_helpers
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Andrew Horner
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-10-01 00:00:00.000000000 Z
+date: 2020-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -108,7 +108,7 @@ homepage: https://github.com/ahorner/text-helpers
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -123,9 +123,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: TextHelpers is a gem which supplies some basic utilities for text localization
   in Rails projects.  The library is intended to make it simple to keep your application's