releasy 0.2.0 → 0.2.2

data/lib/releasy/deployers/local.rb

@@ -0,0 +1,55 @@
+require 'releasy/deployers/deployer'
+
+module Releasy
+  module Deployers
+    # Deploys (copies) to a local destination, such as into your Dropbox folder.
+    #
+    # @example
+    #   Releasy::Project.new do
+    #     name "My App"
+    #     add_build :source
+    #     add_package :zip
+    #     add_deploy :local do
+    #       path "C:/Users/X/Dropbox/Public" # Required.
+    #     end
+    #   end
+    #
+    # @attr path [String] Path to copy files to.
+    class Local < Deployer
+      TYPE = :local
+
+      Deployers.register self
+
+      attr_reader :path
+      def path=(path)
+        raise TypeError, "path must be a String, but received #{path.class}" unless path.is_a? String
+        @path = path
+      end
+
+      protected
+      def setup
+        @path = nil
+      end
+
+      protected
+      # @param file [String] Path to file to deploy.
+      # @return [nil]
+      def deploy(file)
+        raise ConfigError, "#path must be set" unless path
+
+        destination = File.join path, File.basename(file)
+        raise ConfigError, "#path is same as build directory" if File.expand_path(destination) == File.expand_path(file)
+
+        # If destination file already exists or is as new as the one we are going to copy over it, don't bother.
+        if (not File.exists?(destination)) or (File.ctime(destination) < File.ctime(file))
+          mkdir_p path, fileutils_options unless File.exists? path
+          cp file, path, fileutils_options.merge(:force => File.exists?(destination))
+        else
+          warn "Skipping '#{File.basename(file)}' because it already exists in '#{path}'"
+        end
+
+        nil
+      end
+    end
+  end
+end

data/lib/releasy/deployers/rsync.rb

@@ -0,0 +1,59 @@
+require 'releasy/deployers/deployer'
+require "releasy/mixins/utilities"
+
+module Releasy
+  module Deployers
+    # Deploys to a remote server, using the rsync command.
+    #
+    # @example
+    #   Releasy::Project.new do
+    #     name "My App"
+    #     add_build :source
+    #     add_package :zip
+    #     add_deploy :rsync do
+    #       destination "example.com:/var/www/sites/mysite/downloads" # Required.
+    #     end
+    #   end
+    #
+    # @attr destination [String] Location to deploy to, such as "example.com:/var/www/sites/mysite/downloads".
+    # @attr options [String] ('-glpPrtvz') Options to pass to rsync.
+    class Rsync < Deployer
+      include Mixins::Utilities
+
+      TYPE = :rsync
+      DEFAULT_OPTIONS = '-glpPrtvz'
+
+      Deployers.register self
+
+      attr_reader :destination
+      def destination=(destination)
+        raise TypeError, "destination must be a String, but received #{destination.inspect}" unless destination.is_a? String
+        raise ArgumentError, 'destination requires no trailing slash' if destination[-1,1] == '/'
+        @destination = destination
+      end
+
+      attr_reader :options
+      def options=(options)
+        raise TypeError, "options must be a String, but received #{options.inspect}" unless options.is_a? String
+        @options = options
+      end
+
+      protected
+      def setup
+        @destination = nil
+        @options = DEFAULT_OPTIONS
+      end
+
+      protected
+      # @param file [String] Path to file to deploy.
+      # @return [nil]
+      def deploy(file)
+        raise ConfigError, "#destination must be set" unless destination
+
+        execute_command %[rsync #{options} "#{File.expand_path file}" "#{destination.chomp "/"}"]
+
+        nil
+      end
+    end
+  end
+end

data/lib/releasy/mixins/has_packagers.rb

@@ -14,7 +14,7 @@ module Mixins
       packagers << packager
 
       if block_given?
-        if block.arity == 0
+        if block.arity <= 0
           DSLWrapper.new(packager, &block)
         else
           yield packager

data/lib/releasy/mixins/utilities.rb

@@ -0,0 +1,34 @@
+module Releasy
+  module Mixins
+    module Utilities
+      protected
+      # Executes command, and prints out command and result only if the project is verbose.
+      # Requires {Log} to be included.
+      # Returns true if the command succeeded. False if it failed.
+      def execute_command(command)
+        info command
+
+        begin
+          IO.popen command do |output|
+            info output.gets.strip until output.eof?
+          end
+
+          true
+        rescue Errno::ENOENT
+          false
+        end
+      end
+
+      protected
+      # Is a particular command available on this system?
+      def command_available?(command)
+        find = Releasy.win_platform? ? "where" : "which"
+        !!Kernel.`("#{find} #{command}")
+      end
+
+      protected
+      def null_file; Releasy.win_platform? ? "NUL" : "/dev/null"; end
+
+    end
+  end
+end

data/lib/releasy/packagers/dmg.rb

@@ -3,6 +3,23 @@ require "releasy/packagers/packager"
 module Releasy
   module Packagers
     # OS X .dmg format (self-extractor).
+    #
+    # @example Package a particular build.
+    #   Releasy::Project.new do
+    #     name "My App"
+    #     add_build :source do
+    #       add_package :dmg
+    #     end
+    #   end
+    #
+    # @example Package all builds.
+    #   Releasy::Project.new do
+    #     name "My App"
+    #     add_build :source
+    #     add_build :windows_folder
+    #     add_package :dmg
+    #   end
+    #
     class Dmg < Packager
       TYPE = :dmg
       DEFAULT_EXTENSION = ".dmg"

data/lib/releasy/packagers/exe.rb

@@ -5,6 +5,23 @@ module Releasy
     # Windows self-extracting archive.
     #
     # If not on Windows, run "releasy install-sfx" after installing 7z, before you can use this.
+    #
+    # @example Package a particular build.
+    #   Releasy::Project.new do
+    #     name "My App"
+    #     add_build :source do
+    #       add_package :exe
+    #     end
+    #   end
+    #
+    # @example Package all builds.
+    #   Releasy::Project.new do
+    #     name "My App"
+    #     add_build :source
+    #     add_build :windows_folder
+    #     add_package :exe
+    #   end
+    #
     class Exe < Packager
       TYPE = :exe
       DEFAULT_EXTENSION = ".exe"
@@ -16,7 +33,7 @@ module Releasy
 
       protected
       def command(folder)
-        %[7z a -mmt -bd -t7z -mx9 -sfx#{SFX_NAME} "#{package(folder)}" "#{folder}"]
+        %[#{seven_zip_command} a -mmt -bd -t7z -mx9 -sfx#{SFX_NAME} "#{package(folder)}" "#{folder}"]
       end
     end
   end

data/lib/releasy/packagers/packager.rb

@@ -1,6 +1,6 @@
 require 'digest/md5'
 
-require "releasy/mixins/exec"
+require "releasy/mixins/utilities"
 require "releasy/mixins/log"
 
 module Releasy
@@ -11,7 +11,7 @@ module Packagers
   # @attr extension [String] Extension of archive to be created (such as ".zip").
   class Packager
     include Rake::DSL
-    include Mixins::Exec
+    include Mixins::Utilities
     include Mixins::Log
 
     MD5_READ_SIZE = 128 * 64 # MD5 likes 128 byte chunks.
@@ -21,7 +21,7 @@ module Packagers
 
     attr_reader :extension
     def extension=(extension)
-      raise TypeError "extension must be a String" unless extension.is_a? String
+      raise TypeError, "extension must be a String" unless extension.is_a? String
       raise ArgumentError, "extension must be valid, such as '.zip'" unless extension =~ /^\.[a-z0-9\.]+$/
       @extension = extension
     end
@@ -33,6 +33,22 @@ module Packagers
       @extension = self.class::DEFAULT_EXTENSION
     end
 
+    protected
+    # Finds
+    def seven_zip_command
+      @seven_zip_command ||= begin
+        if command_available? "7za"
+          "7za" # Installed standalone command line version. Included with CLI and GUI releases.
+        elsif command_available? "7z"
+          "7z" # Installed CLI version only included with gui version.
+        elsif Releasy.win_platform?
+          %["#{File.expand_path("../../../../bin/7za.exe", __FILE__)}"]
+        else
+          raise CommandNotFoundError, "Failed to find 7-ZIP; see readme for details of how to install"
+        end
+      end
+    end
+
     protected
     # Generate tasks to create the archive of this file.
     def generate_tasks(output_task, folder, deployers)
@@ -54,8 +70,8 @@ module Packagers
 
       heading "Creating #{pkg}"
       rm pkg, fileutils_options if File.exist? pkg
-      cd project.output_path do
-        exec command(File.basename folder)
+      cd project.output_path, fileutils_options do
+        execute_command command(File.basename folder)
       end
 
       File.open("#{pkg}.MD5", "w") {|f| f.puts checksum(pkg) } if project.send :create_md5s?
@@ -66,7 +82,7 @@ module Packagers
 
     protected
     def command(folder)
-      %[7z a -mmt -bd -t#{type} -mx9 "#{package(folder)}" "#{folder}"]
+      %[#{seven_zip_command} a -mmt -bd -t#{type} -mx9 "#{package(folder)}" "#{folder}"]
     end
 
     protected

data/lib/releasy/packagers/seven_zip.rb

@@ -3,6 +3,23 @@ require "releasy/packagers/packager"
 module Releasy
   module Packagers
     # 7z archive format (LZMA)
+    #
+    # @example Package a particular build.
+    #   Releasy::Project.new do
+    #     name "My App"
+    #     add_build :source do
+    #       add_package :"7z"
+    #     end
+    #   end
+    #
+    # @example Package all builds.
+    #   Releasy::Project.new do
+    #     name "My App"
+    #     add_build :source
+    #     add_build :windows_folder
+    #     add_package :"7z"
+    #   end
+    #
     class SevenZip < Packager
       TYPE = :"7z"
       DEFAULT_EXTENSION = ".7z"

data/lib/releasy/packagers/tar_bzip2.rb

@@ -3,6 +3,25 @@ require "releasy/packagers/tar_packager"
 module Releasy
   module Packagers
     # Archives with tar and Bzip2 formats.
+    #
+    # @example Package a particular build and change extension.
+    #   Releasy::Project.new do
+    #     name "My App"
+    #     add_build :source do
+    #       add_package :tar_bz2 do
+    #         extension ".tbz"
+    #       end
+    #     end
+    #   end
+    #
+    # @example Package all builds.
+    #   Releasy::Project.new do
+    #     name "My App"
+    #     add_build :source
+    #     add_build :windows_folder
+    #     add_package :tar_bz2
+    #   end
+    #
     class TarBzip2 < TarPackager
       TYPE = :tar_bz2
       DEFAULT_EXTENSION = ".tar.bz2"

data/lib/releasy/packagers/tar_gzip.rb

@@ -3,6 +3,25 @@ require "releasy/packagers/tar_packager"
 module Releasy
   module Packagers
     # Archives with tar and Gzip formats.
+    #
+    # @example Package a particular build and change extension.
+    #   Releasy::Project.new do
+    #     name "My App"
+    #     add_build :source do
+    #       add_package :tar_gz do
+    #         extension ".tgz"
+    #       end
+    #     end
+    #   end
+    #
+    # @example Package all builds.
+    #   Releasy::Project.new do
+    #     name "My App"
+    #     add_build :source
+    #     add_build :windows_folder
+    #     add_package :tar_gz
+    #   end
+    #
     class TarGzip < TarPackager
       TYPE = :tar_gz
       DEFAULT_EXTENSION = ".tar.gz"

data/lib/releasy/packagers/tar_packager.rb

@@ -7,7 +7,8 @@ module Packagers
   class TarPackager < Packager
     protected
     def command(folder)
-      %[7z a -so -mmt -bd -ttar "#{folder}.tar" "#{folder}" | 7z a -si -bd -t#{self.class::FORMAT} -mx9 "#{folder}#{extension}"]
+
+      %[#{seven_zip_command} a -so -mmt -bd -ttar "#{folder}.tar" "#{folder}" 2>#{null_file} | #{seven_zip_command} a -si -bd -t#{self.class::FORMAT} -mx9 "#{folder}#{extension}"]
     end
   end
 end

data/lib/releasy/packagers/zip.rb

@@ -3,6 +3,23 @@ require "releasy/packagers/packager"
 module Releasy
   module Packagers
     # Archives with zip format. This isn't efficient, but can be decompressed on Windows Vista or later without requiring a 3rd party tool.
+    #
+    # @example Package a particular build.
+    #   Releasy::Project.new do
+    #     name "My App"
+    #     add_build :source do
+    #       add_package :zip
+    #     end
+    #   end
+    #
+    # @example Package all builds.
+    #   Releasy::Project.new do
+    #     name "My App"
+    #     add_build :source
+    #     add_build :windows_folder
+    #     add_package :zip
+    #   end
+    #
     class Zip < Packager
       TYPE = :zip
       DEFAULT_EXTENSION = ".zip"

data/lib/releasy/project.rb

@@ -11,6 +11,47 @@ require "releasy/mixins/log"
 module Releasy
   # A description of the Ruby application that is being build for release and what packages to make from it.
   #
+  # @example
+  #   Releasy::Project.new do
+  #     name "My Application"
+  #     version MyApplication::VERSION
+  #
+  #     executable "bin/my_application.rbw"
+  #     files `git ls-files`.split("\n")
+  #     files.exclude '.gitignore'
+  #
+  #     exposed_files ["README.html", "LICENSE.txt"]
+  #     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
+  #       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 do
+  #       add_package :"7z"
+  #     end
+  #
+  #     add_build :windows_folder do
+  #       icon "media/icon.ico"
+  #       add_package :exe
+  #     end
+  #
+  #     add_build :windows_installer do
+  #       icon "media/icon.ico"
+  #       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_deploy :github # Upload to a github project.
+  #   end
+  #
   # @attr underscored_name [String] Project name underscored (as used in file names), which will be derived from {#name}, but can be manually set.
   # @attr underscored_version [String] Version number, underscored so it can be used in file names, which will be derived from {#version}, but can be manually set.
   # @attr executable [String] Name of executable to run (defaults to 'bin/<underscored_name>')
@@ -144,7 +185,7 @@ module Releasy
       setup
 
       if block_given?
-        if block.arity == 0
+        if block.arity <= 0
           DSLWrapper.new(self, &block)
         else
           yield self
@@ -166,7 +207,7 @@ module Releasy
       @builders << builder
 
       if block_given?
-        if block.arity == 0
+        if block.arity <= 0
           DSLWrapper.new(builder, &block)
         else
           yield builder
@@ -178,7 +219,7 @@ module Releasy
 
     # Add a deployment method for archived packages.
     # @see #initialize
-    # @param type [:github]
+    # @param type [:github, :local, :rsync]
     # @return [Project] self
     def add_deploy(type, &block)
       raise ArgumentError, "Unsupported deploy type #{type}" unless Deployers.has_type? type
@@ -188,7 +229,7 @@ module Releasy
       @deployers << deployer
 
       if block_given?
-        if block.arity == 0
+        if block.arity <= 0
           DSLWrapper.new(deployer, &block)
         else
           yield deployer