releasy 0.2.0 → 0.2.2

data/lib/releasy/builders/osx_app.rb

@@ -6,6 +6,18 @@ module Releasy
   module Builders
     # Builds an OS X application bundle.
     #
+    # @example
+    #   Releasy::Project.new do
+    #     name "My App"
+    #     add_build :osx_app do
+    #       wrapper "gosu-mac-wrapper-0.7.41.tar.gz" # Required, see {#wrapper=}.
+    #       url "com.cheese.myapp"                   # Required
+    #       icon "media/icon.icns"                   # Optional
+    #       exclude_encoding                         # Optional
+    #       add_package :dmg                         # Optional
+    #     end
+    #   end
+    #
     # @attr icon [String] Optional filename of icon to show on executable/installer (.icns).
     class OsxApp < Builder
       include Mixins::HasGemspecs
@@ -49,13 +61,12 @@ module Releasy
         raise ConfigError, "#wrapper not set" unless wrapper
         raise ConfigError, "#wrapper not valid wrapper: #{wrapper}" unless File.basename(wrapper) =~ VALID_GOSU_WRAPPER
 
-        directory folder
-
         desc "Build OS X app"
         task "build:osx:app" => folder
 
         file folder => project.files + [wrapper] do
-           build
+          mkdir_p folder, fileutils_options
+          build
         end
       end
 
@@ -66,7 +77,7 @@ module Releasy
         new_app = File.join folder, app_name
 
         # Copy the app files.
-        exec %[7z x -so -bd "#{wrapper}" | 7z x -si -mmt -bd -ttar -o"#{folder}"]
+        execute_command %[7z x -so -bd "#{wrapper}" 2>#{null_file} | 7z x -si -mmt -bd -ttar -o"#{folder}"]
         mv File.join(folder, "RubyGosu App.app"), new_app, fileutils_options
 
         ## Copy my source files.
@@ -156,10 +167,11 @@ 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
+  BINARY = UTF_7 = UTF_16BE = UTF_16LE = UTF_32BE = UTF_32LE = Encoding.list.first
 end
 
-load 'application/#{project.executable}'
+Dir.chdir 'application'
+load '#{project.executable}'
 END_TEXT
         end
       end

data/lib/releasy/builders/source.rb

@@ -3,6 +3,14 @@ require "releasy/builders/builder"
 module Releasy
   module Builders
     # Creates a folder containing the application source.
+    #
+    # @example
+    #   Releasy::Project.new do
+    #     name "My App"
+    #     add_build :source do
+    #       add_package :zip       # Optional.
+    #     end
+    #   end
     class Source < Builder
       TYPE = :source
       Builders.register self
@@ -14,9 +22,8 @@ module Releasy
         desc "Build source"
         task "build:source" => folder
 
-        directory folder
-
         file folder => project.files do
+          mkdir_p folder, fileutils_options
           copy_files_relative project.files, folder
         end
       end

data/lib/releasy/builders/windows_folder.rb

@@ -4,6 +4,16 @@ 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.
+    #
+    # @example
+    #   Releasy::Project.new do
+    #     name "My App"
+    #     add_build :windows_folder do
+    #       icon "media/icon.ico"  # Optional
+    #       exclude_encoding       # Optional
+    #       add_package :zip       # Optional
+    #     end
+    #   end
     class WindowsFolder < OcraBuilder
       TYPE = :windows_folder
       DEFAULT_FOLDER_SUFFIX = "WIN32"
@@ -13,12 +23,11 @@ module Releasy
       protected
       # FOLDER containing EXE, Ruby + source.
       def generate_tasks
-        directory project.output_path
-
         file folder => project.files do
+          mkdir_p project.output_path, fileutils_options
           tmp_ocra_executable = "#{folder}.exe"
 
-          exec %[#{ocra_command} --output "#{tmp_ocra_executable}" --debug-extract]
+          execute_command %[#{ocra_command} --output "#{tmp_ocra_executable}" --debug-extract]
 
           # Extract the files from the executable.
           system tmp_ocra_executable

data/lib/releasy/builders/windows_installer.rb

@@ -21,9 +21,8 @@ module Releasy
       protected
       # Regular windows installer, but some users consider them evil.
       def generate_tasks
-        directory folder
-
         file folder => project.files do
+          mkdir_p folder, fileutils_options
           create_link_files folder
           project.exposed_files.each {|file| cp file, folder, fileutils_options }
 
@@ -51,7 +50,7 @@ module Releasy
       protected
       def create_installer(file, options = {})
         generate_installer_script file, options
-        exec %[#{ocra_command} --chdir-first --no-lzma --innosetup "#{temp_installer_script}"]
+        execute_command %[#{ocra_command} --chdir-first --no-lzma --innosetup "#{temp_installer_script}"]
       end
 
       # Generate innosetup script to build installer.

data/lib/releasy/builders/windows_standalone.rb

@@ -5,6 +5,16 @@ module Releasy
     # Creates a completely standalone Windows executable.
     #
     # @note Startup of the executable created by this build takes a couple of seconds longer than running from the other windows builds, as the files are extracted into a temporary directory each time it is run. It is recommended to build with _:windows_folder_ or _:windows_installer_ instead of this, unless you really need to distribute the application as a single file.
+    #
+    # @example
+    #   Releasy::Project.new do
+    #     name "My App"
+    #     add_build :windows_standalone do
+    #       icon "media/icon.ico"  # Optional
+    #       exclude_encoding       # Optional
+    #       add_package :zip       # Optional
+    #     end
+    #   end
     class WindowsStandalone < OcraBuilder
       TYPE = :windows_standalone
       DEFAULT_FOLDER_SUFFIX = "WIN32_EXE"
@@ -14,14 +24,14 @@ module Releasy
       protected
       # Self-extracting standalone executable.
       def generate_tasks
-        directory folder
-
         file folder => project.files do
+          mkdir_p folder, fileutils_options
+
           project.exposed_files.each {|file| cp file, folder, fileutils_options }
 
           create_link_files folder
 
-          exec %[#{ocra_command} --output "#{folder}/#{executable_name}"]
+          execute_command %[#{ocra_command} --output "#{folder}/#{executable_name}"]
         end
 
         desc "Build standalone exe #{project.version} [Ocra]"

data/lib/releasy/builders/windows_wrapped.rb

@@ -11,6 +11,17 @@ module Releasy
     # Limitations:
     #   * Does not DLLs loaded from the system, which will have to be included manually if any are required by the application and no universally available in Windows installations.
     #   * Unless a gem is in pure Ruby or available as a pre-compiled binary gem, it won't work!
+    #
+    # @example
+    #   Releasy::Project.new do
+    #     name "My App"
+    #     add_build :windows_wrapped do
+    #       wrapper "ruby-1.9.3-p0-i386-mingw32.7z" # Required
+    #       exclude_encoding                        # Optional
+    #       exclude_tcl_tk                          # Optional
+    #       add_package :zip                        # Optional
+    #     end
+    #   end
     class WindowsWrapped < WindowsBuilder
       include Mixins::HasGemspecs
 
@@ -48,9 +59,8 @@ module Releasy
         raise ConfigError, "#wrapper not set" unless wrapper
         raise ConfigError, "#wrapper not valid wrapper: #{wrapper}" unless File.basename(wrapper) =~ VALID_RUBY_DIST
 
-        directory project.output_path
-
         file folder => project.files + [wrapper] do
+          mkdir_p project.output_path, fileutils_options
           build
         end
 
@@ -104,7 +114,7 @@ module Releasy
       protected
       def copy_ruby_distribution
         archive_name = File.basename(wrapper).chomp(File.extname(wrapper))
-        exec %[7z x "#{wrapper}" -o"#{File.dirname folder}"]
+        execute_command %[7z x "#{wrapper}" -o"#{File.dirname folder}"]
         mv File.join(File.dirname(folder), archive_name), folder, fileutils_options
         rm_r File.join(folder, "share"), fileutils_options
         rm_r File.join(folder, "include"), fileutils_options if File.exists? File.join(folder, "include")
@@ -138,7 +148,7 @@ module Releasy
               # If we have a bundle file specified, then gem will _only_ install the version specified by it and not the one we request.
               bundle_gemfile = ENV['BUNDLE_GEMFILE']
               ENV['BUNDLE_GEMFILE'] = ''
-              exec %[gem install "#{spec.name}" --remote --no-rdoc --no-ri --force --ignore-dependencies --platform "#{windows_platform}" --version "#{spec.version}" --install-dir "#{destination}"]
+              execute_command %[gem install "#{spec.name}" --remote --no-rdoc --no-ri --force --ignore-dependencies --platform "#{windows_platform}" --version "#{spec.version}" --install-dir "#{destination}"]
               ENV['BUNDLE_GEMFILE'] = bundle_gemfile
               binary_gems << spec.name
             end

data/lib/releasy/cli/install_sfx.rb

@@ -53,7 +53,7 @@ Releasy::Cli.define_command do
         if ENV["USER"] != "root"
           command = %[sudo cp "#{sfx_path}" "#{assets_location}"]
           puts "Copy failed, trying again as super-user:\n#{command}"
-          exec command
+          system command
           if File.exists? destination_file
             puts "#{sfx_file} copied to #{assets_location}"
           else

data/lib/releasy/deployers.rb

@@ -7,6 +7,6 @@ module Releasy
   end
 end
 
-%w[github].each do |deployer|
+%w[github local rsync].each do |deployer|
   require "releasy/deployers/#{deployer}"
 end

data/lib/releasy/deployers/deployer.rb

@@ -1,5 +1,6 @@
 require "releasy/mixins/log"
 
+
 module Releasy
   module Deployers
     # @abstract
@@ -7,6 +8,9 @@ module Releasy
       include Rake::DSL
       include Mixins::Log
 
+      # Printed out while file is being transferred.
+      WORKING_CHARACTER = "."
+
       attr_reader :project
 
       def type; self.class::TYPE; end
@@ -20,9 +24,26 @@ module Releasy
       def generate_tasks(archive_task, folder, extension)
         desc "#{type} <= #{archive_task.split(":")[0..-2].join(" ")} #{extension}"
         task "deploy:#{archive_task}:#{type}" => "package:#{archive_task}" do
-          deploy(folder + extension)
+          do_deploy(folder + extension)
         end
       end
+
+      protected
+      def do_deploy(file)
+        heading "Deploying #{file} (#{(File.size(file).fdiv 1024).ceil}k) to #{self.class.name[/[^:]+$/]}"
+
+        t = Time.now
+
+        deploy file
+
+        minutes, seconds = (Time.now - t).ceil.divmod 60
+        hours, minutes = minutes.divmod 60
+        duration = "%d:%02d:%02d" % [hours, minutes, seconds]
+
+        heading "Successfully deployed file in #{duration}"
+
+        nil
+      end
     end
   end
 end

data/lib/releasy/deployers/github.rb

@@ -4,131 +4,45 @@ module Releasy
   module Deployers
     # Deploys to a Github project's downloads page.
     #
-    # @attr description [String] Description of file (defaults to: "#{project.description")
-    # @attr login [String] Github user name that has write access to {#repository} (defaults to: `git config github.user` or user name in `git config remote.origin.url`).
-    # @attr repository [String] Name of Github repository (defaults to: the repository name in `git config remote.origin.url` or _project.underscored_name_).
-    # @attr token [String] Github token associated with {#login} - a 32-digit hexadecimal string - DO NOT COMMIT A FILE CONTAINING YOUR GITHUB TOKEN (defaults to: `git config github.token`)
+    # @example
+    #   Releasy::Project.new do
+    #     name "My App"
+    #     add_build :source
+    #     add_package :zip
+    #     add_deploy :github # Should be enough if git is configured correctly.
+    #   end
+    #
+    # @attr description [String] (project.description) Description of file.
+    # @attr user [String] (`git config github.user` or user name in `git config remote.origin.url`) Github user name that has write access to {#repository}
+    # @attr repository [String] (repository name in `git config remote.origin.url` or _project.underscored_name_) Name of Github repository.
+    # @attr token [String] (`git config github.token`) Github token associated with {#user} - a 32-digit hexadecimal string - DO NOT COMMIT A FILE CONTAINING YOUR GITHUB TOKEN!
     class Github < Deployer
-      # Patch to add an asynchronous version of upload, that also yields every second and takes into account timeout.
-      module UploaderUploadAsync
-        def upload_async(info)
-          unless info[:repos]
-            raise "required repository name"
-          end
-          info[:repos] = @login + '/' + info[:repos] unless info[:repos].include? '/'
-
-          if info[:file]
-            file = info[:file]
-            unless File.exist?(file) && File.readable?(file)
-              raise "file does not exsits or readable"
-            end
-            info[:name] ||= File.basename(file)
-          end
-          unless  info[:file] || info[:data]
-            raise "required file or data parameter to upload"
-          end
-
-          unless info[:name]
-            raise "required name parameter for filename with data parameter"
-          end
-
-          if info[:replace]
-            list_files(info[:repos]).each { |obj|
-              next unless obj[:name] == info[:name]
-              delete info[:repos], obj[:id]
-            }
-          elsif list_files(info[:repos]).any?{|obj| obj[:name] == info[:name]}
-            raise "file '#{info[:name]}' is already uploaded. please try different name"
-          end
-
-          info[:content_type] ||= 'application/octet-stream'
-          stat = HTTPClient.post("https://github.com/#{info[:repos]}/downloads", {
-              "file_size"    => info[:file] ? File.stat(info[:file]).size : info[:data].size,
-              "content_type" => info[:content_type],
-              "file_name"    => info[:name],
-              "description"  => info[:description] || '',
-              "login"        => @login,
-              "token"        => @token
-          })
-
-          unless stat.code == 200
-            raise "Failed to post file info"
-          end
-
-          upload_info = JSON.parse(stat.content)
-          if info[:file]
-            f = File.open(info[:file], 'rb')
-          else
-            f = Tempfile.open('net-github-upload')
-            f << info[:data]
-            f.flush
-          end
-
-          client = HTTPClient.new
-          client.send_timeout = info[:upload_timeout] if info[:upload_timeout]
-
-          res = begin
-            connection = client.post_async("http://github.s3.amazonaws.com/", [
-                ['Filename', info[:name]],
-                ['policy', upload_info['policy']],
-                ['success_action_status', 201],
-                ['key', upload_info['path']],
-                ['AWSAccessKeyId', upload_info['accesskeyid']],
-                ['Content-Type', upload_info['content_type'] || 'application/octet-stream'],
-                ['signature', upload_info['signature']],
-                ['acl', upload_info['acl']],
-                ['file', f]
-            ])
-
-            until connection.finished?
-              yield if block_given?
-              sleep info[:yield_interval] || 1
-            end
-
-            connection.pop
-          ensure
-            f.close
-          end
-
-          if res.status == 201
-            return FasterXmlSimple.xml_in(res.body.read)['PostResponse']['Location']
-          else
-            raise 'Failed to upload' + extract_error_message(res.body)
-          end
-        end
-      end
-
-
       TYPE = :github
       # Maximum time to allow an upload to continue. An hour to upload a file isn't unreasonable. Better than the default 2 minutes, which uploads about 4MB for me.
       UPLOAD_TIMEOUT = 60 * 60
 
       Deployers.register self
 
-      def repository
-        @repository || project.underscored_name
-      end
+      def repository; @repository || project.underscored_name; end
       def repository=(repository)
         raise TypeError, "repository must be a String, but received #{repository.class}" unless repository.is_a? String
         @repository = repository
       end
 
-      attr_reader :user
+      def user; @user; end
       def user=(user)
         raise TypeError, "user must be a String, but received #{user.class}" unless user.is_a? String
         @user = user
       end
 
-      attr_reader :token
+      def token; @token; end
       def token=(token)
         raise TypeError, "token must be a String, but received #{token.class}" unless token.is_a? String
         raise ArgumentError, "token invalid (expected 32-character hex string)" unless token =~ /^[0-9a-f]{32}$/i
         @token = token
       end
 
-      def description
-        @description || project.description
-      end
+      def description; @description || project.description; end
       def description=(description)
         raise TypeError, "description must be a String, but received #{description.class}" unless description.is_a? String
         @description = description
@@ -164,44 +78,37 @@ module Releasy
       # @param key [String] Name of setting in git config.
       # @return [String, nil] Value of setting, else nil if it isn't defined.
       def from_config(key)
-        `git config #{key}`.chomp rescue nil
+        Kernel.`("git config #{key}").chomp rescue nil
       end
 
       protected
       # @param file [String] Path to file to deploy.
-      # @return [String] A link to download the file.
-      # @raise SystemError If file fails to upload.
+      # @return [nil]
       def deploy(file)
         raise ConfigError, "#user must be set manually if it is not configured on the system" unless user
         raise ConfigError, "#token must be set manually if it is not configured on the system" unless token
 
+        info %[Uploading to: https://github.com/downloads/#{user}/#{repository}/#{File.basename(file)}]
+
         # Hold off requiring this unless needed, so it doesn't slow down creating tasks.
-        if require 'net/github-upload'
-          Net::GitHub::Upload.send :include, UploaderUploadAsync
-        end
+        require 'net/github-upload'
 
         uploader = Net::GitHub::Upload.new(:login => user, :token => token)
 
-        heading "Deploying #{file} (#{(File.size(file).fdiv 1024).ceil}k) to Github"
-
-        t = Time.now
-
         begin
-          uploader.upload_async :repos => repository, :file => file, :description => description, :replace => @force_replace, :upload_timeout => UPLOAD_TIMEOUT do
-            print '.'
+          uploader.upload :repos => repository, :file => file, :description => description, :replace => @force_replace, :upload_timeout => UPLOAD_TIMEOUT do
+            print WORKING_CHARACTER unless log_level == :silent
+          end
+          info WORKING_CHARACTER
+        rescue RuntimeError => ex
+          if ex.message =~ /file .* is already uploaded/i
+            warn "Skipping '#{File.basename file}' as it is already uploaded. Use #replace! to force uploading"
+          else
+            raise ex
           end
-          puts '.'
-        rescue => ex
-          # Probably failed to overwrite an existing file.
-          error "Error uploading file #{file}: #{ex.message}"
-          exit 1 # This is bad. Lets just die, die, die at this point.
         end
 
-        link = "https://github.com/downloads/#{user}/#{repository}/#{File.basename(file)}"
-        time = "%d:%02d" % (Time.now - t).ceil.divmod(60)
-        heading %[Successfully uploaded to "#{link}" in #{time}]
-
-        link
+        nil
       end
     end
   end