querystring 0.1.0

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.2@querystring

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Bob Corsaro
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,161 @@
+= querystring
+
+A small and flexible library to parse and create HTTP query strings.
+
+Many languages, libraries and application use different styles of query
+strings.  Specifically, query arrays seem to take on many different forms
+accross the web.  Some APIs use multiple name/value pairs with the same name to
+represent arrays.  Others use the '[]' notation, and some even include an index
+in the brackets.  Other APIs use a comma seperated list of values, with only
+one name parameter.  querystring is meant to be flexible enough to create and
+parse in any style.
+
+== Usage
+
+QueryString provides stringify and parse methods.  Both methods take an optional
+hash as a second parameter defining the behavior of the function.
+
+=== Stringify
+
+Default stringify options::
+  {
+    :seperator => '&',             # between params
+    :equals => '=',                # between key/value pairs
+    :array_style => :seperate,     # or :combine
+    :array_brackets => false,      # use [] with array_style :seperate
+    :array_index => false,         # use indexes with array style :seperate
+    :array_seperator => ','        # used with :combine array style
+  }
+
+The array_ options need some explaining.  For style, :seperated means that each
+element in the array will get it's own name/value pair.  Combined means that
+they will be combined into one name/value pair.
+
+For seperate style, brackets is used to determine if '[]' should be appended to
+each name/value pair.  If index is specified, then the index number will be put
+inside the brackets, or appended to the name if brackets is false.
+
+For combined style, we have the seperator option.  seperator is used to determine
+how they will be combined.
+
+=== Parse
+
+Parse always parses into arrays for simplicities sake.  Every value is an array.
+
+== Examples
+
+  >> ########################
+  >> # stringify
+  >> ########################
+  >>
+  >> require 'querystring'
+  >>
+  >> obj = {
+    :name => 'bob',
+    :roles => [
+      'maintainer',
+      'contributor'
+    ],
+    :homepage => 'http://www.google.com/profiles/rcorsaro'
+  }
+  >>
+  >> puts QueryString.stringify(obj)
+  name=bob&roles=maintainer&roles=contributor&homepage=http%3a%2f%2fwww.google.com%2fprofiles%2frcorsaro
+  >>
+  >> puts QueryString.stringify(obj, {:seperator => '*'})
+  name=bob*roles=maintainer*roles=contributor*homepage=http%3a%2f%2fwww.google.com%2fprofiles%2frcorsaro
+  >>
+  >> puts QueryString.stringify(obj, {:array_brackets => true})
+  name=bob&roles[]=maintainer&roles[]=contributor&homepage=http%3a%2f%2fwww.google.com%2fprofiles%2frcorsaro
+  >>
+  >> puts QueryString.stringify(obj, {:array_brackets => true, :array_index => true})
+  name=bob&roles[0]=maintainer&roles[1]=contributor&homepage=http%3a%2f%2fwww.google.com%2fprofiles%2frcorsaro
+  >>
+  >> puts QueryString.stringify(obj, {:array_index => true})
+  name=bob&roles0=maintainer&roles1=contributor&homepage=http%3a%2f%2fwww.google.com%2fprofiles%2frcorsaro
+  >>
+  >> puts QueryString.stringify(obj, {:array_style => :combined})
+  name=bob&roles=maintainer,contributor&homepage=http%3a%2f%2fwww.google.com%2fprofiles%2frcorsaro
+  >>
+  >> # Be careful with this because we do no check to make sure your seperator is sane.
+  >> # '+' would usually be a bad choice since values can potentially have a space in
+  >> # them, which is converted to '+' when encoded.  But you know what you doing, so
+  >> # we let you go about your work.
+  >> puts QueryString.stringify(obj, {:array_style => :combined, :array_seperator => '!'})
+  name=bob&roles=maintainer!contributor
+  >>
+  >> ########################
+  >> # stringify
+  >> ########################
+  >>
+  >> require 'ap'
+  >>
+  >> ap QueryString.parse('name=bob&roles=maintainer&roles=contributor&homepage=http%3a%2f%2fwww.google.com%2fprofiles%2frcorsaro')
+  {
+      "name" => [
+          [0] "bob",
+      ],
+      "roles => [
+          [0] "maintainer",
+          [1] "contributor"
+      ],
+      "homepage" => [
+          [0] "http://www.google.com/profiles/rcorsaro"
+  }
+  >> ap QueryString.parse('name=bob*roles=maintainer*roles=contributor*homepage=http%3a%2f%2fwww.google.com%2fprofiles%2frcorsaro', :seperator => '*')
+  {
+      "name" => [
+          [0] "bob",
+      ],
+      "roles => [
+          [0] "maintainer",
+          [1] "contributor"
+      ],
+      "homepage" => [
+          [0] "http://www.google.com/profiles/rcorsaro"
+  }
+  >> ap QueryString.parse('name=bob&roles[]=maintainer&roles[]=contributor&homepage=http%3a%2f%2fwww.google.com%2fprofiles%2frcorsaro')
+  {
+      "name" => [
+          [0] "bob",
+      ],
+      "roles => [
+          [0] "maintainer",
+          [1] "contributor"
+      ],
+      "homepage" => [
+          [0] "http://www.google.com/profiles/rcorsaro"
+  }
+  >> ap QueryString.parse('name=bob&roles[0]=maintainer&roles[1]=contributor&homepage=http%3a%2f%2fwww.google.com%2fprofiles%2frcorsaro')
+  {
+      "name" => [
+          [0] "bob",
+      ],
+      "roles => [
+          [0] "maintainer",
+          [1] "contributor"
+      ],
+      "homepage" => [
+          [0] "http://www.google.com/profiles/rcorsaro"
+  }
+
+
+
+
+
+
+== Contributing to querystring
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Bob Corsaro. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "querystring"
+  gem.homepage = "http://github.com/dokipen/ruby-querystring"
+  gem.license = "MIT"
+  gem.summary = %Q{Final solution for HTTP querystrings}
+  gem.description = %Q{Flexible querystring generator}
+  gem.email = "bob@embed.ly"
+  gem.authors = ["Bob Corsaro"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "querystring #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/querystring.rb

@@ -0,0 +1,67 @@
+require 'cgi'
+
+module QueryString
+  VERSION = File.read(File.expand_path('../../VERSION', __FILE__)).strip
+
+  def self.stringify obj, options={}
+    o = {
+      :seperator => '&',             # between params
+      :equals => '=',                # between key/value pairs
+      :array_style => :seperate,     # or :combine
+      :array_brackets => false,      # use [] with array_style :seperate
+      :array_index => false,         # use indexes with array style :seperate
+      :array_seperator => ','        # used with :combine array style
+    }.merge(options)
+
+    # used for seperate style arrays
+    ar_tmpl = "%s#{'[' if o[:array_brackets]}%s#{']' if o[:array_brackets]}#{o[:equals]}%s"
+
+    obj.map do |key,value|
+      key = CGI.escape(key.to_s)
+
+      if value.is_a?Array
+        case o[:array_style]
+        when :combine
+          list = value.map do |inner_value|
+            CGI.escape(inner_value.to_s)
+          end.join o[:array_seperator]
+          "#{key}#{o[:equals]}#{list}"
+        else  # when :seperate
+          value.each_with_index.map do |inner_value, index|
+            index = o[:array_index] ? index.to_s : ''
+            inner_value = CGI.escape(inner_value.to_s)
+
+            ar_tmpl%[key, index, inner_value]
+          end.join o[:seperator]
+        end
+      else
+        value = CGI.escape(value.to_s)
+
+        "#{key}#{o[:equals]}#{value}"
+      end
+    end.join o[:seperator]
+  end
+
+  def self.parse q, options={}
+    o = {
+      :seperator => /&|;/,           # between params
+      :equals => '=',                # between key/value pairs
+      :array_seperator => ','        # used with :combine array style
+    }.merge(options)
+
+    q.split(o[:seperator]).inject({}) do |ret, pair|
+      key, value = pair.split(o[:equals])
+      value.split(o[:array_seperator]).inject(ret) do |ret, part|
+        key =~ /([^\[]+)(\[(\d)?\])?/
+        ret[$1] ||= []
+        if $3
+          ret[$1][$3.to_i] = CGI.unescape(part)
+        else
+          ret[$1] << CGI.unescape(part)
+        end
+        ret
+      end
+    end
+  end
+end
+

data/test/test_parse.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+$:.unshift(File.expand_path('../../lib', __FILE__))
+%w{querystring test/unit}.each{|i| require i}
+
+class QueryStringTest < Test::Unit::TestCase
+  include QueryString
+
+  # shorthand parse
+  def p *a
+    QueryString.parse *a
+  end
+
+  def test_parse
+    # testing object
+    expected = {
+      "a" => ["1"],
+      "b" => ["2","3","4",'http://www.google.com/hello?far=near&war=peace']
+    }
+
+    queries = [
+      p('a=1&b[0]=2&b[1]=3&b[2]=4&b[3]=http%3A%2F%2Fwww.google.com%2Fhello%3Ffar%3Dnear%26war%3Dpeace'),
+      # p('a=1&b0=2&b1=3&b2=4&b3=http%3A%2F%2Fwww.google.com%2Fhello%3Ffar%3Dnear%26war%3Dpeace'), fuck this
+      p('a=1&b[]=2&b[]=3&b[]=4&b[]=http%3A%2F%2Fwww.google.com%2Fhello%3Ffar%3Dnear%26war%3Dpeace'),
+      p('a=1&b=2&b=3&b=4&b=http%3A%2F%2Fwww.google.com%2Fhello%3Ffar%3Dnear%26war%3Dpeace'),
+      p('a=1|b=2|b=3|b=4|b=http%3A%2F%2Fwww.google.com%2Fhello%3Ffar%3Dnear%26war%3Dpeace', {:seperator => '|'}),
+      p('a~1&b~2&b~3&b~4&b~http%3A%2F%2Fwww.google.com%2Fhello%3Ffar%3Dnear%26war%3Dpeace', {:equals => '~'}),
+      p('a=1&b=2,3,4,http%3A%2F%2Fwww.google.com%2Fhello%3Ffar%3Dnear%26war%3Dpeace'),
+      p('a=1&b=2|3|4|http%3A%2F%2Fwww.google.com%2Fhello%3Ffar%3Dnear%26war%3Dpeace', {:array_seperator => '|'})
+    ]
+
+    queries.each do |i|
+      assert_equal(expected,i)
+    end
+  end
+end
+

data/test/test_stringify.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+$:.unshift(File.expand_path('../../lib', __FILE__))
+%w{querystring test/unit}.each{|i| require i}
+
+class QueryStringTest < Test::Unit::TestCase
+  include QueryString
+
+  # shorthand stringify
+  def s *a
+    QueryString.stringify *a
+  end
+
+  def test_stringify
+    # testing object
+    o = { 
+      :a => 1,
+      :b => [2,3,4,'http://www.google.com/hello?far=near&war=peace']
+    }
+
+    queries = {
+      s(o, :array_brackets => true, :array_index => true) => 
+        'a=1&b[0]=2&b[1]=3&b[2]=4&b[3]=http%3A%2F%2Fwww.google.com%2Fhello%3Ffar%3Dnear%26war%3Dpeace',
+      s(o, :array_brackets => false, :array_index => true) =>
+        'a=1&b0=2&b1=3&b2=4&b3=http%3A%2F%2Fwww.google.com%2Fhello%3Ffar%3Dnear%26war%3Dpeace',
+      s(o, :array_brackets => true, :array_index => false) =>
+        'a=1&b[]=2&b[]=3&b[]=4&b[]=http%3A%2F%2Fwww.google.com%2Fhello%3Ffar%3Dnear%26war%3Dpeace',
+      s(o) =>
+        'a=1&b=2&b=3&b=4&b=http%3A%2F%2Fwww.google.com%2Fhello%3Ffar%3Dnear%26war%3Dpeace',
+      s(o, :seperator => '|') =>
+        'a=1|b=2|b=3|b=4|b=http%3A%2F%2Fwww.google.com%2Fhello%3Ffar%3Dnear%26war%3Dpeace',
+      s(o, :equals => '~') =>
+        'a~1&b~2&b~3&b~4&b~http%3A%2F%2Fwww.google.com%2Fhello%3Ffar%3Dnear%26war%3Dpeace',
+      s(o, :array_style => :combine) =>
+        'a=1&b=2,3,4,http%3A%2F%2Fwww.google.com%2Fhello%3Ffar%3Dnear%26war%3Dpeace',
+      s(o, :array_style => :combine, :array_seperator => '.') =>
+        'a=1&b=2.3.4.http%3A%2F%2Fwww.google.com%2Fhello%3Ffar%3Dnear%26war%3Dpeace'
+    }
+
+    queries.each do |k,v|
+      assert_equal(v,k)
+    end
+  end
+
+  def test_version
+    assert_not_nil(QueryString::VERSION)
+  end
+end
+

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: querystring
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Bob Corsaro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-03-27 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &67906090 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *67906090
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &67903430 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *67903430
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &67902200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *67902200
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &67873920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *67873920
+description: Flexible querystring generator
+email: bob@embed.ly
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/querystring.rb
+- test/test_parse.rb
+- test/test_stringify.rb
+has_rdoc: true
+homepage: http://github.com/dokipen/ruby-querystring
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -47907889
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Final solution for HTTP querystrings
+test_files:
+- test/test_parse.rb
+- test/test_stringify.rb