Class: String

Inherits:
Object
  • Object
show all
Defined in:
lib/headingify/core_ext/string.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#headingified ⇒ Object Also known as: headingified?

Returns the value of attribute headingified.



4
5
6
 
# File 'lib/headingify/core_ext/string.rb', line 4

def headingified
  @headingified
end

Instance Method Details

#headingify ⇒ Object 



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/headingify/core_ext/string.rb', line 7

def headingify
  #
  # built to syntactically supercede String.[titlecase|titleize]
  #
  # example : "garlic is as \%GOOD\% as ten mothers"
  # yields  : "Garlic Is as GOOD as Ten Mothers"
  #
  # based on rules in The Chicago Manual of Style: ed. 16 pgf. 8.155
  # inspired by http://titlecapitalization.com/
  # © 2014 Copyright Chris Calo. Vulcan Creative, LLC.
  #

  # http://en.wikipedia.org/wiki/English_articles
  articles = %w[a an the]

  # http://en.wikipedia.org/wiki/Conjunction_(grammar)
  conjunctions = %w[and but or nor for yet so]

  # http://en.wikipedia.org/wiki/List_of_English_prepositions
  prepositions = %w[a abaft aboard about above absent across afore after 
  against along alongside amid amidst among amongst an anenst apropos 
  apud around as aside astride at athwart atop barring before behind 
  below beneath beside besides between beyond but by circa concerning 
  despite down during except excluding failing following for forenenst 
  from given in including inside into like mid midst minus modulo near 
  nigh next notwithstanding of off on onto opposite out outside over 
  pace past per plus pro qua regarding round sans save since than through 
  thru throughout thruout til till times to toward towards under 
  underneath unlike until unto up upon versus via vice vis-a-vis 
  vis-à-vis with within without worth]

  # combine for ease of iteration
  blacklist = (articles + conjunctions + prepositions).uniq!

  # prepare initial string for modification
  working = self.split

  # determines whether word has quoting characters, or not
  include_open_quote = lambda do |w|
    q = %w[' " ’ ‘ “ ”]

    return !/^(["'‘“’”]).*/.match(w).nil?
  end

  # capitalize only what's necessary
  working.each_with_index do |s, i|
    if s.include? "\%"
      working[i] = s.delete "\\%"

      # buckass patch for executable access
      if working[i][0] == "\\" || working[i][working.length - 1] == "\\"
        working[i].delete! "\\" 
      end

      next
    end

    next if s =~ /^o'.*$/
    if blacklist.include?(s) && i == 0; s.capitalize!; next; end
    blacklist.include?(s) ? s.downcase! : s.capitalize!

    if include_open_quote.call(s)
      open = /^(["'‘“’”])([a-zA-Z]*)(["'‘“’”])?([\.\?!])?$/.match(s)[1]
      temp = /^(["'‘“’”])([a-zA-Z]*)(["'‘“’”])?([\.\?!])?$/.match(s)[2]
      last = /^(["'‘“’”])([a-zA-Z]*)(["'‘“’”])?([\.\?!])?$/.match(s)[3]
      punc = /^(["'‘“’”])([a-zA-Z]*)(["'‘“’”])?([\.\?!])?$/.match(s)[4]

      unless temp.nil?
        blacklist.include?(temp) ? temp.downcase! : temp.capitalize!
        temp = open + temp unless open.nil?
        temp = temp + last unless last.nil?
        temp = temp + punc unless punc.nil?
        working[i] = temp
      end
    end
  end

  result = working.join(" ")
  result.headingified = true

  return result
end

#headingify! ⇒ Object 



90
91
92
93
94
 
# File 'lib/headingify/core_ext/string.rb', line 90

def headingify!
  replace self.headingify
  self.headingified = true
  return self
end

#headingify_safe ⇒ Object 



96
97
98
 
# File 'lib/headingify/core_ext/string.rb', line 96

def headingify_safe
  return self.headingify unless self.headingified?; nil
end

#headingify_safe! ⇒ Object 



100
101
102
103
104
105
106
 
# File 'lib/headingify/core_ext/string.rb', line 100

def headingify_safe!
  unless self.headingified?
    replace self.headingify
    self.headingified = true
    return self
  end
end