dominatrix 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6eb591b5b1bce5de59315fa2c8d6e0fa6266a89
-  data.tar.gz: e0cf4c3e765bd887a73a73af9d50310bac038fdd
+  metadata.gz: 6f7dda304ebe0f6acbb19b84cc811183cc9d1ab7
+  data.tar.gz: 77c378c2062ebf1c670c7c903c4c4d613cd761d4
 SHA512:
-  metadata.gz: 53ec7aa73d8e32bbd84289fed5fb3d8af09b552e1f547df2e886615a5119333e4dff9d23971041448931736cfeb9f9fc617d8a3f8025e322b84beb9c7bdf0fc1
-  data.tar.gz: bf458fa755a50bf1c852305fba671ba4a63ee314ade92c97b703b952891bfd72fa606ed0e805533185c271d58b512450570fb08ae19586ae2c9a0e074dec32ee
+  metadata.gz: f39a2448d7690076771e0f96167bc40f9f70df40e2acb63ac6842551588772c984cf9765eca4719b3cc8f0d29d852a090942f9bae431282444bab55bb84f9cf5
+  data.tar.gz: ef9561efae2e81a8e4de83f1752bb87a8c90828460c4bab3e570694db3fa743e90e2af0479bf51f585aeecff988bb30f62003e93274e754ec1650523b5c89cc3

data/README.md

@@ -22,8 +22,12 @@ Or install it yourself as:
 
 ### Parsing Domains
 
-To parse a domain name from a URI, call the `Dominatrix.parse` method with a
-URI object or parseable URI string.
+There are two approaches to parsing domains with Dominatrix: `Dominatrix.parse`
+and `Dominatrix#parse`.
+
+#### Dominatrix.parse
+
+Call the `Dominatrix.parse` method with a URI object or parseable URI string.
 
 ```ruby
 Dominatrix.parse('http://www.google.com')
@@ -62,6 +66,30 @@ following errors will be raised:
   parsed.
 * `Dominatrix::NotFoundError`: the URI does not contain a valid domain name.
 
+#### Dominatrix#parse
+
+Instantiate a `Dominatrix` object by passing in an optional set of valid domain
+extensions.  By default, this value is set to `Dominatrix.default_extensions`.
+
+```ruby
+dominatrix = Dominatrix.new
+# => #<Dominatrix:0x007fda8428a8f0 @extensions=#<Set: {".ac", ".com.ac", ".gov.ac", ".mil.ac", ... }>>
+
+dominatrix = Dominatrix.new(%w[.com .net].to_set)
+# => #<Dominatrix:0x007fda823861c0 @extensions=#<Set: {".com", ".net"}>>
+```
+
+Once instantiated, call the `#parse` method with a URI object or parseable URI
+string.
+
+```ruby
+dominatrix.parse('http://www.google.com')
+# => "google.com"
+
+dominatrix.parse('http://www.google.foo')
+# => Dominatrix::NotFoundError: no matching domain for "http://www.google.foo"
+```
+
 ### Domain Extensions
 
 To see the list of domain extensions built into the gem, call the

data/lib/dominatrix.rb

@@ -2,49 +2,62 @@ require 'set'
 require 'uri'
 require 'dominatrix/version'
 
-module Dominatrix
+class Dominatrix
   class NotFoundError < StandardError; end
 
-  class << self
-    def parse(uri, extensions = default_extensions)
-      uri = URI.parse(uri) if uri.is_a?(String)
-      raise ArgumentError, '`uri` must be a String or URI' unless uri.is_a?(URI)
-      raise ArgumentError, '`uri` must include a host' if uri.host.nil?
-      raise ArgumentError, '`extensions` must be Enumerable' unless extensions.is_a?(Enumerable)
+  attr_reader :extensions
 
-      domain = extract_domain(uri.host, extensions)
-      raise NotFoundError, "no matching domain for \"#{uri}\"" if domain.nil?
-      domain
-    end
+  def initialize(extensions = self.class.default_extensions)
+    self.extensions = extensions
+  end
 
