[Misc] Deprecated TagList.from in favor of TagListParser.parse

lib/acts-as-taggable-on.rb

@@ -11,6 +11,7 @@ module ActsAsTaggableOn
   autoload :Engine
   autoload :Tag
   autoload :TagList
+  autoload :TagListParser
   autoload :Taggable
   autoload :Tagger
   autoload :Tagging

lib/acts_as_taggable_on/tag_list.rb

@@ -1,3 +1,4 @@
+
 require 'active_support/core_ext/module/delegation'
 
 module ActsAsTaggableOn
@@ -8,82 +9,6 @@ def initialize(*args)
       add(*args)
     end
 
-    class << self
-      ##
-      # Returns a new TagList using the given tag string.
-      #
-      # Example:
-      #   tag_list = ActsAsTaggableOn::TagList.from("One , Two,  Three")
-      #   tag_list # ["One", "Two", "Three"]
-      def from(string)
-        string = string.join(ActsAsTaggableOn.glue) if string.respond_to?(:join)
-
-        new.tap do |tag_list|
-          string = string.to_s.dup
-
-
-          string.gsub!(double_quote_pattern) {
-            # Append the matched tag to the tag list
-            tag_list << Regexp.last_match[2]
-            # Return the matched delimiter ($3) to replace the matched items
-            ''
-          }
-
-          string.gsub!(single_quote_pattern) {
-            # Append the matched tag ($2) to the tag list
-            tag_list << Regexp.last_match[2]
-            # Return an empty string to replace the matched items
-            ''
-          }
-
-          # split the string by the delimiter
-          # and add to the tag_list
-          tag_list.add(string.split(Regexp.new delimiter))
-        end
-      end
-
-      def delimiter
-        # Parse the quoted tags
-        d = ActsAsTaggableOn.delimiter
-        # Separate multiple delimiters by bitwise operator
-        d = d.join('|') if d.kind_of?(Array)
-
-        d
-      end
-
-      def single_quote_pattern
-        %r{
-          (             # Tag start delimiter ($1)
-            \A       |  # Either string start or
-            #{delimiter}        # a delimiter
-          )
-          \s*'          # quote (') optionally preceded by whitespace
-          (.*?)         # Tag ($2)
-          '\s*          # quote (') optionally followed by whitespace
-          (?=           # Tag end delimiter (not consumed; is zero-length lookahead)
-            #{delimiter}\s*  |  # Either a delimiter optionally followed by whitespace or
-            \z          # string end
-          )
-      }x
-      end
-
-      def double_quote_pattern
-        %r{
-          (             # Tag start delimiter ($1)
-            \A       |  # Either string start or
-            #{delimiter}        # a delimiter
-          )
-          \s*"          # quote (") optionally preceded by whitespace
-          (.*?)         # Tag ($2)
-          "\s*          # quote (") optionally followed by whitespace
-          (?=           # Tag end delimiter (not consumed; is zero-length lookahead)
-            #{delimiter}\s*  |  # Either a delimiter optionally followed by whitespace or
-            \z          # string end
-          )
-      }x
-      end
-
-    end
     ##
     # Add tags to the tag_list. Duplicate or blank tags will be ignored.
     # Use the <tt>:parse</tt> option to add an unparsed tag string.
@@ -165,12 +90,23 @@ def extract_and_apply_options!(args)
       options = args.last.is_a?(Hash) ? args.pop : {}
       options.assert_valid_keys :parse
 
-      args.map! { |a| self.class.from(a) } if options[:parse]
+      args.map! { |a| TagListParser.parse(a) } if options[:parse]
 
       args.flatten!
     end
 
 
+    ## DEPRECATED
+    def self.from(string)
+      ActiveRecord::Base.logger.warn <<WARNING
+ActsAsTaggableOn::TagList.from is deprecated \
+and will be removed from v4.0+, use  \
+ActsAsTaggableOn::TagListParser.parse instead
+WARNING
+      TagListParser.parse(string)
+    end
+
+
   end
 end
 

lib/acts_as_taggable_on/tag_list_parser.rb

