wixgem 0.110.0 → 0.112.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10e61c62d03979266feff1ade5dcef49603123b87b8fa6e6103466783c9ef203
-  data.tar.gz: 3ceb485b6e95b995d43d09e53fa89738a533d70ac1b3bec2d5390f8c3b5954ea
+  metadata.gz: d4723f8b26548ee609b1bfaee5351907307088a980711b19f303de6d022e2492
+  data.tar.gz: 71863140ca3dccf4e34edc6c19ce262cd2c3d20f1ed5076f9c3fc07c9f5281d2
 SHA512:
-  metadata.gz: 36d3b66c9e9a27ab5850bbc429a3f8e6148915bf9df77a612dbc797cc01ee872fccdc4f942a6c75b8eeb368713e32ecdf09bdd54f73a1027ff993d0e59f5e4dc
-  data.tar.gz: ece434c79d788ee69e20df13ce90cf31d7224db1c7fab0ad66381de28e3210125efb7ba50965965b5f8e00f18bc91273f0f26b508da2009ba1c1ceb1aabaa96d
+  metadata.gz: f6b4f238ed0b62c2548f4bf8b8e91510aa5dd940c15555f516026a5b0f48fdf9da89ae67a3749cca041b922f872fdcb9295454ef3a65dd69c1cafde1c2d44f9a
+  data.tar.gz: 6799fa78437b6ff969bef1685045984884ba1564ca5f056c798cd92eee595e75c31cec3674dd96571611ca4e1f7316e18d5a8e4706cfe8ce4ac88dcefeda7138

data/lib/custom_action.rb

@@ -48,8 +48,8 @@ class CustomAction
 	    action.attributes['FileKey'] = file_key
 	  end
 
-		action.attributes['Directory'] = custom_action[:directory] if(custom_action.key?(:directory))
-  	action.attributes['ExeCommand'] = custom_action[:exe_command] if(custom_action.key?(:exe_command))
+	  action.attributes['Directory'] = custom_action[:directory] if(custom_action.key?(:directory))
+  	  action.attributes['ExeCommand'] = custom_action[:exe_command] if(custom_action.key?(:exe_command))
 	  action.attributes['DllEntry'] = custom_action[:dll_entry] if(custom_action.key?(:dll_entry))
 
 	  if(custom_action.key?(:property))

data/lib/file.rb

@@ -2,7 +2,7 @@ require 'win32ole'
 
 class File
   def self.read_only?(path)
-    raise "'#{path}' does not exist" unless(File.exists?(path))
+    raise "'#{path}' does not exist" unless(File.exist?(path))
 	
 	  fso = WIN32OLE.new('Scripting.FileSystemObject')
     raise 'Failed to create Scripting.FileSystemObject' if(fso.nil?)

data/lib/registry_key.rb

@@ -1,81 +1,42 @@
-require 'rexml/document'
-require 'SecureRandom'
+##require 'rexml/document'
+#require 'SecureRandom'
 
-module Wixgem
+#module Wixgem
 
-class CustomAction
+# https://support.firegiant.com/hc/en-us/articles/230912127-RegistryKey-and-RegistryValue-elements
+class RegistryKey
   def initialize(xml_doc, input)
     @xml_doc = xml_doc
     @input = input
   end
