simple-url 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e632fad57dab8f0b92dbbd3e2dd107f4ae8be747904b5c64e7ec2c82c1512b10
-  data.tar.gz: '09a1efd13633ef472a58ee35e8de6abc6073fe23bcb751a63d4ee697cfb103cc'
+  metadata.gz: d0c8a6dbc59d68c1a775dad5f3bf9a3596eb41aa8ad1d2da3774a11822bb1102
+  data.tar.gz: 026665ece6eddedcfb9638b203dad6400f0ea5d87fd186c9335051b3e9e73810
 SHA512:
-  metadata.gz: 14bc721c66c2703a210e10c3385de9cc7249006140fe248604f8ba904299da1d9dee1b07a83eca58ebc6e073047a3ecec3e8c269603f09755a3e03d911c8b02e
-  data.tar.gz: cb9f169ae237932ffae04f3e8f9ee83e40fb8c57a1574b628e2d02bf70259ceea2b6acfe925a25ec4275d1a47ffd01a075d51cd51956fbc97296bb8c35c708c4
+  metadata.gz: 12fd9d790cefba9ad4fcaea5123338f337340e71202d40f1346609cccc959f48cabac3ed9686b8c303221979948c1a84739b18223fd7aaec259b81f3ae8fe9bc
+  data.tar.gz: b4bb33efa8c65a2a52f1634f9a787681dd7f978af53193a15fb88b3c5537d9f78f177b0787595217a4a069d87a575d69555e30616be3950f701b9d48d81d4ed1

data/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org>

data/lib/url.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'uri'
+
 module SimpleUrl
   class Url
     attr_accessor :url, :query

data/readme.md

@@ -0,0 +1,102 @@
+# Simple URL
+
+ruby's `URI` is a very simple way to deal with...well, uri.
+
+the problem is the `search` (query string).
+
+dealing with search string by hand is really annoying 
+and error prune. as the search has no form specified on the RFC,
+we can play with it, it opens a lot of interesting ideas
+to providing a better way to manage it.
+
+an example is a search that works with key/values pairs
+that can contains duplicated keys:
+
+```txt
+a=ok&a=meh
+```
+
+if this is not a good idea for you application,
+we could implement a query string that uses a hashmap
+as storage.
+
+a required interface is:
+
+```java
+interface QueryString {
+  static QueryString from_string(String query_string);
+  String to_s();
+}
+```
+
+```rb
+class HashmapSearch
+  def self.from_string(query_string)
+    ary = URI.decode_www_form(query_string || '')
+    new(ary)
+  end
+
+  def initialize(query)
+    # if a keys is present many times,
+    # the last one will get on the hash.
+    @query = query.empty? ? {} : Hash[query]
+  end
+
+  def to_s
+    URI.encode_www_form(@query)
+  end
+
+  # operations is up to you!
+
+  def add(key, value)
+    @query[key] = value
+  end
+
+  def [](key)
+    @query[key]
+  end
+
+  def remove(key)
+    @query = @query.reject do |pair|
+      k, = pair
+      k == key
+    end
+  end
+end
+```
+
+getting everything together...
+
+```rb
+irb> a = SimpleUrl::Url.new('https://okokok.com/path?a=1&a=2', HashmapSearch)
+=> #<SimpleUrl::Url:0x00000000017447e8 @url=#<URI::HTTPS https://okokok.com/path?a=1&a=2>, @query_string_class=HashmapSearch, @query=#<HashmapSea...
+irb> a.query
+=> #<HashmapSearch:0x0000000001744338 @query={"a"=>"2"}>
+irb> a.url.path = "/asdf"
+=> "/asdf"
+irb> a.to_s
+=> "https://okokok.com/asdf?a=2"
+irb> a.query.add('b', 2)
+=> 2
+irb> a.to_s
+=> "https://okokok.com/path?a=2&b=2"
+irb(main):039:0> a.query.add('a', 43)
+=> 43
+irb(main):040:0> a.to_s
+=> "https://okokok.com/path?a=43&b=2"
+
+irb> a = SimpleUrl::Url.new('https://okokok.com/path?a=1&a=2', SimpleUrl::KeyValueQueryString)
+=> #<SimpleUrl::Url:0x0000000003c32f78 @url=#<URI::HTTPS https://okokok.com/path?a=1&a=2>, @query_string_class=SimpleUrl::KeyValueQueryString, @q...
+irb> a.query.to_s
+=> "a=1&a=2"
+irb(main):043:0> a.query.add('a', 3)
+=> [["a", "1"], ["a", "2"], ["a", 3]]
+irb(main):044:0> a.query.to_s
+=> "a=1&a=2&a=3"
+```
+
+## license
+
+This code is released under `Unlicense`.
+
+See `License`

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple-url
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Bruno Dias
@@ -16,8 +16,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - lib/key_value_query_string.rb
 - lib/url.rb
+- readme.md
 homepage: https://rubygems.org/gems/simple-url
 licenses:
 - Unlicense
@@ -30,7 +32,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="