yaml_conditions 0.0.0.1

data/Manifest

@@ -0,0 +1,34 @@
+Manifest
+README.rdoc
+Rakefile
+TESTS.rdoc
+bin/console.sh
+init.rb
+lib/orms/active_record.rb
+lib/orms/active_record/version2/delayed_job.rb
+lib/orms/active_record/version_2.rb
+lib/orms/active_record/version_3.rb
+lib/orms/datamapper.rb
+lib/yaml/conditions.rb
+lib/yaml/query_builder.rb
+lib/yaml/query_builder/sql/mysql.rb
+lib/yaml/query_builder/sql/postgresql.rb
+lib/yaml_conditions.rb
+out.txt
+spec/ar_spec_helper.rb
+spec/cases/orms/active_record/version_2_delayed_job_spec.rb
+spec/cases/orms/active_record/version_2_spec.rb
+spec/connections/mysql/connection.rb
+spec/connections/postgresql/connection.rb
+spec/datamapper_spec_helper.rb
+spec/models/delayed/job.rb
+spec/models/delayed/performable_method.rb
+spec/models/job.rb
+spec/models/period.rb
+spec/models/priority.rb
+spec/models/user.rb
+spec/models/user_data.rb
+spec/schema.rb
+spec/spec_helper.rb
+tasks/yaml_conditions.rake
+yaml_conditions.gemspec

data/README.rdoc

@@ -0,0 +1,66 @@
+= yaml_conditions
+
+This is a tool for allowing queries based on serialized objects (via YAML) on relational databases (currently MySQL and Postrgres are supported).
+
+== Frameworks supported
+
+The idea is to support multiple ORMs. Currently we are only supporting ActiveRecord (version 2.x). We are working on extending support for ActiveRecord version 3.x, and then working on the integration with Datamapper.
+
+== Usage (for ActiveRecord 2.x only for now)
+
+Basically, we extend AR#find to allow a new option :yaml_conditions. If :yaml_contitions is not present, #find will behave exactly as it used to.
+
+yaml_conditions parameter expects a Hash with all the key/values you want to filter the serialized object.
+
+Below I summarized some samples so you can see how I use it.
+
+  Company.find(:all, :yaml_conditions => { :address => { :street => '5551 LEOPARD ST' } })
+
+  Company.find(:all, :yaml_conditions => { :status => :active })
+
+  Company.find(:first, :yaml_conditions => { :data => { { :street => '5551 LEOPARD ST' }, :status => :active } })
+
+  Company.find(:first, :yaml_conditions => { :data => { :owner => { :class => User, :name => 'Marcelo' } } })
+
+  Company.find(:first, :yaml_conditions => { :data => {  { :street => '5551 LEOPARD ST' }, :status => :active }, :conditions => [ 'branches_counter > ?', 3] )
+
+As you can see from the last sample, both yaml_conditions and conditions will be merged in order to find the expected results.
+
+  Company.find(:last, :yaml_conditions => { :data => { :user => { :last_name => 'Marcelo', :address => { :city => Yaml::NotSerializedField.new('Rio Negro') } } } })
+
+On this last sample, the city attribute can be traversed on memory but it is not saved on the serialized field (i.e. handler), so we want to indicate that to avoid building an invalid SQL.
+
+BTW: All methods ActiveRecord::Base#{last, first, all} rely on ActiveRecord::Base#find, so we can use yaml_conditions with these methods too. As an example:
+Company.all(:yaml_conditions => { :data => { :address => { :street => '5551 LEAOPARD ST' } } }) behaves the same way as the first sample explained below.
+
+== delayed_job
+
+Just to give you a little background, I build this gem/plugin just to filter my YAML objects created via delayed_job plugin ;)
+
+So, I added some custom magic for filtering Delayed::Job objects, like this:
+
+  Delayed::Job.first(:yaml_conditions => { :class => NotificationMailer, :handler => { :method => :new_registration, :args => [ User.find(1), '*', '*' ] } })
+
+  Delayed::Job.first(:yaml_conditions => { :handler => { :args => [ { :user => { :last_name => 'Marcelo', :address => { :city => 'Rio Negro' } } } ] } })
+
+As you probably realize, '*' is interpreted (for Delayed::Job instances) as a wildcard.
+
+== Installation
+
+  $ ruby script/plugin install git://github.com/marklazz/yaml_conditions.git)
+
+OR install it as a gem
+
+  $ [sudo] gem install yaml_conditions
+
+Enjoy!
+
+== License
+
+Copyright (c) 2010 Marcelo Giorgi
+
+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,16 @@
+require 'rubygems'
+require 'echoe'
+
+# PACKAGING ============================================================
+
+Echoe.new('yaml_conditions', '0.0.0.1') do |p|
+  p.description = ''
+  p.url = 'http://github.com/marklazz/yaml_conditions'
+  p.author = 'Marcelo Giorgi'
+  p.email = 'marklazz.uy@gmail.com'
+  p.ignore_pattern = [ 'tmp/*', 'script/*', '*.sh' ]
+  p.runtime_dependencies = []
+  p.development_dependencies = [ 'spec' ]
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/TESTS.rdoc