-  def add(custom_action)
-    unless(custom_action.key?(:file) || custom_action.key?(:binary_key) || custom_action.key?(:property) || custom_action.key?(:directory))
-      raise 'Currently, only supported custom actions work with installed executable, binary key, property, or directory' 
-	  end
-	
-	  file_key=nil
-	  if(custom_action.key?(:file))
-      install_path = ".\\#{custom_action[:file].gsub(/\//,'\\')}"
-	    file_elements = REXML::XPath.match(@xml_doc, "//File[@Source='#{install_path}']")
-	    raise "Unable to locate installation file '#{custom_action[:file]} for custom action'" if(file_elements.nil? || (file_elements.size == 0))
-	
-	    file_key = file_elements[0].attributes['Id']
-	  end
-	
-	  id = "ca_#{SecureRandom.uuid.gsub(/-/,'')}"
-	  id = custom_action[:id] if(custom_action.key?(:id))
-		
-	  impersonate = 'yes'
-	  impersonate = custom_action[:impersonate] if(custom_action.key?(:impersonate))
-	
-	  condition='NOT Installed AND NOT REMOVE'
-	  condition='1' if(custom_action.key?(:binary_key))
-	  condition = custom_action[:condition] if(custom_action.key?(:condition))
-	
-	  execute='deferred'
-	  execute = custom_action[:execute] if(custom_action.key?(:execute))
-	
-	  ret='check'
-	  ret = custom_action[:return] if(custom_action.key?(:return))
-	
-	  wix_element = REXML::XPath.match(@xml_doc, "/Wix")[0]
-	  fragment = wix_element.add_element 'Fragment'
-	
-	  action = fragment.add_element 'CustomAction', { 'Id' => id, 'Impersonate' => impersonate, 'Return' => ret, 'HideTarget' => 'no', 'Execute' => execute }
-	  if(custom_action.key?(:binary_key))
-	    action.attributes['BinaryKey'] = custom_action[:binary_key]
-	  else
-	    action.attributes['FileKey'] = file_key
-	  end
+  def add(registry_key)
+    unless(registry_key.key?(:root) && registry_key.key?(:key) && registry_key.key?(:value))
+      raise 'Registry key must have root, key, and value elements' 
+	end
 
-		action.attributes['Directory'] = custom_action[:directory] if(custom_action.key?(:directory))
-  	action.attributes['ExeCommand'] = custom_action[:exe_command] if(custom_action.key?(:exe_command))
-	  action.attributes['DllEntry'] = custom_action[:dll_entry] if(custom_action.key?(:dll_entry))
+	key_value = registry_key[:value]
+    unless(key_value.key?(:name) || key_value.key?(:value) || key_value.key?(:type))
+		raise 'Registry value must have name, value, and type elements' 
+	end
 
-	  if(custom_action.key?(:property))
-	    raise "Custom action property '#{custom_action[:property]} must have a value!" unless(custom_action.key?(:value))
-	    action.attributes.delete('ExeCommand')
-	    action.attributes.delete('Return')
-	    action.attributes['Property'] = custom_action[:property]
-	    action.attributes['Value'] = custom_action[:value]	  
-	  end
-	
-    install_execute_sequence = fragment.add_element 'InstallExecuteSequence'
+	registry_keys_component = REXML::XPath.match(@xml_doc, "//Component[@Id='RegistryKeys']")
+	if(registry_keys_component.size == 0)
+		wix_element = REXML::XPath.match(@xml_doc, "/Wix")[0]
+		fragment = wix_element.add_element 'Fragment'
+		component_group = fragment.add_element 'ComponentGroup'
+		component_group.attributes['Id'] = "rk_#{SecureRandom.uuid.gsub(/-/,'')}"
 
-	  custom_action[:before] = 'InstallFinalize' if(!custom_action.key?(:after) && !custom_action.key?(:before))
- 	  if(custom_action.key?(:after))
- 	    action = install_execute_sequence.add_element 'Custom', { 'Action' => id, 'After' => custom_action[:after] }
-      action.text = condition
- 	  else
- 	    action = install_execute_sequence.add_element 'Custom', { 'Action' => id, 'Before' => custom_action[:before] }
-      action.text = condition
-	  end
-	
-	  control=nil
-	  elements = REXML::XPath.match(@xml_doc, "/Wix/Product")
-	  elements = REXML::XPath.match(@xml_doc, "/Wix/Module") if(elements.nil? || elements.size == 0)
-	
-	  elements[0].add_element 'CustomActionRef', { 'Id' => id }
-  end
-end
+		default_feature = REXML::XPath.match(@xml_doc, '//Wix/Product/Feature')
+		component_ref = default_feature[0].add_element 'ComponentGroupRef', 'Id' => component_group.attributes['Id']
+
+		component = component_group.add_element 'Component'
+		component.attributes['Id'] = 'RegistryKeys'
+		component.attributes['Directory'] = 'INSTALLDIR'
+	else
+		puts "component: #{registry_keys_component.to_s}"
+	end
+		
+	registry_key_element = component.add_element 'RegistryKey', { 'Root' => registry_key[:root], 'Key' => registry_key[:key] }
+	value_element = registry_key_element.add_element 'RegistryValue', { 'Action' => 'write', 'Name' => key_value[:name], 'Value' => key_value[:value], 'Type' => key_value[:type] }
+   end
 end

