uri_template 0.5.3 → 0.6.0

data/CHANGELOG.md

@@ -1,56 +1,84 @@
+# 0.6.0 - TBD
+
+* [FEATURE] partial expansion
+* [FEATURE] You can now pass variables as an Array to URITemplate#expand ( thanks to @bmaland )
+    Example:
+
+        tpl = URITemplate.new("/{var}/")
+        tpl.expand(["value"]) # => '/value/'
+
+* [BUGFIX] Expanding arrays/hashes with a length limit now actually works
+
+# 0.5.2 - 24.02.2013
+
+* [ENHANCEMENT] The colon based uri templates now allow more characters in variable names.
+
 # 0.5.1 - 23.09.2012
-  - * f*** bug.
+
+* [BUGFIX] f*** bug.
 
 # 0.5.0 - 23.09.2012
-  - - Removed draft7
-  - - splitted absoulte? method into host? and scheme?
-  - + the URITemplate interface is now much stronger
-  - * code quality _significantly_ improved
-  - + concat method
+
+* [ENHANCEMENT] Removed draft7
+* [ENHANCEMENT] splitted absoulte? method into host? and scheme?
+* [ENHANCEMENT] the URITemplate interface is now much stronger
+* [ENHANCEMENT] code quality _significantly_ improved
+* [ENHANCEMENT] concat method
 
 # 0.4.0 - 06.07.2012
-  - + expand now accepts symbols as keys ( thanks to @peterhellber )
-  - + expand now accepts arrays of pairs ( thanks to @peterhellber )
-  - * fixed some testing bugs
+
+* [ENHANCEMENT] expand now accepts symbols as keys ( thanks to @peterhellber )
+* [ENHANCEMENT] expand now accepts arrays of pairs ( thanks to @peterhellber )
+* [BUGFIX] fixed some testing bugs
 
 # 0.3.0 - 24.05.2012
-  - + Implemented the final version. Default implementation is now RFC 6570
-  - * BUGFIX: variables with terminal dots were allowed
-  - * BUGFIX: lists of commas were parsed incorrectly
+
+* [ENHANCEMENT] Implemented the final version. Default implementation is now RFC 6570
+* [BUGFIX] variables with terminal dots were allowed
+* [BUGFIX] lists of commas were parsed incorrectly
 
 # 0.2.1 - 30.12.2011
-  - * Compatibility: Works now with MRI 1.8.7 and REE
+
+* [ENHANCEMENT] Works now with MRI 1.8.7 and REE
 
 # 0.2.0 - 03.12.2011
-  - * Reworked the escaping mechanism
-  - + escape_utils can now be used to boost escape/unescape performance
+
+* [ENHANCEMENT] Reworked the escaping mechanism
+* [ENHANCEMENT] escape_utils can now be used to boost escape/unescape performance
 
 # 0.1.4 - 19.11.2011
-  - * Compatiblity: Works now with MRI 1.9.3, Rubinius and JRuby
-  - * Various (significant!) performance improvements
+
+* [ENHANCEMENT] Compatiblity: Works now with MRI 1.9.3, Rubinius and JRuby
+* [ENHANCEMENT] Various (significant!) performance improvements
 
 # 0.1.3 - 15.11.2011
-  - * BUGFIX: Draft7./ now concatenates literals correctly
-  - * BUGFIX: Draft7.tokens is now public
+
+* [BUGFIX] Draft7./ now concatenates literals correctly
+* [BUGFIX] Draft7.tokens is now public
 
 # 0.1.2 - 10.11.2011
-  - + added a new template-type: Colon
+
+* [FEATURE] added a new template-type: Colon
     this should allow (some day) to  rails-like routing tables
-  - + made the tokens-method mandatory and added two interfaces for tokens.
+* [ENHANCEMENT] made the tokens-method mandatory and added two interfaces for tokens.
     this allows cross-type features like variable anaylisis
 
 # 0.1.1 -  4.11.2011
-  - + added a bunch of useful helper methods
+
+* [ENHANCEMENT] added a bunch of useful helper methods
 
 # 0.1.0 -  2.11.2011
-  - - Removed Sections. They made too many headaches.
-  - + Made draft7 template concatenateable. This should replace sections.
-  - * BUGFIX: multiline uris were matched
-  - * BUGFIX: variablenames were decoded when this was not appreciated
+
+* [ENHANCEMENT] Removed Sections. They made too many headaches.
+* [ENHANCEMENT] Made draft7 template concatenateable. This should replace sections.
+* [BUGFIX] multiline uris were matched
+* [BUGFIX] variablenames were decoded when this was not appreciated
 
 # 0.0.2 -  1.11.2011
