fuzzyurl 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8bc03d75fbe841afed852424c2123761aeff21b
-  data.tar.gz: 0124a1e435856981f3088a25c9ca7348b172d4b8
+  metadata.gz: 7f97f4d61a613298ae6dc7d637c9db0e762a4ca2
+  data.tar.gz: 55abe6ac3a5f2d4f9b8d4df14499a59948a4242a
 SHA512:
-  metadata.gz: 3acd8d87e7df1e4ae87c91e9edde769b84c1b1bd993d7f8275a19d06f2a611384c5af8ca8e7eba1542c06404aedd7161d313b6577ae5c16e84507ce39b41ca9e
-  data.tar.gz: 18eef24b09a6f54690e6ebe53db791a07188050e8fae0fb652db938f076403941c4c2557b1eaf6f9f1eacee4d788fe6d7ee9333eef6ffa215ea2333cd2faaaf6
+  metadata.gz: 7297e9a3bf80f937ee928ae8f66f44b2f01c1e2e1ca885c53636ebed42da6fd54d60864de721a612998dffaa240a795cd7005ebf029cf78f0cdc8f35613d571a
+  data.tar.gz: 5fe01d27cfb6898cf85b7a5d9c0a3d8fa59fd20cc50ada7559638987f03c641ee05789a016e9ac880e60b303ce9aec6a57d5f6234fa21517d7667a73a22d9d54

data/lib/fuzzyurl.rb

@@ -4,6 +4,81 @@ require 'fuzzyurl/protocols'
 require 'fuzzyurl/match'
 require 'fuzzyurl/strings'
 
+
+# Fuzzyurl provides two related functions: non-strict parsing of URLs or
+# URL-like strings into their component pieces (protocol, username, password,
+# hostname, port, path, query, and fragment), and fuzzy matching of URLs
+# and URL patterns.
+#
+# Specifically, URLs that look like this:
+#
+#     [protocol ://] [username [: password] @] [hostname] [: port] [/ path] [? query] [# fragment]
+#
+# Fuzzyurls can be constructed using some or all of the above
+# fields, optionally replacing some or all of those fields with a `*`
+# wildcard if you wish to use the Fuzzyurl as a URL mask.
+#
+#
+# ## Parsing URLs
+#
+#     irb> Fuzzyurl.from_string("https://api.example.com/users/123?full=true")
+#     #=> #<Fuzzyurl:0x007ff55b914f58 @protocol="https", @username=nil, @password=nil, @hostname="api.example.com", @port=nil, @path="/users/123", @query="full=true", @fragment=nil>
+#
+#
+# ## Constructing URLs
+#
+#     irb> f = Fuzzyurl.new(hostname: "example.com", protocol: "http", port: "8080")
+#     irb> f.to_s
+#     #=> "http://example.com:8080"
+#
+#
+# ## Matching URLs
+#
+# Fuzzyurl supports wildcard matching:
+#
+# * `*` matches anything, including `null`.
+# * `foo*` matches `foo`, `foobar`, `foo/bar`, etc.
+# * `*bar` matches `bar`, `foobar`, `foo/bar`, etc.
+#
+# Path and hostname matching allows the use of a greedier wildcard `**` in
+# addition to the naive wildcard `*`:
+#
+# * `*.example.com` matches `filsrv-01.corp.example.com` but not `example.com`.
+# * `**.example.com` matches `filsrv-01.corp.example.com` and `example.com`.
+# * `/some/path/*` matches `/some/path/foo/bar` and `/some/path/`
+#    but not `/some/path`
+# * `/some/path/**` matches `/some/path/foo/bar` and `/some/path/`
+#    and `/some/path`
+#
+# The `Fuzzyurl.mask` function aids in the creation of URL masks.
+#
+#     irb> Fuzzyurl.mask
+#     #=> #<Fuzzyurl:0x007ff55b039578 @protocol="*", @username="*", @password="*", @hostname="*", @port="*", @path="*", @query="*", @fragment="*">
+#
+#     irb> Fuzzyurl.matches?(Fuzzyurl.mask, "http://example.com:8080/foo/bar")
+#     #=> true
+#
+#     irb> mask = Fuzzyurl.mask(path: "/a/b/**")
+#     irb> Fuzzyurl.matches?(mask, "https://example.com/a/b/")
+#     #=> true
+#     irb> Fuzzyurl.matches?(mask, "git+ssh://jen@example.com/a/b/")
+#     #=> true
+#     irb> Fuzzyurl.matches?(mask, "https://example.com/a/bar")
+#     #=> false
+#
+# `Fuzzyurl.bestMatch`, given a list of URL masks and a URL, will return
+# the given mask which most closely matches the URL:
+#
+#     irb> masks = ["/foo/*", "/foo/bar", Fuzzyurl.mask]
+#     irb> Fuzzyurl.best_match(masks, "http://example.com/foo/bar")
+#     #=> "/foo/bar"
+#
+# If you'd prefer the array index instead of the matching mask itself, use
+# `Fuzzyurl.best_match_index` instead:
+#
+#     irb> Fuzzyurl.best_match_index(masks, "http://example.com/foo/bar")
+#     #=> 1
+#
 class Fuzzyurl
   FIELDS.each {|f| attr_accessor f}
 

data/lib/fuzzyurl/strings.rb

@@ -8,7 +8,7 @@ class Fuzzyurl::Strings
         (?: : (?<password> \* | [a-zA-Z0-9%_.!~*'();&=+$,-]*))?
         @
     )?
-    (?<hostname> [a-zA-Z0-9\.\*\-]+?)?
+    (?<hostname> [a-zA-Z0-9\.\*\-_]+?)?
     (?: : (?<port> \* | \d+))?
     (?<path> / [^\?\#]*)?                 ## captures leading /
     (?: \? (?<query> [^\#]*) )?

data/lib/fuzzyurl/version.rb

@@ -1,5 +1,5 @@
 class Fuzzyurl
-  VERSION = "0.8.0"
-  VERSION_DATE = "2015-12-25"
+  VERSION = "0.9.0"
+  VERSION_DATE = "2016-06-28"
 end
 

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: fuzzyurl
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Pete Gamache
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-25 00:00:00.000000000 Z
+date: 2016-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.0.4
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.0.4
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.7.0
 - !ruby/object:Gem::Dependency
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.13.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.13.3
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: pete@gamache.org
 executables: []