adomain 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83a5d692e2425fec3d5bbc93a753d7c96a73223f2c0e63c13cb7554519dccf86
-  data.tar.gz: 29d37fcdca4db2f997c4d473b012a06677e06e0d713899e4e76569f2ad2ce630
+  metadata.gz: 1ff6ad12bb0daeb96fbb1ce22ee09f4cf09c5f6a0ac3ef21336792c977e4dce1
+  data.tar.gz: be1e2cfa7e6a72b6595dc2d79e70f636cce95fc3fa9d4215a366b45e458a6baf
 SHA512:
-  metadata.gz: 3f9ffd06b85aac9718c5d450125838acc7a38034fa805f5578c621d70522e3d33dbe451c988c56c6a593d9b0e2359fca128975599f53a21956883c1fc8993d2d
-  data.tar.gz: ae911c83f0e65a877837b3fb8cd4eeacf2d9058f380b2a07da48369880d532bb7c04eb2747196c5f0aaa68c1b2ba962adf5bfbd730eef53a5bb0924a3416a783
+  metadata.gz: 50d9e06e046e86d8f5e4f5fd9c58af82f101c62ddfff23a263571f2afc7315d5ea555da4ed52a4df33399c629baecbf0e98da6137b17b5487470a8cb991b4c62
+  data.tar.gz: b75ef3af5862e458d9389ce3bba1ba385d1bf528f30ae842c5c7121a9e818871203e728855aef1a4440f0f8060e6ed276ab42cee352e60dd0d93de93f3283ca1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    adomain (0.1.2)
+    adomain (0.2.0)
       addressable (~> 2.5)
       logger
 

data/README.md

@@ -13,10 +13,12 @@ Adomain["https://www.xyz.com"]
 # => "xyz.com"
 ```
 
-Adomain returns the URL host, stripping 'www' by default, scheming your URL if necessary (with "https://").
-Optionally, you can strip subdomains or keep 'www' subdomains -- see below.
+Adomain returns the URL host, stripping 'www' by default,
+scheming your URL if necessary (with "https://").
+Optionally, you can strip subdomains or keep 'www' subdomains – see below.
 
-[`Addressable::URI.parse`](https://github.com/sporkmonger/addressable#example-usage) performs the parsing.
+[`Addressable::URI.parse`](https://github.com/sporkmonger/addressable#example-usage)
+performs the parsing.
 
 ## Other methods and options
 
@@ -41,36 +43,59 @@ Adomain.domain "http://abc.xyz.com" # => "xyz.com"
 Adomain.subdomain_www "http://www.xyz.com" # => "www.xyz.com"
 ```
 
+### Domain options
+
 Optionally, each method accepts boolean values,
 allowing you to contort the method to do something other
 than what it says it does. Don't do this, unless you want to.
 
-### A gotcha: Adomain returns nil for some invalid values
+#### A gotcha: Adomain returns nil for some invalid values
 
-Because Adomain adds a scheme to any string passed to it
-Addressable does not error out. So, Adomain returns nil
-when presented with otherwise-valid strings
-for which Addressable cannot find a domain.
+Because Adomain adds a scheme to any string passed to it,
+schemeless-but-otherwise valid strings do not raise errors.
+Additionally, Adomain rescues InvalidURIError errors,
+and instead returns nil.
 
 ```ruby
 Adomain["hola"]     # => nil
 Adomain["::::::::"] # => nil
-Adomain[""]         # => Addressable::URI::InvalidURIError
-Adomain["{}"]       # => Addressable::URI::InvalidURIError
-Gem::Version.new(Adomain::VERSION) >= Gem::Version.new(0.2) # => false
+Adomain[""]         # => nil
+Adomain["{}"]       # => nil
 ```
 
-#### WARNING: All InvalidURIError will be caught in >= version 0.2
+#### NOTE: InvalidURIError are now caught in >= version 0.2
 
-When 0.2 is released, `Addressable::URI::InvalidURIError`s will be caught
-and ignored. Nil will be returned.
+With 0.2 `Addressable::URI::InvalidURIError`s are now caught
+and ignored. Nil is returned.
 
 ```ruby
 Gem::Version.new(Adomain::VERSION) >= Gem::Version.new(0.2) # => true
 Adomain["hola"]     # => nil
 Adomain["::::::::"] # => nil
-Adomain[""]         # => nil
-Adomain["{}"]       # => nil
+Adomain[""]         # => nil (formerly raised a Addressable::URI::InvalidURIError)
+Adomain["{}"]       # => nil (formerly raised a Addressable::URI::InvalidURIError)
+```
+
+### Convenience Addressable passthroughs
+
+These methods are simply passed through to parsed
+Addressable URI objects, and respond accordingly.
+These are presented for your convenience, and will track with
+your version of Addressable.
+
+```ruby
+Adomain.path "http://www.xyz.com/pages/123" # => "/pages/123"
+Adomain.path "{{{{{" # => "{{{{{"
+Adomain.scheme "http://www.xyz.com/pages/123" # => "http"
+Adomain.scheme "harrison:ford" # => "harrison"
+```
+
+However, they are rescued from InvalidURIError,
+like in other parts of the gem.
+
+```ruby
+Adomain.path "::::::::::::" #=> nil
+Adomain.scheme "::::::::::::" #=> nil
 ```
 
 ## Installation
@@ -89,16 +114,23 @@ Or install it yourself as:
 
 ## Development
 
-File bugs against the GitHub issue tracker and pull requests to match, where possible.
+File bugs against the GitHub issue tracker and pull requests to match,
+where possible.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/samnissen/adomain. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/samnissen/adomain. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere
+to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the Adomain project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/adomain/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Adomain project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/samnissen/adomain/blob/master/CODE_OF_CONDUCT.md).

data/lib/adomain/version.rb

@@ -1,3 +1,3 @@
 class Adomain
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adomain
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Sam Nissen