wixgem 0.0.13

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,65 @@
+# wixgem
+Simple Ruby interface to facilitate creating and compiling simple windows installation files 
+with the Wix Toolset.
+
+## Installation
+wixgem can be installed by the single command
+ gem install wixgem
+
+## Usage
+The wix toolset must be installed.
+
+In a rakefile define an installation task:
+
+```
+  require 'wixgem'
+	
+  WIX_TOOLSET_ROOT='path to root of Wix toolset'
+
+  task :create_installation_files do
+    FileUtils.mkpath('./install_files/directory')
+    sleep(1)
+    File.open('./install_files/file1.txt', 'w') { |f| f.write('Hello World') }
+    File.open('./install_files/directory/file2.txt', 'w') { |f| f.write('Hello World') }
+  end
+
+  desc "Generate an installation msi file"
+  task :installation => [:create_installation_files] do	  
+    Wix.install_path = WIX_TOOLSET_ROOT
+
+    installation_files = Dir.glob('./install_files/**/*')
+    Wix.make_installation("./example.msi",  
+      { 
+	    manufacturer: 'Company', version: "1.0.0", 
+	    product_code: '{69d12c6c-63be-43e4-92ff-e31ec3c86dc0}', 
+	    upgrade_code: '{a62c35a7-6a6d-4392-822b-f6aca7eef88b}', 
+	    files: installation_files
+	  } 
+	)
+  end
+
+  task :mergemodule => [:create_installation_files] do
+    installation_files = Dir.glob('./install_files/**/*')
+  
+    Wix.install_path = WIX_TOOLSET_ROOT
+    Wix.make_mergemodule('./example.msm', installation_files)
+  end
+
+  task :default => [:installation]
+```
+
+## License
+Copyright 2013-2014 Kevin Marshall
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/lib/templates/Install.wxs

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
+	<Product Id="PRODUCT_CODE" Name="PRODUCT_NAME" Language="1033" Version="VERSION" Manufacturer="MANUFACTURER" UpgradeCode="UPGRADE_CODE">
+		<Package InstallerVersion="200" Compressed="yes" InstallScope="perMachine" />
+
+		<MajorUpgrade DowngradeErrorMessage="A newer version of [ProductName] is already installed." />
+		<Media Id="1" Cabinet="WixgemTest.cab" EmbedCab="yes" />
+		    
+    <!-- Step 1: Define the directory structure -->
+		<Directory Id="TARGETDIR" Name="SourceDir">
+			<Directory Id="ProgramFilesFolder">
+              INSTALL_DIR
+			</Directory>
+		</Directory>
+
+    <!-- Step 2: Add files to installer package -->
+		<DirectoryRef Id="INSTALLFOLDER">
+			FILES
+		</DirectoryRef>
+
+    <!-- Step 3: Tell Wix to install the files-->
+    <Feature Id="ProductFeature" Title="PRODUCT_NAME Installation" Level="1">
+      COMPONENT_REFS
+    </Feature>
+  </Product>
+</Wix>

data/lib/templates/mergemodule.wxs

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
+    <Module Id="MODULE_NAME" Language="1033" Version="VERSION">
+        <Package Id="PRODUCT_CODE" InstallerVersion="200" Manufacturer="MANUFACTURER" />
+        COMPONENT_REFS
+        <Directory Id="TARGETDIR" Name="SourceDir">
+		  <Directory Id="MergeRedirectFolder" />
+		</Directory>
+    </Module>
+    <Fragment>
+        <DirectoryRef Id="MergeRedirectFolder">
+            FILES
+        </DirectoryRef>
+    </Fragment>
+</Wix>

data/lib/wixgem.rb

@@ -0,0 +1,156 @@
+require 'fileutils'
+require 'SecureRandom'
+require 'tmpdir.rb'
+
+class Wix
+  def self.install_path=(value)
+    raise "WIX path '#{value}' does not exist" unless(Dir.exists?(value))
+	@install_path = value
+  end
+  
+  def self.install_path
+	return @install_path
+  end
+
+  def self.make_mergemodule(output, input)
+    gem_dir = File.dirname(__FILE__)
+    apply_wix_template(output, input, "#{gem_dir}/templates/mergemodule.wxs")
+  end
+  
+  def self.make_installation(output, input)
+    gem_dir = File.dirname(__FILE__)
+    apply_wix_template(output, input, "#{gem_dir}/templates/Install.wxs")
+  end
+  
+  private      
+  def self.manage_msm_files(wxs_text)
+	indent_merge = '			'
+	indent_directory = '		'
+	
+	merge_ids = ''
+	merge_refs = ''
+	remove_components = []
+	
+	component = 0
+	id = 1
+	file = 2
+	wxs_text.scan(/(?<component><Component Id=\"(?<id>[^\"]+)\".+Source=\"(?<file>.+\.msm)\".+Component>)/m) { |match|
+	  merge_id = match[id].gsub('cmp','merge')
+	  merge_ids = "#{merge_ids}#{indent_merge}<Merge Id='#{merge_id}' Language='1033' SourceFile='#{match[file]}' DiskId='1' />\n"
+	  merge_refs = "#{indent_merge}#{merge_refs}<MergeRef Id='#{merge_id}' />\n#{indent_merge}"
+
+	  remove_components.insert(remove_components.length, match[component])
+	}
+	
+	remove_components.each { |cmp| wxs_text = wxs_text.gsub(cmp, '') }
+	
+	directory_element = "<Directory Id='TARGETDIR' Name='SourceDir'>\n#{merge_ids}#{indent_directory}</Directory>"
+	wxs_text = wxs_text.gsub('<Directory Id="TARGETDIR" Name="SourceDir" />', directory_element)
+	
+	wxs_text = wxs_text.gsub(/\s+<\/Feature>/, "\n#{merge_refs}</Feature>")
+
+	return wxs_text
+  end
+ 
+  def self.copy_install_files(directory, input)
+    files = input
+	files = input[:files] if(input.kind_of?(Hash))
+	
+	files.each do |file| 
+	  if(File.file?(file))
+	    install_path = "#{directory}/#{file}"
+		FileUtils.mkpath(File.dirname(install_path)) unless(Dir.exists?(File.dirname(install_path)))
+		FileUtils.cp(file, install_path)
+#	  else if(!Dir.exists?(file) && !File.exists?(file))
+#	    raise "File: '#{file}' does not exist!"
+	  end
+	end
+  end
+
+  def self.create_wxs_file(wxs_file, input, ext)
+    template_option = "-template product"
+	template_option = "-template module" unless(ext == ".msi")
+	
+	stdout = %x[\"#{install_path}/bin/heat.exe\" dir . #{template_option} -cg InstallionFiles -gg -nologo -srd -o  \"#{wxs_file}\"]
+	raise "#{stdout}\nFailed to generate .wxs file" unless(File.exists?(wxs_file))
+	
+	product_name = File.basename(wxs_file, '.wxs')
+    product_name = input[:product_name] if(input.kind_of?(Hash) && input.has_key?(:product_name))
+	
+    manufacturer = 'Not Set'
+    manufacturer = input[:manufacturer] if(input.kind_of?(Hash) && input.has_key?(:manufacturer))
+
+	product_version = ''
+    product_version = input[:version] if(input.kind_of?(Hash) && input.has_key?(:version))
+
+	product_code = ''
+	product_code = input[:product_code] if(input.kind_of?(Hash) && input.has_key?(:product_code))
+	
+	wxs_text = File.read(wxs_file)
+
+	wxs_text = wxs_text.gsub(/SourceDir\\/) { |s| s = '.\\' }
+	wxs_text = wxs_text.gsub(/PUT-PRODUCT-NAME-HERE/) { |s| s = product_name }
+	wxs_text = wxs_text.gsub(/PUT-MODULE-NAME-HERE/) { |s| s = product_name }
+	wxs_text = wxs_text.gsub(/PUT-COMPANY-NAME-HERE/) { |s| s = manufacturer }
+	wxs_text = wxs_text.gsub(/PUT-FEATURE-TITLE-HERE/) { |s| s = 'Files to Install' }
+
+	wxs_text = wxs_text.gsub(/Version=\"1.0.0.0\"/) { |s| s = "Version=\"#{product_version}\"" } unless(product_version.empty?)
+	wxs_text = wxs_text.gsub(/Product Id=\"[^\"]+\"/) { |s| s = "Product Id=\"#{product_code}\"" } unless(product_code.empty?)
+
+	install_path = '[ProgramFilesFolder][ProductName]'
+	install_path = "[ProgramFilesFolder][Manufacturer]\\[ProductName]" unless(manufacturer == 'Not Set')
+	
+	custom_action = "
+        <CustomAction Id='SetTARGETDIR' Property='TARGETDIR' Value='#{install_path}' Execute='firstSequence' />
+
+		<InstallUISequence>
+			<!-- Set TARGETDIR if it wasn't set on the command line -->
+			<Custom Action='SetTARGETDIR' Before='CostFinalize'>TARGETDIR=\"\"</Custom>
+		</InstallUISequence>
+
+		<InstallExecuteSequence>
+			<!-- Set TARGETDIR if it wasn't set on the command line -->
+			<Custom Action='SetTARGETDIR' Before='CostFinalize'>TARGETDIR=\"\"</Custom>
+		</InstallExecuteSequence>
+	</Product>"	
+	wxs_text = wxs_text.gsub(/<\/Product>/) { |s| s = custom_action }
+
+	wxs_text = manage_msm_files(wxs_text)
+		
+	File.open(wxs_file, 'w') { |f| f.puts(wxs_text) }	
+  end
+
+  def self.create_output(wxs_file, output)
+    wixobj_file = "#{File.basename(wxs_file)}.wixobj"
+	
+	stdout = %x[\"#{install_path}\\bin\\candle.exe\" -out \"#{wixobj_file}\" \"#{wxs_file}\"]
+	raise "#{stdout}\nFailed to generate .wixobj file" unless(File.exists?(wixobj_file))
+
+    stdout = %x[\"#{install_path}\\bin\\light.exe\" -nologo -out \"#{output}\" \"#{wixobj_file}\"]
+	raise "#{stdout}\nFailed to generate #{output} file" unless(File.exists?(output))
+  end
+
+  def self.apply_wix_template(output, input, template)
+    raise 'WIX path is not set!' if(install_path.nil?)
+ 
+	ext = File.extname(output)
+  	basename = File.basename(output, ext)
+	FileUtils.rm(output) if(File.exists?(output))
+ 
+	output_absolute_path = File.absolute_path(output)
+
+    #dir = 'tmp_dir'
+	#FileUtils.rm_rf(dir) if(Dir.exists?(dir))
+	Dir.mktmpdir do |dir|
+	  copy_install_files(dir, input)
+	  
+	  wxs_file = "#{basename}.wxs"	    
+	  Dir.chdir(dir) do |current_dir|
+		create_wxs_file(wxs_file, input, ext)
+		create_output(wxs_file, output_absolute_path)
+	  end
+    end
+	pdb_file = output_absolute_path.gsub(ext,'.wixpdb')
+	FileUtils.rm(pdb_file) if(File.exists?(pdb_file))
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: wixgem
+version: !ruby/object:Gem::Version
+  version: 0.0.13
+  prerelease: 
+platform: ruby
+authors:
+- Kevin Marshall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dev_tasks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'Simple Ruby interface to facilitate creating and compiling windows
+  installation files with the Wix Toolset.\n\nNote: This gem currently does not handle
+  registration of COM objects or registry entries.'
+email: KCCKSMarshall@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/templates/Install.wxs
+- lib/templates/mergemodule.wxs
+- lib/wixgem.rb
+homepage: http://rubygems.org/gems/wixgem
+licenses:
+- Apache 2.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.28
+signing_key: 
+specification_version: 3
+summary: Simple Ruby interface to facilitate working with Wix Toolset
+test_files: []
+has_rdoc: