Project

core

0.0
A long-lived project that still receives updates
corebkuhlmann/coreHomepageDocumentationSource CodeBug Tracker
A collection of foundational objects.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
45,000
Stars
0
Forks
2
Watchers
2
 Releases
Current version
1.3.0
Total releases
12
First release
2009-10-12
Latest release
2024-04-21
 Development
Primary Language
Ruby
Licenses
Hippocratic-2.1
Average date of last 50 commits
2023-10-01
Reverse Dependencies
10

 Dependencies
 Project Readme

Core

Provides a collection of core objects missing from the standard Ruby distribution. This is meant to provide common objects for engineering advanced architctures in order to reduce duplication, improve performance, and improve memory usage.

Table of Contents
  • Features
  • Requirements
  • Setup
  • Usage
    • Constants
    • Functions
  • Development
  • Tests
  • License
  • Security
  • Code of Conduct
  • Contributions
  • Versions
  • Community
  • Credits

Features

  • Provides commonly needed core objects.

Requirements

  1. Ruby.

Setup

To set up the project, run:

bin/setup

Usage

The following details what is currently available for use.

Constants

The following empty constants are frozen by default and available for use as core objects for use throughout your application.

  • Core::EMPTY_ARRAY: Provides an empty Array instance.

  • Core::EMPTY_DATA: Provides an empty Data instance.

  • Core::EMPTY_HASH: Provides an empty Hash instance.

  • Core::EMPTY_SET: Provides an empty Set instance.

  • Core::EMPTY_STRING: Provides an empty String instance.

Functions

The following identity function (lambda) is available as a neutral value in function composition:

Core::Identity.call "example"  # "example"

Development

To contribute, run:

git clone https://github.com/bkuhlmann/core
cd core
bin/setup

You can also use the IRB console for direct access to all objects:

bin/console

Tests

To test, run:

bin/rake

Credits