Selfer

Code Climate Build Status Gem Version

Stops you having to write class methods that delegate to their respective instance method.

Basic Usage

VisibleQuery.find(Hotel.all) looks nicer than VisibleQuery.new(Hotel.all).find but the latter is easier to test. This gem allows the best of both worlds.

Before:

class VisibleQuery
  def initialize(relation)
    @relation = relation
  end

  def all
    @relation.where(hidden: false)
  end

  def find(id)
    all.find(id)
  end

  def self.all(relation)
    new(relation).all
  end

  def self.find(relation, id)
    new(relation).find(id)
  end
end

VisibleQuery.all(Hotel.all)
VisibleQuery.find(Hotel.all,1)

After:

class VisibleQuery
  extend Selfer

  selfer :all, :find

  def initialize(relation)
    @relation = relation
  end

  def all
    @relation.where(hidden: false)
  end

  def find(id)
    all.find(id)
  end
end

VisibleQuery.all(Hotel.all)
VisibleQuery.find(Hotel.all,1)

Installation

Add this line to your application's Gemfile:

gem 'selfer'

And then execute:

$ bundle

Or install it yourself as:

$ gem install selfer

Usage

See description.

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

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/robwilliams/selfer. 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.