quick_random_records 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2bb0588241c2d513e8bbb2ae843cc2b67f6c4bf0
-  data.tar.gz: cd5da0a147961a9c9ece4bd8a81610fcd21077e6
+  metadata.gz: a73a46ab4437ecf9169db037cc018ba179bc36ba
+  data.tar.gz: 9b068b8a67f71f9b88d91e5112937fc23118b6bb
 SHA512:
-  metadata.gz: 37b792a2d9a89aa3c6441be805c8174e5a8c8311fafffde4a00f1e6aa3a6f3e3006da0a79e45d7ae8c2780538e7f0c4325b73d6a7c7592f2dcdf565e147806b3
-  data.tar.gz: 38ec1f3608797b7b6c699904212d967ac4bc618ad1fd06dd74d3ec2c90ae84072941398971ab3d819f4e9c7cafeee7b696d9d15a8bfc3531db1c805ff7c53628
+  metadata.gz: b2a2f477ee383c8fc66fc6557899d9d3849215428b4098af9ad25489d332e4cd842390b4074e9e81a345a69b2d030733d52ea7ac46654728396592472b45cc84
+  data.tar.gz: 34e3a955bedd78e1393a23a54626b07093663da1a78bb8dc2796c91a984388ff801f0986a2663c48aa286a010e0aacf87dc9b606435f3aa6f7d94f5f99dbbd03

data/README.md

@@ -1,6 +1,6 @@
 ## QuickRandomRecords
 
-`quick_random_records` is a Ruby Gem that empowers ActiveRecord Models with the ability to return random records dramatically fast.
+`quick_random_records` is a Ruby Gem that empowers ActiveRecord Models with the ability to return random records dramatically fast, even with table that has a lot of data rows.
 
 ## Installation
 
@@ -45,22 +45,49 @@ Scenario: query 100 random records from table with 550,000 data rows.
 ## Fine-tuning
 
 This strategy is fast because:
-(1) Instead of plucking all ids in the table, it selects ids bewteen min_id and max_id.
+
+(1) Instead of plucking all id in the table, it selects id bewteen min_id and max_id.
     Then make complements if any missing records (id between min_id and max_id, but not exist in db). 
-(2) 
 
+(2) It select id 1.25 times more than required. So that it doesn't need to perform another query to make complements.
+    And of course, it will truncate to the required number before method return.
+    
+   You can configure your own multiply, which is 1.25 by default.
+   EX: My table has 10% deleted records, so multiply 1.1 will maximum the speed of random_records. 
+    
+ ```ruby
+ # select 1.1 times more than required, that is 110 here. 
+ # And it will truncate to 100 before method return.
+    
+ users = User.random_records(100, multiply: 1.1) 
+ ```
+   
 ## Drawback
 
 This strategy works extremely well with table that has a lot of records and few deleted records.
 
 But for tables with a lot of deleted records (ex: 8 deleted reocrds out of 10 records),
-it may return fewer random records as expected since I limit the loop it searchs for complements.
+it may return fewer random records as required since I limit the loop searching for complements.
 
 The default `loop_limit` is `3`. You can configure your own `loop_limit` for searching complements.
 ```ruby
 users = User.random_records(100, loop_limit: 5)
 ```
 
+or 
+
+You can use other strategy for tables with a lot of deleted records.
+
+`Model.order("RAND()").limit(num)` is strategy 2
+```ruby
+users = User.random_records(100, strategy: 2)
+```
+
+`Model.where(id: Model.pluck(:id).sample(num))` is strategy 3
+```ruby
+users = User.random_records(100, strategy: 3)
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/quick_random_records/version.rb

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

data/lib/quick_random_records.rb

@@ -2,7 +2,7 @@ require 'quick_random_records/version'
 require 'active_record'
 
 class ActiveRecord::Base
-  def self.random_records(quantity, strategy: 1, multiply: 1.25, loop_limit: 3)
+  def self.random_records(quantity, strategy: 1, multiply: 1.05, loop_limit: 3)
     case strategy
     when 1
       self.sample_complement_records(quantity, multiply, loop_limit)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quick_random_records
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - derekfan