djb2 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5289f212e113d7ce344f3aca42cd112ea8263807fbac52e8ded9cea07cec49ce
+  data.tar.gz: d573c00d36bc540125e74a90a9fd959bd7236e5c6dc149db0033a8cac76e27f7
+SHA512:
+  metadata.gz: fa8293f3d33a9ba62c7ff2481ce4976cc9ebaa54e7eca2f1da6b0fc81cdc5e78f875c0fa127dfcae2423b3d249e3292e95e8e6ad58eb5e3f67fd8e10dd322253
+  data.tar.gz: 92636feeed901c10450892a144070a60eb8208492aabda8f45d0d88519bd9fcbde0a333d560fbd6c1fd9df1ec5692f6391b8a4060d92761702664e32df268a6c

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-11-24
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Shopify
+
+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,35 @@
+# DJB2
+
+Native djb2 hash implementation
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add djb2
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install djb2
+
+## Usage
+
+```ruby
+require "djb2"
+
+DJB2.digest("Some String") # => 13838202372652591140
+```
+
+## 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 the created tag, 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/Shopify/djb2.
+
+## 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,22 @@
+# frozen_string_literal: true
+
+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
+
+require "rake/extensiontask"
+
+task build: :compile
+
+GEMSPEC = Gem::Specification.load("djb2.gemspec")
+
+Rake::ExtensionTask.new("djb2", GEMSPEC) do |ext|
+  ext.lib_dir = "lib/djb2"
+end
+
+task default: %i[clobber compile test]

data/ext/djb2/djb2.c

@@ -0,0 +1,28 @@
+#include "ruby.h"
+
+VALUE rb_mDJB2;
+
+uint64_t
+djb_hash_2(const char *string, long length)
+{
+    uint64_t hash = 5381;
+    long index;
+    for (index = 0; index < length; index++) {
+        hash = (hash * 33) ^ (unsigned char)string[index];
+    }
+    return hash;
+}
+
+static VALUE
+rb_djb_hash_2(VALUE self, VALUE str)
+{
+    Check_Type(str, T_STRING);
+    return ULL2NUM(djb_hash_2(RSTRING_PTR(str), RSTRING_LEN(str)));
+}
+
+RUBY_FUNC_EXPORTED void
+Init_djb2(void)
+{
+  rb_mDJB2 = rb_define_module("DJB2");
+  rb_define_singleton_method(rb_mDJB2, "digest", rb_djb_hash_2, 1);
+}

data/ext/djb2/extconf.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "mkmf"
+
+# Makes all symbols private by default to avoid unintended conflict
+# with other gems. To explicitly export symbols you can use RUBY_FUNC_EXPORTED
+# selectively, or entirely remove this flag.
+append_cflags("-fvisibility=hidden")
+
+create_makefile("djb2/djb2")

data/lib/djb2/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DJB2
+  VERSION = "0.1.0"
+end

data/lib/djb2.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "djb2/version"
+require_relative "djb2/djb2"
+
+module DJB2
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: djb2
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jean Boussier
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-11-27 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- jean.boussier@gmail.com
+executables: []
+extensions:
+- ext/djb2/extconf.rb
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/djb2/djb2.c
+- ext/djb2/extconf.rb
+- lib/djb2.rb
+- lib/djb2/version.rb
+homepage: https://github.com/Shopify/djb2
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/Shopify/djb2/issues
+  source_code_uri: https://github.com/Shopify/djb2
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Native djb2 hash implementation
+test_files: []