ru_bee 0.0.9 → 0.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NWI5MWIzMTgxM2Q0MDVmY2NkMzdlZjU1N2Q1MGMwZDI5NTY5M2RmMQ==
-  data.tar.gz: !binary |-
-    Nzc4YThhNjA4NmIxODkzNmUyZTFkZTEyYzY3Y2E2NzZhYmExYjFmMA==
+SHA1:
+  metadata.gz: 1ebbdc60feeecd7c9acee31590a037dc0784526f
+  data.tar.gz: 7eec24ba6b08aaf15031a3261f5622501c71981e
 SHA512:
-  metadata.gz: !binary |-
-    NTIxZTBhOTAyNWVkMWE3NDE5MjI3OThiOTU0ODQzZWM3NjNkODU4M2ZiMmYz
-    Y2NiY2IzZjllYmZmNTY1NmFlODQ0NjhkMWZhMjdhODg2NjA0MDU3YzY1OTMx
-    NjZkYmY0YzA0YWIxYjEzMDA1ZGI1N2EwNDUzM2IxMzgxOGMxNGE=
-  data.tar.gz: !binary |-
-    ZmZiMWI0NjQyZGRiYzE1NWE3ZDcxM2Q0MmU5Mjk5Y2UzMzc3NTgyNDAxYmU4
-    NjFjZjJlYzZhMWY4YTAwNTY1ZmNkMGYxNGQ3NTMyMzhmMmVkNmYzMDQ3ZWJk
-    NjMwNjM3OTQ5ZWY1YmVlMTc0ZWE4OWIzYTU1M2RiMWViNDEyM2I=
+  metadata.gz: 21c099525f30e85eabd4e6f3a9b72ec5c4149255f6fec80628d8b77a6c35aa422e32c341c2e77a09ef7365ee0a3ff899c3e22e5f83ddb61d069c36eb6b8f4dbc
+  data.tar.gz: e5b9feda7f928d304b204e1a6ff9ac4d8ac41440f6b948609f1b7f0e351c9f1a8e87dea364e981a2bb5a3564e1ac63cbd275d3c07747d2ccc87a0e7e8ec5e9a0

data/README.md

@@ -29,7 +29,7 @@ Or install it yourself as:
 
 ######boolean
 
-Does the string contain a misspelling?
+Checks String for misspelled words. Returns boolean.
 
 ######arguments
 
@@ -37,70 +37,74 @@ Does the string contain a misspelling?
 #correct? language: 'english'
 ```
 
-Other languages coming...
+_Other languages coming..._
 
+######usage
 
 ```ruby
 "This is a correct sentence. It works well and is pretty cool. You can also use numbers 123!".correct?
 ```
 
-##### `=> true`
+###### `=> true`
 
 ```ruby
 "This santence contains a typo.".correct?
 ```
 
-##### `=> false`
+###### `=> false`
 
 
-##misspellings 
+###spell_check
 
 ```
-#misspellings
+#spell_check
 ```
 
-######Array
-
-Array of misspellings from String
-
-######arguments
+######array
 
 ```
-#misspellings? language: 'english'
+#spell_check language: 'english'
 ```
 
-```ruby
-"This is a correct sentence. It works well and is pretty cool. You can also use numbers 123!".misspellings
-```
+Returns array of hashes consisting of word and suggestioned corrections.
 
-##### `=> []`
+######usage
 
 ```ruby
-"This santence contains a typo.".misspellings
+'fla'.spell_check 
 ```
 
-##### `=> ['santence']`
+###### `=> [{word: 'fla', suggestions: ["flab", "flabbergast", "flabbergastation", "flabbergasted"...]}]`
 
 
-###suggestions
+###misspellings 
 
 ```
-#misspellings(suggestions: true)
+#misspellings
 ```
 
-Returns array of hashes consisting of word and suggestions.
+######array
+
+Array of misspellings from String
 
 ```ruby
-'fla'.misspellings suggestions: true
+"This is a correct sentence. It works well and is pretty cool. You can also use numbers 123!".misspellings
 ```
 
-##### `=> [{word: 'fla', suggestions: ["acriflavin", "acriflavine"...]}]`
+###### `=> []`
 
+```ruby
+"This santence contains a typo.".misspellings
+```
 
+###### `=> ['santence']`
 
 
 ## Contributing
 
+#### Code
+fork or pr away
+
 #### Dictionaries
 Add issue or submit pull request to add different languages or make additions to the library.
 Each dictionary is in lib/dictionaries

data/lib/ru_bee/version.rb

@@ -1,3 +1,3 @@
 module RuBee
-  VERSION = "0.0.9"
+  VERSION = "0.1.0"
 end

data/lib/scanner.rb

@@ -8,6 +8,10 @@ class String
     check
   end
 
+  def spell_check opt={}
+    misspellings opt.merge!(suggestions: true)
+  end
+
   def misspellings options={}
     @options = options
     check({collect: true, suggestions: @options[:suggestions]})

data/ru_bee.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = RuBee::VERSION
   spec.authors       = ["dan"]
   spec.email         = ["danbickford007@yahoo.com"]
-  spec.summary       = %q{Dictionary for Ruby String.}
-  spec.description   = %q{Checks Ruby String for misspellings. Usage: 'this is a test'.correct?  'this is a test'.misspellings(suggestions: true)}
+  spec.summary       = %q{Spell check for Ruby String.}
+  spec.description   = %q{Checks for words within a String that are spelled incorrectly and offers suggestions for a correction . Usage: 'this is a test'.correct? or 'this is a test'.spell_check or 'this is a test'.misspellings}
   spec.homepage      = ""
   spec.license       = "MIT"
 

data/spec/scanner_spec.rb

@@ -18,6 +18,15 @@ describe String do
 
   end
 
+  describe '#spell_check' do
+
+    it 'should return true with correct word' do
+      expect(test_string_good).to receive(:misspellings)
+      test_string_good.spell_check
+    end
+
+  end
+
   describe '#misspellings' do
 
     it 'should return array of misspelled words' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ru_bee
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - dan
@@ -14,28 +14,28 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !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'
 - !ruby/object:Gem::Dependency
@@ -52,15 +52,16 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.2.0
-description: ! 'Checks Ruby String for misspellings. Usage: ''this is a test''.correct?  ''this
-  is a test''.misspellings(suggestions: true)'
+description: 'Checks for words within a String that are spelled incorrectly and offers
+  suggestions for a correction . Usage: ''this is a test''.correct? or ''this is a
+  test''.spell_check or ''this is a test''.misspellings'
 email:
 - danbickford007@yahoo.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -87,20 +88,20 @@ 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.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Dictionary for Ruby String.
+summary: Spell check for Ruby String.
 test_files:
 - spec/dictionary_spec.rb
 - spec/scanner_spec.rb