releasy 0.2.0 → 0.2.2

data/.yardopts

@@ -1,4 +1,6 @@
 --title 'Releasy Documentation'
 -
 CHANGELOG.md
-LICENSE.txt
+LICENSE.txt
+bin/7za_exe_LICENSE.txt
+bin/7z_sfx_LICENSE.txt

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 Releasy Change Log
 ==================
 
+v0.2.2
+------
+
+  * Added new deployers: :rsync and :local
+  * Removed 7z installation dependency on Windows (included 7za.exe in gem).
+  * Fixes for Ruby 1.8.7
+  * :osx_app build - Change directory into application directory before running app.
+  * :osx_app build - Add BINARY to list of "fake" encodings.
+
 v0.2.0
 ------
 

data/README.md

@@ -1,49 +1,32 @@
 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 build, archive and/or deploy a new version of the application.
-
-Releasy allows cross-platform releases, relying on OS X or Windows "wrappers" to act as templates.
+_Releasy_ automates the release of Ruby applications for non-Ruby users, such as games or GUI applications.
+By configuring a {Releasy::Project} in your application's Rakefile, Releasy can generate Rake tasks for use
+when there is a need to build, package (archive) and/or deploy a new version of the application.
 
 * 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)
-* Relapse has been 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!
-
-Build types supported
-----------------------
-
-The project can build one or more release folders:
+* Releasy has been 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!
 
-* `: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_wrapped` - 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].
 
-Package types supported
------------------------
+Key features
+------------
 
-Optionally, release folders can be packaged into an archive using one or more of:
+* Package up Ruby applications (Games, GUI applications, etc.) for non-ruby users.
+* Build OSX application bundle (.app) on any platform.
+* Build Windows executable (.exe) on any platform.
+* Build Windows installer on Windows only.
+* Build, package (compress) and deploy your executables for all platforms from a single rake command ('rake deploy').
 
