cuprum-collections 0.4.0 → 0.5.0

data/lib/cuprum/collections/basic/commands/find_matching.rb

@@ -101,26 +101,10 @@ module Cuprum::Collections::Basic::Commands
     #     @return [Cuprum::Result<Hash{String, Array<Hash{String, Object}>}>] a
     #       hash with the collection name as key and the matching items as
     #       value.
-
-    validate_parameters :call do
-      keyword :envelope,
-        Stannum::Constraints::Boolean.new,
-        default: true
-      keyword :limit, Integer, optional: true
-      keyword :offset, Integer, optional: true
-      keyword :order,
-        Cuprum::Collections::Constraints::Ordering.new,
-        optional: true
-      keyword :scope,
-        Cuprum::Collections::Basic::Query,
-        optional: true
-      keyword :where, Object, optional: true
-    end
-
-    private
-
-    def build_query
-      Cuprum::Collections::Basic::Query.new(data)
-    end
+    validate :envelope, :boolean, optional: true
+    validate :limit,    Integer,  optional: true
+    validate :offset,   Integer,  optional: true
+    validate :order
+    validate :where
   end
 end

data/lib/cuprum/collections/basic/commands/find_one.rb

@@ -11,7 +11,7 @@ module Cuprum::Collections::Basic::Commands
   class FindOne < Cuprum::Collections::Basic::Command
     include Cuprum::Collections::Commands::AbstractFindOne
 
-    # @!method call(primary_key:, envelope: false, scope: nil)
+    # @!method call(primary_key:, envelope: false)
     #   Queries the collection for the item with the given primary key.
     #
     #   The command will find and return the entity with the given primary key.
@@ -23,27 +23,10 @@ module Cuprum::Collections::Basic::Commands
     #
     #   @param envelope [Boolean] If true, wraps the result value in a Hash.
     #   @param primary_key [Object] The primary key of the requested item.
-    #   @param scope [Cuprum::Collections::Basic::Query, nil] Optional scope for
-    #     the query. The item must match the scope as well as the primary key.
     #
     #   @return [Cuprum::Result<Hash{String, Object}>] a result with the
     #     requested item.
-    validate_parameters :call do
-      keyword :envelope,    Stannum::Constraints::Boolean.new, default: true
-      keyword :primary_key, Object
-      keyword :scope,       Cuprum::Collections::Basic::Query, optional: true
-    end
-
-    private
-
-    def build_query
-      Cuprum::Collections::Basic::Query.new(data)
-    end
-
-    def process(primary_key:, envelope: false, scope: nil)
-      step { validate_primary_key(primary_key) }
-
-      super
-    end
+    validate :envelope, :boolean, optional: true
+    validate :primary_key
   end
 end

data/lib/cuprum/collections/basic/commands/insert_one.rb

@@ -18,10 +18,7 @@ module Cuprum::Collections::Basic::Commands
     #   @param entity [Hash] The collection entity to persist.
     #
     #   @return [Cuprum::Result<Hash>] the persisted entity.
-    validate_parameters :call do
-      keyword :entity,
-        Stannum::Constraints::Types::HashWithStringKeys.new
-    end
+    validate :entity
 
     private
 
@@ -34,14 +31,14 @@ module Cuprum::Collections::Basic::Commands
       error = Cuprum::Collections::Errors::AlreadyExists.new(
         attribute_name:  primary_key_name,
         attribute_value: value,
-        collection_name: collection_name,
+        collection_name:,
         primary_key:     true
       )
       failure(error)
     end
 
     def process(entity:)
-      step { find_existing(entity: entity) }
+      step { find_existing(entity:) }
 
       data << tools.hash_tools.deep_dup(entity)
 

data/lib/cuprum/collections/basic/commands/update_one.rb

@@ -18,10 +18,7 @@ module Cuprum::Collections::Basic::Commands
     #   @param entity [Hash] The collection entity to persist.
     #
     #   @return [Cuprum::Result<Hash>] the persisted entity.
