cuprum-collections 0.2.0 → 0.3.0

data/lib/cuprum/collections/errors/extra_attributes.rb

@@ -38,29 +38,19 @@ module Cuprum::Collections::Errors
     # @return [Array<String>] The names of valid attributes for the entity.
     attr_reader :valid_attributes
 
-    # @return [Hash] a serializable hash representation of the error.
-    def as_json
+    private
+
+    def as_json_data
       {
-        'data'    => {
-          'entity_class'     => entity_class.name,
-          'extra_attributes' => extra_attributes,
-          'valid_attributes' => valid_attributes
-        },
-        'message' => message,
-        'type'    => type
+        'entity_class'     => entity_class.name,
+        'extra_attributes' => extra_attributes,
+        'valid_attributes' => valid_attributes
       }
     end
 
-    # @return [String] short string used to identify the type of error.
-    def type
-      TYPE
-    end
-
-    private
-
     def default_message
-      "invalid attributes for #{entity_class.name}:" \
-        " #{extra_attributes.join(', ')}"
+      "invalid attributes for #{entity_class.name}: " \
+        "#{extra_attributes.join(', ')}"
     end
   end
 end

data/lib/cuprum/collections/errors/failed_validation.rb

@@ -7,9 +7,6 @@ require 'cuprum/collections/errors'
 module Cuprum::Collections::Errors
   # Error returned when a collection item fails validation.
   class FailedValidation < Cuprum::Error
-    COMPARABLE_PROPERTIES = %i[entity_class errors message].freeze
-    private_constant :COMPARABLE_PROPERTIES
-
     # Short string used to identify the type of error.
     TYPE = 'cuprum.collections.errors.failed_validation'
 
@@ -33,25 +30,15 @@ module Cuprum::Collections::Errors
     # @return [Stannum::Errors] The errors generated when validating the entity.
     attr_reader :errors
 
-    # @return [Hash] a serializable hash representation of the error.
-    def as_json
+    private
+
+    def as_json_data
       {
-        'data'    => {
-          'entity_class' => entity_class.name,
-          'errors'       => format_errors
-        },
-        'message' => message,
-        'type'    => type
+        'entity_class' => entity_class.name,
+        'errors'       => format_errors
       }
     end
 
-    # @return [String] short string used to identify the type of error.
-    def type
-      TYPE
-    end
-
-    private
-
     def default_message
       "#{entity_class.name} failed validation"
     end

data/lib/cuprum/collections/errors/invalid_parameters.rb

@@ -24,27 +24,19 @@ module Cuprum::Collections::Errors
       )
     end
 
-    # @return [Hash] a serializable hash representation of the error.
-    def as_json
-      {
-        'data'    => {
-          'command_class' => command.class.name,
-          'errors'        => errors.to_a
-        },
-        'message' => message,
-        'type'    => type
-      }
-    end
-
     # @return [Cuprum::Command] the called command.
     attr_reader :command
 
     # @return [Stannum::Errors] the errors returned by the parameters contract.
     attr_reader :errors
 
-    # @return [String] short string used to identify the type of error.
-    def type
-      TYPE
+    private
+
+    def as_json_data
+      {
+        'command_class' => command.class.name,
+        'errors'        => errors.to_a
+      }
     end
   end
 end

data/lib/cuprum/collections/errors/invalid_query.rb

@@ -29,25 +29,15 @@ module Cuprum::Collections::Errors
     # @return [Symbol] the strategy used to construct the query.
     attr_reader :strategy
 
-    # @return [Hash] a serializable hash representation of the error.
-    def as_json
+    private
+
+    def as_json_data
       {
-        'data'    => {
-          'errors'   => errors.to_a,
-          'strategy' => strategy
-        },
-        'message' => message,
-        'type'    => type
+        'errors'   => errors.to_a,
+        'strategy' => strategy
       }
     end
 
-    # @return [String] short string used to identify the type of error.
-    def type
-      TYPE
-    end
-
-    private
-
     def default_message
       "unable to parse query with strategy #{strategy.inspect}"
     end

data/lib/cuprum/collections/errors/missing_default_contract.rb

@@ -23,27 +23,15 @@ module Cuprum::Collections::Errors
     # @return [Class] the class of the assigned entity.
     attr_reader :entity_class
 
