releasy 0.2.0rc1 → 0.2.0rc2

data/CHANGELOG.md

@@ -10,7 +10,7 @@ v0.2.0
   * 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).
+  * Added `:windows_wrapped` 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.

data/README.md

@@ -3,120 +3,126 @@ 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.
+when there is a need to build, archive and/or deploy 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).
+Releasy allows cross-platform releases, relying on OS X or Windows "wrappers" to act as templates.
 
 * 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!
+* 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!
 
-Output types supported
+Build types supported
 ----------------------
 
-The project can create one or more release folders:
+The project can build 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]
+* `: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].
 
-Archive types supported
+Package types supported
 -----------------------
 
-Optionally, release folders can be archived using one or more of:
+Optionally, release folders can be packaged into an archive 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)
+* `: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
+----------------------
+
+Optionally, packaged releases can be deployed using one or more of:
+
+* `:github` - Upload to Github downloads.
+* Others, such as `:dropbox`, when I get around to implementing them.
 
 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'
+    require 'lib/my_application/version'
 
     #<<<
     Releasy::Project.new do
-      name "Alpha Channel"
-      version AlphaChannel::VERSION
+      name "My Application"
+      version MyApplication::VERSION
 
-      executable "bin/alpha_channel.rbw"
+      executable "bin/my_application.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"
+      add_link "http://my_application.github.com", "My Application website"
+      exclude_encoding
 
       # Create a variety of releases, for all platforms.
       add_build :osx_app do
-        add_archive :tar_gz
-        url "com.github.spooner.games.alpha_channel"
+        url "com.github.my_application"
         wrapper "../osx_app/gosu-mac-wrapper-0.7.41.tar.gz"
         icon "media/icon.icns"
+        add_package :tar_gz
       end
 
-      add_build :source
+      add_build :source do
+        add_package :zip
+      end
 
       add_build :windows_folder do
         icon "media/icon.ico"
-        add_archive :exe
-        exclude_encoding
+        add_package :exe
       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.
+        add_package :zip
       end
 
-      add_archive :zip # All outputs given this archive format.
+      add_deploy :github # Upload to a github project.
     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...
+The `windows:wrapped` task will not be created if running on Windows.
+
+    rake build                                # Build My Application 1.4.0
+    rake build:osx                            # Build all osx
+    rake build:osx:app                        # Build OS X app
+    rake build:source                         # Build source
+    rake build:windows                        # Build all windows
+    rake build:windows:folder                 # Build windows folder
+    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:windows:folder:exe:github     # github <= windows folder .exe
+    rake deploy:windows:installer:exe: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: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).
 
 CLI Commands
 ------------
@@ -126,12 +132,12 @@ 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)
---------------------------------
+External Requirements
+---------------------
 
-### To create package archives (except `:dmg`)
+### 7-Zip
 
