addressabler 0.0.4 → 0.0.5

data/CHANGELOG.md

@@ -1,4 +1,6 @@
-## 0.0.3
+## 0.0.5
+* Restored nested hash support **if Rack is installed**
+
+## 0.0.4
 * Updated to the latest TLD list from [Paul Dix](https://github.com/pauldix), thanks to [this unbelievably helpful user](https://github.com/flipsasser/addressabler/issues/1)
 * Updated to latest Addressable spec
-* 

data/README.md

@@ -0,0 +1,82 @@
+# Addressabler
+
+**Addressabler** extends the [Addressable::URI](https://github.com/sporkmonger/addressable) class by adding TLD parsing, domain and subdomain parsing, query modification, and restoring setting of nested hashes to query strings.
+
+## Install
+
+Install using Rubygems:
+
+	gem install addressabler
+
+Then:
+
+	require 'rubygems'
+	require 'addressabler'
+
+Addressabler will automatically require `addressable/uri`.
+
+## Usage
+
+### Domain, TLD, and subdomain parsing
+
+Use `Addressable::URI` like you normally would:
+
+```
+@uri = Addressable::URI.parse("http://www.google.com/")
+@uri.host #=> "www.google.com"
+```
+
+Addressabler will add the following properties:
+
+```
+@uri.tld #=> "com"
+@uri.domain #=> "google"
+@uri.subdomain #=> "www"
+```
+
+You can set these values, as well:
+
+```
+@uri.tld = "org"
+@uri.host #=> "www.google.org"
+@uri.domain = "amazon"
+@uri.host #=> "www.amazon.org"
+@uri.subdomain = "developers"
+@uri.host #=> "developers.amazon.org"
+```
+
+#### Complex TLD support (thanks to Paul Dix!)
+Addressabler copies some of Paul Dix's [Domaintrix](https://github.com/pauldix/domainatrix) TLD code to support fancy TLDs, as well:
+
+```
+@uri.host = "www.google.co.uk"
+@uri.tld #=> "co.uk"
+```
+
+### Query interface
+
+Addressabler adds a `query_hash` method to `Addressable::URI`s. This makes editing query strings a lot simpler, using a familiar Hash syntax:
+
+```
+@uri.query_hash[:foo] = :bar
+@uri.to_s #=> "http://www.google.co.uk/?foo=bar"
+```
+
+#### Nested hashes in query strings
+
+The current maintainer of Addressable, [Bob Aman](https://github.com/sporkmonger), feels rather strongly that [Rails got it wrong](https://github.com/sporkmonger/addressable/issues/77) in supporting nested hashes in query strings.
+
+Frankly, I don't disagree with anything he has to say on the issue, but it is a problem many people have experienced.
+
+*As such,* since Rack already supports building nested hashes "the Rails Way" (shudder), I added support for assigning nested hashes to `URI`s **only if Rack is available.** Addressabler will attempt to load `Rack::Utils` and, if it finds it, you can assign a nested hash in the `query_hash=` method like so:
+
+```
+@uri.query_hash = {:foo => {:bar => :baz}}
+@uri.to_s #=> "http://www.google.co.uk/?foo[bar]=baz"
+```
+
+**HANDLE WITH CARE!** As [Bob explains in the discussion](https://github.com/sporkmonger/addressable/issues/77#issuecomment-8534480), there's a better alternative to nested hashes in query strings, so try that before you install this library.
+
+That's it. Enjoy.
+
+#### Copyright © 2013 Flip Sasser

data/lib/addressabler/query.rb

@@ -1,5 +1,17 @@
 module Addressabler
   class Query < ::Hash
+    class << self
+      def nested_hash_support?
+        return @nested_hash_support if defined?(@nested_hash_support)
+        begin
+          require 'rack/utils'
+          @nested_hash_support = true
+        rescue LoadError
+          @nested_hash_support = false
+        end
+      end
+    end
+
     def delete(value)
       super
       update_uri
@@ -17,7 +29,38 @@ module Addressabler
 
     private
     def update_uri
-      @uri.query_values = empty? ? nil : to_hash
+      if self.class.nested_hash_support?
+        @uri.query = Rack::Utils.build_nested_query(hash_with_string_values(self))
+      else
+        @uri.query_values = empty? ? nil : dup
+      end
+    end
+
+    def array_with_string_values(array)
+      array.map do |value|
+        case value
+        when Array
+          array_with_string_values(value)
+        when Hash
+          hash_with_string_values(Hash)
+        else
+          value.to_s
+        end
+      end
+    end
+
+    def hash_with_string_values(hash)
+      string_values = hash.map do |key, value|
+        case value
+        when Array
+          [key, array_with_string_values(value)]
+        when Hash
+          [key, hash_with_string_values(value)]
+        else
+          [key, value.to_s]
+        end
+      end
+      Hash[*string_values.flatten(1)]
     end
   end
 end

data/spec/addressabler_spec.rb

@@ -35,17 +35,11 @@ describe Addressabler do
     uri.to_s.should == "http://www.foo.bar.baz.co.uk/gjadgsg?adg=f&foo=bar"
   end
 
-  # TODO: This breaks due to a deprection in Addressable. This test
-  # was probably inappropriate to begin with, as it was testing something
-  # Addressable does, and not something Addressable*r* does.
-  #
-  # This would be a nice feature to have anyway, but alas ... some other
-  # time.
-  #it "should support adding nested values to the query" do
-    #uri = Addressable::URI.parse("http://www.amazon.ca")
-    #uri.query_hash[:foo] = {:bar => :baz}
-    #uri.to_s.should == "http://www.amazon.ca?foo[bar]=baz"
-  #end
+  it "should support adding nested values to the query" do
+    uri = Addressable::URI.parse("http://www.amazon.ca")
+    uri.query_hash[:foo] = {:bar => "baz", :sommat => [:else, 1, true, false]}
+    uri.to_s.should == "http://www.amazon.ca?foo[bar]=baz&foo[sommat][]=else&foo[sommat][]=1&foo[sommat][]=true&foo[sommat][]=false"
+  end
 
   it "should support subdomains" do
     uri = Addressable::URI.heuristic_parse("i.am.a.subdomain.co.uk")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: addressabler
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -68,14 +68,14 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE
-- README.markdown
+- README.md
 files:
 - CHANGELOG.md
 - LICENSE
-- README.markdown
 - lib/addressabler.rb
 - lib/addressabler/query.rb
 - lib/tlds
+- README.md
 - spec/addressabler_spec.rb
 - spec/spec_helper.rb
 - spec/uri_spec.rb

data/README.markdown

@@ -1,53 +0,0 @@
-Addressabler
-=
-
-**Addressabler** extends the Addressable::URI class by adding TLD parsing, domain and subdomain parsing, and query modification.
-
-Install
-==
-
-Install using Rubygems:
-
-	gem install addressabler
-
-Then:
-
-	require 'rubygems'
-	require 'addressabler'
-
-Addressabler will automatically require `addressable/uri`.
-
-Usage
-==
-
-Use Addressable::URI like you normally would:
-
-	@uri = Addressable::URI.parse("http://www.google.com/")
-	@uri.host #=> "www.google.com"
-
-Addressabler will add the following properties:
-
-	@uri.tld #=> "com"
-	@uri.domain #=> "google"
-	@uri.subdomain #=> "www"
-
-You can set these values, as well:
-
-	@uri.tld = "org"
-	@uri.host #=> "www.google.org"
-	@uri.domain = "amazon"
-	@uri.host #=> "www.amazon.org"
-	@uri.subdomain = "developers"
-	@uri.host #=> "developers.amazon.org"
-
-Addressabler copies some of Paul Dix's [Domaintrix](https://github.com/pauldix/domainatrix) TLD code to support fancy TLDs, as well:
-
-	@uri.host = "www.google.co.uk"
-	@uri.tld #=> "co.uk"
-
-Addressabler also makes editing queries a little bit easier:
-
-	@uri.query_hash[:foo] = :bar
-	@uri.to_s #=> "http://www.google.co.uk/?foo=bar"
-
-That's it. Enjoy.