cuprum-collections 0.1.0 → 0.3.0.rc.0

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

@@ -58,10 +58,15 @@ module Cuprum::Collections::RSpec
       describe 'with an array of invalid primary keys' do
         let(:primary_keys) { invalid_primary_key_values }
         let(:expected_error) do
-          Cuprum::Collections::Errors::NotFound.new(
-            collection_name:    command.collection_name,
-            primary_key_name:   primary_key_name,
-            primary_key_values: primary_keys
+          Cuprum::Errors::MultipleErrors.new(
+            errors: primary_keys.map do |primary_key|
+              Cuprum::Collections::Errors::NotFound.new(
+                attribute_name:  primary_key_name,
+                attribute_value: primary_key,
+                collection_name: command.collection_name,
+                primary_key:     true
+              )
+            end
           )
         end
 
@@ -79,7 +84,6 @@ module Cuprum::Collections::RSpec
             .map do |key|
               mapped_data.find { |item| item[primary_key_name.to_s] == key }
             end
-            .compact
         end
         let(:expected_data) do
           defined?(super()) ? super() : matching_data
@@ -88,10 +92,15 @@ module Cuprum::Collections::RSpec
         describe 'with an array of invalid primary keys' do
           let(:primary_keys) { invalid_primary_key_values }
           let(:expected_error) do
-            Cuprum::Collections::Errors::NotFound.new(
-              collection_name:    command.collection_name,
-              primary_key_name:   primary_key_name,
-              primary_key_values: primary_keys
+            Cuprum::Errors::MultipleErrors.new(
+              errors: primary_keys.map do |primary_key|
+                Cuprum::Collections::Errors::NotFound.new(
+                  attribute_name:  primary_key_name,
+                  attribute_value: primary_key,
+                  collection_name: command.collection_name,
+                  primary_key:     true
+                )
+              end
             )
           end
 
@@ -107,10 +116,17 @@ module Cuprum::Collections::RSpec
             invalid_primary_key_values + valid_primary_key_values
           end
           let(:expected_error) do
-            Cuprum::Collections::Errors::NotFound.new(
-              collection_name:    command.collection_name,
-              primary_key_name:   primary_key_name,
-              primary_key_values: invalid_primary_key_values
+            Cuprum::Errors::MultipleErrors.new(
+              errors: primary_keys.map do |primary_key|
+                next nil unless invalid_primary_key_values.include?(primary_key)
+
+                Cuprum::Collections::Errors::NotFound.new(
+                  attribute_name:  primary_key_name,
+                  attribute_value: primary_key,
+                  collection_name: command.collection_name,
+                  primary_key:     true
+                )
+              end
             )
           end
 
@@ -145,10 +161,15 @@ module Cuprum::Collections::RSpec
           describe 'with an array of invalid primary keys' do
             let(:primary_keys) { invalid_primary_key_values }
             let(:expected_error) do
-              Cuprum::Collections::Errors::NotFound.new(
-                collection_name:    command.collection_name,
-                primary_key_name:   primary_key_name,
-                primary_key_values: primary_keys
+              Cuprum::Errors::MultipleErrors.new(
+                errors: invalid_primary_key_values.map do |primary_key|
+                  Cuprum::Collections::Errors::NotFound.new(
+                    attribute_name:  primary_key_name,
+                    attribute_value: primary_key,
+                    collection_name: command.collection_name,
+                    primary_key:     true
+                  )
+                end
               )
             end
 
@@ -163,6 +184,22 @@ module Cuprum::Collections::RSpec
             let(:primary_keys) do
               invalid_primary_key_values + valid_primary_key_values
             end
+            let(:expected_error) do
+              Cuprum::Errors::MultipleErrors.new(
+                errors: primary_keys.map do |primary_key|
+                  unless invalid_primary_key_values.include?(primary_key)
+                    next nil
+                  end
+
+                  Cuprum::Collections::Errors::NotFound.new(
+                    attribute_name:  primary_key_name,
+                    attribute_value: primary_key,
+                    collection_name: command.collection_name,
+                    primary_key:     true
+                  )
+                end
+              )
+            end
 
             it 'should return a passing result' do
               expect(
@@ -170,6 +207,7 @@ module Cuprum::Collections::RSpec
               )
                 .to be_a_passing_result
                 .with_value(expected_data)
+                .and_error(expected_error)
             end
           end
 
@@ -226,10 +264,15 @@ module Cuprum::Collections::RSpec
           describe 'with an array of invalid primary keys' do
             let(:primary_keys) { invalid_primary_key_values }
             let(:expected_error) do
-              Cuprum::Collections::Errors::NotFound.new(
-                collection_name:    command.collection_name,
-                primary_key_name:   primary_key_name,
-                primary_key_values: primary_keys
+              Cuprum::Errors::MultipleErrors.new(
+                errors: primary_keys.map do |primary_key|
+                  Cuprum::Collections::Errors::NotFound.new(
+                    attribute_name:  primary_key_name,
+                    attribute_value: primary_key,
+                    collection_name: command.collection_name,
+                    primary_key:     true
+                  )
+                end
               )
             end
 
@@ -246,10 +289,15 @@ module Cuprum::Collections::RSpec
             describe 'with a valid array of primary keys' do
               let(:primary_keys) { valid_primary_key_values }
               let(:expected_error) do
-                Cuprum::Collections::Errors::NotFound.new(
-                  collection_name:    command.collection_name,
-                  primary_key_name:   primary_key_name,
-                  primary_key_values: primary_keys
+                Cuprum::Errors::MultipleErrors.new(
+                  errors: primary_keys.map do |primary_key|
+                    Cuprum::Collections::Errors::NotFound.new(
+                      attribute_name:  primary_key_name,
+                      attribute_value: primary_key,
+                      collection_name: command.collection_name,
+                      primary_key:     true
+                    )
+                  end
                 )
               end
 
@@ -264,20 +312,32 @@ module Cuprum::Collections::RSpec
           describe 'with a scope that matches some keys' do
             let(:scope_filter) { -> { { series: nil } } }
             let(:matching_data) do
-              super().select { |item| item['series'].nil? }
+              super().map do |item|
+                next nil unless item['series'].nil?
+
+                item
+              end
             end
 
             describe 'with a valid array of primary keys' do
               let(:primary_keys) { valid_primary_key_values }
               let(:expected_error) do
-                found_keys   =
-                  matching_data.map { |item| item[primary_key_name.to_s] }
-                missing_keys = primary_keys - found_keys
-
-                Cuprum::Collections::Errors::NotFound.new(
-                  collection_name:    command.collection_name,
-                  primary_key_name:   primary_key_name,
-                  primary_key_values: missing_keys
+                found_keys =
+                  matching_data
+                    .compact
+                    .map { |item| item[primary_key_name.to_s] }
+
+                Cuprum::Errors::MultipleErrors.new(
+                  errors: primary_keys.map do |primary_key|
+                    next if found_keys.include?(primary_key)
+
+                    Cuprum::Collections::Errors::NotFound.new(
+                      attribute_name:  primary_key_name,
+                      attribute_value: primary_key,
+                      collection_name: command.collection_name,
+                      primary_key:     true
+                    )
+                  end
                 )
               end
 
@@ -291,6 +351,25 @@ module Cuprum::Collections::RSpec
             describe 'with allow_partial: true' do
               describe 'with a valid array of primary keys' do
                 let(:primary_keys) { valid_primary_key_values }
+                let(:expected_error) do
+                  found_keys =
+                    matching_data
+                      .compact
+                      .map { |item| item[primary_key_name.to_s] }
+
+                  Cuprum::Errors::MultipleErrors.new(
+                    errors: primary_keys.map do |primary_key|
+                      next if found_keys.include?(primary_key)
+
+                      Cuprum::Collections::Errors::NotFound.new(
+                        attribute_name:  primary_key_name,
+                        attribute_value: primary_key,
+                        collection_name: command.collection_name,
+                        primary_key:     true
+                      )
+                    end
+                  )
+                end
 
                 it 'should return a passing result' do
                   expect(
@@ -302,6 +381,7 @@ module Cuprum::Collections::RSpec
                   )
                     .to be_a_passing_result
                     .with_value(expected_data)
+                    .and_error(expected_error)
                 end
               end
             end

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

@@ -47,9 +47,10 @@ module Cuprum::Collections::RSpec
         let(:primary_key) { invalid_primary_key_value }
         let(:expected_error) do
           Cuprum::Collections::Errors::NotFound.new(
-            collection_name:    command.collection_name,
-            primary_key_name:   primary_key_name,
-            primary_key_values: primary_key
+            attribute_name:  primary_key_name,
+            attribute_value: primary_key,
+            collection_name: command.collection_name,
+            primary_key:     true
           )
         end
 
@@ -73,9 +74,10 @@ module Cuprum::Collections::RSpec
           let(:primary_key) { invalid_primary_key_value }
           let(:expected_error) do
             Cuprum::Collections::Errors::NotFound.new(
-              collection_name:    command.collection_name,
-              primary_key_name:   primary_key_name,
-              primary_key_values: primary_key
+              attribute_name:  primary_key_name,
+              attribute_value: primary_key,
+              collection_name: command.collection_name,
+              primary_key:     true
             )
           end
 
@@ -120,9 +122,10 @@ module Cuprum::Collections::RSpec
               let(:primary_key) { valid_primary_key_value }
               let(:expected_error) do
                 Cuprum::Collections::Errors::NotFound.new(
-                  collection_name:    command.collection_name,
-                  primary_key_name:   primary_key_name,
-                  primary_key_values: primary_key
+                  attribute_name:  primary_key_name,
+                  attribute_value: primary_key,
+                  collection_name: command.collection_name,
+                  primary_key:     true
                 )
               end
 

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

@@ -61,9 +61,10 @@ module Cuprum::Collections::RSpec
         let(:data) { fixtures_data }
         let(:expected_error) do
           Cuprum::Collections::Errors::AlreadyExists.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
 

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

@@ -386,8 +386,8 @@ module Cuprum::Collections::RSpec # rubocop:disable Style/Documentation
     describe '#order' do
       let(:default_order) { defined?(super()) ? super() : {} }
       let(:error_message) do
-        'order must be a list of attribute names and/or a hash of attribute' \
-          ' names with values :asc or :desc'
+        'order must be a list of attribute names and/or a hash of attribute ' \
+          'names with values :asc or :desc'
       end
 
       it 'should define the method' do
@@ -397,7 +397,7 @@ module Cuprum::Collections::RSpec # rubocop:disable Style/Documentation
           .and_unlimited_arguments
       end
 
-      it { expect(query).to alias_method(:order).as(:order_by) }
+      it { expect(query).to have_aliased_method(:order).as(:order_by) }
 
       describe 'with no arguments' do
         it { expect(query.order).to be == default_order }

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

@@ -76,8 +76,8 @@ module Cuprum::Collections::RSpec
       end
     end
 
-    shared_context 'when the query has where: a greater_than_or_equal_to' \
-                   ' filter' \
+    shared_context 'when the query has where: a greater_than_or_equal_to ' \
+                   'filter' \
     do
       let(:filter) do
         -> { { published_at: greater_than_or_equal_to('1970-12-01') } }

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

@@ -0,0 +1,235 @@
+# 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.
+  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
+        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)
+          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)
+          end
+        end
+
+        describe 'with an invalid string' do
+          let(:collection_name) { 'invalid_name' }
+
+          it 'should raise an exception' do
+            expect { repository[collection_name] }
+              .to raise_error(error_class, error_message)
+          end
+        end
+
+        describe 'with an invalid symbol' do
+          let(:collection_name) { :invalid_name }
+
+          it 'should raise an exception' do
+            expect { repository[collection_name] }
+              .to raise_error(error_class, error_message)
+          end
+        end
+
+        wrap_context 'when the repository has many collections' do
+          describe 'with an invalid string' do
+            let(:collection_name) { 'invalid_name' }
+
+            it 'should raise an exception' do
+              expect { repository[collection_name] }
+                .to raise_error(error_class, error_message)
+            end
+          end
+
+          describe 'with an invalid symbol' do
+            let(:collection_name) { :invalid_name }
+
+            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
+
+      describe '#add' do
+        let(:error_class) do
+          described_class::InvalidCollectionError
+        end
+        let(:error_message) do
+          "#{collection.inspect} is not a valid collection"
+        end
+
+        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
+
+        describe 'with nil' do
+          let(:collection) { nil }
+
+          it 'should raise an exception' do
+            expect { repository.add(collection) }
+              .to raise_error(error_class, error_message)
+          end
+        end
+
+        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)
+          end
+        end
+
+        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)
+
+            expect(repository[example_collection.qualified_name])
+              .to be example_collection
+          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
+
+          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
+
+      describe '#key?' do
+        it { expect(repository).to respond_to(:key?).with(1).argument }
+
+        it { expect(repository.key? nil).to be false }
+
+        it { expect(repository.key? Object.new.freeze).to be false }
+
+        it { expect(repository.key? 'invalid_name').to be false }
+
+        it { expect(repository.key? :invalid_name).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? 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
+
+      describe '#keys' do
+        include_examples 'should define reader', :keys, []
+
+        wrap_context 'when the repository has many collections' do
+          it { expect(repository.keys).to be == collections.keys }
+        end
+      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,13 +11,13 @@ module Cuprum
       # Major version.
       MAJOR = 0
       # Minor version.
-      MINOR = 1
+      MINOR = 3
       # Patch version.
       PATCH = 0
       # Prerelease version.
-      PRERELEASE = nil
+      PRERELEASE = :rc
       # Build metadata.
-      BUILD = nil
+      BUILD = 0
 
       class << self
         # Generates the gem version string from the Version constants.

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