fnv-hash 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0dfd5c68e0d222205d6ab88ec084ffe7c883b03a
-  data.tar.gz: 0913b8a87a307006458a7f00f6a5560b331fd230
+  metadata.gz: 0d5ce82d849a6440aa02e0265bcc528a7b5adc3c
+  data.tar.gz: 25addfcc91906f8afb42e720393e36fb2d9c3bef
 SHA512:
-  metadata.gz: 6dafd049fd131cf270f63ff3a8552fa744c20b752232356f8012c50775049711529138546ef012b5a0bbe30815313ae8d89369e87d882c1d961e0612aa0ccce0
-  data.tar.gz: 4d0b9a7311a4b104fa1307b2e4ae74aa9c33fe0f797c1b1af37dc32553a939d7893d879ce884538d18d1f6043f8ba998174d90d8e5b6dc546ab4d98f26f3a18d
+  metadata.gz: e1b25d2dcea885cb9a0bdf7f3d013477f8d0130363b5c9acea2a8ffe9e39eaf8c3c2af59a5f80578b52581c070c356c7332c27f6c6b93c2abb08f4ad2d7a28f1
+  data.tar.gz: 446055975520bd899c9d579f13988cb1fa9e1d5445edaaba00dbb73580bb893f162c9973fa1b1d15faecfb6bc090a0646666b2cf457498bdffac62ef73f2985e

data/LICENSE.txt

@@ -1,13 +1,202 @@
-Copyright 2017 Pawan Dubey
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-    http://www.apache.org/licenses/LICENSE-2.0
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/pawandubey/fnv-hash.svg?branch=master)](https://travis-ci.org/pawandubey/fnv-hash)  [![codecov](https://codecov.io/gh/pawandubey/fnv-hash/branch/master/graph/badge.svg)](https://codecov.io/gh/pawandubey/fnv-hash)
+[![Build Status](https://travis-ci.org/pawandubey/fnv-hash.svg?branch=master)](https://travis-ci.org/pawandubey/fnv-hash)  [![codecov](https://codecov.io/gh/pawandubey/fnv-hash/branch/master/graph/badge.svg)](https://codecov.io/gh/pawandubey/fnv-hash)  [![Gem Version](https://badge.fury.io/rb/fnv-hash.svg)](https://badge.fury.io/rb/fnv-hash)
 
 # Fnv::Hash
 

data/fnv-hash.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'fnv/hash/version'
+require 'fnv/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "fnv-hash"
-  spec.version       = Fnv::Hash::VERSION
+  spec.version       = Fnv::VERSION
   spec.authors       = ["Pawan Dubey"]
   spec.email         = ["hi@pawandubey.com"]
 
@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.description   = %q{Provides a pure Ruby implementations of the FNV-1
                           and FNV-1a non-cryptographic hash functions.}
   spec.homepage      = "https://github.com/pawandubey/fnv-hash"
-  spec.license       = "Apache V2"
+  spec.license       = "Apache v2"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})

data/lib/fnv.rb

@@ -0,0 +1,65 @@
+require "fnv/version"
+
+module Fnv
+  class Hash
+    OFFSET_BASIS = {
+      32 => 0x811c9dc5,
+      64 => 0xcbf29ce484222325,
+      128 => 0x6c62272e07bb014262b821756295c58d
+    }
+
+    PRIME = {
+      32 => 16777619,
+      64 => 1099511628211,
+      128 => 309485009821345068724781371
+    }
+
+    MASK = {
+      32 => 4294967295,
+      64 => 18446744073709551615,
+      128 => 340282366920938463463374607431768211455
+    }
+
+    # Calculates the FNV-1 hash for the given
+    # item value
+    #
+    # @param item The item to hash
+    # @param size [Integer] the size of the resulting hash
+    #
+    # @return [Integer] the calculated hash value
+    def self.fnv_1(item, size: 32)
+      offset_basis = OFFSET_BASIS.fetch(size)
+      prime = PRIME.fetch(size)
+
+      hash = offset_basis
+      item.to_s.each_byte do |byte|
+        hash *= prime
+        hash &= MASK.fetch(size)
+        hash ^= byte
+      end
+
+      hash
+    end
+
+    # Calculates the FNV-1a hash for the given
+    # item value
+    #
+    # @param item The item to hash
+    # @param size [Integer] the size of the resulting hash
+    #
+    # @return [Integer] the calculated hash value
+    def self.fnv_1a(item, size: 32)
+      offset_basis = OFFSET_BASIS.fetch(size)
+      prime = PRIME.fetch(size)
+
+      hash = offset_basis
+      item.to_s.each_byte do |byte|
+        hash ^= byte
+        hash *= prime
+        hash &= MASK.fetch(size)
+      end
+
+      hash
+    end
+  end
+end

data/lib/fnv/version.rb

@@ -0,0 +1,3 @@
+module Fnv
+  VERSION = "0.2.0"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fnv-hash
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Pawan Dubey
@@ -99,11 +99,11 @@ files:
 - bin/console
 - bin/setup
 - fnv-hash.gemspec
-- lib/fnv/hash.rb
-- lib/fnv/hash/version.rb
+- lib/fnv.rb
+- lib/fnv/version.rb
 homepage: https://github.com/pawandubey/fnv-hash
 licenses:
-- Apache V2
+- Apache v2
 metadata: {}
 post_install_message: 
 rdoc_options: []

data/lib/fnv/hash.rb

@@ -1,37 +0,0 @@
-require "fnv/hash/version"
-
-module Fnv
-  module Hash
-    OFFSET_BASIS = { 32 => 0x811c9dc5, 64 => 0xcbf29ce484222325 }
-    PRIME = { 32 => 16777619, 64 => 1099511628211 }
-    MASK = { 32 => 4294967295, 64 => 18446744073709551615 }
-
-    def self.fnv_1(item, size: 32)
-      offset_basis = OFFSET_BASIS.fetch(size)
-      prime = PRIME.fetch(size)
-
-      hash = offset_basis
-      item.to_s.each_byte do |byte|
-        hash *= prime
-        hash &= MASK.fetch(size)
-        hash ^= byte
-      end
-
-      hash
-    end
-
-    def self.fnv_1a(item, size: 32)
-      offset_basis = OFFSET_BASIS.fetch(size)
-      prime = PRIME.fetch(size)
-
-      hash = offset_basis
-      item.to_s.each_byte do |byte|
-        hash ^= byte
-        hash *= prime
-        hash &= MASK.fetch(size)
-      end
-
-      hash
-    end
-  end
-end

data/lib/fnv/hash/version.rb

@@ -1,5 +0,0 @@
-module Fnv
-  module Hash
-    VERSION = "0.1.0"
-  end
-end