Allowing clearing of cookies with options.

spec/lucky/cookies/cookie_jar_spec.cr

@@ -134,6 +134,28 @@ describe Lucky::CookieJar do
       jar.get_raw(:rules).expired?.should be_true
       jar.get_raw(:rules).value.should eq("")
     end
+
+    it "deletes a valid cookie with a block" do
+      jar = Lucky::CookieJar.empty_jar
+      jar.set(:rules, "no fighting!").domain("brawl.co")
+
+      jar.delete(:rules) do |cookie|
+        cookie.domain("brawl.co")
+      end
+
+      jar.deleted?(:rules).should be_true
+    end
+
+    it "ignores an invalid cookie when trying to delete" do
+      jar = Lucky::CookieJar.empty_jar
+      jar.set(:rules, "no fighting!").domain("brawl.co")
+
+      jar.delete(:burritos) do |cookie|
+        cookie.domain("brawl.co")
+      end
+
+      jar.deleted?(:rules).should be_false
+    end
   end
 
   describe "deleted?" do
@@ -168,5 +190,27 @@ describe Lucky::CookieJar do
       name.expired?.should be_true
       age.expired?.should be_true
     end
+
+    it "deletes cookies with options" do
+      headers = HTTP::Headers.new
+      headers["Cookie"] = "name=Rick%20James"
+
+      jar = Lucky::CookieJar.from_request_cookies(
+        HTTP::Cookies.from_headers(headers))
+
+      jar.clear do |cookie|
+        cookie.path("/")
+          .http_only(true)
+          .secure(true)
+          .domain(".example.com")
+      end
+
+      name = jar.get_raw(:name)
+      name.value.should eq("")
+      name.path.should eq("/")
+      name.domain.should eq(".example.com")
+      name.secure.should be_true
+      name.expired?.should be_true
+    end
   end
 end

src/lucky/cookies/cookie_jar.cr

@@ -42,19 +42,47 @@ class Lucky::CookieJar
     {% raise "use CookieJar#delete instead of CookieJar#unset" %}
   end
 
+  # Delete all cookies.
   def clear : Void
+    clear { }
+  end
+
+  # Delete cookies with a block to add specific options.
+  #
+  # jar.clear do |cookie|
+  #   cookie.path("/")
+  #         .http_only(true)
+  #         .secure(true)
+  # end
+  def clear(&block : HTTP::Cookie ->) : Void
     cookies.each do |cookie|
+      yield cookie
       delete cookie.name
     end
   end
 
+  # https://tools.ietf.org/search/rfc6265#page-8
+  # to remove a cookie, the server returns a Set-Cookie header
+  # with an expiration date in the past. The server will be successful
+  # in removing the cookie only if the Path and the Domain attribute in
+  # the Set-Cookie header match the values used when the cookie was
+  # created.
   def delete(key : Key) : Nil
     if cookie = cookies[key.to_s]?
       cookie.expires(1.year.ago).value("")
       set_cookies[key.to_s] = cookie
     end
   end
 
+  # Delete a specific cookie by name `key`. Yield that cookie
+  # to the block so you can add additional options like domain, path, etc...
+  def delete(key : Key) : Nil
+    if cookie = cookies[key.to_s]?
+      yield cookie
+      delete cookie.name
+    end
+  end
+
   # Returns `true` if the cookie has been expired, and has no value.
   # Will return `false` if the cookie does not exist, or is valid.
   def deleted?(key : Key) : Bool