dpickett-tiny_rack_spellchecker 0.1.3

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Dan Pickett
+
+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.rdoc

@@ -0,0 +1,17 @@
+= tiny_rack_spellchecker
+
+A Rack Application that processes tinyMCE spell check requests
+
+Point tinyMCE to this application like so:
+<pre>
+tinyMCE.init({
+  "plugins" : "spellchecker",
+	"theme_advanced_buttons3_add" : "spellchecker",
+  "spellchecker_languages" : "+English=en",
+  "spellchecker_rpc_url" : "/spell_checker",
+  "theme_advanced_buttons1_add" : "spellchecker",
+  });
+</pre>
+== Copyright
+
+Copyright (c) 2009 Dan Pickett. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,70 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "tiny_rack_spellchecker"
+    gem.summary = %Q{A Rack Application that processes tinyMCE spell check requests}
+    gem.email = "dpickett@enlightsolutions.com"
+    gem.homepage = "http://github.com/dpickett/tiny_rack_spellchecker"
+    gem.authors = ["Dan Pickett"]
+    gem.add_dependency("raspell", ">= 1.1")
+    gem.add_dependency("json", ">= 1.1.4")
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'cucumber'
+  require 'cucumber/rake/task'
+
+  Cucumber::Rake::Task.new(:features) do |t|
+    t.cucumber_opts = "features --format pretty" # Any valid command line option can go here.
+  end
+
+rescue LoadError
+  puts "Cucumber not installed. You will not be able to run features"
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tiny_rack_spellchecker #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.4

data/features/spell_checking.feature

@@ -0,0 +1,16 @@
+Feature: Spell Checking
+  In order to provide quality content and a richer experience for users of TinyMCE
+  They should be able to perform spell checking on their content
+
+  Scenario: I perform spell checking with a mispelled word
+    Given I have supplied the content 'Sally sells shesells down by the seashore'
+    When I do a spellcheck
+    Then I should get a response
+    And there should be 1 error
+
+  Scenario: I perform spell checking with perfect spelling
+    Given I have supplied the content 'Sally sells seashells down by the seashore'
+    When I do a spellcheck
+    Then I should get a response
+    And there should be 0 errors
+

data/features/step_definitions/spell_checking_steps.rb

@@ -0,0 +1,21 @@
+Given /^I have supplied the content '(.*)'$/ do |content|
+  @params ||= {}
+  @params["params"] ||= ["en"]
+  @params["method"] = "checkWords"
+  @params["params"] << content.split(" ") 
+end
+
+
+When /^I do a spellcheck$/ do
+  post '/spell_checker', @params.to_json
+end
+
+Then /^I should get a response$/ do
+  assert last_response.ok?
+end
+
+Then /^there should be (\d*) errors?$/ do |error_count|
+  json_hash = JSON.parse(last_response.body) 
+  assert_equal error_count.to_i, json_hash["result"].size
+end
+

data/features/step_definitions/suggest_replacement_steps.rb

@@ -0,0 +1,26 @@
+Given /^I have entered the word '(.*)'$/ do |word|
+  @params = {}
+  @params["params"] = ["en"]
+  @params["params"] << word
+  @params["id"] = "c0"
+end
+
+When /^I request possible replacements$/ do
+  @params["method"] = "getSuggestions"
+  post "/spell_checker", @params.to_json
+  @json_hash = JSON.parse(last_response.body)
+  @result = @json_hash["result"]
+end
+
+Then /^I should get an array of results$/ do
+  assert_instance_of Array, @result
+end
+
+Then /^I should see '(.*)' as a replacement option$/ do |word|
+  assert @result.include?(word)
+end
+
+Then /^I should get a position identifier so I can perform a valid replacement$/ do
+  assert_equal @params["id"], @json_hash["id"] 
+end
+

data/features/suggest_replacements.feature

@@ -0,0 +1,20 @@
+Feature: Mispelled Replacement Suggestion
+In order to provide quality content 
+and a richer experience for users of the TinyMCE editor
+They should be able to get a list of suggested replacements for 
+a misspelled word
+
+  Scenario: I request replacement suggestions for a mispelled word
+    Given I have entered the word 'shesells'
+    When I request possible replacements
+    Then I should get a response
+    And I should get an array of results
+    And I should see 'seashells' as a replacement option
+    And I should get a position identifier so I can perform a valid replacement
+
+  Scenario: I request replacement suggestions for a properly spelled word
+    Given I have entered the word 'seashells'
+    When I request possible replacements
+    Then I should get a response
+    And I should get an array of results
+

data/features/support/env.rb

@@ -0,0 +1,17 @@
+require "test/unit/assertions"
+ 
+require "tiny_rack_spellchecker"
+require "rack/test"
+
+module TinyRackSpellchecker
+  module WorldOfCucumber
+    def app
+      TinyRackSpellchecker::RackApplication.new
+    end
+    
+    include Test::Unit::Assertions
+    include Rack::Test::Methods
+  end
+end
+
+World(TinyRackSpellchecker::WorldOfCucumber)

