model_set 1.0.0 → 1.1.0

data/lib/model_set/sql_base_query.rb

@@ -4,29 +4,33 @@ class ModelSet
     def ids
       @ids ||= fetch_id_set(sql)
     end
-    
+
     def size
       @size ||= ids.size
     end
 
   private
-    
+
     def ids_clause(ids, field = id_field_with_prefix)
-      db.ids_clause(ids, field)
+      db.ids_clause(ids, field, set_class.id_type)
     end
 
     def fetch_id_set(sql)
-      db.select_values(sql).collect {|id| id.to_i}.to_ordered_set
+      db.select_values(sql).collect { |id| set_class.id_type == :integer ? id.to_i : id }.to_ordered_set
     end
 
     def db
       model_class.connection
     end
-    
+
     def sanitize_condition(condition)
       model_class.send(:sanitize_sql, condition)
     end
-    
+
+    def transform_condition(condition)
+      [sanitize_condition(condition)]
+    end
+
     def limit_clause
       return unless limit
       limit_clause = "LIMIT #{limit}"
@@ -37,15 +41,23 @@ class ModelSet
 end
 
 class ActiveRecord::ConnectionAdapters::AbstractAdapter
-  def ids_clause(ids, field)
-    # Make sure all ids are integers to prevent SQL injection attacks.
-    ids = ids.collect {|id| id.to_i}
-
-    if ids.empty?
-      "FALSE"
-    elsif kind_of?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
-      "#{field} = ANY ('{#{ids.join(',')}}'::bigint[])"
-    else
+  def ids_clause(ids, field, id_type)
+    return "FALSE" if ids.empty?
+
+    if id_type == :integer
+      # Make sure all ids are integers to prevent SQL injection attacks.
+      ids = ids.collect {|id| id.to_i}
+
+      if kind_of?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
+        "#{field} = ANY ('{#{ids.join(',')}}'::bigint[])"
+      else
+        "#{field} IN (#{ids.join(',')})"
+      end
+    elsif id_type == :string
+      ids = ids.collect do |id|
+        raise ArgumentError.new('Invalid id: #{id}') if id =~ /'/
+        "'#{id}'"
+      end
       "#{field} IN (#{ids.join(',')})"
     end
   end

data/lib/model_set/sql_query.rb

@@ -22,7 +22,7 @@ class ModelSet
           base_conditions = conditions
           @ids = [].to_ordered_set
           @reorder.each_slice(@limit_fetch) do |ids|
-            self.conditions = Conditions.new(:and, ids_clause(ids), *base_conditions)
+            self.conditions = to_conditions(:and, ids_clause(ids), *base_conditions)
             @ids.concat fetch_id_set(sql)
             if limit and @ids.size >= limit
               @ids.reorder!(@reorder).limit!(limit)
@@ -54,12 +54,7 @@ class ModelSet
 
     def add_joins!(*joins)
       @joins ||= []
-
-      joins.each do |join|
-        @joins << sanitize_condition(join)
-      end
-      @joins.uniq!
-
+      @joins.concat(joins)
       clear_cache!
     end
 
@@ -70,7 +65,7 @@ class ModelSet
     def order_by!(*args)
       opts = args.last.kind_of?(Hash) ? args.pop : {}
 
-      @sort_join  = sanitize_condition(opts[:join])
+      @sort_join  = opts[:join]
       @sort_order = args
       @reorder    = nil
       clear_cache!
@@ -120,9 +115,12 @@ class ModelSet
     def join_clause
       return unless @joins or @sort_join
       joins = []
-      joins << @joins      if @joins
+      joins << @joins     if @joins
       joins << @sort_join if @sort_join
-      joins.join(' ')
+
+      joins.flatten.collect do |join|
+        sanitize_condition(join)
+      end.uniq.join(' ')
     end
   end
 end

data/lib/model_set.rb

@@ -1,4 +1,3 @@
-require 'rubygems'
 require 'active_record'
 require 'deep_clonable'
 require 'ordered_set'
@@ -52,7 +51,7 @@ class ModelSet
 
   [:add!, :unshift!, :subtract!, :intersect!, :reorder!, :reverse_reorder!].each do |action|
     define_method(action) do |models|
-      anchor!(:set)
+      reanchor!(:set)
       query.send(action, as_ids(models))
       self
     end
@@ -67,6 +66,8 @@ class ModelSet
   alias delete subtract!
   alias without! subtract!
   clone_method :without
+  clone_method :reorder
+  clone_method :reverse_reorder
 
   clone_method :shuffle
   def shuffle!
@@ -228,6 +229,7 @@ class ModelSet
   def reject_raw!(&block)
     anchor!(:raw)
     query.reject!(&block)
+    self
   end
 
   def select_raw(&block)
@@ -372,7 +374,7 @@ class ModelSet
     :sql
   end
 
-  [:add_conditions!, :add_joins!, :in!, :invert!, :order_by!].each do |method_name|
+  [:add_conditions!, :add_joins!, :in!, :invert!, :order_by!, :to_conditions].each do |method_name|
     clone_method method_name
     define_method(method_name) do |*args|
       # Use the default query engine if none is specified.
@@ -383,6 +385,11 @@ class ModelSet
     end
   end
 
+  def to_conditions(*args)
+    anchor!( extract_opt(:query_type, args) || default_query_type )
+    query.to_conditions(*args)
+  end
+
   [:unsorted!, :limit!, :page!, :unlimited!, :reverse!].each do |method_name|
     clone_method method_name
     define_method(method_name) do |*args|
@@ -473,7 +480,19 @@ class ModelSet
       models.ids
     else
       models = [models] if not models.kind_of?(Enumerable)
-      models.collect {|model| model.kind_of?(ActiveRecord::Base) ? model.id : model.to_i }
+      models.collect {|model| as_id(model)}
+    end
+  end
+
+  def self.as_id(model)
+    id = model_class.as_id(model) if model_class.respond_to?(:as_id)
+    return id if id
+
+    case model
+    when model_class        then model.send(id_field)
+    when ActiveRecord::Base then model.id
+    when String             then model.split('-').last.to_i
+    else                         model.to_i
     end
   end
 
@@ -550,14 +569,22 @@ class ModelSet
 
   def self.id_field(id_field = nil)
     if id_field.nil?
-      @id_field ||= 'id'
+      @id_field ||= :id
     else
       @id_field = id_field
     end
   end
 
+  def self.id_type(id_type = nil)
+    if id_type.nil?
+      @id_type ||= :integer
+    else
+      @id_type = id_type.to_sym
+    end
+  end
+
   def self.id_field_with_prefix
-    "#{self.table_name}.#{self.id_field}"
+    self.id_field.is_a?(String) ? self.id_field : "#{self.table_name}.#{self.id_field}"
   end
 
   # Define instance methods based on class methods.
@@ -609,7 +636,7 @@ private
         models = model_class.find(:all,
           :select     => fields.compact.join(','),
           :joins      => joins.compact.join(' '),
-          :conditions => db.ids_clause(ids_to_fetch, id_field_with_prefix),
+          :conditions => db.ids_clause(ids_to_fetch, id_field_with_prefix, self.class.id_type),
           :include    => @included_models
         )
       end
@@ -625,15 +652,10 @@ private
   end
 
   def as_id(model)
-    case model
-    when model_class
+    id = self.class.as_id(model)
+    if model.kind_of?(model_class)
       # Save the model object if it is of the same type as our models.
-      id = model.send(id_field)
       models_by_id[id] ||= model
-    when ActiveRecord::Base
-      id = model.id
-    else
-      id = model.to_i
     end
     raise "id not found for model: #{model.inspect}" if id.nil?
     id
