deas 0.34.0 → 0.35.0

data/lib/deas/router.rb

@@ -1,3 +1,4 @@
+require 'rack'
 require 'deas/exceptions'
 require 'deas/url'
 
@@ -8,11 +9,13 @@ module Deas
     DEFAULT_REQUEST_TYPE_NAME = 'default'
 
     attr_reader :request_types, :urls, :routes
+    attr_reader :escape_query_value_proc
 
     def initialize(&block)
       @request_types = []
       @urls, @routes = {}, []
       default_request_type_name(DEFAULT_REQUEST_TYPE_NAME)
+      escape_query_value{ |v| Rack::Utils.escape(v) }
       self.instance_eval(&block) if !block.nil?
     end
 
@@ -21,6 +24,11 @@ module Deas
       @view_handler_ns
     end
 
+    def escape_query_value(&block)
+      raise(ArgumentError, "no block given") unless block
+      @escape_query_value_proc = block
+    end
+
     def base_url(value = nil)
       @base_url = value if !value.nil?
       @base_url
@@ -30,12 +38,12 @@ module Deas
       "#{base_url}#{url_path}"
     end
 
-    def url(name, path)
+    def url(name, path, options = nil)
       if !path.kind_of?(::String)
         raise ArgumentError, "invalid path `#{path.inspect}` - "\
                              "can only provide a url name with String paths"
       end
-      add_url(name.to_sym, path)
+      add_url(name.to_sym, path, options || {})
     end
 
     def url_for(name, *args)
@@ -101,8 +109,11 @@ module Deas
 
     private
 
-    def add_url(name, path)
-      self.urls[name] = Deas::Url.new(name, path)
+    def add_url(name, path, options)
+      options[:escape_query_value] ||= self.escape_query_value_proc
+      self.urls[name] = Deas::Url.new(name, path, {
+        :escape_query_value => options[:escape_query_value]
+      })
     end
 
     def add_route(http_method, path, proxies)

data/lib/deas/url.rb

@@ -1,12 +1,20 @@
-require 'deas/cgi'
-
 module Deas
   class Url
 
+    def self.http_query(hash, &escape_value_proc)
+      escape_value_proc ||= proc{ |v| v.to_s }
+      hash.map do |(key, value)|
+        "#{key}=#{escape_value_proc.call(value)}"
+      end.sort.join('&')
+    end
+
     attr_reader :name, :path
+    attr_reader :escape_query_value_proc
 
-    def initialize(name, path)
+    def initialize(name, path, options = nil)
+      options ||= {}
       @name, @path = name, path
+      @escape_query_value_proc = options[:escape_query_value]
     end
 
     def path_for(*args)
@@ -51,7 +59,9 @@ module Deas
     end
 
     def apply_extra(path, params)
-      params.empty? ? path : "#{path}?#{Deas::Cgi.http_query(params)}"
+      return path if params.empty?
+      query_string = Deas::Url.http_query(params, &self.escape_query_value_proc)
+      "#{path}?#{query_string}"
     end
 
     def apply_anchor(path, anchor)

data/lib/deas/version.rb

@@ -1,3 +1,3 @@
 module Deas
-  VERSION = "0.34.0"
+  VERSION = "0.35.0"
 end

data/test/unit/router_tests.rb

@@ -28,8 +28,10 @@ class Deas::Router
     subject{ @router }
 
     should have_readers :request_types, :urls, :routes
+    should have_readers :escape_query_value_proc
 
-    should have_imeths :view_handler_ns, :base_url, :prepend_base_url
+    should have_imeths :view_handler_ns, :escape_query_value
+    should have_imeths :base_url, :prepend_base_url
     should have_imeths :url, :url_for
     should have_imeths :default_request_type_name, :add_request_type
     should have_imeths :request_type_name
@@ -45,6 +47,10 @@ class Deas::Router
 
       exp = @router_class::DEFAULT_REQUEST_TYPE_NAME
       assert_equal exp, subject.default_request_type_name
+
+      value = "#%&?"
+      exp = Rack::Utils.escape(value)
+      assert_equal exp, subject.escape_query_value_proc.call(value)
     end
 
     should "set a view handler namespace" do
@@ -52,6 +58,14 @@ class Deas::Router
       assert_equal exp, subject.view_handler_ns
     end
 
+    should "allow configuring a custom escape query value proc" do
+      escape_proc = proc{ Factory.string }
+      subject.escape_query_value(&escape_proc)
+      assert_equal escape_proc, subject.escape_query_value_proc
+
+      assert_raises(ArgumentError){ subject.escape_query_value }
+    end
+
     should "set a base url" do
       subject.base_url(exp = Factory.url)
       assert_equal exp, subject.base_url
@@ -228,6 +242,16 @@ class Deas::Router
       assert_kind_of Deas::Url, url
       assert_equal :get_info, url.name
       assert_equal '/info/:for', url.path
+      assert_equal subject.escape_query_value_proc, url.escape_query_value_proc
+    end
+
+    should "define a url with a custom escape query value proc" do
+      name = Factory.string
+      escape_proc = proc{ Factory.string }
+      @router.url(name, Factory.path, :escape_query_value => escape_proc)
+
+      url = subject.urls[name.to_sym]
+      assert_equal escape_proc, url.escape_query_value_proc
     end
 
     should "complain if defining a url with a non-string path" do

data/test/unit/url_tests.rb

@@ -7,12 +7,36 @@ class Deas::Url
 
   class UnitTests < Assert::Context
     desc "Deas::Url"
+    setup do
+      @url_class = Deas::Url
+    end
+    subject{ @url_class }
+
+    should have_imeths :http_query
+
+    should "create http query strings" do
+      params = {
+        Factory.string        => Factory.string,
+        Factory.integer       => Factory.integer(3).times.map{ Factory.string },
+        Factory.string.to_sym => { Factory.string => Factory.string }
+      }
+      exp = params.map{ |(k, v)| "#{k}=#{v}" }.sort.join('&')
+      assert_equal exp, @url_class.http_query(params)
+
+      exp = params.map{ |(k, v)| "#{k}=#{v.inspect}" }.sort.join('&')
+      assert_equal exp, @url_class.http_query(params){ |v| v.inspect }
+    end
+
+  end
+
+  class InitTests < UnitTests
+    desc "when init"
     setup do
       @url = Deas::Url.new(:get_info, '/info')
     end
     subject{ @url }
 
-    should have_readers :name, :path
+    should have_readers :name, :path, :escape_query_value_proc
     should have_imeth :path_for
 
     should "know its name and path info" do
@@ -20,12 +44,25 @@ class Deas::Url
       assert_equal '/info', subject.path
     end
 
+    should "know its escape query value proc" do
+      assert_nil subject.escape_query_value_proc
+
+      escape_proc = proc{ Factory.string }
+      url = Deas::Url.new(Factory.string, Factory.path, {
+        :escape_query_value => escape_proc
+      })
+      assert escape_proc, subject.escape_query_value_proc
+    end
+
   end
 
-  class PathForTests < UnitTests
+  class PathForTests < InitTests
     desc "when generating paths"
     setup do
       @url = Deas::Url.new(:some_thing, '/:some/:thing/*/*')
+      @url_with_escape = Deas::Url.new(:some_thing, '/:some/:thing/*/*', {
+        :escape_query_value => proc{ |v| Rack::Utils.escape(v) }
+      })
     end
 
     should "generate given named params only" do
@@ -51,13 +88,31 @@ class Deas::Url
     end
 
     should "append other (additional) params as query params" do
