awncorp / venus Goto Github PK

View Code? Open in Web Editor NEW

35.0 1.0 2.0 9.97 MB

OO Standard Library for Perl 5

Home Page: https://metacpan.org/release/Venus

License: Other

Perl 100.00%

perl perl5 object-oriented standard-library

venus's Introduction

Venus - Object-Oriented Standard Library for Perl 5

Venus is an object-orientation framework and extendible standard library for Perl 5 with classes which wrap most native Perl data types. Venus has a simple modular architecture, robust library of classes and methods, supports pure-Perl autoboxing, advanced exception handling, "true" and "false" keywords, package introspection, command-line options parsing, and more.

Installation

Install Venus using cpm:

cpm install Venus

Install Venus using cpanm:

cpanm -qn Venus

Install Venus using Perl (via cpanm):

curl -sSL https://cpanmin.us | perl - -qn Venus

Install Venus using Perl (via cpanm, from GitHub):

curl -ssL https://cpanmin.us | perl - -qn https://github.com/awncorp/venus.zip

Features

Perl 5.18.0+
Zero Dependencies
Fast Object-Orientation
Robust Standard Library
Intuitive Value Classes
Pure Perl Autoboxing
Convenient Utility Classes
Simple Package Reflection
Flexible Exception Handling
Composable Standards
Pluggable (no monkeypatching)
Proxyable Methods
Type Assertions
Type Coercions
Value Casting
Boolean Values
Complete Documentation
Complete Test Coverage

Founder

@awncorp

Contributing

We rely on your contributions and feedback to improve Venus, and we love hearing about your experiences and what we can improve upon.

All contributions are always welcome! See the contributing guide for ways to get started, and please adhere to this project's code of conduct.

Support

For support, feel free to report an issue.

License

Apache 2

venus's People

Contributors

Stargazers

Watchers

Forkers

stepht bollwarm

venus's Issues

Implement Venus::Match#expr

Conveniently match against a string or regular expression.

Document overrides

Document all Kind classes and roles which implement operator overloading.

i.e. "This package overloads the following operators:"

Fix Venus::Role::Coercible build process

Update String#render token syntax

Tokens should take the form of {{token}} or {{ token }}, not {token}.

https://github.com/cpanery/venus/blob/3d3f2e9ca1ad134cecdfc08676fc662954e7f7c0/lib/Venus/String.pm#L181

Implement String#substr

Release v0.01

Implement better Venus::Json

Document overrides in Venus::Boolean

Implement Venus::Role::Digestable

This role should be added to all Kind classes. The digest method call will wrap the existing dump signature and allow derived objects to compute a hash using the core "Digest" module.

Implement Venus::Role::Coercible

A role that reifies hierarchical data structures (during object construction) as objects with complex (nesting).

Inspiration: https://metacpan.org/pod/Data::Object::Role::Formulatable

Update documentation

Release v0.01

Add missing Venus::Role::Digestable documentation

t/Venus_Date.t may fail with non-English locale

See subject. With a German locale it fails like this:

    #   Failed test at t/Venus_Date.t line 1159.
    #                   'Mo, 01 Feb 1988 00:00:00 +0100'
    #     doesn't match '(?^u:Mon, 01 Feb 1988 00:00:00 [-+]\d{4})'
    # Looks like you failed 1 test of 4.

Implement String#prepend

Fix Venus::Path#mkdirs empty rootdir issue

Release v0.03

Fix Venus::Role::Dumpable

Redress release pipeline

Document all proxyable methods

A proxyable method, different from the Proxyable role, are methods that take as arguments a method name and arguments which the original method call will make itself after performing some other operation.

Release v0.04

Extend Venus::Role::Coercion with new abilities

Venus::Role::Coercion#coerce_args
This method coerces the build arguments provided.
E.g. coerce_args(data, spec)

Venus::Role::Coercion#coerce_into
This method coerces a value into an object.
E.g. coerce_into(Venus/Code, value)

Venus::Role::Coercion#coerce_onto
This method sets a single writable attribute using the coerced value
E.g. coerce_onto(data, foo, Venus/Code, value)

Implement String#repeat

Remove version testing, update documentation

Address CPAN Testers reports

See https://www.cpantesters.org/distro/V/Venus.html?oncpan=1&distmat=1&version=0.03&grade=3

Address test failures reported via CPAN testers issues

Venus::Date tests fail in envs with non-English locales
Venus::Path tests fail in Windows envs
Venus distro declares Perl 5.14 instead of 5.18

Release v0.06

Update CONTRIBUTING.md

Update CONTRIBUTING.md to include required and suggested tools, as well as an explanation of how CI/CD is configured, how CHANGELOG is generated, and how releases to GitHub and CPAN are done.

Implement CHANGES.json

Update title in README

i.e. to say "Object-Oriented Standard Library for Perl 5"

Remove git configs from CI/CD tests

Remove unnecessary git config directives from CI/CD tests.

Fix Venus::Template#render not rendering falsy values

Fix Dumpable method calls in list context

Update releasing pipeline

Fix Venus::Template newline handling

Validate CI/CD testing pipeline

Futureproof handling of boolean values

Apparently, Perl 5.37.5 introduced a builtin pragma which provides true and false keywords. While widespread adoption of that version of Perl and that particular pragma is not likely to happen anytime soon, it's a good idea to ensure Venus isn't coming into conflict with that environment.

https://perldoc.perl.org/5.35.7/builtin#SYNOPSIS

Release v0.05

Implement Venus::Template

Implement Venus::Yaml class for YAML handling

I believe the standard library should have both JSON and YAML de/serializers, both of which will have an almost identical API.

Require Perl version 5.18+

Document and be transparent that Venus supports Perl versions 5.18+.

Validate CI/CD releasing pipeline

Update CHANGES.json

Implement Venus::Match

Implement Venus::Match#data

Takes a hashref/lookup table to create match conditions and actions.

Implement String#append_with,prepend_with

Implement Venus::Process

Implement Venus::Role::Matchable

Implement Venus::Role::Matchable and attach it to Venus::Kind.

Implement better multi-library JSON handling

While JSON::PP 2.9700 is core in Perl 5.14 onward, configuring custom boolean values via boolean_values supported isn't until JSON::PP 4.00.

https://github.com/cpanery/venus/blob/99ca61b2701fce115ab6178c533e22db73d400a3/lib/Venus/Json.pm#L43-L46
https://github.com/cpanery/venus/blob/99ca61b2701fce115ab6178c533e22db73d400a3/lib/Venus/Json.pm#L81-L84

This is going to continue to get hairy, first having to drop support for Cpanel::JSON::XS, and now having to contend with all the nuances between different JSON libraries and their handling of boolean values.