iab-WhiteLabeling 0.1.1

data/lib/channel_manager.rb

@@ -0,0 +1,147 @@
+# Copyright (c) 2007-2008 Orangery Technology Limited 
+# You can redistribute it and/or modify it under the same terms as Ruby.
+#
+# a session has one brand (e.g. Lexus) and one human language (e.g. English)
+# a session can have many products
+module ChannelManager  
+  def self.debug_default_channel=(value)
+    @@debug_default_channel = value
+  end
+  
+  def set_channel_in_session
+    set_session_data unless params_remain_unchanged
+  end
+  
+  def load_changes_in_channel
+    inject_channel unless channel_already_loaded
+  end
+  
+  #helper used to handle xpath field name translation to human understandable field label/legend
+  #TODO: generate these translation into a separate dictionary
+  def __(key)
+    trans = @dictionary[key]
+    return trans unless trans == nil
+    key
+  end
+  
+  #helper used for human language translation
+  def _(key)
+    if (session[:lang] != "en")
+      trans = @dictionary[key]
+      return trans unless trans == nil
+    end
+    key
+  end
+  
+  private
+  def params_remain_unchanged
+    param_same_as_session?("brand") && param_same_as_session?("product") && param_same_as_session?("lang")
+  end
+  
+  def param_same_as_session?(param)
+    if (session == nil || session[param.to_sym] == nil) then
+      #we don't currently have a variable of name param in session store, so we must be entering for the first time
+      return false
+    elsif (params[param.to_sym] == nil) then
+      #no param variable on the current url so we must stick with what we have in session store
+      return true
+    else
+      return session[param.to_sym] == params[param.to_sym]
+    end
+  end
+  
+  def channel_already_loaded
+    #where no channel has yet been injected the method productName will not be defined
+    return false unless self.respond_to? :productName
+    #where productName method exists, if the product has changed then this method will not return the new product name
+    return (productName('dummy') == session[:product])
+  end
+  
+  def set_session_data
+    #only set/change session variable is there is something on the URL for that variable
+    session[:brand] = params["brand"] unless params["brand"] == nil
+    session[:lang] = params["lang"] unless params["lang"] == nil
+    session[:product] = params["product"] unless params["product"] == nil
+  end
+  
+  def inject_channel
+    if defined?(@@debug_default_channel) && (!session || !session[:brand] || !session[:product] || !session[:lang])
+      product = @@debug_default_channel[:product]
+      brand = @@debug_default_channel[:brand]
+      lang = @@debug_default_channel[:lang]
+    else
+      product = session[:product]
+      brand = session[:brand]
+      lang = session[:lang]
+    end
+
+    productPath = PRODUCT_ROOT.gsub(/%product/,product)
+    brandPath = BRAND_ROOT.gsub(/%brand/,brand)
+
+    unless FileTest.directory?("#{productPath}")
+      puts "#{productPath} channel does not exist!"
+    end
+
+    #introduce graphical assets including stylesheets
+    introduceBrand(brand)    
+    #add human language of choice
+    introduce_dictionary(PRODUCTS_ROOT, lang)  
+    introduce_dictionary(productPath, lang)      
+    introduce_dictionary(brandPath, lang)
+    #enable oil DSL based layout files to be used a rails view definitions
+    prepend_view_path(File.join(productPath, 'DSL', 'layouts' ))
+    prepend_view_path(File.join("#{WIDGET_ROOT4}"))
+    #dynamically sets the flow of the process from the process part of the oil DSL
+    load_controller_actions(product)
+  end
+  
+  def introduceBrand(brand)
+    path = BRAND_ROOT.gsub(/%brand/,brand)
+    open("#{path}/damManifest.rb") {|f| @contents = f.read }
+    
+    #introduce brand information as a ruby module
+    eval(@contents.to_s)
+    
+    #extend the current controller instance with the channel specific ruby module
+    #loaded on the line above
+    eval("self.extend #{brand}Manifest");
+    
+    associateDAMReferences   
+  end
+  
+  def introduce_dictionary(dictionary_folder, lang)
+    dict = "#{dictionary_folder}/dictionary_#{lang}.rb"
+    load_dictionary(dict,lang)
+  end
+  
+  def load_controller_actions(product)
+    if (File.exist?("#{PRODUCT_ROOT.gsub(/%product/,product)}/DSL/processes.oil"))
+      action_methods = Communicator.instance.handle(session,"ProcessDefinition",nil)
+      #extend controller with actions for this product
+      self.class.class_eval("#{action_methods}")
+      #the following method is introduced by the evaluation of the results of the above
+      #call to communicator and injected with the line above
+      wireProcess
+    end
+  end
+  
+  def load_dictionary(dict,lang)
+    if (File.exists?(dict))
+      open(dict) {|f| eval(f.read.to_s) }
+      eval("self.extend Dictionary#{lang}HL")
+
+      # We assume the first dictionary loaded is the master and all subsequent
+      # loads are to be merged into the master
+      @dictionary = dictionary if @dictionary == nil
+      @dictionary.merge!(dictionary) unless @dictionary == nil
+
+      #setup variables used by the UI views
+      associateHLReferences
+    end
+  end
+  
+  def introduce_layout_dictionary(layout)
+    dict = PRODUCT_ROOT.gsub(/%product/,session[:product])+"/DSL/layouts/#{layout}_dictionary_#{session[:lang]}.rb"
+    load_dictionary(dict,session[:lang])
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: iab-WhiteLabeling
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Gary Mawdsley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-31 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.15"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: diff-lcs
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.2
+    version: 
+description: WhiteLabeling is a module that facilitates the separation of UI layers allowing for quick brand and language change
+email: garymawdsley@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/channel_manager.rb
+has_rdoc: true
+homepage: http://github.com/iab/WhiteLabeling
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: WhiteLabeling
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: WhiteLabeling is a module that facilitates the separation of UI layers allowing for quick brand and language change
+test_files: []
+