ryodo 0.0.3 → 0.1.0

data/README.md

@@ -8,7 +8,9 @@ This is a pure Ruby implementation of the [regdomr](https://github.com/asaaki/re
 
 Without the Cext backend it should be also easily usable with Ruby implemenations like JRuby.
 
-**Works only with Ruby 1.9.x!**
+**Works only with Ruby 1.9.x!** (I dropped all support for 1.8.x)
+
+
 
 ## Usage
 
@@ -52,7 +54,7 @@ ryodo("my.awesome.domain.co.jp")
 "my.awesome.domain.co.jp".ryodo
 ```
 
-UTF-8 junkie? ;o)
+### UTF-8 junkie?
 
 ```ruby
 # encoding: utf-8
@@ -61,10 +63,117 @@ ryōdo("my.awesome.domain.co.jp")
 りょうど("my.awesome.domain.co.jp")
 ```
 
+### Extension of URI
+
+```ruby
+require "regdomr/uri"
+
+uri = URI.parse("http://my.awesome.domain.jp:5555/path")
+uri.host
+#=> "my.awesome.domain.jp"
+
+uri.host.class
+#=> Ryodo::Domain
+# but decorates the String class transparently
+
+uri.host.domain
+#=> "domain.com"
+```
+
+In Gemfile:
+
+```ruby
+gem "ryodo", :require => ["ryodo","ryodo/ext/uri"]
+```
+
+
+
+## Benchmark
+
+There is another gem called [public_suffix](https://github.com/weppos/public_suffix_service), which does nearly the same (maybe with more features I don't need).
+
+So I did a tiny benchmark.
+
+**Setup**
+
+A domain input list, taken by publicsuffix.org (checkPublicSuffix test script under [publicsuffix.org/list/](http://publicsuffix.org/list/)).
+
+Some of them are also invalid (to test, if you implementation works correctly).
+
+I added some very long domain names with many parts (for look-up time scale).
+
+Finally 72 entries to check.
+
+Ruby: 1.9.3-p194, no special patches
+
+We only do a basic parsing and retrieve the registered/registrable domain. (Should hit the most important code of the gems.)
+
+**Test script snippet**
+
+```ruby
+# DOMAINS is the array of domain entries - shuffled on every benchmark run
+
+LOOPS = 1_000
+
+Benchmark.bmbm do |b|
+
+  b.report "ryodo" do
+    LOOPS.times do
+      DOMAINS.each do |domain|
+        Ryodo.parse(domain).domain # returns nil if not valid
+      end
+    end
+  end
+
+  b.report "public_suffix" do
+    LOOPS.times do
+      DOMAINS.each do |domain|
+        PublicSuffix.parse(domain).domain rescue nil # it raises if not valid in any way, so we rescue it
+      end
+    end
+  end
+
+end
+```
+
+**Caveats**
+
+`PublicSuffix.parse(…)` will raise errors if domain input is invalid (e.g. not a registrable domain).
+
+`Ryodo.parse(…)` won't raise but return nil values for invalid stuff (it only raises if input is not a String, of course).
+
+**Result**
+
+```
+Rehearsal -------------------------------------------------
+ryodo           1.800000   0.000000   1.800000 (  1.809521)
+public_suffix  21.880000   0.020000  21.900000 ( 21.907808)
+--------------------------------------- total: 23.700000sec
+
+                    user     system      total        real
+ryodo           1.770000   0.000000   1.770000 (  1.769734)
+public_suffix  22.320000   0.010000  22.330000 ( 22.346013)
+```
+
+As you can see, Ryodo is more than **10 times faster**.
+
+_(Funfact: My first approach was 6 times slower — improvement factor of 60!)_
+
+
+
+
+## TODO
+
+Lot of specs missing, this first version of second approach was developed in playground mode. ;o)
+
+
+
 ## Foo …
 
 "Uh, excuse me Sir … just one more question." — Columbo (Peter Falk †)
 
+
+
 ## License
 
 MIT/X11 — see `LICENSE.txt`

data/Rakefile

@@ -51,6 +51,7 @@ end
 desc "Fetch and save public suffix data (task for updates)"
 task :fetch_data do
   require "ryodo"
+  require "ryodo/suffix_list_fetcher"
   Ryodo::SuffixListFetcher.fetch_and_save!
 end
 

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.1.0

data/checks/matching.rb

@@ -9,7 +9,7 @@ def checkPublicSuffix query, expectation
   calculated =  q.domain.nil? ? "NULL" : q.domain
   passed     = (calculated==expectation) ? "  OK" : "FAIL"
 
-  puts "#{passed} === Q: #{query.ljust(20)} | #{expectation.rjust(20)} <=> #{calculated.ljust(20)}"
+  puts "#{passed} === Q: #{query.ljust(26)} | #{expectation.rjust(16)} <=> #{calculated.ljust(16)}"
 end
 
 # NULL input.
@@ -23,6 +23,11 @@ checkPublicSuffix('.com', 'NULL')
 checkPublicSuffix('.example', 'NULL')
 checkPublicSuffix('.example.com', 'NULL')
 checkPublicSuffix('.example.example', 'NULL')
+#Trailing dot (FQDN).
+checkPublicSuffix('com.', 'NULL')
+checkPublicSuffix('example.com.', 'example.com')
+checkPublicSuffix('www.example.com.', 'example.com')
+checkPublicSuffix('www.subdomain.example.com.', 'example.com')
 # Unlisted TLD.
 checkPublicSuffix('example', 'NULL')
 checkPublicSuffix('example.example', 'NULL')

data/lib/ryodo.rb

@@ -20,6 +20,7 @@ require "ryodo/suffix_list"
 
 require "ryodo/methods"
 require "ryodo/ext/string"
+#require "ryodo/ext/uri"
 
 # Convenient shorthands
 module Ryodo

data/lib/ryodo/ext/uri.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+require "uri"
+
+class URI::Generic
+
+  alias_method :set_host_string, :set_host
+
+  def set_host(v)
+    @host = Ryodo.parse(self.set_host_string(v)) unless self.set_host_string(v).nil?
+  end
+
+end

data/lib/ryodo/rule_set.rb

@@ -9,7 +9,6 @@ module Ryodo
     end
 
     def build!
-
       Ryodo::SuffixList.list.each do |line|
 
         line.each.with_index do |node_name, idx|
@@ -33,11 +32,9 @@ module Ryodo
         end
 
       end
-
     end
 
     def select_rule(rule_path)
-
       path = rule_path.dup
 
       if current = path.pop
@@ -51,7 +48,6 @@ module Ryodo
         end
 
       end
-
     end
 
     def match(path)
@@ -70,7 +66,6 @@ module Ryodo
       if match && !match.children.keys.include?(domain[0]) && domain[0]
         [ suffix, [domain.shift], domain ]
       end
-
     end
 
   end

data/ryodo.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "ryodo"
-  s.version = "0.0.3"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Christoph Grabo"]
@@ -36,6 +36,7 @@ Gem::Specification.new do |s|
     "lib/ryodo/convenience/.u.rb",
     "lib/ryodo/domain.rb",
     "lib/ryodo/ext/string.rb",
+    "lib/ryodo/ext/uri.rb",
     "lib/ryodo/methods.rb",
     "lib/ryodo/parser.rb",
     "lib/ryodo/rule.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ryodo
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -150,6 +150,7 @@ files:
 - lib/ryodo/convenience/.u.rb
 - lib/ryodo/domain.rb
 - lib/ryodo/ext/string.rb
+- lib/ryodo/ext/uri.rb
 - lib/ryodo/methods.rb
 - lib/ryodo/parser.rb
 - lib/ryodo/rule.rb
@@ -177,7 +178,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1101056168484725658
+      hash: -130552580166080210
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: