Class: Middleman::Spellcheck::SpellcheckExtension

Inherits:
Extension
  • Object
show all
Defined in:
lib/middleman-spellcheck/extension.rb

Constant Summary collapse

REJECTED_EXTS = 
%w(.css .js .coffee)

Instance Method Summary collapse

Instance Method Details

#after_build(builder) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/middleman-spellcheck/extension.rb', line 13

def after_build(builder)
  filtered = filter_resources(app, options.page)
  total_misspelled = []

  filtered.each do |resource|
    builder.say_status :spellcheck, "Running spell checker for #{resource.url}", :blue
    current_misspelled = run_check(select_content(resource))
    current_misspelled.each do |misspell|
      builder.say_status :misspell, error_message(misspell), :red
    end
    total_misspelled += current_misspelled
  end

  unless total_misspelled.empty?
    raise Thor::Error, "Build failed. There are spelling errors."
  end
end

#error_message(misspell) ⇒ Object 



91
92
93
 
# File 'lib/middleman-spellcheck/extension.rb', line 91

def error_message(misspell)
  "The word '#{misspell[:word]}' is misspelled"
end

#exclude_allowed(results) ⇒ Object 



69
70
71
 
# File 'lib/middleman-spellcheck/extension.rb', line 69

def exclude_allowed(results)
  results.reject { |entry| option_allowed.include? entry[:word].downcase }
end

#filter_resources(app, pattern) ⇒ Object 



58
59
60
61
 
# File 'lib/middleman-spellcheck/extension.rb', line 58

def filter_resources(app, pattern)
  app.sitemap.resources.select { |resource| resource.url.match(pattern) }
                       .reject { |resource| option_ignored_exts.include? resource.ext }
end

#option_allowed ⇒ Object 



73
74
75
76
77
78
79
80
 
# File 'lib/middleman-spellcheck/extension.rb', line 73

def option_allowed
  allowed = if options.allow.is_a? Array
              options.allow
            else
              [options.allow]
            end
  allowed.map(&:downcase)
end

#option_ignored_exts ⇒ Object 



82
83
84
85
86
87
88
89
 
# File 'lib/middleman-spellcheck/extension.rb', line 82

def option_ignored_exts
  ignored_exts = if options.ignored_exts.is_a? Array
                   options.ignored_exts
                 else
                   [options.ignored_exts]
                 end
  REJECTED_EXTS + ignored_exts
end

#option_tags ⇒ Object 



42
43
44
45
46
47
48
 
# File 'lib/middleman-spellcheck/extension.rb', line 42

def option_tags
  if options.tags.is_a? Array
    options.tags
  else
    [options.tags]
  end
end

#run_check(text, dictionary = "en") ⇒ Object 



63
64
65
66
67
 
# File 'lib/middleman-spellcheck/extension.rb', line 63

def run_check(text, dictionary="en")
  results = Spellchecker.check(text, dictionary)
  results = exclude_allowed(results)
  results.reject { |entry| entry[:correct] }
end

#select_content(resource) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/middleman-spellcheck/extension.rb', line 31

def select_content(resource)
  rendered_resource = resource.render(layout: false)
  doc = Nokogiri::HTML(rendered_resource)

  if options.tags.empty?
    doc.text
  else
    select_tagged_content(doc, option_tags)
  end
end

#select_tagged_content(doc, tags) ⇒ Object 



50
51
52
 
# File 'lib/middleman-spellcheck/extension.rb', line 50

def select_tagged_content(doc, tags)
  tags.map { |tag| texts_for_tag(doc, tag.to_s) }.flatten.join(' ')
end

#texts_for_tag(doc, tag) ⇒ Object 



54
55
56
 
# File 'lib/middleman-spellcheck/extension.rb', line 54

def texts_for_tag(doc, tag)
  doc.css(tag).map(&:text)
end