Module: RailsAjax

Defined in:
lib/rails-ajax.rb,
lib/rails-ajax/railtie.rb,
lib/rails-ajax/controller.rb,
lib/rails-ajax/rails-ajax.rb,
lib/rails-ajax/url_helper.rb,
lib/rails-ajax/configuration.rb,
lib/rails-ajax/form_tag_helper.rb

Overview

– Copyright © 2012 Muriel Salvan ([email protected]) Licensed under the terms specified in LICENSE file. No warranty is provided. ++

Defined Under Namespace

Modules: Controller, FormTagHelper, UrlHelper Classes: Configuration, Railtie

Constant Summary collapse

@@Configuration =

The configuration

<em>RailsAjax::Configuration</em>

RailsAjax::Configuration.new

Class Method Summary collapse

Class Method Details

.config ⇒ Object

Give access to the configuration

Return

  • RailsAjax::Configuration: The RailsAjax configuration



16
17
18
 
# File 'lib/rails-ajax/rails-ajax.rb', line 16

def self.config
  return @@Configuration
end

.configure(&iProcConfig) ⇒ Object

Configure RailsAjax

Parameters

  • iProcConfig (CodeBlock): Block called that will contain all configuration directives



24
25
26
 
# File 'lib/rails-ajax/rails-ajax.rb', line 24

def self.configure(&iProcConfig)
  @@Configuration.instance_eval(&iProcConfig)
end

.rails_ajaxifiable?(iOptions) ⇒ Boolean

Find if we use rails-ajax for a given set of options applicable to a link

Parameters

  • iOptions (map<Symbol,Object>): The options provided to a link (used in link_to or form_tag)

Result

  • Boolean: Would this link be handled by rails-ajax?

Returns:

  • (Boolean) 


34
35
36
37
38
 
# File 'lib/rails-ajax/rails-ajax.rb', line 34

def self.rails_ajaxifiable?(iOptions)
  return ((iOptions[:use_rails_ajax] != false) and # User has not removed rails-ajax voluntarily
          (iOptions[:target] == nil) and # Open in the same window and
          (!iOptions.has_key?(:remote))) # User has not specified Ajax call itself
end

.root ⇒ Object

Give the root directory of the RailsAjax installation

Return

  • String: RailsAjax root directory



12
13
14
 
# File 'lib/rails-ajax.rb', line 12

def self.root
  return File.expand_path("#{File.dirname(__FILE__)}/..")
end