From ecca548233739f61f8a44447889bfd574ff7618c Mon Sep 17 00:00:00 2001 From: James Armes Date: Mon, 2 Sep 2024 23:49:16 -0400 Subject: [PATCH] Added some documentation. --- CHANGELOG.md | 20 +++++++ CODE_OF_CONDUCT.md | 132 +++++++++++++++++++++++++++++++++++++++++++++ LICENSE | 21 ++++++++ README.md | 102 +++++++++++++++++++++++++++++++++++ 4 files changed, 275 insertions(+) create mode 100644 CHANGELOG.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 LICENSE create mode 100644 README.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..f8504ee --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,20 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog][changelog], and this project adheres +to [Semantic Versioning][versioning]. + +## [Unreleased] + +Initial release. + +### Added + +- Simple DSL for defining configuration +- JSON and YAML file reading support +- Environment variable reading support +- Formatting and validation of values + +[changelog]: https://keepachangelog.com/en/1.1.0/ +[versioning]: https://semver.org/spec/v2.0.0.html diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..35746bc --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,132 @@ + +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official email address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +via GitHub. All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6d4e411 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 James I. Armes + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..b92b698 --- /dev/null +++ b/README.md @@ -0,0 +1,102 @@ +# ConfigSL + +ConfigSL is a simple Domain-Specific Language (DSL) module for configuration. +It is designed to provide a declarative way to define configuration, with as few +dependencies and additional cruft as possible. It is both modular and +extensible, so you can use as little or as much as you need. + +## Installation + +Add this line to your application's Gemfile: + +```ruby +gem 'configsl' +``` + +And then execute: + +```sh +bundle install +``` + +Or install it yourself as: + +```sh +gem install configsl +``` + +## Usage + +You can start defining your configurations using two methods: + +1. Extend the included `ConfigSL::Config` base class +2. Include the `ConfigSL` modules you want to use in you class + +### Using the included base class + +The `ConfigSL::Config` base class includes common functionality for working with +configurations. Currently, the class provides the following features: + +- **DSL**: The primary DSL for defining configuration options +- **Format**: A simple way to enforce option value formatting +- **FromEnvironment**: Load configuration from environment variables +- **FromFile**: Load configuration from a file +- **Validation**: Built-in validation for configuration options + +```ruby +require 'configsl' + +class AppConfig < ConfigSL::Config + register_file_format :json + register_file_format :yaml + + option :name, type: String, default: 'My App' + option :environment, type: Symbol, enum: %i[dev test prod], default: :dev, + env_variable: 'RACK_ENV' + option :database, type: DatabaseConfig, required: true +end +``` + +### Including modules + +If you'd like to pick and choose the features you want to use, you can include +modules individually. _Most_ modules can be included in any order, but the `DSL` +module _**must**_ be included before any others. + +Additionally, you will need to implement `initialize` -- or some other method -- +that sets the configuration values by calling `set_value` for each option. + +```ruby +require 'configsl' + +class ApplicationConfig + include ConfigSL::DSL + include ConfigSL::Format + include ConfigSL::FromEnvironment + + option :name, type: String, default: 'My App' + option :environment, type: Symbol, env_variable: 'RACK_ENV' + option :database, type: DatabaseConfig + + def initialize(params = {}) + params.each do |name, value| + set_value(name, value) + end + end +end +``` + +### A note about inheritance + +When working with multiple configuration classes, you'll likely want to use a +base class. This could be the `ConfigSL::Config` class, or a custom class that +includes the modules you need. + +While the modules you include are inherited by subclasses, any options you +define via DSL are not. This is because these values are stored using _class +instance variables_. As a result, if you have options that are shared between +classes, they will need to be implemented in both. + +It's important to note that this is not limited to your defined configuration +options, but also methods such as `register_file_format` and +`config_file_path`.