rspec-uuid 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9734bb31d88892de3d5c141afbcdbd444b942f327863c4e87be0198b0cf0d3e9
-  data.tar.gz: 7672b8b47603a9f895fb4586af1141edd7b0693c492991a5fecc1847f7f42348
+  metadata.gz: 182a16e53a65c328fd32f92aef6b5d9bb5d52e92cf08cc67f5799eaaea72f13d
+  data.tar.gz: 7cd4ffa9c8e7a7427b32ba1d48ce59a39c81728c4fe54563c05cb604596225b0
 SHA512:
-  metadata.gz: c59ae103abe71f91cb4902c2a98d33084cc5cfa5726c0c723fdb19267f85ff29f1f76ffc366d598743c740f49635b75490747f8a53a455b3bef84ffb14400262
-  data.tar.gz: c5cefea9b062dd117b02491684cc221b52651c56801975458519c222dac9152a8bfcbbb15dbe8d475dcdf2e94b304974cab9d8e47696f032be3cbb17828256f2
+  metadata.gz: 7b58fa677009b056653611cf8950e651e89db53229e06fe4d8673a0cfd4f65775b8e26f3d02b0ba97821eed76b255423130e608d3fea00fcc2330058481e8894
+  data.tar.gz: fab7586801890f4eef8268690c6568c53afb6fb4a62f2ee2910b1860ad3dfc85917d6bdb2c53a9fc7c94b31432e3e1190dd3c53a119dbb3d61ecfa954923779e

data/CHANGELOG.md

