text_helpers 0.7.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 903554bdd7d36e4e370e3ee49c9b4fea2ce583c0
-  data.tar.gz: a44bc31df0e1ee330828bc7fce8c744cef1b851a
+SHA256:
+  metadata.gz: d4e0a6d2b19adb159000ea905c72b4023942ae268e36ac0eb9b39baf551e7460
+  data.tar.gz: ba520c7137fe2355dab9c1e29cbf215c2a19baccef7b246b850f188f909e81e5
 SHA512:
-  metadata.gz: cd7cbf44933933fde4fef80f20346ce5f69acef7c5faf5842f73397db143ec3a13b59b2ada6ced119fc9500b76f0a1ff832d81d3bce9cf8f4054168c8f712a1b
-  data.tar.gz: ce8278cd00a6b9ec4df5e4aaaf9ae6486fb5a4e7212b9f4d0528647f05a32104958b01df0fe2e333ef0350130070f41357f8ec011c8e0a6b7094e94077c3b74d
+  metadata.gz: c1fb87f89fbc7e42cfeab3fa224573097626b6dafd3c252076f7b13df1de5c7a8e8046b95207ba8d69dc9d50aa4290b2bd859166ef2cf17441bddad961ad8f10
+  data.tar.gz: 599e77b95ca58b291bf1d0348b65cfb4e7f2ff831e2a2850a2fd883df1e4fb9e6d569aecd1a209fb6cedf1df1e7aa9136be5ec3db55a6bc61b3ab2b3197d9eb5

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,88 @@
+# Change Log
+
+## [1.1.0] - 2020-12-02
+
+### New Features 
+
+- Add `rel=noopener` to external links (thanks to @n00dle)
+
+## [1.0.1] - 2020-12-02
+
+### Changes 
+
+- Support cascading backends by default
+
+## [1.0.0] - 2020-03-27
+
+### Changes
+
+- **(Breaking)** Drop explicit support for Ruby versions below 2.6
+
+### Bug Fixes
+
+- Properly support translations using I18n::Pluralization backend (thanks to @jhanggi)
+
+## [0.7.2] - 2019-07-06
+
+### Bug Fixes
+
+- Improve orphaned text matcher targeting
+
+## [0.7.1] - 2019-07-05
+
+### Bug Fixes
+
+- Prevent unnecessary non-breaking spaces in generated HTML
+
+### Changes
+
+- Improve `NotImplementedError` messaging (thanks to @stephen-puiszis)
+- Update README with spec setup instructions (thanks to @jhanggi)
+
+## [0.7.0] - 2016-05-06
+
+### New features
+
+- Automatically load entire locale directory via Railtie
+
+## [0.6.1] - 2015-10-01
+
+### Changes
+
+- Bump version requirement for Redcarpet gem to address memory leaks
+
+## [0.6.0] - 2015-06-15
+
+### New Features
+
+- Apply `target=_blank` attribute to anchor tags pointed at external URLs
+
+## [0.5.3] - 2015-02-25
+
+### Changes
+
+- Update spec helpers for compatibility with RSpec 3 (thanks to @gabrielg)
+
+## [0.5.2] - 2015-02-03
+
+### Changes
+
+- Support cascading backends for interpolated keys (thanks to @gabrielg)
+
+## [0.5.1] - 2015-01-23
+
+### New Features
+
+- Add RSpec helpers (thanks to @gabrielg)
+
+[1.1.0]: https://github.com/ahorner/text-helpers/compare/v1.0.1...v1.1.0
+[1.0.1]: https://github.com/ahorner/text-helpers/compare/v1.0.0...v1.0.1
+[1.0.0]: https://github.com/ahorner/text-helpers/compare/v0.7.2...v1.0.0
+[0.7.2]: https://github.com/ahorner/text-helpers/compare/v0.7.1...v0.7.2
+[0.7.1]: https://github.com/ahorner/text-helpers/compare/v0.7.0...v0.7.1
+[0.7.0]: https://github.com/ahorner/text-helpers/compare/v0.6.1...v0.7.0
+[0.6.1]: https://github.com/ahorner/text-helpers/compare/v0.6.0...v0.6.1
+[0.6.0]: https://github.com/ahorner/text-helpers/compare/v0.5.3...v0.6.0
+[0.5.3]: https://github.com/ahorner/text-helpers/compare/v0.5.2...v0.5.3
+[0.5.2]: https://github.com/ahorner/text-helpers/compare/v0.5.1...v0.5.2
+[0.5.1]: https://github.com/ahorner/text-helpers/compare/v0.5.0...v0.5.1

data/README.md

@@ -60,7 +60,9 @@ The controller text helpers described above can be accessed in controller specs
 
 ### 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. 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:
@@ -69,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
@@ -83,7 +87,13 @@ 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

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

@@ -12,7 +12,7 @@ module TextHelpers
       attributes = [
         ("href=\"#{link}\"" if link),
         ("title=\"#{title}\"" if title),
-        ("target=\"_blank\"" if link =~ PROTOCOL_MATCHER),
+        ("target=\"_blank\" rel=\"noopener\"" if link.match?(PROTOCOL_MATCHER)),
       ]
 
       "<a #{attributes.compact.join(" ")}>#{content}</a>"
@@ -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.match?(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.7.0"
+  VERSION = "1.1.0"
 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)
@@ -100,12 +119,12 @@ describe TextHelpers::Translation do
         assert_equal "<em>#{@scoped_text}</em>\n", @helper.html(:test_key, inline: true, orphans: true)
       end
 
-      it "renders internal links without a target" do
+      it "renders internal links without a target or rel" do
         assert_equal "<a href=\"/internal/path\">Internal&nbsp;link</a>\n", @helper.html(:internal_link, inline: true)
       end
 
-      it "renders external links with target='_blank'" do
-        assert_equal "<a href=\"http://external.com\" target=\"_blank\">External&nbsp;link</a>\n", @helper.html(:external_link, inline: true)
+      it "renders external links with target='_blank' and rel='noopener'" do
+        assert_equal "<a href=\"http://external.com\" target=\"_blank\" rel=\"noopener\">External&nbsp;link</a>\n", @helper.html(:external_link, inline: true)
       end
 
       it "interpolates values wrapped in !!" do
@@ -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.7.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Andrew Horner
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-05-06 00:00:00.000000000 Z
+date: 2020-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -89,6 +89,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -108,7 +109,7 @@ homepage: https://github.com/ahorner/text-helpers
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -123,9 +124,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