README.md
# Module Methods
[![Cirrus CI - Base Branch Build Status](https://img.shields.io/cirrus/github/AlexWayfer/module_methods?style=flat-square)](https://cirrus-ci.com/github/AlexWayfer/module_methods)
[![Codecov branch](https://img.shields.io/codecov/c/github/AlexWayfer/module_methods/main.svg?style=flat-square)](https://codecov.io/gh/AlexWayfer/module_methods)
[![Code Climate](https://img.shields.io/codeclimate/maintainability/AlexWayfer/module_methods.svg?style=flat-square)](https://codeclimate.com/github/AlexWayfer/module_methods)
[![Depfu](https://img.shields.io/depfu/AlexWayfer/benchmark_toys?style=flat-square)](https://depfu.com/repos/github/AlexWayfer/module_methods)
[![Inline docs](https://inch-ci.org/github/AlexWayfer/module_methods.svg?branch=main)](https://inch-ci.org/github/AlexWayfer/module_methods)
[![license](https://img.shields.io/github/license/AlexWayfer/module_methods.svg?style=flat-square)](https://github.com/AlexWayfer/module_methods/blob/main/LICENSE.txt)
[![Gem](https://img.shields.io/gem/v/module_methods.svg?style=flat-square)](https://rubygems.org/gems/module_methods)
Extendable module for modules with instance and class methods.
These modules can be included into each other modules and saving all chain,
including `inherited` or `included` (class) methods.
There are no conflicts with `ActiveSupport::Concern`.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'module_methods'
```
And then execute:
```shell
bundle install
```
Or install it yourself as:
```shell
gem install module_methods
```
## Usage
```ruby
require 'module_methods'
module SomeCommonCode
extend ::ModuleMethods::Extension
module ClassMethods
def inherited(klass)
## manipulations with klass
end
end
def some_method
## this is instance method
end
end
module MoreSpecificCommonCode
include SomeCommonCode
module ClassMethods
def inherited(klass)
## you can control the order of `inherited` execution by `super`
## this `super` executes `inherited` in `SomeCommonCode`
super
end
end
def some_another_method
## This is another instance method.
end
end
class BaseClass
include MoreSpecificCommonCode
## Instance methods from modules are here.
end
class EndPoint < BaseClass
## Both `inherited` from `SomeCommonCode` and `MoreSpecificCommonCode`
## are executing here; private methods from modules are also here.
end
```
## Development
After checking out the repo, run `bundle install` to install dependencies.
Then, run `toys rspec` to run the tests.
To install this gem onto your local machine, run `toys gem install`.
To release a new version, run `toys gem release %version%`.
See how it works [here](https://github.com/AlexWayfer/gem_toys#release).
## Contributing
Bug reports and pull requests are welcome on [GitHub](https://github.com/AlexWayfer/module_methods).
## License
The gem is available as open source under the terms of the
[MIT License](https://opensource.org/licenses/MIT).