Class: SmartListing::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/smart_listing/config.rb

Constant Summary collapse

DEFAULT_PAGE_SIZES = 
[10, 20, 50, 100].freeze
DEFAULTS = 
{
  :global_options => {
    :param_names  => {                                      # param names
      :page                         => :page,
      :per_page                     => :per_page,
      :sort                         => :sort,
    },
    :array                          => false,                       # controls whether smart list should be using arrays or AR collections
    :max_count                      => nil,                         # limit number of rows
    :unlimited_per_page             => false,                       # allow infinite page size
    :paginate                       => true,                        # allow pagination
    :memorize_per_page              => false,
    :page_sizes                     => DEFAULT_PAGE_SIZES.dup,      # set available page sizes array
    :kaminari_options               => {:theme => "smart_listing"}, # Kaminari's paginate helper options
    :sort_dirs                      => [nil, "asc", "desc"],        # Default sorting directions cycle of sortables
  },
  :constants => {
    :classes => {
      :main => "smart-listing",
      :editable => "editable",
      :content => "content",
      :loading => "loading",
      :status => "smart-listing-status",
      :item_actions => "actions",
      :new_item_placeholder => "new-item-placeholder",
      :new_item_action => "new-item-action",
      :new_item_button => "btn",
      :hidden => "hidden",
      :autoselect => "autoselect",
      :callback => "callback",
      :pagination_wrapper => "text-center",
      :pagination_container => "pagination",
      :pagination_per_page => "pagination-per-page text-center",
      :inline_editing => "info",
      :no_records => "no-records",
      :limit => "smart-listing-limit",
      :limit_alert => "smart-listing-limit-alert",
      :controls => "smart-listing-controls",
      :controls_reset => "reset",
      :filtering => "filter",
      :filtering_search => "glyphicon-search",
      :filtering_cancel => "glyphicon-remove",
      :filtering_disabled => "disabled",
      :sortable => "sortable",
      :icon_new => "glyphicon glyphicon-plus",
      :icon_edit => "glyphicon glyphicon-pencil",
      :icon_trash => "glyphicon glyphicon-trash",
      :icon_inactive => "glyphicon glyphicon-remove-circle text-muted",
      :icon_show => "glyphicon glyphicon-share-alt",
      :icon_sort_none => "glyphicon glyphicon-resize-vertical",
      :icon_sort_up => "glyphicon glyphicon-chevron-up",
      :icon_sort_down => "glyphicon glyphicon-chevron-down",
      :muted => "text-muted",
    },
    :data_attributes => {
      :main => "smart-listing",
      :controls_initialized => "smart-listing-controls-initialized",
      :confirmation => "confirmation",
      :id => "id",
      :href => "href",
      :callback_href => "callback-href",
      :max_count => "max-count",
      :item_count => "item-count",
      :inline_edit_backup => "smart-listing-edit-backup",
      :params => "params",
      :observed => "observed",
      :autoshow => "autoshow",
      :popover => "slpopover",
    },
    :selectors => {
      :item_action_destroy => "a.destroy",
      :edit_cancel => "button.cancel",
      :row => "tr",
      :head => "thead",
      :filtering_button => "button",
      :filtering_icon => "button span",
      :filtering_input => ".filter input",
      :pagination_count => ".pagination-per-page .count",
    },
    :element_templates => {
      :row => "<tr />",
    }
  }
}.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration.



106
107
108
 
# File 'lib/smart_listing/config.rb', line 106

def initialize
  @options = {}
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(sym, *args, &block) ⇒ Object 



110
111
112
 
# File 'lib/smart_listing/config.rb', line 110

def method_missing(sym, *args, &block)
  @options[sym] = *args
end

Instance Attribute Details

#options ⇒ Object (readonly)

Returns the value of attribute options.



104
105
106
 
# File 'lib/smart_listing/config.rb', line 104

def options
  @options
end

Instance Method Details

#classes(key) ⇒ Object 



123
124
125
 
# File 'lib/smart_listing/config.rb', line 123

def classes key
  @options[:constants].try(:[], :classes).try(:[], key) || DEFAULTS[:constants][:classes][key]
end

#constants(key, value = nil) ⇒ Object 



114
115
116
117
118
119
120
121
 
# File 'lib/smart_listing/config.rb', line 114

def constants key, value = nil
  if value && !value.empty?
    @options[:constants] ||= {}
    @options[:constants][key] ||= {}
    @options[:constants][key].merge!(value)
  end
  @options[:constants].try(:[], key) || DEFAULTS[:constants][key]
end

#data_attributes(key) ⇒ Object 



127
128
129
 
# File 'lib/smart_listing/config.rb', line 127

def data_attributes key
  @options[:constants].try(:[], :data_attributes).try(:[], key) || DEFAULTS[:constants][:data_attributes][key]
end

#dump ⇒ Object 



151
152
153
 
# File 'lib/smart_listing/config.rb', line 151

def dump
  DEFAULTS.deep_merge(@options)
end

#dump_json ⇒ Object 



155
156
157
 
# File 'lib/smart_listing/config.rb', line 155

def dump_json
  dump.to_json
end

#element_templates(key) ⇒ Object 



135
136
137
 
# File 'lib/smart_listing/config.rb', line 135

def element_templates key
  @options[:constants].try(:[], :element_templates).try(:[], key) || DEFAULTS[:constants][:element_templates][key]
end

#global_options(value = nil) ⇒ Object 



139
140
141
142
143
144
145
 
# File 'lib/smart_listing/config.rb', line 139

def global_options value = nil
  if value && !value.empty?
    @options[:global_options] ||= {}
    @options[:global_options].merge!(value)
  end
  !@options[:global_options] ? DEFAULTS[:global_options] : DEFAULTS[:global_options].deep_merge(@options[:global_options])
end

#selectors(key) ⇒ Object 



131
132
133
 
# File 'lib/smart_listing/config.rb', line 131

def selectors key
  @options[:constants].try(:[], :selectors).try(:[], key) || DEFAULTS[:constants][:selectors][key]
end

#to_json ⇒ Object 



147
148
149
 
# File 'lib/smart_listing/config.rb', line 147

def to_json
  @options.to_json
end