zooplankton 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c878d585575f883e203938c61e037c88a667446b
-  data.tar.gz: 0636a9f4041b56d76e419b2e9c25ea0a70b5f4ff
+  metadata.gz: 41a78b4848286bffd070b3dfa475cc20a46315df
+  data.tar.gz: 6ce1b3626fa6f4a0cd21d0c260947fa7ef023e46
 SHA512:
-  metadata.gz: 48c544b8b85fd25ccddab92c59a3c188d25939214a18ee531a313f9071b531f9df1d70dc1fb1c36dfd7d9621ca88ed81fffc68c91e3e3be70c3c4968d10a724b
-  data.tar.gz: 1334e12ea45556b4e50dea5fe21c583b6d745b4a43f075adf02829b02b53cb3180ed0197b42e2070bd9f8d0353dce1f9ddb2c279427e37fcbc56fc1e35eac8cc
+  metadata.gz: 7f3a722e1590fbb1c536e91523d7811ce24ef3cbb3efe2784371db35890160d648ac02bd6c58a0ce9c4ecb8810aed349bfe1239d5485d6f7cb3077a2198d5dca
+  data.tar.gz: 2df979c72e073df641945139a5ca12e4b777e1344c56b6dc4afe640f7cf4873c6ac92cc1972c7931608d262295e59cc09289821837024da1bb96e4cac02556de

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+gemfiles/*.lock

data/.travis.yml

@@ -1,4 +1,15 @@
 language: ruby
 rvm:
   - 2.0.0
-  - 2.1.2
+  - 2.2.2
+gemfile:
+  - gemfiles/rails4.gemfile
+  - gemfiles/rails5.gemfile
+matrix:
+  fast_finish: true
+  exclude:
+    - gemfile: gemfiles/rails4.gemfile
+      rvm: 2.2.2
+    - gemfile: gemfiles/rails5.gemfile
+      rvm: 2.0.0
+cache: bundler

data/Appraisals

@@ -0,0 +1,7 @@
+appraise "rails4" do
+  gem "rails", "~> 4.2.0"
+end
+
+appraise "rails5" do
+  gem "rails", "~> 5.0.0"
+end

data/CHANGES.md

@@ -1,5 +1,10 @@
 # Changes
 
+## 1.3.0
+
+* Support Rails 5 - Ismael Celis
+* Fix bug where supplying all query parameters would leave in a trailing `{&}` - Ismael Celis
+
 ## 1.2.0
 
 * Added support for Ruby 2.1. - Ben Weiner

data/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
 
+gem "appraisal"
+
 # Specify your gem's dependencies in zooplankton.gemspec
 gemspec

data/README.md

@@ -126,6 +126,20 @@ like `"name?middle=dale{?first,last}"` which would end up as
 `"name?middle=dale&first=ben&last=hamill"`. Zooplankton will use this when it's
 appropriate for building query strings.
 
+## Testing
+
+```
+rake spec
+```
+
+This library uses the [Appraisal](https://github.com/thoughtbot/appraisal) gem to test against multiple versions of Rails. You can run them individually with
+
+```
+appraisal rails4 rake spec
+appraisal rails5 rake spec
+```
+
+Look in `./Appraisals` for available Rails versions.
 
 ## Contributing
 

data/Rakefile

@@ -1,3 +1,5 @@
+require "rubygems"
+require "bundler/setup"
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 

data/gemfiles/rails4.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rails", "~> 4.2.0"
+
+gemspec :path => "../"

data/gemfiles/rails5.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rails", "~> 5.0.0"
+
+gemspec :path => "../"

data/lib/zooplankton.rb

@@ -1,89 +1,16 @@
-require "rails"
-
 require "zooplankton/version"
+require "zooplankton/parser"
 
 module Zooplankton
   class << self
-    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={}, supplied_params=nil)
-      build_template(:url, helper_name, *parse_params(query_params, supplied_params))
-    end
-
-    private
-
-    def parse_params(*args)
-      if args.first.respond_to?(:to_h) && !args.first.is_a?(Array)
-        query_params = []
-        supplied_params = args.first.to_h
-      else
-        query_params = Array(args.shift)
-        supplied_params = args.first || {}
-      end
-
-      [query_params, supplied_params]
-    end
-
-    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, 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, supplied_params)
-      return template unless query_params.any?
-
-      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_supplied_params_for(helper_name, params))
-    end
-
-    def named_routes
-      Rails.application.routes.named_routes
-    end
-
-    def route_object_for(helper_name)
-      named_routes.routes[helper_name]
-    end
-
-    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
-    end
+    @@parser = Parser.new
 
-    def unescape_template(template)
-      CGI.unescape(template)
+    def path_template_for(helper_name, query_params = {}, supplied_params = nil)
+      @@parser.path_template_for(helper_name, query_params, supplied_params)
     end
 
-    def url_helpers
-      Rails.application.routes.url_helpers
+    def url_template_for(helper_name, query_params = {}, supplied_params = nil)
+      @@parser.url_template_for(helper_name, query_params, supplied_params)
     end
   end
 end

data/lib/zooplankton/parser.rb

@@ -0,0 +1,83 @@
+require "rails"
+require "zooplankton/resolver"
+
+module Zooplankton
+  class Parser
+    AMPERSAND = '&'.freeze
+    QUESTION_MARK = '?'.freeze
+
+    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={}, supplied_params=nil)
+      build_template(:url, helper_name, *parse_params(query_params, supplied_params))
+    end
+
+    private
+
+    def parse_params(*args)
+      if args.first.respond_to?(:to_h) && !args.first.is_a?(Array)
+        query_params = []
+        supplied_params = args.first.to_h
+      else
+        query_params = Array(args.shift)
+        supplied_params = args.first || {}
+      end
+
+      [query_params, supplied_params]
+    end
+
+    def build_template(type, helper_name, query_params, supplied_params)
+      return unless resolver.has_route?(helper_name)
+
+      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, defined_keys, supplied_params)
+      return template unless defined_keys.any?
+
+      supplied_keys = defined_keys & supplied_params.keys
+      not_supplied_keys = defined_keys - supplied_params.keys
+
+      segments = []
+      init_symbol = QUESTION_MARK
+
+      if supplied_keys.any?
+        segments << supplied_keys.map{|k| escaped_pair(k, supplied_params[k]) }.join(AMPERSAND)
+      end
+
+      if not_supplied_keys.any?
+        init_symbol, sep = if segments.size > 0
+          [QUESTION_MARK, AMPERSAND]
+        else
+          ['', QUESTION_MARK]
+        end
+        segments << "{#{sep}#{not_supplied_keys.join(",")}}"
+      end
+
+      "#{template}#{init_symbol}#{segments.join}"
+    end
+
+    def expand_helper(helper_name, path_or_url, params)
+      helper_method = "#{helper_name}_#{path_or_url}"
+
+      resolver.generate(helper_method, helper_name, params)
+    end
+
+    def resolver
+      @resolver ||= Resolver.instance
+    end
+
+    def escaped_pair(key, value)
+      [key, URI.encode(value.to_s)].join('=')
+    end
+
+    def unescape_template(template)
+      CGI.unescape(template)
+    end
+  end
+end

data/lib/zooplankton/resolver.rb

@@ -0,0 +1,39 @@
+require 'action_controller/metal/strong_parameters'
+
+module Zooplankton
+  class Resolver
+    def self.instance
+      new(Rails.application.routes)
+    end
+
+    def initialize(routes)
+      @routes = routes
+    end
+
+    def has_route?(name)
+      names.include?(name)
+    end
+
+    def generate(helper_method, helper_name, params = {})
+      route = named_routes[helper_name]
+      routes.url_helpers.public_send(helper_method, *tokenized_params_for(route, params))
+    end
+
+    private
+    attr_reader :routes
+
+    def tokenized_params_for(route, params)
+      route.required_parts.map do |required_part|
+        params.fetch(required_part) { "{#{required_part}}" }
+      end
+    end
+
+    def names
+      named_routes.names
+    end
+
+    def named_routes
+      routes.named_routes
+    end
+  end
+end

data/lib/zooplankton/version.rb

@@ -1,3 +1,3 @@
 module Zooplankton
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/spec/zooplankton_spec.rb

@@ -39,6 +39,14 @@ describe Zooplankton do
           expect(subject).to eq('/{?q,f}')
         end
       end
+
+      context "with all query parameters" do
+        subject { Zooplankton.path_template_for(:root, %w(s q aa), "s" => "foo", "q" => "bar", "aa" => "hello", "ignore" => "me") }
+
+        it "templateizes all query params with the right separators" do
+          expect(subject).to eq('/?s=foo&q=bar&aa=hello')
+        end
+      end
     end
 
     context "for a route with one required param" do

data/zooplankton.gemspec

@@ -23,5 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rspec", "~> 2.14"
 
-  spec.add_dependency "rails", "~> 4.0"
+  spec.add_dependency "rails", [">= 4.0", "< 6.0"]
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zooplankton
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Ben Hamill
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-16 00:00:00.000000000 Z
+date: 2016-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,16 +70,22 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 description: A library for turning Rails routes into URI Templates, like maybe for
   HAL.
 email:
@@ -91,12 +97,17 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- Appraisals
 - CHANGES.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- gemfiles/rails4.gemfile
+- gemfiles/rails5.gemfile
 - lib/zooplankton.rb
+- lib/zooplankton/parser.rb
+- lib/zooplankton/resolver.rb
 - lib/zooplankton/version.rb
 - spec/spec_helper.rb
 - spec/zooplankton_spec.rb
@@ -121,11 +132,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A library for turning Rails routes into URI Templates.
 test_files:
 - spec/spec_helper.rb
 - spec/zooplankton_spec.rb
-has_rdoc: