yard-spellcheck 0.1.1 → 0.1.2

data/ChangeLog.md

@@ -1,3 +1,8 @@
+### 0.1.2 / 2011-05-17
+
+* Added a work-around for FFI 1.0.8 not accepting frozen Strings.
+* Filter words specified by `--ignore`.
+
 ### 0.1.1 / 2011-01-25
 
 * Do not load `yard` within the plugin.

data/gemspec.yml

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

data/lib/yard/spellcheck/checker.rb

@@ -41,10 +41,10 @@ module YARD
       # @option options [String, Symbol] :lang (FFI::Hunspell.lang)
       #   The language to spellcheck against.
       #
-      # @option options [Array, Set] :ignore
+      # @option options [Array<String>, Set<String>] :ignore
       #   The words to ignore.
       #
-      # @option options [Array, Set] :add
+      # @option options [Array<String>] :add
       #   The words to add to the dictionary.
       #
       def initialize(options={})
@@ -92,7 +92,7 @@ module YARD
 
         FFI::Hunspell.dict(@lang) do |dict|
           # add user specified words
-          @added.each { |word| dict.add(word) }
+          @added.each { |word| dict.add(word.dup) }
 
           unless names.empty?
             names.each do |name|
@@ -161,17 +161,25 @@ module YARD
       def spellcheck(text,dict)
         typos = Set[]
 
-        text.scan(WORD_REGEXP).each do |word|
-          # ignore all underscored names
-          next if word.include?('_')
+        text.each_line do |line|
+          # ignore indented lines
+          next if line =~ /^\s{2,}/
 
-          # ignore all acronyms and CamelCase words
-          next if (word =~ ACRONYM_REGEXP || word =~ CAMEL_CASE_REGEXP)
+          line.scan(WORD_REGEXP).each do |word|
+            # ignore all underscored names
+            next if word.include?('_')
 
-          if (@misspelled.has_key?(word) || !dict.valid?(word))
-            @misspelled[word] += 1
+            # ignore all acronyms and CamelCase words
+            next if (word =~ ACRONYM_REGEXP || word =~ CAMEL_CASE_REGEXP)
 
-            typos << word
+            # skip ignored words
+            next if @ignore.include?(word)
+
+            if (@misspelled.has_key?(word) || !dict.valid?(word))
+              @misspelled[word] += 1
+
+              typos << word
+            end
           end
         end
 

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: yard-spellcheck
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 1
-  version: 0.1.1
+  prerelease: 
+  version: 0.1.2
 platform: ruby
 authors: 
 - Postmodern
@@ -14,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-25 00:00:00 -08:00
-default_executable: yard-spellcheck
+date: 2011-05-17 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: yard
@@ -25,10 +20,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 6
-        - 0
         version: 0.6.0
   type: :runtime
   version_requirements: *id001
@@ -40,10 +31,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 2
-        - 0
         version: 0.2.0
   type: :runtime
   version_requirements: *id002
@@ -55,10 +42,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 3
-        - 0
         version: 0.3.0
   type: :development
   version_requirements: *id003
@@ -70,15 +53,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 4
-        - 0
         version: 2.4.0
   type: :development
   version_requirements: *id004
 description: Adds the 'spellcheck' command to YARD, which will spellcheck every docstring within your documentation.
-email: postmodern.mod3@gmail.com
+email: 
+- postmodern.mod3@gmail.com
 executables: 
 - yard-spellcheck
 extensions: []
@@ -103,7 +83,6 @@ files:
 - lib/yard/spellcheck/printer.rb
 - spec/spec_helper.rb
 - yard-spellcheck.gemspec
-has_rdoc: yard
 homepage: http://github.com/postmodern/yard-spellcheck
 licenses: 
 - MIT
@@ -117,21 +96,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: yard-spellcheck
-rubygems_version: 1.3.7
+rubygems_version: 1.8.1
 signing_key: 
 specification_version: 3
 summary: Spellcheck your YARD documentat