@@ -0,0 +1,78 @@
+module ActsAsTaggableOn
+  ##
+  # Returns a new TagList using the given tag string.
+  #
+  # Example:
+  #   tag_list = ActsAsTaggableOn::TagListParser.parse("One , Two,  Three")
+  #   tag_list # ["One", "Two", "Three"]
+  module TagListParser
+    class << self
+      def parse(string)
+        string = string.join(ActsAsTaggableOn.glue) if string.respond_to?(:join)
+        TagList.new.tap do |tag_list|
+          string = string.to_s.dup
+
+
+          string.gsub!(double_quote_pattern) {
+            # Append the matched tag to the tag list
+            tag_list << Regexp.last_match[2]
+            # Return the matched delimiter ($3) to replace the matched items
+            ''
+          }
+
+          string.gsub!(single_quote_pattern) {
+            # Append the matched tag ($2) to the tag list
+            tag_list << Regexp.last_match[2]
+            # Return an empty string to replace the matched items
+            ''
+          }
+
+          # split the string by the delimiter
+          # and add to the tag_list
+          tag_list.add(string.split(Regexp.new delimiter))
+        end
+      end
+
+
+      # private
+      def delimiter
+        # Parse the quoted tags
+        d = ActsAsTaggableOn.delimiter
+        # Separate multiple delimiters by bitwise operator
+        d = d.join('|') if d.kind_of?(Array)
+        d
+      end
+
+      # (             # Tag start delimiter ($1)
+      # \A       |  # Either string start or
+      # #{delimiter}        # a delimiter
+      # )
+      # \s*"          # quote (") optionally preceded by whitespace
+      # (.*?)         # Tag ($2)
+      # "\s*          # quote (") optionally followed by whitespace
+      # (?=           # Tag end delimiter (not consumed; is zero-length lookahead)
+      # #{delimiter}\s*  |  # Either a delimiter optionally followed by whitespace or
+      # \z          # string end
+      # )
+      def double_quote_pattern
+        /(\A|#{delimiter})\s*"(.*?)"\s*(?=#{delimiter}\s*|\z)/
+      end
+
+      # (             # Tag start delimiter ($1)
+      # \A       |  # Either string start or
+      # #{delimiter}        # a delimiter
+      # )
+      # \s*'          # quote (') optionally preceded by whitespace
+      # (.*?)         # Tag ($2)
+      # '\s*          # quote (') optionally followed by whitespace
+      # (?=           # Tag end delimiter (not consumed; is zero-length lookahead)
+      # #{delimiter}\s*  | d # Either a delimiter optionally followed by whitespace or
+      # \z          # string end
+      # )
+      def single_quote_pattern
+        /(\A|#{delimiter})\s*'(.*?)'\s*(?=#{delimiter}\s*|\z)/
+      end
+
+    end
+  end
+end

lib/acts_as_taggable_on/taggable/ownership.rb

@@ -63,7 +63,7 @@ def set_owner_tag_list_on(owner, context, new_list)
 
       cache = cached_owned_tag_list_on(context)
 
-      cache[owner] = ActsAsTaggableOn::TagList.from(new_list)
+      cache[owner] = ActsAsTaggableOn::TagListParser.parse(new_list)
     end
 
     def reload(*args)

spec/acts_as_taggable_on/tag_list_parser_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe ActsAsTaggableOn::TagListParser do
+  it '#parse should return empty array if empty array is passed' do
+    expect(ActsAsTaggableOn::TagListParser.parse([])).to be_empty
+  end
+
+  describe 'Multiple Delimiter' do
+    before do
+      @old_delimiter = ActsAsTaggableOn.delimiter
+    end
+
+    after do
+      ActsAsTaggableOn.delimiter = @old_delimiter
+    end
+
+    it 'should separate tags by delimiters' do
+      ActsAsTaggableOn.delimiter = [',', ' ', '\|']
+      tag_list = ActsAsTaggableOn::TagListParser.parse('cool, data|I have')
+      expect(tag_list.to_s).to eq('cool, data, I, have')
+    end
+
+    it 'should escape quote' do
+      ActsAsTaggableOn.delimiter = [',', ' ', '\|']
+      tag_list = ActsAsTaggableOn::TagListParser.parse "'I have'|cool, data"
+      expect(tag_list.to_s).to eq('"I have", cool, data')
+
+      tag_list = ActsAsTaggableOn::TagListParser.parse '"I, have"|cool, data'
+      expect(tag_list.to_s).to eq('"I, have", cool, data')
+    end
+
+    it 'should work for utf8 delimiter and long delimiter' do
+      ActsAsTaggableOn.delimiter = ['，', '的', '可能是']
+      tag_list = ActsAsTaggableOn::TagListParser.parse('我的东西可能是不见了，还好有备份')
+      expect(tag_list.to_s).to eq('我， 东西， 不见了， 还好有备份')
+    end
+
+    it 'should work for multiple quoted tags' do
+      ActsAsTaggableOn.delimiter = [',']
+      tag_list = ActsAsTaggableOn::TagListParser.parse('"Ruby Monsters","eat Katzenzungen"')
+      expect(tag_list.to_s).to eq('Ruby Monsters, eat Katzenzungen')
+    end
+  end
+
+end

spec/acts_as_taggable_on/tag_list_spec.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+
 require 'spec_helper'
 
 describe ActsAsTaggableOn::TagList do
@@ -7,9 +7,7 @@
 
   it { should be_kind_of Array }
 
-  it '#from should return empty array if empty array is passed' do
-    expect(ActsAsTaggableOn::TagList.from([])).to be_empty
-  end
+
 
   describe '#add' do
     it 'should be able to be add a new tag word' do
@@ -118,41 +116,5 @@
 
   end
 
-  describe 'Multiple Delimiter' do
-    before do
-      @old_delimiter = ActsAsTaggableOn.delimiter
-    end
-
-    after do
-      ActsAsTaggableOn.delimiter = @old_delimiter
-    end
-
-    it 'should separate tags by delimiters' do
-      ActsAsTaggableOn.delimiter = [',', ' ', '\|']
-      tag_list = ActsAsTaggableOn::TagList.from 'cool, data|I have'
-      expect(tag_list.to_s).to eq('cool, data, I, have')
-    end
-
-    it 'should escape quote' do
-      ActsAsTaggableOn.delimiter = [',', ' ', '\|']
-      tag_list = ActsAsTaggableOn::TagList.from "'I have'|cool, data"
-      expect(tag_list.to_s).to eq('"I have", cool, data')
-
-      tag_list = ActsAsTaggableOn::TagList.from '"I, have"|cool, data'
-      expect(tag_list.to_s).to eq('"I, have", cool, data')
-    end
-
-    it 'should work for utf8 delimiter and long delimiter' do
-      ActsAsTaggableOn.delimiter = ['，', '的', '可能是']
-      tag_list = ActsAsTaggableOn::TagList.from '我的东西可能是不见了，还好有备份'
-      expect(tag_list.to_s).to eq('我， 东西， 不见了， 还好有备份')
-    end
-
-    it 'should work for multiple quoted tags' do
-      ActsAsTaggableOn.delimiter = [',']
-      tag_list = ActsAsTaggableOn::TagList.from '"Ruby Monsters","eat Katzenzungen"'
-      expect(tag_list.to_s).to eq('Ruby Monsters, eat Katzenzungen')
-    end
-  end
 
 end