configuratrix 0.0.1.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 93b3ad072cd0671d44b8070ed2001f10e1908b9fa763accb8c3b0a1f677dc1a0
+  data.tar.gz: 1120f79e5e750f1ad4f491dd863cb31652b475f1d529ee903d54d53b019fc57c
+SHA512:
+  metadata.gz: fedc7ec78c63f6742a9ec315df056d7c93a4daef59186813ea80cd144b78235b3a5cc63ff80487dc35ebceb466738f449b591d7ae963ef148d5127fedf4e1498
+  data.tar.gz: 365e2c66a76e9d4d469cddcd9afabbbae4983a622ee9248e331a88be76f6f008303fc4c633a46e282b15d3a75628bea526eb9a2dbea7eb71a1a10b71ab2b7ece

data/lib/configuratrix/errors.rb

@@ -0,0 +1,101 @@
+module Configuratrix
+
+class Err < StandardError
+  # By eliminating newlines in error messages, we can use heredocs in `raise`
+  # statements which is nice.
+  def initialize(message=nil)
+    unless message.nil?
+      message = message.lines(chomp: true).join(' ').strip
+    end
+    super(message)
+  end
+
+  # Allow errors to descend from each other in whatever groupings are useful,
+  # while still having them all be defined directly under Err.
+  def self.err(name, &block)
+    Err.const_set name, Class.new(self, &block)
+  end
+  private_class_method :err
+
+  # A value is referenced that has no value, not even nil.
+  err :NoSuchValue do
+    # A namespace was queried for a name it does not contain.
+    err :ValuelessKey
+  end
+
+  # A well-formed schema could not be defined as requested.
+  err :BadSchema do
+    # A name would become ambiguous by referring to multiple values.
+    err :NameCollision
+    # A name was given that is not acceptable in context.
+    err :NameIsInvalid do
+      # A reserved name was given to a real value.
+      err :WordIsReserved
+    end
+    # A schema is set up in a way that is not useful and may mask
+    # misconfiguration elsewhere.
+    err :PathologicalSchema
+    # A schema class tried to configure itself with respect to another schema
+    # class, but did it wrong.
+    err :NoCanToggle
+    # The type of a value is unspecified and could not be determined.
+    err :TypeUndefined
+    # An unmarshalled value was assigned to a field (e.g. as the default
+    # value), but it is not a value of the field's value_type.
+    err :ValueUnrecognized
+    # Wrong number of values: An unmarshalled value was assigned to a field
+    # (e.g. as the default value), but the plurality of the value is not
+    # appropriate for the arity of the field.
+    err :ArityMismatch
+    # When an existing schema is reopened for further editing to find that it's
+    # the wrong kind of schema for the context.
+    err :UnsafeReopen
+  end
+
+  # Though the schema is well-formed, a config could not be created from it.
+  err :BadConfig do
+    # An input could not be understood within the schema.
+    err :SchemaViolation do
+      # The configuration does not contain a value that the schema requires it
+      # to.
+      err :RequirementUnmet
+      # The configuration refers to a field not defined in the schema.
+      err :NoSuchField
+      # The configuration refers to a source not defined in the schema.
+      err :NoSuchSource
+      # The configuration refers to a value type not defined in the schema.
+      err :NoSuchType
+      # The value specified for a field was not usable by that field.
+      err :MarshalUnacceptable
+    end
+    # A source encountered a problem with its input other than a violation of
+    # the schema.
+    err :SourceRejected do
+      # The source's input text was in some way not well-formed
+      err :BadSyntax
+      # The field was specified in a source in a context not appropriate for
+      # the field's value type.  Contrast this to MarshalUnacceptable: a Type
+      # with no #affirm specified is not applicable to an implicit command line
+      # specification like `--field`.  There's not even a value to deem
+      # unacceptable.
+      err :FieldNotApplicable
+      # A reference was made to a field, but it can't be told which one.
+      err :AmbiguousName
+      # A value was given when no more were expected.
+      err :DanglingValue
+      # A value was neither omitted from a source, nor fully specified.
+      err :IncompleteValue
+      # The source needed to resolve a reference within the source text, but
+      # couldn't.
+      err :BadReference
+    end
+  end
+
+  # Like the ruby's ArgumentError, but plays nice with heredoc messages.
+  err :BadArgument
+
+  # Testing only: an error that will never be raised.
+  err :UnusedError
+end
+
+end

data/lib/configuratrix/initialize.rb

@@ -0,0 +1,5 @@
+module Configuratrix
+  # It is frequently necessary to look up constants etc just in the local
+  # module and not in parents, but man is that an opaque interface.
+  NO_INHERIT = false
+end

data/lib/configuratrix/language-util.rb

@@ -0,0 +1,65 @@
+module Configuratrix
+module Internal
+
+module ConfigSchemaLanguageUtil
+  # Facilitate the slick no-default/default commaless syntax for minimally
+  # specifying a field.
+  #   field :has_no_default
+  # vs.
+  #   field defaults_to: :a_value
+  #
+  # Returns a triple of [name, has_default, default_value (if applicable)]
+  def self.unpack_field_args(name, kwargs, declaring: :field)
+    case kwargs.size
+    in 0
+      if name.nil?
+        raise Err::BadArgument, <<~END
+          #{declaring} declaration requires a name
+        END
+      end
+      [name.to_sym, false]
+    in 1
+      unless name.nil?
+        raise Err::BadArgument, <<~END
+          #{declaring} declaration can't mix positional and keyword
+          arguments
+        END
+      end
+      [kwargs.keys.first.to_sym, true, kwargs.values.first]
+    in (2...)
+      raise Err::BadArgument, <<~END
+        #{declaring} declaration takes no extra keywords
+      END
+    end
+  end
+
+  # Fetch (or create) the named field within the config schema.
+  def self.field_by_name(name, schema:)
+    NestingSchemaUtil.absent_local_or_remote(
+      name,
+      schema.method(:fields),
+      absent: -> { schema.field_add Field.nested_class!(name, under: schema) },
+      local:  -> { schema.field_get name },
+      remote: -> { schema.field_lift name },
+    )
+  end
+
+  def self.resolve_file_source_schema(filename, format)
+    return format if format .is_a? Class
+
+    format ||= filename.split('.').last
+    source_name = (format.to_s.capitalize << "File").to_sym
+
+    unless Mutable::DefaultSources.const_defined? source_name
+      raise Err::ValuelessKey, <<~END
+        #{source_name} does not name a Source!
+      END
+    end
+
+    Mutable::DefaultSources.const_get source_name
+  end
+end
+
+
+end
+end