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 



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
 
# File 'lib/middleman-spellcheck/extension.rb', line 17

def after_build(builder)
  Spellchecker.cmdargs=(options.cmdargs)
  Spellchecker.debug_enabled=(options.debug)
  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), options.lang)
    current_misspelled.each do |misspell|
      builder.say_status :misspell, error_message(misspell), :red
    end
    total_misspelled += current_misspelled
  end

  unless total_misspelled.empty?
	  estr = "Build failed. There are spelling errors."
	  if options.dontfail
	    print "== :dontfail set! Will issue warning only, but not fail.\n"
	    print estr, "\n"
	  else
      raise Thor::Error, estr
	  end
  end
end

#error_message(misspell) ⇒ Object 



103
104
105
 
# File 'lib/middleman-spellcheck/extension.rb', line 103

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

#exclude_allowed(results) ⇒ Object 



81
82
83
 
# File 'lib/middleman-spellcheck/extension.rb', line 81

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

#filter_resources(app, pattern) ⇒ Object 



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

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 



85
86
87
88
89
90
91
92
 
# File 'lib/middleman-spellcheck/extension.rb', line 85

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

#option_ignored_exts ⇒ Object 



94
95
96
97
98
99
100
101
 
# File 'lib/middleman-spellcheck/extension.rb', line 94

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 



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

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

#run_check(text, lang) ⇒ Object 



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

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

#select_content(resource) ⇒ Object 



43
44
45
46
47
48
49
50
51
52
 
# File 'lib/middleman-spellcheck/extension.rb', line 43

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 



62
63
64
 
# File 'lib/middleman-spellcheck/extension.rb', line 62

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 



66
67
68
 
# File 'lib/middleman-spellcheck/extension.rb', line 66

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