-  - * BUGFIX: Concatenating empty sections no more leads to catch-all templates, when an emtpy template was appreciated.
-  - + The extracted variables now contains the keys :suffix and :prefix if the match didn't consume the whole uri.
+
+* [BUGFIX] Concatenating empty sections no more leads to catch-all templates, when an emtpy template was appreciated.
+* [ENHANCEMENT] The extracted variables now contains the keys :suffix and :prefix if the match didn't consume the whole uri.
 
 # 0.0.1 - 30.10.2011
-  - Initial version
+
+* [FEATURE] Initial version

data/README.md

@@ -38,7 +38,9 @@ Examples
     
     # This will give: {'x' => 'z'}
     tpl2.extract('/z/y')
-
+    
+    # This will give a new uri template with just the host expanded:
+    tpl.expand_partial(host: "www.host.com")
 
 RFC 6570 Syntax
 --------------------

data/lib/uri_template.rb

@@ -192,33 +192,51 @@ RUBY
   # The keys in the variables hash are converted to
   # strings in order to support the Ruby 1.9 hash syntax.
   #
+  # If the variables are given as an array, they will be matched against the variables in the template based on their order.
+  #
   # @raise {Unconvertable} if a variable could not be converted to a string.
   # @raise {InvalidValue} if a value is not suiteable for a certain variable ( e.g. a string when a list is expected ).
   #
-  # @param variables [#map]
+  # @param variables [#map, Array]
   # @return String
   def expand(variables = {})
-    raise ArgumentError, "Expected something that responds to :map, but got: #{variables.inspect}" unless variables.respond_to? :map
-
-    if variables.kind_of? Array
-      warn <<WARN
-Passing variables as an Array to URITemplate#expand will have a different semantic in the next version of uri_template.
-Please convert your variables into a Hash or use some ducktyping.
-WARN
-    end
-
-    # Stringify variables
-    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]
-
+    variables = normalize_variables(variables)
     tokens.map{|part|
       part.expand(variables)
     }.join
   end
 
+  # Works like #expand with two differences:
+  #
+  #  - the result is a uri template instead of string
+  #  - undefined variables are left in the template
+  # 
+  # @see {#expand}
+  # @param variables [#map, Array]
+  # @return [URITemplate]
+  def expand_partial(variables = {})
+    variables = normalize_variables(variables)
+    self.class.new(tokens.map{|part|
+      part.expand_partial(variables)
+    }.flatten(1))
+  end
+
+  def normalize_variables( variables )
+    raise ArgumentError, "Expected something that responds to :map, but got: #{variables.inspect}" unless variables.respond_to? :map
+    if variables.kind_of?(Array)
+      return Hash[self.variables.zip(variables)]
+    else
+      # Stringify variables
+      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
+      return Hash[arg]
+    end
+  end
+
+  private :normalize_variables
+
   # @abstract
   # Returns the type of this template. The type is a symbol which can be used in {.resolve_class} to resolve the type of this template.
   #

data/lib/uri_template/literal.rb

@@ -40,6 +40,10 @@ module URITemplate::Literal
     return string
   end
 
+  def expand_partial(_)
+    return [self]
+  end
+
   def starts_with_slash?
     string[0] == SLASH
   end
@@ -50,4 +54,4 @@ module URITemplate::Literal
 
   alias to_s string
 
-end
+end

data/lib/uri_template/rfc6570.rb

@@ -33,7 +33,41 @@ class URITemplate::RFC6570
   extend Forwardable
 
   # @private
-  Utils = URITemplate::Utils
+  module Utils
+
+    include URITemplate::Utils
+
+    # Returns true iff the value is `defined` [RFC6570 Section 2.3](http://tools.ietf.org/html/rfc6570#section-2.3)
+    # 
+    # The only undefined things are:
+    # - nil
+    # - arrays containing no defined value
+    # - associative arrays/hashes containing no defined value
+    #
+    # Things that are always defined:
+    # - Strings, independent of the length
+    def def?( value )
+      case( value )
+      when nil  then
+        false
+      when Hash then
+        value.any?{|_, v| !v.nil? }
+      when Array then
+        if value.none?
+          false
+        elsif value[0].kind_of?(Array)
+          value.any?{|_,v| !v.nil? }
+        else
+          value.any?{|v| !v.nil? }
+        end
+      else
+        true
+      end
+    end
+
+    extend self
+
+  end
 
   # :nocov:
   if Utils.use_unicode?
@@ -161,34 +195,6 @@ __REGEXP__
 
   end
 
