0.0
No commit activity in last 3 years
No release in over 3 years
Helps you build objects without boilerplate.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 2.0
~> 10.0
~> 3.0
 Project Readme

ClearObject

clear_object helps you define your ruby objects(classes) without the need for a lot of boilerplate code.

Installation

Add this line to your application's Gemfile:

gem 'clear_object'

And then execute:

$ bundle

Or install it yourself as:

$ gem install clear_object

Usage

Imagine the following ruby class:

class Address
  attr_reader :city, :street

  def initialize(city:, :street)
   @city = city
   @street = street
  end

  def location
    "#{city}, #{street}"
  end
end

class User
  attr_reader :name, :email, :address

  def initialize(name:'Jo', email: nil, address: Address.new)
    @name = name
    @address = address
    @email = email
  end

  def location
    address.location
  end
end

clear_object gives you exactly the same code, but reduces the boilerplate

class User
  extends ClearObject

  clear :name, default: 'Jo'
  clear :email, default: nil
  clear :address do
    clear :city, :street
    def location
      "#{city} #{street}"
    end
  end
end

It will 'secretly' define an Address class for you under the hood in case you supply a block. You have control over the name of the class via the :class_name option. The default option will accept anything, including a callable object

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 tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/clear_object. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the ClearObject project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.