@@ -0,0 +1,33 @@
+###  v0.6.0  (2024-04-08)
+- drop ruby 2.7
+- dependabot upgrades
+- uuid_v7
+- gemspec fixup
+- codecov upgrade (#1)
+- add lockfile and dependabot
+
+###  v0.5.0  (2022-06-08)
+- move to "rspec/uuid"
+- .of_version chain
+- Update README.md
+- simplify composition spec
+
+###  v0.4.0  (2022-05-23)
+- rspec 3
+- Update README.md
+
+###  v0.3.0  (2022-05-19)
+- version kwarg
+
+###  v0.2.1  (2022-05-16)
+- requirements
+- faker coverage
+- Update README.md
+
+###  v0.2.0  (2022-05-13)
+- uuid version support
+- Update README.md
+
+###  v0.1.0  (2022-05-12)
+- voila
+

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    rspec-uuid (0.6.0)
+      rspec-expectations (>= 3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.6)
+    byebug (11.1.3)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    diff-lcs (1.5.1)
+    docile (1.4.0)
+    drb (2.2.0)
+      ruby2_keywords
+    faker (3.3.0)
+      i18n (>= 1.8.11, < 2)
+    i18n (1.14.4)
+      concurrent-ruby (~> 1.0)
+    minitest (5.22.2)
+    mutex_m (0.2.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    uuid7 (0.2.0)
+      zeitwerk (~> 2.4)
+    zeitwerk (2.6.12)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  byebug
+  faker
+  rspec
+  rspec-uuid!
+  simplecov
+  uuid7
+
+BUNDLED WITH
+   2.4.20

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Daniel Pepper
+
+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,34 @@
+rspec-uuid
+======
+![Gem](https://img.shields.io/gem/dt/rspec-uuid?style=plastic)
+[![codecov](https://codecov.io/gh/dpep/rspec-uuid/branch/main/graph/badge.svg)](https://codecov.io/gh/dpep/rspec-uuid)
+
+
+An RSpec matcher for UUIDs.
+
+```ruby
+require "rspec/uuid"
+
+
+it { is_expected.to be_a_uuid }
+
+# check the version
+it { is_expected.to be_a_uuid(version: 4) }
+it { is_expected.to be_a_uuid.of_version(4) }
+
+# compose with other matchers
+it { expect(data).to include(uuid: a_uuid) }
+```
+
+
+----
+## Contributing
+
+Yes please  :)
+
+1. Fork it
+1. Create your feature branch (`git checkout -b my-feature`)
+1. Ensure the tests pass (`bundle exec rspec`)
+1. Commit your changes (`git commit -am 'awesome new feature'`)
+1. Push your branch (`git push origin my-feature`)
+1. Create a Pull Request

data/lib/rspec/uuid/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module UUID
+    VERSION = "0.6.0"
+  end
+end

data/lib/rspec/uuid.rb

@@ -0,0 +1,45 @@
+require "rspec/expectations"
+
+RSpec::Matchers.define :be_a_uuid do |version: nil|
+  chain :of_version do |version|
+    @version = version
+  end
+
+  match do |actual|
+    raise ArgumentError if @version && version
+
+    return false unless actual.is_a?(String)
+
+    # https://www.uuidtools.com/what-is-uuid
+    matches = actual.match /^\h{8}-\h{4}-(\h{4})-\h{4}-\h{12}$/
+    return false unless matches
+
+    version ||= @version
+    if version
+      # 1st nibble of 3rd section
+      @actual_version = matches[1].to_i(16) >> 12
+
+      version == @actual_version
+    else
+      true
+    end
+  end
+
+  description do
+    version ? "a UUID v#{version}" : "a UUID"
+  end
+
+  failure_message do
+    if @actual_version
+      "expected #{description}, found a UUID v#{@actual_version}"
+    else
+      "expected #{description}"
+    end
+  end
+
+  failure_message_when_negated do
+    "did not expect #{description}"
+  end
+end
+
+RSpec::Matchers.alias_matcher :a_uuid, :be_a_uuid

data/lib/rspec-uuid.rb

@@ -1,38 +1 @@
-require "rspec/expectations"
-
-RSpec::Matchers.define :be_a_uuid do |version: nil|
-  match do |actual|
-    return false unless actual.is_a?(String)
-
-    # https://www.uuidtools.com/what-is-uuid
-    matches = actual.match /^\h{8}-\h{4}-(\h{4})-\h{4}-\h{12}$/
-    return false unless matches
-
-    if version
-      # 1st nibble of 3rd section
-      @actual_version = matches[1].to_i(16) >> 12
-
-      version == @actual_version
-    else
-      true
-    end
-  end
-
-  description do
-    version ? "a UUID v#{version}" : "a UUID"
-  end
-
-  failure_message do
-    if @actual_version
-      "expected #{description}, found a UUID v#{@actual_version}"
-    else
-      "expected #{description}"
-    end
-  end
-
-  failure_message_when_negated do
-    "did not expect #{description}"
-  end
-end
-
-RSpec::Matchers.alias_matcher :a_uuid, :be_a_uuid
+require "rspec/uuid"

data/rspec-uuid.gemspec

@@ -0,0 +1,25 @@
+require_relative "lib/rspec/uuid/version"
+package = RSpec::UUID
+package_name = "rspec-uuid"
+
+Gem::Specification.new do |s|
+  s.authors     = ["Daniel Pepper"]
+  s.description = "RSpec UUID matcher"
+  s.files       = `git ls-files * ':!:spec'`.split("\n")
+  s.homepage    = "https://github.com/dpep/#{package_name}"
+  s.license     = "MIT"
+  s.name        = package_name
+  s.summary     = package.to_s
+  s.version     = package.const_get "VERSION"
+
+  s.required_ruby_version = ">= 3"
+
+  s.add_dependency "rspec-expectations", ">= 3"
+
+  s.add_development_dependency "activesupport"
+  s.add_development_dependency "byebug"
+  s.add_development_dependency "faker"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "uuid7"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-uuid
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Daniel Pepper
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-24 00:00:00.000000000 Z
+date: 2024-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codecov
+  name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: faker
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: uuid7
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -114,9 +114,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
 - lib/rspec-uuid.rb
-- lib/rspec-uuid/version.rb
-- spec/matchers_spec.rb
+- lib/rspec/uuid.rb
+- lib/rspec/uuid/version.rb
+- rspec-uuid.gemspec
 homepage: https://github.com/dpep/rspec-uuid
 licenses:
 - MIT
@@ -129,16 +135,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.5.7
 signing_key:
 specification_version: 4
-summary: RSpecUUID
-test_files:
-- spec/matchers_spec.rb
+summary: RSpec::UUID
+test_files: []

data/lib/rspec-uuid/version.rb

@@ -1,3 +0,0 @@
-module RSpecUUID
-  VERSION = "0.4.0"
-end

data/spec/matchers_spec.rb

@@ -1,70 +0,0 @@
-describe "be_a_uuid" do
-  context "with a valid UUID" do
-    let(:uuid) { "992c94bd-5870-4e02-ad2d-a9435f7fffe6" }
-
-    specify { expect(uuid).to be_a_uuid }
-  end
-
-  context "with generated UUIDs" do
-    specify do
-      100.times { expect(SecureRandom.uuid).to be_a_uuid }
-      100.times { expect(Faker::Internet.uuid).to be_a_uuid }
-    end
-  end
-
-  context "with invalid UUIDs" do
-    specify { expect("abc").not_to be_a_uuid }
-    specify { expect(:xyz).not_to be_a_uuid }
-    specify { expect(123).not_to be_a_uuid }
-    specify { expect(nil).not_to be_a_uuid }
-
-    it "fails with a useful message" do
-      expect {
-        expect(nil).to be_a_uuid
-      }.to fail_including("expected a UUID")
-    end
-
-    it "fails with a useful negation message" do
-      expect {
-        expect(SecureRandom.uuid).not_to be_a_uuid
-      }.to fail_including("did not expect a UUID")
-    end
-  end
-
-  context "with a UUID version" do
-    let(:namespace) { Digest::UUID::OID_NAMESPACE }
-    let(:uuid_v3) { Digest::UUID.uuid_v3(namespace, "123") }
-    let(:uuid_v4) { SecureRandom.uuid }
-    let(:uuid_v5) { Digest::UUID.uuid_v5(namespace, "123") }
-
-    specify { expect(uuid_v3).to be_a_uuid(version: 3) }
-    specify { expect(uuid_v3).not_to be_a_uuid(version: 4) }
-    specify { expect(uuid_v3).not_to be_a_uuid(version: 5) }
-
-    specify { expect(uuid_v4).to be_a_uuid(version: 4) }
-    specify { expect(uuid_v5).to be_a_uuid(version: 5) }
-
-    it "fails with a useful message" do
-      expect {
-        expect(uuid_v3).to be_a_uuid(version: 4)
-      }.to fail_including("expected a UUID v4, found a UUID v3")
-    end
-  end
-
-  it "is composable" do
-    data = {
-      res: {
-        abc: { a: 1 },
-        uuid: SecureRandom.uuid,
-        uuid_v5: Digest::UUID.uuid_v5(Digest::UUID::OID_NAMESPACE, "123"),
-      },
-      foo: nil,
-    }
-
-    expect(data).to include(res: {
-      abc: a_hash_including(:a),
-      uuid: a_uuid,
-      uuid_v5: a_uuid(version: 5),
-    })
-  end
-end