Module: Innate::HelpersHelper

Includes:
Optioned
Defined in:
/home/manveru/github/ramaze/ramaze.net/tmp/git/innate/lib/innate/helper.rb

Overview

Here come the utility methods used from the HelperAccess#helper method, we do this to keep method count at a minimum and because HelpersHelper is such an awesome name that just can't be wasted.

Usage if you want to only extend with helpers:

class Hi Innate::HelpersHelper.each_extend(self, :cgi, :link, :aspect) end

Usage if you only want to include helpers:

class Hi Innate::HelpersHelper.each_include(self, :cgi, :link, :aspect) end

Usage for iteration:

Innate::HelpersHelper.each(:cgi, :link, :aspect) do |mod| p mod end

Usage for translating helpers to modules:

p Innate::HelpersHelper.each(:cgi, :link, :aspect)

Constant Summary

EXTS = 
%w[rb so bundle]

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods included from Optioned

included, #options

Class Method Details

+ (Object) each(*names)

Yield all the modules we can find for the given names of helpers, try to require them if not available.

NOTE: Unlike usual #each, this will actually return an Array of the found modules instead of the given +*names+

Usage:

Innate::HelpersHelper.each(:cgi, :link, :aspect) do |mod| p mod end



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File '/home/manveru/github/ramaze/ramaze.net/tmp/git/innate/lib/innate/helper.rb', line 102

def each(*names)
  names.map do |name|
    if name.class == Module
      yield(name) if block_given?
      name
    elsif mod = get(name)
      yield(mod) if block_given?
      mod
    elsif try_require(name)
      redo
    else
      raise LoadError, "Helper #{name} not found"
    end
  end
end

+ (Object) each_extend(into, *names, &block)

Shortcut to extend +into+ with Helper modules corresponding to +*names+. +into+ has to respond to #extend.

Usage:

class Hi Innate::HelpersHelper.each_extend(self, :cgi, :link, :aspect) end



126
127
128
129
 
# File '/home/manveru/github/ramaze/ramaze.net/tmp/git/innate/lib/innate/helper.rb', line 126

def each_extend(into, *names, &block)
  return if names.empty?
  into.extend(*each(*names, &block))
end

+ (Object) each_include(into, *names, &block)

Shortcut to include Helper modules corresponding to +*names+ on +into+. +into+ has to respond to #include.

send(:include) is used in case #include raises due to being

private/protected

in case #include is a private/protected method.

Usage:

class Hi Innate::HelpersHelper.each_include(self, :cgi, :link, :aspect) end



143
144
145
146
 
# File '/home/manveru/github/ramaze/ramaze.net/tmp/git/innate/lib/innate/helper.rb', line 143

def each_include(into, *names, &block)
  return if names.compact.empty?
  into.__send__(:include, *each(*names, &block))
end

+ (Object) find_helper(name) 



175
176
177
178
179
180
181
182
183
 
# File '/home/manveru/github/ramaze/ramaze.net/tmp/git/innate/lib/innate/helper.rb', line 175

def find_helper(name)
  options.paths.uniq.find do |path|
    base = ::File.join(path, 'helper', name)
    options.exts.find do |ext|
      full = "#{base}.#{ext}"
      return full if ::File.file?(full)
    end
  end
end

+ (Object) get(name)

Based on a simple set of rules we will first construct the most likely name for the helper and then grep the constants in the Innate::Helper module for any matches.

helper :foo_bar # => FooBar helper :foo # => Foo



154
155
156
157
158
159
160
161
162
163
 
# File '/home/manveru/github/ramaze/ramaze.net/tmp/git/innate/lib/innate/helper.rb', line 154

def get(name)
  module_name = /^#{name.to_s.dup.delete('_')}(?:helper)?$/i

  options.namespaces.each do |namespace|
    found = namespace.constants.grep(module_name).first
    return namespace.const_get(found) if found
  end

  nil
end

+ (Object) try_require(name)

Figure out files that might have the helper we ask for and then require the first we find, if any.



167
168
169
170
171
172
173
 
# File '/home/manveru/github/ramaze/ramaze.net/tmp/git/innate/lib/innate/helper.rb', line 167

def try_require(name)
  if found = find_helper(name.to_s)
    require(found) || true
  else
    raise(LoadError, "Helper #{name} not found")
  end
end

Instance Method Details

- (Object) each(*names) (private)

Yield all the modules we can find for the given names of helpers, try to require them if not available.

NOTE: Unlike usual #each, this will actually return an Array of the found modules instead of the given +*names+

Usage:

Innate::HelpersHelper.each(:cgi, :link, :aspect) do |mod| p mod end



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File '/home/manveru/github/ramaze/ramaze.net/tmp/git/innate/lib/innate/helper.rb', line 102

def each(*names)
  names.map do |name|
    if name.class == Module
      yield(name) if block_given?
      name
    elsif mod = get(name)
      yield(mod) if block_given?
      mod
    elsif try_require(name)
      redo
    else
      raise LoadError, "Helper #{name} not found"
    end
  end
end

- (Object) each_extend(into, *names, &block) (private)

Shortcut to extend +into+ with Helper modules corresponding to +*names+. +into+ has to respond to #extend.

Usage:

class Hi Innate::HelpersHelper.each_extend(self, :cgi, :link, :aspect) end



126
127
128
129
 
# File '/home/manveru/github/ramaze/ramaze.net/tmp/git/innate/lib/innate/helper.rb', line 126

def each_extend(into, *names, &block)
  return if names.empty?
  into.extend(*each(*names, &block))
end

- (Object) each_include(into, *names, &block) (private)

Shortcut to include Helper modules corresponding to +*names+ on +into+. +into+ has to respond to #include.

send(:include) is used in case #include raises due to being

private/protected

in case #include is a private/protected method.

Usage:

class Hi Innate::HelpersHelper.each_include(self, :cgi, :link, :aspect) end



143
144
145
146
 
# File '/home/manveru/github/ramaze/ramaze.net/tmp/git/innate/lib/innate/helper.rb', line 143

def each_include(into, *names, &block)
  return if names.compact.empty?
  into.__send__(:include, *each(*names, &block))
end

- (Object) find_helper(name) (private) 



175
176
177
178
179
180
181
182
183
 
# File '/home/manveru/github/ramaze/ramaze.net/tmp/git/innate/lib/innate/helper.rb', line 175

def find_helper(name)
  options.paths.uniq.find do |path|
    base = ::File.join(path, 'helper', name)
    options.exts.find do |ext|
      full = "#{base}.#{ext}"
      return full if ::File.file?(full)
    end
  end
end

- (Object) get(name) (private)

Based on a simple set of rules we will first construct the most likely name for the helper and then grep the constants in the Innate::Helper module for any matches.

helper :foo_bar # => FooBar helper :foo # => Foo



154
155
156
157
158
159
160
161
162
163
 
# File '/home/manveru/github/ramaze/ramaze.net/tmp/git/innate/lib/innate/helper.rb', line 154

def get(name)
  module_name = /^#{name.to_s.dup.delete('_')}(?:helper)?$/i

  options.namespaces.each do |namespace|
    found = namespace.constants.grep(module_name).first
    return namespace.const_get(found) if found
  end

  nil
end

- (Object) try_require(name) (private)

Figure out files that might have the helper we ask for and then require the first we find, if any.



167
168
169
170
171
172
173
 
# File '/home/manveru/github/ramaze/ramaze.net/tmp/git/innate/lib/innate/helper.rb', line 167

def try_require(name)
  if found = find_helper(name.to_s)
    require(found) || true
  else
    raise(LoadError, "Helper #{name} not found")
  end
end