ru_bee 0.0.7 → 0.0.8

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MmQyNTg0NWQ5NDM0OWZjYjJmZTk1ZTc0MzA0MTE5YTVlMWYyNzExYw==
+    ODM4ZWFiNTliOTgwNjk5ODYwNGU0MTNlOTZmOTdjNzRhM2I0NzIwNg==
   data.tar.gz: !binary |-
-    OTVhNDE2MjY4MDU4MzkwMWE0NDJhNDdiZWY1N2FkZjUwODUyYjUxMA==
+    NmQ2NWZhYjNhZGVkNjMyNjQzNjI1YjBhMmExNDVkMzZmYmU4ZWNkNw==
 SHA512:
   metadata.gz: !binary |-
-    Nzk4ZDk1YWI4MDAwNTYzOGQ1OGRhNGYyNjJiNDJlZGQ0ZThiZmM5M2M1MDZi
-    M2ZiMzJmMTM5ODIzNTUxNzQwZmM1MzExNzcwYzMyOTJjYzRjOGE3MjlkZTNk
-    ZTVlYjBlMmVhMzUxMDAyOGE3YTQ5YmFhNTUyMjVjYTdmOWQxODY=
+    NTQ1YmE4NTJlNGQzNjVmZjVjMWM5MDc3ZTk4NGU5YTE1ZWY1OWEwOGE3OTVl
+    NDUxZWZiM2EyMDUzNzIzN2RjYmYzNzgwMzQ2NzFkMDk4NWU2N2NmNzI1NTc2
+    NWUwNjU0YmYwNzY1MjcwOTViNTI1YTE1Zjk0NmFhNjIyNmM0MWI=
   data.tar.gz: !binary |-
-    ZWZmZDMyNjcyMDkyZWFhMDY4MjQyZGQwMTgxMWZjZTRjNjc5MDQwOWM5ZDQy
-    YmY1NjFlYmNiYzU4OGU5N2ExY2U0ZmZhODNhNWU4NzVkZjczMjJhMTlhZGQw
-    ZGMzNDFjM2U1N2UwMDMxYjJjMjM4OGMzYmMyZWY0ODljODlhYjY=
+    ZmQ4MTVhODVkNWU3MTA2YWI0MjI5MDZkNmJjODViMjYwNmVlZGM5MTIyODVk
+    YmQ1ZThlMjg5MjkxNDU3NzdhMmI4MGVhMGZiYjI5ZWQxZDMwZTQ5Y2Y1YjI5
+    ZGQ5ZmE5ZDRkMmVhMTZiMTQ3NmQ1MjMyMmZiMzM2NjAxMDliZGY=

data/README.md

@@ -21,7 +21,11 @@ Or install it yourself as:
 
 ## Usage
 
-`#correct?`
+###correct?
+
+```
+#correct?
+```
 
 ######boolean
 
@@ -29,22 +33,31 @@ Does the string contain a misspelling?
 
 ######arguments
 
-`#correct? language: 'english'`
+```
+#correct? language: 'english'
+```
 
 Other languages coming...
 
 
-`"This is a correct sentence. It works well and is pretty cool. You can also use numbers 123!".correct?`
+```ruby
+"This is a correct sentence. It works well and is pretty cool. You can also use numbers 123!".correct?
+```
 
 ##### `=> true`
 
-`"This santence contains a typo.".correct?`
+```ruby
+"This santence contains a typo.".correct?
+```
 
 ##### `=> false`
 
 
+##misspellings 
 
-`#misspellings`
+```
+#misspellings
+```
 
 ######Array
 
@@ -52,19 +65,40 @@ Array of misspellings from String
 
 ######arguments
 
-`#misspellings? language: 'english'`
-
-Other languages coming...
+```
+#misspellings? language: 'english'
+```
 
-`"This is a correct sentence. It works well and is pretty cool. You can also use numbers 123!".misspellings`
+```ruby
+"This is a correct sentence. It works well and is pretty cool. You can also use numbers 123!".misspellings
+```
 
 ##### `=> []`
 
-`"This santence contains a typo.".correct?`
+```ruby
+"This santence contains a typo.".misspellings
+```
 
 ##### `=> ['santence']`
 
 
+###suggestions
+
+```
+#misspellings(suggestions: true)
+```
+
+Returns array of hashes consisting of word and suggestions.
+
+```ruby
+'fla'.misspellings suggestions: true
+```
+
+##### `=> [{word: 'fla', suggestions: ["acriflavin", "acriflavine"...]}]`
+
+
+
+
 ## Contributing
 
 #### Dictionaries

data/lib/dictionary.rb

@@ -0,0 +1,26 @@
+class Dictionary
+
+  def initialize options={}
+    @options = options
+  end
+
+  def self.instance options={}
+    @instance ||= new(options)
+  end
+
+  def contents
+    @contents ||= begin
+      filename = @options[:language] || 'english'
+      path =  File.dirname(__FILE__)
+      file = File.open("#{path}/dictionaries/#{filename}", "r")
+      contents = file.read.downcase.split(/\n/)
+      file.close
+      contents || []
+    end
+  end
+
+  def check word
+    contents.include?(word)
+  end
+
+end

