randumb 0.4.0 → 0.4.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    OTI0OTBlMWNhNTc3MWQxYzU5MDM0YzAwNmM5NWI3OTFmNzhlYzA0Nw==
-  data.tar.gz: !binary |-
-    YzNlMmUzYTA3ZDRmZDI4ZmE5YTIyMzFiMGNlMTA2ZDNiMjRjZDFjNQ==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    OTkzMmIzZmQ1ZDg0YjhjYmFiODhhNDRhZWFkN2RkNzdjYTQ4NTE5ZDgzOTIx
-    NTY4NTk4YjVhOTZmMTFhNWJlZjM5Zjg0OGE3YzMyNmFmM2QwZDA1ZDRjYTY3
-    YTRmYzVkNjExY2UwMTc4MDBhZWFmZjFjNzkzYTgwMzI2MjQzYjM=
-  data.tar.gz: !binary |-
-    OWJjZjUzODMzOWY2MWYwZWU1YWQzZDAxMWNkOWYyM2E3ZTQyZTNmMmE4ODI4
-    ZjY4NjE5ZjBjMzkyNDFmZTFhZWJlMGQ4YWNlOTg2YjdiNzA3M2NmNzhhNGZj
-    ZDUzMTZjNjgwYTI3ZWYzNjE0MDdkMWNmNjNlOWY4MGQ0ZWU2ZWY=
+SHA1:
+  metadata.gz: fd1f3d0262772918cb40ffc6f8c57bf5e841ea69
+  data.tar.gz: 4f05d46fcee8600f14f287718adeb346b7832cf2
+SHA512:
+  metadata.gz: 0a713af87ffb2e625ee646dd9308876fbddb9c034d43eca825d6520bef18f8c6255d36771eafba17b770950fa4bdf17905558d4c81f1d5f542b95c12d9f714b8
+  data.tar.gz: 1c8bfdab9e93a9bb3241a82115460e5d42c320aa1ac52484d2615314b076e8e7ad81618bd0d4021f83b091ba0aebbad90d110221e5d6b1b291d19e191b4517fb

data/lib/randumb.rb

@@ -1,4 +1,5 @@
 require 'randumb/version'
+require 'randumb/syntax'
 require 'randumb/relation'
 
 # Mix it in

data/lib/randumb/relation.rb

@@ -9,18 +9,19 @@ 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)
-        random_weighted(nil, max_items)
+      def random(max_items = nil, opts={})
+        random_weighted(nil, max_items, opts)
       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)
+      def random_weighted(ranking_column, max_items = nil, opts={})
         relation = clone
-        return random_by_id_shuffle(max_items) if is_randumb_postges_case?(relation, ranking_column)
+        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 = random_order_clause(ranking_column)
+        order_clause = Randumb::Syntax.random_order_clause(ranking_column, opts.merge(connection: connection, table_name: table_name))
 
         the_scope = if ::ActiveRecord::VERSION::MAJOR == 3 && ::ActiveRecord::VERSION::MINOR < 2
           # AR 3.0.0 support
@@ -45,11 +46,11 @@ module Randumb
       # 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)
+      def random_by_id_shuffle(max_items = nil, opts={})
         return_first_record = max_items.nil? # see return switch at end
         max_items ||= 1
         relation = clone
-        ids = fetch_random_ids(relation, max_items)
+        ids = fetch_random_ids(relation, max_items, opts)
 
         # build new scope for final query
         the_scope = klass.includes(includes_values)
@@ -58,8 +59,9 @@ module Randumb
         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!
+        # passed to where() isn't retained in the result set
+        rng = random_number_generator(opts)
+        records = the_scope.where(:id => ids).shuffle!(:random => rng)
 
         # return first record if method was called without parameters
         return_first_record ? records.first : records
@@ -88,36 +90,9 @@ module Randumb
         end
       end
 
-      # sligtly different for each DB
-      def random_syntax
-        if connection.adapter_name =~ /(sqlite|postgres|postgis)/i
-          "RANDOM()"
-        elsif connection.adapter_name =~ /mysql/i
-          "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
-
-      # builds the order clause to be appended in where clause
-      def random_order_clause(ranking_column)
-        if ranking_column.nil?
-          random_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(#{random_syntax} * #{multiplier}) ) DESC"
-          else
-            "(#{ranking_column} * #{random_syntax}) DESC"
-          end
-        end
-      end
-
       # 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)
+      def fetch_random_ids(relation, max_ids, opts={})
         # clear these for our id only query
         relation.select_values = []
         relation.includes_values = []
@@ -127,12 +102,23 @@ 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
-          [ id_results[ rand(id_results.count) ]['id'] ]
+          rand_index = rng.rand(id_results.count)
+          [ id_results[ rand_index ]['id'] ]
         else
           # ActiveRecord 4 requires .to_ary
           arr = id_results.respond_to?(:to_ary) ? id_results.to_ary : id_results
-          arr.shuffle![0,max_ids].collect!{ |h| h['id'] }
+          arr.shuffle!(:random => rng)[0,max_ids].collect!{ |h| h['id'] }
+        end
+      end
+
+      def random_number_generator(opts={})
+        if seed = opts[:seed]
+          Random.new(seed)
+        else
+          Random.new
         end
       end
 
@@ -141,16 +127,16 @@ module Randumb
 
     # Class methods
     module Base
-      def random(max_items = nil)
-        relation.random(max_items)
+      def random(max_items = nil, opts = {})
+        relation.random(max_items, opts)
       end
 
-      def random_weighted(ranking_column, max_items = nil)
-        relation.random_weighted(ranking_column, max_items)
+      def random_weighted(ranking_column, max_items = nil, opts = {})
+        relation.random_weighted(ranking_column, max_items, opts)
       end
 
-      def random_by_id_shuffle(max_items = nil)
-        relation.random_by_id_shuffle(max_items)
+      def random_by_id_shuffle(max_items = nil, opts = {})
+        relation.random_by_id_shuffle(max_items, opts)
       end
     end
 

data/lib/randumb/syntax.rb

@@ -0,0 +1,80 @@
+module Randumb
+  class Syntax
+    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)
+        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
+        end
+      end
+
+      private 
+
+      # sligtly different for each DB
+      def random_for(opts)
+        connection = opts[:connection]
+        adapter_name = connection.adapter_name
+        if adapter_name =~ /(sqlite)/i
+          random_for_sqlite(opts)
+        elsif adapter_name =~ /(postgres|postgis)/i
+          random_for_postgres(opts)
+        elsif adapter_name =~ /mysql/i
+          random_for_mysql(opts)
+        else
+          raise Exception, "ActiveRecord adapter: '#{adapter_name}' not supported by randumb.  Send a pull request or open a ticket: https://github.com/spilliton/randumb"
+        end
+      end
+
+      def random_for_sqlite(opts)
+        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 
+          # multiplying the id by the random seed and ignoring everything before
+          # the decimal).
+          # See http://stackoverflow.com/questions/2171578/seeding-sqlite-random
+          seed_value = Random.new(seed.to_i).rand
+          "(SUBSTR(#{table_name}.id * #{seed_value}, LENGTH(#{table_name}.id) + 2))"
+        else
+          "RANDOM()"
+        end
+      end
+
+      def random_for_postgres(opts)
+        # Postgres random seeding requires executing an extra "SELECT SETSEED(value)" on the connection.
+        # See http://www.postgresql.org/docs/8.3/static/sql-set.html:
+        #
+        #     Sets the internal seed for the random number generator (the
+        #     function random). Allowed values are floating-point numbers
+        #     between 0 and 1, which are then multiplied by 2^(31)-1.
+        #
+        if seed = opts[:seed]
+          connection = opts[:connection]
+          seed_value = Random.new(seed.to_i).rand # map integer seed to a value: 0 <= value < 1
+          connection.execute "SELECT SETSEED(#{seed_value})"
+        end
+        "RANDOM()"
+      end
+
+      def random_for_mysql(opts)
+        if seed = opts[:seed]
+          "RAND(#{seed.to_i})"
+        else
+          "RAND()"
+        end
+      end
+
+    end
+  end
+end

data/lib/randumb/version.rb

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

data/test/randumb_test.rb

@@ -2,12 +2,11 @@ $:.unshift '.'; require File.dirname(__FILE__) + '/test_helper'
 
 class RandumbTest < Test::Unit::TestCase
 
-  def assert_equal_for_both_methods(expected, obj, params = nil)
-    assert_equal expected, obj.send(:random, params), "when calling random"
-    assert_equal expected, obj.send(:random_by_id_shuffle, params), "when calling random_by_id_shuffle"
+  def assert_equal_for_both_methods(expected, obj, *params)
+    assert_equal expected, obj.send(:random, *params), "when calling random"
+    assert_equal expected, obj.send(:random_by_id_shuffle, *params), "when calling random_by_id_shuffle"
   end
 
-
   should "should return empty when no record in table" do
     assert_equal 0, Artist.count
 
@@ -190,6 +189,25 @@ class RandumbTest < Test::Unit::TestCase
       assert order1_found
       assert order2_found
     end
-  end
 
+    context "using seed" do
+      setup do
+        @seed = 123
+      end
+
+      should "always return the same order using default method" do
+        seeded_order = Artist.random(2, seed: @seed)
+        10.times do
+          assert_equal seeded_order, Artist.random(2, seed: @seed)
+        end
+      end
+
+      should "always return the same order using shuffle method" do
+        seeded_order = Artist.random_by_id_shuffle(2, seed: @seed)
+        10.times do
+          assert_equal seeded_order, Artist.random_by_id_shuffle(2, seed: @seed)
+        end
+      end
+    end
+  end
 end

data/test/test_helper.rb

@@ -6,16 +6,10 @@ require 'factory_girl'
 require 'faker'
 require 'active_record'
 require 'active_support/dependencies'
-require 'active_support/core_ext/logger'
-# require 'active_record/fixtures'
 require 'randumb'
 
 MODELS_PATH = File.join(File.dirname(__FILE__), 'models')
 
-
-ActiveRecord::Base.logger = Logger.new(STDERR)
-ActiveRecord::Base.logger.level = Logger::WARN
-
 config = YAML::load(File.open(File.expand_path("../databases.yml", __FILE__)))
 version = ActiveRecord::VERSION::STRING
 driver = (ENV["DB"] or "sqlite3").downcase

data/test/weighted_test.rb

@@ -107,20 +107,20 @@ class WeightedTest < Test::Unit::TestCase
         result.first.views
       end
     end
+  end
 
-    def assert_hits_per_views
-      hits_per_views = Hash.new
-      @view_counts.each { |views| hits_per_views[views] = 0 }
-      
-      1000.times do
-        hits_per_views[yield] += 1
-      end
-      last_count = 0
-      @view_counts.each do |views|
-        hits = hits_per_views[views]
-        assert(hits >= last_count, "#{hits} > #{last_count} : There were an unexpected number of visits: #{hits_per_views.to_yaml}")
-        last_count = hits
-      end
+  def assert_hits_per_views
+    hits_per_views = Hash.new
+    @view_counts.each { |views| hits_per_views[views] = 0 }
+    
+    1000.times do
+      hits_per_views[yield] += 1
+    end
+    last_count = 0
+    @view_counts.each do |views|
+      hits = hits_per_views[views]
+      assert(hits >= last_count, "#{hits} > #{last_count} : There were an unexpected number of visits: #{hits_per_views.to_yaml}")
+      last_count = hits
     end
   end
 

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: randumb
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Zachary Kloepping
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-20 00:00:00.000000000 Z
+date: 2013-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
@@ -70,14 +70,14 @@ dependencies:
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -98,14 +98,14 @@ dependencies:
   name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -115,6 +115,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/randumb/relation.rb
+- lib/randumb/syntax.rb
 - lib/randumb/version.rb
 - lib/randumb.rb
 - test/models/album.rb
@@ -133,17 +134,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
 summary: Adds the ability to pull random records from ActiveRecord