params_ready 0.0.7 → 0.0.8

data/lib/params_ready/marshaller/polymorph_marshallers.rb

@@ -3,7 +3,7 @@ require_relative 'collection'
 module ParamsReady
   module Marshaller
     class PolymorphMarshallers
-      class HashMarshaller
+      class StructMarshaller
         attr_reader :type_identifier
 
         def self.instance(type_identifier:)
@@ -57,7 +57,7 @@ module ParamsReady
       def self.collection
         @collection ||= begin
           c = ClassCollection.new Hash
-          c.add_factory :hash, HashMarshaller
+          c.add_factory :hash, StructMarshaller
           c.freeze
           c
         end

data/lib/params_ready/marshaller/{hash_marshallers.rb → struct_marshallers.rb}

@@ -4,7 +4,7 @@ require_relative 'collection'
 
 module ParamsReady
   module Marshaller
-    class HashMarshallers
+    class StructMarshallers
       module AbstractMarshaller
         def extract_bare_value(parameter, intent)
           parameter.names.keys.reduce({}) do |result, name|
@@ -27,11 +27,11 @@ module ParamsReady
         def self.canonicalize(definition, string, context, validator)
           json = Base64.urlsafe_decode64(string)
           hash = JSON.parse(json)
-          HashMarshaller.canonicalize(definition, hash, context, validator)
+          StructMarshaller.canonicalize(definition, hash, context, validator)
         end
 
         def self.marshal(parameter, intent)
-          hash = HashMarshaller.marshal(parameter, intent)
+          hash = StructMarshaller.marshal(parameter, intent)
           json = JSON.generate(hash)
           Base64.urlsafe_encode64(json)
         end
@@ -39,7 +39,7 @@ module ParamsReady
         freeze
       end
 
-      module HashMarshaller
+      module StructMarshaller
         extend AbstractMarshaller
 
         def self.canonicalize(definition, hash, context, validator, freeze: false)
@@ -88,7 +88,7 @@ module ParamsReady
       def self.collection
         @collection ||= begin
           c = ClassCollection.new Hash
-          c.add_instance Hash, HashMarshaller
+          c.add_instance Hash, StructMarshaller
           c.add_factory :base64, Base64Marshaller
           c.default!(Hash)
           c.freeze

data/lib/params_ready/marshaller/tuple_marshallers.rb

@@ -43,7 +43,7 @@ module ParamsReady
         freeze
       end
 
-      module HashMarshaller
+      module StructMarshaller
         extend AbstractMarshaller
 
         def self.canonicalize(definition, hash, context, validator)
@@ -92,7 +92,7 @@ module ParamsReady
         @collection ||= begin
           c = ClassCollection.new Array
           c.add_instance Array, ArrayMarshaller
-          c.add_instance Hash, HashMarshaller
+          c.add_instance Hash, StructMarshaller
           c.add_factory :string, StringMarshaller
           c.freeze
           c

data/lib/params_ready/ordering/column.rb

@@ -27,7 +27,7 @@ module ParamsReady
 
       def attribute(name, default_table, context)
         arel_table = table || default_table
-        arel_builder = Helpers::ArelBuilder.instance(expression(name), arel_table: arel_table)
+        arel_builder = Helpers::ArelBuilder::Attribute.instance(expression(name), arel_table: arel_table)
         arel_builder.to_arel(arel_table, context, self)
       end
 

data/lib/params_ready/output_parameters.rb

@@ -72,6 +72,17 @@ module ParamsReady
       end
     end
 
+
+    def to_a
+      if @parameter.definition.is_a? Parameter::ArrayParameterDefinition
+        (0...@parameter.length).map do |n|
+          self[n]
+        end
+      else
+        raise ParamsReadyError, "Unimplemented method 'to_a' for #{@parameter.definition.class.name}"
+      end
+    end
+
     def flat_pairs(format = @intent.format, restriction: @intent.restriction, data: @intent.data)
       self.class.flatten_hash(for_output(format, restriction: restriction, data: data), scoped_name)
     end

data/lib/params_ready/pagination/keyset_pagination.rb

@@ -1,4 +1,4 @@
-require_relative '../parameter/hash_parameter'
+require_relative '../parameter/struct_parameter'
 require_relative '../value/constraint'
 require_relative '../helpers/arel_builder'
 require_relative 'abstract_pagination'
@@ -6,7 +6,7 @@ require_relative 'direction'
 
 module ParamsReady
   module Pagination
-    class KeysetPagination < Parameter::HashParameter
+    class KeysetPagination < Parameter::StructParameter
       include AbstractPagination
 
       def select_keysets(query, limit, direction, keyset, ordering, arel_table, context)
@@ -177,7 +177,7 @@ module ParamsReady
       end
     end
 
-    class KeysetPaginationDefinition < Parameter::HashParameterDefinition
+    class KeysetPaginationDefinition < Parameter::StructParameterDefinition
       MIN_LIMIT = 1
 
       parameter_class KeysetPagination
@@ -212,14 +212,14 @@ module ParamsReady
     class KeysetPaginationBuilder
       def initialize(ordering_builder, default_limit, max_limit = nil)
         definition = KeysetPaginationDefinition.new(default_limit, max_limit)
-        @cursor_builder = Parameter::HashParameterBuilder.send :new, definition
+        @cursor_builder = Parameter::StructParameterBuilder.send :new, definition
         @default = {
           limit: default_limit,
           direction: :aft,
           keyset: {}
         }
         @ordering_builder = ordering_builder
-        @keyset = Parameter::HashParameterBuilder.instance(:keyset, altn: :ks)
+        @keyset = Parameter::StructParameterBuilder.instance(:keyset, altn: :ks)
       end
 
       def key(type, name, direction, &block)

data/lib/params_ready/parameter/{abstract_hash_parameter.rb → abstract_struct_parameter.rb}

@@ -1,6 +1,6 @@
 require_relative 'parameter'
 require_relative '../helpers/key_map'
-require_relative '../marshaller/hash_marshallers'
+require_relative '../marshaller/struct_marshallers'
 require_relative '../marshaller/builder_module'
 require_relative '../marshaller/definition_module'
 
@@ -8,7 +8,7 @@ module ParamsReady
   module Parameter
     using Extensions::Hash
 
-    class AbstractHashParameter < Parameter
+    class AbstractStructParameter < Parameter
       include ComplexParameter
 
       def_delegators :@definition, :names, :remap?
@@ -132,10 +132,10 @@ module ParamsReady
       end
     end
 
-    module AbstractHashParameterBuilder
+    module AbstractStructParameterBuilder
       include Marshaller::BuilderModule
 
-      module HashLike
+      module StructLike
         def add(input, *args, **opts, &block)
           definition = self.class.resolve(input, *args, **opts, &block)
           @definition.add_child definition
@@ -143,7 +143,7 @@ module ParamsReady
       end
     end
 
-    class AbstractHashParameterDefinition < Definition
+    class AbstractStructParameterDefinition < Definition
       attr_reader :key_map
 
       def duplicate_value(value)

data/lib/params_ready/parameter/array_parameter.rb

@@ -1,6 +1,6 @@
 require_relative 'parameter'
 require_relative 'definition'
-require_relative 'abstract_hash_parameter'
+require_relative 'abstract_struct_parameter'
 require_relative '../builder'
 require_relative '../marshaller/array_marshallers'
 require_relative '../marshaller/builder_module'
@@ -74,7 +74,7 @@ module ParamsReady
       end
 
       def_delegators :@definition, :prototype
-      def_delegators :bare_value, :length, :each, :each_with_index, :map, :reduce, :to_a
+      def_delegators :bare_value, :length, :count, :each, :each_with_index, :map, :reduce, :to_a
 
       freeze_variable :value do |array|
         array.each(&:freeze)

data/lib/params_ready/parameter/definition.rb

@@ -9,6 +9,7 @@ require_relative '../extensions/undefined'
 require_relative '../input_context'
 require_relative '../result'
 require_relative '../helpers/conditional_block'
+require_relative '../helpers/callable'
 
 module ParamsReady
   module Parameter
@@ -212,6 +213,7 @@ module ParamsReady
 
       late_init :default, once: false, definite: false do |value|
         next value if value == Extensions::Undefined
+        next value if value.is_a? Helpers::Callable
 
         canonical = canonical_default(value)
         next canonical if canonical.nil?
@@ -219,11 +221,24 @@ module ParamsReady
         freeze_value(canonical)
       end
 
-      def duplicate_default
+      def fetch_default(duplicate: true)
         return Extensions::Undefined unless default_defined?
         return nil if @default.nil?
 
-        duplicate_value(@default)
+        if @default.is_a?(Helpers::Callable)
+          fetch_callable_default
+        else
+          return @default unless duplicate
+          duplicate_value(@default)
+        end
+      end
+
+      def fetch_callable_default
+        value = @default.call
+        value = ensure_canonical(value)
+        duplicate_value(value)
+      rescue StandardError => e
+        raise ParamsReadyError, "Invalid default: #{e.message}"
       end
 
 

data/lib/params_ready/parameter/{hash_set_parameter.rb → enum_set_parameter.rb}

@@ -1,13 +1,13 @@
 require 'set'
-require_relative 'hash_parameter'
+require_relative 'struct_parameter'
 require_relative 'value_parameter'
 require_relative '../intent'
-require_relative '../marshaller/hash_set_marshallers'
+require_relative '../marshaller/enum_set_marshallers'
 require_relative '../marshaller/parameter_module'
 
 module ParamsReady
   module Parameter
-    class HashSetParameter < AbstractHashParameter
+    class EnumSetParameter < AbstractStructParameter
       include Marshaller::ParameterModule
 
       def self.intent_for_set(intent)
@@ -31,13 +31,14 @@ module ParamsReady
       end
     end
 
-    class HashSetParameterBuilder < Builder
+    class EnumSetParameterBuilder < Builder
       include Marshaller::BuilderModule
 
-      register :hash_set
+      register :enum_set
+      register_deprecated :hash_set, use: :enum_set
 
       def self.instance(name, altn: nil, type: :boolean)
-        new HashSetParameterDefinition.new(name, altn: altn, type: type)
+        new EnumSetParameterDefinition.new(name, altn: altn, type: type)
       end
 
       def add(input, *args, val: nil, **opts, &block)
@@ -56,12 +57,12 @@ module ParamsReady
       end
     end
 
-    class HashSetParameterDefinition < AbstractHashParameterDefinition
+    class EnumSetParameterDefinition < AbstractStructParameterDefinition
       attr_reader :type, :values
       freeze_variable :values
-      name_for_formatter :hash_set
-      parameter_class HashSetParameter
-      include Marshaller::DefinitionModule[Marshaller::HashSetMarshallers.collection]
+      name_for_formatter :enum_set
+      parameter_class EnumSetParameter
+      include Marshaller::DefinitionModule[Marshaller::EnumSetMarshallers.collection]
 
       def initialize(*args, type: :boolean, **opts)
         @type = type

data/lib/params_ready/parameter/parameter.rb

@@ -347,14 +347,18 @@ module ParamsReady
         format(Intent.instance(:backend))
       end
 
-      def unwrap_or(default)
+      def unwrap_or(*args, &block)
+        ensure_default_present!(*args, &block)
+
         if is_definite?
-          unwrap
+          begin
+            unwrap
+          rescue StandardError => _
+            supply_default(*args, &block)
+          end
         else
-          default
+          supply_default(*args, &block)
         end
-      rescue StandardError => _
-        default
       end
 
       def find_in_hash(hash, context)
@@ -432,22 +436,32 @@ module ParamsReady
         nil
       end
 
+      def ensure_default_present!(*args, &block)
+        raise ParamsReadyError, 'Single default value expected' if args.length > 1
+        raise ParamsReadyError, 'Supply either default or a block' if args.length == 0 && block.nil?
+        warn 'WARNING: block supersedes default value' if args.length > 0 && block
+      end
+
+      def supply_default(*args, &block)
+        if block.nil?
+          args[0]
+        else
+          block.call
+        end
+      end
+
       def init_for_read(to_be_frozen = false)
         return unless @value == Extensions::Undefined
         return unless default_defined?
 
-        @value = if to_be_frozen
-          definition.default
-        else
-          definition.duplicate_default
-        end
+        @value = definition.fetch_default(duplicate: !to_be_frozen)
       end
 
       def init_for_write
         return if is_definite?
 
         if default_defined? && !default.nil?
-          @value = definition.duplicate_default
+          @value = definition.fetch_default
         else
           init_value
         end

data/lib/params_ready/parameter/state.rb

@@ -1,10 +1,10 @@
 require_relative '../error'
-require_relative '../../params_ready/parameter/hash_parameter'
+require_relative '../../params_ready/parameter/struct_parameter'
 require_relative '../query/relation'
 
 module ParamsReady
   module Parameter
-    class State < HashParameter
+    class State < StructParameter
       extend Query::Relation::PageAccessors
       extend Forwardable
       def_delegators :definition, :relations
@@ -98,7 +98,7 @@ module ParamsReady
       end
     end
 
-    class StateBuilder < HashParameterBuilder
+    class StateBuilder < StructParameterBuilder
       def relation(relation)
         @definition.add_relation relation
       end
@@ -109,7 +109,7 @@ module ParamsReady
       end
     end
 
-    class StateDefinition < HashParameterDefinition
+    class StateDefinition < StructParameterDefinition
       parameter_class State
       attr_reader :relations
 

data/lib/params_ready/parameter/{hash_parameter.rb → struct_parameter.rb}

@@ -1,22 +1,23 @@
 require_relative 'parameter'
 require_relative '../builder'
-require_relative 'abstract_hash_parameter'
+require_relative 'abstract_struct_parameter'
 require_relative '../marshaller/parameter_module'
 
 
 module ParamsReady
   module Parameter
-    class HashParameter < AbstractHashParameter
+    class StructParameter < AbstractStructParameter
       include Marshaller::ParameterModule
     end
 
-    class HashParameterBuilder < Builder
-      include AbstractHashParameterBuilder::HashLike
+    class StructParameterBuilder < Builder
+      include AbstractStructParameterBuilder::StructLike
       include Marshaller::BuilderModule
-      register :hash
+      register :struct
+      register_deprecated :hash, use: :struct
 
       def self.instance(name, altn: nil)
-        new HashParameterDefinition.new(name, altn: altn)
+        new StructParameterDefinition.new(name, altn: altn)
       end
 
       def map(hash)
@@ -24,11 +25,11 @@ module ParamsReady
       end
     end
 
-    class HashParameterDefinition < AbstractHashParameterDefinition
-      include Marshaller::DefinitionModule[Marshaller::HashMarshallers.collection]
+    class StructParameterDefinition < AbstractStructParameterDefinition
+      include Marshaller::DefinitionModule[Marshaller::StructMarshallers.collection]
 
-      name_for_formatter :hash
-      parameter_class HashParameter
+      name_for_formatter :struct
+      parameter_class StructParameter
       freeze_variables :key_map
 
       def ensure_canonical(hash)

data/lib/params_ready/parameter/tuple_parameter.rb

@@ -98,7 +98,7 @@ module ParamsReady
         end
       end
 
-      class HashMarshaller
+      class StructMarshaller
         def marshal(fields, _format)
           fields.each_with_index.map do |field, index|
             [index.to_s, field]

data/lib/params_ready/parameter/value_parameter.rb

@@ -165,7 +165,7 @@ module ParamsReady
       def ensure_canonical(value)
         coerced = coder.try_coerce value, Format.instance(:backend)
         if coder.strict_default? && value != coerced
-          raise ParamsReadyError, "input '#{value}' (#{value.class.name}) coerced to '#{coerced}' (#{coerced.class.name})"
+          raise ParamsReadyError, "input '#{value}'/#{value.class.name} (expected '#{coerced}'/#{coerced.class.name})"
         end
         validate coerced
         coerced