-[7z](http://www.7-zip.org) must be installed.
+The [7z](http://www.7-zip.org) command must be installed on your system for Releasy to work:
 
   - Installing on OS X homebrew:
 
@@ -143,11 +149,19 @@ External Requirements (Optional, but recommended)
 
   - Installing on Windows (or other OS)
 
-    * [Download](http://www.7-zip.org/download.html)
+    * [Download 7-Zip](http://www.7-zip.org/download.html) - Either the full version or the command line version will work with Releasy.
+
+### To build `:windows_installer` release (Windows only)
+
+[InnoSetup](http://www.jrsoftware.org/isdl.php) is used to create an installer for the application.
+
+### To build `:windows_wrapped` release (OS X/Linux)
+
+[RubyInstaller 7-ZIP archives](http://rubyinstaller.org/downloads/) for Ruby 1.8.7, 1.9.2 or 1.9.3. Used as a wrapper for a Windows release built on non-Windows systems.
 
-### To create `:windows_installer` output (Windows only)
+### To build `:osx_app` application bundle release (any platform)
 
-[InnoSetup](http://www.jrsoftware.org/isdl.php) must be installed.
+[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.
 
 Credits
 -------
@@ -161,5 +175,5 @@ Credits
 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)]
+* 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)]
 

data/Rakefile

@@ -17,7 +17,7 @@ task :test do
   Rake::TestTask.new do |t|
     t.libs << "test"
     t.pattern = "test/**/*_test.rb"
-    t.verbose = false
+    t.verbose = true
   end
 end
 

data/lib/releasy/builders.rb

@@ -7,6 +7,6 @@ module Releasy
   end
 end
 
-%w[osx_app source windows_folder windows_folder_from_ruby_dist windows_installer windows_standalone].each do |builder|
+%w[osx_app source windows_folder windows_wrapped windows_installer windows_standalone].each do |builder|
   require "releasy/builders/#{builder}"
 end

data/lib/releasy/builders/builder.rb

@@ -1,5 +1,6 @@
-require "releasy/mixins/has_archivers"
+require "releasy/mixins/has_packagers"
 require "releasy/mixins/exec"
+require "releasy/mixins/log"
 
 module Releasy
 module Builders
@@ -7,8 +8,9 @@ module Builders
   # @abstract
   class Builder
     include Rake::DSL
-    include Mixins::HasArchivers
+    include Mixins::HasPackagers
     include Mixins::Exec
+    include Mixins::Log
 
     # @return [Project] that this Builder belongs to.
     attr_reader :project
@@ -43,8 +45,8 @@ module Builders
     def copy_files_relative(files, folder)
       files.each do |file|
         destination = File.join(folder, File.dirname(file))
-        mkdir_p destination unless File.exists? destination
-        cp file, destination
+        mkdir_p destination, fileutils_options unless File.exists? destination
+        cp file, destination, fileutils_options
       end
     end
   end

data/lib/releasy/builders/osx_app.rb

@@ -1,5 +1,6 @@
 require "releasy/builders/builder"
 require "releasy/mixins/has_gemspecs"
+require "releasy/mixins/can_exclude_encoding"
 
 module Releasy
   module Builders
@@ -8,6 +9,7 @@ module Releasy
     # @attr icon [String] Optional filename of icon to show on executable/installer (.icns).
     class OsxApp < Builder
       include Mixins::HasGemspecs
+      include Mixins::CanExcludeEncoding
 
       TYPE = :osx_app
 
@@ -20,6 +22,11 @@ module Releasy
       # Source gems included in app that we should remove.
       SOURCE_GEMS_TO_REMOVE = %w[chingu]
 
+      # Encoding files that are required, even if we don't need most of them if we select to {#exclude_encoding}.
+      REQUIRED_ENCODING_FILES = %w[encdb.bundle iso_8859_1.bundle utf_16le.bundle trans/single_byte.bundle trans/transdb.bundle trans/utf_16_32.bundle]
+
+      VALID_GOSU_WRAPPER = /gosu-mac-wrapper-\d\.\d\.\d+.tar.gz/
+
       Builders.register self
 
       # @return [String] Name of .app directory used as the framework for osx app release.
@@ -31,17 +38,16 @@ module Releasy
       attr_reader :icon
 
       def icon=(icon)
-        raise ConfigError, "icon must be a #{ICON_EXTENSION} file" unless File.extname(icon) == ICON_EXTENSION
+        raise ArgumentError, "icon must be a #{ICON_EXTENSION} file" unless File.extname(icon) == ICON_EXTENSION
         @icon = icon
       end
 
       protected
       def generate_tasks
         raise ConfigError, "#url not set" unless url
+        raise ConfigError, "#url not valid: #{url}" unless url =~ /\w+(\.\w+)*/i
         raise ConfigError, "#wrapper not set" unless wrapper
-        raise ConfigError, "#wrapper not valid wrapper: #{wrapper}" unless File.basename(wrapper) =~ /gosu-mac-wrapper-[\d\.]+.tar.gz/
-
-        new_app = File.join folder, app_name
+        raise ConfigError, "#wrapper not valid wrapper: #{wrapper}" unless File.basename(wrapper) =~ VALID_GOSU_WRAPPER
 
         directory folder
 
@@ -49,26 +55,35 @@ module Releasy
         task "build:osx:app" => folder
 
         file folder => project.files + [wrapper] do
-          Rake::FileUtilsExt.verbose project.verbose?
+           build
+        end
+      end
 
-          # Copy the app files.
-          exec %[7z x -so -bd "#{wrapper}" | 7z x -si -mmt -bd -ttar -o"#{folder}"]
-          mv File.join(folder, "RubyGosu App.app"), new_app
+      protected
+      def build
+        raise ConfigError, "#wrapper file does not exist: #{wrapper}" unless File.exists? wrapper
 
-          ## Copy my source files.
-          copy_files_relative project.files, File.join(new_app, 'Contents/Resources/application')
+        new_app = File.join folder, app_name
 
-          # Copy accompanying files.
-          project.exposed_files.each {|file| cp file, folder }
+        # Copy the app files.
+        exec %[7z x -so -bd "#{wrapper}" | 7z x -si -mmt -bd -ttar -o"#{folder}"]
+        mv File.join(folder, "RubyGosu App.app"), new_app, fileutils_options
 
-          copy_gems vendored_gem_names(BINARY_GEMS), File.join(new_app, 'Contents/Resources/vendor')
-          create_main new_app
-          edit_init new_app
-          remove_gems new_app
-          rename_executable new_app
-          update_icon new_app
-          create_executable_setter
-        end
+        ## Copy my source files.
+        copy_files_relative project.files, File.join(new_app, 'Contents/Resources/application')
+
+        remove_encoding if encoding_excluded?
+
+        # Copy accompanying files.
+        project.exposed_files.each {|file| cp file, folder, fileutils_options }
+
+        copy_gems vendored_gem_names(BINARY_GEMS), File.join(new_app, 'Contents/Resources/vendor')
+        create_main new_app
+        edit_init new_app
+        remove_gems new_app
+        rename_executable new_app
+        update_icon new_app
+        create_executable_setter
       end
 
       protected
@@ -97,33 +112,40 @@ END
         end
       end
 
+      protected
+      def remove_encoding
+        encoding_files = Dir[File.join folder, "#{app_name}/Contents/Resources/lib/enc/**/*.bundle"]
+        required_encoding_files = REQUIRED_ENCODING_FILES.map {|f| File.join folder, "#{app_name}/Contents/Resources/lib/enc", f }
+        rm_r encoding_files - required_encoding_files, fileutils_options
+      end
+
       protected
       def rename_executable(app)
         new_executable = "#{app}/Contents/MacOS/#{project.name}"
-        mv "#{app}/Contents/MacOS/RubyGosu App" , new_executable
-        chmod 0755, new_executable
+        mv "#{app}/Contents/MacOS/RubyGosu App" , new_executable, fileutils_options
+        chmod 0755, new_executable, fileutils_options
       end
 
       protected
       # Remove unnecessary gems from the distribution.
       def remove_gems(app)
         SOURCE_GEMS_TO_REMOVE.each do |gem|
-          rm_r "#{app}/Contents/Resources/lib/#{gem}"
+          rm_r "#{app}/Contents/Resources/lib/#{gem}", fileutils_options
         end
       end
 
       protected
       def update_icon(app)
         if icon
-          rm "#{app}/Contents/Resources/Gosu.icns"
-          cp icon, "#{app}/Contents/Resources"
+          rm "#{app}/Contents/Resources/Gosu.icns", fileutils_options
+          cp icon, "#{app}/Contents/Resources", fileutils_options
         end
       end
 
       protected
       def create_main(app)
         # Something for the .app to run -> just a little redirection file.
-        puts "--- Creating Main.rb" if project.verbose?
+        info "Creating Main.rb"
         File.open("#{app}/Contents/Resources/Main.rb", "w") do |file|
           file.puts <<END_TEXT
 Dir[File.expand_path("../vendor/gems/*/lib", __FILE__)].each do |lib|
@@ -146,7 +168,7 @@ END_TEXT
       def edit_init(app)
         file = "#{app}/Contents/Info.plist"
         # Edit the info file to be specific for my game.
-        puts "--- Editing init" if project.verbose?
+        info "Editing init"
         info = File.read(file)
         info.sub!('<string>Gosu</string>', "<string>#{File.basename(icon).chomp(File.extname(icon))}</string>") if icon
         info.sub!('<string>RubyGosu App</string>', "<string>#{project.name}</string>")

data/lib/releasy/builders/source.rb

@@ -11,14 +11,12 @@ module Releasy
 
       protected
       def generate_tasks
-        desc "Build source folder"
+        desc "Build source"
         task "build:source" => folder
 
         directory folder
 
         file folder => project.files do
-          Rake::FileUtilsExt.verbose project.verbose?
-
           copy_files_relative project.files, folder
         end
       end