randumb 0.3.0 → 0.3.1

data/lib/randumb/relation.rb

@@ -4,7 +4,7 @@ require 'active_record/relation'
 module Randumb
   # https://github.com/rails/rails/blob/master/activerecord/lib/active_record/relation/query_methods.rb
   module ActiveRecord
-    
+
     module Relation
 
       # If the max_items argument is omitted, one random entity will be returned.
@@ -17,110 +17,116 @@ module Randumb
       # by a random number to determine probability of order. The ranking column must be numeric.
       def random_weighted(ranking_column, max_items = nil)
         relation = clone
+        return random_by_id_shuffle(max_items) if is_randumb_postges_case?(relation, ranking_column)
+        raise_unless_valid_ranking_column(ranking_column)
+
+        order_clause = random_order_clause(ranking_column)
+        the_scope = relation.order(order_clause)
+
+        # override the limit if they are requesting multiple records
+        if max_items && (!relation.limit_value || relation.limit_value > max_items)
+          the_scope = the_scope.limit(max_items)
+        end
+
+        # return first record if method was called without parameters
+        max_items ? the_scope.all : the_scope.first
+      end
+
+
+      # This was my first implementation, adding it as an option for people to use
+      # and to fall back on for pesky DB one off situations...
+      #    https://github.com/spilliton/randumb/issues/7
+      def random_by_id_shuffle(max_items = nil)
+        return_first_record = max_items.nil? # see return switch at end
+        max_items ||= 1
+        relation = clone
+        ids = fetch_random_ids(relation, max_items)
+
+        # build new scope for final query
+        the_scope = klass.includes(includes_values)
+
+        # specifying empty selects caused bug in rails 3.0.0/3.0.1
+        the_scope = the_scope.select(select_values) unless select_values.empty?
+
+        # get the records and shuffle since the order of the ids
+        # passed to find_all_by_id isn't retained in the result set
+        records = the_scope.find_all_by_id(ids).shuffle!
+
+        # return first record if method was called without parameters
+        return_first_record ? records.first : records
+      end
 
-        # postgres won't let you do an order_by when also doing a distinct
-        # let's just use the in-memory option in this case
-        if relation.uniq_value && connection.adapter_name =~ /postgres/i
-          if ranking_column 
-            raise Exception, "random_weighted: not possible when using .uniq and the postgres db adapter"
+      private
+
+      # postgres won't let you do an order_by when also doing a distinct
+      # let's just use the in-memory option in this case
+      def is_randumb_postges_case?(relation, ranking_column)
+        if relation.respond_to?(:uniq_value) && relation.uniq_value && connection.adapter_name =~ /(postgres|postgis)/i
+          if ranking_column
+            raise Exception, "random_weighted: not possible when using .uniq and the postgres/postgis db adapter"
           else
-            return random_by_id_shuffle(max_items)
+            return true
           end
         end
+      end
 
-        # ensure a valid column for ranking
+      # columns used for ranking must be a numeric type b/c they are multiplied
+      def raise_unless_valid_ranking_column(ranking_column)
         if ranking_column
           column_data = @klass.columns_hash[ranking_column.to_s]
           raise ArgumentError.new("random_weighted: #{ranking_column} is not a column on #{@klass.table_name}!") unless column_data
           raise ArgumentError.new("random_weighted: #{ranking_column} is not a numeric column on #{@klass.table_name}!") unless [:integer, :float].include?(column_data.type)
         end
+      end
 
-        # choose the right syntax
-        if connection.adapter_name =~ /(sqlite|postgres)/i
-          rand_syntax = "RANDOM()"
+      # sligtly different for each DB
+      def random_syntax
+        if connection.adapter_name =~ /(sqlite|postgres|postgis)/i
+          "RANDOM()"
         elsif connection.adapter_name =~ /mysql/i
-          rand_syntax = "RAND()"
+          "RAND()"
         else
           raise Exception, "ActiveRecord adapter: '#{connection.adapter_name}' not supported by randumb.  Send a pull request or open a ticket: https://github.com/spilliton/randumb"
         end
+      end
 
-        order_clause =  if ranking_column.nil?
-                          rand_syntax
-                        else
-                          if connection.adapter_name =~ /sqlite/i
-                            # computer multiplication is faster than division I was once taught...so translate here
-                            max_int = 9223372036854775807.0
-                            multiplier = 1.0 / max_int 
-                            "(#{ranking_column} * ABS(#{rand_syntax} * #{multiplier}) ) DESC"
-                          else
-                            "(#{ranking_column} * #{rand_syntax}) DESC"
-                          end
-                        end
-
-        the_scope = relation.order(order_clause)
-
-        # override the limit if they are requesting multiple records
-        if max_items && (!relation.limit_value || relation.limit_value > max_items)
-          the_scope = the_scope.limit(max_items)
-        end
-
-        # return first record if method was called without parameters
-        if max_items.nil?
-          the_scope.first
+      # builds the order clause to be appended in where clause
+      def random_order_clause(ranking_column)
+        if ranking_column.nil?
+          random_syntax
         else
-          the_scope.all
+          if connection.adapter_name =~ /sqlite/i
+            # computer multiplication is faster than division I was once taught...so translate here
+            max_int = 9223372036854775807.0
+            multiplier = 1.0 / max_int
+            "(#{ranking_column} * ABS(#{random_syntax} * #{multiplier}) ) DESC"
+          else
+            "(#{ranking_column} * #{random_syntax}) DESC"
+          end
         end
       end
 
-
-      # This was my first implementation, adding it as an option for people to use
-      # and to fall back on for pesky DB one off situations...
-      #  https://github.com/spilliton/randumb/issues/7
-      def random_by_id_shuffle(max_items = nil)
-        return_first_record = max_items.nil?# see return switch at end
-        max_items ||= 1
-        relation = clone
-      
-        # store these for including on final scope
-        original_includes = relation.includes_values
-        original_selects = relation.select_values
-        
+      # Returns all matching ids from the db, shuffles them,
+      # then returns an array containing at most max_ids
+      def fetch_random_ids(relation, max_ids)
         # clear these for our id only query
         relation.select_values = []
         relation.includes_values = []
-      
+
         # do original query but only for id field
         id_only_relation = relation.select("#{table_name}.id")
         id_results = connection.select_all(id_only_relation.to_sql)
-      
-        # get requested number of random ids
-        if max_items == 1 && id_results.length > 0
-          ids = [ id_results[ rand(id_results.length) ]['id'] ]
-        else
-          ids = id_results.shuffle![0,max_items].collect!{ |h| h['id'] }
-        end
-  
-        # build scope for final query
-        the_scope = klass.includes(original_includes)
-
-        # specifying empty selects caused bug in rails 3.0.0/3.0.1
-        the_scope = the_scope.select(original_selects) unless original_selects.empty? 
 
-        # get the records and shuffle since the order of the ids
-        # passed to find_all_by_id isn't retained in the result set
-        records = the_scope.find_all_by_id(ids).shuffle!
-                
-        # return first record if method was called without parameters
-        if return_first_record
-          records.first
+        if max_ids == 1 && id_results.length > 0
+          ids = [ id_results[ rand(id_results.length) ]['id'] ]
         else
-          records
+          ids = id_results.shuffle![0,max_ids].collect!{ |h| h['id'] }
         end
       end
 
-    end 
+    end
+
 
-    
     # Class methods
     module Base
       def random(max_items = nil)
@@ -134,7 +140,7 @@ module Randumb
       def random_by_id_shuffle(max_items = nil)
         relation.random_by_id_shuffle(max_items)
       end
-    end 
+    end
 
 
     # These get registered as class and instance methods
@@ -157,4 +163,4 @@ module Randumb
     end
 
   end # ActiveRecord
-end # Randumb
+end # Randumb

data/lib/randumb/version.rb

@@ -1,3 +1,3 @@
 module Randumb
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/test/randumb_test.rb

@@ -139,12 +139,14 @@ class RandumbTest < Test::Unit::TestCase
           assert_equal true, albums.include?(@sixty_nine_love_songs)
         end
 
-        should "work with uniq" do
-          assert_equal 2, Artist.uniq.random(2).length
-          assert_equal 2, Artist.uniq.random_by_id_shuffle(2).length
-
-          assert_not_nil Artist.uniq.random
-          assert_not_nil Artist.uniq.random_by_id_shuffle
+        # ActiveRecord 3.0 does not have this
+        if Artist.respond_to?(:uniq)
+          should "work with uniq" do
+            assert_equal 2, Artist.uniq.random(2).length
+            assert_equal 2, Artist.uniq.random_by_id_shuffle(2).length
+            assert_not_nil Artist.uniq.random
+            assert_not_nil Artist.uniq.random_by_id_shuffle
+          end
         end
 
       end

data/test/weighted_test.rb

@@ -20,15 +20,18 @@ class WeightedTest < Test::Unit::TestCase
     end
   end
 
-  if ENV["DB"] == "postgres"
-    should "raise exception if being called with uniq/postgres" do
-      assert_raises(Exception) do
-        Artist.uniq.random_weighted(:name)
+  # ActiveRecord 3.0 doesnt have uniq scope
+  if Artist.respond_to?(:uniq)
+    if ENV["DB"] == "postgres"
+      should "raise exception if being called with uniq/postgres" do
+        assert_raises(Exception) do
+          Artist.uniq.random_weighted(:name)
+        end
+      end
+    else
+      should "work with uniq if not postgres" do
+        assert_nil Artist.uniq.random_weighted_by_views
       end
-    end
-  else
-    should "work with uniq if not postgres" do
-      assert_nil Artist.uniq.random_weighted_by_views
     end
   end
 

metadata

@@ -2,7 +2,7 @@
 name: randumb
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Zachary Kloepping
@@ -10,21 +10,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-07 00:00:00 Z
+date: 2013-01-19 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activesupport
+  name: rake
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 3.0.0
+        version: "0"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: activerecord
+  name: activesupport
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -35,25 +35,25 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rake
+  name: activerecord
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 3.0.0
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: pg
+  name: sqlite3
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 1.3.5
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency