cuid2 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d073902862a8146e76858ff1e28d218f9c61bc86b44b91827b6bacaa25361823
-  data.tar.gz: 070ed76bfff065d1dd51149096e88c7b9fe593adcd462d219c99ce3f4ef264d4
+  metadata.gz: abf9155d7edfc94b9696e7748c4b1a34abd31904d7caebde99eea9f1ccb29fc0
+  data.tar.gz: 71fadc184e73e10ef95fd0e98875c53b02838f10305d01bb3249ebd3a6953eda
 SHA512:
-  metadata.gz: 4fb0a7e863fb5097090493e0a1ff64238a0523255224f7cf5728ff264d781c2a2c04041041a7e539c556e49c812b63134844608e3e656d2c1eb98149c46056fe
-  data.tar.gz: 2f45bd473652443707359b676a6340719b268743e832e6224a7cbb6404521206040daca4f3d9f5db963e5296db2a12b88078cf673399e7c7fb767027d164db13
+  metadata.gz: e6ebadaaf263c633c372e7450a452146c06231870b5423bcb9f97bb130654ef7de366fb35529184892225522c10d1233b7ceef2df28b41f729ea6d6077f8f21c
+  data.tar.gz: 0ccdbd78a19f4f601f0a989da3c29110f3bafd83558718d6e2fdf01f786870f3caaa30eb46e49ec94fe857f1b8fc72339e648fe8d85ec9c1f0855bab71c41b08

data/.rubocop.yml

@@ -1,6 +1,5 @@
 AllCops:
-  Enabled: true
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.2
 
 Style/StringLiterals:
   Enabled: true

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Rubens Stulzer
+
+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

@@ -16,6 +16,25 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     $ gem install cuid2
 
+## Usage
+
+First require it.
+
+```ruby
+require 'cuid2'
+```
+
+Generate a Cuid2 with call.
+
+```
+Cuid2.generate
+=> "zw881lkfxx644yknviucss31"
+Cuid2.call
+=> "yra4dr2qteivp6kkur89gd11"
+Cuid2.()
+=> "cr6x94qpqagcgbay780xifun"
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/stulzer/cuid2. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/stulzer/cuid2/blob/main/CODE_OF_CONDUCT.md).

data/lib/cuid2/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cuid2
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

data/lib/cuid2.rb

@@ -3,6 +3,7 @@
 require_relative 'cuid2/version'
 require 'digest'
 
+# CUID2 is a Ruby implementation of the CUID2 algorithm.
 module Cuid2
   # Entropy is a class that generates a random string of characters
   class Entropy
@@ -37,20 +38,17 @@ module Cuid2
     end
   end
 
-  # Generate is a class that generates a Cuid2
-  class Generate
-    DEFAULT_LENGTH = 24
+  DEFAULT_LENGTH = 24
 
-    def self.call
-      new.generate
-    end
-
-    def generate(length = DEFAULT_LENGTH)
+  class << self
+    def call(length = DEFAULT_LENGTH)
       hash_input = (time + Entropy.create(length) + count + fingerprint).to_s
 
       "#{random_letter}#{Cuid2::Hash.create(hash_input, length)[2..length]}"
     end
 
+    alias generate call
+
     private
 
     def time

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cuid2
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Rubens Stulzer
@@ -10,10 +10,9 @@ bindir: exe
 cert_chain: []
 date: 2023-02-18 00:00:00.000000000 Z
 dependencies: []
-description: |-
-  Secure, collision-resistant ids optimized for horizontal scaling and performance.\
-    Next generation UUIDs. Need unique ids in your app? Forget UUIDs which often collide in large apps.\
-    Use Cuid2, instead.
+description: Secure, collision-resistant ids optimized for horizontal scaling and
+  performance.Next generation UUIDs. Need unique ids in your app? Forget UUIDs which
+  often collide in large apps.Use Cuid2, instead.
 email:
 - rubens.stulzer@gmail.com
 executables: []
@@ -24,7 +23,7 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
 - lib/cuid2.rb
@@ -45,7 +44,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/Gemfile.lock

@@ -1,57 +0,0 @@
-PATH
-  remote: .
-  specs:
-    cuid2 (0.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    diff-lcs (1.5.0)
-    json (2.6.3)
-    parallel (1.22.1)
-    parser (3.2.1.0)
-      ast (~> 2.4.1)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.7.0)
-    rexml (3.2.5)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.1)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.45.1)
-      json (~> 2.3)
-      parallel (~> 1.10)
-      parser (>= 3.2.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.24.1, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.26.0)
-      parser (>= 3.2.1.0)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.4.2)
-
-PLATFORMS
-  arm64-darwin-22
-
-DEPENDENCIES
-  cuid2!
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop (~> 1.21)
-
-BUNDLED WITH
-   2.4.6