garant 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: db998129db177ba09d52e8230d7ed862dc74168f534fbf419b4970d66d3aa83e
+  data.tar.gz: 3c8a07e5b62dd87cbad7b897a7ac801a478fe4121418e1cb23d7b5658014befe
+SHA512:
+  metadata.gz: 9b526a8ce9bdb575eab883504dbcc75e69250666869cf02190930e91a6671487220f9cb0c77dfc89bb97122944cac35065be3618e8a5acbbfe3ad6f1c755bcbb
+  data.tar.gz: 6989c8c1b1f4c022dc747205a87f904701499df7463ab0b22c54f32a82ecee8bf3b9e0dd15b06897b93ee0134fb5a1aea7c10053d35af10c9c26c87e474aaf80

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 creadone
+
+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,40 @@
+# Garant
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/garant`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'garant'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install garant
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+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/[USERNAME]/garant.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "garant"
+
+# 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/garant.gemspec

@@ -0,0 +1,23 @@
+require_relative 'lib/garant/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "garant"
+  spec.version       = Garant::VERSION
+  spec.authors       = ["Sergey Fedorov"]
+  spec.email         = ["creadone@gmail.com"]
+  spec.summary       = %q{Helper for generation unique hashes.}
+  spec.description   = %q{Garant prevents the collisions when generating a large number of hashes.}
+  spec.homepage      = "http://github.com/creadone/garant"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.add_runtime_dependency     'bloomer',  '~> 1.0'
+  spec.add_development_dependency 'rake',     '~> 12.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+
+  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.require_paths = ["lib"]
+end

data/lib/garant.rb

@@ -0,0 +1,27 @@
+require "set"
+require "bloomer"
+require "bloomer/msgpackable"
+require "garant/config"
+require "garant/errors"
+
+module Garant
+  class << self
+    def safe(&block)
+      retries = 0
+      hashed_value = nil
+
+      while true do
+        hashed_value = block.call
+        raise MissingHashedValue.new if hashed_value.nil?
+        raise MaxRetriesExceeded.new if config.max_retries <= retries
+        if config.storage.include?(hashed_value)
+          retries += 1
+        else
+          config.storage.add(hashed_value)
+          return hashed_value
+        end
+      end
+
+    end
+  end
+end

data/lib/garant/config.rb

@@ -0,0 +1,47 @@
+module Garant
+  class << self
+    attr_accessor :config
+  end
+
+  def self.setup
+    self.config ||= Config.new
+    yield config
+  end
+
+  class Config
+    attr_accessor :error_probability
+    attr_accessor :expected_size
+    attr_accessor :max_retries
+
+    attr_accessor :dump_load_path
+    attr_accessor :dump_save_path
+
+    attr_accessor :storage_type
+    attr_accessor :storage
+
+    def initialize
+      @error_probability = 0.01
+      @expected_size     = 1_000_000
+      @storage_type      = :bloom
+      @max_retries       = 15
+      @dump_save_load    = nil
+      @dump_load_path    = nil
+
+      init_storage
+    end
+
+    private
+      def init_storage
+        if @storage_type == :bloom
+          @storage = if @dump_load_path
+            Bloomer.from_msgpack(@dump_load_path)
+          else
+            Bloomer.new(@expected_size, @error_probability)
+          end
+        elsif @storage_type == :set
+          @storage = Set.new
+        end
+        return nil
+      end
+  end
+end

data/lib/garant/errors.rb

@@ -0,0 +1,13 @@
+module Garant
+  class MaxRetriesExceeded < StandardError
+    def initialize(msg = "The hash-function has reached the limit of generating unique hashes")
+      super(msg)
+    end
+  end
+
+  class MissingHashValue < StandardError
+    def initialize(msg = "The hash-function return nil instead value")
+      super(msg)
+    end
+  end
+end

data/lib/garant/version.rb

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

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: garant
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergey Fedorov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bloomer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Garant prevents the collisions when generating a large number of hashes.
+email:
+- creadone@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- garant.gemspec
+- lib/garant.rb
+- lib/garant/config.rb
+- lib/garant/errors.rb
+- lib/garant/version.rb
+homepage: http://github.com/creadone/garant
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Helper for generation unique hashes.
+test_files: []