-    def default_extensions
-      @default_domains ||= begin
-        file = File.join(File.dirname(__FILE__), 'extensions.txt')
-        File.readlines(file).map(&:strip).delete_if(&:empty?).to_set
-      end
-    end
+  def parse(uri)
+    uri = URI.parse(uri) if uri.is_a?(String)
+    raise ArgumentError, '`uri` must be a String or URI' unless uri.is_a?(URI)
+    raise ArgumentError, '`uri` must include a host' if uri.host.nil?
 
-    private
+    domain = extract_domain(uri.host)
+    raise NotFoundError, "no matching domain for \"#{uri}\"" if domain.nil?
+    domain
+  end
 
-    def extract_domain(host, extensions)
-      parts = host.split('.')
-      last_found_domain = nil
+  private
 
-      parts.size.times.each do |n|
-        offset = parts.size - n - 1
-        lookup = '.' + parts[offset..-1].join('.')
+  def extensions=(extensions)
+    raise ArgumentError, '`extensions` must be Enumerable' unless extensions.is_a?(Enumerable)
+    raise ArgumentError, '`extensions` must all start with "."' unless extensions.all? { |s| s.start_with?('.') }
+    @extensions = extensions
+  end
 
-        if extensions.include?(lookup)
-          last_found_domain = lookup
-        elsif last_found_domain
-          last_found_domain = parts[offset] + last_found_domain
-          break
-        else
-          break
-        end
+  def extract_domain(host)
+    parts = host.split('.')
+    last_found_domain = nil
+
+    parts.size.times.each do |n|
+      offset = parts.size - n - 1
+      lookup = '.' + parts[offset..-1].join('.')
+
+      if extensions.include?(lookup)
+        last_found_domain = lookup
+      elsif last_found_domain
+        last_found_domain = parts[offset] + last_found_domain
+        break
+      else
+        break
       end
+    end
+
+    last_found_domain
+  end
+
+  def self.parse(uri, extensions = default_extensions)
+    new(extensions).parse(uri)
+  end
 
-      last_found_domain
+  def self.default_extensions
+    @default_domains ||= begin
+      file = File.join(File.dirname(__FILE__), 'extensions.txt')
+      File.readlines(file).map(&:strip).delete_if(&:empty?).to_set
     end
   end
 end

data/lib/dominatrix/version.rb

@@ -1,3 +1,3 @@
-module Dominatrix
-  VERSION = '1.0.0'
+class Dominatrix
+  VERSION = '1.1.0'
 end

data/lib/extensions.txt

@@ -1,4 +1,4 @@
- .ac
+.ac
 .com.ac
 .gov.ac
 .mil.ac
@@ -9,7 +9,7 @@
 .ad
 .nom.ad
 .ae
-امارات.
+.امارات
 .co.ae
 .net.ae
 .org.ae
@@ -550,7 +550,7 @@
 .web.do
 .domains
 .dz
-الجزائر.
+.الجزائر
 .com.dz
 .art.dz
 .asso.dz
@@ -582,7 +582,7 @@
 .org.ee
 .pri.ee
 .eg
-مصر.
+.مصر
 .com.eg
 .edu.eg
 .eun.eg
@@ -868,7 +868,7 @@
 .in
 .ભારત
 .भारत
-بھارت.
+.بھارت
 .ਭਾਰਤ
 .இந்தியா
 .co.in
@@ -905,7 +905,7 @@
 .org.iq
 .tv.iq
 .ir
-ایران.
+.ایران
 .ac.ir
 .co.ir
 .id.ir
@@ -930,7 +930,7 @@
 .jm
 .com.jm
 .jo
-الاردن.
+.الاردن
 .com.jo
 .edu.jo
 .gov.jo
@@ -1140,7 +1140,7 @@
 .sch.ly
 .mex.com
 .ma
