dry-initializer 3.0.1

data/lib/dry/initializer/config.rb

@@ -0,0 +1,184 @@
+module Dry::Initializer
+  #
+  # Gem-related configuration of some class
+  #
+  class Config
+    # @!attribute [r] null
+    # @return [Dry::Initializer::UNDEFINED, nil] value of unassigned variable
+
+    # @!attribute [r] extended_class
+    # @return [Class] the class whose config collected by current object
+
+    # @!attribute [r] parent
+    # @return [Dry::Initializer::Config] parent configuration
+
+    # @!attribute [r] definitions
+    # @return [Hash<Symbol, Dry::Initializer::Definition>]
+    #   hash of attribute definitions with their source names
+
+    attr_reader :null, :extended_class, :parent, :definitions
+
+    # @!attribute [r] mixin
+    # @return [Module] reference to the module to be included into class
+    def mixin
+      @mixin ||= Module.new.tap do |mod|
+        __dry_initializer__ = self
+        mod.extend(Mixin::Local)
+        mod.send :define_method, :__dry_initializer_config__ do
+          __dry_initializer__
+        end
+        mod.send :private, :__dry_initializer_config__
+      end
+    end
+
+    # List of configs of all subclasses of the [#extended_class]
+    # @return [Array<Dry::Initializer::Config>]
+    def children
+      @children ||= Set.new
+    end
+
+    # List of definitions for initializer params
+    # @return [Array<Dry::Initializer::Definition>]
+    def params
+      definitions.values.reject(&:option)
+    end
+
+    # List of definitions for initializer options
+    # @return [Array<Dry::Initializer::Definition>]
+    def options
+      definitions.values.select(&:option)
+    end
+
+    # Adds or redefines a parameter
+    # @param  [Symbol]       name
+    # @param  [#call, nil]   type (nil)
+    # @option opts [Proc]    :default
+    # @option opts [Boolean] :optional
+    # @option opts [Symbol]  :as
+    # @option opts [true, false, :protected, :public, :private] :reader
+    # @return [self] itself
+    def param(name, type = nil, **opts, &block)
+      add_definition(false, name, type, block, opts)
+    end
+
+    # Adds or redefines an option of [#dry_initializer]
+    #
+    # @param  (see #param)
+    # @option (see #param)
+    # @return (see #param)
+    #
+    def option(name, type = nil, **opts, &block)
+      add_definition(true, name, type, block, opts)
+    end
+
+    # The hash of public attributes for an instance of the [#extended_class]
+    # @param  [Dry::Initializer::Instance] instance
+    # @return [Hash<Symbol, Object>]
+    def public_attributes(instance)
+      definitions.values.each_with_object({}) do |item, obj|
+        key = item.target
+        next unless instance.respond_to? key
+        val = instance.send(key)
+        obj[key] = val unless null == val
+      end
+    end
+
+    # The hash of assigned attributes for an instance of the [#extended_class]
+    # @param  [Dry::Initializer::Instance] instance
+    # @return [Hash<Symbol, Object>]
+    def attributes(instance)
+      definitions.values.each_with_object({}) do |item, obj|
+        key = item.target
+        val = instance.send(:instance_variable_get, item.ivar)
+        obj[key] = val unless null == val
+      end
+    end
+
+    # Code of the `#__initialize__` method
+    # @return [String]
+    def code
+      Builders::Initializer[self]
+    end
+
+    # Finalizes config
+    # @return [self]
+    def finalize
+      @definitions = final_definitions
+      check_order_of_params
+      mixin.class_eval(code)
+      children.each(&:finalize)
+      self
+    end
+
+    # Human-readable representation of configured params and options
+    # @return [String]
+    def inch
+      line  =  Builders::Signature[self]
+      line  =  line.gsub("__dry_initializer_options__", "options")
+      lines =  ["@!method initialize(#{line})"]
+      lines += ["Initializes an instance of #{extended_class}"]
+      lines += definitions.values.map(&:inch)
+      lines += ["@return [#{extended_class}]"]
+      lines.join("\n")
+    end
+
+    private
+
+    def initialize(extended_class = nil, null: UNDEFINED)
+      @extended_class = extended_class.tap { |klass| klass&.include mixin }
+      sklass          = extended_class&.superclass
+      @parent         = sklass.dry_initializer if sklass.is_a? Dry::Initializer
+      @null           = null || parent&.null
+      @definitions    = {}
+      finalize
+    end
+
+    # rubocop: disable Metrics/MethodLength
+    def add_definition(option, name, type, block, **opts)
+      opts = {
+        parent: extended_class,
+        option: option,
+        null:   null,
+        source: name,
+        type:   type,
+        block:  block,
+        **opts,
+      }
+
+      options = Dispatchers.call(opts)
+      definition = Definition.new(options)
+      definitions[definition.source] = definition
+      finalize
+      mixin.class_eval definition.code
+    end
+    # rubocop: enable Metrics/MethodLength
+
+    def final_definitions
+      parent_definitions = Hash(parent&.definitions&.dup)
+      definitions.each_with_object(parent_definitions) do |(key, val), obj|
+        obj[key] = check_type(obj[key], val)
+      end
+    end
+
+    def check_type(previous, current)
+      return current unless previous
+      return current if previous.option == current.option
+      raise SyntaxError,
+            "cannot reload #{previous} of #{extended_class.superclass}" \
+            " by #{current} of its subclass #{extended_class}"
+    end
+
+    def check_order_of_params
+      params.inject(nil) do |optional, current|
+        if current.optional
+          current
+        elsif optional
+          raise SyntaxError, "#{extended_class}: required #{current}" \
+                             " goes after optional #{optional}"
+        else
+          optional
+        end
+      end
+    end
+  end
+end

