spell 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ced55319ca8557405a6924cdb1b44d8f9b7cc1c
+  data.tar.gz: 2d8e7811a225f6ef5ad3eb0f302b7ecfcbec53fd
+SHA512:
+  metadata.gz: 7b0d2f24e3351687ab6db89414c41f726e7a73a3ee8d4379ac51b06db6a25ed33a081ca3754521fd3eb482ed74aa92e74672652fec91cccd3361b061f230ec0d
+  data.tar.gz: ff69fb892e76be991b0452e073ac6d82829519db3a36b90d41aa09113d4050fe3fb686387ac68118d7da1f37283ef0863b9da865f00f84eb649d86a7cbaa2915

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in spell.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jonathan Arnett
+
+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,72 @@
+# Spell
+
+Spell checker written in pure Ruby, implementing a simple bigram comparison algorithm. Spell has no external dependencies (including aspell or ispell).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'spell'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spell
+
+## Usage
+
+The spell initializer can take one or two arguments.
+
+If you do not care about using the word usage, you can simply write:
+```ruby
+word_list = ["alpha", "beta"]
+spell = Spell::Spell.new(word_list)
+spell.best_match('alphabet')  #=> "alpha"
+```
+
+If you want to include word usage in the best match calculation, you must provide a hash where the keys are the words and the values are the corresponding word counts.
+
+The default for the word usage weight (internally termed "alpha") is 0.3. This value should be in the range 0.0-1.0, where 0.0 means the word usage does not affect the output, whereas 1.0 means the most used word is always returned.
+
+If you want to accept the default weight, you can simply write:
+```ruby
+word_list = { "alpha" => 2, "beta" => 20 }
+spell = Spell::Spell.new(word_list)
+spell.best_match('alphabet')  #=> "alpha"
+```
+
+Or, if you'd rather specify a custom word weight, you can specify it like this:
+```ruby
+word_list = { "alpha" => 8, "beta" => 2 }
+spell = Spell::Spell.new(word_list, 0.5)
+spell.best_match('alphabet')  #=> "beta"
+```
+
+Other than the `best_match` method, shown above, there is also a method `compare`, which returns the how similar two words are, based on shared, order-consistent bigrams compared to the maximum number of bigrams of the two words.
+
+```ruby
+word_list = ["alpha", "beta"]
+spell = Spell::Spell.new(word_list)
+spell.compare('alpha', 'alphabet')  #=> 0.5714285714285714 (4 / 7)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/J3RN/spellrb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "spell"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/spell.rb

@@ -0,0 +1,2 @@
+require "spell/version"
+require "spell/spell"

data/lib/spell/spell.rb

@@ -0,0 +1,100 @@
+module Spell
+  class Spell
+    def initialize(*args)
+      fail "Too many arguments given" if args.count > 3
+
+      if args[0].is_a? Hash
+        @word_list = args[0]
+        @alpha = args[1] || 0.3
+      elsif args[0].is_a? Array
+        @word_list = args[0]
+      else
+        fail "First argument must be an Array or Hash"
+      end
+    end
+
+    # Return a value from 0.0-1.0 of how similar these two words are
+    def compare(word1, word2)
+      bigram_compare(bigramate(word1), bigramate(word2))
+    end
+
+    # Returns the closest matching word in the dictionary
+    def best_match(given_word)
+      words = (@word_list.is_a? Array) ? @word_list : @word_list.keys
+
+      word_bigrams = bigramate(given_word)
+      word_hash = words.map do |key|
+        [key, bigram_compare(word_bigrams, bigramate(key))]
+      end.to_h
+
+      # Weight by word usage, if logical
+      word_hash = apply_usage_weights(word_hash) if @word_list.is_a? Hash
+
+      word_hash.max_by { |key, value| value }.first
+    end
+
+    private
+
+    # Returns the number of matching bigrams between the two sets of bigrams
+    def num_matching(one_bigrams, two_bigrams, acc = 0)
+      return acc if (one_bigrams.empty? || two_bigrams.empty?)
+
+      one_two = one_bigrams.index(two_bigrams[0])
+      two_one = two_bigrams.index(one_bigrams[0])
+
+      if (one_two.nil? && two_one.nil?)
+        num_matching(one_bigrams.drop(1), two_bigrams.drop(1), acc)
+      else
+        # If one is nil, it is set to the other
+        two_one ||= one_two
+        one_two ||= two_one
+
+        if one_two < two_one
+          num_matching(one_bigrams.drop(one_two + 1), two_bigrams.drop(1), acc + 1)
+        else
+          num_matching(one_bigrams.drop(1), two_bigrams.drop(two_one + 1), acc + 1)
+        end
+      end
+    end
+
+    # Returns an array of the word's bigrams (in order)
+    def bigramate(word)
+      (0..(word.length - 2)).map { |i| word.slice(i, 2) }
+    end
+
+    # Returns a value from 0 to 1 for how likely these two words are to be a match
+    def bigram_compare(word1_bigrams, word2_bigrams)
+      most_bigrams = [word1_bigrams.count, word2_bigrams.count].max
+      num_matching(word1_bigrams, word2_bigrams).to_f / most_bigrams
+    end
+
+    # For each word, adjust it's score by usage
+    #
+    # v = s * (1 - a) + u * a
+    # Where v is the new value
+    # a is @alpha
+    # s is the bigram score (0..1)
+    # u is the usage score (0..1)
+    def apply_usage_weights(word_hash)
+      max_usage = @word_list.values.max.to_f
+      max_usage = 1 if max_usage == 0
+
+      weighted_array = word_hash.map do |word, bigram_score|
+        usage_score = @word_list[word].to_f / max_usage
+        [word, (bigram_score * (1 - @alpha)) + (usage_score * @alpha)]
+      end
+
+      weighted_array.to_h
+    end
+
+    # Returns a boolean for whether or not 'word' is in the dictionary
+    def spelled_good?(word)
+      @word_list.keys.include?(word)
+    end
+
+    # Increment count on each utterance
+    def add_count(word)
+      @word_list[word] += 1
+    end
+  end
+end

data/lib/spell/version.rb

@@ -0,0 +1,3 @@
+module Spell
+  VERSION = "0.1.0"
+end

data/spell.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spell/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spell"
+  spec.version       = Spell::VERSION
+  spec.authors       = ["Jonathan Arnett"]
+  spec.email         = ["jonarnett90@gmail.com"]
+
+  spec.summary       = %q{A customizable spell checker, written in pure Ruby }
+  spec.description   = %q{Spell checker written in pure Ruby, implementing a simple bigram comparison algorithm. Spell has no external dependencies (including aspell or ispell). }
+  spec.homepage      = "https://github.com/J3RN/spellrb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: spell
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonathan Arnett
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 'Spell checker written in pure Ruby, implementing a simple bigram comparison
+  algorithm. Spell has no external dependencies (including aspell or ispell). '
+email:
+- jonarnett90@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/spell.rb
+- lib/spell/spell.rb
+- lib/spell/version.rb
+- spell.gemspec
+homepage: https://github.com/J3RN/spellrb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: A customizable spell checker, written in pure Ruby
+test_files: []