-المغرب.
+.المغرب
 .co.ma
 .net.ma
 .org.ma
@@ -1268,7 +1268,7 @@
 .edu.mx
 .gob.mx
 .my
-مليسيا.
+.مليسيا
 .com.my
 .net.my
 .org.my
@@ -1377,7 +1377,7 @@
 .health.nz
 .parliament.nz
 .om
-عمان.
+.عمان
 .co.om
 .com.om
 .ac.om
@@ -1438,7 +1438,7 @@
 .pictures
 .pink
 .pk
-پاکستان.
+.پاکستان
 .com.pk
 .net.pk
 .org.pk
@@ -1665,7 +1665,7 @@
 .productions
 .properties
 .ps
-فلسطين.
+.فلسطين
 .com.ps
 .net.ps
 .org.ps
@@ -1697,7 +1697,7 @@
 .org.py
 .qc.com
 .qa
-قطر.
+.قطر
 .com.qa
 .net.qa
 .org.qa
@@ -1781,7 +1781,7 @@
 .org.sa
 .pub.sa
 .sch.sa
-السعودية.
+.السعودية
 .com.sb
 .net.sb
 .org.sb
@@ -1911,7 +1911,7 @@
 .red.sv
 .sx
 .sy
-سوريا.
+.سوريا
 .systems
 .co.sz
 .sz
@@ -1965,7 +1965,7 @@
 .org.tl
 .tm
 .tn
-تونس.
+.تونس
 .com.tn
 .net.tn
 .org.tn
@@ -2227,7 +2227,7 @@
 .xxx
 .xyz
 .ye
-اليمن.
+.اليمن
 .co.ye
 .com.ye
 .gov.ye

data/spec/dominatrix_spec.rb

@@ -2,9 +2,7 @@
 require 'spec_helper'
 
 RSpec.describe Dominatrix do
-  subject { described_class }
-
-  describe '.parse' do
+  describe '#parse' do
     shared_examples_for 'a valid URL' do |domain|
       it 'returns the domain when given a string' do
         expect(subject.parse(url)).to eq domain
@@ -48,24 +46,49 @@ RSpec.describe Dominatrix do
     end
 
     describe 'when given a custom list of extensions' do
+      subject { described_class.new(extensions) }
+
       let(:extensions) { %w[.uk .co.uk].to_set }
 
       it 'returns the domain for a valid URI' do
-        expect(subject.parse('http://www.example.co.uk', extensions)).to eq 'example.co.uk'
+        expect(subject.parse('http://www.example.co.uk')).to eq 'example.co.uk'
       end
 
       it 'raises an error for an invalid URI' do
-        expect { subject.parse('http://www.example.com', extensions) }.to raise_error Dominatrix::NotFoundError
+        expect { subject.parse('http://www.example.com') }.to raise_error Dominatrix::NotFoundError
       end
     end
   end
 
+  describe '.parse' do
+    subject { described_class }
+
+    let(:url) { 'http://www.google.com' }
+
+    it 'delegates to a new instance' do
+      instance = subject.new
+      allow(subject).to receive(:new).and_return(instance)
+      expect(instance).to receive(:parse).with(url)
+      subject.parse(url)
+    end
+
+    it 'includes the provided extension list' do
+      extensions = %w[.uk .co.uk].to_set
+      instance = subject.new(extensions)
+      allow(subject).to receive(:new).with(extensions).and_return(instance)
+      expect(instance).to receive(:parse).with(url)
+      subject.parse(url, extensions)
+    end
+  end
+
   describe '.default_extensions' do
+    subject { described_class }
+
     it 'returns a set' do
       expect(subject.default_extensions).to be_a Set
     end
 
-    it 'prefixes each extension with a dot', skip: 'RTL extensions not working' do
+    it 'prefixes each extension with a dot' do
       expect(subject.default_extensions).to all start_with('.')
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dominatrix
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Matt Huggins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-24 00:00:00.000000000 Z
+date: 2014-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler