Class: TagList

Inherits:
Array
  • Object
show all
Defined in:
lib/tag_list.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ TagList

Returns a new instance of TagList.


5
6
7
# File 'lib/tag_list.rb', line 5

def initialize(*args)
  add(*args)
end

Class Method Details

.from(source) ⇒ Object

Returns a new TagList using the given tag string.

tag_list = TagList.from("One , Two,  Three")
tag_list # ["One", "Two", "Three"]

86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
# File 'lib/tag_list.rb', line 86

def from(source)
  returning new do |tag_list|
    
    case source
      when Array
        tag_list.add(source)
      else
        string = source.to_s.dup
        
        # Parse the quoted tags
        [
          /\s*#{delimiter}\s*(['"])(.*?)\1\s*/,
          /^\s*(['"])(.*?)\1\s*#{delimiter}?/
        ].each do |re|
          string.gsub!(re) { tag_list << $2; "" }
        end
        
        tag_list.add(string.split(delimiter))
    end
  end
end

Instance Method Details

#add(*names) ⇒ Object

Add tags to the tag_list. Duplicate or blank tags will be ignored.

tag_list.add("Fun", "Happy")

Use the :parse option to add an unparsed tag string.

tag_list.add("Fun, Happy", :parse => true)

16
17
18
19
20
21
# File 'lib/tag_list.rb', line 16

def add(*names)
  extract_and_apply_options!(names)
  concat(names)
  clean!
  self
end

#remove(*names) ⇒ Object

Remove specific tags from the tag_list.

tag_list.remove("Sad", "Lonely")

Like #add, the :parse option can be used to remove multiple tags in a string.

tag_list.remove("Sad, Lonely", :parse => true)

30
31
32
33
34
# File 'lib/tag_list.rb', line 30

def remove(*names)
  extract_and_apply_options!(names)
  delete_if { |name| names.include?(name) }
  self
end

#to_sObject

Transform the tag_list into a tag string suitable for edting in a form. The tags are joined with TagList.delimiter and quoted if necessary.

tag_list = TagList.new("Round", "Square,Cube")
tag_list.to_s # 'Round, "Square,Cube"'

54
55
56
57
58
59
60
# File 'lib/tag_list.rb', line 54

def to_s
  clean!
  
  map do |name|
    name.include?(delimiter) ? "\"#{name}\"" : name
  end.join(delimiter.ends_with?(" ") ? delimiter : "#{delimiter} ")
end

#toggle(*names) ⇒ Object

Toggle the presence of the given tags. If a tag is already in the list it is removed, otherwise it is added.


38
39
40
41
42
43
44
45
46
47
# File 'lib/tag_list.rb', line 38

def toggle(*names)
  extract_and_apply_options!(names)
  
  names.each do |name|
    include?(name) ? delete(name) : push(name)
  end
  
  clean! 
  self
end