laserlemon-search_party 0.3.3 → 0.4.0

data/README.rdoc

@@ -1,13 +1,75 @@
 = search_party
 
+Rails params that actually _mean_ something!
+
+<tt>search_party</tt> parses a Rails request's GET variables according to your own rules. This allows you to:
+
+* Keep your controllers skinny,
+* Remove models' ID numbers from your URLs,
+* Prepare your query parameters for better use in <tt>searchlogic</tt>[http://github.com/binarylogic/searchlogic] by binarylogic[http://github.com/binarylogic].
+
 == Installation
 
-  script/plugin install git://github.com/laserlemon/search_party.git
+In <tt>environment.rb</tt>:
+
+  Rails::Initializer.run do |config|
+    config.gem 'laserlemon-search_party', :lib => 'search_party', :source => 'http://gems.github.com'
+  end
+
+At your application root, run:
+
+  $ sudo rake gems:install
+
+All the parameter parsing is application-defined, so you'll also need an initializer. <tt>search_party</tt> adds three class variables to <tt>ActionController::Request</tt>:
+
+* <tt>search_parameter_models</tt>
+* <tt>search_parameter_finders</tt>
+* <tt>search_parameter_patterns</tt>
+
+An example <tt>search_party</tt> initializer:
+
+  ActionController::Request.search_parameter_models = {
+    :user => 'User',
+    :friend => 'User',
+    :home_state => 'State'
+  }
+  
+  ActionController::Request.search_parameter_finders = {
+    :user => :find_by_login,
+    :friend => :find_by_login,
+    :home_state => :find_by_abbreviation
+  }
+  
+  ActionController::Request.search_parameter_patterns = [
+    [/^\d+$/,                   lambda{|m| m.to_s.to_i }],
+    [/^\d+\.\d+$/,              lambda{|m| m.to_s.to_f }],
+    [/^(?:true|t|yes|y|on)$/i,  true],
+    [/^(?:false|f|no|n|off)$/i, false],
+    [/^\s+$/,                   nil]
+  ]
 
 == Example
 
-Coming soon...
+With <tt>search_party</tt>, a <tt>search_params</tt> hash is added to the controller instance in addition to the normal (and boring) <tt>params</tt>. The new <tt>search_params</tt> are available in the view as well, just like <tt>params</tt>, and are also accessible in the <tt>Request</tt> object via <tt>search_parameters</tt>. The <tt>search_params</tt> are simply the query parameters from a given request, run through the initializer configuration to silently make more sense out of what's being really being asked for.
+
+For instance, the following <tt>params</tt>:
+
+  {"friend" => "laserlemon", "home_state" => "WA"}
+
+would product the following <tt>search_params</tt>:
+
+  {"friend" => #<User id: 1, first_name: "Steve", last_name: "Richert", login: "laserlemon">, "home_state" => #<State id: 48, name: "Washington", abbreviation: "WA">}
+
+using User.find_by_login and State.find_by_abbreviation. With the <tt>search_parameter_patterns</tt> variable, non-model query parameters are also cleaned up:
+
+  {"price" => "12.50", "negotiable" => "no"}
+
+produces:
+
+  {"price" => 12.5, "negotiable" => false}
 
 == Tips
 
-Coming soon...
+* <tt>search_parameter_patterns</tt> are evaluated in the order they're defined.
+* Lambdas may be used as the value corresponding to a pattern, with the MatchData object being passed as a single argument.
+* <tt>search_party</tt> will parse the query parameters recursively in the case of multidimensional parameters.

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('search_party', '0.3.3') do |g|
+Echoe.new('search_party', '0.4.0') do |g|
   g.description = %(Parse your query parameters into more meaningful values)
   g.url = 'http://github.com/laserlemon/search_party'
   g.author = 'Steve Richert'

data/VERSION.yml

@@ -1,4 +1,4 @@
 ---
 :major: 0
-:minor: 3
-:patch: 3
+:minor: 4
+:patch: 0

data/lib/search_party.rb

@@ -24,7 +24,7 @@ module LaserLemon
           parsed_value = case value
           when Hash then parse_hash(value)
           when Array then value.map{|v| parse_value(v) }
-          else parse_value(v)
+          else parse_value(value)
           end
           new_value = if model_name = self.class.search_parameter_models[key]
             model = model_name.to_s.classify.constantize

data/search_party.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{search_party}
-  s.version = "0.3.3"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Steve Richert"]
-  s.date = %q{2009-07-30}
+  s.date = %q{2009-07-31}
   s.description = %q{Parse your query parameters into more meaningful values}
   s.email = %q{steve@laserlemon.com}
   s.extra_rdoc_files = ["lib/search_party.rb", "README.rdoc"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: laserlemon-search_party
 version: !ruby/object:Gem::Version 
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors: 
 - Steve Richert
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-30 00:00:00 -07:00
+date: 2009-07-31 00:00:00 -07:00
 default_executable: 
 dependencies: []