Русский | English

The import statement is used to import functions and objects that have been exported from an external module or class in Ruby.

This is a good and simple alternative to extend and include statements. The idea is greatly inspired by ES6 import statement

Why not use extend or include? Because it mixes with your current module/class scope and conflicts with existing or future method names. Also you can not include concerns with the same method names in the same module. In case of ModuleImport you import every module into different namespace. It is safe and clean.

Add this line to your application's Gemfile:

gem 'module_import'

or require injector when you want to have import method in Object

gem 'module_import', require: 'module_import/inject'

And then execute:

$ bundle

Or install it yourself as:

$ gem install module_import

# foo_helpers.rb
module FooHelpers
  def some_helper
    puts 'Ok foo'
  end
end

# bar_helpers.rb
class BarHelpers
  def another_helper
    puts 'Ok bar'
  end
end

# example1.rb
require 'foo_helpers'
FH = ModuleImport.import FooHelpers
FH.some_helper
# > Ok foo

require 'bar_helpers'
BH = ModuleImport.import BarHelpers
BH.another_helper
# > Ok bar

# Gemfile
gem 'module_import', require: 'module_import/inject'

# app/models/user.rb
class User < ActiveRecord::Base
  TextHelpers = import ActionView::Helpers::TextHelper
  
  def short_name
    TextHelpers.truncate name, 20
  end
end

It's recommended to create app/utils directory and put there primitive helpers to be used in any classes in your application.

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.

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

• https://github.com/franckverrot/rb_import

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