-    validate_parameters :call do
-      keyword :entity,
-        Stannum::Constraints::Types::HashWithStringKeys.new
-    end
+    validate :entity
 
     private
 
@@ -34,14 +31,14 @@ module Cuprum::Collections::Basic::Commands
       error = Cuprum::Collections::Errors::NotFound.new(
         attribute_name:  primary_key_name,
         attribute_value: entity[primary_key_name.to_s],
-        collection_name: collection_name,
+        collection_name:,
         primary_key:     true
       )
       failure(error)
     end
 
     def process(entity:)
-      index = step { find_existing(entity: entity) }
+      index = step { find_existing(entity:) }
 
       entity = data[index].merge(entity)
 

data/lib/cuprum/collections/basic/commands/validate_one.rb

@@ -24,13 +24,8 @@ module Cuprum::Collections::Basic::Commands
     #   @param entity [Hash] The collection entity to validate.
     #
     #   @return [Cuprum::Result<Hash>] the validated entity.
-    validate_parameters :call do
-      keyword :contract,
-        Stannum::Constraints::Base,
-        optional: true
-      keyword :entity,
-        Stannum::Constraints::Types::HashWithStringKeys.new
-    end
+    validate :contract, Stannum::Constraints::Base, optional: true
+    validate :entity
 
     private
 
@@ -45,25 +40,25 @@ module Cuprum::Collections::Basic::Commands
       failure(error)
     end
 
-    def process(entity:, contract: nil)
-      contract =
-        step { contract_or_default(contract: contract, entity: entity) }
-
-      step { validate_entity(contract: contract, entity: entity) }
-
-      entity
-    end
-
-    def validate_entity(contract:, entity:)
+    def match_entity(contract:, entity:)
       valid, errors = contract.match(entity)
 
       return if valid
 
       error = Cuprum::Collections::Errors::FailedValidation.new(
         entity_class: entity.class,
-        errors:       errors
+        errors:
       )
       failure(error)
     end
+
+    def process(entity:, contract: nil)
+      contract =
+        step { contract_or_default(contract:, entity:) }
+
+      step { match_entity(contract:, entity:) }
+
+      entity
+    end
   end
 end

data/lib/cuprum/collections/basic/query.rb

@@ -1,24 +1,20 @@
 # frozen_string_literal: true
 
 require 'cuprum/collections/basic'
-require 'cuprum/collections/basic/query_builder'
+require 'cuprum/collections/basic/scopes/all_scope'
 require 'cuprum/collections/query'
 
 module Cuprum::Collections::Basic
   # Concrete implementation of a Query for an in-memory collection.
   class Query < Cuprum::Collections::Query
-    include Enumerable
-
     # @param data [Array<Hash>] The current data in the collection. Should be an
     #   Array of Hashes, each of which represents one item in the collection.
-    def initialize(data)
-      super()
-
-      @data    = data
-      @filters = []
-      @limit   = nil
-      @offset  = nil
-      @order   = {}
+    # @param scope [Cuprum::Collections::Scopes::Base] the base scope for the
+    #   query. Defaults to nil.
+    def initialize(data, scope: nil)
+      super(scope:)
+
+      @data = data
     end
 
     # Iterates through the collection, yielding each item matching the query.
@@ -48,10 +44,10 @@ module Cuprum::Collections::Basic
     # @see #order
     # @see #to_a
     # @see #where
-    def each(&block)
-      return enum_for(:each) unless block_given?
+    def each(...)
+      return enum_for(:each, ...) unless block_given?
 
-      filtered_data.each(&block)
+      scoped_data.each(...)
     end
 
     # Checks for the presence of collection items matching the query.
@@ -62,9 +58,9 @@ module Cuprum::Collections::Basic
     #
     # @return [Boolean] true if any items match the query; otherwise false.
     def exists?