-  class InvalidValue < StandardError
-
-    include URITemplate::InvalidValue
-
-    attr_reader :variable, :value
-
-    def initialize(variable, value)
-      @variable = variable
-      @value = value
-      super(generate_message())
-    end
-  protected
-
-    def generate_message()
-      return "The template variable " + variable.inspect + " cannot expand the given value "+ value.inspect
-    end
-
-  end
-
-  class InvalidValue::LengthLimitInapplicable < InvalidValue
-
-  protected
-    def generate_message()
-      return "The template variable "+variable.inspect+" has a length limit and therefore cannot expand an associative value ("+value.inspect+")."
-    end
-
-  end
-
   # @private
   class Tokenizer
 
@@ -307,9 +313,18 @@ __REGEXP__
   #   URITemplate::RFC6570.new('{?args*}').expand('args'=>{'key'=>'value'}) #=> '?key=value'
   #   URITemplate::RFC6570.new('{undef}').expand() #=> ''
   #
-  # @param variables [Hash]
+  # @param variables [Hash, Array]
   # @return String
 
+  # @method expand_partial(variables = {})
+  # Works like expand but keeps missing variables in place.
+  # @example
+  #   URITemplate::RFC6570.new('{foo}').expand_partial('foo'=>'bar') #=> URITemplate::RFC6570.new('bar')
+  #   URITemplate::RFC6570.new('{undef}').expand_partial() #=> URITemplate::RFC6570.new('{undef}')
+  #
+  # @param variables [Hash,Array]
+  # @return URITemplate
+
   # Compiles this template into a regular expression which can be used to test whether a given uri matches this template. This template is also used for {#===}.
   #
   # @example

data/lib/uri_template/rfc6570/expression.rb

@@ -61,11 +61,11 @@ class URITemplate::RFC6570
 
     def expand( vars )
       result = []
-      @variable_specs.each{| var, expand , max_length |
-        unless vars[var].nil?
+      @variable_specs.each do | var, expand , max_length |
+        if Utils.def? vars[var]
           result.push(*expand_one(var, vars[var], expand, max_length))
         end
-      }
+      end
       if result.any?
         return (self.class::PREFIX + result.join(self.class::SEPARATOR))
       else
@@ -73,6 +73,24 @@ class URITemplate::RFC6570
       end
     end
 
+    def expand_partial( vars )
+      result = []
+      defined = false
+      @variable_specs.each do | var, expand , max_length |
+        defined ||= vars.key? var
+        if Utils.def? vars[var]
+          result.push(*expand_one(var, vars[var], expand, max_length))
+        end
+      end
+      if result.any?
+        return [ Literal.new(self.class::PREFIX + result.join(self.class::SEPARATOR)) ]
+      elsif defined
+        return []
+      else
+        return [ self ]
+      end
+    end
+
     def extract(position,matched)
       name, expand, max_length = @variable_specs[position]
       if matched.nil?
@@ -101,11 +119,6 @@ class URITemplate::RFC6570
   private
 
     def expand_one( name, value, expand, max_length)
-      if length_limited?(max_length)
-        if value.kind_of?(Array) or value.kind_of?(Hash)
-          raise InvalidValue::LengthLimitInapplicable.new(name,value)
-        end
-      end
       if value.kind_of?(Hash) or Utils.pair_array?(value)
         return transform_hash(name, value, expand, max_length)
       elsif value.kind_of? Array
@@ -237,7 +250,7 @@ class URITemplate::RFC6570
       if expand
         hsh.map{|key,value| pair(escape(key),value) }
       else
-        [ self_pair(name,hsh){|key,value| escape(key)+self.class::LIST_CONNECTOR+escape(value)} ]
+        [ self_pair(name,hsh, max_length ){|key,value| escape(key)+self.class::LIST_CONNECTOR+escape(value)} ]
       end
     end
 
@@ -245,7 +258,7 @@ class URITemplate::RFC6570
       if expand
         ary.map{|value| self_pair(name,value) }
       else
-        [ self_pair(name, ary){|value| escape(value) } ]
+        [ self_pair(name, ary, max_length){|value| escape(value) } ]
       end
     end
   end

data/lib/uri_template/token.rb

@@ -56,9 +56,14 @@ module URITemplate::Token
     raise "Please implement #expand(variables) on #{self.class.inspect}."
   end
 
+  # @abstract
+  def expand_partial(variables)
+    raise "Please implement #expand_partial(variables) on #{self.class.inspect}."
+  end
+
   # @abstract
   def to_s
     raise "Please implement #to_s on #{self.class.inspect}."
   end
 
-end
+end

data/uri_template.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'uri_template'
-  s.version = '0.5.3'
+  s.version = '0.6.0'
   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.3
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,14 +9,14 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-04 00:00:00.000000000 Z
+date: 2013-08-09 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
@@ -121,20 +121,19 @@ 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.25
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A templating system for URIs.
 test_files: []
-has_rdoc: