zooplankton 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae65d74db6edba8ebc5b96293d864003f6aefad3
-  data.tar.gz: e0ba84294a367c0a767754a100562708131ccb1c
+  metadata.gz: 07178fdc94e41e3d73816c73617dca152a1c2220
+  data.tar.gz: 202ce012feb0b347b5863219052b008096d36bf2
 SHA512:
-  metadata.gz: 00604a8f9af348e7d6ed678b29a9ad73bff37a520c50b1e6ae812425ba78beb10bc63a1eaa4231828bbcfac9f4f7885e9df8f7d5bf867e7ebd026762f76e797d
-  data.tar.gz: abebc6d574ec3c4bdc692f995de68e9c72a33097f05dab13881f9ace19a05ff66d4eb908c75e38155abb3348bbe3409c31f5145fee998f3d7dc6b7f3c840eaff
+  metadata.gz: 3f81add78dbebd1b84126ace5d89e9eec047196a48d3ea33086ed8374b3a255e87b22900c92a8e76ff57938d37c209f6158404603f3aa1f88d7cb9086e201cb5
+  data.tar.gz: d02fa7b216e7b9c71e18bf7c9175437996e35e5422698519941fa899505afed5ea57a144b78907fefe742e5193a5c3e3b5c3ddde88307870d2c44fcf89c559f3

data/CHANGES.md

@@ -1,5 +1,10 @@
 # Changes
 
+## 1.1.0
+
+* Added supplied query parameter handling, including the use of continuation
+  marker. - Ben Hamill
+
 ## 1.0.0
 
 * Added ability to append query parameters to your templates. - Ben Hamill

data/README.md

@@ -62,6 +62,13 @@ you need:
 # => '/post/{slug}/comment/{comment_id}{?foo,bar}'
 ```
 
+If you supply a query parameter for replacement, it'll denote a continuation:
+
+``` ruby
+> Zooplankton.path_template_for(:comment, %i(foo bar), slug: 'the-best-post-ever', bar: 'baz')
+# => '/post/the-best-post-ever/comment/{comment_id}?bar=baz{&foo}'
+```
+
 It'll generate URLs, too, not just paths.
 
 ``` ruby

data/lib/zooplankton/version.rb

@@ -1,3 +1,3 @@
 module Zooplankton
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/zooplankton.rb

@@ -4,12 +4,12 @@ require "zooplankton/version"
 
 module Zooplankton
   class << self
-    def path_template_for(helper_name, query_params={}, required_params=nil)
-      build_template(:path, helper_name, *parse_params(query_params, required_params))
+    def path_template_for(helper_name, query_params={}, supplied_params=nil)
+      build_template(:path, helper_name, *parse_params(query_params, supplied_params))
     end
 
-    def url_template_for(helper_name, query_params={}, required_params=nil)
-      build_template(:url, helper_name, *parse_params(query_params, required_params))
+    def url_template_for(helper_name, query_params={}, supplied_params=nil)
+      build_template(:url, helper_name, *parse_params(query_params, supplied_params))
     end
 
     private
@@ -17,34 +17,51 @@ module Zooplankton
     def parse_params(*args)
       if args.first.respond_to?(:to_h)
         query_params = []
-        required_params = args.first.to_h
+        supplied_params = args.first.to_h
       else
         query_params = Array(args.shift)
-        required_params = args.first || {}
+        supplied_params = args.first || {}
       end
 
-      [query_params, required_params]
+      [query_params, supplied_params]
     end
 
-    def build_template(type, helper_name, query_params, required_params)
+    def build_template(type, helper_name, query_params, supplied_params)
       return unless named_routes.names.include?(helper_name)
 
-      escaped_template_without_query_params = expand_helper(helper_name, type, required_params)
-      escaped_template = append_query_params(escaped_template_without_query_params, query_params)
+      escaped_template_without_query_params = expand_helper(helper_name, type, supplied_params)
+      escaped_template = append_query_params(escaped_template_without_query_params, query_params, supplied_params)
 
       unescape_template(escaped_template)
     end
 
-    def append_query_params(template, query_params)
+    def append_query_params(template, query_params, supplied_params)
       return template unless query_params.any?
 
-      "#{template}{?#{query_params.join(',')}}"
+      supplied_query_params = query_params & supplied_params.keys
+      supplied_query_string = ''
+
+      if supplied_query_params.any?
+        continuation_or_expansion = '&'
+
+        supplied_query_string << '?'
+
+        supplied_query_string << supplied_query_params.map do |key|
+          "#{key.to_s}=#{URI.encode(supplied_params[key].to_s)}"
+        end.join('&')
+
+        query_params = query_params - supplied_query_params
+      else
+        continuation_or_expansion = '?'
+      end
+
+      "#{template}#{supplied_query_string}{#{continuation_or_expansion}#{query_params.join(',')}}"
     end
 
     def expand_helper(helper_name, path_or_url, params)
       helper_method = "#{helper_name}_#{path_or_url}"
 
-      url_helpers.send(helper_method, *templated_required_params_for(helper_name, params))
+      url_helpers.send(helper_method, *templated_supplied_params_for(helper_name, params))
     end
 
     def named_routes
@@ -55,7 +72,7 @@ module Zooplankton
       named_routes.routes[helper_name]
     end
 
-    def templated_required_params_for(helper_name, params)
+    def templated_supplied_params_for(helper_name, params)
       route_object_for(helper_name).required_parts.map do |required_part|
         params.fetch(required_part) { "{#{required_part}}" }
       end

data/spec/zooplankton_spec.rb

@@ -112,6 +112,14 @@ describe Zooplankton do
             expect(subject).to eq('/post/post-slug/comment/{comment_id}{?q,f}')
           end
         end
+
+        context "with some query parameters that are supplied" do
+          subject { Zooplankton.path_template_for(:comment, %i(q f), slug: 'post-slug', q: 'find me') }
+
+          it "templateizes the query params" do
+            expect(subject).to eq('/post/post-slug/comment/{comment_id}?q=find me{&f}')
+          end
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zooplankton
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Ben Hamill
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-15 00:00:00.000000000 Z
+date: 2013-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler