Module: CmAdmin::Models::DslMethod

Extended by:
ActiveSupport::Concern
Included in:
CmAdmin::Model
Defined in:
lib/cm_admin/models/dsl_method.rb

Instance Method Summary collapse

Instance Method Details

#all_db_columns(options = {}) ⇒ Object 



88
89
90
91
92
93
94
95
96
97
 
# File 'lib/cm_admin/models/dsl_method.rb', line 88

def all_db_columns(options={})
  field_names = self.instance_variable_get(:@ar_model)&.columns&.map{|x| x.name.to_sym}
  if options.include?(:exclude) && field_names
    excluded_fields = (Array.new << options[:exclude]).flatten.map(&:to_sym)
    field_names -= excluded_fields
  end
  field_names.each do |field_name|
    column field_name
  end
end

#cm_edit(page_title: nil, page_description: nil, partial: nil, &block) ⇒ Object 



18
19
20
21
22
 
# File 'lib/cm_admin/models/dsl_method.rb', line 18

def cm_edit(page_title: nil,page_description: nil, partial: nil, &block)
  @current_action = CmAdmin::Models::Action.find_by(self, name: 'edit')
  @current_action.set_values(page_title, page_description, partial)
  yield
end

#cm_index(page_title: nil, page_description: nil, partial: nil, &block) ⇒ Object 



6
7
8
9
10
 
# File 'lib/cm_admin/models/dsl_method.rb', line 6

def cm_index(page_title: nil, page_description: nil, partial: nil, &block)
  @current_action = CmAdmin::Models::Action.find_by(self, name: 'index')
  @current_action.set_values(page_title, page_description, partial)
  yield
end

#cm_new(page_title: nil, page_description: nil, partial: nil, &block) ⇒ Object 



24
25
26
27
28
 
# File 'lib/cm_admin/models/dsl_method.rb', line 24

def cm_new(page_title: nil,page_description: nil, partial: nil, &block)
  @current_action = CmAdmin::Models::Action.find_by(self, name: 'new')
  @current_action.set_values(page_title, page_description, partial)
  yield
end

#cm_show(page_title: nil, page_description: nil, partial: nil, &block) ⇒ Object 



12
13
14
15
16
 
# File 'lib/cm_admin/models/dsl_method.rb', line 12

def cm_show(page_title: nil, page_description: nil, partial: nil, &block)
  @current_action = CmAdmin::Models::Action.find_by(self, name: 'show')
  @current_action.set_values(page_title, page_description, partial)
  yield
end

#cm_show_section(section_name, display_if: nil, &block) ⇒ Object 



57
58
59
60
 
# File 'lib/cm_admin/models/dsl_method.rb', line 57

def cm_show_section(section_name, display_if: nil, &block)
  @available_fields[@current_action.name.to_sym] ||= []
  @available_fields[@current_action.name.to_sym] << CmAdmin::Models::CmShowSection.new(section_name, display_if, &block)
end

#column(field_name, options = {}) ⇒ Object 



77
78
79
80
81
82
83
84
85
86
 
# File 'lib/cm_admin/models/dsl_method.rb', line 77

def column(field_name, options={})
  @available_fields[@current_action.name.to_sym] ||= []
  if @available_fields[@current_action.name.to_sym].select{|x| x.lockable}.size > 0 && options[:lockable]
    raise "Only one column can be locked in a table."
  end

  unless @available_fields[@current_action.name.to_sym].map{|x| x.field_name.to_sym}.include?(field_name)
    @available_fields[@current_action.name.to_sym] << CmAdmin::Models::Column.new(field_name, options)
  end
end

#custom_action(name: nil, verb: nil, layout: nil, layout_type: nil, partial: nil, path: nil, display_type: nil, display_if: lambda { |arg| return true }, route_type: nil, icon_name: 'fa fa-th-large', &block) ⇒ Object

Custom actions eg class User < ApplicationRecord

cm_admin do
  custom_action name: 'submit', verb: 'post', path: ':id/submit' do
    def user_submit
      Code for action here...
    end
  end
end

end



110
111
112
113
114
115
116
117
 
# File 'lib/cm_admin/models/dsl_method.rb', line 110

def custom_action(name: nil, verb: nil, layout: nil, layout_type: nil, partial: nil, path: nil, display_type: nil, display_if: lambda { |arg| return true }, route_type: nil, icon_name: 'fa fa-th-large', &block)
  action = CmAdmin::Models::CustomAction.new(
              name: name, verb: verb, layout: layout, layout_type: layout_type, partial: partial, path: path,
              parent: self.current_action.name, display_type: display_type, display_if: display_if,
              action_type: :custom, route_type: route_type, icon_name: icon_name, &block)
  @available_actions << action
  # self.class.class_eval(&block)
end

#filter(db_column_name, filter_type, options = {}) ⇒ Object 



119
120
121
 
# File 'lib/cm_admin/models/dsl_method.rb', line 119

def filter(db_column_name, filter_type, options={})
  @filters << CmAdmin::Models::Filter.new(db_column_name: db_column_name, filter_type: filter_type, options: options)
end

#form_field(field_name, options = {}, arg = nil) ⇒ Object 



62
63
64
65
66
67
68
69
 
# File 'lib/cm_admin/models/dsl_method.rb', line 62

def form_field(field_name, options={}, arg=nil)
  unless @current_action.is_nested_field
    @available_fields[@current_action.name.to_sym][:fields] << CmAdmin::Models::FormField.new(field_name, options[:input_type], options)
  else
    @available_fields[@current_action.name.to_sym][@current_action.nested_table_name] ||= []
    @available_fields[@current_action.name.to_sym][@current_action.nested_table_name] << CmAdmin::Models::FormField.new(field_name, options[:input_type], options)
  end
end

#nested_form_field(field_name, &block) ⇒ Object 



71
72
73
74
75
 
# File 'lib/cm_admin/models/dsl_method.rb', line 71

def nested_form_field(field_name, &block)
  @current_action.is_nested_field = true
  @current_action.nested_table_name = field_name
  yield
end

#page_description(description) ⇒ Object 



36
37
38
39
40
 
# File 'lib/cm_admin/models/dsl_method.rb', line 36

def page_description(description)
  if @current_action
    @current_action.page_description = description
  end
end

#page_title(title) ⇒ Object 



30
31
32
33
34
 
# File 'lib/cm_admin/models/dsl_method.rb', line 30

def page_title(title)
  if @current_action
    @current_action.page_title = title
  end
end

#sort_column(column = :created_at) ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/cm_admin/models/dsl_method.rb', line 129

def sort_column(column = :created_at)
  model = if @current_action.child_records
    CmAdmin::Model.find_by(name: @current_action.child_records.to_s.classify)
  else
    self
  end
  db_columns = model.instance_variable_get(:@ar_model)&.columns&.map{|x| x.name.to_sym}
  raise "Sorting for custom column #{column} does not exist." unless db_columns.include?(column.to_sym)

  @current_action.sort_column = column.to_sym if @current_action
end

#sort_direction(direction = :desc) ⇒ Object

Raises:

  • (ArgumentError) 


123
124
125
126
127
 
# File 'lib/cm_admin/models/dsl_method.rb', line 123

def sort_direction(direction = :desc)
  raise ArgumentError, "Select a valid sort direction like #{CmAdmin::Models::Action::VALID_SORT_DIRECTION.join(' or ')} instead of #{direction}" unless CmAdmin::Models::Action::VALID_SORT_DIRECTION.include?(direction.to_sym.downcase)

  @current_action.sort_direction = direction.to_sym if @current_action
end

#tab(tab_name, custom_action, associated_model: nil, layout_type: nil, layout: nil, partial: nil, display_if: nil, &block) ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/cm_admin/models/dsl_method.rb', line 42

def tab(tab_name, custom_action, associated_model: nil, layout_type: nil, layout: nil, partial: nil, display_if: nil, &block)
  if custom_action.to_s == ''
    @current_action = CmAdmin::Models::Action.find_by(self, name: 'show')
    @available_tabs << CmAdmin::Models::Tab.new(tab_name, '', display_if, &block)
  else
    action = CmAdmin::Models::Action.new(name: custom_action.to_s, verb: :get, path: ':id/'+custom_action,
                layout_type: layout_type, layout: layout, partial: partial, child_records: associated_model,
                action_type: :custom, display_type: :page)
    @available_actions << action
    @current_action = action
    @available_tabs << CmAdmin::Models::Tab.new(tab_name, custom_action, display_if, &block)
  end
  yield if block
end