naughty_or_nice 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99393247edb23d92e4d1ddebb5a3a62b71c8179c
-  data.tar.gz: afc4922b88c3789f860fc95a8fcf26037d83bd7b
+  metadata.gz: ffbdc7af85eed5f4b34c437590c4c0d38eed1dd6
+  data.tar.gz: 5285a0ae47a4908efb6d6582b02a78c02cbe27a2
 SHA512:
-  metadata.gz: e9c88f8fc3407466c321177f0a6074b797aba84dcb5be52f1b78e5a124e7ed51b21560ea03333e9a58cedd0f5bf2a79e7b8b55a9382d916cee854d171a7bb15e
-  data.tar.gz: 3f9cde45e96febf46407d91efa40c3e3484c01f337c781bc11f6720ee5482cefa041a4c5cbb6c22f184ba01a168b333b2cd0bc604fab5a8233c5aacdb0df3f12
+  metadata.gz: 6a4f84828325d89c6fc187be7c489ea31f00a88ef4529aa03b3874a2acf1faad97650650c75821d145da0c5ad34dbd62f227a1922e08ed5ae3c5128eb703a172
+  data.tar.gz: 312f9b00bbeb629521f470ce4e7f5adaa1f6297794113b73424e1d6fbad2bc8c9be473d38c83958416facab22bf00b36206147c89bf2eb8ad149de3e9d31ff38

data/README.md

@@ -21,13 +21,26 @@ class Checker
   DOMAINS = %w[foo.com bar.com foobar.com]
 
   def valid?
-    DOMAINS.include? domain
+    DOMAINS.include? domain.to_s
   end
 end
 ```
 
 That's it! Just overwrite the `valid?` method and Naughty or Nice takes care of the rest.
 
+You can also get more complicated. Let's say you only wanted to allow `.gov` domains:
+
+```ruby
+class Checker
+
+  include NaughtyOrNice
+
+  def valid?
+    domain.tld == ".gov"
+  end
+end
+```
+
 ## Using the included methods
 
 There are a handful of magic methods that your class automatically gets. You can throw any domain-like string at your new `Checker` class, and figure out if it's on the list. Here's a few examples:
@@ -54,9 +67,9 @@ You can also you NaughtyOrNice to extract domain information for use elsewhere.
 ```ruby
 address = Checker.new "baz@foo.bar.com"
 address.valid?           #=> true
-address.domain           #=> "foo.bar.com"
-address.domain_parts.tld #=> "com"
-address.domain_parts.sld #=> "bar"
+address.domain.to_s      #=> "foo.bar.com"
+address.domain.tld       #=> "com"
+address.domain.sld       #=> "bar"
 ```
 
 ## See it in action

data/lib/naughty_or_nice/version.rb

@@ -1,3 +1,3 @@
 module NaughtyOrNice
-  VERSION = "1.0.0"
+  VERSION = "2.0.0"
 end

data/lib/naughty_or_nice.rb

@@ -56,45 +56,29 @@ module NaughtyOrNice
 
   def initialize(domain)
     if domain.is_a?(PublicSuffix::Domain)
-      @domain_parts = domain
-      @text = domain.to_s
+      @domain = domain
+      @text   = domain.to_s
     else
       @text = domain.to_s.downcase.strip
     end
   end
 
-  # Parse the domain from the input string
+  # Return the public suffix domain object
   #
-  # Can handle urls, domains, or emails
+  # Supports all domain strings (URLs, emails)
   #
-  # Returns the domain string
+  # Returns the domain object or nil, but no errors, never an error
   def domain
-    @domain ||= begin
-      return nil if @text.empty?
-
-      uri = Addressable::URI.parse(@text)
-
-      if uri.host # valid https?://* URI
-        uri.host
-      elsif email?
-        @text.match(/@([\w\.\-]+)\Z/i)[1]
-      else # url sans http://
-        uri = Addressable::URI.parse("http://#{@text}")
-        # properly parse http://foo edge cases
-        # see https://github.com/sporkmonger/addressable/issues/145
-        uri.host if uri.host =~ /\./
-      end
-    rescue Addressable::URI::InvalidURIError
-      nil
-    end
+    @domain ||= PublicSuffix.parse(domain_text)
+  rescue PublicSuffix::DomainInvalid, PublicSuffix::DomainNotAllowed
+    nil
   end
-  alias_method :to_s, :domain
 
   # Checks if the input string represents a valid domain
   #
   # Returns boolean true if a valid domain, otherwise false
   def valid?
-    !!(domain_parts && domain_parts.valid?)
+    !!(domain && domain.valid?)
   end
 
   # Is the input text in the form of a valid email address?
@@ -104,20 +88,38 @@ module NaughtyOrNice
     !!(@text =~ EMAIL_REGEX)
   end
 
-  # Helper function to return the public suffix domain object
-  #
-  # Supports all domain strings (URLs, emails)
-  #
-  # Returns the domain object or nil, but no errors, never an error
-  def domain_parts
-    @domain_parts ||= begin
-      PublicSuffix.parse domain
-    rescue PublicSuffix::DomainInvalid, PublicSuffix::DomainNotAllowed
-      nil
-    end
+  # Return the parsed domain as a string
+  def to_s
+    domain.to_s if domain
   end
 
   def inspect
     "#<#{self.class} domain=\"#{domain}\" valid=#{valid?}>"
   end
+
+  private
+
+  # Parse the domain from the input string
+  #
+  # Can handle urls, domains, or emails
+  #
+  # Returns the domain string
+  def domain_text
+    return nil if @text.empty?
+
+    uri = Addressable::URI.parse(@text)
+
+    if uri.host # valid https?://* URI
+      uri.host
+    elsif email?
+      @text.match(/@([\w\.\-]+)\Z/i)[1]
+    else # url sans http://
+      uri = Addressable::URI.parse("http://#{@text}")
+      # properly parse http://foo edge cases
+      # see https://github.com/sporkmonger/addressable/issues/145
+      uri.host if uri.host =~ /\./
+    end
+  rescue Addressable::URI::InvalidURIError
+    nil
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: naughty_or_nice
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-30 00:00:00.000000000 Z
+date: 2015-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: public_suffix