randumb 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd1f3d0262772918cb40ffc6f8c57bf5e841ea69
-  data.tar.gz: 4f05d46fcee8600f14f287718adeb346b7832cf2
+  metadata.gz: b7a8de94fe998a9315531dc1785ccec096ed4a7e
+  data.tar.gz: b7e3d1440cc41ecd3231f8f9cde03361414cc329
 SHA512:
-  metadata.gz: 0a713af87ffb2e625ee646dd9308876fbddb9c034d43eca825d6520bef18f8c6255d36771eafba17b770950fa4bdf17905558d4c81f1d5f542b95c12d9f714b8
-  data.tar.gz: 1c8bfdab9e93a9bb3241a82115460e5d42c320aa1ac52484d2615314b076e8e7ad81618bd0d4021f83b091ba0aebbad90d110221e5d6b1b291d19e191b4517fb
+  metadata.gz: b215658a671a55d23fa68db3807ba2f2b6b204263ecb200f1a664f2f25bb58c0137132b1a67d4bbacaebf73ab7025f5a1348c7d2c722dc9f58837fa92faf024c
+  data.tar.gz: 7ea4b738b0cca2b7544bda4a55eb0e74c0e662cab6d85a46322086ddae7fa32def04afad55e82b5cb3fec8542a86116ca0ae00551803fdcc002695e665d0316b

data/lib/randumb/relation.rb

@@ -10,36 +10,32 @@ module Randumb
       # If the max_items argument is omitted, one random entity will be returned.
       # If you provide the integer argument, you will get back an array of records.
       def random(max_items = nil, opts={})
-        random_weighted(nil, max_items, opts)
+        ActiveSupport::Deprecation.warn "The random() method will be depricated in randumb 1.0 in favor of the order_by_rand scope."
+        relation = clone
+        return random_by_id_shuffle(max_items, opts) if is_randumb_postges_case?(relation)
+        scope = relation.order_by_rand(opts)
+
+        scope = scope.limit(max_items) if override_limit?(max_items, relation)
+
+        # return first record if method was called without parameters
+        max_items ? scope.to_a : scope.first
       end
 
       # If ranking_column is provided, that named column wil be multiplied
       # by a random number to determine probability of order. The ranking column must be numeric.
       def random_weighted(ranking_column, max_items = nil, opts={})
+        ActiveSupport::Deprecation.warn "The random_weighted() method will be depricated in randumb 1.0 in favor of the order_by_rand_weighted scope."
         relation = clone
         return random_by_id_shuffle(max_items, opts) if is_randumb_postges_case?(relation, ranking_column)
         raise_unless_valid_ranking_column(ranking_column)
 
-        # get clause for current db type
-        order_clause = Randumb::Syntax.random_order_clause(ranking_column, opts.merge(connection: connection, table_name: table_name))
+        scope = relation.order_by_rand_weighted(ranking_column, opts)
 
-        the_scope = if ::ActiveRecord::VERSION::MAJOR == 3 && ::ActiveRecord::VERSION::MINOR < 2
-          # AR 3.0.0 support
-          relation.order(order_clause)
-        else
-          # keep prior orders and append random
-          all_orders = (relation.orders + [order_clause]).join(", ")
-          # override all previous orders
-          relation.reorder(all_orders) 
-        end
-        
         # 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
+        scope = scope.limit(max_items) if override_limit?(max_items, relation)
 
         # return first record if method was called without parameters
-        max_items ? the_scope.to_a : the_scope.first
+        max_items ? scope.to_a : scope.first
       end
 
 
@@ -67,14 +63,44 @@ module Randumb
         return_first_record ? records.first : records
       end
 
+      def order_by_rand(opts={})
+        build_order_scope(opts)
+      end
+
+      def order_by_rand_weighted(ranking_column, opts={})
+        raise_unless_valid_ranking_column(ranking_column)
+        is_randumb_postges_case?(self, ranking_column)
+        build_order_scope(opts, ranking_column)
+      end
+
       private
 
+      def build_order_scope(options, ranking_column=nil)
+        opts = options.reverse_merge(connection: connection, table_name: table_name)
+
+        order_clause = if ranking_column
+          Randumb::Syntax.random_weighted_order_clause(ranking_column, opts)
+        else
+          Randumb::Syntax.random_order_clause(opts)
+        end
+
+        if ::ActiveRecord::VERSION::MAJOR == 3 && ::ActiveRecord::VERSION::MINOR < 2
+          # AR 3.0.0 support
+          order(order_clause)
+        else
+          # keep prior orders and append random
+          all_orders = (orders + [order_clause]).join(", ")
+          # override all previous orders
+          reorder(all_orders)
+        end
+      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
-      def is_randumb_postges_case?(relation, ranking_column)
+      def is_randumb_postges_case?(relation, ranking_column=nil)
         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"
+            raise Exception, "order_by_rand_weighted: not possible when using .uniq and the postgres/postgis db adapter"
           else
             return true
           end
@@ -102,7 +128,6 @@ module Randumb
 
         id_results = connection.select_all(id_only_relation.to_sql)
 
-        
         rng = random_number_generator(opts)
         if max_ids == 1 && id_results.count > 0
           rand_index = rng.rand(id_results.count)
@@ -122,6 +147,10 @@ module Randumb
         end
       end
 
+      def override_limit?(max_items, relation)
+        max_items && (!relation.limit_value || relation.limit_value > max_items)
+      end
+
     end
 
 
@@ -138,6 +167,14 @@ module Randumb
       def random_by_id_shuffle(max_items = nil, opts = {})
         relation.random_by_id_shuffle(max_items, opts)
       end
+
+      def order_by_rand(opts={})
+        relation.order_by_rand(opts)
+      end
+
+      def order_by_rand_weighted(ranking_column, opts={})
+        relation.order_by_rand_weighted(ranking_column, opts)
+      end
     end
 
 
@@ -145,6 +182,7 @@ module Randumb
     module MethodMissingMagicks
       def method_missing(symbol, *args)
         if symbol.to_s =~ /^random_weighted_by_(\w+)$/
+          ActiveSupport::Deprecation.warn "Dynamic finders will be removed in randumb 1.0 http://guides.rubyonrails.org/active_record_querying.html#dynamic-finders"
           random_weighted($1, *args)
         else
           super
@@ -153,6 +191,7 @@ module Randumb
 
       def respond_to?(symbol, include_private=false)
         if symbol.to_s =~ /^random_weighted_by_(\w+)$/
+          ActiveSupport::Deprecation.warn "Dynamic finders will be removed in randumb 1.0 http://guides.rubyonrails.org/active_record_querying.html#dynamic-finders"
           true
         else
           super

data/lib/randumb/syntax.rb

@@ -3,23 +3,25 @@ module Randumb
     class << self
 
       # builds the order clause to be appended in where clause
-      def random_order_clause(ranking_column, opts={})
-        if ranking_column.nil?
-          random_for(opts)
+      def random_order_clause(opts={})
+        random_for(opts)
+      end
+
+      # builds the order clause to be appended in where clause
+      def random_weighted_order_clause(ranking_column, opts={})
+        connection = opts[:connection]
+
+        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_for(opts)} * #{multiplier}) ) DESC"
         else
-          connection = opts[:connection]
-          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_for(opts)} * #{multiplier}) ) DESC"
-          else
-            "(#{ranking_column} * #{random_for(opts)}) DESC"
-          end
+          "(#{ranking_column} * #{random_for(opts)}) DESC"
         end
       end
 
-      private 
+      private
 
       # sligtly different for each DB
       def random_for(opts)
@@ -40,7 +42,7 @@ module Randumb
         if seed = opts[:seed]
           table_name = opts[:table_name]
           # SQLLite does not support a random seed.  However, pseudo-randomness
-          # can be achieved by sorting on a hash of the id field (generated by 
+          # can be achieved by sorting on a hash of the id field (generated by
           # multiplying the id by the random seed and ignoring everything before
           # the decimal).
           # See http://stackoverflow.com/questions/2171578/seeding-sqlite-random
@@ -77,4 +79,4 @@ module Randumb
 
     end
   end
-end
+end

data/lib/randumb/version.rb

@@ -1,3 +1,3 @@
 module Randumb
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

data/test/randumb_test.rb

@@ -14,11 +14,13 @@ class RandumbTest < Test::Unit::TestCase
     # above is equivalent to:
     # assert_equal nil, Artist.random
     # assert_equal nil, Artist.random_by_id_shuffle
+    assert_nil Artist.order_by_rand.first
 
     assert_equal_for_both_methods [], Artist, 1
     # above is equivalent to:
     # assert_equal [], Artist.random(1)
     # assert_equal [], Artist.random_by_id_shuffle(1)
+    assert_equal [], Artist.order_by_rand.limit(1).all
 
     assert_equal_for_both_methods nil, Artist.limit(50)
   end
@@ -32,8 +34,11 @@ class RandumbTest < Test::Unit::TestCase
       assert_equal 1, Artist.count
 
       assert_equal_for_both_methods @high_on_fire, Artist
+      assert_equal @high_on_fire, Artist.order_by_rand.first
+
       assert_equal_for_both_methods [@high_on_fire], Artist, 1
       assert_equal_for_both_methods [@high_on_fire], Artist, 30
+      assert_equal [@high_on_fire], Artist.limit(30).order_by_rand.all
     end
 
     should "not return a record that doesnt match where" do
@@ -66,6 +71,10 @@ class RandumbTest < Test::Unit::TestCase
         assert_equal false, artists.first.name.nil?
         assert_raise (ActiveModel::MissingAttributeError) {artists.first.views}
 
+        artists = Artist.select(:name).order_by_rand.limit(3)
+        assert_equal false, artists.first.name.nil?
+        assert_raise (ActiveModel::MissingAttributeError) {artists.first.views}
+
         artists = Artist.select(:name).random_by_id_shuffle(3)
         assert_equal false, artists.first.name.nil?
         assert_raise (ActiveModel::MissingAttributeError) {artists.first.views}
@@ -73,6 +82,7 @@ class RandumbTest < Test::Unit::TestCase
 
       should "respect scopes" do
         assert_equal_for_both_methods [@fiona_apple], Artist.at_least_three_views, 3
+        assert_equal [@fiona_apple], Artist.at_least_three_views.order_by_rand.limit(3)
       end
 
       should "select only as many as in the db if we request more" do
@@ -200,6 +210,10 @@ class RandumbTest < Test::Unit::TestCase
         10.times do
           assert_equal seeded_order, Artist.random(2, seed: @seed)
         end
+
+        10.times do 
+          assert_equal seeded_order, Artist.order_by_rand(seed: @seed).limit(2)
+        end
       end
 
       should "always return the same order using shuffle method" do

data/test/test_helper.rb

@@ -59,3 +59,6 @@ class Test::Unit::TestCase
 
 end
 
+
+# Silence deprications
+ActiveSupport::Deprecation.silenced = true

data/test/weighted_test.rb

@@ -4,7 +4,7 @@ class WeightedTest < Test::Unit::TestCase
 
   should "raise exception when called with a non-existent column" do
     assert_raises(ArgumentError) do
-      Artist.random_weighted(:blah)
+      Artist.order_by_rand_weighted(:blah)
     end
     assert_raises(ArgumentError) do
       Artist.random_weighted_by_blah
@@ -13,7 +13,7 @@ class WeightedTest < Test::Unit::TestCase
 
   should "raise exception when called with a non-numeric column" do
     assert_raises(ArgumentError) do
-      Artist.random_weighted(:name)
+      Artist.order_by_rand_weighted(:name)
     end
     assert_raises(ArgumentError) do
       Artist.random_weighted_by_name
@@ -25,7 +25,7 @@ class WeightedTest < Test::Unit::TestCase
     if ENV["DB"] == "postgres"
       should "raise exception if being called with uniq/postgres" do
         assert_raises(Exception) do
-          Artist.uniq.random_weighted(:name)
+          Artist.uniq.order_by_rand_weighted(:views)
         end
       end
     else
@@ -66,6 +66,9 @@ class WeightedTest < Test::Unit::TestCase
       assert_hits_per_views do
         Artist.random_weighted("views").views
       end
+      assert_hits_per_views do 
+        Artist.order_by_rand_weighted("views").first.views
+      end
     end
 
     should "order by ranking column with method_missing" do
@@ -80,6 +83,12 @@ class WeightedTest < Test::Unit::TestCase
         assert(result.size == 5)
         result.first.views
       end
+
+      assert_hits_per_views do 
+        result = Artist.order_by_rand_weighted("views").limit(5).all
+        assert(result.size == 5)
+        result.first.views
+      end
     end
 
     should "order by ranking column with method_missing using max_items" do
@@ -98,6 +107,14 @@ class WeightedTest < Test::Unit::TestCase
           result.last.views
         end
       end
+
+      assert_raises(MiniTest::Assertion) do
+        assert_hits_per_views do
+          result = Artist.order_by_rand_weighted(:views).limit(3)
+          assert(result.size == 3)
+          result.last.views
+        end
+      end
     end
 
     should "order by ranking column with method_missing using 1 max_items" do
@@ -106,6 +123,12 @@ class WeightedTest < Test::Unit::TestCase
         assert(result.size == 1)
         result.first.views
       end
+
+      assert_hits_per_views do
+        result = Artist.order_by_rand_weighted(:views).limit(1)
+        assert(result.size == 1)
+        result.first.views
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: randumb
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Zachary Kloepping
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-17 00:00:00.000000000 Z
+date: 2014-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake