releasy 0.2.0rc1 → 0.2.0rc2

data/lib/releasy/mixins/has_packagers.rb

@@ -0,0 +1,37 @@
+module Releasy
+module Mixins
+  # An object that owns one or more instances of {Packagers::Packager}
+  module HasPackagers
+    # Add an archive type to be generated for each of your outputs.
+    # @see Project#initialize
+    # @param type [:exe, :"7z", :tar_bz2, :tar_gz, :zip]
+    # @return [Project] self
+    def add_package(type, &block)
+      raise ArgumentError, "Unsupported archive format #{type.inspect}" unless Packagers.has_type? type
+      raise ArgumentError, "Already have archive format #{type.inspect}" if packagers.any? {|a| a.type == type }
+
+      packager = Packagers[type].new(respond_to?(:project) ? project : self)
+      packagers << packager
+
+      if block_given?
+        if block.arity == 0
+          DSLWrapper.new(packager, &block)
+        else
+          yield packager
+        end
+      end
+
+      packager
+    end
+
+    protected
+    def packagers; @packagers ||= []; end
+
+    protected
+    # @return [Array<Packager>]
+    def active_packagers
+      packagers
+    end
+  end
+end
+end

data/lib/releasy/mixins/log.rb

@@ -0,0 +1,39 @@
+module Releasy::Mixins::Log
+  class << self
+    LOG_LEVELS = [:silent, :quiet, :verbose]
+    DEFAULT_LOG_LEVEL = :quiet
+
+    def log_level; @log_level ||= DEFAULT_LOG_LEVEL; end
+    def log_level=(level)
+      raise ArgumentError, "Bad log_level: #{level.inspect}" unless LOG_LEVELS.include? level
+      @log_level = level
+    end
+  end
+
+  def log_level; Releasy::Mixins::Log.log_level; end
+
+  # Options for fileutils commands, based on log_level.
+  def fileutils_options
+    { :verbose => log_level == :verbose }
+  end
+
+  # Heading message shown unless :silent
+  def heading(str)
+    puts "=== #{str}" unless log_level == :silent
+  end
+
+  # Heading message shown if :verbose
+  def info(str)
+    puts str if log_level == :verbose
+  end
+
+  # Warning message shown unless :silent
+  def warn(str)
+    puts "=== WARNING: #{str}" unless log_level == :silent
+  end
+
+  # Error message always shown.
+  def error(str)
+    puts "=== ERROR: #{str}"
+  end
+end

data/lib/releasy/mixins/register.rb

@@ -35,7 +35,6 @@ module Releasy
       # @param klass [Object] Object, which is defined within the namespace being registered with.
       def register(klass)
         raise TypeError, "Can only register classes" unless klass.is_a? Class
-        raise ArgumentError, "Can't register a class not within this module" unless klass.name.split('::')[0...-1].join('::') == name
         raise ArgumentError, "To register, a class must have TYPE defined" unless klass.const_defined? :TYPE
         registered[klass::TYPE] = klass
       end

data/lib/releasy/packagers.rb

@@ -0,0 +1,12 @@
+require 'releasy/mixins/register'
+
+module Releasy
+  # Contains all {Packager} types.
+  module Packagers
+    extend Mixins::Register
+  end
+end
+
+%w[dmg exe seven_zip tar_bzip2 tar_gzip zip].each do |packager|
+  require "releasy/packagers/#{packager}"
+end

data/lib/releasy/{archivers → packagers}/dmg.rb

@@ -1,13 +1,13 @@
-require "releasy/archivers/archiver"
+require "releasy/packagers/packager"
 
 module Releasy
-  module Archivers
+  module Packagers
     # OS X .dmg format (self-extractor).
-    class Dmg < Archiver
+    class Dmg < Packager
       TYPE = :dmg
       DEFAULT_EXTENSION = ".dmg"
 
-      Archivers.register self
+      Packagers.register self
 
       protected
       def command(folder)

data/lib/releasy/{archivers → packagers}/exe.rb

@@ -1,18 +1,18 @@
-require "releasy/archivers/archiver"
+require "releasy/packagers/packager"
 
 module Releasy
-  module Archivers
+  module Packagers
     # Windows self-extracting archive.
     #
     # If not on Windows, run "releasy install-sfx" after installing 7z, before you can use this.
-    class Exe < Archiver
+    class Exe < Packager
       TYPE = :exe
       DEFAULT_EXTENSION = ".exe"
 
       SFX_NAME = "7z.sfx"
       SFX_FILE = File.expand_path("../../../../bin/#{SFX_NAME}", __FILE__)
 
-      Archivers.register self
+      Packagers.register self
 
       protected
       def command(folder)

data/lib/releasy/{archivers/archiver.rb → packagers/packager.rb}

@@ -1,22 +1,30 @@
 require 'digest/md5'
 
 require "releasy/mixins/exec"
+require "releasy/mixins/log"
 
 module Releasy
-module Archivers
+module Packagers
   # Archives a build folder.
   #
   # @abstract
-  class Archiver
+  # @attr extension [String] Extension of archive to be created (such as ".zip").
+  class Packager
     include Rake::DSL
     include Mixins::Exec
+    include Mixins::Log
 
     MD5_READ_SIZE = 128 * 64 # MD5 likes 128 byte chunks.
 
-    # @return [Project] Project this Archiver was created by.
+    # @return [Project] Project this Packager was created by.
     attr_reader :project
-    # @return [String] Extension of archive to be created (such as ".zip").
-    attr_accessor :extension
+
+    attr_reader :extension
+    def extension=(extension)
+      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
 
     def type; self.class::TYPE; end
 
@@ -27,10 +35,12 @@ module Archivers
 
     protected
     # Generate tasks to create the archive of this file.
-    def generate_tasks(output_task, folder)
+    def generate_tasks(output_task, folder, deployers)
       pkg = package folder
 
-      desc "Create #{pkg}"
+      deployers.each {|d| d.send :generate_tasks, "#{output_task}:#{type}", folder, extension }
+
+      desc "Package #{output_task.tr(":", " ")} #{extension}"
       task "package:#{output_task}:#{type}" => pkg
 
       file pkg => folder do
@@ -41,10 +51,9 @@ module Archivers
     protected
     def archive(folder)
       pkg = package folder
-      Rake::FileUtilsExt.verbose project.verbose?
 
-      puts "Creating #{pkg}" if project.verbose?
-      rm pkg if File.exist? pkg
+      heading "Creating #{pkg}"
+      rm pkg, fileutils_options if File.exist? pkg
       cd project.output_path do
         exec command(File.basename folder)
       end
@@ -53,7 +62,7 @@ module Archivers
     end
 
     protected
-    def package(folder); "#{folder}#{extension[0, 1] == '.' ? '' : '.'}#{extension}"; end
+    def package(folder); "#{folder}#{extension}"; end
 
     protected
     def command(folder)

data/lib/releasy/packagers/seven_zip.rb

@@ -0,0 +1,12 @@
+require "releasy/packagers/packager"
+
+module Releasy
+  module Packagers
+    # 7z archive format (LZMA)
+    class SevenZip < Packager
+      TYPE = :"7z"
+      DEFAULT_EXTENSION = ".7z"
+      Packagers.register self
+    end
+  end
+end

data/lib/releasy/{archivers → packagers}/tar_bzip2.rb

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

data/lib/releasy/{archivers → packagers}/tar_gzip.rb

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

data/lib/releasy/{archivers/tar_archiver.rb → packagers/tar_packager.rb}

@@ -1,10 +1,10 @@
-require "releasy/archivers/archiver"
+require "releasy/packagers/packager"
 
 module Releasy
-module Archivers
-  # An archiver that tars and then compresses the folder.
+module Packagers
+  # An packager that tars and then compresses the folder.
   # @abstract
-  class TarArchiver < Archiver
+  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}"]

data/lib/releasy/{archivers → packagers}/zip.rb

@@ -1,12 +1,12 @@
-require "releasy/archivers/archiver"
+require "releasy/packagers/packager"
 
 module Releasy
-  module Archivers
+  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.
-    class Zip < Archiver
+    class Zip < Packager
       TYPE = :zip
       DEFAULT_EXTENSION = ".zip"
-      Archivers.register self
+      Packagers.register self
     end
   end
 end

data/lib/releasy/project.rb

@@ -1,7 +1,10 @@
 require 'releasy/dsl_wrapper'
 require 'releasy/builders'
-require 'releasy/archivers'
-require "releasy/mixins/has_archivers"
+require 'releasy/packagers'
+require 'releasy/deployers'
+require "releasy/mixins/has_packagers"
+require "releasy/mixins/can_exclude_encoding"
+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.
@@ -14,7 +17,9 @@ module Releasy
   # @attr exposed_files [Rake::FileList] Files which should always be copied into the archive folder root, so they are always visible to the user. e.g readme, change-log and/or license files.
   class Project
     include Rake::DSL
-    include Mixins::HasArchivers
+    include Mixins::HasPackagers
+    include Mixins::CanExcludeEncoding
+    include Mixins::Log
 
     DEFAULT_PACKAGE_FOLDER = "pkg"
 
@@ -29,11 +34,10 @@ module Releasy
 
     # Make the tasks give more detailed output.
     # @return [nil]
-    def verbose; @verbose = true; nil; end
-    # Make the tasks give less detailed output.
+    def verbose; Mixins::Log.log_level = :verbose; end
+    # Make the tasks give no output at all.
     # @return [nil]
-    def quiet; @verbose = false; nil; end
-    def verbose?; @verbose; end
+    def silent; Mixins::Log.log_level = :silent; end
 
     # Create MD5 hashes for created archives.
     # @return [nil]
@@ -41,10 +45,6 @@ module Releasy
     def create_md5s?; @create_md5s; end
     protected :create_md5s?
 
-    # Verbosity of the console output.
-    # @return [Boolean] True to make the tasks output more information.
-    def verbose?; @verbose; end
-
     def exposed_files; @exposed_files; end
     def exposed_files=(files); @exposed_files = Rake::FileList.new files; end
 
@@ -89,7 +89,7 @@ module Releasy
     #         name "My Application"
     #         version "1.2.4"
     #         add_build :source do
-    #           add_archive :tar_gz do
+    #           add_package :tar_gz do
     #             extension ".tgz"
     #           end
     #         end
@@ -106,7 +106,7 @@ module Releasy
     #         p.name = "My Application"
     #         p.version = "1.2.4"
     #         p.add_build :source do |b|
-    #           b.add_archive :tar_gz do |a|
+    #           b.add_package :tar_gz do |a|
     #             a.extension = ".tgz"
     #           end
     #         end
@@ -122,19 +122,19 @@ module Releasy
     #       project.name = "My Application"
     #       project.version = "1.2.4"
     #       builder = project.add_build :source
-    #       archiver = builder.add_archive :zip
-    #       archiver.extension = ".tgz"
+    #       packager = builder.add_package :zip
+    #       packager.extension = ".tgz"
     #       project.generate_tasks # This has to be done manually.
     #
     def initialize(&block)
       super()
 
       @builders = []
+      @deployers = []
       @links = {}
       @files = Rake::FileList.new
       @exposed_files = Rake::FileList.new
       @output_path = DEFAULT_PACKAGE_FOLDER
-      @verbose = true
       @create_md5s = false
       @name = @underscored_name = @underscored_version = nil
       @version = @executable = nil
@@ -152,13 +152,13 @@ module Releasy
       end
     end
 
-    # Add a type of output to produce. Must define at least one of these.
+    # Add a type of build to produce. Must define at least one of these.
     # @see #initialize
-    # @param type [:osx_app, :source, :windows_folder, :windows_folder_from_ruby_dist, :windows_installer, :windows_standalone]
+    # @param type [:osx_app, :source, :windows_folder, :windows_wrapped, :windows_installer, :windows_standalone]
     # @return [Project] self
     def add_build(type, &block)
       raise ArgumentError, "Unsupported output type #{type}" unless Builders.has_type? type
-      raise ConfigError, "Already have output #{type.inspect}" if @builders.any? {|b| b.type == type }
+      raise ArgumentError, "Already have output #{type.inspect}" if @builders.any? {|b| b.type == type }
 
       builder = Builders[type].new(self)
       @builders << builder
@@ -174,6 +174,28 @@ module Releasy
       builder
     end
 
+    # Add a deployment method for archived packages.
+    # @see #initialize
+    # @param type [:github]
+    # @return [Project] self
+    def add_deploy(type, &block)
+      raise ArgumentError, "Unsupported deploy type #{type}" unless Deployers.has_type? type
+      raise ArgumentError, "Already have deploy #{type.inspect}" if @deployers.any? {|b| b.type == type }
+
+      deployer = Deployers[type].new(self)
+      @deployers << deployer
+
+      if block_given?
+        if block.arity == 0
+          DSLWrapper.new(deployer, &block)
+        else
+          yield deployer
+        end
+      end
+
+      deployer
+    end
+
     # Add a link file to be included in the win32 releases. Will create the file _title.url_ for you.
     #
     # @param url [String] Url to link to.
@@ -188,7 +210,7 @@ module Releasy
     # Generates all tasks required by the user. Automatically called at the end of the block, if {#initialize} is given a block.
     # @return [Project] self
     def generate_tasks
-      raise ConfigError, "Must specify at least one valid output for this OS with #add_build before tasks can be generated" if @builders.empty?
+      raise ConfigError, "Must use #add_build at least once before tasks can be generated" if @builders.empty?
 
       # Even if there are builders specified, none may work on this platform.
       return if active_builders.empty?
@@ -210,11 +232,11 @@ module Releasy
       end
 
       build_groups.each_pair do |group, tasks|
-        desc "Build all #{group} outputs"
+        desc "Build all #{group}"
         task "build:#{group}" => tasks
       end
 
-      desc "Build all outputs"
+      desc "Build #{description}"
       task "build" => build_outputs
 
       generate_archive_tasks
@@ -222,10 +244,12 @@ module Releasy
       self
     end
 
-
-    def folder_base
-      File.join(output_path, "#{underscored_name}#{version ? "_#{underscored_version}" : ""}")
-    end
+    # Full name of the project, including the version name E.g. "My Application" or "My Application 0.1"
+    def description; name ? "#{name}#{version ? " #{version}" : ""}" : nil; end
+    # Full underscored name of the project. E.g. "my_application" or "my_application_0_1"
+    def underscored_description; underscored_name ? "#{underscored_name}#{version ? "_#{underscored_version}" : ""}" : nil; end
+    # Base name of folders that will be created, such as "pkg/my_application" or "pkg/my_application_0_1"
+    def folder_base; File.join(output_path, underscored_description.to_s); end
 
     protected
     # Only allow access to this from Builder
@@ -249,52 +273,87 @@ module Releasy
       windows_tasks = []
       osx_tasks = []
       top_level_tasks = []
+
       active_builders.each do |builder|
         output_task = builder.type.to_s.sub '_', ':'
 
-        archivers = active_archivers(builder)
-        archivers.each do |archiver|
-          archiver.send :generate_tasks, output_task, builder.send(:folder)
+        packagers = active_packagers(builder)
+        packagers.each do |packager|
+          packager.send :generate_tasks, output_task, builder.send(:folder), @deployers
+
+          task "deploy:#{output_task}:#{packager.type}" => @deployers.map {|d| "deploy:#{output_task}:#{packager.type}:#{d.type}" }
         end
 
-        desc "Package all #{builder.type}"
-        task "package:#{output_task}" => archivers.map {|c| "package:#{output_task}:#{c.type}" }
+        @deployers.each do |deployer|
+          task "deploy:#{output_task}:#{deployer.type}" => packagers.map {|a| "deploy:#{output_task}:#{a.type}:#{deployer.type}" }
+        end
+
+        task "package:#{output_task}" => packagers.map {|a| "package:#{output_task}:#{a.type}" }
 
         case output_task
           when /^windows:/
-            windows_tasks << "package:#{output_task}"
-            top_level_tasks << "package:windows" unless top_level_tasks.include? "package:windows"
+            windows_tasks << "#{output_task}"
+            top_level_tasks << "windows" unless top_level_tasks.include? "windows"
           when /^osx:/
             osx_tasks << "package:#{output_task}"
-            top_level_tasks << "package:osx" unless top_level_tasks.include? "package:osx"
+            top_level_tasks << "osx" unless top_level_tasks.include? "osx"
           else
-            top_level_tasks << "package:#{output_task}"
+            top_level_tasks << "#{output_task}"
         end
       end
 
+      # Windows tasks.
       unless windows_tasks.empty?
-        desc "Package all Windows"
-        task "package:windows" => windows_tasks
+        task "package:windows" => windows_tasks.map {|t| "package:#{t}" }
+
+        generate_deploy_tasks "windows", windows_tasks
       end
 
+      # OS X tasks.
       unless osx_tasks.empty?
-        desc "Package all OS X"
-        task "package:osx" => osx_tasks
+        task "package:osx" => osx_tasks.map {|t| "package:#{t}" }
+
+        generate_deploy_tasks "osx", osx_tasks
       end
 
-      desc "Package all"
-      task "package" => top_level_tasks
+      # Top level tasks.
+      desc "Package #{description}"
+      task "package" => top_level_tasks.map {|t| "package:#{t}" }
+
+      unless @deployers.empty?
+        desc "Deploy #{description}"
+        task "deploy" => top_level_tasks.map {|t| "deploy:#{t}" }
+
+        generate_deploy_tasks "", top_level_tasks
+      end
 
       self
     end
 
     protected
-    def active_archivers(builder)
-      # Use archivers specifically set on the builder and those set globally that aren't on the builder.
-      archivers = builder.send(:active_archivers)
-      archiver_types = archivers.map(&:type)
+    def generate_deploy_tasks(task_name, tasks)
+      deploy_task = task_name.empty? ? "deploy" : "deploy:#{task_name}"
+
+      unless @deployers.empty?
+        task deploy_task => tasks.map {|t| "deploy:#{t}" }
+
+        @deployers.each do |deployer|
+          task "#{deploy_task}:#{deployer.type}" => tasks.map {|t| "deploy:#{t}:#{deployer.type}" }
+        end
+
+        tasks.each do |t|
+          task "deploy:#{t}" => @deployers.map {|d| "deploy:#{t}:#{d.type}" }
+        end
+      end
+    end
+
+    protected
+    def active_packagers(builder)
+      # Use packagers specifically set on the builder and those set globally that aren't on the builder.
+      packagers = builder.send(:active_packagers)
+      packager_types = packagers.map(&:type)
 
-      archivers + super().reject {|a| archiver_types.include? a.type }
+      packagers + super().reject {|a| packager_types.include? a.type }
     end
   end
 end