-      data.any? do |item|
-        @filters.all? { |filter| filter.call(item) }
-      end
+      return data.any? unless scope
+
+      data.any? { |item| scope.match?(item:) }
     end
 
     # Returns an array containing each collection item matching the query.
@@ -90,23 +86,13 @@ module Cuprum::Collections::Basic
     # @see #order
     # @see #where
     def to_a
-      filtered_data
+      scoped_data
     end
 
     protected
 
-    def query_builder
-      Cuprum::Collections::Basic::QueryBuilder.new(self)
-    end
-
     def reset!
-      @filtered_data = nil
-
-      self
-    end
-
-    def with_filters(filters)
-      @filters += filters
+      @scoped_data = nil
 
       self
     end
@@ -115,14 +101,6 @@ module Cuprum::Collections::Basic
 
     attr_reader :data
 
-    attr_reader :filters
-
-    def apply_filters(data)
-      data.select do |item|
-        @filters.all? { |filter| filter.call(item) }
-      end
-    end
-
     def apply_limit_offset(data)
       return data[@offset...(@offset + @limit)] || [] if @limit && @offset
       return data[0...@limit] if @limit
@@ -148,10 +126,18 @@ module Cuprum::Collections::Basic
       end
     end
 
-    def filtered_data
-      @filtered_data ||=
+    def apply_scope(data)
+      scope ? scope.call(data:) : data
+    end
+
+    def default_scope
+      Cuprum::Collections::Basic::Scopes::AllScope.instance
+    end
+
+    def scoped_data
+      @scoped_data ||=
         data
-          .then { |ary| apply_filters(ary) }
+          .then { |ary| apply_scope(ary) }
           .then { |ary| apply_order(ary) }
           .then { |ary| apply_limit_offset(ary) }
           .map(&:dup)

data/lib/cuprum/collections/basic/repository.rb

@@ -2,6 +2,7 @@
 
 require 'cuprum/collections/basic'
 require 'cuprum/collections/basic/collection'
+require 'cuprum/collections/relations/parameters'
 require 'cuprum/collections/repository'
 
 module Cuprum::Collections::Basic
@@ -21,13 +22,13 @@ module Cuprum::Collections::Basic
       validate_data!(data)
 
       qualified_name =
-        Cuprum::Collections::Relation::Disambiguation
-          .resolve_parameters(parameters, name: :collection_name)
+        Cuprum::Collections::Relations::Parameters
+          .resolve_parameters(parameters)
           .fetch(:qualified_name)
 
       data ||= @data.fetch(qualified_name, [])
 
-      Cuprum::Collections::Basic.new(data: data, **parameters)
+      Cuprum::Collections::Basic.new(data:, **parameters)
     end
 
     def valid_collection?(collection)

data/lib/cuprum/collections/basic/scopes/all_scope.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'cuprum/collections/basic/scopes'
+require 'cuprum/collections/basic/scopes/base'
+require 'cuprum/collections/scopes/all'
+
+module Cuprum::Collections::Basic::Scopes
+  # Scope for returning unfiltered data.
+  class AllScope < Cuprum::Collections::Basic::Scopes::Base
+    include Cuprum::Collections::Scopes::All
+
+    # @return [Cuprum::Collections::Basic::Scopes::AllScope] a cached instance
+    #   of the all scope.
+    def self.instance
+      @instance ||= new
+    end
+
+    # Filters the provided data.
+    def call(data:)
+      raise ArgumentError, 'data must be an Array' unless data.is_a?(Array)
+
+      data
+    end
+  end
+end

data/lib/cuprum/collections/basic/scopes/base.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'cuprum/collections/basic/scopes'
+require 'cuprum/collections/scopes/base'
+
+module Cuprum::Collections::Basic::Scopes
+  # Abstract class representing a set of filters for a basic query.
+  class Base < Cuprum::Collections::Scopes::Base
+    # Filters the provided data.
+    def call(data:)
+      raise ArgumentError, 'data must be an Array' unless data.is_a?(Array)
+
+      data.select { |item| match?(item:) }
+    end
+
+    # Returns true if the provided item matches the scope.
+    def match?(item:)
+      raise ArgumentError, 'item must be a Hash' unless item.is_a?(Hash)
+
+      true
+    end
+    alias matches? match?
+
+    private
+
+    def builder
+      Cuprum::Collections::Basic::Scopes::Builder.instance
+    end
+  end
+end
+
+require 'cuprum/collections/basic/scopes/builder'

data/lib/cuprum/collections/basic/scopes/builder.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'cuprum/collections/basic/scopes'
+require 'cuprum/collections/scopes/building'
+
+module Cuprum::Collections::Basic::Scopes
+  # Builder for generating Basic collection scopes.
+  class Builder
+    include Cuprum::Collections::Scopes::Building
+
+    private
+
+    def all_scope_class
+      Cuprum::Collections::Basic::Scopes::AllScope
+    end
+
+    def conjunction_scope_class
+      Cuprum::Collections::Basic::Scopes::ConjunctionScope
+    end
+
+    def criteria_scope_class
+      Cuprum::Collections::Basic::Scopes::CriteriaScope
+    end
+
+    def disjunction_scope_class
+      Cuprum::Collections::Basic::Scopes::DisjunctionScope
+    end
+
+    def none_scope_class
+      Cuprum::Collections::Basic::Scopes::NoneScope
+    end
+  end
+end
+
+require 'cuprum/collections/basic/scopes/all_scope'
+require 'cuprum/collections/basic/scopes/conjunction_scope'
+require 'cuprum/collections/basic/scopes/criteria_scope'
+require 'cuprum/collections/basic/scopes/disjunction_scope'
+require 'cuprum/collections/basic/scopes/none_scope'

data/lib/cuprum/collections/basic/scopes/conjunction_scope.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'cuprum/collections/basic/scopes'
+require 'cuprum/collections/basic/scopes/base'
+require 'cuprum/collections/scopes/conjunction'
+
+module Cuprum::Collections::Basic::Scopes
+  # Scope for filtering data matching all of the given scopes.
+  class ConjunctionScope < Cuprum::Collections::Basic::Scopes::Base
+    include Cuprum::Collections::Scopes::Conjunction
+
+    # Returns true if the provided item matches all of the configured scopes.
+    def match?(item:)
+      super
+
+      scopes.all? { |scope| scope.match?(item:) }
+    end
+    alias matches? match?
+  end
+end

data/lib/cuprum/collections/basic/scopes/criteria_scope.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'cuprum/collections/basic/scopes'
+require 'cuprum/collections/basic/scopes/base'
+require 'cuprum/collections/queries'
+require 'cuprum/collections/scopes/criteria'
+
+module Cuprum::Collections::Basic::Scopes
+  # Scope for filtering on basic collection data based on criteria.
+  class CriteriaScope < Cuprum::Collections::Basic::Scopes::Base
+    include Cuprum::Collections::Scopes::Criteria
+
+    Operators = Cuprum::Collections::Queries::Operators
+    private_constant :Operators
+
+    # Returns true if the provided item matches the configured criteria.
+    def match?(item:)
+      super
+
+      if inverted?
+        criteria.any? do |(attribute, operator, value)|
+          filter_for(operator).call(item, attribute, value)
+        end
+      else
+        criteria.all? do |(attribute, operator, value)|
+          filter_for(operator).call(item, attribute, value)
+        end
+      end
+    end
+    alias matches? match?
+
+    private
+
+    def filter_for(operator) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+      case operator
+      when Operators::EQUAL
+        @eq_filter ||= ->(item, attribute, value) { item[attribute] == value }
+      when Operators::GREATER_THAN
+        @gt_filter ||= ->(item, attribute, value) { item[attribute] > value }
+      when Operators::GREATER_THAN_OR_EQUAL_TO
+        @gte_filter ||= ->(item, attribute, value) { item[attribute] >= value }
+      when Operators::LESS_THAN
+        @lt_filter ||= ->(item, attribute, value) { item[attribute] < value }
+      when Operators::LESS_THAN_OR_EQUAL_TO
+        @lte_filter ||= ->(item, attribute, value) { item[attribute] <= value }
+      when Operators::NOT_EQUAL
+        @ne_filter ||= ->(item, attribute, value) { item[attribute] != value }
+      when Operators::NOT_ONE_OF
+        @nin_filter ||=
+          ->(item, attribute, value) { !value.include?(item[attribute]) }
+      when Operators::ONE_OF
+        @in_filter ||=
+          ->(item, attribute, value) { value.include?(item[attribute]) }
+      else
+        error_class = Cuprum::Collections::Queries::UnknownOperatorException
+        message     = %(unknown operator "#{operator}")
+
+        raise error_class.new(message, operator)
+      end
+    end
+  end
+end

