releasy 0.2.0rc1 → 0.2.0rc2

data/lib/releasy/builders/windows_builder.rb

@@ -1,4 +1,5 @@
 require "releasy/builders/builder"
+require "releasy/mixins/can_exclude_encoding"
 
 module Releasy
 module Builders
@@ -6,20 +7,13 @@ module Builders
   # @abstract
   # @attr icon [String] Optional filename of icon to show on executable/installer (.ico).
   class WindowsBuilder < Builder
+    include Mixins::CanExcludeEncoding
+
     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
@@ -39,7 +33,6 @@ module Builders
 
     protected
     def setup
-      @exclude_encoding = false
       @executable_type = :auto
       super
     end

data/lib/releasy/builders/windows_folder.rb

@@ -16,27 +16,25 @@ module Releasy
         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
+          rm tmp_ocra_executable, fileutils_options
 
-          mv Dir["#{File.dirname(folder)}/ocr*\.tmp"].first, folder
+          mv Dir["#{File.dirname(folder)}/ocr*\.tmp"].first, folder, fileutils_options
 
           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 }
+          project.exposed_files.each {|file| cp file, folder, fileutils_options }
         end
 
-        desc "Build source/exe folder #{project.version}"
+        desc "Build windows folder"
         task "build:windows:folder" => folder
       end
 

data/lib/releasy/builders/windows_installer.rb

@@ -24,17 +24,15 @@ module Releasy
         directory folder
 
         file folder => project.files do
-          Rake::FileUtilsExt.verbose project.verbose?
-
           create_link_files folder
-          project.exposed_files.each {|file| cp file, folder }
+          project.exposed_files.each {|file| cp file, folder, fileutils_options }
 
           create_installer installer_name, :links => true
 
-          rm temp_installer_script
+          rm temp_installer_script, fileutils_options
         end
 
-        desc "Build installer #{project.version} [Innosetup]"
+        desc "Build windows installer"
         task "build:windows:installer" => folder
       end
 

data/lib/releasy/builders/windows_standalone.rb

@@ -17,9 +17,7 @@ module Releasy
         directory folder
 
         file folder => project.files do
-          Rake::FileUtilsExt.verbose project.verbose?
-
-          project.exposed_files.each {|file| cp file, folder }
+          project.exposed_files.each {|file| cp file, folder, fileutils_options }
 
           create_link_files folder
 

data/lib/releasy/builders/{windows_folder_from_ruby_dist.rb → windows_wrapped.rb}

@@ -11,10 +11,10 @@ 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!
-    class WindowsFolderFromRubyDist < WindowsBuilder
+    class WindowsWrapped < WindowsBuilder
       include Mixins::HasGemspecs
 
-      TYPE = :windows_folder_from_ruby_dist
+      TYPE = :windows_wrapped
       DEFAULT_FOLDER_SUFFIX = "WIN32"
 
       # Files that are required for Tcl/Tk, but which are unlikely to be used in many applications.
@@ -28,10 +28,12 @@ module Releasy
       # 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.so iso_8859_1.so utf_16le.so trans/single_byte.so trans/transdb.so trans/utf_16_32.so]
 
+      VALID_RUBY_DIST = /ruby-1\.[89]\.\d-p\d+-i386-mingw32.7z/
+
       Builders.register self
 
       # @return [String] Path to windows distribution archive that has been manually downloaded from http://rubyinstaller.org/downloads/ (e.g. "rubies/ruby-1.9.2-p290-i386-mingw32.7z").
-      attr_accessor :ruby_dist
+      attr_accessor :wrapper
 
       # Remove TCL/TK from package, which can save a significant amount of space if the application does not require them.
       # This is over 6MB uncompressed, which is a saving of 1.6MB when compressed with 7z format (LZMA).
@@ -43,22 +45,22 @@ module Releasy
       protected
       # FOLDER containing EXE, Ruby + source.
       def generate_tasks
-        raise ConfigError, "#ruby_dist not set" unless ruby_dist
-        raise ConfigError, "#ruby_dist not valid: #{ruby_dist}" unless File.exist?(ruby_dist) and File.extname(ruby_dist) == ".7z"
+        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 + [ruby_dist] do
+        file folder => project.files + [wrapper] do
           build
         end
 
         desc "Build source/exe folder #{project.version} from wrapper"
-        task "build:windows:folder_from_ruby_dist" => folder
+        task "build:windows:wrapped" => folder
       end
 
       protected
       def build
