params_ready 0.0.2 → 0.0.8

data/lib/params_ready/marshaller/{hash_set_marshallers.rb → enum_set_marshallers.rb}

@@ -1,9 +1,9 @@
 require_relative 'collection'
-require_relative 'hash_marshallers'
+require_relative 'struct_marshallers'
 
 module ParamsReady
   module Marshaller
-    class HashSetMarshallers
+    class EnumSetMarshallers
       module AbstractMarshaller
         def canonicalize_collection(definition, context, validator, freeze: false)
           hash = {}
@@ -18,7 +18,7 @@ module ParamsReady
         end
       end
 
-      module HashMarshaller
+      module StructMarshaller
         extend AbstractMarshaller
 
         def self.canonicalize(definition, hash, context, validator)
@@ -30,7 +30,7 @@ module ParamsReady
 
         def self.marshal(parameter, intent)
           if intent.marshal? parameter.name_for_formatter
-            HashMarshallers::HashMarshaller.marshal(parameter, intent)
+            StructMarshallers::StructMarshaller.marshal(parameter, intent)
           else
             SetMarshaller.marshal(parameter, intent)
           end
@@ -83,7 +83,7 @@ module ParamsReady
       def self.collection
         @collection ||= begin
           c = ClassCollection.new Hash
-          c.add_instance Hash, HashMarshaller
+          c.add_instance Hash, StructMarshaller
           c.add_instance Set, SetMarshaller
           c.add_instance Array, ArrayMarshaller
           c.default!(Hash)

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
@@ -104,8 +115,8 @@ module ParamsReady
       @parameter.for_frontend(restriction: restriction, data: data)
     end
 
-    def for_model(restriction: @intent.restriction)
-      @parameter.for_model(restriction: restriction)
+    def for_model(format = :update, restriction: @intent.restriction)
+      @parameter.for_model(format, restriction: restriction)
     end
 
     def format(format = @intent)

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?
@@ -69,7 +69,7 @@ module ParamsReady
         for_output(format, restriction: restriction, data: data)
       end
 
-      def for_model(format = :attributes, restriction: nil)
+      def for_model(format = :update, restriction: nil)
         for_output(format, restriction: restriction)
       end
 
@@ -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
@@ -96,7 +97,7 @@ module ParamsReady
         preprocessor: nil,
         populator: nil,
         postprocessor: nil,
-        local: false,
+        no_input: nil,
         no_output: nil,
         **opts
       )
@@ -106,7 +107,7 @@ module ParamsReady
         @preprocessor = preprocessor
         @postprocessor = postprocessor
         @populator = populator
-        @local = local
+        @no_input = no_input
         @no_output = no_output
 
         set_default(default) unless default == Extensions::Undefined
@@ -126,6 +127,7 @@ module ParamsReady
       end
 
       late_init :populator, getter: true, once: true, obligatory: false
+      late_init :no_input, getter: false, once: false
       late_init :no_output, getter: false, once: false
       late_init :memoize, getter: true, obligatory: false
 
@@ -173,52 +175,45 @@ module ParamsReady
         validator
       end
 
-      def set_local(*arr, rule: nil)
-        if rule.nil?
-          @local = true
-        else
-          @local = Helpers::Rule(rule)
-        end
+      def set_no_input(*arr, rule: nil)
+        @no_input = Helpers::Rule(rule) || true
+        raise ParamsReadyError, "Default not expected: #{arr}" if rule == false
+
         set_default *arr unless arr.empty?
       end
 
-      def local?(format)
-        case @local
-        when nil, false
-          false
-        when true
-          !format.local?
-        when Helpers::Rule
-          @local.include? format.name
-        else
-          raise ParamsReadyError, "Unexpected rule: #{@local}"
-        end
+      def set_local(*arr, rule: nil)
+        rule = Helpers::Rule(rule)
+        set_no_input(*arr, rule: rule)
+        set_no_output(rule || true)
+      end
+
+      def no_input?(format)
+        restricted_for_format?(@no_input, format)
       end
 
       def no_output?(format)
-        case @no_output
+        restricted_for_format?(@no_output, format)
+      end
+
+      def restricted_for_format?(rule, format)
+        case rule
         when nil, false
-          return local?(format)
+          false
         when true
-          return !format.local?
+          !format.local?
         when Helpers::Rule
-          @no_output.include? format.name
+          rule.include?(format.name)
         else
-          raise ParamsReadyError, "Unexpected option: '#{@no_output}'"
+          raise ParamsReadyError, "Unexpected rule: #{rule}"
         end
       end
 
