conditioner 0.0.1 → 0.0.2

data/README.rdoc

@@ -4,55 +4,44 @@
 
 == DESCRIPTION:
 
- Simple conditions builder for active_resource
+Simple conditions builder for active_record
 
-== SYNOPSIS:
+== INSTALL:
 
-  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
+in config/environment.rb:
 
-  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
+ config.gem 'conditioner'
 
-  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
+and then 
 
-  def test_ilike
-    cnd = User.conditioner :name=>'*nicola*'
-    assert_match(/name ILIKE E'%nicola%'/, cnd)
-  end
+ sudo rake gems:install
 
-== TODO:
+To override Conditioner configurations create config/initializers/conditioner.rb with:
 
- * Add pluguble rules for extactions
 
- Example: 
+  Conditioner.configure do
 
- Conditioner.configure do
    extraction_rule do |key,value|
      if /.*_gt/ =~ key
        ["#{table_name}.#{key.gsub(/_gt$/,'')} > ?",value]
      end
    end
- end
+  end
 
-== INSTALL:
+== USAGE
 
- in config/environmen.rb 
- gem 'conditioner'
- sudo rake gems:install
+  #this create conditions from params using extract rules  
+  cnd = YourModel.conditioner(params)
+  #<b>and</b> and <b>or</b> eat same parameters as :conditions option in ActiveRecord.find
+  cnd.and  :field=>'value'
+  cnd.and  ['field='?',value]
+
+  #here we pass condition into find methods
+  YourModel.all(:conditions=>cnd)
+
+== CHANGE LIST:
+
+* 0.0.2 Add configurable rules for extactions
 
 == LICENSE:
 

data/Rakefile

@@ -1,35 +1,46 @@
-require 'rubygems'
-gem 'hoe', '>= 2.1.0'
-require 'hoe'
-require 'fileutils'
-require './lib/conditioner'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
 
-Hoe.plugin :newgem
-# Hoe.plugin :website
-# Hoe.plugin :cucumberfeatures
+desc 'Default: run unit tests.'
+task :default => :test
 
-# 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']]
+desc 'Test the pg_gnostic plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
 
+desc 'Generate documentation for the pg_gnostic plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Conditioner'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-require 'newgem/tasks'
-Dir['tasks/**/*.rake'].each { |t| load t }
 
+PKG_FILES = FileList[ '[a-zA-Z]*', 'generators/**/*', 'lib/**/*', 'rails/**/*', 'tasks/**/*', 'test/**/*' ]
+
+spec = Gem::Specification.new do |s|
+  s.name = "conditioner"
+  s.version = "0.0.2"
+  s.author = "niquola"
+  s.email = "niquola@gmail.com"
+  s.homepage = "http://github.com/niquola/conditioner"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Simple conditions builder for active_record"
+  s.files = PKG_FILES.to_a 
+  s.require_path = "lib"
+  s.has_rdoc = false
+  s.extra_rdoc_files = ["README.rdoc"]
+end
 
-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
+desc 'Turn this plugin into a gem.'
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
 end

data/init.rb

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

data/lib/conditioner.rb

@@ -5,14 +5,24 @@ module Conditioner
   VERSION = '0.0.1'
   autoload :ActiveRecordMixin, 'conditioner/active_record_mixin'
   autoload :Condition, 'conditioner/condition'
+  autoload :Configurator, 'conditioner/configurator'
 
   class << self
     def enable
       ActiveRecord::Base.send :extend, ActiveRecordMixin
+      Conditioner.config.activate_default_rules!
     end
 
     def condition(table_name,fields)
     end
+
+    def config
+      @config ||= Configurator.new
+    end
+
+    def configure
+      yield config
+    end
   end
 end
 

data/lib/conditioner/condition.rb

@@ -25,6 +25,7 @@ module Conditioner
     end
 
     def add_condition(unit,*args)
+      @condition_called_flag= true
       result= []
       unless @first_condition
         result<<' '<<unit
@@ -37,37 +38,22 @@ module Conditioner
     end
 
     def is_field?(field)
-      @column_names.include?(field.to_s) || (field.to_s =~ /^(from|to)_(\w*_(datetime|at))/ && @column_names.include?($2))
+      @column_names.include?(field)
     end
 
-    def c(field_name)
+    def with_table_name(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)
+        field = k.to_s
+        Conditioner.config.extract_rules.each do |rule|
+          rule.call(field,v,self)
+          break if @condition_called_flag
         end
+        _and(field=>v) if is_field?(field) and !@condition_called_flag
+        @condition_called_flag = false
       end
       self
     end

data/lib/conditioner/configurator.rb

@@ -0,0 +1,34 @@
+module Conditioner
+  class Configurator
+
+    def extract_rules
+      @rules ||= []
+    end
+
+    def add_rule(&rule)
+      extract_rules<< rule
+    end
+
+    #You can clear default rules with
+    def clear_rules!
+      @rules = []
+    end
+
+    def activate_default_rules!
+      add_rule do |field, v, cnd|
+        if cnd.is_field?(field) && v =~ /(\*$|^\*)/
+          cnd.and(["#{cnd.with_table_name(field)} ILIKE ?",v.gsub(/(\*$|^\*)/,'%')])
+        elsif cnd.is_field?(field) && v =~ /(%$|^%)/
+          cnd.and(["upper(#{cnd.with_table_name(field)}) like upper(?)",v])
+          #FIXME: add logic for ranges
+        elsif field=~ /^from_(\w*_(datetime|at))/ and cnd.is_field?($1)
+          cnd.and(["#{cnd.with_table_name($1)} >= ?","#{v} 00:00:00.000"])
+        elsif field=~ /^to_(\w*_(datetime|at))/ and cnd.is_field?($1)
+          cnd.and(["#{cnd.with_table_name($1)} <= ?","#{v} 23:59:59.999"])
+        elsif cnd.is_field?(field) && (field.include?('_datetime') || field.include?('_at'))
+          cnd.and(["(#{cnd.with_table_name(field)} BETWEEN ? AND ?)","#{v} 00:00","#{v} 23:59:59.999"])
+        end
+      end
+    end
+  end
+end

data/test/{test_conditioner.rb → conditioner_test.rb}

@@ -1,5 +1,17 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
 
+Conditioner.configure do |cfg|
+  #Must be activated by default
+  #cfg.activate_default_rules!
+  #You can clear default rules with
+  #cfg.clear_rules!
+
+  cfg.add_rule do |key, value, cnd|
+    if /(.\w*)_gt/ =~ key.to_s && cnd.is_field?($1) 
+      cnd.and(["#{key.gsub(/_gt$/,'')} > ?",value])
+    end
+  end
+end
 
 class TestConditioner < Test::Unit::TestCase
 
@@ -11,12 +23,6 @@ class TestConditioner < Test::Unit::TestCase
     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)
@@ -33,5 +39,11 @@ class TestConditioner < Test::Unit::TestCase
   def test_ilike
     cnd = User.conditioner :name=>'*nicola*'
     assert_match(/name ILIKE E'%nicola%'/, cnd)
+    assert_no_match(/\*nicola\*/, cnd,'Rule must work only once!')
+  end
+
+  def test_configurator
+    cnd = User.conditioner :created_at_gt => '2010-01-01'
+    assert_match(/created_at > E'2010-01-01'/, cnd)
   end
 end

data/test/test_helper.rb

@@ -1,6 +1,6 @@
 require 'stringio'
-require 'test/unit'
 require File.dirname(__FILE__) + '/../lib/conditioner'
+require "test/unit"
 require 'rubygems'
 require 'active_record'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: conditioner
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - niquola
@@ -9,82 +9,38 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-03 00:00:00 +03:00
+date: 2010-03-04 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
+dependencies: []
+
+description: 
+email: niquola@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
-- Manifest.txt
-- PostInstall.txt
+- README.rdoc
 files: 
-- History.txt
+- init.rb
 - Manifest.txt
 - PostInstall.txt
-- README.rdoc
 - Rakefile
+- README.rdoc
+- History.txt
 - lib/conditioner.rb
-- lib/conditioner/active_record_mixin.rb
 - lib/conditioner/condition.rb
-- script/console
-- script/destroy
-- script/generate
-- test/test_conditioner.rb
+- lib/conditioner/active_record_mixin.rb
+- lib/conditioner/configurator.rb
+- test/conditioner_test.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
+post_install_message: 
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -101,11 +57,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: conditioner
+rubyforge_project: 
 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
+summary: Simple conditions builder for active_record
+test_files: []
+

data/script/console

@@ -1,10 +0,0 @@
-#!/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

@@ -1,14 +0,0 @@
-#!/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

@@ -1,14 +0,0 @@
-#!/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)