Class: SemanticallyTaggable::TagList

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ TagList

Returns a new instance of TagList.



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

def initialize(*args)
  self.delimiter = ','
  add(*args)
end

Instance Attribute Details

#delimiter ⇒ Object

Returns the value of attribute delimiter.



3
4
5
 
# File 'lib/semantically_taggable/tag_list.rb', line 3

def delimiter
  @delimiter
end

Class Method Details

.from(string, delimiter = ',') ⇒ Object

Returns a new TagList using the given tag string.

Example:

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



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/semantically_taggable/tag_list.rb', line 16

def self.from(string, delimiter = ',')
  glue   = delimiter.ends_with?(" ") ? delimiter : "#{delimiter} "
  string = string.join(glue) if string.respond_to?(:join)

  new.tap do |tag_list|
    tag_list.delimiter = delimiter

    string = string.to_s.dup

    # Parse the quoted tags
    string.gsub!(/(\A|#{delimiter})\s*"(.*?)"\s*(#{delimiter}\s*|\z)/) { tag_list << $2; $3 }
    string.gsub!(/(\A|#{delimiter})\s*'(.*?)'\s*(#{delimiter}\s*|\z)/) { tag_list << $2; $3 }

    tag_list.add(string.split(delimiter))
  end
end

Instance Method Details

#add(*names) ⇒ Object

Add tags to the tag_list. Duplicate or blank tags will be ignored. Use the :parse option to add an unparsed tag string.

Example:

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



40
41
42
43
44
45
 
# File 'lib/semantically_taggable/tag_list.rb', line 40

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

#remove(*names) ⇒ Object

Remove specific tags from the tag_list. Use the :parse option to add an unparsed tag string.

Example:

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



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

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

#to_s ⇒ Object

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.

Example:

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



67
68
69
70
71
72
73
74
 
# File 'lib/semantically_taggable/tag_list.rb', line 67

def to_s
  tags = frozen? ? self.dup : self
  tags.send(:clean!)

  tags.map do |name|
    name.include?(delimiter) ? "\"#{name}\"" : name
  end.join(delimiter.ends_with?(" ") ? delimiter : "#{delimiter} ")
end