releasy 0.2.0rc1

data/lib/releasy/windows_wrapper_maker.rb

@@ -0,0 +1,90 @@
+require 'fileutils'
+require 'ocra'
+
+module Releasy
+  # Creates wrappers and executables by wrapping Ocra's functionality.
+  class WindowsWrapperMaker
+    include FileUtils
+    include FileUtils::Verbose
+
+    # Creates an win32 executable file (xxx.exe) that runs via a Ruby executable at bin/ruby(w).exe
+    # Paths given to the executable are relative to the directory that the executable is in.
+    # Assumes that user's source will be put into _./src/_ and that ruby executables will be in _./bin/_
+    #
+    # @param executable_file [String] File to create, which should be a .exe file.
+    # @param ruby_file [String] Path of script to run with the executable.
+    # @option options :rubyopt [String] RUBYOPT environment variable - Options to pass to Ruby ('')
+    # @option options :rubylib [String] RUBYLIB environment variable - Paths, relative to _./src/_, to add to $LOAD_PATH ('').
+    # @option options :gem_path [String] GEM_PATH environment variable - Path, relative to  _./_, to load gems from ('vendor').
+    # @option options :windows [Boolean] True for an application that uses windows, false for a console application (false)
+    # @option options :icon [String] Path to Windows icon file (.ico) that the executable should use (nil).
+    def build_executable(executable_file, ruby_file, options = {})
+      options = {
+          :rubyopt => '',
+          :rubylib => '',
+          :gem_path => 'vendor',
+          :windows => false,
+          :icon => nil,
+      }.merge! options
+
+      load_ocra unless defined? Ocra::OcraBuilder
+      set_ocra_options options[:icon]
+
+      Ocra::OcraBuilder.new(executable_file, options[:windows]) do |sb|
+        root = Ocra.Pathname Ocra::TEMPDIR_ROOT
+
+        sb.setenv('RUBYOPT', options[:rubyopt])
+        sb.setenv('RUBYLIB', options[:rubylib])
+        sb.setenv('GEM_PATH', (root / options[:gem_path]).to_native)
+        sb.setenv('BUNDLE_GEMFILE', '')
+        sb.setenv('BUNDLE_BIN_PATH', '')
+
+        ruby_executable = options[:windows] ? "rubyw.exe" : "ruby.exe"
+        exe = root / 'bin' / ruby_executable
+        script = (root / ruby_file).to_native
+
+        sb.postcreateprocess(exe, "#{ruby_executable} \"#{script}\"")
+      end
+
+      nil
+    end
+
+    protected
+    def set_ocra_options(icon)
+      options = Ocra.instance_variable_get(:@options)
+      options[:lzma_mode] = false
+      options[:chdir_first] = true
+      options[:icon_filename] = icon
+
+      nil
+    end
+
+    protected
+    def load_ocra
+      Object.send(:remove_const, :Ocra) # remove the "class Ocra", so we can load the "module Ocra"
+      spec = Gem.loaded_specs['ocra']
+
+      # If we aren't on Windows, then File::ALT_SEPARATOR won't be defined or will be defined to the local system.
+      # To save breaking the world, change it as we load, not in File itself.
+      ocra_file = spec.bin_file(spec.executable)
+      if Gem.win_platform?
+        load ocra_file
+      else
+        script = File.read(ocra_file)
+        # On non-windows, UTF8 is the standard way to load files, which is not what we want at all since it will complain about "\xFF".
+        script.force_encoding Encoding::ASCII_8BIT if script.respond_to? :force_encoding
+        script.gsub!("File::ALT_SEPARATOR", "'\\\\\\\\'")
+        Object.class_eval script, ocra_file
+      end
+
+      # Need to disable this method so we get the right output.
+      Ocra::OcraBuilder.class_eval do
+        def createinstdir(*args); end
+      end
+
+      Ocra.find_stubs
+
+      nil
+    end
+  end
+end

data/lib/releasy/windows_wrapper_maker/Gemfile