-* `: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).
 
-Deploy types supported
-----------------------
+Installation
+------------
 
-Optionally, packaged releases can be deployed using one or more of:
+    gem install releasy
 
-* `:github` - Upload to Github downloads.
-* Others, such as `:dropbox`, when I get around to implementing them.
 
 Example
 -------
@@ -71,13 +54,13 @@ Example
       # Create a variety of releases, for all platforms.
       add_build :osx_app do
         url "com.github.my_application"
-        wrapper "../osx_app/gosu-mac-wrapper-0.7.41.tar.gz"
+        wrapper "wrappers/gosu-mac-wrapper-0.7.41.tar.gz" # Assuming this is where you downloaded this file.
         icon "media/icon.icns"
         add_package :tar_gz
       end
 
       add_build :source do
-        add_package :zip
+        add_package :"7z"
       end
 
       add_build :windows_folder do
@@ -93,6 +76,12 @@ Example
         add_package :zip
       end
 
+      add_build :windows_wrapped do
+        wrapper "wrappers/ruby-1.9.3-p0-i386-mingw32.7z" # Assuming this is where you downloaded this file.
+        exclude_tcl_tk
+        add_package :zip
+      end
+
       add_deploy :github # Upload to a github project.
     end
     #>>>
@@ -102,6 +91,8 @@ Example
 Note: The `windows:folder`, `windows:installer` and `windows:standalone` will be created only if running on Windows.
 The `windows:wrapped` task will not be created if running on Windows.
 
+The output from "rake -T" on Windows would be:
+
     rake build                                # Build My Application 1.4.0
     rake build:osx                            # Build all osx
     rake build:osx:app                        # Build OS X app
@@ -111,19 +102,99 @@ The `windows:wrapped` task will not be created if running on Windows.
     rake build:windows:installer              # Build windows installer
     rake deploy                               # Deploy My Application 1.4.0
     rake deploy:osx:app:tar_gz:github         # github <= osx app .tar.gz
-    rake deploy:source:zip:github             # github <= source .zip
+    rake deploy:source:7z:github              # github <= source .7z
     rake deploy:windows:folder:exe:github     # github <= windows folder .exe
-    rake deploy:windows:installer:exe:github  # github <= windows installer .zip
+    rake deploy:windows:installer:zip:github  # github <= windows installer .zip
     rake generate:images                      # Generate images
     rake package                              # Package My Application 1.4.0
     rake package:osx:app:tar_gz               # Package osx app .tar.gz
-    rake package:source:zip                   # Package source .zip
+    rake package:source:7z                    # Package source .7z
     rake package:windows:folder:exe           # Package windows folder .exe
     rake package:windows:installer:zip        # Package windows installer .zip
 
 A variety of unlisted tasks are also created, that allow for more control, such as `deploy:github` (Deploy all packages to Github only),
 `deploy:windows:folder` (deploy all windows folder packages all destinations) or `package:windows` (Package all windows builds).
 
+
+Build types supported
+----------------------
+
+The project can build one or more release folders:
+
+* `:source`
+  - Plain source folder, which can be used by anyone with Ruby already installed.
+  - See {Releasy::Builders::Source}
+* `: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.
+  - See {Releasy::Builders::OsxApp}
+* `:windows_folder`
+  - A folder containing Ruby, application source files and an EXE to run them.
+  - Available on _Windows only_.
+  - See {Releasy::Builders::WindowsFolder}
+* `:windows_wrapped`
+  - A folder containing Ruby, application source files and an EXE to run them, requiring a copy of a RubyInstaller archive.
+  - Available on _OS X and Linux only_.
+  - Creates larger release than other Windows build options.
+  - See {Releasy::Builders::WindowsWrapped}
+* `:windows_installer`
+  - A Windows installer.
+  - Available on _Windows only and requires [InnoSetup](http://www.jrsoftware.org/isinfo.php) to be installed_.
+  - See {Releasy::Builders::WindowsInstaller}
+* `:windows_standalone`
+  - Standalone EXE file that self-extracts to a temporary directory, which is the default behaviour for [Ocra](https://github.com/larsch/ocra).
+  - Available on _Windows only_.
+  - Slower startup than the other Windows build options (up to 2s slower).
+  - See {Releasy::Builders::WindowsStandalone}
+
+See {Releasy::Project#add_build}
+
+
+Package types supported
+-----------------------
+
+Optionally, release folders can be packaged into an archive using one or more of:
+
+* `:"7z"`
+  - 7Zip format (.7z - Best compression).
+  - See {Releasy::Packagers::SevenZip}
+* `:dmg`
+  - OS X self-extractor (.dmg - requires `hdiutil` to be installed, so only available on OS X).
+  - Available on OS X only (`hdiutils` command required).
+  - See {Releasy::Packagers::Dmg}
+* `:exe`
+  - Windows self-extractor (.exe - Includes a 7z decompression module, so not efficient for small releases).
+  - See {Releasy::Packagers::Exe}
+* `:tar_bz2`
+  - Bzip2 tarball (.tar.bz2).
+  - See {Releasy::Packagers::TarBzip2}
+* `:tar_gz`
+  - Gzip tarball (.tar.gz).
+  - See {Releasy::Packagers::TarGzip}
+* `:zip`
+  - Standard zip format (.zip - Poor compression, but best compatibility).
+  - See {Releasy::Packagers::Zip}
+
+See {Releasy::Mixins::HasPackagers#add_package}
+
+
+Deploy types supported
+----------------------
+
+Optionally, packaged releases can be deployed using one or more of:
+
+* `:github`
+  - Upload to a Github project's downloads page.
+  - See {Releasy::Deployers::Github}
+* `:local`
+  - Copy files locally, for example into a local web server or dropbox folder.
+  - See {Releasy::Deployers::Local}
+* `:rsync`
+  - Upload to remote server with rsync (requires 'rsync' command be installed).
+  - See {Releasy::Deployers::Rsync}
+
+See {Releasy::Project#add_deploy}
+
+
 CLI Commands
 ------------
 
@@ -135,7 +206,7 @@ Releasy also provides some supplementary commands:
 External Requirements
 ---------------------
 
-### 7-Zip
+### 7-Zip (OS X/Linux only - Windows `7za` executable included in Windows)
 
 The [7z](http://www.7-zip.org) command must be installed on your system for Releasy to work:
 
@@ -147,9 +218,9 @@ The [7z](http://www.7-zip.org) command must be installed on your system for Rele
 
     <pre>sudo apt-get install p7zip-full</pre>
 
-  - Installing on Windows (or other OS)
+  - Installing on other OS
 
-    * [Download 7-Zip](http://www.7-zip.org/download.html) - Either the full version or the command line version will work with Releasy.
+    * [Download 7-Zip](http://www.7-zip.org/download.html)
 
 ### To build `:windows_installer` release (Windows only)
 
@@ -163,6 +234,8 @@ The [7z](http://www.7-zip.org) command must be installed on your system for Rele
 
 [libgosu app wrapper](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.
 
+Warning: "gosu-mac-0.7.41.tar.gz" is NOT the complete OS X app wrapper, but rather just the Gosu gem pre-compiled for OS X!
+
 Credits
 -------
 
@@ -175,5 +248,5 @@ Credits
 Third Party Assets included
 ---------------------------
 
-* bin/7z.sfx - Windows [7z 9.20](http://www.7-zip.org) self-extractor module, which can be installed using `releasy install-sfx` [License: [GNU LGPL](http://www.7-zip.org/license.txt)]
-
+* bin/7z.sfx - Windows [7-ZIP](http://www.7-zip.org) self-extractor module, which can be installed using `releasy install-sfx` [License: [GNU LGPL](http://www.7-zip.org/license.txt)]
+* bin/7za.exe - Windows [7-ZIP](http://www.7-zip.org) CLI executable.

data/Rakefile

@@ -17,7 +17,7 @@ task :test do
   Rake::TestTask.new do |t|
     t.libs << "test"
     t.pattern = "test/**/*_test.rb"
-    t.verbose = true
+    # t.options = "--verbose" # Add --verbose to run full descriptive list.
   end
 end
 

data/bin/7z_sfx_LICENSE.txt

@@ -0,0 +1,56 @@
+  7-Zip
+  ~~~~~
+  License for use and distribution
+  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+  7-Zip Copyright (C) 1999-2010 Igor Pavlov.
+
+  Licenses for files are:
+
+    1) 7z.dll: GNU LGPL + unRAR restriction
+    2) All other files:  GNU LGPL
+
+  The GNU LGPL + unRAR restriction means that you must follow both 
+  GNU LGPL rules and unRAR restriction rules.
+
+
+  Note: 
+    You can use 7-Zip on any computer, including a computer in a commercial 
+    organization. You don't need to register or pay for 7-Zip.
+
+
+  GNU LGPL information
+  --------------------
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    Lesser General Public License for more details.
+
+    You can receive a copy of the GNU Lesser General Public License from 
+    http://www.gnu.org/
+
+
+  unRAR restriction
+  -----------------
+
+    The decompression engine for RAR archives was developed using source 
+    code of unRAR program.
+    All copyrights to original unRAR code are owned by Alexander Roshal.
+
+    The license for original unRAR code has the following restriction:
+
+      The unRAR sources cannot be used to re-create the RAR compression algorithm, 
+      which is proprietary. Distribution of modified unRAR sources in separate form 
+      or as a part of other software is permitted, provided that it is clearly
+      stated in the documentation and source comments that the code may
+      not be used to develop a RAR (WinRAR) compatible archiver.
+
+
+  --
+  Igor Pavlov

data/bin/7za_exe_LICENSE.txt

@@ -0,0 +1,29 @@
+      7-Zip Command line version
+      ~~~~~~~~~~~~~~~~~~~~~~~~~~
+      License for use and distribution
+      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+      7-Zip Copyright (C) 1999-2010 Igor Pavlov.
+
+      7za.exe is distributed under the GNU LGPL license
+
+      Notes: 
+        You can use 7-Zip on any computer, including a computer in a commercial 
+        organization. You don't need to register or pay for 7-Zip.
+
+
+      GNU LGPL information
+      --------------------
+
+        This library is free software; you can redistribute it and/or
+        modify it under the terms of the GNU Lesser General Public
+        License as published by the Free Software Foundation; either
+        version 2.1 of the License, or (at your option) any later version.
+
+        This library is distributed in the hope that it will be useful,
+        but WITHOUT ANY WARRANTY; without even the implied warranty of
+        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+        Lesser General Public License for more details.
+
+        You can receive a copy of the GNU Lesser General Public License from 
+        http://www.gnu.org/

data/lib/releasy.rb

@@ -4,11 +4,14 @@ $LOAD_PATH.unshift File.expand_path("..", __FILE__)
 
 # Application release manager.
 module Releasy
-  def self.win_platform?; RUBY_PLATFORM =~ /mingw|win32/; end
+  def self.win_platform?; !!(RUBY_PLATFORM =~ /mingw|win32/); end
 
   # An error caused when Releasy configuration is incorrect or inconsistent.
   class ConfigError < StandardError; end
 
+  # Failed to find a particular CLI command on the system.
+  class CommandNotFoundError < StandardError; end
+
   # Modules used to extend Releasy classes.
   module Mixins; end
 end

data/lib/releasy/builders/builder.rb

@@ -1,21 +1,29 @@
 require "releasy/mixins/has_packagers"
-require "releasy/mixins/exec"
+require "releasy/mixins/utilities"
 require "releasy/mixins/log"
 
 module Releasy
 module Builders
   # Builds release folders.
   # @abstract
+  #
+  # @attr suffix [String] Suffix on the folder generated, after name and version.
   class Builder
     include Rake::DSL
     include Mixins::HasPackagers
-    include Mixins::Exec
+    include Mixins::Utilities
     include Mixins::Log
 
     # @return [Project] that this Builder belongs to.
     attr_reader :project
-    # @return [String] Suffix on the folder generated, after name and version.
-    attr_accessor :folder_suffix
+
+    attr_reader :suffix
+    def suffix=(suffix)
+      raise TypeError, "suffix must be a String" unless suffix.is_a? String
+      @suffix = suffix
+    end
+    alias_method :folder_suffix, :suffix
+    alias_method :folder_suffix=, :suffix=
 
     # @return [Symbol] Type of builder.
     def type; self.class::TYPE; end
@@ -26,7 +34,7 @@ module Builders
     def initialize(project)
       super()
       @project = project
-      @folder_suffix = self.class::DEFAULT_FOLDER_SUFFIX
+      @suffix = self.class::DEFAULT_FOLDER_SUFFIX
       setup
     end
 
@@ -34,7 +42,7 @@ module Builders
     # @return [String] Called from the project, but users don't need to know about it.
     def task_group; type.to_s.split(/_/).first; end
     # @return [String] Output folder.
-    def folder; "#{project.folder_base}#{folder_suffix.empty? ? '' : '_'}#{folder_suffix}"; end
+    def folder; "#{project.folder_base}#{suffix.empty? ? '' : '_'}#{suffix}"; end
 
     protected
     # Called by {#initalize}

data/lib/releasy/builders/ocra_builder.rb

@@ -2,14 +2,16 @@ require "releasy/builders/windows_builder"
 
 module Releasy
 module Builders
-  # Functionality for a {WindowsBuilder} that use Ocra and runs on Windows.
+  # Functionality for a {WindowsBuilder} that use Ocra to build on Windows.
+  #
   # @attr icon [String] Optional filename of icon to show on executable/installer (.ico).
+  #
   # @abstract
   class OcraBuilder < WindowsBuilder
     OCRA_COMMAND = "ocra"
     ICON_EXTENSION = ".ico"
 
-    # @return [String] Extra options to send to Ocra (Windows outputs only).
+    # @return [String] Extra options to send to Ocra, but they are unlikely to be needed explicitly. '_--no-enc_' is automatically used if {#exclude_encoding} is called and '_--console_' or '_--window_' is used based on {#executable_type}
     attr_accessor :ocra_parameters
 
     def valid_for_platform?; Releasy.win_platform?; end