data/lib/ru_bee/version.rb

@@ -1,3 +1,3 @@
 module RuBee
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/scanner.rb

@@ -1,4 +1,5 @@
 require 'suggestion'
+require 'dictionary'
 
 class String 
 
@@ -19,17 +20,6 @@ class String
     @words ||= self.downcase.gsub(/[\'\"]/, '').scan(/[a-z]+/)
   end
 
-  def dictionary
-    @dictionary ||= begin
-      filename = @options[:language] || 'english'
-      path =  File.dirname(__FILE__)
-      file = File.open("#{path}/dictionaries/#{filename}", "r")
-      contents = file.read.downcase.split(/\n/)
-      file.close
-      contents || []
-    end
-  end
-
   def remove_s word
     if word[-1] == 's'
       return word[0...-1] 
@@ -59,15 +49,15 @@ class String
   end
 
   def check opts={}
+    dictionary = Dictionary.instance @options
     @bad_words = []
     words.each do |word|
-      unless dictionary.include?("#{word}") or
-        dictionary.include?("#{remove_s(word)}") or
-        dictionary.include?("#{remove_ed(word)}") or
-        dictionary.include?("#{remove_ing(word)}") or
-        dictionary.include?("#{remove_es(word)}")
-        suggestion = Suggestion.new word, @dictionary
-        @bad_words << (opts[:suggestions] ? suggestion.search : word)
+      unless dictionary.check("#{word}") or
+        dictionary.check("#{remove_s(word)}") or
+        dictionary.check("#{remove_ed(word)}") or
+        dictionary.check("#{remove_ing(word)}") or
+        dictionary.check("#{remove_es(word)}")
+        @bad_words << (opts[:suggestions] ? (Suggestion.new(word, dictionary.contents).search) : word)
         return false unless opts[:collect]
       end
     end

data/lib/suggestion.rb

@@ -31,8 +31,7 @@ class Suggestion
   end
 
   def try_3
-    parts = @word.chars.to_a.join('')
-    @dictionary.join("\n").scan(/(.*[#{parts}]+.*)/).flatten
+    @dictionary.join("\n").scan(/(.*[#{@word}]+.*)/).flatten
   end
 
   def find word

data/ru_bee.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["dan"]
   spec.email         = ["danbickford007@yahoo.com"]
   spec.summary       = %q{Dictionary for Ruby String.}
-  spec.description   = %q{See if a string contains any incorrect words. Use by 'this is a test'.correct?}
+  spec.description   = %q{Checks Ruby String for misspellings. Usage: 'this is a test'.correct?  'this is a test'.misspellings(suggestions: true)}
   spec.homepage      = ""
   spec.license       = "MIT"
 

data/spec/dictionary_spec.rb

@@ -0,0 +1,32 @@
+require 'dictionary'
+
+describe Dictionary do
+
+  let(:dictionary) { Dictionary.instance {}}
+
+  describe '#contents' do
+
+    it 'should have x amount contents' do
+      expect(dictionary.contents.count).to eq(235887)
+    end
+
+  end
+
+  describe '.instance' do
+
+    it 'should only have 1 instance' do
+      dict = Dictionary.instance
+      expect(dictionary.object_id).to eq(dict.object_id)
+    end
+
+  end
+
+  describe '#check' do
+
+    it 'should word exists in contents' do
+      expect(dictionary.check('test')).to eq(true)
+    end
+
+  end
+
+end

data/spec/scanner_spec.rb

@@ -50,15 +50,6 @@ describe String do
 
   end
 
-  describe '#load_dictionary' do
-
-    it 'should set DICTIONARY to' do
-      test_string_good.correct?
-      expect(test_string_good.send('dictionary').count).to eq(235887)
-    end
-
-  end
-
   describe '#remove_s' do
 
     it 'should trim plural to singluar with s' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ru_bee
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - dan
@@ -52,7 +52,8 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.2.0
-description: See if a string contains any incorrect words. Use by 'this is a test'.correct?
+description: ! 'Checks Ruby String for misspellings. Usage: ''this is a test''.correct?  ''this
+  is a test''.misspellings(suggestions: true)'
 email:
 - danbickford007@yahoo.com
 executables: []
@@ -65,6 +66,7 @@ files:
 - README.md
 - Rakefile
 - lib/dictionaries/english
+- lib/dictionary.rb
 - lib/ru_bee.rb
 - lib/ru_bee/version.rb
 - lib/scanner.rb
@@ -72,6 +74,7 @@ files:
 - ru_bee-0.0.2.gem
 - ru_bee.gemspec
 - ru_bee_string.rb
+- spec/dictionary_spec.rb
 - spec/scanner_spec.rb
 - spec/suggestion_spec.rb
 homepage: ''
@@ -99,5 +102,6 @@ signing_key:
 specification_version: 4
 summary: Dictionary for Ruby String.
 test_files:
+- spec/dictionary_spec.rb
 - spec/scanner_spec.rb
 - spec/suggestion_spec.rb