Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Switch the lib to A-labels by default #40

Merged
merged 11 commits into from
Nov 21, 2016
Merged

Switch the lib to A-labels by default #40

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
d5b7003
Release 0.2.0
weppos Nov 20, 2016
4db7531
Add test cases for GH-31
weppos Nov 20, 2016
5cbf2ae
Switch the list internal representation to A-labels by default
weppos Nov 20, 2016
3e0183a
Pre-process the list to A-labels
weppos Nov 20, 2016
f7095df
Enforce official PSL test cases to ASCII
weppos Nov 20, 2016
3c8d92a
It helps if I get the depds
weppos Nov 20, 2016
f2838c3
Tell Travis to install deps
weppos Nov 20, 2016
7c78f35
The first command of make should be test
weppos Nov 20, 2016
85d72c6
Fix typo
weppos Nov 21, 2016
2e0db42
Add note about A-labels
weppos Nov 21, 2016
0445958
Update README.md
weppos Nov 21, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,19 @@ publicsuffix.DomainFromListWithOptions(list, "google.blogspot.com", nil)
// blogspot.com
```

## IDN domains, A-labels and U-labels

[A-label and U-label](https://tools.ietf.org/html/rfc5890#section-2.3.2.1) are two different ways to represent IDN domain names. These two encodings are also known as ASCII (A-label) or Pynucode vs Unicode (U-label). Conversions between U-labels and A-labels are performed according to the ["Punycode" specification](https://tools.ietf.org/html/rfc3492), adding or removing the ACE prefix as needed.

IDNA-aware applications generally use the A-label form for storing and manipulating data, whereas the U-labels can appear in presentation and user interface forms.

Although the PSL list has been traditionally U-label encoded, this library follows the common industry standards and stores the rules in their A-label form. Therefore, unless explicitly mentioned, any method call, comparison or internal representation is expected to be ASCII-compatible encoded (ACE).

Passing Unicode names to the library may either result is error or unexpected behaviors.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"may either result is error or" -> "may either result in error or"

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✔️


If you are interested in the details of this decision, you can read the full discussion [here](https://github.com/weppos/publicsuffix-go/issues/31).


## Differences with `golang.org/x/net/publicsuffix`

The [`golang.org/x/net/publicsuffix`](https://godoc.org/golang.org/x/net/publicsuffix) is a package part of the Golang `x/net` package, that provides a public suffix list implementation.
Expand Down