-      exp_path = "/a/goose/cooked/well?aye=a%20a%20a&bee=b"
+      exp_path = "/a/goose/cooked/well?aye=a&bee=b"
       assert_equal exp_path, subject.path_for({
         'some'  => 'a',
         :thing  => 'goose',
         'splat' => ['cooked', 'well'],
         'bee'   => 'b',
-        :aye    => 'a a a'
+        :aye    => 'a'
+      })
+    end
+
+    should "escape query values when built with an escape query value proc" do
+      exp_path = "/a/goose/cooked/well?aye=a?a&a"
+      assert_equal exp_path, subject.path_for({
+        'some'  => 'a',
+        :thing  => 'goose',
+        'splat' => ['cooked', 'well'],
+        :aye    => 'a?a&a'
+      })
+
+      exp_path = "/a/goose/cooked/well?aye=a%3Fa%26a"
+      assert_equal exp_path, @url_with_escape.path_for({
+        'some'  => 'a',
+        :thing  => 'goose',
+        'splat' => ['cooked', 'well'],
+        :aye    => 'a?a&a'
       })
     end
 
@@ -142,10 +197,10 @@ class Deas::Url
 
     should "not alter the given params" do
       params = {
-        'some' => 'thing',
+        'some'    => 'thing',
         :captures => 'captures',
-        :splat => 'splat',
-        '#' => 'anchor'
+        :splat    => 'splat',
+        '#'       => 'anchor'
       }
       exp_params = params.dup
 

metadata

@@ -1,108 +1,123 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: deas
-version: !ruby/object:Gem::Version
-  version: 0.34.0
+version: !ruby/object:Gem::Version 
+  hash: 147
+  prerelease: 
+  segments: 
+  - 0
+  - 35
+  - 0
+  version: 0.35.0
 platform: ruby
-authors:
+authors: 
 - Kelly Redding
 - Collin Redding
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-07 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: ns-options
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
+
+date: 2015-06-24 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 1
+        version: "1.1"
     - - ">="
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 1
+        - 4
         version: 1.1.4
   type: :runtime
+  name: ns-options
+  version_requirements: *id001
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.4
-- !ruby/object:Gem::Dependency
-  name: rack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 5
+        version: "1.5"
   type: :runtime
+  name: rack
+  version_requirements: *id002
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: sinatra
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 4
+        version: "1.4"
   type: :runtime
+  name: sinatra
+  version_requirements: *id003
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-- !ruby/object:Gem::Dependency
-  name: assert
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.12'
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 12
+        version: "2.12"
   type: :development
+  name: assert
+  version_requirements: *id004
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.12'
-- !ruby/object:Gem::Dependency
-  name: assert-rack-test
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
     - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  name: assert-rack-test
+  version_requirements: *id005
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Handler-based web framework powered by Sinatra
-email:
+email: 
 - kelly@kellyredding.com
 - collin.redding@me.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
-- ".gitignore"
+
+files: 
+- .gitignore
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - deas.gemspec
 - lib/deas.rb
-- lib/deas/cgi.rb
 - lib/deas/deas_runner.rb
 - lib/deas/error_handler.rb
 - lib/deas/exceptions.rb
@@ -139,7 +154,6 @@ files:
 - test/support/test_template.test
 - test/support/view_handlers.rb
 - test/system/rack_tests.rb
-- test/unit/cgi_tests.rb
 - test/unit/deas_runner_tests.rb
 - test/unit/error_handler_tests.rb
 - test/unit/exceptions_tests.rb
@@ -163,30 +177,39 @@ files:
 - test/unit/view_handler_tests.rb
 - tmp/.gitkeep
 homepage: http://github.com/redding/deas
-licenses:
+licenses: 
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  requirements:
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
   - - ">="
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  requirements:
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
   - - ">="
-    - !ruby/object:Gem::Version
-      version: '0'
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Handler-based web framework powered by Sinatra
-test_files:
+test_files: 
 - test/helper.rb
 - test/support/factory.rb
 - test/support/fake_sinatra_call.rb
@@ -199,7 +222,6 @@ test_files:
 - test/support/test_template.test
 - test/support/view_handlers.rb
 - test/system/rack_tests.rb
