conditioner 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2010-02-22
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,13 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/conditioner.rb
+lib/conditioner/active_record_mixin.rb
+lib/conditioner/condition.rb
+script/console
+script/destroy
+script/generate
+test/test_conditioner.rb
+test/test_helper.rb

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on conditioner, see http://conditioner.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,80 @@
+= conditioner
+
+* http://github.com/niquola/conditioner
+
+== DESCRIPTION:
+
+ Simple conditions builder for active_resource
+
+== SYNOPSIS:
+
+  def test_conditioner_creation
+    cnd = User.conditioner
+    assert_not_nil(cnd)
+    params={:name=>'nicola',:email=>'nicola@mail.com'}
+    cnd = User.conditioner(params)
+    assert_not_nil(cnd)
+  end
+
+  def test_extraction
+    cnd=User.conditioner(:updated_at=>'2009-01-01', :email=>'nicola@mail.com',:unexisting=>'value')
+    assert_match(/"users"."email"\s*=\s*E'nicola@mail.com'/, cnd)
+    assert_match(/users.updated_at BETWEEN E'2009-01-01 00:00' AND E'2009-01-01 23:59:59.999'/, cnd)
+    assert_no_match(/unexisting/, cnd)
+  end
+
+  def test_extract_from_and_to_prefixed_date_fields
+    cnd = User.conditioner :to_updated_at =>'2010-02-02', :from_updated_at=>'2009-01-01'
+    assert_match(/updated_at <= E'2010-02-02 23:59:59.999'/, cnd)
+    assert_match(/updated_at >= E'2009-01-01 00:00:00.000'/, cnd)
+  end
+
+  def test_ilike
+    cnd = User.conditioner :name=>'*nicola*'
+    assert_match(/name ILIKE E'%nicola%'/, cnd)
+  end
+
+== TODO:
+
+ * Add pluguble rules for extactions
+
+ Example: 
+
+ Conditioner.configure do
+   extraction_rule do |key,value|
+     if /.*_gt/ =~ key
+       ["#{table_name}.#{key.gsub(/_gt$/,'')} > ?",value]
+     end
+   end
+ end
+
+== INSTALL:
+
+ in config/environmen.rb 
+ gem 'conditioner'
+ sudo rake gems:install
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 niquola
+
+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/Rakefile

@@ -0,0 +1,35 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/conditioner'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'conditioner' do
+  self.developer 'niquola', 'niquola@gmail.com'
+  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = self.name # TODO this is default value
+  self.extra_deps         = [['activerecord','>= 2.3.5']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+
+desc 'push gem to medapp'
+namespace :medapp do
+  task :push do
+    gem_name =  File.basename(Dir['pkg/*.gem'].max)
+    last_gem = File.join(File.dirname(__FILE__),'pkg',gem_name);
+    server = 'demo'
+    gem_copy_path = "/tmp/#{gem_name}"
+    system "scp #{last_gem} #{server}:#{gem_copy_path}"
+    system "ssh -t #{server} sudo gem install #{gem_copy_path}"  
+  end
+end

data/lib/conditioner.rb

@@ -0,0 +1,21 @@
+$:.unshift(File.dirname(__FILE__)) unless
+$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Conditioner
+  VERSION = '0.0.1'
+  autoload :ActiveRecordMixin, 'conditioner/active_record_mixin'
+  autoload :Condition, 'conditioner/condition'
+
+  class << self
+    def enable
+      ActiveRecord::Base.send :extend, ActiveRecordMixin
+    end
+
+    def condition(table_name,fields)
+    end
+  end
+end
+
+if defined? Rails
+  Conditioner.enable if defined? ActiveRecord
+end

data/lib/conditioner/active_record_mixin.rb

@@ -0,0 +1,9 @@
+module Conditioner
+  module ActiveRecordMixin
+    def conditioner(params=nil)
+      cnd = Conditioner::Condition.new(self)
+      cnd.extract params if params
+      cnd
+    end
+  end
+end

data/lib/conditioner/condition.rb

@@ -0,0 +1,75 @@
+module Conditioner
+  class Condition < String
+    def initialize(model)
+      @model=model
+      @result=[]
+      @column_names=@model.column_names
+      @first_condition=true
+      yield self if block_given?
+    end
+
+    def and(*args)
+      add_condition('AND',*args)
+    end
+
+    def _and(*args)
+      add_condition('AND',*args)
+    end
+
+    def or(*args)
+      add_condition('OR',*args)
+    end
+
+    def _or(*args)
+      add_condition('OR',*args)
+    end
+
+    def add_condition(unit,*args)
+      result= []
+      unless @first_condition
+        result<<' '<<unit
+      else
+        @first_condition=false
+      end
+      result<<@model.send(:sanitize_sql_for_conditions, *args)
+      self<< result.join(" ")
+      self
+    end
+
+    def is_field?(field)
+      @column_names.include?(field.to_s) || (field.to_s =~ /^(from|to)_(\w*_(datetime|at))/ && @column_names.include?($2))
+    end
+
+    def c(field_name)
+      %Q[#{@model.table_name}.#{field_name}]
+    end
+
+    #FIXME: document conventions
+    #add more conventions like
+    #name_start_from
+    #field_end_with
+    #field_in_range
+    #field_gt
+    #field_mt
+    def extract(hash)
+      hash.each do |k,v|
+        next unless is_field?(k)
+        if v =~ /(\*$|^\*)/
+          _and(["#{c(k)} ILIKE ?",v.gsub(/(\*$|^\*)/,'%')])
+        elsif v =~ /(%$|^%)/
+          _and(["upper(#{c(k)}) like upper(?)",v])
+          #FIXME: add logic for ranges
+        elsif k.to_s =~ /^from_(\w*_(datetime|at))/
+          _and(["#{c($1)} >= ?","#{v} 00:00:00.000"])
+        elsif k.to_s =~ /^to_(\w*_(datetime|at))/
+          _and(["#{c($1)} <= ?","#{v} 23:59:59.999"])
+        elsif k.to_s.include?('_datetime') || k.to_s.include?('_at')
+          _and(["(#{c(k)} BETWEEN ? AND ?)","#{v} 00:00","#{v} 23:59:59.999"])
+        else
+          _and(k=>v)
+        end
+      end
+      self
+    end
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/conditioner.rb'}"
+puts "Loading conditioner gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_conditioner.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+
+class TestConditioner < Test::Unit::TestCase
+
+  def test_conditioner_creation
+    cnd = User.conditioner
+    assert_not_nil(cnd)
+    params={:name=>'nicola',:email=>'nicola@mail.com'}
+    cnd = User.conditioner(params)
+    assert_not_nil(cnd)
+  end
+
+  def test_without_model_conditioner
+    #table_name = 'roles'
+    #fields = %w{name created_at}
+    #Conditioner.condition(table_name,fields)
+  end
+
+  def test_extraction
+    cnd=User.conditioner(:updated_at=>'2009-01-01', :email=>'nicola@mail.com',:unexisting=>'value')
+    assert_match(/"users"."email"\s*=\s*E'nicola@mail.com'/, cnd)
+    assert_match(/users.updated_at BETWEEN E'2009-01-01 00:00' AND E'2009-01-01 23:59:59.999'/, cnd)
+    assert_no_match(/unexisting/, cnd)
+  end
+
+  def test_extract_from_and_to_prefixed_date_fields
+    cnd = User.conditioner :to_updated_at =>'2010-02-02', :from_updated_at=>'2009-01-01'
+    assert_match(/updated_at <= E'2010-02-02 23:59:59.999'/, cnd)
+    assert_match(/updated_at >= E'2009-01-01 00:00:00.000'/, cnd)
+  end
+
+  def test_ilike
+    cnd = User.conditioner :name=>'*nicola*'
+    assert_match(/name ILIKE E'%nicola%'/, cnd)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,82 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/conditioner'
+require 'rubygems'
+require 'active_record'
+
+ActiveRecord::Base.logger = nil
+class TestUtils
+  class<< self
+    def config
+      {
+        :adapter=>'postgresql',
+        :host=> 'localhost',
+        :database=>'unittest_conditioner',
+        :username=>'postgres',
+        :password=>'postgres',
+        :encoding=>'utf8'
+      }
+    end
+
+    #create test database
+    def ensure_test_database
+      connect_to_test_db
+    rescue
+      create_database
+    end
+
+    def create_database
+      connect_to_postgres_db
+      ActiveRecord::Base.connection.create_database(config[:database], config)
+      connect_to_test_db
+    rescue
+      $stderr.puts $!, *($!.backtrace)
+      $stderr.puts "Couldn't create database for #{config.inspect}"
+    end
+
+    def connect_to_test_db
+      ActiveRecord::Base.establish_connection(config)
+      ActiveRecord::Base.connection
+    end
+
+    def connect_to_postgres_db
+      ActiveRecord::Base.establish_connection(config.merge(:database => 'postgres', :schema_search_path => 'public'))
+    end
+
+    def drop_database
+      connect_to_postgres_db
+      ActiveRecord::Base.connection.drop_database config[:database]
+    end
+  end
+end
+
+class CreateUsers < ActiveRecord::Migration
+  def self.up
+    create_table :users do |t|
+      t.string   :last_name,                 :limit => 25
+      t.string   :first_name,                :limit => 25
+      t.string   :middle_name,               :limit => 25
+      t.string   :name,                      :limit => 25
+      t.string   :login,                     :limit => 40
+      t.string   :email,                     :limit => 100
+      t.string   :crypted_password,          :limit => 40
+      t.string   :salt,                      :limit => 40
+      t.datetime :last_login_datetime
+      t.datetime :deleted_at
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :users
+  end
+end
+
+Conditioner.enable
+
+class User< ActiveRecord::Base
+end
+
+TestUtils.ensure_test_database
+CreateUsers.migrate(:up) unless ActiveRecord::Base.connection.table_exists?('users')
+#CreateUsers.migrate :down

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: conditioner
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- niquola
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-03 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: gemcutter
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.5.0
+    version: 
+description: Simple conditions builder for active_resource
+email: 
+- niquola@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/conditioner.rb
+- lib/conditioner/active_record_mixin.rb
+- lib/conditioner/condition.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_conditioner.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/niquola/conditioner
+licenses: []
+
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+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: conditioner
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Simple conditions builder for active_resource
+test_files: 
+- test/test_conditioner.rb
+- test/test_helper.rb