@@ -0,0 +1,8 @@
+# Gemfile used to create windows_wrapper
+source :rubygems
+
+# Ocra used to make the wrapper.
+gem 'ocra', '~> 1.3.0'
+
+# Ray used to generate it.
+gem 'ray', '~> 0.2.0'

data/releasy.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "releasy/version"
+
+Gem::Specification.new do |s|
+  s.name        = "releasy"
+  s.version     = Releasy::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Bil Bas (Spooner)"]
+  s.email       = ["bil.bagpuss@gmail.com"]
+  s.homepage    = "http://spooner.github.com/libraries/releasy/"
+  s.summary     = %q{Releasy helps to make Ruby application releases simpler}
+  s.description = <<END
+#{s.summary}, by creating and archiving source folders, Windows folders,
+standalone executables, installers and OS X app bundles.
+END
+
+  s.licenses = ["MIT", "GNU LGPL"] # Since I include a file from 7z.
+  s.rubyforge_project = "releasy"
+
+  s.requirements << '7z (optional; used to generate archives)'
+  s.requirements << 'InnoSetup (optional on Windows; used to make Win32 installer)'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = Dir["test/**/*_test.rb"]
+  s.executable    = "releasy"
+
+  s.add_runtime_dependency('ocra', '~> 1.3.0')
+  s.add_runtime_dependency('rake', '~> 0.9.2.2')
+  s.add_runtime_dependency('cri', '~> 2.1.0')
+  s.add_runtime_dependency('thor', '~> 0.14.6') # Only needed in Ruby 1.8, since it provides HashWithIndifferentAccess.
+
+  s.add_development_dependency('riot', '~> 0.12.5')
+  s.add_development_dependency('rr', '~> 1.0.4')
+  s.add_development_dependency('yard', '~> 0.7.4')
+  s.add_development_dependency('redcarpet', '~> 2.0.1')
+end

data/test/releasy/archivers_test.rb

@@ -0,0 +1,65 @@
+require File.expand_path("../teststrap", File.dirname(__FILE__))
+
+# Test all archivers at once, since they are pretty much identical.
+[
+    [:dmg,     Releasy::Archivers::Dmg,      %[GZIP=-9 hdiutil create -fs HFS+ -srcfolder "f" -volname "Test App 0.1" "f.dmg"]],
+    [:exe,     Releasy::Archivers::Exe,      %[7z a -mmt -bd -t7z -mx9 -sfx7z.sfx "f.exe" "f"]],
+    [:"7z",    Releasy::Archivers::SevenZip, %[7z a -mmt -bd -t7z -mx9 "f.7z" "f"]],
+    [:tar_bz2, Releasy::Archivers::TarBzip2, %[7z a -so -mmt -bd -ttar "f.tar" "f" | 7z a -si -bd -tbzip2 -mx9 "f.tar.bz2"]],
+    [:tar_gz,  Releasy::Archivers::TarGzip,  %[7z a -so -mmt -bd -ttar "f.tar" "f" | 7z a -si -bd -tgzip -mx9 "f.tar.gz"]],
+    [:zip,     Releasy::Archivers::Zip,      %[7z a -mmt -bd -tzip -mx9 "f.zip" "f"]],
+].each do |type, archiver, command|
+  extension = "." + type.to_s.tr("_", ".")
+
+  context archiver do
+    setup do
+      project = Releasy::Project.new
+      project.name = "Test App"
+      project.version = "0.1"
+      archiver.new project
+    end
+    teardown { Rake::Task.clear }
+
+    asserts(:type).equals type
+    asserts(:extension).equals extension
+    asserts(:command, "f").equals command
+    asserts(:package, "f").equals "f#{extension}"
+
+    context "setting extension with a . changes package path" do
+      hookup { topic.extension = ".wobble" }
+
+      asserts(:extension).equals ".wobble"
+      asserts(:package, "f").equals "f.wobble"
+    end
+
+    context "setting extension without a . still adds one" do
+      hookup { topic.extension = "wobble" }
+
+      asserts(:extension).equals "wobble"
+      asserts(:package, "f").equals "f.wobble"
+    end
+
+    context "generated tasks" do
+      hookup { topic.send :generate_tasks, "source", "frog" }
+
+      tasks = [
+          [:FileTask, "frog#{extension}", %w[frog]],
+          [:Task, "package:source:#{type}", ["frog#{extension}"]],
+      ]
+
+      test_tasks tasks
+    end
+
+    context "class" do
+      setup { topic.class }
+
+      asserts("#{archiver}::TYPE") { topic::TYPE }.equals type
+
+      if type == :exe
+        asserts("#{archiver}::SFX_NAME") { topic::SFX_NAME }.equals "7z.sfx"
+        asserts("#{archiver}::SFX_FILE") { topic::SFX_FILE }.equals File.expand_path("bin/7z.sfx", $original_path)
+        asserts("sfx file included") { File.exists? topic::SFX_FILE }
+      end
+    end
+  end
+end

data/test/releasy/builders/data/Info.plist

@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>BuildMachineOSBuild</key>
+	<string>11C74</string>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>English</string>
+	<key>CFBundleExecutable</key>
+	<string>Test App</string>
+	<key>CFBundleIconFile</key>
+	<string>test_app</string>
+	<key>CFBundleIdentifier</key>
+	<string>org.frog.fish</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundlePackageType</key>
+	<string>APPL</string>
+	<key>CFBundleSignature</key>
+	<string>????</string>
+	<key>CFBundleVersion</key>
+	<string>1.0</string>
+	<key>DTCompiler</key>
+	<string>4.0</string>
+	<key>DTPlatformBuild</key>
+	<string>10M2518</string>
+	<key>DTPlatformVersion</key>
+	<string>PG</string>
+	<key>DTSDKBuild</key>
+	<string>8S2167</string>
+	<key>DTSDKName</key>
+	<string>macosx10.4</string>
+	<key>DTXcode</key>
+	<string>0400</string>
+	<key>DTXcodeBuild</key>
+	<string>10M2518</string>
+	<key>LSMinimumSystemVersionByArchitecture</key>
+	<dict>
+		<key>i386</key>
+		<string>10.4.0</string>
+		<key>ppc</key>
+		<string>10.4.0</string>
+		<key>x86_64</key>
+		<string>10.6.0</string>
+	</dict>
+	<key>NSMainNibFile</key>
+	<string>MainMenu</string>
+	<key>NSPrincipalClass</key>
+	<string>NSApplication</string>
+</dict>
+</plist>

data/test/releasy/builders/data/Main.rb

@@ -0,0 +1,12 @@
+Dir[File.expand_path("../vendor/gems/*/lib", __FILE__)].each do |lib|
+  $LOAD_PATH.unshift lib
+end
+
+OSX_EXECUTABLE_FOLDER = File.expand_path("../../..", __FILE__)
+
+# Really hacky fudge-fix for something oddly missing in the .app.
+class Encoding
+  UTF_7 = UTF_16BE = UTF_16LE = UTF_32BE = UTF_32LE = Encoding.list.first
+end
+
+load 'application/bin/test_app'

data/test/releasy/builders/data/relapse_runner.rb

@@ -0,0 +1 @@
+load 'bin/test_app'

data/test/releasy/builders/data/set_app_executable.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+chmod a+x "./Test App.app/Contents/MacOS/Test App"
+echo "Made Test App.app executable"

data/test/releasy/builders/helpers/helper.rb

