Module: Usable

Defined in:
lib/usable.rb,
lib/usable/config.rb,
lib/usable/version.rb,
lib/usable/config_multi.rb,
lib/usable/mod_extender.rb,
lib/usable/config_register.rb

Defined Under Namespace

Modules: ConfigMulti, ConfigRegister Classes: Config, ModExtender

Constant Summary collapse

VERSION = 
"3.0.0".freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#usables ⇒ Object 



36
37
38
 
# File 'lib/usable.rb', line 36

def usables
  @usables ||= Config.new
end

Class Method Details

.extended(base) ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/usable.rb', line 9

def self.extended(base)
  base.class_eval do
    def usable_method(method_name)
      self.class.usable_method(self, method_name)
    end
  end
  if base.is_a? Class
    # Define an instance level version of +usables+
    base.class_eval do
      def usables
        self.class.usables
      end
    end
  else
    # Define +config+ when added to a module
    base.instance_eval do
      def config(&block)
        if block
          usables.instance_eval &block
        else
          usables
        end
      end unless defined? config
    end
  end
end

Instance Method Details

#usable(*args, &block) ⇒ Object

Note:

Hides methods

Returns self.

Examples:


class Example
  extend Usable
  usable Mixin, only: [:foo, :bar] do
    baz "Available as `Example.usables.baz` or `Example.usables.mixin.baz`"
  end
end

Parameters:

  • mod (Module)
  • options (Hash) —

    Customize the extension of the module as well as define config settings on the target

  • [Array,Symbol] (Hash) —

    a customizable set of options

  • [String,Symbol] (Hash) —

    a customizable set of options

Returns:

  • self



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/usable.rb', line 59

def usable(*args, &block)
  options = args.last.is_a?(Hash) ? args.pop : {}
  args.each do |mod|
    ModExtender.new(mod, only: options.delete(:only), method: options.delete(:method)).call self
    # Define settings on @usables and on the scoped @usables
    scope = Config.new
    if mod.name
      scope_name = mod.name.split('::').last.gsub(/\B([A-Z])([a-z_0-9])/, '_\1\2').downcase
      usables[scope_name] = scope
    end
    if mod.respond_to? :usables
      scope += mod.usables
      self.usables += mod.usables
    end
    # any left over -options- are considered "config" settings
    if options
      [scope, usables].each { |x| options.each { |k, v| x[k] = v } }
    end
    if block_given?
      [scope, usables].each { |x| x.instance_eval &block }
    end
    if mod.const_defined?(:InstanceMethods, false)
      send :include, mod.const_get(:InstanceMethods, false)
    end
    if mod.const_defined?(:ClassMethods, false)
      send :extend, mod.const_get(:ClassMethods, false)
    end
  end
  self
end

#usable_method(context, method_name) ⇒ Method

Returns bound to the given -context-.

Returns:

  • (Method) —

    bound to the given -context-



91
92
93
 
# File 'lib/usable.rb', line 91

def usable_method(context, method_name)
  usables.available_methods[method_name].bind(context)
end