cw_condition_merge 1.0.0

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+	t.libs << 'test'
+end
+
+desc "Run Tests"
+task :default => :test

data/lib/cw_condition_merge.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/cw_condition_merge/cw_condition_merge.rb'

data/lib/cw_condition_merge/cw_condition_merge.rb

@@ -0,0 +1,67 @@
+module CW
+
+# Merge conditions
+#
+# This case has happened to me so frequently, I decided to write a function to perform this logic for me.
+#
+# Say you have an Active Record query you want to make. You normally want to find all the Widgets with customizations, but this time, you want to search for customizations that are pink:
+#
+# Widget.find(:all, :conditions => 'customized' )
+# Widget.find(:all, :conditions => ['color = ?', 'pink'] )
+#
+# But you want to combine them:
+# Widget.find(:all, :conditions => ['customized AND color = ?','pink'] )
+#
+# Looks simple if you're doing this all hard-coded style, but if you want more flexible models where you're using functions to generate your conditions and then chaining up conditions, as I often do, then you'll need something to combine or chain up those conditions
+#
+# Enter ConditionMerge. It handles the 3 big cases: You're merging into a set of missing conditions (no conditions or nil conditions), conditions specified only as a string, or conditions as an Array.
+class ConditionMerge
+
+	def self.and( src, with )
+		merge( src, with, 'AND' )
+	end
+	def self.or( src, with )
+		merge( src, with, 'OR' )
+	end
+	def self.and_not( src, with )
+		merge( src, with, 'AND NOT' )
+	end
+	def self.or_not( src, with )
+		merge( src, with, 'OR NOT' )
+	end
+
+	def self.merge( src, with, join_clause )
+		if src.nil?
+			return with
+		end
+		if with.nil?
+			return src
+		end
+
+		raise ArgumentError.new("src can be nil, or a String or an Array. It cannot be a #{src.class.name}") unless src.is_a?(Array) or src.is_a?(String)
+		raise ArgumentError.new("with can be nil, or a String or an Array. It cannot be a #{with.class.name}") unless with.is_a?(Array) or with.is_a?(String)
+		raise ArgumentError.new("join_clause must be a String, not an #{join_clause.class.name}") unless join_clause.is_a?(String)
+
+		if src.is_a?(String)
+			if src.strip.empty?
+				# coerse to array for conformity
+				if with.is_a?(String)
+					return [with]
+				else
+					return with
+				end
+			end
+			src = [src]
+		end
+		if with.is_a?(String)
+			return src if with.strip.empty?
+			with = [with]
+		end
+
+		src[0] = '(' + src[0] + ') ' + join_clause + ' (' + with[0] + ')'
+		src.concat( with[1..-1] ) if with.size > 1
+		src
+	end
+
+end # ConditionMerge
+end # CW

data/test/test_cw_condition_merge.rb

@@ -0,0 +1,47 @@
+require 'test/unit'
+require 'cw_condition_merge'
+
+class PaginationOrderTest < Test::Unit::TestCase
+	def setup
+	end
+	def teardown
+	end
+
+	def test_nil_src
+		assert_equal 'customized', CW::ConditionMerge.and( nil, 'customized' )
+	end
+	def test_nil_with
+		assert_equal 'customized', CW::ConditionMerge.and( 'customized', nil )
+	end
+
+	def test_and
+		assert_equal ['(customized) AND (color = ?)','pink'], CW::ConditionMerge.and( 'customized', ['color = ?','pink'] )
+	end
+	def test_or
+		assert_equal ['(customized) OR (color = ?)','pink'], CW::ConditionMerge.or( 'customized', ['color = ?','pink'] )
+	end
+	def test_and_not
+		assert_equal ['(customized) AND NOT (color = ?)','pink'], CW::ConditionMerge.and_not( 'customized', ['color = ?','pink'] )
+	end
+	def test_or_not
+		assert_equal ['(customized) OR NOT (color = ?)','pink'], CW::ConditionMerge.or_not( 'customized', ['color = ?','pink'] )
+	end
+
+	def test_empty_condition
+		assert_equal ['customized'], CW::ConditionMerge.and( 'customized', '' )
+		assert_equal ['customized'], CW::ConditionMerge.and( '', 'customized' )
+	end
+
+	def test_array_string
+		assert_equal ['(color = ?) AND (customized)','pink'], CW::ConditionMerge.and( ['color = ?','pink'], 'customized' )
+	end
+	def test_array_array
+		assert_equal ['(color = ?) AND (customized = ?)','pink','ye'], CW::ConditionMerge.and( ['color = ?','pink'], ['customized = ?','ye'] )
+	end
+
+	def test_bad_arguments
+		assert_raises( ArgumentError ) { CW::ConditionMerge.and( 3, 'customized' ) }
+		assert_raises( ArgumentError ) { CW::ConditionMerge.and( 'customized', 5 ) }
+		assert_raises( ArgumentError ) { CW::ConditionMerge.merge( ['color = ?','pink'], 'customized', ['clause'] ) }
+	end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: cw_condition_merge
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Christopher Wojno
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-17 00:00:00 Z
+dependencies: []
+
+description: Allows one to "merge" condition hashes used in active record in a safe and uniform manner. Originally designed for Rails 2.3.14
+email: cw_condition_merge.gem@wojnosystems.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gemtest
+- lib/cw_condition_merge/cw_condition_merge.rb
+- lib/cw_condition_merge.rb
+- Rakefile
+- test/test_cw_condition_merge.rb
+homepage: http://www.wojnosystems.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Combine ActiveRecord condition hashes
+test_files: []
+