@@ -0,0 +1,47 @@
+require File.expand_path("../../../teststrap", File.dirname(__FILE__))
+
+def new_project
+  project = Releasy::Project.new
+  project.name = "Test App"
+  project.version = "0.1"
+  project.files = source_files
+  project.exposed_files = %w[README.txt LICENSE.txt]
+  project.add_link "http://spooner.github.com/libraries/releasy/", "Releasy website"
+  project.quiet
+  project.output_path = output_path
+
+  project
+end
+
+# Hack to allow test to work using a different gemfile than Releasy's.
+def clear_bundler_env
+  gemfile, bin_path = ENV['BUNDLE_GEMFILE'], ENV['BUNDLE_BIN_PATH']
+  ENV['BUNDLE_GEMFILE'], ENV['BUNDLE_BIN_PATH'] = '', ''
+  ret_val = yield
+  ENV['BUNDLE_GEMFILE'], ENV['BUNDLE_BIN_PATH'] = gemfile, bin_path
+  ret_val
+end
+
+def clear_all_env
+  rubylib, rubyopts = ENV['RUBYLIB'], ENV['RUBYOPTS']
+  ENV['RUBYLIB'], ENV['RUBYOPTS'] = '', ''
+  ret_val = clear_bundler_env { yield }
+  ENV['RUBYLIB'], ENV['RUBYOPTS'] = rubylib, rubyopts
+  ret_val
+end
+
+def data_file(file)
+  File.expand_path("test/releasy/builders/data/#{file}", $original_path)
+end
+
+def gemspecs_to_use
+  # Don't add Releasy since it is may be being run locally and thus not work at all.
+  Gem.loaded_specs.values.find_all {|s| %w[bundler cri ocra thor].include? s.name }
+end
+
+def link_file
+  <<END
+[InternetShortcut]
+URL=http://spooner.github.com/libraries/releasy/
+END
+end

data/test/releasy/builders/ocra_builder_test.rb

@@ -0,0 +1,37 @@
+require File.expand_path("helpers/helper", File.dirname(__FILE__))
+
+context Releasy::Builders::OcraBuilder do
+  setup do
+    Class.new(Releasy::Builders::OcraBuilder) do
+      const_set :DEFAULT_FOLDER_SUFFIX, ''
+    end.new new_project
+  end
+
+  hookup do
+    topic.send(:setup)
+  end
+
+  asserts_topic.kind_of Releasy::Builders::WindowsBuilder
+  asserts(:ocra_parameters).equals ""
+  asserts(:icon).nil
+  asserts("setting incorrect icon") { topic.icon = "frog.png" }.raises ArgumentError, /icon must be a .ico file/
+  asserts(:ocra_command).raises Releasy::ConfigError, /Unless the executable file extension is .rbw or .rb, then #executable_type must be explicitly :windows or :console/
+
+  context "#icon=" do
+    hookup { topic.icon = "icon.ico" }
+    asserts(:icon).equals "icon.ico"
+  end
+
+  context "#ocra_command" do
+    hookup do
+      topic.exclude_encoding
+      topic.ocra_parameters = "--wobble"
+      topic.project.executable = source_files.first
+      topic.executable_type = :console
+      topic.icon = "icon.ico"
+    end
+
+    helper(:command) { %[ocra "bin/test_app" --console --no-enc --wobble --icon "icon.ico" "lib/test_app.rb" "lib/test_app/stuff.rb" "README.txt" "LICENSE.txt" "Gemfile.lock" "Gemfile"] }
+    asserts(:ocra_command).equals { %[bundle exec #{command}] }
+  end
+end

data/test/releasy/builders/osx_app_test.rb

@@ -0,0 +1,107 @@
+require File.expand_path("helpers/helper", File.dirname(__FILE__))
+
+folder = File.join(output_path, "test_app_0_1_OSX")
+app_folder = File.join(folder, "Test App.app")
+
+osx_app_wrapper = Dir.chdir(project_path) { Dir["../wrappers/gosu-mac-wrapper-*.tar.gz"].first }
+if osx_app_wrapper
+  context Releasy::Builders::OsxApp do
+    setup { Releasy::Builders::OsxApp.new new_project }
+
+    teardown do
+      Dir.chdir $original_path
+      Rake::Task.clear
+    end
+
+    hookup do
+      Dir.chdir project_path
+    end
+
+    asserts(:folder_suffix).equals "OSX"
+    asserts(:icon=, "test_app.ico").raises Releasy::ConfigError, /icon must be a .icns file/
+    denies(:gemspecs).empty
+
+    context "no wrapper" do
+      hookup do
+        topic.url = "org.frog.fish"
+      end
+      asserts(:generate_tasks).raises Releasy::ConfigError, /wrapper not set/
+    end
+
+    context "invalid wrapper" do
+      hookup do
+        topic.url = "org.frog.fish"
+        topic.wrapper = "whatever"
+      end
+
+      asserts(:generate_tasks).raises Releasy::ConfigError, /wrapper not valid/
+    end
+
+    context "no url" do
+      hookup do
+        topic.wrapper = osx_app_wrapper
+      end
+      asserts(:generate_tasks).raises Releasy::ConfigError, /url not set/
+    end
+
+    context "valid" do
+      hookup do
+        topic.url = "org.frog.fish"
+        topic.wrapper = osx_app_wrapper
+        topic.icon = "test_app.icns"
+        topic.gemspecs = gemspecs_to_use
+        topic.send :generate_tasks
+      end
+
+      asserts(:folder_suffix).equals "OSX"
+      asserts(:app_name).equals "Test App.app"
+      asserts(:url).equals "org.frog.fish"
+      asserts(:wrapper).equals osx_app_wrapper
+      asserts("gemspecs correct") { topic.gemspecs == gemspecs_to_use }
+
+      context "tasks" do
+        tasks = [
+            [ :Task, "build:osx:app", [folder] ],
+            [ :FileCreationTask, '..', [] ], # byproduct of using #directory
+            [ :FileCreationTask, output_path, [] ], # byproduct of using #directory
+            [ :FileCreationTask, folder, source_files + [osx_app_wrapper]],
+        ]
+
+        test_tasks tasks
+      end
+
+      context "generate" do
+        hookup { Rake::Task["build:osx:app"].invoke }
+
+        asserts("files copied inside app") { source_files.all? {|f| same_contents? "#{app_folder}/Contents/Resources/application/#{f}", f } }
+        asserts("readme copied to folder") { same_contents? "#{folder}/README.txt", "README.txt" }
+        asserts("license copied to folder") { same_contents? "#{folder}/LICENSE.txt", "LICENSE.txt" }
+
+        asserts("executable renamed") { File.exists?("#{app_folder}/Contents/MacOS/Test App") }
+        if Gem.win_platform?
+          asserts("set_app_executable.sh created and with correct line endings") { File.read("#{folder}/set_app_executable.sh") == File.read(data_file("set_app_executable.sh")) }
+        else
+          asserts("app is an executable") { File.executable?("#{app_folder}/Contents/MacOS/Test App") }
+          denies("set_app_executable.sh created") { File.exists? "#{folder}/set_app_executable.sh" }
+        end
+
+        asserts("Gosu icon deleted") { not File.exists? "#{app_folder}/Contents/Resources/Gosu.icns" }
+        asserts("icon is copied to correct location") { File.exists? "#{app_folder}/Contents/Resources/test_app.icns" }
+        asserts("Main.rb is correct") { same_contents? "#{app_folder}/Contents/Resources/Main.rb", data_file("Main.rb") }
+        asserts("Info.plist is correct") { same_contents? "#{app_folder}/Contents/Info.plist", data_file("Info.plist") }
+
+        gemspecs_to_use.each do |gemspec|
+          name = "#{gemspec.name}-#{gemspec.version}"
+          asserts("#{name} gem folder copied") { File.directory? "#{app_folder}/Contents/Resources/vendor/gems/#{name}" }
+          asserts("#{name} spec copied") { File.exists? "#{app_folder}/Contents/Resources/vendor/specifications/#{name}.gemspec" }
+        end
+
+        denies("default chingu gem left in app")  { File.exists?("#{app_folder}/Contents/Resources/lib/chingu") }
+
+        if RUBY_PLATFORM =~ /darwin/
+          asserts("program output") { clear_all_env { %x["./#{app_folder}/Contents/MacOS/Test App"] } }.equals "test run!\n"
+        end
+      end
+    end
+  end
+end