cuprum-collections 0.2.0 → 0.3.0

data/lib/cuprum/collections/rspec/repository_contract.rb

@@ -1,57 +1,48 @@
 # frozen_string_literal: true
 
+require 'rspec/sleeping_king_studios/contract'
+
 require 'cuprum/collections/rspec'
 
 module Cuprum::Collections::RSpec
   # Contract validating the behavior of a Repository.
-  REPOSITORY_CONTRACT = lambda do
-    describe '#[]' do
-      let(:error_class) do
-        described_class::UndefinedCollectionError
-      end
-      let(:error_message) do
-        "repository does not define collection #{collection_name.inspect}"
-      end
-
-      it { expect(repository).to respond_to(:[]).with(1).argument }
-
-      describe 'with nil' do
-        let(:collection_name) { nil }
-
-        it 'should raise an exception' do
-          expect { repository[collection_name] }
-            .to raise_error(error_class, error_message)
+  module RepositoryContract
+    extend RSpec::SleepingKingStudios::Contract
+
+    # @!method apply(example_group)
+    #   Adds the contract to the example group.
+    #
+    #   @param example_group [RSpec::Core::ExampleGroup] The example group to
+    #     which the contract is applied.
+    contract do
+      describe '#[]' do
+        let(:error_class) do
+          described_class::UndefinedCollectionError
         end
-      end
-
-      describe 'with an object' do
-        let(:collection_name) { Object.new.freeze }
-
-        it 'should raise an exception' do
-          expect { repository[collection_name] }
-            .to raise_error(error_class, error_message)
+        let(:error_message) do
+          "repository does not define collection #{collection_name.inspect}"
         end
-      end
 
-      describe 'with an invalid string' do
-        let(:collection_name) { 'invalid_name' }
+        it { expect(repository).to respond_to(:[]).with(1).argument }
 
-        it 'should raise an exception' do
-          expect { repository[collection_name] }
-            .to raise_error(error_class, error_message)
+        describe 'with nil' do
+          let(:collection_name) { nil }
+
+          it 'should raise an exception' do
+            expect { repository[collection_name] }
+              .to raise_error(error_class, error_message)
+          end
         end
-      end
 
-      describe 'with an invalid symbol' do
-        let(:collection_name) { :invalid_name }
+        describe 'with an object' do
+          let(:collection_name) { Object.new.freeze }
 
-        it 'should raise an exception' do
-          expect { repository[collection_name] }
-            .to raise_error(error_class, error_message)
+          it 'should raise an exception' do
+            expect { repository[collection_name] }
+              .to raise_error(error_class, error_message)
+          end
         end
-      end
 
-      wrap_context 'when the repository has many collections' do
         describe 'with an invalid string' do
           let(:collection_name) { 'invalid_name' }
 
@@ -70,91 +61,174 @@ module Cuprum::Collections::RSpec
           end
         end
 
-        describe 'with a valid string' do
-          let(:collection_name) { collection_names.first }
+        wrap_context 'when the repository has many collections' do
+          describe 'with an invalid string' do
+            let(:collection_name) { 'invalid_name' }
 
-          it { expect(repository[collection_name]).to be books_collection }
-        end
+            it 'should raise an exception' do
+              expect { repository[collection_name] }
+                .to raise_error(error_class, error_message)
+            end
+          end
 
-        describe 'with a valid symbol' do
-          let(:collection_name) { collection_names.first.intern }
+          describe 'with an invalid symbol' do
+            let(:collection_name) { :invalid_name }
 
-          it { expect(repository[collection_name]).to be books_collection }
+            it 'should raise an exception' do
+              expect { repository[collection_name] }
+                .to raise_error(error_class, error_message)
+            end
+          end
+
+          describe 'with a valid string' do
+            let(:collection)      { collections.values.first }
+            let(:collection_name) { collections.keys.first }
+
+            it { expect(repository[collection_name]).to be collection }
+          end
+
+          describe 'with a valid symbol' do
+            let(:collection)      { collections.values.first }
+            let(:collection_name) { collections.keys.first.intern }
+
+            it { expect(repository[collection_name]).to be collection }
+          end
         end
       end
-    end
 
-    describe '#add' do
-      let(:error_class) do
-        described_class::InvalidCollectionError
-      end
-      let(:error_message) do
-        "#{collection.inspect} is not a valid collection"
-      end
+      describe '#add' do
+        let(:error_class) do
+          described_class::InvalidCollectionError
+        end
+        let(:error_message) do
+          "#{collection.inspect} is not a valid collection"
+        end
 
-      it { expect(repository).to respond_to(:add).with(1).argument }
+        it 'should define the method' do
+          expect(repository)
+            .to respond_to(:add)
+            .with(1).argument
+            .and_keywords(:force)
+        end
 
-      it 'should alias #add as #<<' do
-        expect(repository.method(:<<)).to be == repository.method(:add)
-      end
+        it 'should alias #add as #<<' do
+          expect(repository.method(:<<)).to be == repository.method(:add)
+        end
 
-      describe 'with nil' do
-        let(:collection) { nil }
+        describe 'with nil' do
+          let(:collection) { nil }
 
-        it 'should raise an exception' do
-          expect { repository.add(collection) }
-            .to raise_error(error_class, error_message)
+          it 'should raise an exception' do
+            expect { repository.add(collection) }
+              .to raise_error(error_class, error_message)
+          end
         end
-      end
 
-      describe 'with an object' do
-        let(:collection) { Object.new.freeze }
+        describe 'with an object' do
+          let(:collection) { Object.new.freeze }
 
-        it 'should raise an exception' do
-          expect { repository.add(collection) }
-            .to raise_error(error_class, error_message)
+          it 'should raise an exception' do
+            expect { repository.add(collection) }
+              .to raise_error(error_class, error_message)
+          end
         end
-      end
 
-      describe 'with a collection' do
-        it { expect(repository.add(example_collection)).to be repository }
+        describe 'with a collection' do
+          it { expect(repository.add(example_collection)).to be repository }
 
-        it 'should add the collection to the repository' do
-          repository.add(example_collection)
+          it 'should add the collection to the repository' do
+            repository.add(example_collection)
 
-          expect(repository[example_collection.collection_name])
-            .to be example_collection
-        end
-      end
-    end
+            expect(repository[example_collection.qualified_name])
+              .to be example_collection
+          end
 
-    describe '#key?' do
-      it { expect(repository).to respond_to(:key?).with(1).argument }
+          describe 'with force: true' do
+            it 'should add the collection to the repository' do
+              repository.add(example_collection, force: true)
 
-      it { expect(repository.key? nil).to be false }
+              expect(repository[example_collection.qualified_name])
+                .to be example_collection
+            end
+          end
 
-      it { expect(repository.key? Object.new.freeze).to be false }
+          context 'when the collection already exists' do
+            let(:error_message) do
+              "collection #{example_collection.qualified_name} already exists"
+            end
+
+            before(:example) do
+              allow(repository)
+                .to receive(:key?)
+                .with(example_collection.qualified_name)
+                .and_return(true)
+            end
+
+            it 'should raise an exception' do
+              expect { repository.add(example_collection) }
+                .to raise_error(
+                  described_class::DuplicateCollectionError,
+                  error_message
+                )
+            end
+
+            it 'should not update the repository' do
+              begin
+                repository.add(example_collection)
+              rescue described_class::DuplicateCollectionError
+                # Do nothing.
+              end
+
+              expect { repository[example_collection.qualified_name] }
+                .to raise_error(
+                  described_class::UndefinedCollectionError,
+                  'repository does not define collection ' \
+                  "#{example_collection.qualified_name.inspect}"
+                )
+            end
+
+            describe 'with force: true' do
+              it 'should add the collection to the repository' do
+                repository.add(example_collection, force: true)
+
+                expect(repository[example_collection.qualified_name])
+                  .to be example_collection
+              end
+            end
+          end
+        end
+      end
 
-      it { expect(repository.key? 'invalid_name').to be false }
+      describe '#key?' do
+        it { expect(repository).to respond_to(:key?).with(1).argument }
 
-      it { expect(repository.key? :invalid_name).to be false }
+        it { expect(repository.key? nil).to be false }
+
+        it { expect(repository.key? Object.new.freeze).to be false }
 
-      wrap_context 'when the repository has many collections' do
         it { expect(repository.key? 'invalid_name').to be false }
 
         it { expect(repository.key? :invalid_name).to be false }
 
-        it { expect(repository.key? collection_names.first).to be true }
+        wrap_context 'when the repository has many collections' do
+          it { expect(repository.key? 'invalid_name').to be false }
+
+          it { expect(repository.key? :invalid_name).to be false }
 
-        it { expect(repository.key? collection_names.first.intern).to be true }
+          it { expect(repository.key? collections.keys.first).to be true }
+
+          it 'should include the key' do
+            expect(repository.key? collections.keys.first.intern).to be true
+          end
+        end
       end
-    end
 
-    describe '#keys' do
-      include_examples 'should define reader', :keys, []
+      describe '#keys' do
+        include_examples 'should define reader', :keys, []
 
-      wrap_context 'when the repository has many collections' do
-        it { expect(repository.keys).to be == collection_names }
+        wrap_context 'when the repository has many collections' do
+          it { expect(repository.keys).to be == collections.keys }
+        end
       end
     end
   end

data/lib/cuprum/collections/rspec/update_one_command_contract.rb

@@ -32,9 +32,10 @@ module Cuprum::Collections::RSpec
       context 'when the item does not exist in the collection' do
         let(:expected_error) do
           Cuprum::Collections::Errors::NotFound.new(
-            collection_name:    collection_name,
-            primary_key_name:   primary_key_name,
-            primary_key_values: attributes[primary_key_name]
+            attribute_name:  primary_key_name,
+            attribute_value: attributes[primary_key_name],
+            collection_name: collection_name,
+            primary_key:     true
           )
         end
         let(:matching_data) { mapped_data.first }

data/lib/cuprum/collections/version.rb

@@ -11,7 +11,7 @@ module Cuprum
       # Major version.
       MAJOR = 0
       # Minor version.
-      MINOR = 2
+      MINOR = 3
       # Patch version.
       PATCH = 0
       # Prerelease version.

data/lib/cuprum/collections.rb

@@ -9,6 +9,7 @@ module Cuprum
     autoload :Base,    'cuprum/collections/base'
     autoload :Basic,   'cuprum/collections/basic'
     autoload :Command, 'cuprum/collections/command'
+    autoload :Errors,  'cuprum/collections/errors'
 
     # @return [String] the absolute path to the gem directory.
     def self.gem_path

metadata

@@ -1,119 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: cuprum-collections
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Rob "Merlin" Smith
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-31 00:00:00.000000000 Z
+date: 2023-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cuprum
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.11'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.11'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: stannum
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: rspec-sleeping_king_studios
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.22'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.22'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.5'
-- !ruby/object:Gem::Dependency
-  name: simplecov
+  name: stannum
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
-  type: :development
+        version: '0.3'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.3'
 description: An adapter library to provide a consistent interface between data stores.
 email:
 - merlin@sleepingkingstudios.com
@@ -151,6 +75,10 @@ files:
 - lib/cuprum/collections/commands/abstract_find_many.rb
 - lib/cuprum/collections/commands/abstract_find_matching.rb
 - lib/cuprum/collections/commands/abstract_find_one.rb
+- lib/cuprum/collections/commands/create.rb
+- lib/cuprum/collections/commands/find_one_matching.rb
+- lib/cuprum/collections/commands/update.rb
+- lib/cuprum/collections/commands/upsert.rb
 - lib/cuprum/collections/constraints.rb
 - lib/cuprum/collections/constraints/attribute_name.rb
 - lib/cuprum/collections/constraints/order.rb
@@ -161,6 +89,7 @@ files:
 - lib/cuprum/collections/constraints/ordering.rb
 - lib/cuprum/collections/constraints/query_hash.rb
 - lib/cuprum/collections/errors.rb
+- lib/cuprum/collections/errors/abstract_find_error.rb
 - lib/cuprum/collections/errors/already_exists.rb
 - lib/cuprum/collections/errors/extra_attributes.rb
 - lib/cuprum/collections/errors/failed_validation.rb
@@ -168,6 +97,7 @@ files:
 - lib/cuprum/collections/errors/invalid_query.rb
 - lib/cuprum/collections/errors/missing_default_contract.rb
 - lib/cuprum/collections/errors/not_found.rb
+- lib/cuprum/collections/errors/not_unique.rb
 - lib/cuprum/collections/errors/unknown_operator.rb
 - lib/cuprum/collections/queries.rb
 - lib/cuprum/collections/queries/ordering.rb
@@ -200,7 +130,8 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/sleepingkingstudios/cuprum-collections/issues
   source_code_uri: https://github.com/sleepingkingstudios/cuprum-collections
-post_install_message: 
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -208,15 +139,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.4.13
+signing_key:
 specification_version: 4
 summary: A data abstraction layer based on the Cuprum library.
 test_files: []