Skip to content

v-kolesnikov/sparse_include

Repository files navigation

SparseInclude

Build Status

A simple module wrapper which allows to sparse include (and extend) methods from other modules.

Installation

Add this line to your application's Gemfile:

gem 'sparse_include'

And then execute:

$ bundle

Or install it yourself as:

$ gem install sparse_include

Usage

module Foo
  def foo
    42
  end

  def bar
    24
  end
end

class Bar
  include SparseInclude[Foo, foo: :bar]
end

>> Bar.new.respond_to?(:foo)
=> false
>> Bar.new.respond_to?(:bar)
=> true
>> Bar.new.bar
=> 42

class Bar
  extend SparseInclude[Foo, foo: :bar]
end

>> Bar.respond_to?(:foo)
=> false
>> Bar.respond_to?(:bar)
=> true
>> Bar.bar
=> 42

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]/sparse_include. 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 Sparse::Include project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.