# BasicSerializer
[![Ruby](https://github.com/aladac/basic_serializer/actions/workflows/main.yml/badge.svg)](https://github.com/aladac/basic_serializer/actions/workflows/main.yml)

This is a simple serializer for Ruby objects without heavy dependencies.

## Installation

Add to the application's Gemfile by executing:

    $ bundle add basic_serializer

If bundler is not being used to manage dependencies, install the gem by executing:

    $ gem install basic_serializer

## Usage

```ruby
class UserSerializer < BasicSerializer
  attribute :id, :integer                # attribute definition
  attribute :name, :string               # attribute definition
  attribute :email, :string              # attribute definition

  format :json, pretty: true             # output format and options

  model_name "User"                      # optional model name metadata
  schema_ref "#/components/schemas/User" # optional swagger schema reference
end

serializer = UserSerializer.new(name: 'Foobar', email: 'email@domain.com', id: 1)
serializer.serialize
```
```json
{
  "id": 1,
  "name": "Foobar",
  "email": "email@domain.com"
}
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/simple_serializer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/simple_serializer/blob/main/CODE_OF_CONDUCT.md).

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the SimpleSerializer project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/simple_serializer/blob/main/CODE_OF_CONDUCT.md).