Contents

require "ostruct"
require "delegate"
require "usable/version"

module Usable

  autoload :ModExtender, 'usable/mod_extender'
  autoload :Config, 'usable/config'

  def usable_config
    @usable_config ||= Config.new
  end
  attr_writer :usable_config

  # @description Configures the +available_methods+ of a module using the given options or block and then includes it on
  #   the target class. Checks if there is a module named UsableSpec within the given mods namespace and uses the instance of
  #   methods of that as the +available_methods+
  #
  # @example
  #
  #   class Example
  #     extend Usable
  #     usable VersionKit, only: :save_version
  #   end
  #
  # @note Hides methods
  # @note We include the primary mod when there is a UsableSpec set because any instance method defined on the mod are not
  #   configurable and should therefore takes precedence over those defined in the UsableSpec
  # @return [ModExtender] containing the original and modified module
  def usable(mod, options = {})
    options.each { |k, v| usable_config.public_send "#{k}=", v }
    yield usable_config if block_given?
    mod_ext = ModExtender.new mod, usable_config
    usable! mod_ext
    usable! mod if mod_ext.has_spec?
    mod_ext
  end

  # @description Directly include a module whose methods you want made available in +usable_config.available_methods+
  #   Gives the module a name when including so that it shows up properly in the list of ancestors
  def usable!(mod)
    mod_name = mod.name ? mod.name.split('::').last : "UsableMod#{Time.now.strftime('%s')}"
    const_name = "#{mod_name}Used"
    mod = mod.call if mod.respond_to? :call
    remove_const const_name if const_defined? const_name
    const_set const_name, mod
    usable_config.modules << mod
    send :include, mod
  end

  # @return [Method] bound to the given -context-
  def usable_method(context, method_name)
    usable_config.available_methods[method_name].bind(context)
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
usable-1.2.0	lib/usable.rb