build-uri 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 875ee954e27285ed02e09319a4522ff214f0a79c
-  data.tar.gz: 7abb5ce2d4cac8a351a2b97825e09d7c8cb6bb8d
+  metadata.gz: 5f8a5d5877dee272338beeec3fda4f17abb9817e
+  data.tar.gz: 8c5a4a231d4d404d04bc1a72a91c0b18249838ba
 SHA512:
-  metadata.gz: 6867609819a69023dc1ecd8eda6a3ff87b55feac5a7ce46eeeb201ade4ee4df67c7c7bb56a30a23f2d88ed0fa6adcdee822ec5fcf2bfc19bede0c236668c6201
-  data.tar.gz: 91424aff5e447387a4e21742c568b72dcd55fa30492edf802fc1972b60040cc949b77b8cf8dc08464dda0d376d41d1cafd4f31d5c79dfd99d25b7bbec6bea5dc
+  metadata.gz: 4265f956f7f4a54da0196a7a8a05daee21da01874f7e0f29991e6f5a0d333c9acb5b44484ed4f69e366ba55af3ee41146c53e867d45cb520d2666b4732cf5614
+  data.tar.gz: 90df195a715cdc880cb6ce9e91f2b73a5b7c99ca9a58174203ede9d307f0672b8fcb3303e52d912472993563984caa0d134233b2172024c207042ef272847d35

data/README.md

@@ -1,6 +1,6 @@
 # Build::URI
 
-`Build::URI` provides unform handling of file paths (`Build::URI::Relative`), URIs (`Build::URI::Absolute`) and triples (`Build::URI::Triple`).
+`Build::URI` provides unform handling of paths (e.g. `/var/lib`), URIs (e.g. `http://www.google.com/search`) and triples (e.g. `git@github.com:ioquatix/build-uri`). It supports logical concatenation of all combinations of these, and a nil token for convenience.
 
 [![Build Status](https://secure.travis-ci.org/ioquatix/build-uri.svg)](http://travis-ci.org/ioquatix/build-uri)
 [![Code Climate](https://codeclimate.com/github/ioquatix/build-uri.svg)](https://codeclimate.com/github/ioquatix/build-uri)
@@ -22,13 +22,36 @@ Or install it yourself as:
 
 ## Usage
 
-To parse an input:
+Some examples of concatenation:
+
+```ruby
+Build::URI['http://www.github.com/ioquatix'] + 'build-uri'
+# Absolute URI is concatenated with relative path, generating 'http://www.github.com/ioquatix/build-uri'.
+
+Build::URI['var'] + 'lib'
+# Concatenates relative paths, generating 'var/lib'.
+
+Build::URI['/usr/bin'] + '/usr/local/bin'
+# RHS is absolute path, so it is returned.
+
+Build::URI['http://www.github.com/'] + Build::URI['git@github.com:ioquatix/build-uri']
+# RHS is absolute URI, so it is returned.
+
+Build::URI[nil] + 'etc'
+# LHS is nil, so RHS is returned.
+```
+
+A `nil` token `Build::URI[nil]` or `Build::URI::EMPTY` is available which always yields the right-hand side when merging.
+
+### Parsing Input
 
 ```ruby
 uri = Build::URI[value]
 ```
 
-Is it a local file?
+### Local Path
+
+Is it a local path or a (potentially) remote resource?
 
 ```ruby
 if uri.local?
@@ -38,16 +61,24 @@ else
 end
 ```
 
-Concatenate paths:
+### Concatenation
 
 ```ruby
-root = Build::URI["http://www.google.com/search?q=awesome"]
-path = Build::URI["/login"]
+root = Build::URI["https://www.github.com/ioquatix"]
+path = Build::URI["build-uri"]
 
 (root + path).to_s
-# => "http://www.google.com/login?q=awesome"
+# => "https://www.github.com/ioquatix/build-uri"
 ```
 
+## Caveats
+
+This library does not implement URI encoding/decoding. It is expected that the inputs are valid encoded strings, and thus the outputs will be too.
+
+This is not a general purposes URI handling library, but is focused on providing correct programmatic path concatenation for [teapot].
+
+[teapot]: https://www.github.com/ioquatix/teapot
+
 ## Contributing
 
 1. Fork it

data/lib/build/uri/absolute.rb

@@ -79,7 +79,9 @@ module Build
 			
 			def self.parse(string)
 				if match = PARSER.match(string)
-					self.new(*match.values_at(*self.members)).freeze
+					self.new(
+						match[:scheme], match[:userinfo], match[:host], match[:path], match[:query], match[:fragment]
+					).freeze
 				end
 			end
 		end

data/lib/build/uri/triplet.rb

@@ -47,7 +47,11 @@ module Build
 			
 			def self.parse(string)
 				if match = PARSER.match(string)
-					self.new(*match.values_at(*self.members))
+					self.new(
+						match[:userinfo],
+						match[:host],
+						match[:path],
+					).freeze
 				end
 			end
 		end

data/lib/build/uri/version.rb

@@ -20,6 +20,6 @@
 
 module Build
 	module URI
-		VERSION = "1.0.0"
+		VERSION = "1.0.1"
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: build-uri
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Samuel Williams