yard-spellcheck 0.1.0 → 0.1.1

data/ChangeLog.md

@@ -1,3 +1,11 @@
+### 0.1.1 / 2011-01-25
+
+* Do not load `yard` within the plugin.
+* Ignore all Acronyms and CamelCase words.
+* Ignore all words containing underscores.
+* Perform a soft-update of the YARD Cache when running `yard-spellcheck`.
+* Exit with status `-1` if the `yard-spellcheck` command found any typos.
+
 ### 0.1.0 / 2011-01-25
 
 * Initial release:

data/gemspec.yml

@@ -1,5 +1,5 @@
 name: yard-spellcheck
-version: 0.1.0
+version: 0.1.1
 summary: Spellcheck your YARD documentat
 description:
   Adds the 'spellcheck' command to YARD, which will spellcheck every

data/lib/yard/cli/spellcheck.rb

@@ -39,6 +39,8 @@ module YARD
       def run(*args)
         optparse(*args)
 
+        CLI::Yardoc.run('-c', '-n', '--no-stats')
+
         @checker.check!(@names) do |element,typos|
           print_typos element, typos
         end
@@ -47,6 +49,8 @@ module YARD
           puts "Statistics"
           print_stats @checker
         end
+
+        exit -1 unless @checker.misspelled.empty?
       end
 
       protected

data/lib/yard/spellcheck/checker.rb

@@ -1,6 +1,5 @@
 require 'ffi/hunspell'
 require 'set'
-require 'yard'
 
 module YARD
   module Spellcheck
@@ -13,7 +12,13 @@ module YARD
       SKIP_TAGS = Set['example', 'since', 'see', 'api']
 
       # The Regexp to use for scanning in words.
-      WORD_REGEXP = /[^\W_][[^\W_]'-]*[^\W_]/
+      WORD_REGEXP = /[^\W_][\w'-]*[^\W_]/
+
+      # The Regexp to filter out Acronyms.
+      ACRONYM_REGEXP = /(([A-Z]\.){2,}|[A-Z]{2,})/
+
+      # The Regexp to filter out CamelCase words.
+      CAMEL_CASE_REGEXP = /([A-Z][a-z]+){2,}/
 
       # The language to spellcheck against.
       attr_accessor :lang
@@ -24,9 +29,6 @@ module YARD
       # The words to add to the dictionary.
       attr_reader :added
 
-      # The known words from the documentation.
-      attr_reader :known
-
       # The misspelled words.
       attr_reader :misspelled
 
@@ -58,7 +60,6 @@ module YARD
           @added += options[:add]
         end
 
-        @known = Set[]
         @misspelled = Hash.new { |hash,key| hash[key] = 0 }
       end
 
@@ -87,14 +88,8 @@ module YARD
         YARD::Registry.load!
 
         # clear any statistics from last run
-        @known.clear
         @misspelled.clear
 
-        # load known Class and Module names
-        YARD::Registry.all(:class, :module).each do |obj|
-          obj.path.split('::').each { |name| @known << name }
-        end
-
         FFI::Hunspell.dict(@lang) do |dict|
           # add user specified words
           @added.each { |word| dict.add(word) }
@@ -167,7 +162,11 @@ module YARD
         typos = Set[]
 
         text.scan(WORD_REGEXP).each do |word|
-          next if (@known.include?(word) || @ignore.include?(word))
+          # ignore all underscored names
+          next if word.include?('_')
+
+          # ignore all acronyms and CamelCase words
+          next if (word =~ ACRONYM_REGEXP || word =~ CAMEL_CASE_REGEXP)
 
           if (@misspelled.has_key?(word) || !dict.valid?(word))
             @misspelled[word] += 1

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Postmodern