data/lib/tiny_rack_spellchecker.rb

@@ -0,0 +1,6 @@
+require "raspell"
+require "json"
+
+require "tiny_rack_spellchecker/rack_application"
+require "tiny_rack_spellchecker/request_controller"
+

data/lib/tiny_rack_spellchecker/rack_application.rb

@@ -0,0 +1,18 @@
+module TinyRackSpellchecker
+  class RackApplication
+    def initialize(app = nil, message = "")
+      @app = app
+      @message = message
+    end
+    
+    def call(env)
+      if env["PATH_INFO"] =~ /^\/spell_checker/
+        req = JSON.parse(env["rack.input"].read)
+        results = RequestController.handle(req) 
+        [200, {"Content-Type" => "text/javascript"}, [results.to_json]]
+      else
+        @app.call(env) unless app.nil?
+      end
+    end
+  end
+end

data/lib/tiny_rack_spellchecker/request_controller.rb

@@ -0,0 +1,40 @@
+module TinyRackSpellchecker
+  class RequestController
+    class << self
+      def handle(req)
+        if req["method"] == "getSuggestions"
+          suggest_alternatives_for(req["params"][1], req["id"])
+        else
+          check(req["params"][1])
+        end
+      end
+
+      def check(content)
+        speller = Aspell.new("en_US")
+        bad_words = []
+        content.each do |word| 
+          unless speller.check(word)
+            bad_words << word
+          end
+        end
+
+        { 
+          "id"     => nil,
+          "error"  => nil,
+          "result" => bad_words.uniq
+        }
+      end
+
+      def suggest_alternatives_for(word, position_id)
+        speller = Aspell.new("en_US")
+        {
+          "id"     => position_id,
+          "error"  => nil,
+          "result" => speller.suggest(word)[0..8]
+        }
+      end
+
+    end
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'tiny_rack_spellchecker'
+
+class Test::Unit::TestCase
+end

data/test/tiny_rack_spellchecker_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class TinyRackSpellcheckerTest < Test::Unit::TestCase
+  should "run cucumber features" do
+    flunk "all the good stuff is in the cucumber features - it's a rack app!"
+  end
+end

data/tiny_rack_spellchecker.gemspec

@@ -0,0 +1,60 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{tiny_rack_spellchecker}
+  s.version = "0.1.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dan Pickett"]
+  s.date = %q{2009-05-16}
+  s.email = %q{dpickett@enlightsolutions.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "features/spell_checking.feature",
+     "features/step_definitions/spell_checking_steps.rb",
+     "features/step_definitions/suggest_replacement_steps.rb",
+     "features/suggest_replacements.feature",
+     "features/support/env.rb",
+     "lib/tiny_rack_spellchecker.rb",
+     "lib/tiny_rack_spellchecker/rack_application.rb",
+     "lib/tiny_rack_spellchecker/request_controller.rb",
+     "test/test_helper.rb",
+     "test/tiny_rack_spellchecker_test.rb",
+     "tiny_rack_spellchecker.gemspec"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/dpickett/tiny_rack_spellchecker}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{A Rack Application that processes tinyMCE spell check requests}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/tiny_rack_spellchecker_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<raspell>, [">= 1.1"])
+      s.add_runtime_dependency(%q<json>, [">= 1.1.4"])
+    else
+      s.add_dependency(%q<raspell>, [">= 1.1"])
+      s.add_dependency(%q<json>, [">= 1.1.4"])
+    end
+  else
+    s.add_dependency(%q<raspell>, [">= 1.1"])
+    s.add_dependency(%q<json>, [">= 1.1.4"])
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: dpickett-tiny_rack_spellchecker
+version: !ruby/object:Gem::Version 
+  version: 0.1.3
+platform: ruby
+authors: 
+- Dan Pickett
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-16 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: raspell
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.1"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.4
+    version: 
+description: 
+email: dpickett@enlightsolutions.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- features/spell_checking.feature
+- features/step_definitions/spell_checking_steps.rb
+- features/step_definitions/suggest_replacement_steps.rb
+- features/suggest_replacements.feature
+- features/support/env.rb
+- lib/tiny_rack_spellchecker.rb
+- lib/tiny_rack_spellchecker/rack_application.rb
+- lib/tiny_rack_spellchecker/request_controller.rb
+- test/test_helper.rb
+- test/tiny_rack_spellchecker_test.rb
+- tiny_rack_spellchecker.gemspec
+has_rdoc: true
+homepage: http://github.com/dpickett/tiny_rack_spellchecker
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: A Rack Application that processes tinyMCE spell check requests
+test_files: 
+- test/test_helper.rb
+- test/tiny_rack_spellchecker_test.rb