README.md in mini_sanity-1.1.0 vs README.md in mini_sanity-2.0.0
- old
+ new
@@ -1,104 +1,67 @@
-# mini_sanity
+# mini_sanity [](https://travis-ci.org/jonathanhefner/mini_sanity)
In-line [sanity checks], written as extensions to core Ruby objects.
See API listing below, or browse the [full documentation].
[sanity checks]: https://en.wikipedia.org/wiki/Sanity_check
-[full documentation]: http://www.rubydoc.info/gems/mini_sanity/
+[full documentation]: https://www.rubydoc.info/gems/mini_sanity/
## Example
```ruby
require "json"
require "pathname"
-path = Pathname.new("hosted_files.json").assert_exist!
+path = Pathname.new("hosted_files.json").assert!(&:exist?)
-hosted_files = JSON.parse(path.read).assert_instance_of!(Array)
+hosted_files = JSON.parse(path.read).assert!(Array)
urls = hosted_files.flat_map do |file_info|
- file_info.fetch("mirror_urls").refute_empty!
+ file_info.fetch("mirror_urls").refute!(&:empty?)
end
domains = urls.map do |url|
- url.assert_match!(%r"^https?://").split("/")[2]
+ url.assert!(%r"^https?://").split("/")[2]
end.uniq
```
## API
-- [Object](http://www.rubydoc.info/gems/mini_sanity/Object)
- - [#assert_equal!](http://www.rubydoc.info/gems/mini_sanity/Object:assert_equal%21)
- - [#assert_in!](http://www.rubydoc.info/gems/mini_sanity/Object:assert_in%21)
- - [#assert_instance_of!](http://www.rubydoc.info/gems/mini_sanity/Object:assert_instance_of%21)
- - [#assert_kind_of!](http://www.rubydoc.info/gems/mini_sanity/Object:assert_kind_of%21)
- - [#assert_nil!](http://www.rubydoc.info/gems/mini_sanity/Object:assert_nil%21)
- - [#assert_respond_to!](http://www.rubydoc.info/gems/mini_sanity/Object:assert_respond_to%21)
- - [#refute_equal!](http://www.rubydoc.info/gems/mini_sanity/Object:refute_equal%21)
- - [#refute_in!](http://www.rubydoc.info/gems/mini_sanity/Object:refute_in%21)
- - [#refute_nil!](http://www.rubydoc.info/gems/mini_sanity/Object:refute_nil%21)
-- [Array](http://www.rubydoc.info/gems/mini_sanity/Array)
- - [#assert_length!](http://www.rubydoc.info/gems/mini_sanity/Array:assert_length%21)
- - [#refute_length!](http://www.rubydoc.info/gems/mini_sanity/Array:refute_length%21)
-- [Enumerable](http://www.rubydoc.info/gems/mini_sanity/Enumerable)
- - [#assert_empty!](http://www.rubydoc.info/gems/mini_sanity/Enumerable:assert_empty%21)
- - [#refute_empty!](http://www.rubydoc.info/gems/mini_sanity/Enumerable:refute_empty%21)
-- [String](http://www.rubydoc.info/gems/mini_sanity/String)
- - [#assert_empty!](http://www.rubydoc.info/gems/mini_sanity/String:assert_empty%21)
- - [#assert_length!](http://www.rubydoc.info/gems/mini_sanity/String:assert_length%21)
- - [#assert_match!](http://www.rubydoc.info/gems/mini_sanity/String:assert_match%21)
- - [#refute_empty!](http://www.rubydoc.info/gems/mini_sanity/String:refute_empty%21)
- - [#refute_length!](http://www.rubydoc.info/gems/mini_sanity/String:refute_length%21)
- - [#refute_match!](http://www.rubydoc.info/gems/mini_sanity/String:refute_match%21)
-- [Pathname](http://www.rubydoc.info/gems/mini_sanity/Pathname)
- - [#assert_dir!](http://www.rubydoc.info/gems/mini_sanity/Pathname:assert_dir%21)
- - [#assert_exist!](http://www.rubydoc.info/gems/mini_sanity/Pathname:assert_exist%21)
- - [#assert_file!](http://www.rubydoc.info/gems/mini_sanity/Pathname:assert_file%21)
- - [#refute_dir!](http://www.rubydoc.info/gems/mini_sanity/Pathname:refute_dir%21)
- - [#refute_exist!](http://www.rubydoc.info/gems/mini_sanity/Pathname:refute_exist%21)
- - [#refute_file!](http://www.rubydoc.info/gems/mini_sanity/Pathname:refute_file%21)
+- `"mini_sanity/assert"`
+ - [Object#assert!](https://www.rubydoc.info/gems/mini_sanity/Object:assert%21)
+ - [Object#refute!](https://www.rubydoc.info/gems/mini_sanity/Object:refute%21)
+- `"mini_sanity/change"`
+ - [String#change](https://www.rubydoc.info/gems/mini_sanity/String:change)
+ - [String#change!](https://www.rubydoc.info/gems/mini_sanity/String:change%21)
+- `"mini_sanity/match"`
+ - [Regexp#match!](https://www.rubydoc.info/gems/mini_sanity/Regexp:match%21)
+ - [String#match!](https://www.rubydoc.info/gems/mini_sanity/String:match%21)
+- `"mini_sanity/results"`
+ - [Enumerator#result!](https://www.rubydoc.info/gems/mini_sanity/Enumerator:result%21)
+ - [Enumerator#results!](https://www.rubydoc.info/gems/mini_sanity/Enumerator:results%21)
-## Util API
-
-*mini_sanity* also includes a few optional utility methods which perform
-some function, check an assertion on the result, and raise an error with
-a helpful message if the assertion fails. You must add
-`require "mini_sanity/util"` to your script to access these methods.
-
-- [Enumerable](http://www.rubydoc.info/gems/mini_sanity/Enumerable)
- - [#first!](http://www.rubydoc.info/gems/mini_sanity/Enumerable:first%21)
-- [Regexp](http://www.rubydoc.info/gems/mini_sanity/Regexp)
- - [#match!](http://www.rubydoc.info/gems/mini_sanity/Regexp:match%21)
-- [String](http://www.rubydoc.info/gems/mini_sanity/String)
- - [#change](http://www.rubydoc.info/gems/mini_sanity/String:change)
- - [#change!](http://www.rubydoc.info/gems/mini_sanity/String:change%21)
- - [#match!](http://www.rubydoc.info/gems/mini_sanity/String:match%21)
-
-
## Installation
-Install from [Ruby Gems](https://rubygems.org/gems/mini_sanity):
+Install the [gem](https://rubygems.org/gems/mini_sanity):
```bash
$ gem install mini_sanity
```
-Then require in your Ruby script:
+Then require in your Ruby code:
```ruby
require "mini_sanity"
-require "mini_sanity/util" # OPTIONAL
```
## Contributing
-Run `rake test` to run the tests. You can also run `rake irb` for an
-interactive prompt that pre-loads the project code.
+Run `rake test` to run the tests.
## License
[MIT License](https://opensource.org/licenses/MIT)