-- test/unit/cgi_tests.rb
 - test/unit/deas_runner_tests.rb
 - test/unit/error_handler_tests.rb
 - test/unit/exceptions_tests.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: cfa612b3fc472e3c8a14005ca567c2a20b901476
-  data.tar.gz: c6e19d87a4393a780da387f19a5698100ab80296
-SHA512:
-  metadata.gz: 99c27beacb566a4f0361aadfd85c4d504c2bf11d0ed09112082f35ea115c37df3d69273da9482b27a9d0e50d6ef4eed1b2e3b1f8431eec5d50ffb053eb1e5622
-  data.tar.gz: 602b81f39fa49f1d92b244450248e7efc7515e06317c51b2ba951172ee9f67c29b4feb4ec7d14a30483bd0b5bfd6a68b03833848df85b6a5bbac7697fe65d409

data/lib/deas/cgi.rb

@@ -1,31 +0,0 @@
-module Deas
-
-  module Cgi
-    # taken from http://ruby-doc.org/stdlib/libdoc/cgi/rdoc/index.html
-    # => not requiring 'cgi' to save on memory usage
-
-    def self.escape(string)
-      string.gsub(/([^ a-zA-Z0-9_.-]+)/n) do
-        '%' + $1.unpack('H2' * $1.size).join('%').upcase
-      end.gsub(' ', '%20')
-    end
-
-    def self.http_query(value, key_ns = nil)
-      # optimized version taken from:
-      # http://github.com/kelredd/useful/blob/master/lib/useful/ruby_extensions/hash.rb
-      value.sort{|a,b| a[0].to_s <=> b[0].to_s}.collect do |key_val|
-        key, val = key_val
-        key_s = key_ns ? "#{key_ns}[#{key_val[0].to_s}]" : key_val[0].to_s
-        if key_val[1].kind_of?(::Array)
-          key_val[1].sort.collect{|i| "#{key_s}[]=#{Deas::Cgi.escape(i.to_s)}"}.join('&')
-        elsif key_val[1].kind_of?(::Hash)
-          Deas::Cgi.http_query(key_val[1], key_s)
-        else
-          "#{key_s}=#{Deas::Cgi.escape(key_val[1].to_s)}"
-        end
-      end.join('&')
-    end
-
-  end
-
-end

data/test/unit/cgi_tests.rb

@@ -1,36 +0,0 @@
-require 'assert'
-require 'deas/cgi'
-
-module Deas::Cgi
-
-  class UnitTests < Assert::Context
-    desc "Deas::Cgi"
-    subject{ Deas::Cgi }
-
-    should have_imeths :escape, :http_query
-
-    should "cgi-escape data values" do
-      exp = "Right%21%20%5BSaid%5D%20Fred.%0D%0A"
-      assert_equal exp, Deas::Cgi.escape("Right! [Said] Fred.\r\n")
-    end
-
-    should "create http query strings" do
-      exp = "name=thomas%20hardy%20%2F%20thomas%20handy"
-      assert_equal exp, Deas::Cgi.http_query(:name => 'thomas hardy / thomas handy')
-
-      exp = "id=23423&since=2009-10-14"
-      assert_equal exp, Deas::Cgi.http_query(:id => 23423, :since => "2009-10-14")
-
-      exp = "id[]=1&id[]=2"
-      assert_equal exp, Deas::Cgi.http_query(:id => [1,2])
-
-      exp = "poo[bar]=2&poo[foo]=1"
-      assert_equal exp, Deas::Cgi.http_query(:poo => {:foo => 1, :bar => 2})
-
-      exp = "poo[bar][bar1]=1&poo[bar][bar2]=nasty&poo[foo]=1"
-      assert_equal exp, Deas::Cgi.http_query(:poo => {:foo => 1, :bar => {:bar1 => 1, :bar2 => "nasty"}})
-    end
-
-  end
-
-end