mini_suffix 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0be3c2c9d92f4a37a7691c18bb0cfcef55c1231f
+  data.tar.gz: 65a80e40e464a618508698c3d906d54d31c8a06d
+SHA512:
+  metadata.gz: c18c41f0b55013130fad3aae53d83d80ac14123435cb24ea444e8f5c9ebd6850384a734b395099d91dada8af5a8096e8cc4179617585eb04e4d5313fb46667bf
+  data.tar.gz: f02b57073cbfa0f41bb0a84dd44a97cbe0b863518003d26d876012612ea9da7502c074fd49e559840d37b60a75094b708657e4c7f911496df8817b814b867130

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in mini_suffix.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Guo Xiang Tan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# MiniSuffix
+
+## Installation
+
+### Debian
+`sudo apt-get install libpsl-dev`
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mini_suffix'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mini_suffix
+
+## Usage
+
+```
+require 'mini_suffix'
+
+MiniSuffix.domain("meta.discourse.org")
+# => "discourse.org"
+
+MiniSuffix.domain("www.careers.gov.sg")
+# => "careers.gov.sg"
+```
+
+##Benchmark
+
+```
+# benchmark/bench.rb
+
+PublicSuffix.domain total allocated memsize: 6574255
+PublicSuffix.domain total retained memsize: 1133266
+MiniSuffix.domain total allocated memsize: 8000
+MiniSuffix.domain total retained memsize: 0
+
+Warming up --------------------------------------
+ PublicSuffix.domain     4.503k i/100ms
+   MiniSuffix.domain    77.107k i/100ms
+Calculating -------------------------------------
+ PublicSuffix.domain     47.521k (± 2.2%) i/s -    238.659k in   5.024541s
+   MiniSuffix.domain    875.595k (± 3.8%) i/s -      4.395M in   5.027237s
+
+Comparison:
+   MiniSuffix.domain:   875594.7 i/s
+ PublicSuffix.domain:    47521.2 i/s - 18.43x  slower
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/discourse/mini_suffix.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/benchmark/bench.rb

@@ -0,0 +1,24 @@
+require 'memory_profiler'
+require 'benchmark/ips'
+require 'public_suffix'
+require 'mini_suffix'
+
+public_suffix_mem = MemoryProfiler.report do
+  100.times { PublicSuffix.domain("www.careers.gov.sg") }
+end
+
+mini_suffix_mem = MemoryProfiler.report do
+  100.times { MiniSuffix.domain("www.careers.gov.sg") }
+end
+
+puts "PublicSuffix.domain total allocated memsize: #{public_suffix_mem.total_allocated_memsize}"
+puts "PublicSuffix.domain total retained memsize: #{public_suffix_mem.total_retained_memsize}"
+puts "MiniSuffix.domain total allocated memsize: #{mini_suffix_mem.total_allocated_memsize}"
+puts "MiniSuffix.domain total retained memsize: #{mini_suffix_mem.total_retained_memsize}"
+puts
+
+Benchmark.ips do |x|
+  x.report('PublicSuffix.domain') { PublicSuffix.domain("www.careers.gov.sg") }
+  x.report('MiniSuffix.domain') { MiniSuffix.domain("www.careers.gov.sg") }
+  x.compare!
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mini_suffix"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mini_suffix.rb

@@ -0,0 +1,21 @@
+require "mini_suffix/version"
+require 'ffi'
+
+module MiniSuffix
+  extend FFI::Library
+
+  ffi_lib File.join(File.dirname(File.expand_path('..', __FILE__)), 'vendor/libpsl.so')
+  attach_function :psl_builtin, [], :pointer
+  attach_function :psl_registrable_domain, [:pointer, :string], :string
+  attach_function :psl_get_version, [], :string
+
+  @@context = psl_builtin
+
+  # Extracts the shortest private suffix part of the hostname
+  #
+  # @param [String] hostname
+  # @return [String] private_suffix
+  def self.domain(hostname)
+    self.psl_registrable_domain(@@context, hostname)
+  end
+end

data/lib/mini_suffix/version.rb

@@ -0,0 +1,3 @@
+module MiniSuffix
+  VERSION = "0.1.0"
+end

data/mini_suffix.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mini_suffix/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mini_suffix"
+  spec.version       = MiniSuffix::VERSION
+  spec.authors       = ["Guo Xiang Tan"]
+  spec.email         = ["tgx@discourse.org"]
+
+  spec.summary       = %q{FFI wrapper for libpsl}
+  spec.homepage      = "https://github.com/discourse/mini_suffix"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'ffi', '~> 1.9'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: mini_suffix
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Guo Xiang Tan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- tgx@discourse.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmark/bench.rb
+- bin/console
+- bin/setup
+- lib/mini_suffix.rb
+- lib/mini_suffix/version.rb
+- mini_suffix.gemspec
+- vendor/libpsl.so
+homepage: https://github.com/discourse/mini_suffix
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: FFI wrapper for libpsl
+test_files: []