rspec-uuid 0.2.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86976570717b28f357f79552d53198d57041efc2ac7e96706d0c8415bdd85782
-  data.tar.gz: c561df77eb3e2867b3ff3818ce2c865c8ba1d03354814116c844faea74ca58c0
+  metadata.gz: 01a071e18425a466c1ad901fc015b3f683467d4b77ba7d1a151e57d0bf28b264
+  data.tar.gz: ee5776d8c999625c67a543bd3ecf40097a0983d9653fbc034505f0542137b51f
 SHA512:
-  metadata.gz: 0616ab1c8402b8f4c0977778a38a0a59cb5a511173d30433d920a2aa521a651272046fb135ef478cfa231c7526c904382bace79b95042efc7bf912d1a38c5f3e
-  data.tar.gz: 2e453940a2a49faa22f2b3933e300b4b986f16080934aca2d0c0acaf39cab022221d9a7ba22609c8abb90c3b5cdb384763b1331bffc52f76832326407d5536c4
+  metadata.gz: c05681f2b05f9c78225f658b99f2fe96032660614cf32611cf1f5596e9d8869346a36d2762e53e0b41846e717ba1d6b0c5457779fc51058fc95f1c1fa8c50f57
+  data.tar.gz: 26cc496001d14ecb9829b21f1525f20e80ea7a139cfe24386700283946f9716269bb4bfefb86658059f09c59469581a8d3c08c1c4565efde0e897fcf515f355d

data/lib/rspec/uuid/version.rb

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

data/lib/rspec/uuid.rb

@@ -0,0 +1,45 @@
+require "rspec/expectations"
+
+RSpec::Matchers.define :be_a_uuid do |version: nil|
+  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
+
+  chain :of_version do |version|
+    @version = version
+  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,8 +1 @@
-require "rspec/core"
-require "rspec/expectations"
-require "rspec-uuid/matchers"
-require "rspec-uuid/version"
-
-RSpec.configure do |config|
-  config.include(RSpecUUID::Matchers)
-end
+require "rspec/uuid"

data/spec/matchers_spec.rb

@@ -1,4 +1,4 @@
-describe RSpecUUID::Matchers do
+describe "be_a_uuid" do
   context "with a valid UUID" do
     let(:uuid) { "992c94bd-5870-4e02-ad2d-a9435f7fffe6" }
 
@@ -37,17 +37,52 @@ describe RSpecUUID::Matchers do
     let(:uuid_v4) { SecureRandom.uuid }
     let(:uuid_v5) { Digest::UUID.uuid_v5(namespace, "123") }
 
-    specify { expect(uuid_v3).to be_a_uuid(3) }
-    specify { expect(uuid_v3).not_to be_a_uuid(4) }
-    specify { expect(uuid_v3).not_to be_a_uuid(5) }
+    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(4) }
-    specify { expect(uuid_v5).to be_a_uuid(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(4)
+        expect(uuid_v3).to be_a_uuid(version: 4)
       }.to fail_including("expected a UUID v4, found a UUID v3")
     end
+
+    describe ".of_version" do
+      it { expect(uuid_v3).to be_a_uuid.of_version(3) }
+
+      it { expect(uuid_v4).to be_a_uuid.of_version(4) }
+      it { expect(uuid_v4).not_to be_a_uuid.of_version(3) }
+
+      it "requires a version argument" do
+        expect {
+          expect(uuid_v4).to be_a_uuid.of_version
+        }.to raise_error(ArgumentError)
+      end
+
+      it "can not be used simultaneously with kwarg version" do
+        expect {
+          expect(uuid_v4).to be_a_uuid(version: 4).of_version(4)
+        }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  it "is composable" do
+    data = {
+      abc: { a: 1 },
+      uuid: SecureRandom.uuid,
+      uuid_v5: Digest::UUID.uuid_v5(Digest::UUID::OID_NAMESPACE, "123"),
+    }
+
+    expect(data).to include(uuid: a_uuid)
+
+    expect(data).to match(
+      abc: a_hash_including(:a),
+      uuid: a_uuid,
+      uuid_v5: a_uuid(version: 5),
+    )
   end
 end

metadata

@@ -1,37 +1,37 @@
 --- !ruby/object:Gem::Specification
 name: rspec-uuid
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Daniel Pepper
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-17 00:00:00.000000000 Z
+date: 2022-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-expectations
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 - !ruby/object:Gem::Dependency
-  name: rspec-expectations
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codecov
+  name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: faker
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -115,8 +115,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/rspec-uuid.rb
-- lib/rspec-uuid/matchers.rb
-- lib/rspec-uuid/version.rb
+- lib/rspec/uuid.rb
+- lib/rspec/uuid/version.rb
 - spec/matchers_spec.rb
 homepage: https://github.com/dpep/rspec-uuid
 licenses:
@@ -140,6 +140,6 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
-summary: RSpecUUID
+summary: Gem::Specification::RSpec::UUID
 test_files:
 - spec/matchers_spec.rb

data/lib/rspec-uuid/matchers.rb

@@ -1,47 +0,0 @@
-module RSpecUUID
-  module Matchers
-    class UUIDMatcher
-      def initialize(version = nil)
-        @version = version
-      end
-
-      def matches?(actual)
-        return false unless actual.is_a?(String)
-
-        # https://www.uuidtools.com/what-is-uuid
-        match = actual.match /^\h{8}-\h{4}-(\h{4})-\h{4}-\h{12}$/
-
-        return false unless match
-
-        if @version
-          # 1st nibble of 3rd section
-          @actual_version = match[1].to_i(16) >> 12
-
-          @version == @actual_version
-        else
-          true
-        end
-      end
-
-      def description
-        @version ? "a UUID v#{@version}" : "a UUID"
-      end
-
-      def failure_message
-        if @actual_version
-          "expected #{description}, found a UUID v#{@actual_version}"
-        else
-          "expected #{description}"
-        end
-      end
-
-      def failure_message_when_negated
-        "did not expect #{description}"
-      end
-    end
-
-    def be_a_uuid(...)
-      UUIDMatcher.new(...)
-    end
-  end
-end

data/lib/rspec-uuid/version.rb

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