html_spellchecker 0.1.2

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Bruno Michel
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+HTML Spellchecker
+=================
+
+Wants to spellcheck an HTML string properly? This gem is for you.
+It's powered by [Nokogiri](http://nokogiri.org/) and
+[hunspell-ffi](https://github.com/ahaller/hunspell-ffi)!
+
+
+How to use it
+-------------
+
+It's very simple. Install it with rubygems:
+
+    gem install html_spellchecker
+
+Or, if you use bundler, add it to your `Gemfile`:
+
+    gem "html_spellchecker", :version => "~>0.1"
+
+Then you can use it in your code:
+
+    require "html_spellchecker"
+	HTML_Spellchecker.english.spellcheck("<p>This is xzqwy.</p>")
+	# => "<p>This is <mark class="misspelled">xzqwy</mark>.</p>"
+
+The HTML_Spellchecker class can be initialized by giving 2 paths:
+the affinity and dictionnary for hunspell. There are helpers to
+create a new instance for english and french dictionnaries.
+
+Then, you can use `spellcheck` method: you give it an HTML string
+and it returns you with the same string with misspelled words
+enclosed in `<mark>` tags (with the `misspelled` class).
+
+HTML_Spellchecker can avoid to check the spelling of special tags
+like `<code>`, by keeping a list of the tags to spellcheck in
+`HTML_Spellchecker.spellcheckable_tags`.
+
+
+Issues or Suggestions
+---------------------
+
+Found an issue or have a suggestion? Please report it on
+[Github's issue tracker](http://github.com/nono/HTML-Spellchecker/issues).
+
+If you wants to make a pull request, please check the specs before:
+
+    rspec spec
+
+
+Credits
+-------
+
+Thanks [Andreas Haller](https://github.com/ahaller) for the hunspell-ffi gem.
+
+Copyright (c) 2011 Bruno Michel <bmichel@menfin.info>, released under the MIT license

data/lib/html_spellchecker.rb

@@ -0,0 +1,62 @@
+# Encoding: UTF-8
+
+require "hunspell-ffi"
+require "nokogiri"
+require "set"
+
+
+class HTML_Spellchecker
+  def self.english
+    @english ||= self.new("/usr/share/hunspell/en_US.aff", "/usr/share/hunspell/en_US.dic")
+  end
+
+  def self.french
+    @french ||= self.new("/usr/share/hunspell/fr_FR.aff", "/usr/share/hunspell/fr_FR.dic")
+  end
+
+  def initialize(aff, dic)
+    @dict = Hunspell.new(aff, dic)
+  end
+
+  def spellcheck(html)
+    Nokogiri::HTML::DocumentFragment.parse(html).spellcheck(@dict)
+  end
+
+  class <<self
+    attr_accessor :spellcheckable_tags
+  end
+  self.spellcheckable_tags = Set.new(%w(p ol ul li div header article nav section footer aside dd dt dl
+                                        span blockquote cite q mark ins del table td th tr tbody thead tfoot
+                                        a b i s em small strong hgroup h1 h2 h3 h4 h5 h6))
+end
+
+class Nokogiri::HTML::DocumentFragment
+  def spellcheckable?
+    true
+  end
+end
+
+class Nokogiri::XML::Node
+  def spellcheck(dict)
+    if spellcheckable?
+      inner = children.map {|child| child.spellcheck(dict) }.join
+      children.remove
+      add_child Nokogiri::HTML::DocumentFragment.parse(inner)
+    end
+    to_html(:indent => 0)
+  end
+
+  def spellcheckable?
+    HTML_Spellchecker.spellcheckable_tags.include? name
+  end
+end
+
+class Nokogiri::XML::Text
+  WORDS_REGEXP = RUBY_VERSION =~ /^1\.8/ ? /\w+/ : /\p{Word}+/
+
+  def spellcheck(dict)
+    to_xhtml(:encoding => 'UTF-8').gsub(WORDS_REGEXP) do |word|
+      dict.check(word) ? word : "<mark class=\"misspelled\">#{word}</mark>"
+    end
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification 
+name: html_spellchecker
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- Bruno Michel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-03 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 4
+        version: "1.4"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hunspell-ffi
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 592302929
+        segments: 
+        - 0
+        - 1
+        - 3
+        - alpha
+        - 2
+        version: 0.1.3.alpha2
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 4
+        version: "2.4"
+  type: :development
+  version_requirements: *id003
+description: Wants to spellcheck an HTML string properly? This gem is for you.
+email: bmichel@menfin.info
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- MIT-LICENSE
+- README.md
+- Gemfile
+- lib/html_spellchecker.rb
+has_rdoc: true
+homepage: http://github.com/nono/HTML-Spellchecker
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Wants to spellcheck an HTML string properly? This gem is for you.
+test_files: []
+