active_record_samplooper 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93d485e74aa6069680edeb330cc7ce8c4c8a376c
-  data.tar.gz: ab4b473a2b67acc840bbbf937af758f49e0b82b0
+  metadata.gz: 7a6fc2ce8bdbe8e29e1c01a4d10244b54cc105e6
+  data.tar.gz: ccdc37e1c5d8f6307e405efdfda20b3fd0068b8a
 SHA512:
-  metadata.gz: 360c1d888bbf00a5704752c3e7c75a641e9f33286612c847bf59cee523d39e90ef4d5706d3571760d29c51c3c557bd088e9f228be2c46d33b84c8d7b5af557db
-  data.tar.gz: a5621a045cf40a4cc1d1fbe504e0d68cb4a8a771cbc7e2c28d7ea548670e44126141be7f37a9db7cc7fd93588d5521dc1d76802526e015565cf89ce2dd7afd7c
+  metadata.gz: 338b2826f9e46c468e7849b658344531e81b625e549ab1848756b71d8170e0b2dbce2991f5dab58f99bfcc94c02b085f81b455ede0b32746f3c9d3b6f9274824
+  data.tar.gz: 2ed837bad209238a913e839abdb5326512f511327dbb52f48e65f0b5812f7b4cbb55dff3aebc4651d4e1b36d49c8f027609404b9c22f390ddd4c6ce076bbf11f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    active_record_samplooper (0.0.3)
+    active_record_samplooper (0.0.6)
       rails (~> 4.2.1)
 
 GEM

data/README.md

@@ -1,2 +1,121 @@
 [![Build Status](https://travis-ci.org/mmmpa/active_record_samplooper.svg)](https://travis-ci.org/mmmpa/active_record_samplooper)
-[![Coverage Status](https://coveralls.io/repos/mmmpa/yorisoi/badge.svg?branch=master)](https://coveralls.io/r/mmmpa/active_record_samplooper?branch=master)
+[![Coverage Status](https://coveralls.io/repos/mmmpa/yorisoi/badge.svg?branch=master)](https://coveralls.io/r/mmmpa/active_record_samplooper?branch=master)
+
+# ActiveRecordSamplooper
+
+ActiveRecordSamplooperはArray#sampleをActiveRecordでもやりたくて書かれました。
+
+おもにテストデータ作成に使っています。
+
+```ruby
+SampleModel.sample
+=> #<SampleModel:0x007ff4e2077068 id: 40, ast_name: "松尾", first_name: "寛治", last_name_reading: "まつお", first_name_reading: "かんじ", email: "matsuo_kanji@example.com", gender: "male", age: 74, birth: Wed, 26 Jun 1940, tel: "090-">
+```
+あるいは
+```ruby
+SampleModel.sample(3)
+=> [
+  #<SampleModel:0x007fb73ec99030  id: 16,  last_name: "七瀬",  first_name: "希",  last_name_reading: "ななせ",  first_name_reading: "のぞみ",  email: "nanase_nozomi@example.com",  gender: "female",  age: 64,  birth: Tue, 23 Jan 1951,  tel: "080-9991-7001">,
+  #<SampleModel:0x007fb73d78c9f8  id: 29,  last_name: "長谷部",  first_name: "樹里",  last_name_reading: "はせべ",  first_name_reading: "じゅり",  email: "hasebe_juri@example.com",  gender: "female",  age: 43,  birth: Sat, 09 Oct 1971,  tel: "090-4943-9297">,
+  #<SampleModel:0x007fb73d786d00  id: 29,  last_name: "長谷部",  first_name: "樹里",  last_name_reading: "はせべ",  first_name_reading: "じゅり",  email: "hasebe_juri@example.com",  gender: "female",  age: 43,  birth: Sat, 09 Oct 1971,  tel: "090-4943-9297">
+]
+```
+`where`で絞って
+```ruby
+SampleModel.where(gender: :male).sample(10).map{|m| [m.first_name, m.gender].join(' : ')}
+=> ["洋介 : male", "勇一 : male", "良介 : male", "晃司 : male", "仁晶 : male", "良介 : male", "一樹 : male", "明 : male", "禄郎 : male", "晃司 : male"]
+```
+ただしダイレクトに`sample`するより(Samplooper)[#Samplooper]を介した方がよさそう。
+
+## Installation
+```ruby
+gem 'active_record_samplooper'
+```
+    $ bundle install
+
+## Usage
+
+`Samplooper`を介すと軽かったり多少便利だったりします。
+
+***
+
+### Samplooper
+
+直接の`sample`のほかに、`sampler`メソッドで`Samplooper`インスタンスを取得、`Samplooper#sample` `Samplooper#pick` `Samplooper#loop`が行えます。
+それぞれ引数に1以上の整数をとり、1の場合はレコードを、2以上の場合はレコードを含む配列を返します。
+* **sample(n = 1)**  
+先行取得したidたちを元にレコードを取得。被りあり。
+* **pick(n = 1)**  
+先行取得したidたちを元にレコードを取得。各レコードは1度のみ出現する。1周すると`nil`が帰ってくる。
+* **loop(n = 1)**  
+先行取得したidたちを元にレコードを取得。各レコードは1周に1度のみ出現する。
+
+***
+
+### sample
+
+```ruby
+sampler = SampleModel.limit(3).sampler
+sampler.sample.id
+=> 3
+sampler.sample.id
+=> 1
+sampler.sample(15).map(&:id)
+=> [3, 3, 2, 3, 1, 3, 3, 3, 1, 3, 1, 3, 2, 1, 1]
+```
+
+***
+
+### pick
+
+```ruby
+sampler = SampleModel.limit(3).sampler
+sampler.pick(5).map{ |m| m.try(:id)}
+=> [2, 1, 3, nil, nil]
+
+sampler = SampleModel.limit(3).sampler
+sampler.pick.id
+=> 1
+sampler.pick(5).map{ |m| m.try(:id)}
+=> [2, 3, nil, nil, nil]
+```
+
+***
+
+### loop
+
+```ruby
+sampler = SampleModel.limit(3).sampler
+sampler.loop.id
+=> 2
+sampler.loop.id
+=> 1
+sampler.loop.id
+=> 3
+sampler.loop(15).map(&:id)
+=> [
+  3, 1, 2,
+  1, 3, 2,
+  3, 1, 2,
+  1, 2, 3,
+  2, 3, 1
+]
+```
+
+***
+
+`where`とかも併用できます。
+```ruby
+SampleModel.where(gender: :male).sample(10).map{|m| [m.first_name, m.gender].join(' : ')}
+=> ["洋介 : male", "勇一 : male", "良介 : male", "晃司 : male", "仁晶 : male", "良介 : male", "一樹 : male", "明 : male", "禄郎 : male", "晃司 : male"]
+```
+上は毎回ActiveRecord_Relation取ってくるのでちょっと遅いので`sampler`でidを先行取得して`sample`するとちょっと早い。
+```ruby
+sampler = SampleModel.where(gender: :male).sampler
+sampler.sample(10).map{|m| [m.first_name, m.gender].join(' : ')}
+=> ["悟志 : male", "良介 : male", "慎之介 : male", "寛治 : male", "浩正 : male", "隆之介 : male", "禄郎 : male", "浩正 : male", "一樹 : male", "良介 : male"]
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/active_record_samplooper.rb

@@ -55,17 +55,17 @@ module ActiveRecordSamplooper
 
 
     def sample(count = 1)
-      count > 1 ? count.times.map { do_sample } : do_sample
+      count > 1 ? count.times.map { do_sampling } : do_sampling
     end
 
 
     def pick(count = 1)
-      count > 1 ? count.times.map { do_pick } : do_pick
+      count > 1 ? count.times.map { do_picking } : do_picking
     end
 
 
     def loop(count = 1)
-      count > 1 ? count.times.map { do_loop } : do_loop
+      count > 1 ? count.times.map { do_looping } : do_looping
     end
 
 
@@ -76,23 +76,23 @@ module ActiveRecordSamplooper
 
 
     def reset!
-      self.rest = id_store.dup
+      self.rest = id_store.dup.shuffle
     end
 
 
     private
-    def do_sample
+    def do_sampling
       find(id_store.sample)
     end
 
 
-    def do_pick
+    def do_picking
       return if rest.blank?
       find(rest.shift)
     end
 
 
-    def do_loop
+    def do_looping
       reset! if rest.blank?
       pick
     end
@@ -118,13 +118,18 @@ end
 
 class ::ActiveRecord::Base
   class << self
-    def sample
-      offset(rand(count(:all))).first
+    def sample(count = 1)
+      count > 1 ? count.times.map { do_sampling } : do_sampling
     end
 
 
     def sampler
       ActiveRecordSamplooper.(self)
     end
+
+    private
+    def do_sampling
+      offset(rand(count(:all))).first
+    end
   end
 end

data/lib/active_record_samplooper/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordSamplooper
-  VERSION = "0.0.4"
+  VERSION = "0.0.6"
 end

data/spec/models/sample_model_spec.rb

@@ -34,7 +34,7 @@ RSpec.describe SampleModel, type: :model do
         end
       end
 
-      it 'sample get once each' do
+      it 'pick get once each' do
         10.times { expect(sampler.pick).to be_a(SampleModel) }
         expect(sampler.pick).to be_nil
       end
@@ -70,6 +70,32 @@ RSpec.describe SampleModel, type: :model do
         new_id = create(:sample_model).id
         1000.times { expect(sampler.sample.id).not_to eq(new_id) }
       end
+
+      context 'fixnum parameter get multiple element' do
+        it 'pick(n) get multiple element' do
+          re = sampler.pick(3)
+          expect(re.size).to eq(3)
+          re.each do |element|
+            expect(element).to be_a(SampleModel)
+          end
+        end
+
+        it 'loop(n) get multiple element' do
+          re = sampler.loop(3)
+          expect(re.size).to eq(3)
+          re.each do |element|
+            expect(element).to be_a(SampleModel)
+          end
+        end
+
+        it 'sample(n) get multiple element' do
+          re = sampler.sample(3)
+          expect(re.size).to eq(3)
+          re.each do |element|
+            expect(element).to be_a(SampleModel)
+          end
+        end
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_samplooper
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - mmmpa