@@ -741,7 +763,9 @@ class ActiveRecord::Base
       if options[:clone] == false or args.include?(:no_clone)
         @model_set_cache[name]
       else
-        @model_set_cache[name].clone
+        set = @model_set_cache[name].clone
+        set.extend(extension_module) if extension_module
+        set
       end
     end
 

data/model_set.gemspec

@@ -1,141 +1,29 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-Gem::Specification.new do |s|
-  s.name = %q{model_set}
-  s.version = "1.0.0"
+Gem::Specification.new do |gem|
+  gem.name          = "model_set"
+  gem.version       = IO.read('VERSION')
+  gem.authors       = ["Justin Balthrop"]
+  gem.email         = ["git@justinbalthrop.com"]
+  gem.description   = %q{Easy manipulation of sets of ActiveRecord models}
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/ninjudd/model_set"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Justin Balthrop"]
-  s.date = %q{2011-06-02}
-  s.description = %q{Easy manipulation of sets of ActiveRecord models}
-  s.email = %q{code@justinbalthrop.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.rdoc"
-  ]
-  s.files = [
-    "LICENSE",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "lib/model_set.rb",
-    "lib/model_set/conditioned.rb",
-    "lib/model_set/conditions.rb",
-    "lib/model_set/query.rb",
-    "lib/model_set/raw_query.rb",
-    "lib/model_set/raw_sql_query.rb",
-    "lib/model_set/set_query.rb",
-    "lib/model_set/solr_query.rb",
-    "lib/model_set/sphinx_query.rb",
-    "lib/model_set/sql_base_query.rb",
-    "lib/model_set/sql_query.rb",
-    "lib/multi_set.rb",
-    "model_set.gemspec",
-    "test/model_set_test.rb",
-    "test/multi_set_test.rb",
-    "test/test_helper.rb",
-    "vendor/sphinx_client/README.rdoc",
-    "vendor/sphinx_client/Rakefile",
-    "vendor/sphinx_client/init.rb",
-    "vendor/sphinx_client/install.rb",
-    "vendor/sphinx_client/lib/sphinx.rb",
-    "vendor/sphinx_client/lib/sphinx/client.rb",
-    "vendor/sphinx_client/lib/sphinx/request.rb",
-    "vendor/sphinx_client/lib/sphinx/response.rb",
-    "vendor/sphinx_client/spec/client_response_spec.rb",
-    "vendor/sphinx_client/spec/client_spec.rb",
-    "vendor/sphinx_client/spec/fixtures/default_search.php",
-    "vendor/sphinx_client/spec/fixtures/default_search_index.php",
-    "vendor/sphinx_client/spec/fixtures/excerpt_custom.php",
-    "vendor/sphinx_client/spec/fixtures/excerpt_default.php",
-    "vendor/sphinx_client/spec/fixtures/excerpt_flags.php",
-    "vendor/sphinx_client/spec/fixtures/field_weights.php",
-    "vendor/sphinx_client/spec/fixtures/filter.php",
-    "vendor/sphinx_client/spec/fixtures/filter_exclude.php",
-    "vendor/sphinx_client/spec/fixtures/filter_float_range.php",
-    "vendor/sphinx_client/spec/fixtures/filter_float_range_exclude.php",
-    "vendor/sphinx_client/spec/fixtures/filter_range.php",
-    "vendor/sphinx_client/spec/fixtures/filter_range_exclude.php",
-    "vendor/sphinx_client/spec/fixtures/filter_range_int64.php",
-    "vendor/sphinx_client/spec/fixtures/filter_ranges.php",
-    "vendor/sphinx_client/spec/fixtures/filters.php",
-    "vendor/sphinx_client/spec/fixtures/filters_different.php",
-    "vendor/sphinx_client/spec/fixtures/geo_anchor.php",
-    "vendor/sphinx_client/spec/fixtures/group_by_attr.php",
-    "vendor/sphinx_client/spec/fixtures/group_by_attrpair.php",
-    "vendor/sphinx_client/spec/fixtures/group_by_day.php",
-    "vendor/sphinx_client/spec/fixtures/group_by_day_sort.php",
-    "vendor/sphinx_client/spec/fixtures/group_by_month.php",
-    "vendor/sphinx_client/spec/fixtures/group_by_week.php",
-    "vendor/sphinx_client/spec/fixtures/group_by_year.php",
-    "vendor/sphinx_client/spec/fixtures/group_distinct.php",
-    "vendor/sphinx_client/spec/fixtures/id_range.php",
-    "vendor/sphinx_client/spec/fixtures/id_range64.php",
-    "vendor/sphinx_client/spec/fixtures/index_weights.php",
-    "vendor/sphinx_client/spec/fixtures/keywords.php",
-    "vendor/sphinx_client/spec/fixtures/limits.php",
-    "vendor/sphinx_client/spec/fixtures/limits_cutoff.php",
-    "vendor/sphinx_client/spec/fixtures/limits_max.php",
-    "vendor/sphinx_client/spec/fixtures/limits_max_cutoff.php",
-    "vendor/sphinx_client/spec/fixtures/match_all.php",
-    "vendor/sphinx_client/spec/fixtures/match_any.php",
-    "vendor/sphinx_client/spec/fixtures/match_boolean.php",
-    "vendor/sphinx_client/spec/fixtures/match_extended.php",
-    "vendor/sphinx_client/spec/fixtures/match_extended2.php",
-    "vendor/sphinx_client/spec/fixtures/match_fullscan.php",
-    "vendor/sphinx_client/spec/fixtures/match_phrase.php",
-    "vendor/sphinx_client/spec/fixtures/max_query_time.php",
-    "vendor/sphinx_client/spec/fixtures/miltiple_queries.php",
-    "vendor/sphinx_client/spec/fixtures/ranking_bm25.php",
-    "vendor/sphinx_client/spec/fixtures/ranking_none.php",
-    "vendor/sphinx_client/spec/fixtures/ranking_proximity.php",
-    "vendor/sphinx_client/spec/fixtures/ranking_proximity_bm25.php",
-    "vendor/sphinx_client/spec/fixtures/ranking_wordcount.php",
-    "vendor/sphinx_client/spec/fixtures/retries.php",
-    "vendor/sphinx_client/spec/fixtures/retries_delay.php",
-    "vendor/sphinx_client/spec/fixtures/select.php",
-    "vendor/sphinx_client/spec/fixtures/set_override.php",
-    "vendor/sphinx_client/spec/fixtures/sort_attr_asc.php",
-    "vendor/sphinx_client/spec/fixtures/sort_attr_desc.php",
-    "vendor/sphinx_client/spec/fixtures/sort_expr.php",
-    "vendor/sphinx_client/spec/fixtures/sort_extended.php",
-    "vendor/sphinx_client/spec/fixtures/sort_relevance.php",
-    "vendor/sphinx_client/spec/fixtures/sort_time_segments.php",
-    "vendor/sphinx_client/spec/fixtures/sphinxapi.php",
-    "vendor/sphinx_client/spec/fixtures/update_attributes.php",
-    "vendor/sphinx_client/spec/fixtures/update_attributes_mva.php",
-    "vendor/sphinx_client/spec/fixtures/weights.php",
-    "vendor/sphinx_client/spec/sphinx/sphinx-id64.conf",
-    "vendor/sphinx_client/spec/sphinx/sphinx.conf",
-    "vendor/sphinx_client/spec/sphinx/sphinx_test.sql",
-    "vendor/sphinx_client/sphinx.yml.tpl",
-    "vendor/sphinx_client/tasks/sphinx.rake"
-  ]
-  s.homepage = %q{http://github.com/ninjudd/model_set}
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Easy manipulation of sets of ActiveRecord models}
+  gem.add_development_dependency 'shoulda', '3.0.1'
+  gem.add_development_dependency 'mocha'
+  gem.add_development_dependency 'rsolr'
+  gem.add_development_dependency 'json'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'system_timer'
+  gem.add_development_dependency 'activerecord-postgresql-adapter'
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  gem.add_dependency 'ordered_set',   '>= 1.0.1'
+  gem.add_dependency 'deep_clonable', '>= 1.1.0'
+  gem.add_dependency 'activerecord',  '~> 2.3.9'
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<ordered_set>, [">= 1.0.1"])
-      s.add_runtime_dependency(%q<deep_clonable>, [">= 1.1.0"])
-      s.add_runtime_dependency(%q<activerecord>, [">= 2.0.0"])
-    else
-      s.add_dependency(%q<ordered_set>, [">= 1.0.1"])
-      s.add_dependency(%q<deep_clonable>, [">= 1.1.0"])
-      s.add_dependency(%q<activerecord>, [">= 2.0.0"])
-    end
-  else
-    s.add_dependency(%q<ordered_set>, [">= 1.0.1"])
-    s.add_dependency(%q<deep_clonable>, [">= 1.1.0"])
-    s.add_dependency(%q<activerecord>, [">= 2.0.0"])
-  end
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
 end
-

data/test/model_set_test.rb

@@ -120,6 +120,23 @@ class ModelSetTest < Test::Unit::TestCase
       assert_equal [ironman.id, captain.id, spidey.id], set.ids
     end
 
+    should "support conditions with or in them" do
+      captain  = Hero.create(:name => 'Captain America', :universe => 'Marvel')
+      spidey   = Hero.create(:name => 'Spider Man',      :universe => 'Marvel')
+      ironman  = Hero.create(:name => 'Iron Man',        :universe => 'Marvel')
+      ryu      = Hero.create(:name => 'Ryu',             :universe => 'Capcom')
+      ken      = Hero.create(:name => 'Ken',             :universe => 'Capcom')
+      guile    = Hero.create(:name => 'Guile',           :universe => 'Capcom')
+      batman   = Hero.create(:name => 'Batman',          :universe => 'D.C.'  )
+      superman = Hero.create(:name => 'Superman',        :universe => 'D.C.'  )
+
+      set = HeroSet.all
+      set.add_conditions!("universe = 'Marvel' OR universe = 'Capcom'")
+      set.add_conditions!("name LIKE '%n'")
+
+      assert_equal [spidey.id, ironman.id, ken.id], set.ids
+    end
+
     should "order and reverse set" do
       captain   = Hero.create(:name => 'Captain America', :universe => 'Marvel')
       spidey    = Hero.create(:name => 'Spider Man',      :universe => 'Marvel')
@@ -199,6 +216,7 @@ class ModelSetTest < Test::Unit::TestCase
       underdog     = Superpet.create(:name => 'Underdog', :owner_id => hero.id, :species => 'dog')
 
       set = hero.pets
+
       assert_equal ['mouse', 'dog', 'dog'], set.collect {|pet| pet.species}
 
       assert_equal [sammy.id, underdog.id], set.dogs!.ids

data/test/test_helper.rb

@@ -1,13 +1,10 @@
 require 'rubygems'
 require 'test/unit'
 require 'shoulda'
-require 'mocha'
+require 'mocha/setup'
 require 'pp'
 
 $LOAD_PATH.unshift File.dirname(__FILE__) + "/../lib"
-['deep_clonable', 'ordered_set'].each do |dir|
-  $LOAD_PATH.unshift File.dirname(__FILE__) + "/../../#{dir}/lib"
-end
 require 'model_set'
 
 class Test::Unit::TestCase
@@ -16,8 +13,6 @@ end
 ActiveRecord::Base.establish_connection(
   :adapter  => "postgresql",
   :host     => "localhost",
-  :username => "postgres",
-  :password => "",
   :database => "model_set_test"
 )
 ActiveRecord::Migration.verbose = false