Module: BootstrapAdminHelper

Defined in:
app/helpers/bootstrap_admin_helper.rb

Instance Method Summary collapse

Instance Method Details

#attributes ⇒ BootstrapAdmin::Attribute Array

Finds the model instance attributes to use for the current action.

First it checks if the bootstrap_admin_config has fields configured for the current action. If so, it uses those, if not, it tries to guess which attributes to use through the model’s “accessible_attributes”

Returns:



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'app/helpers/bootstrap_admin_helper.rb', line 234

def attributes
  return @attributes if @attributes
  model_klass = model_for controller

  fields =  bootstrap_admin_config.send("#{params[:action]}_fields")  ||
            bootstrap_admin_config.send("action_fields")              ||
            model_klass.accessible_attributes.
              reject(&:blank?).
              map{|att| real_attribute_name att }

  @attributes = fields.map do |att|
    BootstrapAdmin::Attribute.new att,
                                  model_klass.human_attribute_name(att),
                                  model_klass.type_of(att)
  end
end

#available_actions ⇒ Object 



128
129
130
 
# File 'app/helpers/bootstrap_admin_helper.rb', line 128

def available_actions
  bootstrap_admin_config.available_actions
end

#bootstrap_form_url(item) ⇒ Object 



145
146
147
148
 
# File 'app/helpers/bootstrap_admin_helper.rb', line 145

def bootstrap_form_url item
  item_name = item.class.name.underscore.gsub("/","_")
  [item, :as => item_name, :url => bootstrap_url_for(:action => (item.new_record? ? :create : :update), :id => item.id)]
end

#bootstrap_url_for(options = {}) ⇒ Object Also known as: bootstrap_url 



133
134
135
136
137
138
139
140
141
142
 
# File 'app/helpers/bootstrap_admin_helper.rb', line 133

def bootstrap_url_for options = {}
  defaults = {:controller => params[:controller]}.merge options

  ctrl_namespace = defaults[:controller].split("/").first
  if instance_eval "defined? #{ctrl_namespace}"
    instance_eval("#{ctrl_namespace}.method :url_for").call defaults
  else
    main_app.url_for(defaults)
  end
end

#collection_for(controller) ⇒ ActiveRecord::Base Array

Returns:

  • (ActiveRecord::Base Array) —

    the model instance collection for the current controller



207
208
209
210
 
# File 'app/helpers/bootstrap_admin_helper.rb', line 207

def collection_for controller
  name = collection_name_for controller
  instance_variable_get "@#{name}"
end

#collection_name_for(controller) ⇒ String

Returns:

  • (String) —

    the model instance collection name for the current controller



220
221
222
 
# File 'app/helpers/bootstrap_admin_helper.rb', line 220

def collection_name_for controller
  controller.class.name.sub("Controller", "").underscore.split('/').last
end

#display_field(item, field, &block) ⇒ Markup

Builds the markup to properly display a field, including label and field value.

If a block is given, then it uses the block as the field “value” else it looks at what the field value is and if it is:

* a boolean, builds a fake checkbox
* an array, builds a ul list with each element of the array
* else, just uses the string value

Examples:

display_field @document, :title
  # <p><b>Title: </b>So Long, and Thanks For All the Fish</p>

display_field @document, :awesome?
  # <p><b>Awesome: </b><span class='checkbox true'><span class='icon'></span></span></p>

display_field @document, :authors
  # <p><b>Authors: </b><ul><li>Douglas Adams</li></ul></p>

display_field @document, :details do
  "#{@document.title} - #{@document.year}"
end
  # <p><b>Title: </b>So Long, and Thanks For All the Fish - 1984</p>

Parameters:

  • item (ActiveRecord::Base) —

    The item record

  • field (Symbol or String) —

    The field to display

  • &block (Block) —

    An optional block that yields markup

Returns:

  • (Markup) —

    the necessary markup to display the field



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'app/helpers/bootstrap_admin_helper.rb', line 77

def display_field item, field, &block
  content_tag :p do
    content_tag(:b) do
      item.class.human_attribute_name(field) + ": "
    end +
    if block_given?
      capture(&block)
    else
      val = render_field item, field
      if val.class.name =~ /(TrueClass|FalseClass)/
        content_tag(:span, :class => "checkbox #{val.to_s}") do
          content_tag(:span, :class=>"icon"){""}
        end
      elsif val.is_a? Array
        content_tag :ul do
          val.map do |uniq_val|
            content_tag(:li, uniq_val.to_s)
          end.join.html_safe
        end
      else
        val.to_s
      end
    end
  end.html_safe
end

#index_actions_for(item) ⇒ Object 



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'app/helpers/bootstrap_admin_helper.rb', line 151

def index_actions_for item
  actions = []

  if available_actions.include? :show
    actions << link_to(:show, bootstrap_url_for(:action => :show, :id => item.id), class: 'btn')
  end

  if available_actions.include? :edit
    actions << link_to(:edit, bootstrap_url_for(:action => :edit, :id => item.id), class: 'btn')
  end

  if available_actions.include? :destroy
    actions << link_to(:destroy, bootstrap_url_for(:action => :show, :id => item.id), confirm: t(:confirm), method: :delete, class: 'btn btn-danger')
  end

  actions.join("\n").html_safe
end

#index_default_actions ⇒ Object 



170
171
172
173
174
175
 
# File 'app/helpers/bootstrap_admin_helper.rb', line 170

def index_default_actions 
  if available_actions.include? :new
    model_klass = model_for controller
    link_to([:new, model_klass], bootstrap_url_for(:action => :new), :class => 'btn btn-primary').html_safe
  end
end

#link_to(*args, &block) ⇒ String

This re-implementation of link_to simply looks at the link label and if it falls under certain conditions, then it tries to create a label and/or url accordingly. Else works normally

Examples:

Assuming locale is set to PT

link_to :Show, @document
  # <a href='/documents/1'>Ver</a>

link_to Document
  # <a href='/documents'>Documentos</a>

link_to [:edit, @document]
  # <a href='/document/1/edit'>Editar Documento</a>

Parameters:

  • *args —

    Same as the original link_to

  • &block —

    Same as the original link_to

Returns:

  • (String) —

    link markup



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'app/helpers/bootstrap_admin_helper.rb', line 22

def link_to(*args, &block)
  super(*args, &block) if block_given?

  # When args[0] is a symbol, then just translate the symbol...
  if args[0].is_a? Symbol
    super(t(args[0]), *args[1..-1])

  # when arg[0] is a ActiveRecord class...
  elsif args[0].is_a?(Class) and args[0] < ActiveRecord::Base
    label = args[0].model_name.human.pluralize
    if args.length == 1
      controller_name = args[0].name.underscore.pluralize
      super(label, url_for(controller: controller_name, action: "index"))
    else
      super(label, *args[1..-1])
    end

  elsif args[0].is_a?(Array) && args[0][0].is_a?(Symbol) && args[0][1] < ActiveRecord::Base
    link_content = t("helpers.submit.#{args[0][0]}", :model => args[0][1].model_name.human)
    super(link_content, *args[1..-1])
  else
    super(*args)
  end
end

#model_for(controller) ⇒ Class

Parameters:

  • controller (ActionController::Base)

Returns:

  • (Class) —

    the model class for the current controller



190
191
192
193
194
195
196
 
# File 'app/helpers/bootstrap_admin_helper.rb', line 190

def model_for controller
  if bootstrap_admin_config.model_name.blank?
    collection_name_for(controller).classify.constantize
  else
    bootstrap_admin_config.model_name.constantize
  end
end

#model_instance_for(controller) ⇒ ActiveRecord::Base

Returns:

  • (ActiveRecord::Base) —

    the model instance based on the controller name



200
201
202
203
 
# File 'app/helpers/bootstrap_admin_helper.rb', line 200

def model_instance_for controller
  name = collection_name_for(controller).singularize
  instance_variable_get "@#{name}"
end

#model_name_for(controller) ⇒ String

Returns:

  • (String) —

    the model instance name for the current controller



214
215
216
 
# File 'app/helpers/bootstrap_admin_helper.rb', line 214

def model_name_for controller
  model_for(controller).model_name.underscore
end

#render_field(item, field) ⇒ Object 



104
105
106
107
108
109
110
111
 
# File 'app/helpers/bootstrap_admin_helper.rb', line 104

def render_field item, field
  if self.respond_to?(helper = "#{params[:action]}_#{field}") ||
     self.respond_to?(helper = "#{field}")
    send helper, item
  else
    item.send field
  end
end

#render_form_field(form, field) ⇒ Object 



114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'app/helpers/bootstrap_admin_helper.rb', line 114

def render_form_field form, field
  if self.respond_to?(helper = "#{params[:action]}_form_#{field.name}") ||
     self.respond_to?(helper = "form_#{field.name}")
    send helper, form

  elsif field.association?
    form.association field.name

  else
    form.input field.name
  end
end

#show_default_actions ⇒ Object 



177
178
179
180
181
182
183
184
 
# File 'app/helpers/bootstrap_admin_helper.rb', line 177

def show_default_actions
  model_instance = model_instance_for controller
  str = if available_actions.include? :edit
    link_to :edit, bootstrap_url_for(:action => :edit, :id => model_instance.id), :class => 'btn'
  end || ""
  str += link_to :back, bootstrap_url, :class => 'btn'
  str.html_safe
end