condition_builder 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,7 @@
+*.sw?
+*~
+.DS_Store
+coverage
+nbproject
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Peter Hoeg
+
+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,36 @@
+= condition_builder
+
+ConditionBuilder generates conditions and criteria for use in ActiveRecord .find
+statements to avoid manually having to construct a string of conditions and
+the releveant hash with values.
+
+It does not support fancy dependencies between the statements as it would make
+the syntax so complicated that people might as well generate the condition
+string and hash themselves.
+
+= Usage
+
+ cb = ConditionBuilder.new
+ # add a condition "user_id < 4" in descending order
+ cb.add('user_id <', 4, :desc)
+ # add a condition "user_location like '%abc'" in ascending order
+ cb.add('user_location like', '%abc', :asc)
+ # add a condition "department_id = 18"
+ cb.add('department_id = ', 18)
+ 
+ User.find(:all, :conditions => cb.conditions, :order => cb.order, cb.criteria)
+
+= Website
+
+http://github.com/peterhoeg/condition_builder
+
+= Requirements
+
+ConditionBuilder has been tested with the following versions
+
+== Ruby
+* 1.8.7
+
+== Copyright
+
+Copyright (c) 2009 Peter Hoeg. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "condition_builder"
+    gem.summary = "This gem assists in creating conditions and criteria for use in ActiveRecord .find statements."
+    gem.email = "peter@hoeg.com"
+    gem.homepage = "http://github.com/peterhoeg/condition_builder"
+    gem.authors = ["Peter Hoeg", "Northwind Technologies Pte Ltd"]
+    gem.rubyforge_project = "cbuilder"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+  Jeweler::RubyforgeTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "condition_builder #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

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

data/condition_builder.gemspec

@@ -0,0 +1,48 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{condition_builder}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Peter Hoeg", "Northwind Technologies Pte Ltd"]
+  s.date = %q{2009-07-10}
+  s.email = %q{peter@hoeg.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "condition_builder.gemspec",
+     "lib/condition_builder.rb",
+     "spec/condition_builder_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/peterhoeg/condition_builder}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{cbuilder}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{This gem assists in creating conditions and criteria for use in ActiveRecord .find statements.}
+  s.test_files = [
+    "spec/condition_builder_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/condition_builder.rb

@@ -0,0 +1,91 @@
+require 'json'
+
+class ConditionBuilder
+  
+  DEFAULT_KIND = :and
+  SUPPORTED_KINDS = [ :and, :or, :xor, :not ]
+
+  def initialize(kind = DEFAULT_KIND)
+    super()
+    set_kind(kind)
+    @_cond = []
+    @_crit = {}
+    @_join = []
+    @_ordr = []
+  end
+
+  # TODO: add << as an alias for add - probably need to do some splatting to handle the parms
+  # alias_method :'<<', :add
+  # See README for usage.
+  def add(condition, criteria, order = nil)
+    crit_name = condition[/^(\w|\.)+/].gsub(/\s/, '_').to_s
+    crit_sym = crit_name.to_sym
+    raise ArgumentError, 'condition already exists' if @_crit.has_key?(crit_sym)
+    if criteria.is_a?(Array)
+      @_cond << "#{condition} (:#{crit_name})"
+    else
+      @_cond << "#{condition} :#{crit_name}"
+    end
+    @_crit[crit_sym] = criteria
+    @_ordr << "#{crit_name} #{order.to_s.upcase}" if [ :asc, :desc ].include?(order)
+  end
+
+  # Add tables and fields for a simple INNER JOIN
+  def add_join(left_table, left_field, right_table, right_field)
+    # TODO: move the joins into a proper structure and only generate when it gets accessed
+    @_join << "INNER JOIN #{right_table} ON #{left_table}.#{left_field} = #{right_table}.#{right_field}"
+  end
+
+  # Returns the condition string used for the :conditions parameter. See README for usage.
+  def conditions
+    @_cond.join(@join)
+  end
+
+  # Returns the criteria hash. See README for usage.
+  def criteria
+    @_crit
+  end
+
+  # Returns the join string used for the :joins parameter. See README for usage.
+  def joins
+    @_join.join(' ')
+  end
+
+  # Returns the order string used for the :order parameter. See README for usage.
+  def order
+    @_ordr.join(', ')
+  end
+
+  # Returns the number of valid statements
+  def statements
+    return valid? ? @_cond.length : 0
+  end
+
+  # Returns a string representation - normally used for debugging
+  def to_s
+    "conditions: #{@_cond.to_json}, criteria: #{@_crit.to_json}, ordering: #{@_ordr.to_json}"
+  end
+
+  # Returns true if it will generate usable output
+  def valid?
+    @_cond.length > 0 && (@_cond.length == @_crit.length)
+  end
+
+  # Gets the kind of condition
+  def kind
+    @kind
+  end
+
+  # Sets the kind of condition
+  def kind=(value)
+    set_kind(value)
+  end
+
+  private
+  def set_kind(kind)
+    @kind = SUPPORTED_KINDS.include?(kind) ? kind : DEFAULT_KIND
+    @join = " #{@kind.to_s.upcase} "
+    return nil
+  end
+  
+end

data/spec/condition_builder_spec.rb

@@ -0,0 +1,269 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe ConditionBuilder do
+
+  before(:each) do
+    @cb = ConditionBuilder.new
+  end
+  
+  it 'should not be valid without contents' do
+    @cb.should_not be_valid
+  end
+
+  it 'should have no statements' do
+    @cb.statements.should == 0
+  end
+
+  it 'should default kind to :and' do
+    @cb.kind.should == :and
+  end
+
+  it 'should have default kind as part of list of supported kinds - NOTE: is this too internal to test??' do
+    ConditionBuilder::SUPPORTED_KINDS.include?(ConditionBuilder::DEFAULT_KIND).should be_true
+  end
+
+  it 'should support :and, :or, :xor and :not' do
+    [ :and, :or, :xor, :not ].each do |kind|
+      @cb.kind = kind
+      @cb.kind.should == kind
+    end
+  end
+
+  it 'should revert to :and if given invalid input' do
+    @cb.kind = :xxx
+    @cb.kind.should == :and
+  end
+
+  it 'should give a basic response to .to_s' do
+    @cb.to_s.length.should_not == 0
+  end
+
+  describe 'single condition/criterion' do
+
+    before(:each) do
+      @cb.add('something =', 'fff')
+    end
+
+    it 'should be valid' do
+      @cb.should be_valid
+    end
+
+    it 'should have just one condition and criterion' do
+      @cb.statements.should == 1
+    end
+
+    it 'should generate a condition' do
+      @cb.conditions.should == 'something = :something'
+    end
+
+    it 'should generate a criterion' do
+      @cb.criteria[:something].should == 'fff'
+    end
+
+    it 'should not generate an ordering' do
+      @cb.order.length.should == 0
+    end
+  end
+
+  describe 'single condition/criterion with ordering' do
+
+    before(:each) do
+      @cb.add('something =', 'fff', :asc)
+    end
+
+    it 'should be valid' do
+      @cb.should be_valid
+    end
+
+    it 'should have just one condition and criterion' do
+      @cb.statements.should == 1
+    end
+
+    it 'should generate a condition' do
+      @cb.conditions.should == 'something = :something'
+    end
+
+    it 'should generate a criterion' do
+      @cb.criteria[:something].should == 'fff'
+    end
+
+    it 'should generate an ordering' do
+      @cb.order.should == 'something ASC'
+    end
+  end
+
+  describe 'being passed an array' do
+
+    before(:each) do
+      @cb.add('something in', [ 1, 2, 3 ])
+    end
+
+    it 'should be valid' do
+      @cb.should be_valid
+    end
+
+    it 'should have just one condition and criterion' do
+      @cb.statements.should == 1
+    end
+
+    it 'should generate a condition' do
+      @cb.conditions.should == 'something in (:something)'
+    end
+
+    it 'should generate a criterion' do
+      @cb.criteria[:something].should == [1, 2, 3]
+    end
+
+  end
+
+  describe 'multiple conditions/criteria' do
+
+    before(:each) do
+      @cb.add('something =', 'fff')
+      @cb.add('something_else >', 123)
+    end
+
+    it 'should be valid' do
+      @cb.should be_valid
+    end
+
+    it 'should have two conditions and criteria' do
+      @cb.statements.should == 2
+    end
+
+    it 'should generate conditions' do
+      @cb.conditions.should == 'something = :something AND something_else > :something_else'
+    end
+
+    it 'should generate criteria' do
+      @cb.criteria[:something].should == 'fff'
+      @cb.criteria[:something_else].should == 123
+    end
+
+    describe 'experiencing duplicate conditions' do
+
+      it 'should raise exception on duplicate conditions' do
+        lambda {
+          @cb.add('something =', 'ggg')
+        }.should raise_error(ArgumentError)
+        @cb.statements.should == 2
+      end
+    end
+
+    describe 'as type :or' do
+
+      before(:each) do
+        @cb.kind = :or
+      end
+
+      it 'should generate conditions' do
+        @cb.conditions.should == 'something = :something OR something_else > :something_else'
+      end
+
+      it 'should generate criteria' do
+        @cb.criteria[:something].should == 'fff'
+        @cb.criteria[:something_else].should == 123
+      end
+    end
+
+    describe 'as type :xor' do
+
+      before(:each) do
+        @cb.kind = :xor
+      end
+
+      it 'should generate conditions' do
+        @cb.conditions.should == 'something = :something XOR something_else > :something_else'
+      end
+
+      it 'should generate criteria' do
+        @cb.criteria[:something].should == 'fff'
+        @cb.criteria[:something_else].should == 123
+      end
+    end
+
+    describe 'as type :not' do
+
+      before(:each) do
+        @cb.kind = :not
+      end
+
+      it 'should generate conditions' do
+        @cb.conditions.should == 'something = :something NOT something_else > :something_else'
+      end
+
+      it 'should generate criteria' do
+        @cb.criteria[:something].should == 'fff'
+        @cb.criteria[:something_else].should == 123
+      end
+    end
+  end
+
+  describe 'multiple conditions/criteria with ordering' do
+
+    before(:each) do
+      @cb.add('something =', 'fff', :asc)
+      @cb.add('something_else >', 123, :desc)
+    end
+
+    it 'should be valid' do
+      @cb.should be_valid
+    end
+
+    it 'should have two conditions and criteria' do
+      @cb.statements.should == 2
+    end
+
+    it 'should generate conditions' do
+      @cb.conditions.should == 'something = :something AND something_else > :something_else'
+    end
+
+    it 'should generate criteria' do
+      @cb.criteria[:something].should == 'fff'
+      @cb.criteria[:something_else].should == 123
+    end
+
+    it 'should generate an ordering' do
+      @cb.order.should == 'something ASC, something_else DESC'
+    end
+  end
+
+  describe 'with table names' do
+
+    before(:each) do
+      @cb.add('some.thing =', 'fff')
+      @cb.add('some.thing._else >', 123)
+    end
+
+    it 'should be valid' do
+      @cb.should be_valid
+    end
+
+    it 'should have two conditions and criteria' do
+      @cb.statements.should == 2
+    end
+
+    it 'should generate conditions' do
+      @cb.conditions.should == 'some.thing = :some.thing AND some.thing._else > :some.thing._else'
+    end
+
+    it 'should generate criteria' do
+      @cb.criteria[:'some.thing'].should == 'fff'
+      @cb.criteria[:'some.thing._else'].should == 123
+    end
+  end
+
+  describe 'joins' do
+
+    it 'a single join' do
+      @cb.add_join('table_a', 'field_a', 'table_b', 'field_b')
+      @cb.joins.should == 'INNER JOIN table_b ON table_a.field_a = table_b.field_b'
+    end
+
+    it 'multiple joins' do
+      @cb.add_join('table_a', 'field_a', 'table_b', 'field_b')
+      @cb.add_join('table_X', 'field_X', 'table_Y', 'field_Y')
+      @cb.joins.should == 'INNER JOIN table_b ON table_a.field_a = table_b.field_b INNER JOIN table_Y ON table_X.field_X = table_Y.field_Y'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'condition_builder'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: condition_builder
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Peter Hoeg
+- Northwind Technologies Pte Ltd
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-10 00:00:00 +08:00
+default_executable: 
+dependencies: []
+
+description: 
+email: peter@hoeg.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- condition_builder.gemspec
+- lib/condition_builder.rb
+- spec/condition_builder_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/peterhoeg/condition_builder
+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: cbuilder
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: This gem assists in creating conditions and criteria for use in ActiveRecord .find statements.
+test_files: 
+- spec/condition_builder_spec.rb
+- spec/spec_helper.rb