string_derived_random 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e82212121f68d2c00f81f9300db8d6cec2591d94
+  data.tar.gz: 84b88f37201d3abfc27a1cb265bf44a45057b66f
+SHA512:
+  metadata.gz: aea0ebd92a855d6c5adbdb1bed3bf5c8ff42d557c7b7491b3f5956b4e34a7332e0fa5e4009e8e1a501d7205aa78e70adb75c3e7a3513fe65029782a738fa02fb
+  data.tar.gz: 459fdfb817630ca31d70949388a92c95a51e930589f4e1b3d28dc20b31517cf83bce914495dbd3f922798036d6715cfee3addfe97f75f390778bce29ddc14573

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.17.3

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.0.1
+
+* Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in string_derived_random.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    string_derived_random (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  string_derived_random!
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Julik Tarkhanov
+
+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,50 @@
+# StringDerivedRandom
+
+Allows one to seed a Ruby `Random` object with a seed value that is derived from a given string. This
+can be useful for doing "one-in-N" selection for large corpi of identifiers. For example:
+
+```ruby
+rng = StringDerivedRandom.new(document.id.to_s)
+rng.rand # => the result is always going to be the same
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'string_derived_random'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install string_derived_random
+
+## Usage
+
+In your code, use a string identifier (for example a filesystem path, or a user ID) to create a generator,
+and then use the generator to emit random values. The generator is a Ruby `Random` object.
+
+```ruby
+if StringDerivedRandom.new(file_path).rand(1..200) == 1
+  apply_processing # will apply to one in 200 file paths
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/julik/string_derived_random.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "string_derived_random"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/string_derived_random.rb

@@ -0,0 +1,51 @@
+require 'digest'
+
+module StringDerivedRandom
+  require_relative "string_derived_random/version"
+
+  class Error < StandardError; end
+
+  # For quick bucketing of "process one in N" objects
+  def is_one_in?(n, string_seed:)
+    raise ArgumentError if n < 1
+    new(string_seed).rand(1..n) == 1
+  end
+
+  # The objective here is getting a stable random
+  # number based on a given string. We use the string to
+  # generate a big Integer that can be used to seed a
+  # Random object at creation. This allows us to
+  # experiment by, say, applying something to
+  #'every 100th of some class of objects having this identifier',
+  # with the result being exactly the same for that identifier,
+  # every time.
+  #
+  # @param string_seed[#to_s] An object that can be converted into a String
+  # @return [Random] A seeded Random object
+  def new(string_seed)
+    # Compute a digest that gives us a good
+    # distribution of values. Doesn't matter which
+    # digest gets used since it is the distribution
+    # that matters, as well as consistency and a broader
+    # range of possible values
+    digest_bytes = Digest::SHA256.digest(string_seed.to_s)
+
+    # We get 256 bits of information from the digest.
+    # The Mersenne twister can be seeded with values
+    # in a certain range, after which the seed rolls over.
+    # For the gory details read https://stackoverflow.com/a/20082583/153886
+    # but basically the range is this:
+    #
+    # 2 ** ( 624 * 32 )
+    #
+    # which is actually 19968 bits of available values, quite a bit more
+    # than what the SHA256 gives us - which is only 256 bits.
+    # So for our purposes we can just use those values and relax, as there
+    # is no requirement for this seed to be cryptographically-secure.
+    # https://stackoverflow.com/a/17556861/153886 for the bytes -> bigint part
+    seed_int = digest_bytes.bytes.inject {|a, b| (a << 8) + b }
+    Random.new(seed_int)
+  end
+
+  extend self
+end

data/lib/string_derived_random/version.rb

@@ -0,0 +1,3 @@
+module StringDerivedRandom
+  VERSION = "0.1.0"
+end

data/string_derived_random.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "string_derived_random/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "string_derived_random"
+  spec.version       = StringDerivedRandom::VERSION
+  spec.authors       = ["Julik Tarkhanov"]
+  spec.email         = ["me@julik.nl"]
+
+  spec.summary       = %q{Seed a Ruby `Random` object with a seed value that is derived from a given string}
+  spec.description   = %q{Seed a Ruby `Random` object with a seed value that is derived from a given string}
+  spec.homepage      = "https://github.com/julik/string_derived_random"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/julik/string_derived_random"
+    spec.metadata["changelog_uri"] = "https://github.com/julik/string_derived_random/blob/master/CHANGELOG=.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: string_derived_random
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julik Tarkhanov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Seed a Ruby `Random` object with a seed value that is derived from a
+  given string
+email:
+- me@julik.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/string_derived_random.rb
+- lib/string_derived_random/version.rb
+- string_derived_random.gemspec
+homepage: https://github.com/julik/string_derived_random
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/julik/string_derived_random
+  source_code_uri: https://github.com/julik/string_derived_random
+  changelog_uri: https://github.com/julik/string_derived_random/blob/master/CHANGELOG=.md
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Seed a Ruby `Random` object with a seed value that is derived from a given
+  string
+test_files: []