Skip to content

Commit

Permalink
Re-add deprecated url helpers with appropriate deprecation warnings t…
Browse files Browse the repository at this point in the history
…o use search_state instead
  • Loading branch information
cbeer committed Nov 7, 2015
1 parent 3c79414 commit 3843a3a
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 0 deletions.
58 changes: 58 additions & 0 deletions app/helpers/blacklight/deprecated_url_helper_behavior.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
module Blacklight
module DeprecatedUrlHelperBehavior
extend Deprecation
self.deprecation_horizon = 'blacklight 7.x'

def params_for_search(*args, &block)
source_params, params_to_merge = case args.length
when 0
search_state.params_for_search
when 1
search_state.params_for_search(args.first)
when 2
Deprecation.warn(Blacklight::DeprecatedUrlHelperBehavior, 'Use Blacklight::SearchState.new(source_params).params_for_search instead')
Blacklight::SearchState.new(args.first, blacklight_config).params_for_search(args.last)
else
raise ArgumentError.new "wrong number of arguments (#{args.length} for 0..2)"
end
end
deprecation_deprecate :params_for_search

def sanitize_search_params(source_params)
Blacklight::Parameters.sanitize(source_params)
end
deprecation_deprecate :sanitize_search_params

def reset_search_params(source_params)
Blacklight::SearchState.new(source_params, blacklight_config).send(:reset_search_params)
end
deprecation_deprecate :reset_search_params

def add_facet_params(field, item, source_params = nil)
if source_params
Deprecation.warn(Blacklight::DeprecatedUrlHelperBehavior, 'Use Blacklight::SearchState.new(source_params).add_facet_params instead')

Blacklight::SearchState.new(source_params, blacklight_config).add_facet_params(field, item)
else
search_state.add_facet_params(field, item)
end
end
deprecation_deprecate :add_facet_params

def remove_facet_params(field, item, source_params = nil)
if source_params
Deprecation.warn(Blacklight::DeprecatedUrlHelperBehavior, 'Use Blacklight::SearchState.new(source_params).remove_facet_params instead')

Blacklight::SearchState.new(source_params, blacklight_config).remove_facet_params(field, item)
else
search_state.remove_facet_params(field, item)
end
end
deprecation_deprecate :remove_facet_params

def add_facet_params_and_redirect(field, item)
search_state.add_facet_params_and_redirect(field, item)
end
deprecation_deprecate :add_facet_params_and_redirect
end
end
2 changes: 2 additions & 0 deletions app/helpers/blacklight/url_helper_behavior.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
##
# URL helper methods
module Blacklight::UrlHelperBehavior
include Blacklight::DeprecatedUrlHelperBehavior

##
# Extension point for downstream applications
# to provide more interesting routing to
Expand Down

0 comments on commit 3843a3a

Please sign in to comment.