data/lib/dry/initializer/definition.rb

@@ -0,0 +1,65 @@
+module Dry::Initializer
+  #
+  # @private
+  # @abstract
+  #
+  # Base class for parameter or option definitions
+  # Defines methods to add corresponding reader to the class,
+  # and build value of instance attribute.
+  #
+  class Definition
+    attr_reader :option, :null, :source, :target, :ivar,
+                :type, :optional, :default, :reader,
+                :desc
+
+    def options
+      {
+        as:       target,
+        type:     type,
+        optional: optional,
+        default:  default,
+        reader:   reader,
+        desc:     desc
+      }.reject { |_, value| value.nil? }
+    end
+
+    def name
+      @name ||= (option ? "option" : "parameter") << " '#{source}'"
+    end
+    alias to_s    name
+    alias to_str  name
+    alias inspect name
+
+    def ==(other)
+      other.instance_of?(self.class) && (other.source == source)
+    end
+
+    def code
+      Builders::Reader[self]
+    end
+
+    def inch
+      @inch ||= (option ? "@option" : "@param ").tap do |text|
+        text << " [Object]"
+        text << (option ? " :#{source}" : " #{source}")
+        text << (optional ? " (optional)" : " (required)")
+        text << " #{desc}" if desc
+      end
+    end
+
+    private
+
+    def initialize(**options)
+      @option   = options[:option]
+      @null     = options[:null]
+      @source   = options[:source]
+      @target   = options[:target]
+      @ivar     = "@#{@target}"
+      @type     = options[:type]
+      @reader   = options[:reader]
+      @default  = options[:default]
+      @optional = options[:optional]
+      @desc     = options[:desc]
+    end
+  end
+end

data/lib/dry/initializer/dispatchers.rb

@@ -0,0 +1,112 @@
+#
+# The module is responsible for __normalizing__ arguments
+# of `.param` and `.option`.
+#
+# What the module does is convert the source list of arguments
+# into the standard set of options:
+# - `:option`   -- whether an argument is an option (or param)
+# - `:source`   -- the name of source option
+# - `:target`   -- the target name of the reader
+# - `:reader`   -- if the reader's privacy (:public, :protected, :private, nil)
+# - `:ivar`     -- the target nane of the variable
+# - `:type`     -- the callable coercer of the source value
+# - `:optional` -- if the argument is optional
+# - `:default`  -- the proc returning the default value of the source value
+# - `:null`     -- the value to be set to unassigned optional argument
+#
+# It is this set is used to build [Dry::Initializer::Definition].
+#
+# @example
+#    # from `option :foo, [], as: :bar, optional: :true
+#    input = { name: :foo, as: :bar, type: [], optional: true }
+#
+#    Dry::Initializer::Dispatcher.call(input)
+#    # => {
+#    #      source:   "foo",
+#    #      target:   "bar",
+#    #      reader:   :public,
+#    #      ivar:     "@bar",
+#    #      type:  ->(v) { Array(v) } }, # simplified for brevity
+#    #      optional: true,
+#    #      default:  -> { Dry::Initializer::UNDEFINED },
+#    #    }
+#
+# # Settings
+#
+# The module uses global setting `null` to define what value
+# should be set to variables that kept unassigned. By default it
+# uses `Dry::Initializer::UNDEFINED`
+#
+# # Syntax Extensions
+#
+# The module supports syntax extensions. You can add any number
+# of custom dispatchers __on top__ of the stack of default dispatchers.
+# Every dispatcher should be a callable object that takes
+# the source set of options and converts it to another set of options.
+#
+# @example Add special dispatcher
+#
+#   # Define a dispatcher for key :integer
+#   dispatcher = proc do |integer: false, **opts|
+#     opts.merge(type: proc(&:to_i)) if integer
+#   end
+#
+#   # Register a dispatcher
+#   Dry::Initializer::Dispatchers << dispatcher
+#
+#   # Now you can use option `integer: true` instead of `type: proc(&:to_i)`
+#   class Foo
+#     extend Dry::Initializer
+#     param :id, integer: true
+#   end
+#
+module Dry::Initializer::Dispatchers
+  extend self
+
+  # @!attribute [rw] null Defines a value to be set to unassigned attributes
+  # @return [Object]
+  attr_accessor :null
+
+  #
+  # Registers a new dispatcher
+  #
+  # @param [#call] dispatcher
+  # @return [self] itself
+  #
+  def <<(dispatcher)
+    @pipeline = [dispatcher] + pipeline
+    self
+  end
+
+  #
+  # Normalizes the source set of options
+  #
+  # @param [Hash<Symbol, Object>] options
+  # @return [Hash<Symbol, Objct>] normalized set of options
+  #
+  def call(**options)
+    options = { null: null }.merge(options)
+    pipeline.reduce(options) { |opts, dispatcher| dispatcher.call(opts) }
+  end
+
+  private
+
+  require_relative "dispatchers/build_nested_type"
+  require_relative "dispatchers/check_type"
+  require_relative "dispatchers/prepare_default"
+  require_relative "dispatchers/prepare_ivar"
+  require_relative "dispatchers/prepare_optional"
+  require_relative "dispatchers/prepare_reader"
+  require_relative "dispatchers/prepare_source"
+  require_relative "dispatchers/prepare_target"
+  require_relative "dispatchers/unwrap_type"
+  require_relative "dispatchers/wrap_type"
+
+  def pipeline
+    @pipeline ||= [
+      PrepareSource, PrepareTarget, PrepareIvar, PrepareReader,
+      PrepareDefault, PrepareOptional,
+      UnwrapType, CheckType, BuildNestedType, WrapType
+    ]
+  end
+end