@@ -0,0 +1,12 @@
+Before running the tests you should create a user yaml_conditions for mysql (and for postgresql too if you want to run them there).
+
+Then to run the suite you should be able to do:
+
+rake spec (which will run both suites for mysql and postgres)
+
+Or run them individually:
+
+rake mysql:spec
+rake postgres:spec
+
+Enjoy!

data/bin/console.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+irb -r /home/marcelo/workspace/yaml_conditions/lib/yaml_conditions.rb

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/lib/yaml_conditions'

data/lib/orms/active_record.rb

@@ -0,0 +1,8 @@
+require 'active_record'
+require(File.join(File.dirname(__FILE__), 'active_record', 'version2', 'delayed_job'))
+
+if ::ActiveRecord::VERSION::MAJOR == 2
+  require File.join(File.dirname(__FILE__), 'active_record', 'version_2')
+elsif ::ActiveRecord::VERSION::MAJOR == 3
+  require File.join(File.dirname(__FILE__), 'active_record', 'version_3')
+end

data/lib/orms/active_record/version2/delayed_job.rb

@@ -0,0 +1,44 @@
+module Orms
+  module ActiveRecordVersion2
+    module DelayedJob
+
+      def self.included(base)
+        base.send(:include, InstanceMethods)
+        base.extend(ClassMethods)
+      end
+
+      module InstanceMethods
+      end
+
+      module ClassMethods
+
+        CLASS_STRING_FORMAT = /^CLASS\:([A-Z][\w\:]+)$/
+        AR_STRING_FORMAT    = /^AR\:([A-Z][\w\:]+)\:(\d+)$/
+
+        def __delayed_job_ar_to_string_(obj)
+          "AR:#{obj.class}:#{obj.id}"
+        end
+
+        def __delayed_job_class_to_string_(obj)
+          "CLASS:#{obj.name}"
+        end
+
+        def __serialize__to_yaml_value__(arg)
+          case arg
+            when Class              then __delayed_job_class_to_string_(arg)
+            when ActiveRecord::Base then __delayed_job_ar_to_string_(arg)
+            else super(arg)
+          end
+        end
+
+        def __yaml_load_object_recursively__(arg)
+          case arg
+            when CLASS_STRING_FORMAT then $1.constantize
+            when AR_STRING_FORMAT    then $1.constantize.find($2)
+            else super(arg)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/orms/active_record/version_2.rb

@@ -0,0 +1,45 @@
+module Orms
+  module ActiveRecordVersion2
+
+    include Yaml::Conditions
+    include Yaml::QueryBuilder
+
+    def __include_delayedjob_adapter_if_necessary__
+      self.send(:include, ::Orms::ActiveRecordVersion2::DelayedJob)
+      @delayed_adapter_included = true
+    end
+
+    def find_with_yaml_conditions(*args)
+      options = args.last.is_a?(::Hash) ? args.last : {}
+      yaml_conditions = options[:yaml_conditions]
+      return find_without_yaml_conditions(*args) if yaml_conditions.blank?
+      __include_db_adapter_if_necessary__ if @db_adapter_included.nil?
+      __include_delayedjob_adapter_if_necessary__ if defined?(Delayed::Job) && self == Delayed::Job && @delayed_adapter_included.nil?
+      options = args.extract_options!
+      adapted_args = args << refactor_options(options)
+      selector = adapted_args.shift
+      result = find_without_yaml_conditions(:all, *adapted_args).select do |o|
+          __check_yaml_nested_hierarchy__(o, yaml_conditions)
+      end
+      selector == :all ? result : result.send(selector.to_sym)
+    end
+
+    def refactor_options(options)
+      sql_conditions = sanitize_sql(options.delete(:conditions))
+      yaml_conditions = options.delete(:yaml_conditions)
+      yaml_conditions.symbolize_keys! if yaml_conditions.is_a?(Hash)
+      options.merge!({ :conditions => __join_yaml_conditions__(sql_conditions, __build_yaml_conditions__(yaml_conditions)) })
+    end
+  end
+end
+
+module ActiveRecord
+  class Base
+   class << self
+     include Orms::ActiveRecordVersion2
+
+     alias_method :find_without_yaml_conditions, :find
+     alias_method :find, :find_with_yaml_conditions
+    end
+  end
+end

data/lib/orms/active_record/version_3.rb

@@ -0,0 +1,7 @@
+module Orms
+  module ActiveRecord
+
+    def where(*args, &blk)
+    end
+  end
+end

data/lib/orms/datamapper.rb

@@ -0,0 +1,4 @@
+module Orms
+  class Datamapper
+  end
+end

data/lib/yaml/conditions.rb

@@ -0,0 +1,19 @@
+module Yaml
+  module Conditions
+    extend self
+    ParseObjectFromYaml = /\!ruby\/\w+\:([^\s]+)/
+
+    VERSION = '0.0.1'
+  end
+
+  class NotSerializedField
+
+    def initialize(value)
+      @value = value
+    end
+
+    def ==(v)
+      @value == v
+    end
+  end
+end

data/lib/yaml/query_builder.rb

@@ -0,0 +1,150 @@
+module Yaml
+  module QueryBuilder
+
+    def __include_db_adapter_if_necessary__
+      adapter_name = self.connection.adapter_name
+      adapter_capitalized = adapter_name.upcase[0].chr + adapter_name.downcase[1..-1]
+      adapter_module = ::Yaml::QueryBuilder::Sql.const_get("#{adapter_capitalized}Adapter".to_sym)
+      self.send(:include, adapter_module)
+      @db_adapter_included = true
+    end
+
+    def __build_yaml_conditions__(yaml_conditions)
+      yaml_conditions.inject("") do |conditions, (serialized_field,v)|
+        __join_yaml_conditions__(conditions, __build_yaml_attributes__(serialized_field, v))
+      end
+    end
+
+    def __serialize__to_yaml_value__(v)
+      return '' if v.nil?
+      v_s = v.to_s
+      v_s == '*' ? "" : v_s
+    end
+
+    def __build_yaml_conditions_for_list__(field, k,v)
+      v.map { |item| __resolve_yaml_conditions_by_structure__(field, k, item, true) }.join('AND ')
+    end
+
+
+    def __build_individual_yaml_conditions__(field, k,v, skip_key = false)
+      return "1 = 1" if v.is_a?(Yaml::NotSerializedField)
+      key_s = skip_key ? '' : "#{k}: "
+      "#{field} LIKE '%#{key_s}#{v.is_a?(Symbol) ? ':' + v.to_s : __serialize__to_yaml_value__(v)}%' "
+    end
+
+    def __resolve_yaml_conditions_by_structure__(field, k, v, skip_key = false)
+      if v.is_a?(Hash)
+        __build_yaml_attributes__(field, v, skip_key)
+      elsif v.is_a?(Array)
+        __build_yaml_conditions_for_list__(field, k, v)
+      else
+        __build_individual_yaml_conditions__(field, k, v, skip_key)
+      end
+    end
+
+    def __build_yaml_attributes__(field, yaml_conditions, skip_key = false)
+      current_conditions = ''
+      __filter_yaml_attributes_to_check_on__(yaml_conditions).each do |k,v|
+        conditions = __resolve_yaml_conditions_by_structure__(field, k, v, skip_key)
+        current_conditions = __join_yaml_conditions__(current_conditions, conditions)
+      end
+      current_conditions
+    end
+
+    def __check_yaml_nested_hierarchy_on_list__(value, yaml_conditions)
+      return false if !value.is_a?(Array) || value.length != yaml_conditions.length
+      yaml_conditions.zip(value).inject(true) do |result, (cond, nested_value)|
+          result &= __check_yaml_nested_hierarchy__(nested_value, cond)
+      end
+    end
+
+    def __check_yaml_nested_hierarchy__(value, yaml_conditions)
+      return true if value.nil? && yaml_conditions.nil? || yaml_conditions == '*'
+      return false if value.nil? || yaml_conditions.nil?
+      unless yaml_conditions.is_a?(Hash) || yaml_conditions.is_a?(Array)
+        object_built_from_conds = value.is_a?(String) ? __yaml_load_object_recursively__(value) : value
+        return yaml_conditions == object_built_from_conds
+      end
+      return __check_yaml_nested_hierarchy_on_list__(value, yaml_conditions) if yaml_conditions.is_a?(Array)
+      yaml_conditions.inject(true) do |accept, (field, conditions)|
+        accept &= begin
+          nested_value = __yaml_method_or_key__(value, field)
+          if conditions.is_a?(Hash)
+            (conditions[:class].blank? || __yaml_same_class__(conditions[:class].to_s, nested_value)) &&
+            __check_yaml_nested_hierarchy__(nested_value, __filter_yaml_attributes_to_check_on__(conditions.symbolize_keys!))
+          else
+            __check_yaml_nested_hierarchy__(nested_value, conditions)
+          end
+        end
+      end
+    end
+
+    def __yaml_method_or_key__(object, key)
+      value = if object.is_a?(Hash)
+        object[key.to_sym] || object[key.to_s]
+      elsif object.respond_to?(key.to_sym)
+        object.send(key)
+      end
+      if value.is_a?(String)
+        __yaml_load_object_recursively__(value)
+      else
+        value
+      end
+    rescue
+        nil
+    end
+
+    def __yaml_load_object_recursively__(object)
+      yaml_object = __yaml_deserialize__(object)
+      if yaml_object.respond_to?(:value) && yaml_object.respond_to?(:type_id) && yaml_object.type_id == 'struct'
+        yaml_object = yaml_object.value
+        yaml_object = yaml_object.keys.inject(yaml_object) do |yobject, key|
+          yobject[key] = yobject[key].is_a?(String) ? __yaml_load_object_recursively__(yobject[key]) : yobject[key]
+          yobject
+        end
+        yaml_object[:class] = yaml_object.class.to_s
+        yaml_object
+      else
+        yaml_object
+      end
+    end
+
+    def __yaml_deserialize__(source)
+      handler = YAML.load(source) rescue nil
+
+      unless handler.present?
+        if handler.nil? && source =~ ParseObjectFromYaml
+          handler_class = $1
+        end
+        __attempt_to_load__(handler_class || handler.class) rescue nil
+        handler = YAML.load(source)
+      end
+      handler
+    end
+
+    def __attempt_to_load__(klass)
+       klass.constantize
+    end
+
+    def __yaml_same_class__(class_string, nested_value)
+      klazz_s = class_string.gsub('Struct::', '')
+      klazz =  klazz_s.constantize rescue nil
+      struct_klazz = nested_value.class.to_s[/^Struct::(.*)$/, 1]
+      klazz.present? && nested_value.is_a?(klazz) || struct_klazz.present? && struct_klazz == klazz_s
+    end
+
+    def __filter_yaml_attributes_to_check_on__(yaml_conditions)
+      yaml_conditions.reject { |k,v| k.to_s == 'class' }
+    end
+
+    def __join_yaml_conditions__(current_conditions, conditions)
+      if current_conditions.blank?
+        conditions
+      elsif conditions.blank?
+        current_conditions
+      else
+        [ "(#{conditions})", "(#{current_conditions})" ].join(' AND ')
+      end
+    end
+  end
+end

data/lib/yaml/query_builder/sql/mysql.rb

@@ -0,0 +1,15 @@
+module Yaml
+  module QueryBuilder
+    module Sql
+      module MysqlAdapter
+
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        module ClassMethods
+        end
+      end
+    end
+  end
+end

data/lib/yaml/query_builder/sql/postgresql.rb

@@ -0,0 +1,15 @@
+module Yaml
+  module QueryBuilder
+    module Sql
+      module PostgresqlAdapter
+
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        module ClassMethods
+        end
+      end
+    end
+  end
+end