From 2b617783ad37e1f008499ba8389f50d67e7b78b1 Mon Sep 17 00:00:00 2001 From: Jan Szumiec Date: Wed, 7 Aug 2013 13:14:28 +0100 Subject: excerpt() now accepts regular expression instances as phrases. --- actionview/lib/action_view/helpers/text_helper.rb | 10 +++++++--- actionview/test/template/text_helper_test.rb | 2 ++ 2 files changed, 9 insertions(+), 3 deletions(-) (limited to 'actionview') diff --git a/actionview/lib/action_view/helpers/text_helper.rb b/actionview/lib/action_view/helpers/text_helper.rb index 7cfbca5b6f..2109b2724c 100644 --- a/actionview/lib/action_view/helpers/text_helper.rb +++ b/actionview/lib/action_view/helpers/text_helper.rb @@ -155,9 +155,13 @@ module ActionView def excerpt(text, phrase, options = {}) return unless text && phrase - separator = options[:separator] || '' - phrase = Regexp.escape(phrase) - regex = /#{phrase}/i + separator = options.fetch(:separator, nil) || "" + if Regexp === phrase + regex = phrase + else + phrase = Regexp.escape(phrase) + regex = /#{phrase}/i + end return unless matches = text.match(regex) phrase = matches[0] diff --git a/actionview/test/template/text_helper_test.rb b/actionview/test/template/text_helper_test.rb index a514bba83d..b3bcf4d67b 100644 --- a/actionview/test/template/text_helper_test.rb +++ b/actionview/test/template/text_helper_test.rb @@ -264,6 +264,8 @@ class TextHelperTest < ActionView::TestCase assert_equal("...is a beautiful morn...", excerpt("This is a beautiful morning", "beautiful", :radius => 5)) assert_equal("This is a...", excerpt("This is a beautiful morning", "this", :radius => 5)) assert_equal("...iful morning", excerpt("This is a beautiful morning", "morning", :radius => 5)) + assert_equal("...udge Allen and...", excerpt("This day was challenging for judge Allen and his colleagues.", /\ballen\b/i, :radius => 5)) + assert_equal("...judge Allen and...", excerpt("This day was challenging for judge Allen and his colleagues.", /\ballen\b/i, :radius => 1, :separator => ' ')) assert_nil excerpt("This is a beautiful morning", "day") end -- cgit v1.2.3 From 490f25034d62817f9315084ddc0506ff6bc65055 Mon Sep 17 00:00:00 2001 From: Jan Szumiec Date: Wed, 7 Aug 2013 13:34:24 +0100 Subject: highlight() now accepts regular expressions as well. --- actionview/lib/action_view/helpers/text_helper.rb | 10 ++++++---- actionview/test/template/text_helper_test.rb | 10 +++++++++- 2 files changed, 15 insertions(+), 5 deletions(-) (limited to 'actionview') diff --git a/actionview/lib/action_view/helpers/text_helper.rb b/actionview/lib/action_view/helpers/text_helper.rb index 2109b2724c..e860577d6f 100644 --- a/actionview/lib/action_view/helpers/text_helper.rb +++ b/actionview/lib/action_view/helpers/text_helper.rb @@ -123,7 +123,9 @@ module ActionView text else highlighter = options.fetch(:highlighter, '\1') - match = Array(phrases).map { |p| Regexp.escape(p) }.join('|') + match = Array(phrases).map do |p| + Regexp === p ? p.to_s : Regexp.escape(p) + end.join('|') text.gsub(/(#{match})(?![^<]*?>)/i, highlighter) end.html_safe end @@ -156,11 +158,11 @@ module ActionView return unless text && phrase separator = options.fetch(:separator, nil) || "" - if Regexp === phrase + case phrase + when Regexp regex = phrase else - phrase = Regexp.escape(phrase) - regex = /#{phrase}/i + regex = /#{Regexp.escape(phrase)}/i end return unless matches = text.match(regex) diff --git a/actionview/test/template/text_helper_test.rb b/actionview/test/template/text_helper_test.rb index b3bcf4d67b..2467c9527a 100644 --- a/actionview/test/template/text_helper_test.rb +++ b/actionview/test/template/text_helper_test.rb @@ -222,6 +222,11 @@ class TextHelperTest < ActionView::TestCase ) end + def test_highlight_accepts_regexp + assert_equal("This day was challenging for judge Allen and his colleagues.", + highlight("This day was challenging for judge Allen and his colleagues.", /\ballen\b/i)) + end + def test_highlight_with_multiple_phrases_in_one_pass assert_equal %(wow em), highlight('wow em', %w(wow em), :highlighter => '\1') end @@ -264,9 +269,12 @@ class TextHelperTest < ActionView::TestCase assert_equal("...is a beautiful morn...", excerpt("This is a beautiful morning", "beautiful", :radius => 5)) assert_equal("This is a...", excerpt("This is a beautiful morning", "this", :radius => 5)) assert_equal("...iful morning", excerpt("This is a beautiful morning", "morning", :radius => 5)) + assert_nil excerpt("This is a beautiful morning", "day") + end + + def test_excerpt_with_regex assert_equal("...udge Allen and...", excerpt("This day was challenging for judge Allen and his colleagues.", /\ballen\b/i, :radius => 5)) assert_equal("...judge Allen and...", excerpt("This day was challenging for judge Allen and his colleagues.", /\ballen\b/i, :radius => 1, :separator => ' ')) - assert_nil excerpt("This is a beautiful morning", "day") end def test_excerpt_should_not_be_html_safe -- cgit v1.2.3 From 9f27e1076ac6aacb33b0f4ee0e940c2a90f1c630 Mon Sep 17 00:00:00 2001 From: Lucas Mazza Date: Thu, 19 Jun 2014 14:58:36 -0300 Subject: 'TextHelper#highlight' now accepts a block to highlight the matched words. The helper will yield each matched word, and you can use this instead of the ':highlighter' option for more complex replacing logic: highlight('My email is me@work.com', EMAIL_REGEXP) { |m| mail_to(m) } # => 'My email is me@work.com' --- actionview/CHANGELOG.md | 9 +++++++++ actionview/lib/action_view/helpers/text_helper.rb | 17 ++++++++++++++--- actionview/test/template/text_helper_test.rb | 7 +++++++ 3 files changed, 30 insertions(+), 3 deletions(-) (limited to 'actionview') diff --git a/actionview/CHANGELOG.md b/actionview/CHANGELOG.md index d825d3b627..03ac155848 100644 --- a/actionview/CHANGELOG.md +++ b/actionview/CHANGELOG.md @@ -1,3 +1,12 @@ +* The `highlight` helper now accepts a block to be used instead of the `highlighter` + option. + + *Lucas Mazza* + +* The `except` and `highlight` helpers now accept regular expressions. + + *Jan Szumiec* + * Flatten the array parameter in `safe_join`, so it behaves consistently with `Array#join`. diff --git a/actionview/lib/action_view/helpers/text_helper.rb b/actionview/lib/action_view/helpers/text_helper.rb index e860577d6f..cf5c1b0e81 100644 --- a/actionview/lib/action_view/helpers/text_helper.rb +++ b/actionview/lib/action_view/helpers/text_helper.rb @@ -103,11 +103,14 @@ module ActionView # Highlights one or more +phrases+ everywhere in +text+ by inserting it into # a :highlighter string. The highlighter can be specialized by passing :highlighter # as a single-quoted string with \1 where the phrase is to be inserted (defaults to - # '\1') + # '\1') or passing a block that receives each matched term. # # highlight('You searched for: rails', 'rails') # # => You searched for: rails # + # highlight('You searched for: rails', /for|rails/) + # # => You searched for: rails + # # highlight('You searched for: ruby, rails, dhh', 'actionpack') # # => You searched for: ruby, rails, dhh # @@ -116,17 +119,25 @@ module ActionView # # highlight('You searched for: rails', 'rails', highlighter: '\1') # # => You searched for: rails + # + # highlight('You searched for: rails', 'rails') { |match| link_to(search_path(q: match, match)) } + # # => You searched for: rails def highlight(text, phrases, options = {}) text = sanitize(text) if options.fetch(:sanitize, true) if text.blank? || phrases.blank? text else - highlighter = options.fetch(:highlighter, '\1') match = Array(phrases).map do |p| Regexp === p ? p.to_s : Regexp.escape(p) end.join('|') - text.gsub(/(#{match})(?![^<]*?>)/i, highlighter) + + if block_given? + text.gsub(/(#{match})(?![^<]*?>)/i) { |found| yield found } + else + highlighter = options.fetch(:highlighter, '\1') + text.gsub(/(#{match})(?![^<]*?>)/i, highlighter) + end end.html_safe end diff --git a/actionview/test/template/text_helper_test.rb b/actionview/test/template/text_helper_test.rb index 2467c9527a..858232a2b9 100644 --- a/actionview/test/template/text_helper_test.rb +++ b/actionview/test/template/text_helper_test.rb @@ -265,6 +265,13 @@ class TextHelperTest < ActionView::TestCase assert_equal options, passed_options end + def test_highlight_with_block + assert_equal( + "one two three", + highlight("one two three", ["one", "two", "three"]) { |word| "#{word}" } + ) + end + def test_excerpt assert_equal("...is a beautiful morn...", excerpt("This is a beautiful morning", "beautiful", :radius => 5)) assert_equal("This is a...", excerpt("This is a beautiful morning", "this", :radius => 5)) -- cgit v1.2.3