Contents

# Inspectacular

## Installation

Install the gem and add to the application's Gemfile by executing:

    bundle add inspectacular

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

    gem install inspectacular

## Usage

Fed up of lengthy `#inspect` output? 😩

Simply extend any object with `Inspectacular` to get a custom `#inspect` method with the given attributes.

```ruby
class User < ApplicationRecord
  extend Inspectacular[:id, :name, :email]
end

User.first.inspect #=> "#<User id: 1, name: 'John Doe', email: '<[e-mail]>'>
```

If no attributes are given, the default is to inspect the object's `#id` attribute.

```ruby
class Account < ApplicationRecord
  extend Inspectacular
end

Account.first.inspect #=> "#<Account id: 1>
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/joelmoss/inspectacular. 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/joelmoss/inspectacular/blob/master/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 Inspectacular project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/joelmoss/inspectacular/blob/master/CODE_OF_CONDUCT.md).

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
inspectacular-1.0.0	README.md