data/lib/dry/initializer/dispatchers/build_nested_type.rb

@@ -0,0 +1,59 @@
+#
+# Prepare nested data type from a block
+#
+# @example
+#   option :foo do
+#     option :bar
+#     option :qux
+#   end
+#
+module Dry::Initializer::Dispatchers::BuildNestedType
+  extend self
+
+  # rubocop: disable Metrics/ParameterLists
+  def call(parent:, source:, target:, type: nil, block: nil, **options)
+    check_certainty!(source, type, block)
+    check_name!(target, block)
+    type ||= build_nested_type(parent, target, block)
+    { parent: parent, source: source, target: target, type: type, **options }
+  end
+  # rubocop: enable Metrics/ParameterLists
+
+  private
+
+  def check_certainty!(source, type, block)
+    return unless block
+    return unless type
+
+    raise ArgumentError, <<~MESSAGE
+      You should define coercer of values of argument '#{source}'
+      either though the parameter/option, or via nested block, but not the both.
+    MESSAGE
+  end
+
+  def check_name!(name, block)
+    return unless block
+    return unless name[/^_|__|_$/]
+
+    raise ArgumentError, <<~MESSAGE
+      The name of the argument '#{name}' cannot be used for nested struct.
+      A proper name can use underscores _ to divide alphanumeric parts only.
+    MESSAGE
+  end
+
+  def build_nested_type(parent, name, block)
+    return unless block
+
+    klass_name = full_name(parent, name)
+    build_struct(klass_name, block)
+  end
+
+  def full_name(parent, name)
+    "::#{parent.name}::#{name.to_s.split("_").compact.map(&:capitalize).join}"
+  end
+
+  def build_struct(klass_name, block)
+    eval "class #{klass_name} < Dry::Initializer::Struct; end"
+    const_get(klass_name).tap { |klass| klass.class_eval(&block) }
+  end
+end

data/lib/dry/initializer/dispatchers/check_type.rb

@@ -0,0 +1,43 @@
+#
+# Checks whether an unwrapped type is valid
+#
+module Dry::Initializer::Dispatchers::CheckType
+  extend self
+
+  def call(source:, type: nil, wrap: 0, **options)
+    check_if_callable! source, type
+    check_arity! source, type, wrap
+
+    { source: source, type: type, wrap: wrap, **options }
+  end
+
+  private
+
+  def check_if_callable!(source, type)
+    return if type.nil?
+    return if type.respond_to?(:call)
+
+    raise ArgumentError,
+          "The type of the argument '#{source}' should be callable"
+  end
+
+  def check_arity!(_source, type, wrap)
+    return if type.nil?
+    return if wrap.zero?
+    return if type.method(:call).arity.abs == 1
+
+    raise ArgumentError, <<~MESSAGE
+      The dry_intitializer supports wrapped types with one argument only.
+      You cannot use array types with element coercers having several arguments.
+
+      For example, this definitions are correct:
+        option :foo, [proc(&:to_s)]
+        option :bar, type: [[]]
+        option :baz, ->(a, b) { [a, b] }
+
+      While this is not:
+        option :foo, [->(a, b) { [a, b] }]
+    MESSAGE
+  end
+  # rubocop: enable Metrics/MethodLength
+end