module Bridgetown::Utils::RequireGems

Public Class Methods

require_if_present(names) { |name, version_constraint(name)| ... } click to toggle source

Require a gem or file if it's present, otherwise silently fail.

names - a string gem name or array of gem names

# File lib/bridgetown-core/utils/require_gems.rb, line 12
def require_if_present(names)
  Array(names).each do |name|
    require name
  rescue LoadError
    Bridgetown.logger.debug "Couldn't load #{name}. Skipping."
    yield(name, version_constraint(name)) if block_given?
    false
  end
end
require_with_graceful_fail(names) click to toggle source

Require a gem or gems. If it's not present, show a very nice error message that explains everything and is much more helpful than the normal LoadError.

names - a string gem name or array of gem names

# File lib/bridgetown-core/utils/require_gems.rb, line 38
        def require_with_graceful_fail(names)
          Array(names).each do |name|
            Bridgetown.logger.debug "Requiring:", name.to_s
            require name
          rescue LoadError => e
            Bridgetown.logger.error "Dependency Error:", <<~MSG
              Yikes! It looks like you don't have #{name} or one of its dependencies installed.
              In order to use Bridgetown as currently configured, you'll need to install this gem.

              If you've run Bridgetown with `bundle exec`, ensure that you have included the #{name}
              gem in your Gemfile as well.

              The full error message from Ruby is: '#{e.message}'

              If you run into trouble, you can find helpful resources at https://www.bridgetownrb.com/docs/community/
            MSG
            raise Bridgetown::Errors::MissingDependencyException, name
          end
        end
version_constraint() click to toggle source

The version constraint required to activate a given gem.

Returns a String version constraint in a parseable form for RubyGems.

# File lib/bridgetown-core/utils/require_gems.rb, line 27
def version_constraint
  "> 0"
end