data/lib/service.rb

@@ -14,7 +14,7 @@ class Service
     raise "Service hash is required to have a :name key" unless(@hash[:service].has_key?(:name))
 
     service_exe = @hash[:service_exe]
-    raise "Service #{file} does not exist" unless(File.exists?(service_exe))
+    raise "Service #{file} does not exist" unless(File.exist?(service_exe))
     
     file_elements = REXML::XPath.match(xml_doc, "//File[@Source='.\\#{service_exe.gsub(/\//,'\\')}']")
     raise "Service #{@file} does not match a 'File' element with a 'Source' attribute in the wix generated wix file" if(file_elements.length == 0)

data/lib/shortcut.rb

@@ -11,7 +11,7 @@ class Shortcut
   end
   
   def create(xml_doc)
-	  raise "Shortcut #{@file} does not exist" unless(File.exists?(@file))
+	  raise "Shortcut #{@file} does not exist" unless(File.exist?(@file))
 	
 	  file_elements = REXML::XPath.match(xml_doc, "//File[@Source='.\\#{@file.gsub(/\//,'\\')}']")
 	  raise "Shortcut #{@file} does not match a 'File' element with a 'Source' attribute in the wix generated wix file" if(file_elements.length == 0)

data/lib/wixgem.rb

@@ -6,6 +6,7 @@ require 'SecureRandom'
 require_relative 'file.rb'
 require_relative 'shortcut.rb'
 require_relative 'custom_action.rb'
+require_relative 'registry_key.rb'
 require_relative 'temp_directory.rb'
 require_relative 'associate_extension.rb'
 require_relative 'service.rb'
@@ -134,13 +135,22 @@ class Wix
 
   def self.manage_custom_actions(xml_doc, input)
     custom_actions = CustomAction.new(xml_doc, input)
-	  return xml_doc if(input[:custom_actions].nil?)
+	return xml_doc if(input[:custom_actions].nil?)
 		
-	  input[:custom_actions].each { |ca| custom_actions.add(ca) } if(input.key?(:custom_actions))
+	input[:custom_actions].each { |ca| custom_actions.add(ca) }
 
-	  return xml_doc
+	return xml_doc
   end
-  
+
+  def self.manage_registry_keys(xml_doc, input)
+	return xml_doc if(input[:set_registry_keys].nil?)
+
+	registry_keys = RegistryKey.new(xml_doc, input)
+	input[:set_registry_keys].each { |rk| registry_keys.add(rk) }
+
+    return xml_doc
+  end
+ 
   def self.manage_associate_extensions(xml_doc, input)
     return xml_doc unless(input.key?(:extensions))
 
@@ -187,7 +197,7 @@ class Wix
 	
 	  install_files.each do |file| 
 	    absolute_path = file
-	    absolute_path = "#{input[:original_pwd]}/#{file}" unless(File.exists?(file))
+	    absolute_path = "#{input[:original_pwd]}/#{file}" unless(File.exist?(file))
 
 	    if(File.read_only?(absolute_path))
 	      install_path = ".\\#{self.modify_file_path(input, file).gsub(/\//,'\\')}"
@@ -270,7 +280,7 @@ class Wix
     files = input
     files = input[:files] if(input.kind_of?(Hash))
 		
-		return files
+	return files
   end
 
   def self.ignore_files(input)
@@ -285,7 +295,7 @@ class Wix
 
 	missing_files = []
 	files.each do |file| 
-	  if(File.exists?(file))
+	  if(File.exist?(file))
    	    install_path = file
         if(input.has_key?(:modify_file_paths))
           input[:modify_file_paths].each { |regex, replacement_string| install_path = install_path.gsub(regex, replacement_string) }
@@ -293,9 +303,9 @@ class Wix
 		raise "Invalid relative installation path: #{install_path}" if(install_path.include?(':'))
 
    	    install_path = "#{directory}/#{install_path}"		
-		FileUtils.mkpath(File.dirname(install_path)) unless(Dir.exists?(File.dirname(install_path)))
+		FileUtils.mkpath(File.dirname(install_path)) unless(Dir.exist?(File.dirname(install_path)))
 		FileUtils.cp(file, install_path, preserve: true)
-	  elsif(!File.exists?(file))
+	  elsif(!File.exist?(file))
 	    missing_files.insert(missing_files.length, file)
 	  end
 	end
@@ -317,7 +327,7 @@ class Wix
 	  files.reject! { |f| ingore_files.include?(f) }
 
 	  files.each do |file| 
-	    if(File.exists?(file))
+	    if(File.exist?(file))
   	      install_path = file
           if(input.has_key?(:modify_file_paths))
             input[:modify_file_paths].each { |regex, replacement_string| install_path = install_path.gsub(regex, replacement_string) }
@@ -380,7 +390,7 @@ class Wix
   def self.execute_heat(input, cmd_line_options)	
 	wix_install_path=install_path.gsub(/\\/,'/');
 	wix_bin_dir = "#{wix_install_path}/bin"
-	wix_bin_dir = "#{wix_install_path}/tools" unless(Dir.exists?(wix_bin_dir))
+	wix_bin_dir = "#{wix_install_path}/tools" unless(Dir.exist?(wix_bin_dir))
 
 	heat_cmd = Execute.new("\"#{wix_bin_dir}/heat.exe\" #{modify_heat_commandline(input, cmd_line_options)}", { quiet: true })
 	heat_cmd.execute	
@@ -527,6 +537,7 @@ class Wix
 	  xml_doc = manage_win10_crt(xml_doc, input)
 	  #xml_doc = manage_ui(xml_doc, input)
 	  xml_doc = manage_custom_actions(xml_doc, input)
+	  xml_doc = manage_registry_keys(xml_doc, input)
 	  xml_doc = manage_upgrade(xml_doc,input)
 	  xml_doc = manage_msm_files(xml_doc)
 	  xml_doc = manage_read_only_files(xml_doc,input)
@@ -550,8 +561,8 @@ class Wix
 	
 	wix_install_path=install_path.gsub(/\\/,'/');
 	wix_bin_dir = "#{wix_install_path}/bin"
-	wix_bin_dir = "#{wix_install_path}/tools" unless(Dir.exists?(wix_bin_dir))
-	raise "Unable to locate candle.exe. Expecting to have a sub directory bin or tools in the wix installtion directory: #{wix_install_path}" unless(Dir.exists?(wix_bin_dir))
+	wix_bin_dir = "#{wix_install_path}/tools" unless(Dir.exist?(wix_bin_dir))
+	raise "Unable to locate candle.exe. Expecting to have a sub directory bin or tools in the wix installtion directory: #{wix_install_path}" unless(Dir.exist?(wix_bin_dir))
 	
 	ext_args = "-ext WixUtilExtension -ext WixNetfxExtension -ext WixUIExtension"
 	candle_cmd = Execute.new("\"#{wix_bin_dir}/candle.exe\" #{ext_args} -out \"#{wixobj_file}\" \"#{wxs_file}\"", { quiet: true })
@@ -579,11 +590,11 @@ class Wix
 	@debug = input[:debug] if(!@debug && input.has_key?(:debug))
 	start_logger if(@debug)
 	
-	FileUtils.mkpath(File.dirname(output)) unless(Dir.exists?(File.dirname(output)))
+	FileUtils.mkpath(File.dirname(output)) unless(Dir.exist?(File.dirname(output)))
 	
 	ext = File.extname(output)
   	basename = File.basename(output, ext)
-	FileUtils.rm(output) if(File.exists?(output))
+	FileUtils.rm(output) if(File.exist?(output))
  
 	output_absolute_path = File.absolute_path(output)
 	input[:original_pwd] = Dir.pwd
@@ -603,13 +614,14 @@ class Wix
 	  rescue Exception => e
 		raise e
 	  ensure
-	    FileUtils.cp("#{dir}/#{wxs_file}", "#{output_absolute_path}.wxs") if(File.exists?("#{dir}/#{wxs_file}") && @debug)
+		puts "debug path: #{output_absolute_path}" if(@debug)
+	    FileUtils.cp("#{dir}/#{wxs_file}", "#{output_absolute_path}.wxs") if(File.exist?("#{dir}/#{wxs_file}") && @debug)
 	    File.open("#{output_absolute_path}.log", 'w') { |f| f.puts(@logger) } if(@debug &!@logger.nil?)
 	  end	  
 	end
 	
 	pdb_file = output_absolute_path.gsub(ext,'.wixpdb')
-	FileUtils.rm(pdb_file) if(File.exists?(pdb_file))
+	FileUtils.rm(pdb_file) if(File.exist?(pdb_file))
 	
 	end_logger if(@debug)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wixgem
 version: !ruby/object:Gem::Version
-  version: 0.110.0
+  version: 0.112.0
 platform: ruby
 authors:
 - Kevin Marshall
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-12 00:00:00.000000000 Z
+date: 2023-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: execute
@@ -140,7 +140,6 @@ files:
 - lib/associate_extension.rb
 - lib/custom_action.rb
 - lib/file.rb
-- lib/registry_entries.rb
 - lib/registry_key.rb
 - lib/service.rb
 - lib/shortcut.rb
@@ -148,7 +147,7 @@ files:
 - lib/wixgem.rb
 homepage: http://rubygems.org/gems/wixgem
 licenses:
-- Apache 2.0
+- MIT
 metadata: {}
 post_install_message:
 rdoc_options: []

data/lib/registry_entries.rb

@@ -1,68 +0,0 @@
-class RegistryEntries
-  def initialize(hash)
-	  @hash = hash
-  end
-
-  def create_key(xml_doc)
-    raise "RegistryEntry hash is required to have a :root key" unless(@hash.has_key?(:root))
-    raise "RegistryEntry hash is required to have a :path key" unless(@hash.has_key?(:path))
-    raise "RegistryEntry hash is required to have a :key key" unless(@hash.has_key?(:key))
-    raise "Key hash is required to have a :name key" unless(@hash[:key].has_key?(:name))
-    raise "Key hash is required to have a :value key" unless(@hash[:value].has_key?(:name))
-    raise "Key hash is required to have a :value key" unless(@hash[:value_type].has_key?(:name))
-
-    service_exe = @hash[:service_exe]
-    raise "Service #{file} does not exist" unless(File.exists?(service_exe))
-    
-    file_elements = REXML::XPath.match(xml_doc, "//File[@Source='.\\#{service_exe.gsub(/\//,'\\')}']")
-    raise "Service #{@file} does not match a 'File' element with a 'Source' attribute in the wix generated wix file" if(file_elements.length == 0)
-      
-    service_exe_element = file_elements[0]
-    service_exe_element.attributes['KeyPath']='yes'
-
-	  create_service_element(xml_doc, service_exe_element)
-	
-	  return xml_doc
-  end
-
-  def set(xml_doc, input)
-    file = file.gsub(/\//,'\\')
-    file_elements = REXML::XPath.match(@xml_doc, "//File[@Source='.\\#{file}']")
-	  raise "Unable to find file '#{file}' to associate with extension '#{extension}'" if(file_elements.nil? || file_elements.size != 1)
-
-	file_parent = file_elements[0].parent
-	
-	app=File.basename(file)
-    # App Paths to support Start,Run -> "myapp"
-    #<RegistryValue Root="HKLM" Key="SOFTWARE\Microsoft\Windows\CurrentVersion\App Paths\MyApp.exe" Value="[!MyApp.exe]" Type="string" />
-	file_parent.add_element 'RegistryValue', { 'Root' => 'HKLM', 'Key' => "SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\App Paths\\#{app}",
-	                                           'Value' => "[INSTALLDIR]#{file}", 'Type' => 'string' }
-    #<RegistryValue Root="HKLM" Key="SOFTWARE\Microsoft\Windows\CurrentVersion\App Paths\MyApp.exe" Name="Path" Value="[APPLICATIONFOLDER]" Type="string" />
-	file_parent.add_element 'RegistryValue', { 'Root' => 'HKLM', 'Key' => "SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\App Paths\\#{app}", 
-	                                           'Name' => 'Path', 'Value' => '[INSTALLDIR]', 'Type' => 'string' }
-
-    # Extend to the "open with" list + Win7 jump menu pinning  
-    #<RegistryValue Root="HKLM" Key="SOFTWARE\Classes\Applications\MyApp.exe\SupportedTypes" Name=".xyz" Value="" Type="string" />
-	file_parent.add_element 'RegistryValue', { 'Root' => 'HKLM', 'Key' => "SOFTWARE\\Classes\\Applications\\#{app}\\SupportedTypes", 
-	                                           'Name' => extension, 'Value' => '', 'Type' => 'string' }
-    #<RegistryValue Root="HKLM" Key="SOFTWARE\Classes\Applications\MyApp.exe\shell\open" Name="FriendlyAppName" Value="!(loc.ApplicationName)" Type="string" />
-	file_parent.add_element 'RegistryValue', { 'Root' => 'HKLM', 'Key' => "SOFTWARE\\Classes\\Applications\\#{app}\\shell\\open\\command", 
-	                                           'Value' => "[INSTALLDIR]#{file} \"%1\"", 'Type' => 'string' }
-
-    # MyApp.Document ProgID 
-    #<RegistryValue Root="HKLM" Key="SOFTWARE\Classes\MyApp.Document" Name="FriendlyTypeName" Value="!(loc.DescXYZ)" Type="string" />
-	file_parent.add_element 'RegistryValue', { 'Root' => 'HKLM', 'Key' => "SOFTWARE\\Classes\\#{File.basename(app, '.exe')}.Document", 
-	                                           'Name' => 'Aim Project File', 'Value' => "[INSTALLDIR]#{app} \"%1\"", 'Type' => 'string' }
-
-	#<ProgId Id="MyApp.Document" Description="!(loc.DescXYZ)" Icon="filetype.ico" Advertise="yes">
-    #    <Extension Id="xyz">
-    #        <Verb Id="open" Command="!(loc.ExplorerMenuOpenXYZ)" Argument="&quot;%1&quot;" />
-    #        <MIME Advertise="yes" ContentType="application/xyz" Default="yes" />
-    #    </Extension>
-    #</ProgId>
-	prog_id = file_parent.add_element 'ProgId', { 'Id' => "#{File.basename(app, '.exe')}.Document", 'Description' => "Aim project file", 
-	                                              'Advertise' => 'yes'}
-    ext = prog_id.add_element 'Extension', { 'Id' => extension.gsub(/\./, '') }
-	ext.add_element 'Verb', { 'Id' => 'open', 'Command' => "[INSTALLDIR]#{app}", 'Argument' => "\"%1\"" }
-  end
-end