-      late_init :optional, boolean: true, getter: false, once: false do |value|
-        next value if value == false
-        raise ParamsReadyError, "Optional parameter can't have default" if default_defined?
-
-        value
-      end
+      late_init :optional, boolean: true, getter: false, once: false
 
       late_init :default, once: false, definite: false do |value|
         next value if value == Extensions::Undefined
-
-        raise ParamsReadyError, "Optional parameter can't have default" if optional?
+        next value if value.is_a? Helpers::Callable
 
         canonical = canonical_default(value)
         next canonical if canonical.nil?
@@ -226,25 +221,38 @@ 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
 
 
       def finish
-        if @populator && !@local
-          raise ParamsReadyError, "Populator set for non-local parameter '#{name}'"
+        if @populator && !@no_input
+          raise ParamsReadyError, "Populator set for input parameter '#{name}'"
         end
 
-        if @preprocessor && @local
-          raise ParamsReadyError, "Preprocessor set for local parameter '#{name}'"
+        if @preprocessor && @no_input == true
+          raise ParamsReadyError, "Preprocessor set for no-input parameter '#{name}'"
         end
 
-        if @postprocessor && @local
-          raise ParamsReadyError, "Postprocessor set for local parameter '#{name}'"
+        if @postprocessor && @no_input == true
+          raise ParamsReadyError, "Postprocessor set for no-input parameter '#{name}'"
         end
 
         super

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

@@ -8,8 +8,12 @@ module ParamsReady
   module Parameter
     module FromHash
       def set_from_hash(hash, context: nil, validator: Result.new(name))
-        _, input = find_in_hash hash, context
-        set_from_input(input, context, validator)
+        if no_input?(context)
+          populate(context, validator)
+        else
+          _, input = find_in_hash hash, context
+          set_from_input(input, context, validator)
+        end
       end
     end
 
@@ -184,7 +188,9 @@ module ParamsReady
       end
 
       def inspect
-        "#{self.class.name.split("::").last} #{self.name}: { #{inspect_content} }"
+        preserve = Format.instance(:inspect).preserve?(self)
+        content = preserve ? inspect_content : '[FILTERED]'
+        "#{self.class.name.split("::").last} #{self.name}: { #{content} }"
       end
 
       def dup
@@ -205,7 +211,7 @@ module ParamsReady
 
     class Parameter < AbstractParameter
       def_delegators :@definition,
-                     :default, :optional?, :default_defined?, :constraints, :no_output?, :local?
+                     :default, :optional?, :default_defined?, :constraints, :no_output?, :no_input?
 
       def initialize(definition)
         @value = Extensions::Undefined
@@ -248,6 +254,7 @@ module ParamsReady
 
       def is_definite?
         return true if @value != Extensions::Undefined && !@value.nil?
+        return false if optional? && @value.nil?
 
         definite_default?
       end
@@ -267,7 +274,13 @@ module ParamsReady
       end
 
       def is_undefined?
-        @value == Extensions::Undefined && !default_defined?
+        @value == Extensions::Undefined && allows_undefined?
+      end
+
+      def allows_undefined?
+        return true if optional?
+
+        !default_defined?
       end
 
       def eligible_for_output?(intent)
@@ -278,14 +291,6 @@ module ParamsReady
         format.hash_key(self)
       end
 
-      def set_from_hash(hash, context: nil, validator: Result.new(name))
-        if local?(context)
-          populate(context, validator)
-        else
-          super
-        end
-      end
-
       def set_from_input(input, context, validator)
         preprocessed = definition.preprocess(input, context, validator)
         set_value preprocessed, context, validator
@@ -342,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)
@@ -389,17 +398,17 @@ module ParamsReady
 
       def handle_indefinite_input(input, validator)
         value_missing validator
-        if optional?
+        if default_defined?
           # if value_missing doesn't crash,
           # and the parameter is optional
           # it's safe to set to nil or Extensions::Undefined
-          @value = input
-        elsif default_defined?
+          @value = Extensions::Undefined
+        elsif optional?
           # Clear possible previous state,
           # will be set to default on read
-          @value = Extensions::Undefined
+          @value = input
         else
-          raise ParamsReadyError, "Unexpected state in #handle_indefinite_input" if validator.ok?
+          raise ParamsReadyError, "Unexpected state for '#{name}' in #handle_indefinite_input" if validator.ok?
         end
       end
 
@@ -427,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