Code comments and formatting
This commit is contained in:
Jon Atack
parent
83c8569ab3
commit
192058e969
|
|
@ -4,7 +4,7 @@ module Ransack
|
|||
|
||||
# +search_form_for+
|
||||
#
|
||||
# Example: <%= search_form_for(@q) do |f| %>
|
||||
# <%= search_form_for(@q) do |f| %>
|
||||
#
|
||||
def search_form_for(record, options = {}, &proc)
|
||||
if record.is_a? Ransack::Search
|
||||
|
|
@ -41,7 +41,7 @@ module Ransack
|
|||
|
||||
# +sort_link+
|
||||
#
|
||||
# Example: <%= sort_link(@q, :name, [:name, 'kind ASC'], 'Player Name') %>
|
||||
# <%= sort_link(@q, :name, [:name, 'kind ASC'], 'Player Name') %>
|
||||
#
|
||||
def sort_link(search, attribute, *args)
|
||||
@search_object, routing_proxy = extract_search_obj_and_routing(search)
|
||||
|
|
@ -53,156 +53,154 @@ module Ransack
|
|||
|
||||
private
|
||||
|
||||
# +sort_link+ mutations and order-dependent code are centralized here.
|
||||
# Ivars are not mutated outside of this method.
|
||||
# `args` are mutated in the `mutate_args!` method.
|
||||
#
|
||||
def initialize_sort_link_ivars(search, attribute, args)
|
||||
@field_name = attribute.to_s
|
||||
@current_dir = existing_sort_direction
|
||||
# begin order-dependent assignments
|
||||
sort_fields = extract_sort_fields_and_mutate_args!(args)
|
||||
@label_text = extract_label_text_and_mutate_args!(args)
|
||||
@options = extract_options_and_mutate_args!(args)
|
||||
@hide_indicator = @options.delete :hide_indicator
|
||||
@default_order = @options.delete :default_order
|
||||
if Hash === @default_order
|
||||
@default_order = @default_order.with_indifferent_access
|
||||
end
|
||||
@sort_params = initialize_sort_params(sort_fields)
|
||||
@sort_params = @sort_params.first if @sort_params.size == 1
|
||||
# end order-dependent assignments
|
||||
# `initialize_sort_link_ivars` centralizes the +sort_link+ value
|
||||
# mutations and order-dependent code. No ivars are mutated outside of
|
||||
# this method. `args` are mutated in the `mutate_args!` methods.
|
||||
def initialize_sort_link_ivars(search, attribute, args)
|
||||
@field_name = attribute.to_s
|
||||
@current_dir = existing_sort_direction
|
||||
# begin order-dependent assignments
|
||||
sort_fields = extract_sort_fields_and_mutate_args!(args)
|
||||
@label_text = extract_label_text_and_mutate_args!(args)
|
||||
@options = extract_options_and_mutate_args!(args)
|
||||
@hide_indicator = @options.delete :hide_indicator
|
||||
@default_order = @options.delete :default_order
|
||||
if Hash === @default_order
|
||||
@default_order = @default_order.with_indifferent_access
|
||||
end
|
||||
@sort_params = initialize_sort_params(sort_fields)
|
||||
@sort_params = @sort_params.first if @sort_params.size == 1
|
||||
# end order-dependent assignments
|
||||
end
|
||||
|
||||
def extract_search_obj_and_routing(search)
|
||||
if search.is_a? Array
|
||||
[search.second, search.first]
|
||||
else
|
||||
[search, nil]
|
||||
end
|
||||
def extract_search_obj_and_routing(search)
|
||||
if search.is_a? Array
|
||||
[search.second, search.first]
|
||||
else
|
||||
[search, nil]
|
||||
end
|
||||
end
|
||||
|
||||
def extract_sort_fields_and_mutate_args!(args)
|
||||
if args.first.is_a? Array
|
||||
args.shift
|
||||
else
|
||||
[@field_name]
|
||||
end
|
||||
def extract_sort_fields_and_mutate_args!(args)
|
||||
if args.first.is_a? Array
|
||||
args.shift
|
||||
else
|
||||
[@field_name]
|
||||
end
|
||||
end
|
||||
|
||||
def extract_label_text_and_mutate_args!(args)
|
||||
if args.first.is_a? String
|
||||
args.shift
|
||||
else
|
||||
Translate.attribute(@field_name, :context => @search_object.context)
|
||||
end
|
||||
def extract_label_text_and_mutate_args!(args)
|
||||
if args.first.is_a? String
|
||||
args.shift
|
||||
else
|
||||
Translate.attribute(@field_name, :context => @search_object.context)
|
||||
end
|
||||
end
|
||||
|
||||
def extract_options_and_mutate_args!(args)
|
||||
if args.first.is_a? Hash
|
||||
args.shift
|
||||
else
|
||||
{}
|
||||
end
|
||||
def extract_options_and_mutate_args!(args)
|
||||
if args.first.is_a? Hash
|
||||
args.shift
|
||||
else
|
||||
{}
|
||||
end
|
||||
end
|
||||
|
||||
def name
|
||||
[ERB::Util.h(@label_text), order_indicator]
|
||||
.compact.join(Constants::NON_BREAKING_SPACE).html_safe
|
||||
def name
|
||||
[ERB::Util.h(@label_text), order_indicator]
|
||||
.compact.join(Constants::NON_BREAKING_SPACE).html_safe
|
||||
end
|
||||
|
||||
def url(routing_proxy)
|
||||
if routing_proxy && respond_to?(routing_proxy)
|
||||
send(routing_proxy).url_for(options_for_url)
|
||||
else
|
||||
url_for(options_for_url)
|
||||
end
|
||||
end
|
||||
|
||||
def url(routing_proxy)
|
||||
if routing_proxy && respond_to?(routing_proxy)
|
||||
send(routing_proxy).url_for(options_for_url)
|
||||
else
|
||||
url_for(options_for_url)
|
||||
end
|
||||
end
|
||||
|
||||
def options_for_url
|
||||
params.merge(
|
||||
@options.merge(
|
||||
@search_object.context.search_key => search_and_sort_params
|
||||
)
|
||||
def options_for_url
|
||||
params.merge(
|
||||
@options.merge(
|
||||
@search_object.context.search_key => search_and_sort_params
|
||||
)
|
||||
end
|
||||
)
|
||||
end
|
||||
|
||||
def search_and_sort_params
|
||||
search_params.merge(:s => @sort_params)
|
||||
end
|
||||
def search_and_sort_params
|
||||
search_params.merge(:s => @sort_params)
|
||||
end
|
||||
|
||||
def search_params
|
||||
params[@search_object.context.search_key].presence ||
|
||||
{}.with_indifferent_access
|
||||
end
|
||||
def search_params
|
||||
params[@search_object.context.search_key].presence ||
|
||||
{}.with_indifferent_access
|
||||
end
|
||||
|
||||
def html_options(args)
|
||||
html_options = extract_options_and_mutate_args!(args)
|
||||
html_options.merge(class: [css, html_options[:class]]
|
||||
.compact.join(Constants::SPACE))
|
||||
end
|
||||
def html_options(args)
|
||||
html_options = extract_options_and_mutate_args!(args)
|
||||
html_options.merge(class: [css, html_options[:class]]
|
||||
.compact.join(Constants::SPACE))
|
||||
end
|
||||
|
||||
def css
|
||||
[Constants::SORT_LINK, @current_dir].compact.join(Constants::SPACE)
|
||||
end
|
||||
def css
|
||||
[Constants::SORT_LINK, @current_dir].compact.join(Constants::SPACE)
|
||||
end
|
||||
|
||||
def initialize_sort_params(sort_fields)
|
||||
sort_fields.each_with_object([]) do |field, a|
|
||||
attr_name, new_dir = field.to_s.split(/\s+/)
|
||||
if no_sort_direction_specified?(new_dir)
|
||||
new_dir = detect_previous_sort_direction_and_invert_it(attr_name)
|
||||
end
|
||||
a << "#{attr_name} #{new_dir}"
|
||||
def initialize_sort_params(sort_fields)
|
||||
sort_fields.each_with_object([]) do |field, a|
|
||||
attr_name, new_dir = field.to_s.split(/\s+/)
|
||||
if no_sort_direction_specified?(new_dir)
|
||||
new_dir = detect_previous_sort_direction_and_invert_it(attr_name)
|
||||
end
|
||||
a << "#{attr_name} #{new_dir}"
|
||||
end
|
||||
end
|
||||
|
||||
def detect_previous_sort_direction_and_invert_it(attr_name)
|
||||
sort_dir = existing_sort_direction(attr_name)
|
||||
if sort_dir
|
||||
direction_text(sort_dir)
|
||||
else
|
||||
default_sort_order(attr_name) || Constants::ASC
|
||||
end
|
||||
def detect_previous_sort_direction_and_invert_it(attr_name)
|
||||
sort_dir = existing_sort_direction(attr_name)
|
||||
if sort_dir
|
||||
direction_text(sort_dir)
|
||||
else
|
||||
default_sort_order(attr_name) || Constants::ASC
|
||||
end
|
||||
end
|
||||
|
||||
def existing_sort_direction(attr_name = @field_name)
|
||||
if sort = @search_object.sorts.detect { |s| s.name == attr_name }
|
||||
sort.dir
|
||||
end
|
||||
def existing_sort_direction(attr_name = @field_name)
|
||||
if sort = @search_object.sorts.detect { |s| s.name == attr_name }
|
||||
sort.dir
|
||||
end
|
||||
end
|
||||
|
||||
def default_sort_order(attr_name)
|
||||
Hash === @default_order ? @default_order[attr_name] : @default_order
|
||||
def default_sort_order(attr_name)
|
||||
Hash === @default_order ? @default_order[attr_name] : @default_order
|
||||
end
|
||||
|
||||
def order_indicator
|
||||
if @hide_indicator || no_sort_direction_specified?
|
||||
nil
|
||||
else
|
||||
direction_arrow
|
||||
end
|
||||
end
|
||||
|
||||
def order_indicator
|
||||
if @hide_indicator || no_sort_direction_specified?
|
||||
nil
|
||||
else
|
||||
direction_arrow
|
||||
end
|
||||
def no_sort_direction_specified?(dir = @current_dir)
|
||||
Constants::ASC_DESC.none? { |d| d == dir }
|
||||
end
|
||||
|
||||
def direction_arrow
|
||||
if @current_dir == Constants::DESC
|
||||
Constants::DESC_ARROW
|
||||
else
|
||||
Constants::ASC_ARROW
|
||||
end
|
||||
end
|
||||
|
||||
def no_sort_direction_specified?(dir = @current_dir)
|
||||
Constants::ASC_DESC.none? { |d| d == dir }
|
||||
def direction_text(dir)
|
||||
if dir == Constants::DESC
|
||||
Constants::ASC
|
||||
else
|
||||
Constants::DESC
|
||||
end
|
||||
|
||||
def direction_arrow
|
||||
if @current_dir == Constants::DESC
|
||||
Constants::DESC_ARROW
|
||||
else
|
||||
Constants::ASC_ARROW
|
||||
end
|
||||
end
|
||||
|
||||
def direction_text(dir)
|
||||
if dir == Constants::DESC
|
||||
Constants::ASC
|
||||
else
|
||||
Constants::DESC
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
|
|
|||
Loading…
Reference in New Issue