-        Rake::FileUtilsExt.verbose project.verbose?
+        raise ConfigError, "#wrapper does not exist: #{wrapper}" unless File.exist?(wrapper)
 
         copy_ruby_distribution
         delete_excluded_files
@@ -66,7 +68,7 @@ module Releasy
         copy_files_relative project.files, File.join(folder, 'src')
 
         create_link_files folder
-        project.exposed_files.each {|file| cp file, folder }
+        project.exposed_files.each {|file| cp file, folder, fileutils_options }
 
         create_executable
 
@@ -79,20 +81,20 @@ module Releasy
       protected
       def delete_excluded_files
         # Remove TCL/TK dlls, lib folder and source.
-        rm_r Dir[*(TCL_TK_FILES.map {|f| File.join(folder, f) })].uniq.sort if @exclude_tcl_tk
+        rm_r Dir[*(TCL_TK_FILES.map {|f| File.join(folder, f) })].uniq.sort, fileutils_options if @exclude_tcl_tk
 
         # Remove Encoding files on Ruby 1.9
-        if encoding_excluded? and ruby_dist =~ /1\.9\.\d/
+        if encoding_excluded? and wrapper =~ /1\.9\.\d/
           encoding_files = Dir[File.join folder, "lib/ruby/1.9.1/i386-mingw32/enc/**/*.so"]
           required_encoding_files = REQUIRED_ENCODING_FILES.map {|f| File.join folder, "lib/ruby/1.9.1/i386-mingw32/enc", f }
-          rm_r encoding_files - required_encoding_files
+          rm_r encoding_files - required_encoding_files, fileutils_options
         end
       end
 
       protected
       def setup
         @exclude_tcl_tk = false
-        @ruby_dist = nil
+        @wrapper = nil
         super
       end
 
@@ -101,13 +103,13 @@ module Releasy
 
       protected
       def copy_ruby_distribution
-        archive_name = File.basename(ruby_dist).chomp(File.extname(ruby_dist))
-        exec %[7z x "#{ruby_dist}" -o"#{File.dirname folder}"]
-        mv File.join(File.dirname(folder), archive_name), folder
-        rm_r File.join(folder, "share")
-        rm_r File.join(folder, "include") if File.exists? File.join(folder, "include")
+        archive_name = File.basename(wrapper).chomp(File.extname(wrapper))
+        exec %[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")
         unused_exe = effective_executable_type == :windows ? "ruby.exe" : "rubyw.exe"
-        rm File.join(folder, "bin", unused_exe)
+        rm File.join(folder, "bin", unused_exe), fileutils_options
       end
 
       protected
@@ -119,10 +121,10 @@ module Releasy
 
       protected
       def install_binary_gems(destination)
-        puts "Checking gems to see if any are binary" if project.verbose?
+        info "Checking gems to see if any are binary"
         binary_gems = []
         gemspecs.reject {|s| false }.each do |spec|
-          puts "Checking gem #{spec.name} #{spec.version} to see if there is a Windows binary version" if project.verbose?
+          info "Checking gem #{spec.name} #{spec.version} to see if there is a Windows binary version"
           # Find out what versions are available and if the required version is available as a windows binary, download and install that.
           versions = %x[gem list "#{spec.name}" --remote --all --prerelease]
           if versions =~ /#{spec.name} \(([^\)]*)\)/m
@@ -132,7 +134,7 @@ module Releasy
             raise "Gem #{spec.name} is binary, but #{spec.version} does not have a published binary" if version_string =~ /mingw|mswin/ and not windows_platform
 
             if windows_platform
-              puts "Installing Windows version of binary gem #{spec.name} #{spec.version}"
+              info "Installing Windows version of binary gem #{spec.name} #{spec.version}"
               # 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'] = ''

data/lib/releasy/cli/install_sfx.rb

@@ -1,9 +1,9 @@
 require 'cri'
-require "releasy/archivers/exe"
+require "releasy/packagers/exe"
 
 command = 'install-sfx'
-sfx_file = Releasy::Archivers::Exe::SFX_NAME
-sfx_path = Releasy::Archivers::Exe::SFX_FILE
+sfx_file = Releasy::Packagers::Exe::SFX_NAME
+sfx_path = Releasy::Packagers::Exe::SFX_FILE
 
 Releasy::Cli.define_command do
   name        command

data/lib/releasy/deployers.rb

@@ -0,0 +1,12 @@
+require 'releasy/mixins/register'
+
+module Releasy
+  # Contains all {Deployer} types.
+  module Deployers
+    extend Mixins::Register
+  end
+end
+
+%w[github].each do |deployer|
+  require "releasy/deployers/#{deployer}"
+end

data/lib/releasy/deployers/deployer.rb

@@ -0,0 +1,28 @@
+require "releasy/mixins/log"
+
+module Releasy
+  module Deployers
+    # @abstract
+    class Deployer
+      include Rake::DSL
+      include Mixins::Log
+
+      attr_reader :project
+
+      def type; self.class::TYPE; end
+
+      def initialize(project)
+        @project = project
+        setup
+      end
+
+      protected
+      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)
+        end
+      end
+    end
+  end
+end

data/lib/releasy/deployers/github.rb

@@ -0,0 +1,109 @@
+require 'releasy/deployers/deployer'
+
+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`)
+    class Github < Deployer
+      TYPE = :github
+
+      Deployers.register self
+
+      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)
+        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)
+        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)
+        raise TypeError, "description must be a String, but received #{description.class}" unless description.is_a? String
+        @description = description
+      end
+
+      # Force replacement of existing uploaded files.
+      def replace!
+        @force_replace = true
+      end
+
+      protected
+      def setup
+        @force_replace = false
+        @description = nil
+
+        # Get username from github.user, otherwise use the name taken from the git_url.
+        @user = from_config 'github.user'
+        @token = from_config 'github.token'
+
+        # Try to guess the repository name from git config.
+        git_url = from_config 'remote.origin.url'
+        if git_url and git_url =~ %r<^git@github.com:(.+)/([^/]+)\.git$>
+          @user ||= $1 # May have already been set from github.user
+          @repository = $2
+        else
+          @repository = nil
+        end
+      end
+
+      protected
+      # Get a value from git config.
+      #
+      # @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
+      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.
+      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
+
+        require 'net/github-upload' # Hold off requiring this unless needed, so it doesn't slow down creating tasks.
+
+        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(:repos => repository, :file => file, :description => description, :replace => @force_replace)
+        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)}"
+        heading %[Successfully uploaded to "#{link}" in #{(Time.now - t).ceil}s]
+
+        link
+      end
+    end
+  end
+end

data/lib/releasy/mixins/can_exclude_encoding.rb

@@ -0,0 +1,22 @@
+module Releasy
+  module Mixins
+    module CanExcludeEncoding
+      # Exclude unnecessary encoding files, only keeping those that sufficient for basic use of Ruby.
+      def exclude_encoding
+        @encoding_excluded = true
+      end
+
+      protected
+      # Has encoding been excluded from builds?
+      def encoding_excluded?
+        @encoding_excluded ||= false
+
+        if is_a? Project
+          @encoding_excluded
+        else
+          @encoding_excluded || project.send(:encoding_excluded?)
+        end
+      end
+    end
+  end
+end

data/lib/releasy/mixins/exec.rb

@@ -4,9 +4,9 @@ module Releasy
     module Exec
       protected
       def exec(command)
-        puts command if project.verbose?
+        info command
         result = %x[#{command}]
-        puts result if project.verbose?
+        info result
         result
       end
     end

data/lib/releasy/mixins/has_gemspecs.rb

@@ -21,20 +21,20 @@ module Mixins
 
     protected
     def copy_gems(gems, destination)
-      puts "Copying source gems from system" if project.verbose?
+      info "Copying source gems from system"
 
       gems_dir = "#{destination}/gems"
       specs_dir = "#{destination}/specifications"
-      mkdir_p gems_dir
-      mkdir_p specs_dir
+      mkdir_p gems_dir, fileutils_options
+      mkdir_p specs_dir, fileutils_options
 
       gems.each do |gem|
         spec = gemspecs.find {|g| g.name == gem }
         gem_dir = spec.full_gem_path
-        puts "Copying gem: #{spec.name} #{spec.version}" if project.verbose?
-        cp_r gem_dir, gems_dir
+        info "Copying gem: #{spec.name} #{spec.version}"
+        cp_r gem_dir, gems_dir, fileutils_options
         spec_file = File.expand_path("../../specifications/#{File.basename gem_dir}.gemspec", gem_dir)
-        cp_r spec_file, specs_dir
+        cp_r spec_file, specs_dir, fileutils_options
       end
     end
   end