search_party 0.4.1

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+pkg
+rdoc
+test/*.db

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Steve Richert
+
+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,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
+
+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
+
+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
+
+* <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

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |g|
+    g.name = 'search_party'
+    g.summary = %(Parse your query parameters into more meaningful values)
+    g.description = %(Parse your query parameters into more meaningful values)
+    g.email = 'steve@laserlemon.com'
+    g.homepage = 'http://github.com/laserlemon/search_party'
+    g.authors = %w(laserlemon)
+    g.rubyforge_project = 'laser-lemon'
+  end
+  Jeweler::RubyforgeTasks.new do |r|
+    r.doc_task = 'rdoc'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts 'Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com'
+end
+
+Rake::TestTask.new do |t|
+  t.libs = %w(test)
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task :default => :test
+
+Rake::RDocTask.new do |r|
+  version = File.exist?('VERSION') ? File.read('VERSION') : nil
+  r.rdoc_dir = 'rdoc'
+  r.title = ['search_party', version].compact.join(' ')
+  r.rdoc_files.include('README*')
+  r.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.4.1

data/init.rb

@@ -0,0 +1 @@
+require 'search_party'

data/lib/search_party.rb

@@ -0,0 +1,74 @@
+module LaserLemon
+  module SearchParty
+    module Request
+      def self.included(base)
+        base.cattr_accessor :search_parameter_models
+        base.search_parameter_models = {}
+
+        base.cattr_accessor :search_parameter_finders
+        base.search_parameter_finders = {}
+        base.search_parameter_finders.default = :find_by_id
+
+        base.cattr_accessor :search_parameter_patterns
+        base.search_parameter_patterns = []
+      end
+
+      def search_parameters
+        @search_parameters ||= parse_hash(query_parameters)
+      end
+
+      private
+        def parse_hash(hash)
+          hash.symbolize_keys.inject({}) do |new_hash, (key, value)|
+            parsed_value = case value
+              when Hash then parse_hash(value)
+              when Array then value.map{|v| 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
+            finder = self.class.search_parameter_finders[key]
+            new_values = [*parsed_value].map{|v| model.send(finder, v) }
+            parsed_value.is_a?(Array) ? new_values.dup : new_values.first
+            else
+              parsed_value
+            end
+            new_hash.update(key => new_value)
+          end.with_indifferent_access
+        end
+
+        def parse_value(value)
+          if p = self.class.search_parameter_patterns.detect{|r,v| r.match(value) }
+            (v = p.last).respond_to?(:call) ? v.call($~) : v
+          else
+            value
+          end
+        end
+    end
+
+    module Controller
+      def self.included(base)
+        base.attr_internal :search_params
+
+        base.class_eval do
+          alias_method_chain :assign_shortcuts, :search_party
+        end
+      end
+
+      def assign_shortcuts_with_search_party(request, response)
+        @_search_params = request.search_parameters
+        assign_shortcuts_without_search_party(request, response)
+      end
+    end
+
+    module View
+      def self.included(base)
+        base.delegate :search_params, :to => :controller
+      end
+    end
+  end
+end
+
+ActionController::Request.send(:include, LaserLemon::SearchParty::Request)
+ActionController::Base.send(:include, LaserLemon::SearchParty::Controller)
+ActionView::Base.send(:include, LaserLemon::SearchParty::View)

data/search_party.gemspec

@@ -0,0 +1,51 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{search_party}
+  s.version = "0.4.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["laserlemon"]
+  s.date = %q{2009-10-07}
+  s.description = %q{Parse your query parameters into more meaningful values}
+  s.email = %q{steve@laserlemon.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "lib/search_party.rb",
+     "search_party.gemspec",
+     "test/search_party_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/laserlemon/search_party}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{laser-lemon}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Parse your query parameters into more meaningful values}
+  s.test_files = [
+    "test/search_party_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/test/search_party_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class SearchPartyTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: search_party
+version: !ruby/object:Gem::Version 
+  version: 0.4.1
+platform: ruby
+authors: 
+- laserlemon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-07 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Parse your query parameters into more meaningful values
+email: steve@laserlemon.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- lib/search_party.rb
+- search_party.gemspec
+- test/search_party_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/laserlemon/search_party
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: laser-lemon
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Parse your query parameters into more meaningful values
+test_files: 
+- test/search_party_test.rb
+- test/test_helper.rb