data/lib/params_ready/parameter_user.rb

@@ -15,29 +15,21 @@ module ParamsReady
     protected
 
     def parameter_definition(key)
-        self.class.parameter_definition key
+      self.class.parameter_definition key
     end
 
     def relation_definition(key)
-        self.class.relation_definition key
+      self.class.relation_definition key
     end
 
-    def populate_state_for(method, params, context = Format.instance(:frontend), validator = nil)
-      definition = create_state_for method
+    def populate_state_for(key, params, context = Format.instance(:frontend), validator = nil)
+      definition = create_state_for key
       result, state = definition.from_input(params || {}, context: context, validator: validator || Result.new(:params_ready))
       [result, state]
     end
 
-    def create_state_for(method)
-      builder = Parameter::StateBuilder.instance
-      options = self.class.params_ready_storage
-      options.parameter_rules do |rule|
-        builder.add rule.parameter_definition if rule.valid_for(method)
-      end
-      options.relation_rules do |rule|
-        builder.relation rule.parameter_definition if rule.valid_for(method)
-      end
-      builder.build
+    def create_state_for(key)
+      self.class.params_ready_option.create_state_for(key)
     end
   end
-end
+end

data/lib/params_ready/query/array_grouping.rb

@@ -1,11 +1,11 @@
-require_relative '../parameter/hash_parameter'
+require_relative '../parameter/struct_parameter'
 require_relative '../parameter/array_parameter'
 require_relative 'grouping'
 require_relative 'predicate'
 
 module ParamsReady
   module Query
-    class ArrayGrouping < Parameter::HashParameter
+    class ArrayGrouping < Parameter::StructParameter
       include Parameter::GroupingLike
 
       def predicates
@@ -29,7 +29,7 @@ module ParamsReady
     end
 
     class ArrayGroupingBuilder < Builder
-      include Parameter::AbstractHashParameterBuilder::HashLike
+      include Parameter::AbstractStructParameterBuilder::StructLike
       PredicateRegistry.register_predicate :array_grouping_predicate, self
 
       def prototype(type_name, name = :proto, *arr, **opts, &block)
@@ -48,7 +48,7 @@ module ParamsReady
       end
     end
 
-    class ArrayGroupingDefinition < Parameter::HashParameterDefinition
+    class ArrayGroupingDefinition < Parameter::StructParameterDefinition
       def initialize(*args, **opts)
         super
       end

data/lib/params_ready/query/exists_predicate.rb

@@ -58,7 +58,7 @@ module ParamsReady
       PredicateRegistry.register_predicate :exists_predicate, self
 
       include GroupingLike
-      include Parameter::AbstractHashParameterBuilder::HashLike
+      include Parameter::AbstractStructParameterBuilder::StructLike
       include HavingArelTable
 
       def self.instance(name, altn: nil, coll: nil)
@@ -66,8 +66,8 @@ module ParamsReady
       end
 
       def related(on: nil, eq: nil, &block)
-        join_statement = JoinStatement.new(on: on, eq: eq, &block)
-        @definition.set_related(join_statement)
+        join_statement = JoinStatement::Builder.new(on: on, eq: eq, &block)
+        @definition.set_related(join_statement.build)
       end
 
       def outer_table(arel_table)

data/lib/params_ready/query/grouping.rb

@@ -48,6 +48,10 @@ module ParamsReady
         definition = Builder.define_grouping_operator(:operator, altn: :op, &block)
         add definition
       end
+
+      def to_query?(&block)
+        helper :to_query?, &block
+      end
     end
   end
 
@@ -67,10 +71,12 @@ module ParamsReady
         arel_table.grouping(subqueries)
       end
 
-      def eligible_for_query?(_table, context)
+      def eligible_for_query?(table, context)
         return false unless context.permitted? self
+        return false unless is_definite?
+        return true unless respond_to?(:to_query?)
 
-        is_definite?
+        to_query?(table, context)
       end
 
       def to_query_if_eligible(arel_table, context:)