random_order 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85869c402378af9d2b328e80a04f2324bf044ffbabbaed80909e52f37ba3957f
-  data.tar.gz: 5d6ee714b7f0311a88f7ed34134b655dec57ece3543e8a9e1c26ce5468ef4917
+  metadata.gz: 44c17e681b84961986ec40faa61117db2eebe889be510822c905bbed642cffa1
+  data.tar.gz: 6c180250b563a70cff7aaca0aca869cc845e06a67a9e8f99217b8c18cec99d06
 SHA512:
-  metadata.gz: 6b02bb4634682f6872a708be802b7f44b1bafa9ce72a876c6a29f57bb5154653608d609519f1045e67d4f8082c7f23619ed66f826ac947f735f1d8f7c66ba536
-  data.tar.gz: 85796b4d178f8ea035773829df8b8a7a7f8e15bd5f632f7ab01b204f479b44d91b630810e5a34d04262dd761d7eca6ee7c317400b5439bef2acf691ce4e875e2
+  metadata.gz: 4284befb9765296e151379f4ab765bcfbae71168e2625f2367af371d862f3673c829dbbe33cfb0bd11f94816a4e86afc9ffca468326c7f958efbc2bcf22be672
+  data.tar.gz: a40069226504d3f50a353d146735a6fe00c1e71e49d683146fca0538463e5ed713a9f7e5e3fc0e8bc8aa5e220719a411c0adff87fcb7a35627cd9b6ffad72f22

data/README.md

@@ -1,10 +1,10 @@
 # RandomOrder
-This gem could DRY your code and return random relation objects or instance object.
+With this gem, you can return a random record from the database using SQL or use `random scope` to return records in random order.
 
 ## Usage
-Works with `MySQL`, `SQLite`, `PostgreSQL`
+Works with `MySQL`, `SQLite`, `PostgreSQL`.
 
-This gem is adding three methods to ActiveRecord Relations - `random` , `find_random` and `find_many_random(...)`.
+This gem is adding three methods to ActiveRecord Relations - `random` , `find_random` and `find_many_random(...)`, `fast_random(n = 1)`.
 
 You can do the following:
 ```ruby
@@ -12,19 +12,44 @@ u1 = User.create(name: 'Lilith')
 u2 = User.create(name: 'Metamorph')
 u3 = User.create(name: 'Diablo')
 
-assert_equal User.find_random.is_a?(User), true
 assert_equal User.random.is_a?(ActiveRecord::Relation), true
 assert_equal User.find_many_random(10).is_a?(ActiveRecord::Relation), true
+assert_equal User.fast_random.is_a?(ActiveRecord::Relation), true
+assert_equal User.find_random.is_a?(User), true
+```
+## Fast Random method
+As you may know `order by RANDOM()` might be slow in case you have many records in DB. I think the case I suggest to use another method which is bundled with this gem fast_random which is using another SQL to return random records from DB. It has some limitations like your table must have a primary key column.
+Simple benchmark on the table with `88000 records` shows that it's `20` times faster. See screenshot with logs below:
+
+```ruby
+n = 10
+Benchmark.bm do |benchmark|
+  benchmark.report("find_many_random(100)") do
+    n.times do
+      Business.find_many_random(100).to_a
+    end
+  end
+  benchmark.report("fast_random(100)") do
+    n.times do
+      Business.fast_random(100).to_a
+    end
+  end
+end
+#
+                         user     system      total        real
+find_many_random(100)  0.088990   0.025837   0.114827 ( 13.836576)
+fast_random(100)       0.060209   0.013933   0.074142 (  0.699557)
 ```
+
 #### Examples:
 ```ruby
 User.friends.random # return ActiveRecord::Relation with user`s random friends
 User.find_random.friends.random # return ActiveRecord::Relation with random user`s random friends
 Post.published.random.limit(3) # return ActiveRecord::Relation with 3 published posts
 Post.published.find_many_random(3) # --//--
+Post.published.fast_random(3) # --//-- and faster
 ```
 
-
 ## Installation
 Add this line to your application's Gemfile:
 
@@ -42,8 +67,16 @@ Or install it yourself as:
 $ gem install random_order
 ```
 
+# TODO
+- `oracle` adapter
+- `sqlserver` adapter
+- `MongoDB` with `Mongoid`
+
 ## Contributing
 Contribution directions go here.
 
+### Source
+`https://rubygems.org/gems/random_order`
+
 ## License
 The gem is available as open-source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/random_order/railtie.rb

@@ -4,7 +4,7 @@ module RandomOrder
   class Railtie < ::Rails::Railtie
     include Extension
 
-    initializer 'RandomOrder.initialize' do
+     config.before_initialize do
       if RandomOrder.const_defined?("ActiveRecord")
         ActiveRecord::Base.send :extend, Extension
       end

data/lib/random_order/random_order/extension.rb

@@ -9,13 +9,14 @@ module RandomOrder
     end
 
     def random
-      case RandomOrder.adapter
-      when 'mysql2'
-        self.order(Arel.sql('RAND()'))
-      when 'postgresql'
-        self.order(Arel.sql('RANDOM()'))
-      when 'sqlite3'
-        self.order(Arel.sql('RANDOM()'))
+      self.order(RandomOrder.order_func)
+    end
+
+    def fast_random(n = 1)
+      if self.primary_key.present?
+        RandomOrder.sql_query_string(self, n)
+      else
+        random.limit(n)
       end
     end
   end

data/lib/random_order/version.rb

@@ -1,3 +1,3 @@
 module RandomOrder
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/lib/random_order.rb

@@ -1,13 +1,25 @@
 require "random_order/railtie"
 
 module RandomOrder
+  ORDERS = Hash.new(Arel.sql('RANDOM()')).update({"mysql2" => Arel.sql('RAND()')})
+
   def self.adapter
-    @@adapter ||= detect_adapter
+    @@adapter ||= begin
+      if self.const_defined?("ActiveRecord")
+        ActiveRecord::Base.configurations[Rails.env]['adapter']
+      end
+    end
   end
 
-  def self.detect_adapter
-    if self.const_defined?("ActiveRecord")
-      ActiveRecord::Base.configurations[Rails.env]['adapter']
-    end
+  def RandomOrder.order_func
+    ORDERS[adapter]
+  end
+
+  def self.sql_query_string(model, n)
+    model.from(
+      "(SELECT * FROM #{model.table_name}, ( SELECT #{model.primary_key} AS sid "\
+      "FROM #{model.table_name} ORDER BY #{RandomOrder.order_func} LIMIT #{n} ) tmp WHERE "\
+      "#{model.table_name}.#{model.primary_key} = tmp.sid) as #{model.table_name}"
+    )
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: random_order
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Vitalii Kasianchuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-20 00:00:00.000000000 Z
+date: 2020-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -66,7 +66,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Find random record in your models, just to DRY your code.
+description: With this gem you can return a random record from database using SQL
+  or using `randomscope` to return records in random order
 email:
 - kasvit93@gmail.com
 executables: []
@@ -103,5 +104,6 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Find random record in your models, just to DRY your code.
+summary: This gem is adding three methods to ActiveRecord Relations - `random` , `find_random`
+  and `find_many_random(...)`.
 test_files: []