data/lib/cuprum/collections/basic/scopes/disjunction_scope.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'cuprum/collections/basic/scopes'
+require 'cuprum/collections/basic/scopes/base'
+require 'cuprum/collections/scopes/disjunction'
+
+module Cuprum::Collections::Basic::Scopes
+  # Scope for filtering data matching any of the given scopes.
+  class DisjunctionScope < Cuprum::Collections::Basic::Scopes::Base
+    include Cuprum::Collections::Scopes::Disjunction
+
+    # Returns true if the provided item matches any of the configured scopes.
+    def match?(item:)
+      super
+
+      scopes.any? { |scope| scope.match?(item:) }
+    end
+    alias matches? match?
+  end
+end

data/lib/cuprum/collections/basic/scopes/none_scope.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'cuprum/collections/basic/scopes'
+require 'cuprum/collections/basic/scopes/base'
+require 'cuprum/collections/scopes/none'
+
+module Cuprum::Collections::Basic::Scopes
+  # Scope for returning an empty data set.
+  class NoneScope < Cuprum::Collections::Basic::Scopes::Base
+    include Cuprum::Collections::Scopes::None
+
+    # @return [Cuprum::Collections::Basic::Scopes::NoneScope] a cached instance
+    #   of the none scope.
+    def self.instance
+      @instance ||= new
+    end
+
+    # Filters the provided data.
+    def call(data:)
+      raise ArgumentError, 'data must be an Array' unless data.is_a?(Array)
+
+      []
+    end
+
+    # Returns false for all items.
+    def match?(item:)
+      super
+
+      false
+    end
+    alias matches? match?
+  end
+end

data/lib/cuprum/collections/basic/scopes.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'cuprum/collections/basic'
+
+module Cuprum::Collections::Basic
+  # Namespace for basic scope functionality, which filters query data.
+  module Scopes
+    autoload :AllScope,
+      'cuprum/collections/basic/scopes/all_scope'
+    autoload :Base,
+      'cuprum/collections/basic/scopes/base'
+    autoload :Builder,
+      'cuprum/collections/basic/scopes/builder'
+    autoload :ConjunctionScope,
+      'cuprum/collections/basic/scopes/conjunction_scope'
+    autoload :CriteriaScope,
+      'cuprum/collections/basic/scopes/criteria_scope'
+    autoload :DisjunctionScope,
+      'cuprum/collections/basic/scopes/disjunction_scope'
+    autoload :NoneScope,
+      'cuprum/collections/basic/scopes/none_scope'
+  end
+end

data/lib/cuprum/collections/basic.rb

@@ -19,5 +19,6 @@ module Cuprum::Collections
     autoload :Commands,   'cuprum/collections/basic/commands'
     autoload :Query,      'cuprum/collections/basic/query'
     autoload :Repository, 'cuprum/collections/basic/repository'
+    autoload :Scopes,     'cuprum/collections/basic/scopes'
   end
 end