sample_by_rate 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 45013c262bfab1a28ebbf9be87f45b504eca9913
+  data.tar.gz: 6b7c13006c4053668cf146c48843da89f0e76590
+SHA512:
+  metadata.gz: 32b8b47f60af4d7ad73bbec17bc088e23a5684ec8e8b67e721864919726ce98cf6dc27a380d1e397927abf68f013df57bb471dc7d5eeb4976e2ed656bd6d9ecc
+  data.tar.gz: cbfb862eb3d66986d612d5a85cc06966fe47c81a3dae236e285979dd6c1e1583364793aa10d99270c335e71cb89cd4839c5515ece305389cb10a7aa9e4e03dd9

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+script: 'ruby test/sample_by_rate_test.rb'
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - ruby-head
+  - rbx-2
+  - jruby
+matrix:
+  allow_failures:
+    - rvm: 1.9.3
+    - rvm: ruby-head
+    - rvm: rbx-2
+    - rvm: jruby
+  fast_finish: true

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sample_by_rate.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Yuya Takeyama
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# SampleByRate
+
+Method to do sampling for `Enumerable` objects in specified rate.
+
+```ruby
+# Prints 10% of numbers in (1..100000)
+(1..100000).sample_by_rate(0.1).each do |n|
+  puts n
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sample_by_rate'
+```
+
+Or if you want to import `sample_by_rate` method into `Enumerable` module by default, Add this line.
+
+```ruby
+gem 'sample_by_rate', require: 'sample_by_rate/core_ext'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sample_by_rate
+
+## Usage
+
+### Importing sample_by_rate method into some Enumerable class
+
+```ruby
+class SomeEnumerableClass
+  include SampleByRate
+end
+```
+
+### Importing sample_by_rate method into Enumerable module by default
+
+Recommended way is to specify in `Gemfile` which explained in `Installation` section above.
+
+Or do like below manually.
+
+```ruby
+require 'sample_by_rate/core_ext'
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/yuya-takeyama/sample_by_rate/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/sample_by_rate.rb

@@ -0,0 +1,11 @@
+require "sample_by_rate/version"
+
+module SampleByRate
+  def sample_by_rate(rate)
+    raise 'rate must greater than or equal to 0 and less than  or equal to 1' unless rate >= 0 and rate <= 1
+
+    return enum_for(__method__, rate) unless block_given?
+
+    each {|n| yield n if rand < rate }
+  end
+end

data/lib/sample_by_rate/core_ext.rb

@@ -0,0 +1,5 @@
+require 'sample_by_rate'
+
+module Enumerable
+  include SampleByRate
+end

data/lib/sample_by_rate/version.rb

@@ -0,0 +1,3 @@
+module SampleByRate
+  VERSION = "0.9.0"
+end

data/sample_by_rate.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sample_by_rate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sample_by_rate"
+  spec.version       = SampleByRate::VERSION
+  spec.authors       = ["Yuya Takeyama"]
+  spec.email         = ["sign.of.the.wolf.pentagram@gmail.com"]
+  spec.summary       = %q{Method to do sampling for Enumerable objects in specified rate.}
+  spec.description   = %q{Method to do sampling for Enumerable objects in specified rate.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "test-unit", "~> 3.0.1"
+end

data/test/sample_by_rate_test.rb

@@ -0,0 +1,60 @@
+require 'test/unit'
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sample_by_rate'
+
+class TestSampleByRate < Test::Unit::TestCase
+  sub_test_case '#sample_by_rate' do
+    sub_test_case 'without block' do
+      setup do
+        @range = (1..100000)
+        @range.extend SampleByRate
+      end
+
+      test 'do sampling correctly' do
+        assert_maybe_sampled_correctly @range.sample_by_rate(0.1), 10000
+        assert_maybe_sampled_correctly @range.sample_by_rate(0.5), 50000
+        assert_maybe_sampled_correctly @range.sample_by_rate(0.9), 90000
+        assert_maybe_sampled_correctly @range.sample_by_rate(Rational(1, 3)), 33333
+      end
+
+      test 'with argument 0' do
+        assert_equal 0, size_of_enumerable(@range.sample_by_rate(0))
+      end
+
+      test 'with argument 1' do
+        assert_equal 100000, size_of_enumerable(@range.sample_by_rate(1))
+      end
+
+      def assert_maybe_sampled_correctly(sampled, expected_size)
+        size = size_of_enumerable(sampled)
+
+        assert size >= (expected_size * 0.95)
+        assert size <= (expected_size * 1.05)
+      end
+
+      def size_of_enumerable(enumerable)
+        enumerable.reduce(0) {|acc, n| acc + 1 }
+      end
+    end
+
+    sub_test_case 'invalid argument' do
+      setup do
+        @range = (1..10)
+        @range.extend SampleByRate
+      end
+
+      test '-1 is invalid argument' do
+        assert_raise do
+          @range.sample_by_rate -1
+        end
+      end
+
+      test '1.1 is invalid argument' do
+        assert_raise do
+          @range.sample_by_rate 1.1
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: sample_by_rate
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Yuya Takeyama
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+description: Method to do sampling for Enumerable objects in specified rate.
+email:
+- sign.of.the.wolf.pentagram@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sample_by_rate.rb
+- lib/sample_by_rate/core_ext.rb
+- lib/sample_by_rate/version.rb
+- sample_by_rate.gemspec
+- test/sample_by_rate_test.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Method to do sampling for Enumerable objects in specified rate.
+test_files:
+- test/sample_by_rate_test.rb