uri_template 0.5.1 → 0.5.2

data/README.md

@@ -3,7 +3,8 @@ URITemplate - a uri template library
 
 [![Build Status](https://secure.travis-ci.org/hannesg/uri_template.png)](http://travis-ci.org/hannesg/uri_template)
 [![Dependency Status](https://gemnasium.com/hannesg/uri_template.png)](https://gemnasium.com/hannesg/uri_template)
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/hannesg/uri_template)
+[![Code Climate](https://codeclimate.com/github/hannesg/uri_template.png)](https://codeclimate.com/github/hannesg/uri_template)
+[![Coverage](https://coveralls.io/repos/hannesg/uri_template/badge.png?branch=master)](https://coveralls.io/r/hannesg/uri_template)
 
 With URITemplate you can generate URIs based on simple templates and extract variables from URIs using the same templates. There are currently two syntaxes defined. Namely the one defined in [RFC 6570]( http://tools.ietf.org/html/rfc6570 ) and a colon based syntax, similiar to the one used by sinatra.
 
@@ -53,4 +54,4 @@ The way variables are inserted can be modified using operators. The operator is
 Benchmarks
 -----------------------
 
-I have assembled one benchmark based on the uritemplate-test examples. You can find them in the "benchmarks" folder. The short result: uri_template is 2-10x faster than addressable on ruby 1.9.3.
+I have assembled one benchmark based on the uritemplate-test examples. You can find them in the "benchmarks" folder. The short result: uri_template is 2-10x faster than addressable on ruby 1.9.3.

data/lib/uri_template.rb

@@ -18,6 +18,42 @@
 # A base module for all implementations of a uri template.
 module URITemplate
 
+  # Helper module which defines class methods for all uri template
+  # classes.
+  module ClassMethods
+    # Tries to convert the given argument into an {URITemplate}.
+    # Returns nil if this fails.
+    #
+    # @return [nil|{URITemplate}]
+    def try_convert(x)
+      if x.kind_of? self
+        return x
+      elsif x.kind_of? String
+        return self.new(x)
+      else
+        return nil
+      end
+    end
+
+    # Same as {.try_convert} but raises an ArgumentError when the given argument could not be converted.
+    # 
+    # @raise ArgumentError if the argument is unconvertable
+    # @return {URITemplate}
+    def convert(x)
+      o = self.try_convert(x)
+      if o.nil?
+        raise ArgumentError, "Expected to receive something that can be converted into a URITemplate of type #{self.inspect}, but got #{x.inspect}"
+      end
+      return o
+    end
+
+    def included(base)
+      base.extend(ClassMethods)
+    end
+  end
+
+  extend ClassMethods
+
   # @api private
   SCHEME_REGEX = /\A[a-z]+:/i.freeze
 
@@ -78,32 +114,6 @@ module URITemplate
     return klass.new(*rest)
   end
 
-  # Tries to convert the given argument into an {URITemplate}.
-  # Returns nil if this fails.
-  #
-  # @return [nil|{URITemplate}]
-  def self.try_convert(x)
-    if x.kind_of? URITemplate
-      return x
-    elsif x.kind_of? String
-      return URITemplate.new(x)
-    else
-      return nil
-    end
-  end
-
-  # Same as {.try_convert} but raises an ArgumentError when the given argument could not be converted.
-  # 
-  # @raise ArgumentError if the argument is unconvertable
-  # @return {URITemplate}
-  def self.convert(x)
-    o = self.try_convert(x)
-    if o.nil?
-      raise ArgumentError, "Expected to receive something that can be converted to an URITemplate, but got #{x.inspect}"
-    end
-    return o
-  end
-
   # Tries to coerce two URITemplates into a common representation.
   # Returns an array with two {URITemplate}s and two booleans indicating which of the two were converted or raises an ArgumentError.
   #
@@ -153,6 +163,7 @@ module URITemplate
     a.send(method,b,*args)
   end
 
+  # @api private
   def self.coerce_first_arg(meth)
     alias_method( (meth.to_s + '_without_coercion').to_sym , meth )
     class_eval(<<-RUBY)
@@ -187,10 +198,14 @@ RUBY
   # @param variables [#map]
   # @return String
   def expand(variables = {})
-    raise ArgumentError, "Expected something that returns to :map, but got: #{variables.inspect}" unless variables.respond_to? :map
+    raise ArgumentError, "Expected something that responds to :map, but got: #{variables.inspect}" unless variables.respond_to? :map
 
     # Stringify variables
-    variables = Hash[variables.map{ |k, v| [k.to_s, v] }]
+    arg = variables.map{ |k, v| [k.to_s, v] }
+    if arg.any?{|elem| !elem.kind_of?(Array) }
+      raise ArgumentError, "Expected the output of variables.map to return an array of arrays but got #{arg.inspect}"
+    end
+    variables = Hash[arg]
 
     tokens.map{|part|
       part.expand(variables)

data/lib/uri_template/colon.rb

@@ -35,7 +35,7 @@ class Colon
 
   include URITemplate
 
-  VAR = /(?:\{:([a-z]+)\}|:([a-z]+)(?![a-z])|\*)/u
+  VAR = /(?:\{:(\w+)\}|:(\w+)(?!\w)|\*)/u
 
   class InvalidValue < StandardError
 

data/lib/uri_template/rfc6570.rb

@@ -35,6 +35,7 @@ class URITemplate::RFC6570
   # @private
   Utils = URITemplate::Utils
 
+  # :nocov:
   if Utils.use_unicode?
     # @private
     #                           \/ - unicode ctrl-chars
@@ -43,6 +44,7 @@ class URITemplate::RFC6570
     # @private
     LITERAL = Regexp.compile('([^"\'%<>\\\\^`{|}\x00-\x1F\x7F-\x9F\s]|%[0-9a-fA-F]{2})+',Utils::KCODE_UTF8)
   end
+  # :nocov:
 
   # @private
   CHARACTER_CLASSES = {
@@ -84,13 +86,32 @@ class URITemplate::RFC6570
   DEFAULT_PROCESSING = CONVERT_VALUES + CONVERT_RESULT
 
   # @private
-  VAR = Regexp.compile(<<'__REGEXP__'.strip, Utils::KCODE_UTF8)
-((?:[a-zA-Z0-9_]|%[0-9a-fA-F]{2})(?:\.?(?:[a-zA-Z0-9_]|%[0-9a-fA-F]{2}))*)(\*)?(?::(\d+))?
+  VAR = Regexp.compile(Utils.compact_regexp(<<'__REGEXP__'), Utils::KCODE_UTF8)
+(
+  (?:[a-zA-Z0-9_]|%[0-9a-fA-F]{2})
+  (?:\.?
+    (?:[a-zA-Z0-9_]|%[0-9a-fA-F]{2})
+  )*
+)
+(?:(\*)|:([1-9]\d{0,3})|)
 __REGEXP__
 
   # @private
-  EXPRESSION = Regexp.compile(<<'__REGEXP__'.strip, Utils::KCODE_UTF8)
-\{([+#\./;?&]?)((?:[a-zA-Z0-9_]|%[0-9a-fA-F]{2})(?:\.?(?:[a-zA-Z0-9_]|%[0-9a-fA-F]{2}))*\*?(?::\d+)?(?:,(?:[a-zA-Z0-9_]|%[0-9a-fA-F]{2})(?:\.?(?:[a-zA-Z0-9_]|%[0-9a-fA-F]{2}))*\*?(?::\d+)?)*)\}
+  EXPRESSION = Regexp.compile(Utils.compact_regexp(<<'__REGEXP__'), Utils::KCODE_UTF8)
+\{
+  ([+#\./;?&]?)
+  (
+    (?:[a-zA-Z0-9_]|%[0-9a-fA-F]{2})
+    (?:\.?(?:[a-zA-Z0-9_]|%[0-9a-fA-F]{2}))*
+    (?:\*|:[1-9]\d{0,3}|)
+    (?:
+      ,
+      (?:[a-zA-Z0-9_]|%[0-9a-fA-F]{2})
+      (?:\.?(?:[a-zA-Z0-9_]|%[0-9a-fA-F]{2}))*
+      (?:\*|:[1-9]\d{0,3}|)
+    )*
+  )
+\}
 __REGEXP__
 
   # @private
@@ -115,10 +136,6 @@ __REGEXP__
       1
     end
 
-    def arity
-      0
-    end
-
     def to_r_source(*_)
       Regexp.escape(@string)
     end
@@ -366,7 +383,6 @@ __REGEXP__
       if block_given?
         return yield result
       end
-
       return result
     end
   end
@@ -435,10 +451,6 @@ protected
     self.class::Tokenizer.new(pattern, self.class::OPERATORS).to_a
   end
 
-  def arity
-    @arity ||= tokens.inject(0){|a,t| a + t.arity }
-  end
-
   # @private
   def extract_matchdata(matchdata, post_processing)
     bc = 1
@@ -460,7 +472,7 @@ protected
         return Hash[vars]
       end
     else
-      if post_processing.include? :convert_value
+      if post_processing.include? :convert_values
         return vars.collect{|k,v| [k,Utils.pair_array_to_hash(v)] }
       else
         return vars
@@ -471,4 +483,4 @@ protected
 end
 
 require 'uri_template/rfc6570/regex_builder.rb'
-require 'uri_template/rfc6570/expression.rb'
+require 'uri_template/rfc6570/expression.rb'

data/lib/uri_template/rfc6570/expression.rb

@@ -41,7 +41,6 @@ class URITemplate::RFC6570
 
     CHARACTER_CLASS = CHARACTER_CLASSES[:unreserved]
 
-    NAMED = false
     OPERATOR = ''
 
     def level
@@ -56,10 +55,6 @@ class URITemplate::RFC6570
       end
     end
 
-    def expands?
-      @variable_specs.any?{|_,expand,_| expand }
-    end
-
     def arity
       @variable_specs.size
     end
@@ -241,8 +236,6 @@ class URITemplate::RFC6570
     def transform_hash(name, hsh, expand , max_length)
       if expand
         hsh.map{|key,value| pair(escape(key),value) }
-      elsif hsh.none? && !self.class::NAMED
-        []
       else
         [ self_pair(name,hsh){|key,value| escape(key)+self.class::LIST_CONNECTOR+escape(value)} ]
       end
@@ -251,8 +244,6 @@ class URITemplate::RFC6570
     def transform_array(name, ary, expand , max_length)
       if expand
         ary.map{|value| self_pair(name,value) }
-      elsif ary.none? && !self.class::NAMED
-        []
       else
         [ self_pair(name, ary){|value| escape(value) } ]
       end
@@ -332,7 +323,6 @@ class URITemplate::RFC6570
 
     SEPARATOR = ';'.freeze
     PREFIX = ';'.freeze
-    NAMED = true
     PAIR_IF_EMPTY = false
     OPERATOR = ';'.freeze
     BASE_LEVEL = 3
@@ -343,7 +333,6 @@ class URITemplate::RFC6570
 
     SEPARATOR = '&'.freeze
     PREFIX = '?'.freeze
-    NAMED = true
     OPERATOR = '?'.freeze
     BASE_LEVEL = 3
 
@@ -353,7 +342,6 @@ class URITemplate::RFC6570
 
     SEPARATOR = '&'.freeze
     PREFIX = '&'.freeze
-    NAMED = true
     OPERATOR = '&'.freeze
     BASE_LEVEL = 3
 
@@ -371,4 +359,4 @@ class URITemplate::RFC6570
     '&' => Expression::FormQueryContinuation
   }
 
-end
+end

data/lib/uri_template/rfc6570/expression/unnamed.rb

@@ -65,6 +65,16 @@ class URITemplate::RFC6570::Expression::Unnamed < URITemplate::RFC6570::Expressi
 
 private
 
+  def transform_hash(name, hsh, expand , max_length)
+    return [] if hsh.none?
+    super
+  end
+
+  def transform_array(name, ary, expand , max_length)
+    return [] if ary.none?
+    super
+  end
+
   def after_expand(name, splitted)
     if splitted.none?{|_,b| b }
       return [ [ name, splitted.map{|a,_| a } ] ]
@@ -73,4 +83,4 @@ private
     end
   end
 
-end
+end

data/lib/uri_template/utils.rb

@@ -14,7 +14,6 @@
 #
 #    (c) 2011 - 2012 by Hannes Georg
 #
-
 module URITemplate
 
   # An awesome little helper which helps iterating over a string.
@@ -31,14 +30,13 @@ module URITemplate
 
     def each(str)
       raise ArgumentError, "RegexpEnumerator#each expects a String, but got #{str.inspect}" unless str.kind_of? String
-      return Enumerator.new(self,:each,str) unless block_given?
+      return self.to_enum(:each,str) unless block_given?
       rest = str
       loop do
         m = @regexp.match(rest)
         if m.nil?
           if rest.size > 0
-            yield rest if @rest == :yield
-            raise "Unable to match #{rest.inspect} against #{@regexp.inspect}" if @rest == :raise
+            yield rest
           end
           break
         end
@@ -83,69 +81,65 @@ module URITemplate
     # Bundles some string encoding methods.
     module StringEncoding
 
-      # @method to_ascii(string)
-      # converts a string to ascii
-      # 
-      # @param str [String]
-      # @return String
-      # @visibility public
-      def to_ascii_encode(str)
-        str.encode(Encoding::ASCII)
-      end
+      # Methods which do actual encoding.
+      module Encode
+        # converts a string to ascii
+        # 
+        # @param str [String]
+        # @return String
+        # @visibility public
+        def to_ascii(str)
+          str.encode(Encoding::ASCII)
+        end
 
-      # @method to_utf8(string)
-      # converts a string to utf8
-      # 
-      # @param str [String]
-      # @return String
-      # @visibility public
-      def to_utf8_encode(str)
-        str.encode(Encoding::UTF_8)
-      end
+        # converts a string to utf8
+        # 
+        # @param str [String]
+        # @return String
+        # @visibility public
+        def to_utf8(str)
+          str.encode(Encoding::UTF_8)
+        end
+
+        # enforces UTF8 encoding
+        # 
+        # @param str [String]
+        # @return String
+        # @visibility public
+        def force_utf8(str)
+          return str if str.encoding == Encoding::UTF_8
+          str = str.dup if str.frozen?
+          return str.force_encoding(Encoding::UTF_8)
+        end
 
-      # @method force_utf8(str)
-      # enforces UTF8 encoding
-      # 
-      # @param str [String]
-      # @return String
-      # @visibility public
-      def force_utf8_encode(str)
-        return str if str.encoding == Encoding::UTF_8
-        str = str.dup if str.frozen?
-        return str.force_encoding(Encoding::UTF_8)
       end
 
+      # Fallback methods to be used in pre 1.9 rubies.
+      module Fallback
 
-      def to_ascii_fallback(str)
-        str
-      end
+        def to_ascii(str)
+          str
+        end
 
-      def to_utf8_fallback(str)
-        str
-      end
+        def to_utf8(str)
+          str
+        end
+
+        def force_utf8(str)
+          str
+        end
 
-      def force_utf8_fallback(str)
-        str
       end
 
+      # :nocov:
       if "".respond_to?(:encode)
-        # @api private
-        send(:alias_method, :to_ascii, :to_ascii_encode)
-        # @api private
-        send(:alias_method, :to_utf8, :to_utf8_encode)
-        # @api private
-        send(:alias_method, :force_utf8, :force_utf8_encode)
+        include Encode
       else
-        # @api private
-        send(:alias_method, :to_ascii, :to_ascii_fallback)
-        # @api private
-        send(:alias_method, :to_utf8, :to_utf8_fallback)
-        # @api private
-        send(:alias_method, :force_utf8, :force_utf8_fallback)
+        include Fallback
       end
+      # :nocov:
 
-      public :to_ascii
-      public :to_utf8
+      private :force_utf8
 
     end
 
@@ -155,8 +149,6 @@ module URITemplate
       # The performance is acceptable, but could be better with escape_utils.
       module Pure
 
-        include StringEncoding
-
         # @private
         URL_ESCAPED = /([^A-Za-z0-9\-\._])/.freeze
 
@@ -179,13 +171,13 @@ module URITemplate
         end
 
         def unescape_url(s)
-          force_utf8( to_ascii(s).gsub('+',' ').gsub(PCT){
+          force_utf8( to_ascii(s.to_s).gsub('+',' ').gsub(PCT){
             $1.to_i(16).chr
           } )
         end
 
         def unescape_uri(s)
-          force_utf8( to_ascii(s).gsub(PCT){
+          force_utf8( to_ascii(s.to_s).gsub(PCT){
             $1.to_i(16).chr
           })
         end
@@ -202,8 +194,6 @@ module URITemplate
       # The performance is good, espacially for strings with many escaped characters.
       module EscapeUtils
 
-        include StringEncoding
-
         include ::EscapeUtils
 
         def using_escape_utils?
@@ -211,19 +201,19 @@ module URITemplate
         end
 
         def escape_url(s)
-          super(to_utf8(s)).gsub('+','%20')
+          super(to_utf8(s.to_s)).gsub('+','%20')
         end
 
         def escape_uri(s)
-          super(to_utf8(s))
+          super(to_utf8(s.to_s))
         end
 
         def unescape_url(s)
-          force_utf8(super(to_ascii(s)))
+          force_utf8(super(to_ascii(s.to_s)))
         end
 
         def unescape_uri(s)
-          force_utf8(super(to_ascii(s)))
+          force_utf8(super(to_ascii(s.to_s)))
         end
 
       end
@@ -233,7 +223,7 @@ module URITemplate
     end
 
     include StringEncoding
-
+    # :nocov:
     if Escaping.const_defined? :EscapeUtils
       include Escaping::EscapeUtils
       puts "Using escape_utils." if $VERBOSE
@@ -241,6 +231,7 @@ module URITemplate
       include Escaping::Pure
       puts "Not using escape_utils." if $VERBOSE
     end
+    # :nocov:
 
     # Converts an object to a param value.
     # Tries to call :to_param and then :to_s on that object.
@@ -267,9 +258,7 @@ module URITemplate
     # @api private
     # Should we use \u.... or \x.. in regexps?
     def use_unicode?
-      return eval('Regexp.compile("\u0020")') =~ " "
-    rescue SyntaxError
-      false
+      eval('Regexp.compile("\u0020")') =~ " " rescue false
     end
 
     # Returns true when the given value is an array and it only consists of arrays with two items.
@@ -328,6 +317,11 @@ module URITemplate
       return result
     end
 
+    # @api private
+    def compact_regexp(rx)
+      rx.split("\n").map(&:strip).join
+    end
+
   end
 
 end

data/uri_template.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'uri_template'
-  s.version = '0.5.1'
+  s.version = '0.5.2'
   s.date = Time.now.strftime('%Y-%m-%d')
   s.authors = ["HannesG"]
   s.email = %q{hannes.georg@googlemail.com}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uri_template
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,14 +9,14 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-23 00:00:00.000000000 Z
+date: 2013-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
@@ -24,7 +24,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -32,7 +32,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
@@ -40,7 +40,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -48,7 +48,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
@@ -56,7 +56,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -64,7 +64,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
@@ -72,7 +72,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -80,7 +80,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
@@ -88,7 +88,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A templating system for URIs, which implements RFC6570 and Colon based
@@ -98,16 +98,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/uri_template/rfc6570/expression.rb
-- lib/uri_template/rfc6570/regex_builder.rb
-- lib/uri_template/rfc6570/expression/named.rb
-- lib/uri_template/rfc6570/expression/unnamed.rb
+- lib/uri_template/utils.rb
 - lib/uri_template/colon.rb
-- lib/uri_template/literal.rb
 - lib/uri_template/expression.rb
-- lib/uri_template/utils.rb
-- lib/uri_template/rfc6570.rb
 - lib/uri_template/token.rb
+- lib/uri_template/rfc6570.rb
+- lib/uri_template/literal.rb
+- lib/uri_template/rfc6570/regex_builder.rb
+- lib/uri_template/rfc6570/expression/unnamed.rb
+- lib/uri_template/rfc6570/expression/named.rb
+- lib/uri_template/rfc6570/expression.rb
 - lib/uri_template.rb
 - uri_template.gemspec
 - README.md
@@ -121,18 +121,18 @@ require_paths:
 required_ruby_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: A templating system for URIs.