Lucille

Lucille is a collection of utilities for Lucky framework. It includes many custom validations for Avram operations, and several helper types and methods for use in app development and specs.

Installation

1. Add the dependency to your shard.yml:

   dependencies:
     lucille:
       github: GrottoPress/lucille
   

2. Run shards update

3. Require Lucille in your app:

   # ...
   
   require "lucille"
   # <= Or you may require only the components you need:
   # <= `require "lucille/avram"`
   # <= `require "lucille/carbon"`
   # <= `require "lucille/lucky"`
   
   # For specs:
   #
   #   require "lucille/spec"
   #
   #   Or require only the components you need:
   #
   #     require "lucille/spec/avram"
   #     require "lucille/spec/carbon"
   #     require "lucille/spec/lucky"
   
   # ...
   

Utilities

Avram

• Macros

  • __enum: Creates an Avram adapter that saves enums to the database as String

• Validations

  • .validate_email
  • .validate_domain
  • .validate_domain_label
  • .validate_http_url
  • .validate_ip
  • .validate_ip4
  • .validate_ip6
  • .validate_name
  • .validate_negative_number
  • .validate_not_pwned
  • .validate_positive_number
  • .validate_primary_key
  • .validate_slug
  • .validate_url
  • .validate_username

Carbon

• Mixins

  • MailHelpers: Includes helpers for working with Carbon mails

Lucky

• Annotations

  • Memoize: Invokes Lucky's .memoize macro

Spec

• Avram

  • #assert_invalid: Asserts that a given attribute is invalid
  • #assert_valid: Asserts that a given attribute is valid
  • #nested_params: Creates nested params
  • #params: Creates params

• Carbon

  • DevDeliverLaterStrategy: Delivers mail immediately, in the current fiber.

Development

Create a .env.sh file:

#!/bin/bash

export DATABASE_URL='postgres://postgres:password@localhost:5432/lucille_spec'

Update the file with your own details. Then run tests with source .env.sh && crystal spec.

Contributing

1. Fork it
2. Switch to the master branch: git checkout master
3. Create your feature branch: git checkout -b my-new-feature
4. Make your changes, updating changelog and documentation as appropriate.
5. Commit your changes: git commit
6. Push to the branch: git push origin my-new-feature
7. Submit a new Pull Request against the GrottoPress:master branch.