releasy 0.2.0rc1

data/lib/releasy/archivers/tar_archiver.rb

@@ -0,0 +1,14 @@
+require "releasy/archivers/archiver"
+
+module Releasy
+module Archivers
+  # An archiver that tars and then compresses the folder.
+  # @abstract
+  class TarArchiver < Archiver
+    protected
+    def command(folder)
+      %[7z a -so -mmt -bd -ttar "#{folder}.tar" "#{folder}" | 7z a -si -bd -t#{self.class::FORMAT} -mx9 "#{folder}#{extension}"]
+    end
+  end
+end
+end

data/lib/releasy/archivers/tar_bzip2.rb

@@ -0,0 +1,13 @@
+require "releasy/archivers/tar_archiver"
+
+module Releasy
+  module Archivers
+    # Archives with tar and Bzip2 formats.
+    class TarBzip2 < TarArchiver
+      TYPE = :tar_bz2
+      DEFAULT_EXTENSION = ".tar.bz2"
+      FORMAT = "bzip2"
+      Archivers.register self
+    end
+  end
+end

data/lib/releasy/archivers/tar_gzip.rb

@@ -0,0 +1,13 @@
+require "releasy/archivers/tar_archiver"
+
+module Releasy
+  module Archivers
+    # Archives with tar and Gzip formats.
+    class TarGzip < TarArchiver
+      TYPE = :tar_gz
+      DEFAULT_EXTENSION = ".tar.gz"
+      FORMAT = "gzip"
+      Archivers.register self
+    end
+  end
+end

data/lib/releasy/archivers/zip.rb

@@ -0,0 +1,12 @@
+require "releasy/archivers/archiver"
+
+module Releasy
+  module Archivers
+    # Archives with zip format. This isn't efficient, but can be decompressed on Windows Vista or later without requiring a 3rd party tool.
+    class Zip < Archiver
+      TYPE = :zip
+      DEFAULT_EXTENSION = ".zip"
+      Archivers.register self
+    end
+  end
+end

data/lib/releasy/builders.rb

@@ -0,0 +1,12 @@
+require 'releasy/mixins/register'
+
+module Releasy
+  # Contains all {Builder} types.
+  module Builders
+    extend Mixins::Register
+  end
+end
+
+%w[osx_app source windows_folder windows_folder_from_ruby_dist windows_installer windows_standalone].each do |builder|
+  require "releasy/builders/#{builder}"
+end

data/lib/releasy/builders/builder.rb

@@ -0,0 +1,52 @@
+require "releasy/mixins/has_archivers"
+require "releasy/mixins/exec"
+
+module Releasy
+module Builders
+  # Builds release folders.
+  # @abstract
+  class Builder
+    include Rake::DSL
+    include Mixins::HasArchivers
+    include Mixins::Exec
+
+    # @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
+
+    # @return [Symbol] Type of builder.
+    def type; self.class::TYPE; end
+
+    # Is the builder valid for the current platform (OS)?
+    def valid_for_platform?; true; end
+
+    def initialize(project)
+      super()
+      @project = project
+      @folder_suffix = self.class::DEFAULT_FOLDER_SUFFIX
+      setup
+    end
+
+    protected
+    # @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
+
+    protected
+    # Called by {#initalize}
+    def setup; end
+
+    protected
+    # Copy a number of files into a folder, maintaining relative paths.
+    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
+      end
+    end
+  end
+end
+end

data/lib/releasy/builders/ocra_builder.rb

@@ -0,0 +1,43 @@
+require "releasy/builders/windows_builder"
+
+module Releasy
+module Builders
+  # Functionality for a {WindowsBuilder} that use Ocra and runs 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).
+    attr_accessor :ocra_parameters
+
+    def valid_for_platform?; Releasy.win_platform?; end
+
+    attr_reader :icon
+    def icon=(icon)
+      raise ArgumentError, "icon must be a #{ICON_EXTENSION} file" unless File.extname(icon) == ICON_EXTENSION
+      @icon = icon
+    end
+
+    protected
+    def setup
+      @icon = nil
+      @ocra_parameters = ""
+      super
+    end
+
+    protected
+    def ocra_command
+      command = defined?(Bundler) ? 'bundle exec ' : ''
+      command += %[#{OCRA_COMMAND} "#{project.executable}" ]
+      command += "--#{effective_executable_type} "
+      command += "--no-enc " if encoding_excluded?
+      command += "#{ocra_parameters} " if ocra_parameters
+      command += %[--icon "#{icon}" ] if icon
+      command += (project.files - [project.executable]).map {|f| %["#{f}"]}.join(" ")
+      command
+    end
+  end
+end
+end

data/lib/releasy/builders/osx_app.rb

@@ -0,0 +1,158 @@
+require "releasy/builders/builder"
+require "releasy/mixins/has_gemspecs"
+
+module Releasy
+  module Builders
+    # Builds an OS X application bundle.
+    #
+    # @attr icon [String] Optional filename of icon to show on executable/installer (.icns).
+    class OsxApp < Builder
+      include Mixins::HasGemspecs
+
+      TYPE = :osx_app
+
+      DEFAULT_FOLDER_SUFFIX = "OSX"
+
+      # Binary gems included in app.
+      BINARY_GEMS = %w[gosu texplay chipmunk]
+      # Icon type used in the app.
+      ICON_EXTENSION = ".icns"
+      # Source gems included in app that we should remove.
+      SOURCE_GEMS_TO_REMOVE = %w[chingu]
+
+      Builders.register self
+
+      # @return [String] Name of .app directory used as the framework for osx app release.
+      attr_accessor :wrapper
+      # @return [String] Inverse url of application (e.g. 'org.supergames.blasterbotsfrommars')
+      attr_accessor :url
+
+      # @return [String] Optional filename of icon to show on app (.icns).
+      attr_reader :icon
+
+      def icon=(icon)
+        raise ConfigError, "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, "#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
+
+        directory folder
+
+        desc "Build OS X app"
+        task "build:osx:app" => folder
+
+        file folder => project.files + [wrapper] do
+          Rake::FileUtilsExt.verbose project.verbose?
+
+          # 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
+
+          ## Copy my source files.
+          copy_files_relative project.files, File.join(new_app, 'Contents/Resources/application')
+
+          # Copy accompanying files.
+          project.exposed_files.each {|file| cp file, folder }
+
+          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
+      end
+
+      protected
+      def setup
+        @icon = nil
+        @url = nil
+        @wrapper = nil
+        super
+      end
+
+      protected
+      def app_name; "#{project.name}.app"; end
+
+      protected
+      def create_executable_setter
+        if Releasy.win_platform?
+          # Ensure that we have a Unixy file by setting binary ("wb") mode on Windows.
+          File.open(File.join(folder, "set_app_executable.sh"), "wb") do |file|
+            file.puts <<END
+#!/bin/sh
+chmod a+x "./#{app_name}/Contents/MacOS/#{project.name}"
+echo "Made #{app_name} executable"
+END
+
+          end
+        end
+      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
+      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}"
+        end
+      end
+
+      protected
+      def update_icon(app)
+        if icon
+          rm "#{app}/Contents/Resources/Gosu.icns"
+          cp icon, "#{app}/Contents/Resources"
+        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?
+        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|
+  $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/#{project.executable}'
+END_TEXT
+        end
+      end
+
+      protected
+      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 = 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>")
+        info.sub!('<string>org.libgosu.UntitledGame</string>', "<string>#{url}</string>")
+        File.open(file, "w") {|f| f.puts info }
+      end
+    end
+  end
+end

data/lib/releasy/builders/source.rb

@@ -0,0 +1,27 @@
+require "releasy/builders/builder"
+
+module Releasy
+  module Builders
+    # Creates a folder containing the application source.
+    class Source < Builder
+      TYPE = :source
+      Builders.register self
+
+      DEFAULT_FOLDER_SUFFIX = "SOURCE"
+
+      protected
+      def generate_tasks
+        desc "Build source folder"
+        task "build:source" => folder
+
+        directory folder
+
+        file folder => project.files do
+          Rake::FileUtilsExt.verbose project.verbose?
+
+          copy_files_relative project.files, folder
+        end
+      end
+    end
+  end
+end

data/lib/releasy/builders/windows_builder.rb

@@ -0,0 +1,65 @@
+require "releasy/builders/builder"
+
+module Releasy
+module Builders
+  # General functionality for Windows builders.
+  # @abstract
+  # @attr icon [String] Optional filename of icon to show on executable/installer (.ico).
+  class WindowsBuilder < Builder
+    EXECUTABLE_TYPES = [:auto, :windows, :console]
+
+    # @return [:auto, :windows, :console] Type of ruby to run executable with. :console means run with 'ruby.exe', :windows means run with 'rubyw.exe',  :auto means determine type from executable extension (.rb => :console or .rbw => :windows).
+    attr_accessor :executable_type
+
+    # Excludes encoding files from 1.9 releases (equivalent to using '--no-enc' in Ocra).
+    def exclude_encoding
+       @exclude_encoding = true
+    end
+
+    # Should encoding files be excluded?
+    def encoding_excluded?; @exclude_encoding; end
+    protected :encoding_excluded?
+
+    # Executable type, resolving :auto if possible.
+    # @return [:windows, :console]
+    def effective_executable_type
+      if executable_type == :auto
+        case File.extname(project.executable)
+          when '.rbw'
+            :windows
+          when '.rb'
+            :console
+          else
+            raise ConfigError, "Unless the executable file extension is .rbw or .rb, then #executable_type must be explicitly :windows or :console"
+        end
+      else
+        executable_type
+      end
+    end
+
+    protected
+    def setup
+      @exclude_encoding = false
+      @executable_type = :auto
+      super
+    end
+
+    protected
+    def create_link_files(dir)
+      project.send(:links).each_pair do |url, title|
+        create_link_file url, File.join(dir, title)
+      end
+    end
+
+    protected
+    def create_link_file(url, title)
+      File.open("#{title}.url", "w") do |file|
+        file.puts <<END
+[InternetShortcut]
+URL=#{url}
+END
+      end
+    end
+  end
+end
+end

data/lib/releasy/builders/windows_folder.rb

@@ -0,0 +1,47 @@
+require "releasy/builders/ocra_builder"
+require 'releasy/windows_wrapper_maker'
+
+module Releasy
+  module Builders
+    # Builds a folder containing Ruby + your source + a small Windows executable to run your executable script.
+    class WindowsFolder < OcraBuilder
+      TYPE = :windows_folder
+      DEFAULT_FOLDER_SUFFIX = "WIN32"
+
+      Builders.register self
+
+      protected
+      # FOLDER containing EXE, Ruby + source.
+      def generate_tasks
+        directory project.output_path
+
+        file folder => project.files do
+          Rake::FileUtilsExt.verbose project.verbose?
+
+          tmp_ocra_executable = "#{folder}.exe"
+
+          exec %[#{ocra_command} --output "#{tmp_ocra_executable}" --debug-extract]
+
+          # Extract the files from the executable.
+          system tmp_ocra_executable
+          rm tmp_ocra_executable
+
+          mv Dir["#{File.dirname(folder)}/ocr*\.tmp"].first, folder
+
+          maker = Releasy::WindowsWrapperMaker.new
+          maker.build_executable("#{folder}/#{executable_name}", "src/#{project.executable}",
+                                  :icon => icon, :windows => (effective_executable_type == :windows))
+
+          create_link_files folder
+          project.exposed_files.each {|file| cp file, folder }
+        end
+
+        desc "Build source/exe folder #{project.version}"
+        task "build:windows:folder" => folder
+      end
+
+      protected
+      def executable_name; "#{project.underscored_name}.exe"; end
+    end
+  end
+end