Class: Exlibris::Aleph::TabHelper
- Inherits:
-
Object
- Object
- Exlibris::Aleph::TabHelper
- Extended by:
- Config::Attributes
- Includes:
- Singleton
- Defined in:
- lib/exlibris/aleph/tab_helper.rb
Overview
Overview
Exlibris::Aleph::TabHelper assumes a mount of Aleph tab files and provides a way to access the various tab settings for patrons, patron_permissions, items, item_permission (both by item status and by item processing status), collections and pickup locations. It also provides convenience methods for common tasks like getting the pickup location for a given combination of item status, item process status and borrower status or getting an item’s web text. To initialize Exlibris::Aleph::TabHelper call Exlibris::Aleph::TabHelper.init in an initializer.
Constant Summary collapse
- @@alephe_tabs =
{ :sub_libraries => :TabSubLibrary }
- @@adm_tabs =
{ :patrons => :PcTabExpFieldExtended, :patron_permissions => :Tab31, :items => :TabWwwItemDesc, :item_permissions_by_item_status => :Tab15ByItemStatus, :item_permissions_by_item_process_status => :Tab15ByItemProcessStatus, :collections => :Tab40, :pickup_locations => :Tab37 }
- @@tabs =
@@alephe_tabs.keys + @@adm_tabs.keys
Instance Attribute Summary collapse
-
#updated_at ⇒ Object
readonly
Returns the value of attribute updated_at.
Class Method Summary collapse
-
.mkdirs ⇒ Object
Make the necessary directories.
-
.refresh_yml ⇒ Object
Refreshes the yml files that are used to parse the tables.
Instance Method Summary collapse
- #adms ⇒ Object
-
#collection_text(params) ⇒ Object
Returns collection text for the given params.
-
#initialize ⇒ TabHelper
constructor
Private initialzize method for the singleton.
-
#item_permissions(params) ⇒ Object
Returns item permissions for the given params.
-
#item_pickup_locations(params) ⇒ Object
Returns an array of pickup locations based on the given params.
-
#item_web_text(params) ⇒ Object
Returns web display text for the given params.
-
#sub_library_adm(code) ⇒ Object
Returns the ADM associated with the given sub library code.
-
#sub_library_text(code) ⇒ Object
Returns the sub library display text for the given sub library code.
Methods included from Config::Attributes
base_url, config, rest_url, tab_path
Constructor Details
#initialize ⇒ TabHelper
Private initialzize method for the singleton.
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 |
# File 'lib/exlibris/aleph/tab_helper.rb', line 56 def initialize raise ArgumentError.new("No tab path was specified.") if self.class.tab_path.nil? raise ArgumentError.new("No yml path was specified.") if self.class.yml_path.nil? raise ArgumentError.new("No refresh time was specified.") if self.class.refresh_time.nil? self.class.refresh_yml @@tabs.each { |tab| # Default to empty hash instance_variable_set("@#{tab}".to_sym, {}) # Define reader w/ refresh self.class.send(:define_method, tab) { refresh if refresh? instance_variable_get("@#{tab}".to_sym) } } refresh end |
Instance Attribute Details
#updated_at ⇒ Object (readonly)
Returns the value of attribute updated_at.
18 19 20 |
# File 'lib/exlibris/aleph/tab_helper.rb', line 18 def updated_at @updated_at end |
Class Method Details
.mkdirs ⇒ Object
Make the necessary directories
48 49 50 51 52 53 |
# File 'lib/exlibris/aleph/tab_helper.rb', line 48 def self.mkdirs FileUtils.mkdir_p File.join(yml_path, "alephe") adms.each do |adm| FileUtils.mkdir_p File.join(yml_path, adm) end end |
.refresh_yml ⇒ Object
Refreshes the yml files that are used to parse the tables.
33 34 35 36 37 38 39 40 41 42 43 44 45 |
# File 'lib/exlibris/aleph/tab_helper.rb', line 33 def self.refresh_yml mkdirs @@alephe_tabs.each do |key, klass| tab = Exlibris::Aleph::TabParser.const_get(klass).new(:aleph_library => "ALEPHE", :aleph_mnt_path => tab_path).to_h File.open( File.join(yml_path, "alephe", "#{key}.yml"), 'w' ) { |out| YAML.dump( tab, out ) } unless tab.empty? end @@adm_tabs.each do |key, klass| adms.each do |adm| tab = Exlibris::Aleph::TabParser.const_get(klass).new(:aleph_library => adm, :aleph_mnt_path => tab_path).to_h File.open( File.join(yml_path, adm, "#{key}.yml"), 'w' ) { |out| YAML.dump( tab, out ) } unless tab.empty? end end end |
Instance Method Details
#adms ⇒ Object
278 279 280 |
# File 'lib/exlibris/aleph/tab_helper.rb', line 278 def adms @adms ||= self.class.adms end |
#collection_text(params) ⇒ Object
Returns collection text for the given params. Available param keys are:
:adm_library_code, :sub_library_code, :collection_code
184 185 186 187 188 189 |
# File 'lib/exlibris/aleph/tab_helper.rb', line 184 def collection_text(params) adm = collections[params[:adm_library_code]] sub = adm[params[:sub_library_code]] unless adm.nil? coll = sub[params[:collection_code]] unless sub.nil? return coll[:text] unless coll.nil? end |
#item_permissions(params) ⇒ Object
Returns item permissions for the given params. Available param keys are:
:adm_library_code, :sub_library_code, :item_status_code, :item_process_status_code
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 |
# File 'lib/exlibris/aleph/tab_helper.rb', line 206 def (params) = {} # Item process statuses take precedent in Aleph, same here. if .empty? and params[:item_process_status_code] = [params[:adm_library_code]] = [params[:sub_library_code]] unless .nil? = [params[:item_process_status_code]] unless .nil? end # If we didn't find anything with the item process status, try the item status if .empty? and params[:item_status_code] = [params[:adm_library_code]] = [params[:sub_library_code]] unless .nil? = [params[:item_status_code]] unless .nil? end rescue => e logger.error(%Q{ Error in #{self.class}. Returning empty item permissions. Parameters: ADM library: #{params[:adm_library_code]} Sub library: #{params[:sub_library_code]} Item status: #{params[:item_status_code]} Item process status: #{params[:item_process_status_code]}}.strip) logger.error("Error: \n\t#{e}") ensure return end |
#item_pickup_locations(params) ⇒ Object
Returns an array of pickup locations based on the given params. Available param keys are:
:adm_library_code, :sub_library_code, :item_status_code,
:item_process_status_code, :bor_status, :availability_status
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 |
# File 'lib/exlibris/aleph/tab_helper.rb', line 89 def item_pickup_locations(params) adm_locations = pickup_locations[params[:adm_library_code]] sub_locations = adm_locations[params[:sub_library_code]] unless adm_locations.nil? # First try the most specific item_locations = sub_locations[params[:item_status_code]] unless sub_locations.nil? item_procesing_locations = item_locations[params[:item_process_status_code]] unless item_locations.nil? borrower_locations = item_procesing_locations[params[:bor_status]] unless item_procesing_locations.nil? availability_locations = item_procesing_locations[params[:bor_status]] unless item_procesing_locations.nil? locations = (borrower_locations.has_key?(params[:availability_status])) ? borrower_locations[:availability_status] : borrower_locations["#"] unless borrower_locations.nil? return locations[:pickup_locations] unless locations.nil? # Wild card item status item_locations, item_procesing_locations, borrower_locations = nil, nil, nil item_locations = sub_locations["##"] unless sub_locations.nil? item_procesing_locations = item_locations[params[:item_process_status_code]] unless item_locations.nil? borrower_locations = item_procesing_locations[params[:bor_status]] unless item_procesing_locations.nil? locations = (borrower_locations.has_key?(params[:availability_status])) ? borrower_locations[:availability_status] : borrower_locations["#"] unless borrower_locations.nil? return locations[:pickup_locations] unless locations.nil? # Wild card item process status item_locations, item_procesing_locations, borrower_locations = nil, nil, nil item_locations = sub_locations[params[:item_status_code]] unless sub_locations.nil? item_procesing_locations = item_locations["##"] unless item_locations.nil? borrower_locations = item_procesing_locations[params[:bor_status]] unless item_procesing_locations.nil? locations = (borrower_locations.has_key?(params[:availability_status])) ? borrower_locations[:availability_status] : borrower_locations["#"] unless borrower_locations.nil? return locations[:pickup_locations] unless locations.nil? # Wild card item status and item process status item_locations, item_procesing_locations, borrower_locations = nil, nil, nil item_locations = sub_locations["##"] unless sub_locations.nil? item_procesing_locations = item_locations["##"] unless item_locations.nil? borrower_locations = item_procesing_locations[params[:bor_status]] unless item_procesing_locations.nil? locations = (borrower_locations.has_key?(params[:availability_status])) ? borrower_locations[:availability_status] : borrower_locations["#"] unless borrower_locations.nil? return locations[:pickup_locations] unless locations.nil? # Wild card patron status item_locations, item_procesing_locations, borrower_locations = nil, nil, nil item_locations = sub_locations[params[:item_status_code]] unless sub_locations.nil? item_procesing_locations = item_locations[params[:item_process_status_code]] unless item_locations.nil? borrower_locations = item_procesing_locations["##"] unless item_procesing_locations.nil? locations = (borrower_locations.has_key?(params[:availability_status])) ? borrower_locations[:availability_status] : borrower_locations["#"] unless borrower_locations.nil? return locations[:pickup_locations] unless locations.nil? # Wild card patron status and item status item_locations, item_procesing_locations, borrower_locations = nil, nil, nil item_locations = sub_locations["##"] unless sub_locations.nil? item_procesing_locations = item_locations[params[:item_process_status_code]] unless item_locations.nil? borrower_locations = item_procesing_locations["##"] unless item_procesing_locations.nil? locations = (borrower_locations.has_key?(params[:availability_status])) ? borrower_locations[:availability_status] : borrower_locations["#"] unless borrower_locations.nil? return locations[:pickup_locations] unless locations.nil? # Wild card patron status and item process status item_locations, item_procesing_locations, borrower_locations = nil, nil, nil item_locations = sub_locations[params[:item_status_code]] unless sub_locations.nil? item_procesing_locations = item_locations["##"] unless item_locations.nil? borrower_locations = item_procesing_locations["##"] unless item_procesing_locations.nil? locations = (borrower_locations.has_key?(params[:availability_status])) ? borrower_locations[:availability_status] : borrower_locations["#"] unless borrower_locations.nil? return locations[:pickup_locations] unless locations.nil? # Wild card everything item_locations, item_procesing_locations, borrower_locations = nil, nil, nil item_locations = sub_locations["##"] unless sub_locations.nil? item_procesing_locations = item_locations["##"] unless item_locations.nil? borrower_locations = item_procesing_locations["##"] unless item_procesing_locations.nil? locations = (borrower_locations.has_key?(params[:availability_status])) ? borrower_locations[:availability_status] : borrower_locations["#"] unless borrower_locations.nil? return locations[:pickup_locations] unless locations.nil? # Set the pickup location to default to the passed in sub library logger.warn( "Warning in #{self.class}. "+ "Pickup locations not found. "+ "Defaulting to Aleph item sub library, #{params[:sub_library_code]}.\n"+ "Additional parameters:\n"+ "\tADM library: #{params[:adm_library_code]}\n"+ "\tSub library: #{params[:sub_library_code]}\n"+ "\tItem status: #{params[:item_status_code]}\n"+ "\tItem process status: #{params[:item_process_status_code]}\n"+ "\tAvailability status: #{params[:availability_status]}\n"+ "\tBorrower status: #{params[:bor_status]}\n" ) return [params[:sub_library_code]] end |
#item_web_text(params) ⇒ Object
Returns web display text for the given params. Available param keys are:
:adm_library_code, :sub_library_code, :item_status_code, :item_process_status_code, :item_status, :item_process_status
194 195 196 197 198 199 200 201 |
# File 'lib/exlibris/aleph/tab_helper.rb', line 194 def item_web_text(params) adm = items[params[:adm_library_code]] item = (adm[params[:item_process_status]].nil?) ? adm[params[:item_status]] : adm[params[:item_process_status]] unless (params[:item_status].nil? and params[:item_process_status].nil?) or adm.nil? = (params) if item.nil? item = adm[[:text]] unless .nil? or adm.nil? return item[:web_text] unless item.nil? return [:text] unless .nil? end |
#sub_library_adm(code) ⇒ Object
Returns the ADM associated with the given sub library code
80 81 82 83 |
# File 'lib/exlibris/aleph/tab_helper.rb', line 80 def sub_library_adm(code) sub_library = @sub_libraries[code] return sub_library[:library] unless sub_library.nil? end |
#sub_library_text(code) ⇒ Object
Returns the sub library display text for the given sub library code
74 75 76 77 |
# File 'lib/exlibris/aleph/tab_helper.rb', line 74 def sub_library_text(code) sub_library = @sub_libraries[code] return sub_library[:text] unless sub_library.nil? end |