facets 2.9.3 → 3.0.0

data/lib/standard/facets/uri/cgi_escape.rb

@@ -0,0 +1,46 @@
+require 'uri'
+
+module URI
+
+  module_function
+
+  # TODO: How does `URI.cgi_escape` compare to `URI.escape`?
+
+  #
+  # CGI escape
+  #
+  def cgi_escape(string)
+    string.gsub(/([^ a-zA-Z0-9_.-]+)/n) do
+      '%' + $1.unpack('H2' * $1.size).join('%').upcase
+    end.tr(' ', '+')
+  end
+
+  #
+  #
+  #
+  def cgi_unescape(string)
+    string.tr('+', ' ').gsub(/((?:%[0-9a-fA-F]{2})+)/n) do
+      [$1.delete('%')].pack('H*')
+    end
+  end
+
+  #
+  #
+  #
+  def cgi_parse(query)
+    params = Hash.new([].freeze)
+
+    query.split(/[&;]/n).each do |pairs|
+      key, value = pairs.split('=',2).collect{|v| cgi_unescape(v) }
+      if params.has_key?(key)
+        params[key].push(value)
+      else
+        params[key] = [value]
+      end
+    end
+
+    params
+  end
+
+end
+

data/lib/standard/facets/uri/cgi_parse.rb

@@ -0,0 +1 @@
+require 'facets/uri/cgi_escape'

data/lib/standard/facets/uri/cgi_unescape.rb

@@ -0,0 +1 @@
+require 'facets/uri/cgi_escape'

data/lib/standard/facets/uri/decode.rb

@@ -0,0 +1,32 @@
+require 'uri'
+
+module URI
+
+  module_function
+
+  # Decode the uri components.
+  #
+  def decode(uri)
+    ## gmosx: hmm is this needed?
+    ## guard against invalid filenames for example pictures with
+    ## spaces uploaded by users
+    escaped_uri = uri.gsub(/ /, "+")
+
+    if md = URI::REGEXP::REL_URI.match(escaped_uri)
+      path = "#{md[5]}#{md[6]}"
+      type = File.extname(path)
+      query_string = md[7]
+
+      ## real_path = "#{$root_dir}/#{path}"
+
+      parameters = URI.query_to_hash(query_string)
+      path.gsub!(/\+/, " ")
+
+      return [path, type, parameters, query_string]
+    end
+
+    ## this is usefull for uncovering bugs!
+    raise ArgumentError.new("the parameter '#{uri}' is not a valid uri")
+  end
+
+end

data/lib/standard/facets/uri/parameters.rb

@@ -0,0 +1,63 @@
+require 'uri'
+
+module URI
+
+  # Allows for taking a hash and turning it into URI/CGI params
+  # Since 1.8.x does not have ordered hashes the params might not
+  # be ordered.
+  #
+  # @todo URI.parameters needs URI escaping.
+  #
+  # @author Matt Kirk
+
+  def self.parameters(hash)
+    hash.map do |k,v|
+      if v.respond_to?(:join)
+        "#{k}=#{v.join(",")}"
+      else
+        "#{k}=#{v}"
+      end
+    end.join("&")
+  end
+
+  # We cannot send nested hash as a param in HTTP requests. For example,
+  # when we would like to send something like this:
+  #
+  #     {:key => "value", :nested => {:nest => "value"}}
+  #
+  # It would be (or should be) mapped like this:
+  #
+  #     /url/?key=value&nested=%7B%3Anest%3D%3E%5C%22value%5C%22%7D 
+  #
+  # Doesn’t look to good ;) However there is a simple way to convert a nested
+  # hash into a params acceptable form. We can convert it to a form, that can
+  # be mapped into params like this:
+  #
+  #     /url/?key=value&nested[nest]=value 
+  #
+  # Here is method to convert any nested hash to a “one level” equivalent:
+  #
+  # @author Maciej Mensfeld
+
+  def self.nested_parameters(value, key=nil, hash={})
+    case value
+    when Hash
+      value.each do |k,v|
+        akey = key.nil? ? :"#{k}" : :"#{key}[#{k}]"
+        nested_parameters(v, akey, hash) 
+      end
+      out_hash
+    when Array
+      value.each do |v|
+        nested_parameters(v, "#{key}[]", hash)
+      end
+      hash
+    when nil then ''
+    else
+      hash[key] = value
+      hash
+    end
+    parameters(hash)
+  end
+ 
+end

