Changeset 4425

Timestamp:

06/03/06 22:15:06 (2 years ago)

Author:

david

Message:

Added simple hash conditions to find that'll just convert hash to an AND-based condition string (closes #5143) [hcatlin@gmail.com]

Files:

• trunk/activerecord/CHANGELOG (modified) (1 diff)
• trunk/activerecord/lib/active_record/base.rb (modified) (4 diffs)
• trunk/activerecord/test/finder_test.rb (modified) (1 diff)

trunk/activerecord/CHANGELOG

@@ -1 +1 @@
-*SVN*
+
+* Added simple hash conditions to find that'll just convert hash to an AND-based condition string #5143 [hcatlin@gmail.com]. Example:
+
+    Person.find(:all, :conditions => { :last_name => "Catlin", :status => 1 }, :limit => 2) 
+
+...is the same as:
+
+    Person.find(:all, :conditions => [ "last_name = ? and status = ?", "Catlin", 1 ], :limit => 2)
+  
+  This makes it easier to pass in the options from a form or otherwise outside.
+    
-
-* Fixed issues with BLOB limits, charsets, and booleans for Firebird #5194, #5191, #5189 [kennethkunz@gmail.com]

trunk/activerecord/lib/active_record/base.rb

@@ -82 +82 @@
-  # == Conditions
-  #
- or an array
+, array, or hash
-  # The array form is to be used when the condition input is tainted and requires sanitization. The string form can
-
+
+
-  #
-  #   class User < ActiveRecord::Base
@@ -94 +95 @@
-  #       find(:first, :conditions => [ "user_name = ? AND password = ?", user_name, password ])
-  #     end
+  #
+  #     def self.authenticate_safely_simply(user_name, password)
+  #       find(:first, :conditions => { :user_name => user_name, :password => password })
+  #     end
-  #   end
-  #
-  # The <tt>authenticate_unsafely</tt> method inserts the parameters directly into the query and is thus susceptible to SQL-injection
-method,
-on the other hand, will sanitize the <tt>user_name</tt> and +password+ before inserting them in the query, which will ensure that
-
+ and
+<tt>authenticate_safely_simply</tt> both will sanitize the <tt>user_name</tt> and +password+ before inserting them in the query, 
+which will ensure that 
-  #
-  # When using multiple parameters in the conditions, it can easily become hard to read exactly what the fourth or fifth
@@ -109 +114 @@
-  #     { :id => 3, :name => "37signals", :division => "First", :accounting_date => '2005-01-01' }
-  #   ])
+  #
+  # Similarly, a simple hash without a statement will generate conditions based on equality with the SQL AND
+  # operator. For instance:
+  #
+  #   Student.find(:all, :conditions => { :first_name => "Harvey", :status => 1 })
+  #   Student.find(:all, :conditions => params[:student])
+  #
-  #
-  # == Overwriting default accessors
@@ -1274 +1286 @@
-        end
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        # sanitized and interpolated into the sql statement.
-        #   ["name='%s' and group_id='%s'", "foo'bar", 4]  returns  "name='foo''bar' and group_id='4'"
-
-
-
+
-          statement, *values = ary
-          if values.first.is_a?(Hash) and statement =~ /:\w+/

trunk/activerecord/test/finder_test.rb

@@ -118 +118 @@
-  end
-
-
+array_
-    assert Topic.find(1, :conditions => ["approved = ?", false])
-    assert_raises(ActiveRecord::RecordNotFound) { Topic.find(1, :conditions => ["approved = ?", true]) }
-  end
-  
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-    assert_kind_of Firm, Company.find(:first, :conditions => ["name = '%s'", "37signals"])
-    assert_nil Company.find(:first, :conditions => ["name = '%s'", "37signals!"])
-    assert_nil Company.find(:first, :conditions => ["name = '%s'", "37signals!' OR 1=1"])
-    assert_kind_of Time, Topic.find(:first, :conditions => ["id = %d", 1]).written_on
+  end
+  
+  def test_condition_hash_interpolation
+    assert_kind_of Firm, Company.find(:first, :conditions => { :name => "37signals"})
+    assert_nil Company.find(:first, :conditions => { :name => "37signals!"})
+    assert_kind_of Time, Topic.find(:first, :conditions => {:id => 1}).written_on
+  end
+  
+  def test_hash_condition_find_malformed
+    assert_raises(ActiveRecord::StatementInvalid) {
+      Company.find(:first, :conditions => { :id => 2, :dhh => true })
+    }
+  end
+  
+  def test_hash_condition_find_with_escaped_characters
+    Company.create("name" => "Ain't noth'n like' \#stuff")
+    assert Company.find(:first, :conditions => { :name => "Ain't noth'n like' \#stuff"})
-  end
-