This module provides methods for setting more complex configuration options. It is mixed into Webgen::Configuration so that its methods can be used. Detailed information on the use of the methods can be found in the "User Manual" in the "Configuration File" section.
All public methods defined in this module are available for direct use in the configuration file, e.g. the method named default_meta_info can be used like this:
default_meta_info: Webgen::SourceHandler::Page: in_menu : true :action : replace
All methods have to take exactly one argument, a Hash.
The special key :action should be used for specifying how the configuration option should be set:
Replace the configuration option with the new values.
Replace old values with new values and add missing ones (useful for hashes and normally the default value)
Set the default meta information for source handlers.
# File lib/webgen/configuration.rb, line 63 def default_meta_info(args) args.each do |sh_name, mi| raise ArgumentError, 'Invalid argument for configuration helper default_meta_info' unless mi.kind_of?(Hash) action = mi.delete(:action) || 'modify' mi_hash = (self['sourcehandler.default_meta_info'][complete_source_handler_name(sh_name)] ||= {}) case action when 'replace' then mi_hash.replace(mi) else mi_hash.update(mi) end end end
Set the default processing pipeline for a source handler.
# File lib/webgen/configuration.rb, line 93 def default_processing_pipeline(args) args.each do |sh_name, pipeline| raise ArgumentError, 'Invalid argument for configuration helper pipeline' unless pipeline.kind_of?(String) mi_hash = (self['sourcehandler.default_meta_info'][complete_source_handler_name(sh_name)] ||= {}) ((mi_hash['blocks'] ||= {})['default'] ||= {})['pipeline'] = pipeline end end
Set the path patterns used by source handlers.
# File lib/webgen/configuration.rb, line 77 def patterns(args) args.each do |sh_name, data| pattern_arr = (self['sourcehandler.patterns'][complete_source_handler_name(sh_name)] ||= []) case data when Array then pattern_arr.replace(data) when Hash (data['del'] || []).each {|pat| pattern_arr.delete(pat)} (data['add'] || []).each {|pat| pattern_arr << pat} else raise ArgumentError, 'Invalid argument for configuration helper patterns' end end end
Complete sh_name by checking if a source handler called Webgen::SourceHandler::SH_NAME exists.
# File lib/webgen/configuration.rb, line 104 def complete_source_handler_name(sh_name) (Webgen::SourceHandler.constants.map {|c| c.to_s}.include?(sh_name) ? 'Webgen::SourceHandler::' + sh_name : sh_name) end
Generated with the Darkfish Rdoc Generator 2.