zooplankton 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 471752a449c9e81524d8c0ce22d8ed5f0e68cd66
-  data.tar.gz: 264eb30f3309d7855330c627a20fcb1ed1877abe
+  metadata.gz: ae65d74db6edba8ebc5b96293d864003f6aefad3
+  data.tar.gz: e0ba84294a367c0a767754a100562708131ccb1c
 SHA512:
-  metadata.gz: 7dbde1412250a6fa7d120e6243d1101277584de10f796b93f079cd5b6eaa2114136c522fd53c43dd3f8d782677c4120c047d6533210653a8a80f41c0d0398bcf
-  data.tar.gz: 2f9f7dc28c002a40351d2b7911b1578c70c0f06586c8b31854f5fcce87088c7c6b5a3f524f5cc70fc7d5ada6d74f66f297e5ce6d8aa5caa79c9331c6c8006542
+  metadata.gz: 00604a8f9af348e7d6ed678b29a9ad73bff37a520c50b1e6ae812425ba78beb10bc63a1eaa4231828bbcfac9f4f7885e9df8f7d5bf867e7ebd026762f76e797d
+  data.tar.gz: abebc6d574ec3c4bdc692f995de68e9c72a33097f05dab13881f9ace19a05ff66d4eb908c75e38155abb3348bbe3409c31f5145fee998f3d7dc6b7f3c840eaff

data/.rspec

@@ -1,2 +1,2 @@
 --color
---format progress
+--format documentation

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/CHANGES.md

@@ -1,5 +1,9 @@
 # Changes
 
+## 1.0.0
+
+* Added ability to append query parameters to your templates. - Ben Hamill
+
 ## 0.1.0
 
 * Basic functionality. - Ben Hamill

data/README.md

@@ -1,4 +1,4 @@
-# Zooplankton
+# Zooplankton [![Build Status](https://travis-ci.org/benhamill/zooplankton.png)](https://travis-ci.org/benhamill/zooplankton) [![Code Climate](https://codeclimate.com/github/benhamill/zooplankton.png)](https://codeclimate.com/github/benhamill/zooplankton)
 
 Zooplankton is a library for helping you turn Rails routes into
 [URI Template strings](http://tools.ietf.org/html/rfc6570). It's useful for
@@ -40,8 +40,31 @@ You can use it like this:
 # => '/post/{slug}'
 > Zooplankton.path_template_for(:comment)
 # => '/post/{slug}/comment/{comment_id}'
+```
+
+It also handles replacing some (or all) of the templated variables if you want
+to prepopulate some of them ahead of time:
+
+``` ruby
 > Zooplankton.path_template_for(:comment, slug: 'the-best-post-ever')
 # => '/post/the-best-post-ever/comment/{comment_id}'
+```
+
+And you can add some query parameters when you're generating the template, if
+you need:
+
+``` ruby
+> Zooplankton.path_template_for(:comment, :q, slug: 'the-best-post-ever')
+# => '/post/the-best-post-ever/comment/{comment_id}{?q}'
+> Zooplankton.path_template_for(:comment, %i(foo bar), slug: 'the-best-post-ever')
+# => '/post/the-best-post-ever/comment/{comment_id}{?foo,bar}'
+> Zooplankton.path_template_for(:comment, %i(foo bar))
+# => '/post/{slug}/comment/{comment_id}{?foo,bar}'
+```
+
+It'll generate URLs, too, not just paths.
+
+``` ruby
 > Zooplankton.url_template_for(:root)
 # => 'http://example.com/'
 > Zooplankton.url_template_for(:post)

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/zooplankton/version.rb

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

data/lib/zooplankton.rb

@@ -4,19 +4,42 @@ require "zooplankton/version"
 
 module Zooplankton
   class << self
-    def path_template_for(helper_name, params={})
-      return unless named_routes.names.include?(helper_name)
+    def path_template_for(helper_name, query_params={}, required_params=nil)
+      build_template(:path, helper_name, *parse_params(query_params, required_params))
+    end
+
+    def url_template_for(helper_name, query_params={}, required_params=nil)
+      build_template(:url, helper_name, *parse_params(query_params, required_params))
+    end
+
+    private
 
-      unescape_template(expand_helper(helper_name, :path, params))
+    def parse_params(*args)
+      if args.first.respond_to?(:to_h)
+        query_params = []
+        required_params = args.first.to_h
+      else
+        query_params = Array(args.shift)
+        required_params = args.first || {}
+      end
+
+      [query_params, required_params]
     end
 
-    def url_template_for(helper_name, params={})
+    def build_template(type, helper_name, query_params, required_params)
       return unless named_routes.names.include?(helper_name)
 
-      unescape_template(expand_helper(helper_name, :url, params))
+      escaped_template_without_query_params = expand_helper(helper_name, type, required_params)
+      escaped_template = append_query_params(escaped_template_without_query_params, query_params)
+
+      unescape_template(escaped_template)
     end
 
-    private
+    def append_query_params(template, query_params)
+      return template unless query_params.any?
+
+      "#{template}{?#{query_params.join(',')}}"
+    end
 
     def expand_helper(helper_name, path_or_url, params)
       helper_method = "#{helper_name}_#{path_or_url}"

data/spec/zooplankton_spec.rb

@@ -23,6 +23,22 @@ describe Zooplankton do
       it "returns just the path" do
         expect(subject).to eq('/')
       end
+
+      context "with one query parameter" do
+        subject { Zooplankton.path_template_for(:root, :q) }
+
+        it "templateizes the query param" do
+          expect(subject).to eq('/{?q}')
+        end
+      end
+
+      context "with some query parameters" do
+        subject { Zooplankton.path_template_for(:root, %i(q f)) }
+
+        it "templateizes the query params" do
+          expect(subject).to eq('/{?q,f}')
+        end
+      end
     end
 
     context "for a route with one required param" do
@@ -31,6 +47,22 @@ describe Zooplankton do
       it "uses simple string expansion to describe the parameter" do
         expect(subject).to eq('/post/{slug}')
       end
+
+      context "with one query parameter" do
+        subject { Zooplankton.path_template_for(:post, :q) }
+
+        it "templateizes the query param" do
+          expect(subject).to eq('/post/{slug}{?q}')
+        end
+      end
+
+      context "with some query parameters" do
+        subject { Zooplankton.path_template_for(:post, %i(q f)) }
+
+        it "templateizes the query params" do
+          expect(subject).to eq('/post/{slug}{?q,f}')
+        end
+      end
     end
 
     context "for a route with more than one required param" do
@@ -40,6 +72,22 @@ describe Zooplankton do
         it "uses simple string expansion to describe the parameters" do
           expect(subject).to eq('/post/{slug}/comment/{comment_id}')
         end
+
+        context "with one query parameter" do
+          subject { Zooplankton.path_template_for(:comment, :q) }
+
+          it "templateizes the query param" do
+            expect(subject).to eq('/post/{slug}/comment/{comment_id}{?q}')
+          end
+        end
+
+        context "with some query parameters" do
+          subject { Zooplankton.path_template_for(:comment, %i(q f)) }
+
+          it "templateizes the query params" do
+            expect(subject).to eq('/post/{slug}/comment/{comment_id}{?q,f}')
+          end
+        end
       end
 
       context "with one supplied parameter value" do
@@ -48,6 +96,22 @@ describe Zooplankton do
         it "uses simple string expansion to describe the parameters" do
           expect(subject).to eq('/post/post-slug/comment/{comment_id}')
         end
+
+        context "with one query parameter" do
+          subject { Zooplankton.path_template_for(:comment, :q, slug: 'post-slug') }
+
+          it "templateizes the query param" do
+            expect(subject).to eq('/post/post-slug/comment/{comment_id}{?q}')
+          end
+        end
+
+        context "with some query parameters" do
+          subject { Zooplankton.path_template_for(:comment, %i(q f), slug: 'post-slug') }
+
+          it "templateizes the query params" do
+            expect(subject).to eq('/post/post-slug/comment/{comment_id}{?q,f}')
+          end
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zooplankton
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Ben Hamill
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-11 00:00:00.000000000 Z
+date: 2013-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,6 +90,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - CHANGES.md
 - Gemfile
 - LICENSE.txt