assert-url 1.0.0 → 1.0.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NDY2MTI0ZTRmY2NiYWE1MjA0M2RkYWU4Y2MxZDc3YTQ2ZTgyMDhiYQ==
-  data.tar.gz: !binary |-
-    YTRkNDAzMTU3ZjAxMjkyNTQ2YzQ4NWU1ZGE3NDdhMGM3NTIwNzE0Mw==
+SHA1:
+  metadata.gz: 081c87760942d9781ee96de1edd14264b124a804
+  data.tar.gz: f940ede15f1cabd224276d3ce79215acc3cbbc37
 SHA512:
-  metadata.gz: !binary |-
-    ZDY3OGY4ZTFmOTU4MzBmYmRlOTQxZWRjYzUyMDYwMjQyNjJjOTc0ZmFmNjUy
-    Y2ZmYzE1MTcxYjQzNmMxOWZmMmMzOGQ4NjUwZDAxOGQ0YTUwYzA5Y2RlZDMx
-    NDUyMTgxM2QxYTQ4M2U3NGM2M2FjYjYzYzhhOWY1ZGM5MWEyODA=
-  data.tar.gz: !binary |-
-    ODZjYThmNzAwM2RlYmNiNzdhZjM2NmIwNTNkZTM3NjZhOTU5Nzg4MDVjODNk
-    NDZhMjcyNTkxYjQzZDMzNDk0NDgxMGE2ZDZlYmNkMmYyZThjOTIzZWNlZTZl
-    ZDcyZjc5MDg0NThiZTg0NjIzNmFjYjA4NThhNzUzZGI1NTA4YTI=
+  metadata.gz: 1d1bcddc2a8d2db7b23d3a6bcd812b3715c1054b15ec590380d2834c95005e4a068e4af59aac1832f804007068e802624dedec67c2356be75ef760bc900971c3
+  data.tar.gz: f8cc98fda94f2c9953f1ef75b5729680e0ad29d3ea11d1dd339a9ac1af3b4c02d885ede89e7c993b3de772253a406bbc5b9b8381e2caa36ef5539ceef291781b

data/assert_url.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "assert-url"
-  s.version = "1.0.0"
+  s.version = "1.0.1"
   s.summary = "Semantical helpers to test your URLs in Ruby"
   s.description = s.summary
   s.authors = ["Lucas Tolchinsky"]

data/lib/assert_url.rb

@@ -1,25 +1,112 @@
 require "uri"
 
 module AssertUrl
-  PARTS = %W[scheme host port path query fragment]
+  PARTS = %W[scheme host port path query fragment].each do |part|
+    const_set("#{part.capitalize}Error", Class.new(StandardError))
+  end
 
-  PARTS.each do |part|
-    error = const_set("#{part.capitalize}Error", Class.new(StandardError))
+  # @param [String or Symbol] expected The scheme the url should have.
+  # @param [String or URI] value The url you wish to validate.
+  #
+  # @example
+  #
+  #   assert_scheme_equal(:http, "http://example.org")
+  #   assert_scheme_equal("http", "http://example.org")
+  #
+  def assert_scheme_equal(expected, value)
+    value = urify(value).scheme
 
-    define_method(:"assert_#{part}_equal") do |expected, value|
-      expected = normalize(part, expected)
-      value = urify(value).send(part.to_sym)
+    expected.to_s == value || raises(SchemeError, expected, value)
+  end
 
-      expected == value || (raise error, "expected #{expected}, got #{value}")
-    end
+  # @param [String] expected The host the url should have.
+  # @param [String or URI] value The url you wish to validate.
+  #
+  # @example
+  #
+  #   assert_host_equal("example.org", "http://example.org")
+  #
+  def assert_host_equal(expected, value)
+    value = urify(value).host
+
+    expected == value || raises(HostError, expected, value)
   end
 
+  # @param [Integer] expected The port the url should have.
+  # @param [String or URI] value The url you wish to validate.
+  #
+  # @example
+  #
+  #   assert_port_equal(80, "http://example.org")
+  #
+  def assert_port_equal(expected, value)
+    value = urify(value).port
+
+    expected == value || raises(PortError, expected, value)
+  end
+
+  # @param [String] expected The path the url should have.
+  # @param [String or URI] value The url you wish to validate.
+  #
+  # @example
+  #
+  #   assert_path_equal("/path", "http://example.org/path")
+  #
+  def assert_path_equal(expected, value)
+    value = urify(value).path
+
+    expected == value || raises(PathError, expected, value)
+  end
+
+  # @param [Hash] expected The query the url should have.
+  # @param [String or URI] value The url you wish to validate.
+  #
+  # @example
+  #
+  #   assert_query_equal({foo: "bar"}, "http://example.org/?foo=bar")
+  #
+  def assert_query_equal(expected, value)
+    value = urify(value).query
+    expected = (URI.encode_www_form(expected) rescue expected)
+
+    expected == value || raises(QueryError, expected, value)
+  end
+
+  # @param [String] expected The fragment the url should have.
+  # @param [String or URI] value The url you wish to validate.
+  #
+  # @example
+  #
+  #   assert_fragment_equal("fragment", "http://example.org/path#fragment")
+  #
+  def assert_fragment_equal(expected, value)
+    value = urify(value).fragment
+
+    expected == value || raises(FragmentError, expected, value)
+  end
+
+  # {#assert_url_equal} runs all the validations above. It's not a String comparison.
+  #
+  # @param [String or URI] expected The url you wish to have.
+  # @param [String or URI] value The url you wish to validate.
+  #
+  # @example
+  #
+  #   assert_url_equal(URI("http://example.org"), "http://example.org")
+  #
   def assert_url_equal(expected, value)
     expected, value = urify(expected), urify(value)
 
     PARTS.map { |part| send(:"assert_#{part}_equal", expected.send(part.to_sym), value) }.reduce(:&)
   end
 
+  # @param [String or Symbol] expected The key-value pairs that the url must include.
+  # @param [String or URI] value The url you wish to validate.
+  #
+  # @example
+  #
+  #   assert_query_include({foo: "bar"}, "http://example.org/?foo=bar&baz=wat")
+  #
   def assert_query_include(expected, value)
     value = Hash[URI.decode_www_form(urify(value).query)]
 
@@ -39,16 +126,9 @@ module AssertUrl
   end
   private :urify
 
-  def normalize(part, expected)
-    case part
-    when "scheme"
-      expected.kind_of?(Symbol) ? expected.to_s : expected
-    when "query"
-      URI.encode_www_form(expected) rescue expected
-    else
-      expected
-    end
+  def raises(error, expected, value)
+    raise error, "expected #{expected}, got #{value}"
   end
-  private :normalize
+  private :raises
 end
 

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: assert-url
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Lucas Tolchinsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-23 00:00:00.000000000 Z
+date: 2014-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cutest
   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: Semantical helpers to test your URLs in Ruby
@@ -46,17 +46,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Semantical helpers to test your URLs in Ruby