-    # @return [Hash] a serializable hash representation of the error.
-    def as_json
-      {
-        'data'    => {
-          'entity_class' => entity_class.name
-        },
-        'message' => message,
-        'type'    => type
-      }
-    end
+    private
 
-    # @return [String] short string used to identify the type of error.
-    def type
-      TYPE
+    def as_json_data
+      { 'entity_class' => entity_class.name }
     end
 
-    private
-
     def default_message
-      "attempted to validate a #{entity_class.name}, but #{entity_class.name}" \
-        ' does not define a default contract'
+      "attempted to validate a #{entity_class.name}, but " \
+        "#{entity_class.name} does not define a default contract"
     end
   end
 end

data/lib/cuprum/collections/errors/not_found.rb

@@ -1,81 +1,18 @@
 # frozen_string_literal: true
 
-require 'cuprum/error'
-require 'sleeping_king_studios/tools/toolbelt'
-
 require 'cuprum/collections/errors'
+require 'cuprum/collections/errors/abstract_find_error'
 
 module Cuprum::Collections::Errors
   # Returned when a find command does not find the requested items.
-  class NotFound < Cuprum::Error
+  class NotFound < Cuprum::Collections::Errors::AbstractFindError
     # Short string used to identify the type of error.
     TYPE = 'cuprum.collections.errors.not_found'
 
-    # @param collection_name [String, Symbol] The name of the collection.
-    # @param primary_key_name [String, Symbol] The name of the primary key
-    #   attribute.
-    # @param primary_key_values [Object, Array] The expected values of the
-    #   primary key attribute.
-    def initialize(collection_name:, primary_key_name:, primary_key_values:)
-      @collection_name    = collection_name
-      @primary_key_name   = primary_key_name
-      @primary_key_values = Array(primary_key_values)
-
-      super(message: default_message)
-    end
-
-    # @return [String, Symbol] the name of the collection.
-    attr_reader :collection_name
-
-    # @return [String, Symbol] the name of the primary key attribute.
-    attr_reader :primary_key_name
-
-    # @return [Array] The expected values of the primary key attribute.
-    attr_reader :primary_key_values
-
-    # @return [Hash] a serializable hash representation of the error.
-    def as_json
-      {
-        'data'    => {
-          'collection_name'    => collection_name,
-          'primary_key_name'   => primary_key_name,
-          'primary_key_values' => primary_key_values
-        },
-        'message' => message,
-        'type'    => type
-      }
-    end
-
-    # @return [String] short string used to identify the type of error.
-    def type
-      TYPE
-    end
-
     private
 
-    def default_message
-      primary_keys = primary_key_values.map(&:inspect).join(', ')
-
-      "#{entity_name} not found with #{primary_key_name} #{primary_keys}"
-    end
-
-    def entity_name
-      entity_name = collection_name
-      entity_name = tools.str.singularize(entity_name) if singular?
-
-      titleize(entity_name)
-    end
-
-    def singular?
-      primary_key_values.size == 1
-    end
-
-    def titleize(string)
-      tools.str.underscore(string).split('_').map(&:capitalize).join(' ')
-    end
-
-    def tools
-      SleepingKingStudios::Tools::Toolbelt.instance
+    def message_fragment
+      'not found'
     end
   end
 end

data/lib/cuprum/collections/errors/not_unique.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'cuprum/collections/errors'
+require 'cuprum/collections/errors/abstract_find_error'
+
+module Cuprum::Collections::Errors
+  # Returned when a unique find command does finds multiple items.
+  class NotUnique < Cuprum::Collections::Errors::AbstractFindError
+    # Short string used to identify the type of error.
+    TYPE = 'cuprum.collections.errors.not_unique'
+
+    private
+
+    def message_fragment
+      'not unique'
+    end
+  end
+end

data/lib/cuprum/collections/errors/unknown_operator.rb

@@ -22,18 +22,6 @@ module Cuprum::Collections::Errors
     # @return [String, Symbol] the unknown operator.
     attr_reader :operator
 
-    # @return [Hash] a serializable hash representation of the error.
-    def as_json
-      {
-        'data'    => {
-          'corrections' => corrections,
-          'operator'    => operator
-        },
-        'message' => message,
-        'type'    => type
-      }
-    end
-
     # @return [Array<String>] Suggested possible values for the operator.
     def corrections
       @corrections ||=
@@ -42,13 +30,15 @@ module Cuprum::Collections::Errors
           .correct(operator)
     end
 
-    # @return [String] short string used to identify the type of error.
-    def type
-      TYPE
-    end
-
     private
 
+    def as_json_data
+      {
+        'corrections' => corrections,
+        'operator'    => operator
+      }
+    end
+
     def generate_message
       message = "unknown operator #{operator.inspect}"
 

data/lib/cuprum/collections/errors.rb

@@ -4,5 +4,17 @@ require 'cuprum/collections'
 
 module Cuprum::Collections
   # Namespace for errors, which represent failure states of commands.
-  module Errors; end
+  module Errors
+    autoload :AbstractFindError, 'cuprum/collections/errors/abstract_find_error'
+    autoload :AlreadyExists,     'cuprum/collections/errors/already_exists'
+    autoload :ExtraAttributes,   'cuprum/collections/errors/extra_attributes'
+    autoload :FailedValidation,  'cuprum/collections/errors/failed_validation'
+    autoload :InvalidParameters, 'cuprum/collections/errors/invalid_parameters'
+    autoload :InvalidQuery,      'cuprum/collections/errors/invalid_query'
+    autoload :MissingDefaultContract,
+      'cuprum/collections/errors/missing_default_contract'
+    autoload :NotFound,          'cuprum/collections/errors/not_found'
+    autoload :NotUnique,         'cuprum/collections/errors/not_unique'
+    autoload :UnknownOperator,   'cuprum/collections/errors/unknown_operator'
+  end
 end

data/lib/cuprum/collections/queries/ordering.rb

@@ -68,8 +68,8 @@ module Cuprum::Collections::Queries
         return if ordering_constraint.matches?(attributes)
 
         raise InvalidOrderError,
-          '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
     end
   end

data/lib/cuprum/collections/repository.rb

@@ -16,6 +16,9 @@ module Cuprum::Collections
   class Repository
     extend Forwardable
 
+    # Error raised when trying to add an existing collection to the repository.
+    class DuplicateCollectionError < StandardError; end
+
     # Error raised when trying to add an invalid collection to the repository.
     class InvalidCollectionError < StandardError; end
 
@@ -35,17 +38,17 @@ module Cuprum::Collections
 
     # Finds and returns the collection with the given name.
     #
-    # @param collection_name [String, Symbol] The name of the collection to
-    #   return.
+    # @param qualified_name [String, Symbol] The qualified name of the
+    #   collection to return.
     #
     # @return [Object] the requested collection.
     #
     # @raise [Cuprum::Collection::Repository::UndefinedCOllectionError] if the
     #   requested collection is not in the repository.
-    def [](collection_name)
-      @collections.fetch(collection_name.to_s) do
+    def [](qualified_name)
+      @collections.fetch(qualified_name.to_s) do
         raise UndefinedCollectionError,
-          "repository does not define collection #{collection_name.inspect}"
+          "repository does not define collection #{qualified_name.inspect}"
       end
     end
 
@@ -56,12 +59,22 @@ module Cuprum::Collections
     #
     # @param collection [#collection_name] The collection to add to the
     #   repository.
+    # @param force [true, false] If true, override an existing collection with
+    #   the same name.
     #
     # @return [Cuprum::Rails::Repository] the repository.
-    def add(collection)
+    #
+    # @raise [DuplicateCollectionError] if a collection with the same name
+    #   already exists in the repository.
+    def add(collection, force: false)
       validate_collection!(collection)
 
-      @collections[collection.collection_name.to_s] = collection
+      if !force && key?(collection.qualified_name.to_s)
+        raise DuplicateCollectionError,
+          "collection #{collection.qualified_name} already exists"
+      end
+
+      @collections[collection.qualified_name.to_s] = collection
 
       self
     end
@@ -69,11 +82,11 @@ module Cuprum::Collections
 
     # Checks if a collection with the given name exists in the repository.
     #
-    # @param collection_name [String, Symbol] The name to check for.
+    # @param qualified_name [String, Symbol] The name to check for.
     #
     # @return [true, false] true if the key exists, otherwise false.
-    def key?(collection_name)
-      @collections.key?(collection_name.to_s)
+    def key?(qualified_name)
+      @collections.key?(qualified_name.to_s)
     end
 
     private