Module: Innate::Node

Includes:
Traited
Defined in:
lib/innate/node.rb

Overview

The nervous system of Innate, so you can relax.

Node may be included into any class to make it a valid responder to requests.

The major difference between this and the old Ramaze controller is that every Node acts as a standalone application with its own dispatcher.

What’s also an important difference is the fact that Node is a module, so we don’t have to spend a lot of time designing the perfect subclassing scheme.

This makes dispatching more fun, avoids a lot of processing that is done by Rack anyway and lets you tailor your application down to the last action exactly the way you want without worrying about side-effects to other Nodes.

Upon inclusion, it will also include Trinity and Helper to provide you with Request, Response, Session instances, and all the standard helper methods as well as the ability to simply add other helpers.

Please note that method_missing will not be considered when building an Action. There might be future demand for this, but for now you can simply use ‘def index(*args); end` to make a catch-all action.

Constant Summary collapse

NODE_LIST = 
Set.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Traited

#ancestral_trait, #ancestral_trait_values, #class_trait, #each_ancestral_trait, #trait

Instance Attribute Details

#layout_templates ⇒ Object (readonly)

Returns the value of attribute layout_templates.



31
32
33
 
# File 'lib/innate/node.rb', line 31

def layout_templates
  @layout_templates
end

#method_arities ⇒ Object (readonly)

Returns the value of attribute method_arities.



31
32
33
 
# File 'lib/innate/node.rb', line 31

def method_arities
  @method_arities
end

#view_templates ⇒ Object (readonly)

Returns the value of attribute view_templates.



31
32
33
 
# File 'lib/innate/node.rb', line 31

def view_templates
  @view_templates
end

Class Method Details

.generate_mapping(object_name = self.name) ⇒ Object 



91
92
93
94
95
96
97
 
# File 'lib/innate/node.rb', line 91

def self.generate_mapping(object_name = self.name)
  return '/' if NODE_LIST.size == 1
  parts = object_name.split('::').map{|part|
    part.gsub(/^[A-Z]+/){|sub| sub.downcase }.gsub(/[A-Z]+[^A-Z]/, '_\&')
  }
  '/' << parts.join('/').downcase
end

.included(into) ⇒ Object

Upon inclusion we make ourselves comfortable.



64
65
66
67
68
69
70
71
72
73
 
# File 'lib/innate/node.rb', line 64

def self.included(into)
  into.__send__(:include, Helper)
  into.extend(Trinity, self)

  NODE_LIST << into

  return if into.provide_set?
  into.provide(:html, :engine => :Etanni)
  into.trait(:provide_set => false)
end

.setup ⇒ Object

node mapping procedure

when Node is included into an object, it’s added to NODE_LIST when object::map(location) is sent, it maps the object into DynaMap when Innate.start is issued, it calls Node::setup Node::setup iterates NODE_LIST and maps all objects not in DynaMap by using Node::generate_mapping(object.name) as location

when object::map(nil) is sent, the object will be skipped in Node::setup



85
86
87
88
89
 
# File 'lib/innate/node.rb', line 85

def self.setup
  NODE_LIST.each{|node|
    node.map(generate_mapping(node.name)) unless node.trait[:skip_node_map]
  }
end

Instance Method Details

#action_found(action) ⇒ Innate::Response

Executed once an Action has been found.

Reset the Response instance, catch :respond and :redirect. Action#call has to return a String.

Parameters:

Returns:

See Also:

Author:

  • manveru



304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/innate/node.rb', line 304

def action_found(action)
  response = catch(:respond){ catch(:redirect){ action.call }}

  unless response.respond_to?(:finish)
    self.response.write(response)
    response = self.response
  end

  response['Content-Type'] ||= action.options[:content_type]
  response
end

#action_missing(path) ⇒ Object

The default handler in case no action was found, kind of method_missing. Must modify the response in order to have any lasting effect.

Reasoning:

  • We are doing this is in order to avoid tons of special error handling code that would impact runtime and make the overall API more complicated.

  • This cannot be a normal action is that methods defined in Innate::Node will never be considered for actions.

To use a normal action with template do following:

Examples:


class Hi
  include Innate::Node
  map '/'

  def self.action_missing(path)
    return if path == '/not_found'
    # No normal action, runs on bare metal
    try_resolve('/not_found')
  end

  def not_found
    # Normal action
    "Sorry, I do not exist"
  end
end

Parameters:

  • path (String)

See Also:

Author:

  • manveru



351
352
353
354
355
356
357
358
 
# File 'lib/innate/node.rb', line 351

def action_missing(path)
  response = Current.response
  response.status = 404
  response['Content-Type'] = 'text/plain'
  response.write("No action found at: %p" % path)

  response
end

#alias_view(to, from, node = nil) ⇒ Object

Aliasing one view from another. The aliases are inherited, and the optional third node parameter indicates the Node to take the view from.

The argument order is identical with ‘alias` and `alias_method`, which quite honestly confuses me, but at least we stay consistent.

Note that the parameters have been simplified in comparision with Ramaze::Controller::template where the second parameter may be a Controller or the name of the template. We take that now as an optional third parameter.

Examples:

class Foo
  include Innate::Node

  # Use the 'foo' view when calling 'bar'
  alias_view 'bar', 'foo'

  # Use the 'foo' view from FooBar node when calling 'bar'
  alias_view 'bar', 'foo', FooBar
end

Parameters:

  • to (#to_s) —

    view that should be replaced

  • from (#to_s) —

    view to use or Node.

  • node (#nil?, Node) (defaults to: nil) —

    optionally obtain view from this Node

See Also:

  • Node::find_aliased_view

Author:

  • manveru



615
616
617
618
 
# File 'lib/innate/node.rb', line 615

def alias_view(to, from, node = nil)
  trait[:alias_view] || trait(:alias_view => {})
  trait[:alias_view][to.to_s] = node ? [from.to_s, node] : from.to_s
end

#binding ⇒ Binding

For compatibility with new Kernel#binding behaviour in 1.9

Returns:

  • (Binding) —

    binding of the instance being rendered.

See Also:

Author:

  • manveru



897
 
# File 'lib/innate/node.rb', line 897

def binding; super end

#call(env) ⇒ Array

This makes the Node a valid application for Rack. env is the environment hash passed from the Rack::Handler

We rely on correct PATH_INFO.

As defined by the Rack spec, PATH_INFO may be empty if it wants the root of the application, so we insert ‘/’ to make our dispatcher simple.

Innate will not rescue any errors for you or do any error handling, this should be done by an underlying middleware.

We do however log errors at some vital points in order to provide you with feedback in your logs.

A lot of functionality in here relies on the fact that call is executed within Current#call which populates the variables used by Trinity. So if you use the Node directly as a middleware make sure that you #use Innate::Current as a middleware before it.

Parameters:

  • env (Hash)

Returns:

  • (Array)

See Also:

Author:

  • manveru



269
270
271
272
273
274
275
 
# File 'lib/innate/node.rb', line 269

def call(env)
  path = env['PATH_INFO']
  path << '/' if path.empty?

  response.reset
  try_resolve(path).finish
end

#fill_action(action, given_name) ⇒ Action?

Now we’re talking Action, we try to find a matching template and method, if we can’t find either we go to the next pattern, otherwise we answer with an Action with everything we know so far about the demands of the client.

Parameters:

  • given_name (String) —

    the name extracted from REQUEST_PATH

Returns:

See Also:

Author:

  • manveru



423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/innate/node.rb', line 423

def fill_action(action, given_name)
  needs_method = action.options[:needs_method]
  wish = action.wish

  patterns_for(given_name) do |name, params|
    method = find_method(name, params)

    next unless method if needs_method
    next unless method if params.any?
    next unless (view = find_view(name, wish)) || method

    params.map!{|param| Rack::Utils.unescape(param) }

    action.merge!(:method => method, :view => view, :params => params,
                  :layout => find_layout(name, wish))
  end
end

#find_aliased_view(action_name, wish) ⇒ nil, String

Resolve one level of aliasing for the given action_name and wish.

Parameters:

  • action_name (String)
  • wish (String)

Returns:

  • (nil, String) —

    the absolute path to the aliased template or nil

See Also:

  • Node::find_view

Author:

  • manveru



630
631
632
633
634
635
636
637
 
# File 'lib/innate/node.rb', line 630

def find_aliased_view(action_name, wish)
  aliased_name, aliased_node = ancestral_trait[:alias_view][action_name]
  return unless aliased_name

  aliased_node ||= self
  aliased_node.update_view_mappings
  aliased_node.find_view(aliased_name, wish)
end

#find_layout(name, wish) ⇒ Array?

TODO:

allow layouts combined of method and view… hairy :)

Try to find a suitable value for the layout. This may be a template or the name of a method.

If a layout could be found, an Array with two elements is returned, the first indicating the kind of layout (:layout|:view|:method), the second the found value, which may be a String or Symbol.

Parameters:

  • name (String)
  • wish (String)

Returns:

  • (Array, nil)

See Also:

Author:

  • manveru



458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/innate/node.rb', line 458

def find_layout(name, wish)
  return unless layout = ancestral_trait[:layout]
  return unless layout = layout.call(name, wish) if layout.respond_to?(:call)

  if found = to_layout(layout, wish)
    [:layout, found]
  elsif found = find_view(layout, wish)
    [:view, found]
  elsif found = find_method(layout, [])
    [:method, found]
  end
end

#find_method(name, params) ⇒ String, Symbol

TODO:

Once 1.9 is mainstream we can use Method#parameters to do accurate prediction

We check arity if possible, but will happily dispatch to any method that has default parameters. If you don’t want your method to be responsible for messing up a request you should think twice about the arguments you specify due to limitations in Ruby.

So if you want your method to take only one parameter which may have a default value following will work fine:

def index(foo = "bar", *rest)

But following will respond to /arg1/arg2 and then fail due to ArgumentError:

def index(foo = "bar")

Here a glance at how parameters are expressed in arity:

def index(a)                  # => 1
def index(a = :a)             # => -1
def index(a, *r)              # => -2
def index(a = :a, *r)         # => -1

def index(a, b)               # => 2
def index(a, b, *r)           # => -3
def index(a, b = :b)          # => -2
def index(a, b = :b, *r)      # => -2

def index(a = :a, b = :b)     # => -1
def index(a = :a, b = :b, *r) # => -1

Parameters:

  • name (String, Symbol)
  • params (Array)

Returns:

  • (String, Symbol)

See Also:

Author:

  • manveru



512
513
514
515
 
# File 'lib/innate/node.rb', line 512

def find_method(name, params)
  return unless arity = method_arities[name.to_s]
  name if arity == params.size || arity < 0
end

#find_provide(path) ⇒ Array

Resolve possible provides for the given path from #provides.

Parameters:

  • path (String)

Returns:

  • (Array) —

    with name, wish, engine

See Also:

  • Node::provides

Author:

  • manveru



397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/innate/node.rb', line 397

def find_provide(path)
  pr = provides

  name, wish, engine = path, 'html', pr['html_handler']

  pr.find do |key, value|
    key = key[/(.*)_handler$/, 1]
    next unless path =~ /^(.+)\.#{key}$/i
    name, wish, engine = $1, key, value
  end

  return name, wish, engine
end

#find_view(action_name, wish) ⇒ String?

Try to find the best template for the given basename and wish and respect aliased views.

Parameters:

  • action_name (#to_s)
  • wish (#to_s)

Returns:

  • (String, nil) —

    depending whether a template could be found

See Also:

Author:

  • manveru



559
560
561
562
563
564
 
# File 'lib/innate/node.rb', line 559

def find_view(action_name, wish)
  aliased = find_aliased_view(action_name, wish)
  return aliased if aliased

  to_view(action_name, wish)
end

#layout(layout_name = nil, &block) ⇒ Proc, String

Define a layout to use on this Node.

A Node can only have one layout, although the template being chosen can depend on #provides.

Examples:

layout :foo
layout do |name, wish|
  name == 'foo' ? 'dark' : 'bright'
end
layout :foo do |name, wish|
  wish == 'html'
end

Parameters:

  • layout_name (String, #to_s) (defaults to: nil) —

    basename without extension of the layout to use

  • block (Proc, #call) —

    called on every dispatch if no name given

Returns:

  • (Proc, String) —

    The assigned name or block

See Also:

Author:

  • manveru



682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
 
# File 'lib/innate/node.rb', line 682

def layout(layout_name = nil, &block)
  if layout_name and block
    # default name, but still check with block
    trait(:layout => lambda{|name, wish| layout_name.to_s if block.call(name, wish) })
  elsif layout_name
    # name of a method or template
    trait(:layout => layout_name.to_s)
  elsif block
    # call block every request with name and wish, returned value is name
    # of layout template or method
    trait(:layout => block)
  else
    # remove layout for this node
    trait(:layout => nil)
  end

  return ancestral_trait[:layout]
end

#layout_mappings ⇒ Array<String>+

Combine Innate.options.layouts with either the ‘ancestral_trait` or the #mapping if the trait yields an empty Array.

Returns:

  • (Array<String>, Array<Array<String>>)

See Also:

  • Innate::Node.{Node{Node#map_layouts}

Author:

  • manveru



966
967
968
969
970
971
 
# File 'lib/innate/node.rb', line 966

def layout_mappings
  paths = [*ancestral_trait[:layouts]]
  paths = ['/'] if paths.empty?

  [[*options.layouts].flatten, [*paths].flatten]
end

#map(location) ⇒ Object

Shortcut to map or remap this Node.

Examples:

Usage for explicit mapping:


class FooBar
  include Innate::Node
  map '/foo_bar'
end

Innate.to(FooBar) # => '/foo_bar'

Usage for automatic mapping:


class FooBar
  include Innate::Node
  map mapping
end

Innate.to(FooBar) # => '/foo_bar'

Parameters:

  • location (#to_s)

See Also:

  • SingletonMethods::map

Author:

  • manveru



144
145
146
147
 
# File 'lib/innate/node.rb', line 144

def map(location)
  trait :skip_node_map => true
  Innate.map(location, self)
end

#map_layouts(*locations) ⇒ Node

Set the paths for lookup below the Innate.options.layouts paths.

Parameters:

  • locations (String, Array<String>) —

    Any number of strings indicating the paths where layout templates may be located, relative to Innate.options.roots/Innate.options.layouts

Returns:

See Also:

  • Innate::Node.{Node{Node#layout_mappings}

Author:

  • manveru



953
954
955
956
 
# File 'lib/innate/node.rb', line 953

def map_layouts(*locations)
  trait :layouts => locations.flatten.uniq
  self
end

#map_views(*locations) ⇒ Node

Set the paths for lookup below the Innate.options.views paths.

Parameters:

  • locations (String, Array<String>) —

    Any number of strings indicating the paths where view templates may be located, relative to Innate.options.roots/Innate.options.views

Returns:

See Also:

  • Innate::Node.{Node{Node#view_mappings}

Author:

  • manveru



922
923
924
925
 
# File 'lib/innate/node.rb', line 922

def map_views(*locations)
  trait :views => locations.flatten.uniq
  self
end

#mapping ⇒ String

Tries to find the relative url that this Innate::Node is mapped to. If it cannot find one it will instead generate one based on the snake_cased name of itself.

Examples:

Usage:


class FooBar
  include Innate::Node
end
FooBar.mapping # => '/foo_bar'

Returns:

  • (String) —

    the relative path to the node

See Also:

Author:

  • manveru



115
116
117
 
# File 'lib/innate/node.rb', line 115

def mapping
  Innate.to(self)
end

#needs_method? ⇒ true, false

Whether an Action can be built without a method.

The default is to allow actions that use only a view template, but you might want to turn this on, for example if you have partials in your view directories.

Examples:

turning needs_method? on


class Foo
  Innate.node('/')
end

Foo.needs_method? # => true
Foo.trait :needs_method => false
Foo.needs_method? # => false

Returns:

  • (true, false) —

    (false)

See Also:

  • Innate::Node.{Node{Node#fill_action}

Author:

  • manveru



998
999
1000
 
# File 'lib/innate/node.rb', line 998

def needs_method?
  ancestral_trait[:needs_method]
end

#options ⇒ Object 



973
974
975
 
# File 'lib/innate/node.rb', line 973

def options
  Innate.options
end

#patterns_for(path) ⇒ Action

The innate beauty in Nitro, Ramaze, and Innate.

Will yield the name of the action and parameter for the action method in order of significance.

def foo__bar # responds to /foo/bar
def foo(bar) # also responds to /foo/bar

But foo__bar takes precedence because it’s more explicit.

The last fallback will always be the index action with all of the path turned into parameters.

Examples:

yielding possible combinations of action names and params


class Foo; include Innate::Node; map '/'; end

Foo.patterns_for('/'){|action, params| p action => params }
# => {"index"=>[]}

Foo.patterns_for('/foo/bar'){|action, params| p action => params }
# => {"foo__bar"=>[]}
# => {"foo"=>["bar"]}
# => {"index"=>["foo", "bar"]}

Foo.patterns_for('/foo/bar/baz'){|action, params| p action => params }
# => {"foo__bar__baz"=>[]}
# => {"foo__bar"=>["baz"]}
# => {"foo"=>["bar", "baz"]}
# => {"index"=>["foo", "bar", "baz"]}

Parameters:

  • path (String, #split) —

    usually the PATH_INFO

Returns:

  • (Action) —

    it actually returns the first non-nil/false result of yield

See Also:

Author:

  • manveru



739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/innate/node.rb', line 739

def patterns_for(path)
  default_action_name = ancestral_trait[:default_action_name]
  separate_default_action = ancestral_trait[:separate_default_action]

  atoms = path.split('/')
  atoms.delete('')
  result = nil
  atoms.size.downto(0) do |len|
    action_name = atoms[0...len].join('__')

    next if separate_default_action && action_name == default_action_name

    params = atoms[len..-1]

    action_name = default_action_name if action_name.empty? &&
      (separate_default_action || params != [default_action_name])

    return result if result = yield(action_name, params)
  end

  return nil
end

#possible_exts_for(wish) ⇒ Array

Answer with an array of possible extensions in order of significance for the given wish.

Parameters:

  • wish (#to_s) —

    the extension (no leading ‘.’)

Returns:

  • (Array) —

    list of exts valid for this wish

See Also:

Author:

  • manveru



884
885
886
887
888
889
890
 
# File 'lib/innate/node.rb', line 884

def possible_exts_for(wish)
  pr = provides
  return unless engine = pr["#{wish}_handler"]
  View.exts_of(engine).map{|e_ext|
    [[*wish].map{|w_ext| /#{w_ext}\.#{e_ext}$/ }, /#{e_ext}$/]
  }.flatten
end

#possible_paths_for(mappings) ⇒ Array

Answer with an array of possible paths in order of significance for template lookup of the given mappings.

Parameters:

  • mappings (#map) —

    An array two Arrays of inner and outer directories.

Returns:

  • (Array)

See Also:

Author:

  • manveru



867
868
869
870
871
872
 
# File 'lib/innate/node.rb', line 867

def possible_paths_for(mappings)
  root_mappings.map{|root|
    mappings.first.map{|inner|
      mappings.last.map{|outer|
        ::File.join(root, inner, outer, '/') }}}.flatten
end

#provide(format, param = {}, &block) ⇒ Object

TODO:

The comment of this method may be too short for the effects it has on the rest of Innate, if you feel something is missing please let me know.

Note:

If you specify a block when calling this method you’ll have to take care of rendering views and the like yourself. If you merely want to set a extension and content type you can omit the block.

Specify which way contents are provided and processed.

Use this to set a templating engine, custom Content-Type, or pass a block to take over the processing of the Action and template yourself.

Provides set via this method will be inherited into subclasses.

The format is extracted from the PATH_INFO, it simply represents the last extension name in the path.

The provide also has influence on the chosen templates for the Action.

Given a request to ‘/list.rss` the template lookup first tries to find `list.rss.erb`, if that fails it falls back to `list.erb`. If neither of these are available it will try to use the return value of the method in the Action as template.

A request to ‘/list.yaml` would match the format ’yaml’

Examples:

providing RSS with ERB templating


provide :rss, :engine => :ERB

providing a yaml version of actions


class Articles
  include Innate::Node
  map '/article'

  provide(:yaml, :type => 'text/yaml'){|action, value| value.to_yaml }

  def list
    @articles = Article.list
  end
end

providing plain text inspect version


class Articles
  include Innate::Node
  map '/article'

  provide(:txt, :type => 'text/plain'){|action, value| value.inspect }

  def list
    @articles = Article.list
  end
end

Parameters:

  • block (Proc) —

    upon calling the action, [action, value] will be passed to it and its return value becomes the response body.

  • param (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (param):

  • :engine (Symbol String) —

    Name of an engine for View::get

  • :type (String) —

    default Content-Type if none was set in Response

Raises:

  • (ArgumentError) —

    if neither a block nor an engine was given

See Also:

  • Node#provides

Author:

  • manveru



223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/innate/node.rb', line 223

def provide(format, param = {}, &block)
  if param.respond_to?(:to_hash)
    param = param.to_hash
    handler = block || View.get(param[:engine])
    content_type = param[:type]
  else
    handler = View.get(param)
  end

  raise(ArgumentError, "Need an engine or block") unless handler

  trait("#{format}_handler"      => handler, :provide_set => true)
  trait("#{format}_content_type" => content_type) if content_type
end

#provide_set? ⇒ true, false

This will return true if the only provides set are by included.

The reasoning behind this is to determine whether the user has touched the provides at all, in which case we will not override the provides in subclasses.

Returns:

  • (true, false) —

    (false)

See Also:

  • Innate::Node.{Node{Node::included}

Author:

  • manveru



1014
1015
1016
 
# File 'lib/innate/node.rb', line 1014

def provide_set?
  ancestral_trait[:provide_set]
end

#provides ⇒ Object 



238
239
240
 
# File 'lib/innate/node.rb', line 238

def provides
  ancestral_trait.reject{|key, value| key !~ /_handler$/ }
end

#resolve(path, options = {}) ⇒ nil, Action

Let’s get down to business, first check if we got any wishes regarding the representation from the client, otherwise we will assume he wants html.

Parameters:

  • path (String)
  • options (Hash) (defaults to: {})

Returns:

See Also:

  • Node::update_method_arities Node::find_action

Author:

  • manveru



372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/innate/node.rb', line 372

def resolve(path, options = {})
  name, wish, engine = find_provide(path)
  node = (respond_to?(:ancestors) && respond_to?(:new)) ? self : self.class
  action = Action.create(:node => node, :wish => wish, :engine => engine, :path => path, :options => options)
  action.options.key?(:needs_method) || action.options[:needs_method] = node.needs_method?

  if content_type = node.ancestral_trait["#{wish}_content_type"]
    action.options[:content_type] = content_type
  end

  node.update_method_arities
  node.update_template_mappings
  node.fill_action(action, name)
end

#root_mappings ⇒ Array

make sure this is an Array and a new instance so modification on the wrapping array doesn’t affect the original option. [*arr].object_id == arr.object_id if arr is an Array

Returns:

  • (Array) —

    list of root directories

Author:

  • manveru



907
908
909
 
# File 'lib/innate/node.rb', line 907

def root_mappings
  [*options.roots].flatten
end

#to_layout(action_name, wish) ⇒ nil, String

Find the best matching action_name for the layout, if any.

This is mostly an abstract method that you might find handy if you want to do vastly different layout lookup.

Parameters:

  • action_name (String)
  • wish (String)

Returns:

  • (nil, String) —

    the absolute path to the template or nil

See Also:

  • {Node#root_mappings} {Node#layout_mappings}

Author:

  • manveru



652
653
654
655
 
# File 'lib/innate/node.rb', line 652

def to_layout(action_name, wish)
  return unless files = layout_templates[wish.to_s]
  files[action_name.to_s]
end

#to_template(path, wish) ⇒ nil, String

Try to find a template at the given path for wish.

Since Innate supports multiple paths to templates the path has to be an Array that may be nested one level.

Examples:

Usage to find available templates


# This assumes following files:
# view/foo.erb
# view/bar.erb
# view/bar.rss.erb
# view/bar.yaml.erb

class FooBar
  Innate.node('/')
end

FooBar.to_template(['.', 'view', '/', 'foo'], 'html')
# => "./view/foo.erb"
FooBar.to_template(['.', 'view', '/', 'foo'], 'yaml')
# => "./view/foo.erb"
FooBar.to_template(['.', 'view', '/', 'foo'], 'rss')
# => "./view/foo.erb"

FooBar.to_template(['.', 'view', '/', 'bar'], 'html')
# => "./view/bar.erb"
FooBar.to_template(['.', 'view', '/', 'bar'], 'yaml')
# => "./view/bar.yaml.erb"
FooBar.to_template(['.', 'view', '/', 'bar'], 'rss')
# => "./view/bar.rss.erb"

Parameters:

  • path (Array<Array<String>>, Array<String>) —

    array containing strings and nested (1 level) arrays containing strings

  • wish (String)

Returns:

  • (nil, String) —

    relative path to the first template found

See Also:

Author:

  • manveru



802
803
804
 
# File 'lib/innate/node.rb', line 802

def to_template(path, wish)
  to_view(path, wish) || to_layout(path, wish)
end

#to_view(action_name, wish) ⇒ String?

Try to find the best template for the given basename and wish.

This method is mostly here for symetry with #to_layout and to allow you overriding the template lookup easily.

Parameters:

  • action_name (#to_s)
  • wish (#to_s)

Returns:

  • (String, nil) —

    depending whether a template could be found

See Also:

  • {Node#to_template} {Node#root_mappings} {Node#view_mappings} {Node#to_template}

Author:

  • manveru



580
581
582
583
 
# File 'lib/innate/node.rb', line 580

def to_view(action_name, wish)
  return unless files = view_templates[wish.to_s]
  files[action_name.to_s]
end

#try_resolve(path) ⇒ Response

Let’s try to find some valid action for given path. Otherwise we dispatch to #action_missing.

Parameters:

  • path (String) —

    from env

Returns:

See Also:

Author:

  • manveru



287
288
289
290
 
# File 'lib/innate/node.rb', line 287

def try_resolve(path)
  action = ancestral_trait[:action_cache][[self, path]] ||= resolve(path)
  action ? action_found(action) : action_missing(path)
end

#update_layout_mappings ⇒ Object 



820
821
822
823
824
825
826
827
 
# File 'lib/innate/node.rb', line 820

def update_layout_mappings
  if ancestral_trait[:fast_mappings]
    return @layout_templates if @layout_templates
  end

  paths = possible_paths_for(layout_mappings)
  @layout_templates = update_mapping_shared(paths)
end

#update_mapping_shared(paths) ⇒ Object 



829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/innate/node.rb', line 829

def update_mapping_shared(paths)
  mapping = {}
  paths.reject!{|path| !File.directory?(path) }

  provides.each do |wish_key, engine|
    wish = wish_key[/(.*)_handler/, 1]
    exts = possible_exts_for(wish)

    paths.reverse_each do |path|
      Find.find(path) do |file|
        exts.each do |ext|
          next unless file =~ ext

          case file.sub(path, '').gsub('/', '__')
          when /^(.*)\.(.*)\.(.*)$/
            action_name, wish_ext, engine_ext = $1, $2, $3
          when /^(.*)\.(.*)$/
            action_name, wish_ext, engine_ext = $1, wish, $2
          end

          mapping[wish_ext] ||= {}
          mapping[wish_ext][action_name] = file
        end
      end
    end
  end

  return mapping
end

#update_method_arities ⇒ Hash

Answer with a hash, keys are method names, values are method arities.

Note that this will be executed once for every request, once we have settled things down a bit more we can switch to update based on Reloader hooks and update once on startup. However, that may cause problems with dynamically created methods, so let’s play it safe for now.

Examples:


Hi.update_method_arities
# => {'index' => 0, 'foo' => -1, 'bar' => 2}

Returns:

  • (Hash) —

    mapping the name of the methods to their arity

See Also:



533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'lib/innate/node.rb', line 533

def update_method_arities
  @method_arities = {}

  exposed = ancestors & Helper::EXPOSE.to_a
  higher = ancestors.select{|ancestor| ancestor < Innate::Node }

  (higher + exposed).reverse_each do |ancestor|
    ancestor.public_instance_methods(false).each do |im|
      @method_arities[im.to_s] = ancestor.instance_method(im).arity
    end
  end

  @method_arities
end

#update_template_mappings ⇒ Object 



806
807
808
809
 
# File 'lib/innate/node.rb', line 806

def update_template_mappings
  update_view_mappings
  update_layout_mappings
end

#update_view_mappings ⇒ Object 



811
812
813
814
815
816
817
818
 
# File 'lib/innate/node.rb', line 811

def update_view_mappings
  if ancestral_trait[:fast_mappings]
    return @view_templates if @view_templates
  end

  paths = possible_paths_for(view_mappings)
  @view_templates = update_mapping_shared(paths)
end

#view_mappings ⇒ Array<String>+

Combine Innate.options.views with either the ‘ancestral_trait` or the #mapping if the trait yields an empty Array.

Returns:

  • (Array<String>, Array<Array<String>>)

See Also:

  • Innate::Node.{Node{Node#map_views}

Author:

  • manveru



935
936
937
938
939
940
 
# File 'lib/innate/node.rb', line 935

def view_mappings
  paths = [*ancestral_trait[:views]]
  paths = [mapping] if paths.empty?

  [[*options.views].flatten, [*paths].flatten]
end