File perl-Data-Domain.spec of Package perl-Data-Domain

Overview Repositories Revisions Requests Users Attributes Meta

File perl-Data-Domain.spec of Package perl-Data-Domain (Revision 7321859cec515703359318c6e1eb6fec)

Currently displaying revision 7321859cec515703359318c6e1eb6fec , Show latest

#
# spec file for package perl-Data-Domain
#
# Copyright (c) 2024 SUSE LLC
#
# All modifications and additions to the file contributed by third parties
# remain the property of their copyright owners, unless otherwise agreed
# upon. The license for this file, and modifications and additions to the
# file, is the same license as for the pristine package itself (unless the
# license for the pristine package is not an Open Source License, in which
# case the license is the MIT License). An "Open Source License" is a
# license that conforms to the Open Source Definition (Version 1.9)
# published by the Open Source Initiative.

# Please submit bugfixes or comments via https://bugs.opensuse.org/
#

%define cpan_name Data-Domain
Name:           perl-Data-Domain
Version:        1.14
Release:        0
License:        Artistic-1.0 OR GPL-1.0-or-later
Summary:        Data description and validation
URL:            https://metacpan.org/release/%{cpan_name}
Source0:        https://cpan.metacpan.org/authors/id/D/DA/DAMI/%{cpan_name}-%{version}.tar.gz
BuildArch:      noarch
BuildRequires:  perl
BuildRequires:  perl-macros
BuildRequires:  perl(Clone)
BuildRequires:  perl(Date::Calc)
BuildRequires:  perl(List::MoreUtils)
BuildRequires:  perl(Module::Build) >= 0.420000
BuildRequires:  perl(Scalar::Does) >= 0.007
BuildRequires:  perl(Sub::Exporter)
BuildRequires:  perl(Test::More) >= 1.30219
BuildRequires:  perl(Test::Warnings)
BuildRequires:  perl(Try::Tiny)
BuildRequires:  perl(experimental)
BuildRequires:  perl(match::simple)
Requires:       perl(Date::Calc)
Requires:       perl(List::MoreUtils)
Requires:       perl(Scalar::Does) >= 0.007
Requires:       perl(Sub::Exporter)
Requires:       perl(Try::Tiny)
Requires:       perl(experimental)
Requires:       perl(match::simple)
Recommends:     perl(match::simple::XS)
%{perl_requires}

%description
A _data domain_ is a description of a set of values, either scalar or
structured (arrays or hashes, possibly nested). The description can include
many constraints, like minimal or maximal values, regular expressions,
required fields, forbidden fields, and also contextual dependencies (for
ex. one date must be posterior to another date). From that description, one
can then invoke the domain's 'inspect' method to check if a given value
belongs to the domain or not. In case of mismatch, a structured set of
error messages is returned, giving detailed explanations about what was
wrong.

The motivation for writing this package was to be able to express in a
compact way some possibly complex constraints about structured data.
Typically the data is a Perl tree (nested hashrefs or arrayrefs) that may
come from XML, JSON, from a database through DBIx::DataModel, or from
postprocessing an HTML form through CGI::Expand. 'Data::Domain' is a kind
of tree parser on that structure, with some facilities for dealing with
dependencies within the structure, and with several options to finely tune
the error messages returned to the user.

The main usage for 'Data::Domain' is to check input from forms in
interactive applications. Structured error messages returned by the domain
give detailed information about which fields were rejected and why; this
can be used to display a new form to the user, highlighting the wrong
inputs.

A domain can also _validate_ a datatree, instead of _inspecting_ it.
Instead of returning error messages, this returns a copy of the input data,
where missing components are replaced by default values (if such defaults
where specified within the domain). In case of failure, the validation
operation dies with a stringified version of the error messages. This usage
is quite similar to type systems like Type::Tiny or Specio, or to parameter
validation modules like Params::ValidationCompiler; such systems are more
focused on efficiency and on integration with Moose, while the present
module is more focused on expressivity for describing constraints on deeply
nested structures.

The validation operation can be encapsulates as a _signature_, which is a
reference to an anonymous function that will unpack arguments passed to a
subroutine or to a method, will validate them, and will return them in the
form of an array or a hash, as demanded by the context. This is probably
not as fast nor as elegant as the new "signature" feature introduced in
Perl 5.20; but it is a convenient way for performing complex validity tests
on parameters received from the caller.

The companion module Test::InDomain uses domains for checking datatrees in
the context of automated tests.

There are several other packages in CPAN doing data validation; these are
briefly listed in the "SEE ALSO" section.

%prep
%autosetup  -n %{cpan_name}-%{version}

%build
perl Build.PL --installdirs=vendor
./Build build --flags=%{?_smp_mflags}

%check
./Build test

%install
./Build install --destdir=%{buildroot} --create_packlist=0
%perl_gen_filelist

%files -f %{name}.files
%doc Changes README

%changelog

Places

File perl-Data-Domain.spec of Package perl-Data-Domain (Revision 7321859cec515703359318c6e1eb6fec)

Places