data/lib/standard/facets/uri/query.rb

@@ -0,0 +1,148 @@
+# TODO: URI query methods need work and new consideration.
+
+require 'uri'
+require 'facets/uri/cgi_escape'
+require 'facets/module/alias_module_function'
+
+module URI
+
+  module_function
+
+  #
+  #
+  #
+  KEY_VALUE_SEPARATOR = ";"  # "&"
+
+  #
+  # Given a hash with parameter/value pairs construct a
+  # standard query string.
+  #
+  #   URI.hash_to_query(:a => 1, :b => 2)
+  #   #=> "a=1;b=2"
+  #
+  def query(parameters)
+    return '' unless parameters
+    pairs = []
+    parameters.each do |param, value|
+      pairs << "#{param}=#{cgi_escape(value.to_s)}"
+    end
+    return pairs.join(KEY_VALUE_SEPARATOR)
+  end
+
+  alias_module_function :hash_to_query, :query
+  alias_module_function :hash_to_query_string, :query
+
+  #
+  # Extend the basic query string parser provided by the cgi module.
+  # converts single valued params (the most common case) to
+  # objects instead of arrays
+  #
+  # Returns hash of parameters, contains arrays for multivalued parameters
+  # (multiselect, checkboxes , etc).
+  #
+  # If no query string is provided (nil or "") returns an empty hash.
+  #
+  def query_hash(query_string)
+    return {} unless query_string
+
+    query_parameters = cgi_parse(query_string)
+
+    query_parameters.each { |key, val|
+      ## replace the array with an object
+      query_parameters[key] = val[0] if 1 == val.length
+    }
+
+    ## set default value to nil! cgi sets this to []
+    query_parameters.default = nil
+
+    return query_parameters
+  end
+
+  alias_module_function :query_to_hash, :query_hash
+  alias_module_function :query_string_to_hash, :query_hash
+
+  #
+  # This method returns the query string of a uri.
+  #
+  # @param [String] uri
+  #   The uri string.
+  #
+  # @return [String] 
+  #   The query string, or `nil` if no query string.
+  #
+  def query_get(uri)
+    return nil unless uri
+    # gmosx: INVESTIGATE ruby's URI seems to differently handle
+    # abs and rel uris.
+    if md = URI::REGEXP::ABS_URI.match(uri)
+      return md[8]
+    elsif md = URI::REGEXP::REL_URI.match(uri)
+      return md[7]
+    end
+    return nil
+  end
+
+  alias_method :get_query_string, :query_get
+
+  #
+  # Removes the query string from a +uri+.
+  #
+  # Returns the chomped uri.
+  #
+  def query_chomp(uri)
+    return nil unless uri
+    query_string = self.get_query_string(uri)
+    return uri.dup.chomp("?#{query_string}")
+  end
+
+  alias_module_function :chomp_query_string, :query_chomp
+
+  #
+  # Get a uri and a hash of parameters. Inject the hash values
+  # as parameters in the query sting path. Returns the full uri.
+  #
+  # uri       - the uri to filter (String)
+  # parameter - hash of parameters to update
+  #
+  # Returns the full updated query string.
+  #
+  # @todo Optimize this method.
+  #
+  def query_update(uri, parameters)
+    query_string = self.query_get(uri)
+    rest = uri.dup.gsub(/\?#{query_string}/, "")
+
+    hash = self.query_string_to_hash(query_string)
+    hash.update(parameters)
+    query_string = self.hash_to_query_string(hash)
+
+    unless query_string.strip.empty?
+      return "#{rest}?#{query_string}"
+    else
+      return rest
+    end
+  end
+
+  alias_module_function :update_query_string, :query_update
+
+  #
+  # Gets the request uri, injects extra parameters in the query string
+  # and returns a new uri. The request object is not modified.
+  # There is always a qs string so an extra test is skipped.
+  #
+  # TODO: find a better name?
+  #
+  def update_request_uri(request, parameters)
+    hash = request.parameters.dup()
+    hash.update(parameters)
+
+    ## use this in hash_to_query
+    query_string = hash.collect { |k, v|
+      "#{k}=#{v}"
+    }.join(";")
+
+    ## return "#{request.translated_uri}?#{query_string}"
+    return "#{request.path}?#{query_string}"
+  end
+
+end

data/lib/standard/facets/yaml.rb

@@ -1,59 +1,6 @@
 require 'yaml'
 
-module Kernel
-
-  # The Kernel method #yaml is a shortcut to YAML::load.
-  #
-  #   data = yaml %{
-  #     a: 1
-  #     b: 2
-  #   }  
-  #   data #=> {"a"=>1, "b"=>2}
-  #
-  def yaml(*args,&blk)
-    YAML.load(*args,&blk)
-  end
-
-  # As with #to_yaml but removes the header line (i.e. '---') to create
-  # a "YAML fragment".
-  #
-  # CREDT: Thomas Sawyer
-  def to_yamlfrag
-    y = to_yaml
-    y.sub!(/---\ */, '')
-    y
-  end
-end
-
-class File
-  # File.yaml? provides a way to check if a file is a YAML
-  # formatted file:
-  #
-  #   File.yaml?('project.yaml')  #=> true
-  #   File.yaml?('project.xml')   #=> false
-  #
-  # Note this isn't perfect. At present it depends on the use
-  # use of an initial document separator (eg. '---'). With
-  # YAML 1.1 the %YAML delaration is supposed to be manditory,
-  # so in the future this can be adapted to fit that standard.
-  def self.yaml?(file)
-    File.open(file) do |f|
-      until f.eof?
-        line = f.gets
-        break true if line =~ /^---/
-        break false unless line =~ /^(\s*#.*?|\s*)$/
-      end
-    end
-  end
-end
-
-module YAML
-  # Shortcut for:
-  #
-  #   YAML.load(File.new(file))
-  #
-  def self.read(file)
-    load(File.new(file))
-  end
-end
+require 'facets/yaml/file'
+require 'facets/yaml/read'
+require 'facets/yaml/kernel'
 

data/lib/standard/facets/yaml/file.rb

@@ -0,0 +1,41 @@
+require 'yaml'
+
+module YAML
+
+  # Provides a simplistic way to check if a file is a YAML formatted
+  # file:
+  #
+  #   YAML.file?('project.yaml')  #=> true
+  #   YAML.file?('project.xml')   #=> false
+  #
+  # Note this isn't perfect. At present it depends on the use
+  # use of an initial document separator (eg. '---'). With
+  # YAML 1.1 the %YAML delaration is supposed to be manditory,
+  # so in the future this can be adapted to fit that standard.
+
+  def self.file?(file)
+    File.open(file) do |f|
+      until f.eof?
+        line = f.gets
+        break true if line =~ /^---/
+        break false unless line =~ /^(\s*#.*?|\s*)$/
+      end
+    end
+  end
+
+end
+
+
+class File
+
+  # Same as `YAML.file?(file)`.
+  #
+  #   File.yaml?('project.yaml')  #=> true
+  #   File.yaml?('project.xml')   #=> false
+  #
+  def self.yaml?(file)
+    YAML.file?(file)
+  end
+
+end
+

data/lib/standard/facets/yaml/kernel.rb

@@ -0,0 +1,29 @@
+require 'yaml'
+
+module Kernel
+
+  # The Kernel method #yaml is a shortcut to YAML::load.
+  #
+  #   data = yaml %{
+  #     a: 1
+  #     b: 2
+  #   }  
+  #   data #=> {"a"=>1, "b"=>2}
+  #
+  def yaml(*args,&blk)
+    YAML.load(*args,&blk)
+  end
+
+  # As with #to_yaml but removes the header line (i.e. '---') to create
+  # a "YAML fragment".
+  #
+  # @author Trans
+  #
+  def to_yamlfrag
+    y = to_yaml
+    y.sub!(/---\ */, '')
+    y
+  end
+
+end
+

data/lib/standard/facets/yaml/read.rb

@@ -0,0 +1,12 @@
+module YAML
+
+  # Alias for `YAML.load_file` and the same as:
+  #
+  #   YAML.load(File.new(file))
+  #
+  def self.read(file)
+    load(File.new(file))
+  end
+
+end
+