releasy 0.2.0rc1

data/.gitignore

@@ -0,0 +1,17 @@
+pkg
+*.swp
+*.swo
+*.log
+.DS_Store
+.yardoc
+tmp
+tags
+ctags
+.bundle
+.idea/
+doc/
+test_output
+test_project/test_app.exe
+Gemfile.lock
+wrappers/*.tar.gz
+wrappers/*.7z

data/.yardopts

@@ -0,0 +1,4 @@
+--title 'Releasy Documentation'
+-
+CHANGELOG.md
+LICENSE.txt

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+Releasy Change Log
+==================
+
+v0.2.0
+------
+
+  * Name changed from "relapse" to "releasy" because of universal dislike and/or confusion about it :)
+  * Warning: API changed significantly from v0.1.0 because it was dreadful :D
+  * Allowed outputs to be configured separately from the project.
+  * Included gems in osx-app more safely, so that no files will be missing.
+  * Added `:exe` archive format (Windows self-extractor, used on any OS).
+  * Added `:dmg` archive format (OS X self-extractor, used on OS X only).
+  * Added `:windows_folder_from_ruby_dist` output (windows folder made from a RubyInstaller archive, used on OSX/Linux).
+  * Allowed project and outputs to have archive formats (when called on Project, affecting all outputs).
+  * Archive formats can have a different `#extension` set.
+  * Output formats can have a different `#folder_suffix` set.
+  * No longer require Innosetup to be installed in order to create `:windows_folder` output.
+  * Added command, 'releasy install-sfx' that installs the self-extractor package for 7z, to enable :exe archiving (non-Windows only).
+  * Lots of other things fixes, refactors and additions, that I lost track of :$
+
+v0.1.0
+------
+
+  * First public release as "relapse"

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Bil Bas (Spooner)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,165 @@
+Releasy
+=======
+
+_Releasy_ automates the release of Ruby applications (name comes from "Release + easy").
+By configuring a {Releasy::Project} in your application's rakefile, Releasy can generates a number of Rake tasks for use
+when there is a need to release a new version of the application.
+
+Releasy allows cross-platform releases, relying on pre-made OS X or Windows wrappers to act as templates
+(Releasy is able to make the latter type of wrapper itself).
+
+* Author: [Bil Bas (Spooner)](https://github.com/Spooner)
+* Licence: [MIT](http://www.opensource.org/licenses/mit-license.php)
+* [Github project](https://github.com/Spooner/releasy)
+* [Reporting issues](https://github.com/Spooner/releasy/issues)
+* Wrappers used to build cross-platform releases:
+  - _Windows:_ [RubyInstaller 7-ZIP archives](http://rubyinstaller.org/downloads/); Ruby 1.8.7, 1.9.2 or 1.9.3
+  - _OS X:_ [libgosu downloads](http://www.libgosu.org/downloads/). Latest version of the OS X-compatible wrapper is "gosu-mac-wrapper-0.7.41.tar.gz" which uses Ruby 1.9.2 and includes some binary gems: Gosu, Chipmunk and TexPlay.
+* Tested on Ruby 1.9.3 and 1.8.7 on Windows, Lubuntu and OS X. However, since this is an early version, please ensure that you double-check any releases created by Releasy before publishing them!
+
+Output types supported
+----------------------
+
+The project can create one or more release folders:
+
+* `:source` - Plain source folder, which can be used by anyone with Ruby already installed.
+* `:osx_app` - OS X application bundle (.app) build, requiring a pre-made Ruby OS X wrapper [Note that this only contains binary gems for Gosu, TexPlay and Chipmunk, but will work with applications using any other source gems].
+* `:windows_folder` - A folder containing Ruby, application source files and an EXE to run them [creation on Windows only]
+* `:windows_folder_from_ruby_dist` - A folder containing Ruby, application source files and an EXE to run them, requiring a copy of a RubyInstaller archive [creation on OSX/Linux]
+* `:windows_installer` - A regular Windows installer [creation on Windows only and requires InnoSetup to be installed]
+* `:windows_standalone` - Standalone EXE file that self-extracts to a temporary directory - slower startup than the other Windows options [creation on Windows only]
+
+Archive types supported
+-----------------------
+
+Optionally, release folders can be archived using one or more of:
+
+* `:dmg` - OS X self-extractor (.dmg - requires `hdiutil` to be installed, so only available on OS X)
+* `:exe` - Windows self-extractor (.exe - Includes a 7z decompression module, so not efficient for small releases)
+* `:"7z"` - 7Zip format (.7z - Best compression)
+* `:tar_bz2` - BZip2 tarball (.tar.bz2)
+* `:tar_gz` - GZip tarball (.tar.gz)
+* `:zip` - Standard zip format (.zip - Poor compression, but best compatibility)
+
+Example
+-------
+
+### Project's Rakefile
+
+    # Example is from my game, Alpha Channel.
+    require 'rubygems'
+    require 'bundler/setup' # Releasy doesn't require that your application uses bundler, but it does make things easier.
+    require 'releasy'
+    require 'lib/alpha_channel/version'
+
+    #<<<
+    Releasy::Project.new do
+      name "Alpha Channel"
+      version AlphaChannel::VERSION
+
+      executable "bin/alpha_channel.rbw"
+      files `git ls-files`.split("\n")
+      files.exclude '.gitignore'
+
+      exposed_files ["README.html", "LICENSE.txt"]
+      add_link "http://spooner.github.com/games/alpha_channel", "Alpha Channel website"
+
+      # Create a variety of releases, for all platforms.
+      add_build :osx_app do
+        add_archive :tar_gz
+        url "com.github.spooner.games.alpha_channel"
+        wrapper "../osx_app/gosu-mac-wrapper-0.7.41.tar.gz"
+        icon "media/icon.icns"
+      end
+
+      add_build :source
+
+      add_build :windows_folder do
+        icon "media/icon.ico"
+        add_archive :exe
+        exclude_encoding
+      end
+
+      add_build :windows_installer do
+        icon "media/icon.ico"
+        exclude_encoding
+        start_menu_group "Spooner Games"
+        readme "README.html" # User asked if they want to view readme after install.
+        license "LICENSE.txt" # User asked to read this and confirm before installing.
+      end
+
+      add_archive :zip # All outputs given this archive format.
+    end
+    #>>>
+
+### Tasks created
+
+Note: The `windows:folder`, `windows:installer` and `windows:standalone` will be created only if running on Windows.
+The `windows:folder_from_ruby_dist` task will not be created if running on Windows.
+
+    rake build                         # Build all outputs
+    rake build:osx                     # Build all osx outputs
+    rake build:osx:app                 # Build OS X app
+    rake build:source                  # Build source folder
+    rake build:windows                 # Build all Windows outputs
+    rake build:windows:folder          # Build source/exe folder 1.4.0
+    rake build:windows:installer       # Build installer 1.4.0 [Innosetup]
+    rake package                       # Package all
+    rake package:osx                   # Package all OS X
+    rake package:osx:app               # Package all :osx_app
+    rake package:osx:app:tar_gz        # Create pkg/alpha_channel_1_4_0_OSX.tar.gz
+    rake package:osx:app:zip           # Create pkg/alpha_channel_1_4_0_OSX.zip
+    rake package:source                # Package all :source
+    rake package:source:zip            # Create pkg/alpha_channel_1_4_0_SOURCE.zip
+    rake package:windows               # Package all Windows outputs
+    rake package:windows:folder        # Package all :windows_folder outputs
+    rake package:windows:folder:exe    # Create pkg/alpha_channel_1_4_0_WIN32.exe
+    rake package:windows:folder:zip    # Create pkg/alpha_channel_1_4_0_WIN32.zip
+    rake package:windows:installer     # Package all :windows_installer
+    rake package:windows:installer:zip # Create pkg/alpha_channel_1_4_0_WIN32_I...
+
+CLI Commands
+------------
+
+Releasy also provides some supplementary commands:
+
+* `releasy install-sfx [options]` - Installs a copy of the Windows self-extractor in the local 7z installation, to allow use of the `:exe` archive format (it comes with the Windows version of 7z, so only need to use this command on OS X/Linux).
+
+
+External Requirements (Optional, but recommended)
+--------------------------------
+
+### To create package archives (except `:dmg`)
+
+[7z](http://www.7-zip.org) must be installed.
+
+  - Installing on OS X homebrew:
+
+    <pre>brew install p7zip</pre>
+
+  - Installing on Ubuntu/Debian:
+
+    <pre>sudo apt-get install p7zip-full</pre>
+
+  - Installing on Windows (or other OS)
+
+    * [Download](http://www.7-zip.org/download.html)
+
+### To create `:windows_installer` output (Windows only)
+
+[InnoSetup](http://www.jrsoftware.org/isdl.php) must be installed.
+
+Credits
+-------
+
+* Thanks to jlnr for creating "RubyGosu App.app", an OS X application bundle used to wrap application code.
+* Thanks to larsh for the [Ocra gem](http://ocra.rubyforge.org/), which is used for generating Win32 executables.
+* Thanks to jlnr and shawn42 for help testing on OS X; without you I would have been screwed!
+* Thanks to shawn42 and everyone at #gosu and #rubylang for suggestions on how to improve the API.
+* Thanks to kyrylo for coming up with the name, Releasy!
+
+Third Party Assets included
+---------------------------
+
+* bin/7z.sfx - Windows [7z 9.20](http://www.7-zip.org) self-extractor module [License: [GNU LGPL](http://www.7-zip.org/license.txt)]
+

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:development)
+require 'rake'
+# Hack to ensure rake testtask/clean will load on Ruby 1.8.x
+Gem.loaded_specs['rake'].add_self_to_load_path if RUBY_VERSION =~ /^1\.8\.\d+/
+require 'rake/testtask'
+require 'rake/clean'
+require 'yard'
+
+CLEAN << "test_output" # Created by running tests.
+
+Bundler::GemHelper.install_tasks
+
+desc "Run all tests"
+task :test do
+  Rake::TestTask.new do |t|
+    t.libs << "test"
+    t.pattern = "test/**/*_test.rb"
+    t.verbose = false
+  end
+end
+
+YARD::Rake::YardocTask.new
+
+desc "Run a yard server to auto-update docs"
+task :yard_server do
+  system "bundle exec yard server --reload"
+end
+
+task :default => :test

data/bin/releasy

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require 'releasy'
+require 'releasy/cli'
+
+Releasy::Cli.run ARGV

data/lib/releasy.rb

@@ -0,0 +1,18 @@
+require 'rake'
+
+$LOAD_PATH.unshift File.expand_path("..", __FILE__)
+
+# Application release manager.
+module Releasy
+  def self.win_platform?; RUBY_PLATFORM =~ /mingw|win32/; end
+
+  # An error caused when Releasy configuration is incorrect or inconsistent.
+  class ConfigError < StandardError; end
+
+  # Modules used to extend Releasy classes.
+  module Mixins; end
+end
+
+require "releasy/version"
+require "releasy/project"
+

data/lib/releasy/archivers.rb

@@ -0,0 +1,12 @@
+require 'releasy/mixins/register'
+
+module Releasy
+  # Contains all {Archiver} types.
+  module Archivers
+    extend Mixins::Register
+  end
+end
+
+%w[dmg exe seven_zip tar_bzip2 tar_gzip zip].each do |archiver|
+  require "releasy/archivers/#{archiver}"
+end

data/lib/releasy/archivers/archiver.rb

@@ -0,0 +1,74 @@
+require 'digest/md5'
+
+require "releasy/mixins/exec"
+
+module Releasy
+module Archivers
+  # Archives a build folder.
+  #
+  # @abstract
+  class Archiver
+    include Rake::DSL
+    include Mixins::Exec
+
+    MD5_READ_SIZE = 128 * 64 # MD5 likes 128 byte chunks.
+
+    # @return [Project] Project this Archiver was created by.
+    attr_reader :project
+    # @return [String] Extension of archive to be created (such as ".zip").
+    attr_accessor :extension
+
+    def type; self.class::TYPE; end
+
+    def initialize(project)
+      @project = project
+      @extension = self.class::DEFAULT_EXTENSION
+    end
+
+    protected
+    # Generate tasks to create the archive of this file.
+    def generate_tasks(output_task, folder)
+      pkg = package folder
+
+      desc "Create #{pkg}"
+      task "package:#{output_task}:#{type}" => pkg
+
+      file pkg => folder do
+        archive folder
+      end
+    end
+
+    protected
+    def archive(folder)
+      pkg = package folder
+      Rake::FileUtilsExt.verbose project.verbose?
+
+      puts "Creating #{pkg}" if project.verbose?
+      rm pkg if File.exist? pkg
+      cd project.output_path do
+        exec command(File.basename folder)
+      end
+
+      File.open("#{pkg}.MD5", "w") {|f| f.puts checksum(pkg) } if project.send :create_md5s?
+    end
+
+    protected
+    def package(folder); "#{folder}#{extension[0, 1] == '.' ? '' : '.'}#{extension}"; end
+
+    protected
+    def command(folder)
+      %[7z a -mmt -bd -t#{type} -mx9 "#{package(folder)}" "#{folder}"]
+    end
+
+    protected
+    def checksum(filename)
+      digest = Digest::MD5.new
+      File.open(filename, "rb") do |file|
+        digest << file.read(MD5_READ_SIZE) until file.eof?
+      end
+
+      digest.hexdigest
+    end
+  end
+end
+end

data/lib/releasy/archivers/dmg.rb

@@ -0,0 +1,18 @@
+require "releasy/archivers/archiver"
+
+module Releasy
+  module Archivers
+    # OS X .dmg format (self-extractor).
+    class Dmg < Archiver
+      TYPE = :dmg
+      DEFAULT_EXTENSION = ".dmg"
+
+      Archivers.register self
+
+      protected
+      def command(folder)
+        %[GZIP=-9 hdiutil create -fs HFS+ -srcfolder "#{folder}" -volname "#{project.name} #{project.version}" "#{package(folder)}"]
+      end
+    end
+  end
+end

data/lib/releasy/archivers/exe.rb

@@ -0,0 +1,23 @@
+require "releasy/archivers/archiver"
+
+module Releasy
+  module Archivers
+    # Windows self-extracting archive.
+    #
+    # If not on Windows, run "releasy install-sfx" after installing 7z, before you can use this.
+    class Exe < Archiver
+      TYPE = :exe
+      DEFAULT_EXTENSION = ".exe"
+
+      SFX_NAME = "7z.sfx"
+      SFX_FILE = File.expand_path("../../../../bin/#{SFX_NAME}", __FILE__)
+
+      Archivers.register self
+
+      protected
+      def command(folder)
+        %[7z a -mmt -bd -t7z -mx9 -sfx#{SFX_NAME} "#{package(folder)}" "#{folder}"]
+      end
+    end
+  end
+end

data/lib/releasy/archivers/seven_zip.rb

@@ -0,0 +1,12 @@
+require "releasy/archivers/archiver"
+
+module Releasy
+  module Archivers
+    # 7z archive format (LZMA)
+    class SevenZip < Archiver
+      TYPE = :"7z"
+      DEFAULT_EXTENSION = ".7z"
+      Archivers.register self
+    end
+  end
+end