https://github.com/matt-taylor/class_composer

https://github.com/matt-taylor/class_composer

Last synced: 15 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/matt-taylor/class_composer
• Owner: matt-taylor
• Created: 2022-06-24T21:07:28.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-18T20:57:32.000Z (about 1 month ago)
• Last Synced: 2024-12-18T21:36:22.570Z (about 1 month ago)
• Language: Ruby
• Size: 41 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# ClassComposer

Basic configuration is relatively simple but tedious to do if done multiple times. throughout a project. The intention of `ClassComposer` is to DRY up as much of that configuration as possible to allow you to just write code.

## Installation

`ClassComposer` is hosted on RubyGems https://rubygems.org/gems/class_composer

Add this line to your application's Gemfile:

```ruby

gem 'class_composer'

```

And then execute:

    $ bundle install

Or install it yourself as:

    $ gem install class_composer

## Usage

### Basic Add Composer

`add_composer` is the driving method behind the composer gem. It will

- Add a setter Method

- Add a getter Method

- Add instance variable

- Add validation Method

In short, Composer will behave similarly to `attr_accessor`

Check out [Basic Composer](docs/basic_composer.md) for usage details

### Usage with Arrays

Composer allows interactions with arrays in a native way. When the allowed type is `Array`, ClassComposer will add a custom method `<<` to overwrite the native Array method. This ensures that ClassComposer Validations run when adding to the Array.

For more information, check out [Array Usage](docs/array_usage.md)

### Freezing Objects

Sometimes you want freeze an instance of a Configuration. Freezing it will make it immutable from changes Users may try to make.

For more information, check out [Freezing Class Composer Instances](docs/freezing.md)

### Complex usage: Composer Blocking

Composer blocking builds on top of the [Basic Composer](docs/basic_composer.md) to help with nested Configurations that include `ClassCompser::Generator`.

Nested configuration's allow complex configurations for entire projects to work seamlessly together.

For Examples and use cases, check out [Composer Blocking](docs/composer_blocking.md)

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run

`bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive

prompt that will allow you to experiment.

## Contributing

Bug reports and pull requests are welcome on GitHub at

https://github.com/matt-taylor/class_composer.