dister 0.1.2 → 0.1.3

data/.gitignore

@@ -3,3 +3,5 @@ pkg
 .dister
 rdoc
 Gemfile.lock
+doc
+.yardoc

data/.yardopts

@@ -0,0 +1,7 @@
+--markup rdoc
+--default-return ''
+--no-private
+--title "Documentation for dister"
+--exclude studio_api
+lib/**/*.rb
+- LICENSE

data/Changelog

@@ -1,3 +1,8 @@
+Thu Apr 12 10:32:24 CEST 2012  Flavio Castelli <flavio@castelli.name>
+
+	* release version 0.1.3:
+		- add support for SLE11 SP2 base systems.
+
 Fri May 06 16:55:23 CEST 2011  Flavio Castelli <flavio@castelli.name>
 
 	* Fixed a method missing error.
@@ -6,8 +11,8 @@ Fri May 06 16:46:10 CEST 2011  Flavio Castelli <flavio@castelli.name>
 
 	* appliance building: ask the user what to do when there's already an
 	image with the same version.
-	* release version 1.0.1 
+	* release version 0.1.1 
 
 Wed May 04 16:00:00 CEST 2011  Flavio Castelli <flavio@castelli.name>
 
-	* released first version 1.0.0
+	* released first version 0.0.1

data/README.rdoc

@@ -1,22 +1,22 @@
 = Dister: an Heroku like solution for SUSE Studio
 
 {SUSE Studio}[http://susestudio.com] is an online Linux image creation tool.
-Creating an appliance to run your rails appliacation can be quite annoying:
-there are extra repositories to add, gem dependencies to satisfy, a database to 
-setup, apache and passenger to configure, overlay files to add and so on.
+Creating an appliance to run your Rails application can be quite annoying:
+there are extra repositories to add, gem dependencies to satisfy, a database to
+setup, Apache and Passenger to configure, overlay files to add and so on.
 
 You can save some time cloning {this}[http://susegallery.com/a/CZ0T0D/rails-in-a-box]
 appliance shared on {SUSE Gallery}[http://susegallery.com/], but some efforts
 are still required.
 
-Currenlty the easiest solution to deploy a rails application in the cloud is 
+Currently the easiest solution to deploy a Rails application in the cloud is
 {Heroku}[http://heroku.com/].
 
-Dister is a command line tool similar to the one used by Heroku. Within a few 
-steps you can create a SUSE Studio appliance running your rails application, 
+Dister is a command line tool similar to the one used by Heroku. Within a few
+steps you can create a SUSE Studio appliance running your Rails application,
 download it and run into your private or public cloud.
 
-SUSE Studio currenlty supports the following appliance formats:
+SUSE Studio currently supports the following appliance formats:
 - oem: it can be run inside KVM or it can be installed to a hard disk/usb pen.
 - iso and preload iso: you can create a live dvd or an installation dvd.:
 - vmx and ovf: use these formats if you want to run your appliance inside of
@@ -25,12 +25,15 @@ SUSE Studio currenlty supports the following appliance formats:
   hypervisor.
 - ec2: jumping into Amazon's cloud has never been so easy.
 
-More formats are coming. Checkout {SUSE Studio}[http://susestudio.com] for 
+More formats are coming. Checkout {SUSE Studio}[http://susestudio.com] for
 more details.
 
+Currently only MRI Ruby 1.8 is supported, but support for 1.9 and REE is
+forthcoming.
+
 == Common workflow
 
-This section will show the common workflow required to create a SUSE Studio 
+This section will show the common workflow required to create a SUSE Studio
 appliance running a standard Rails application.
 
 All the following commands must be executed inside of the root directory of
@@ -39,8 +42,8 @@ your rails application.
 === Create
 You can create your SUSE Studio appliance using the following command:
     dister create APPLIANCE_NAME
-The following code creates a 32bit appliance based on the latest version of
-openSUSE supported by SUSE Studio. The appliance will use the 
+This creates a 32bit appliance based on the latest version of openSUSE supported
+by SUSE Studio. The appliance will use the
 {JeOS}[http://en.wikipedia.org/wiki/Just_enough_operating_system] template.
 
 You can change the default behaviour using the following command line options:
@@ -48,16 +51,17 @@ You can change the default behaviour using the following command line options:
 - <tt>--template</tt>: to use something different from the JeOS template.
 - <tt>--arch</tt>: to build a 64bit appliance.
 
-By default all the appliances created by dister have the <em>devel:language:ruby:extensions</em>
-repository. This repository contains all the ruby-related packages.
-It's actively maintained by the openSUSE community and by some Novell employee.
+By default all the appliances created by dister have the
+<em>devel:language:ruby:extensions</em> repository. This repository contains all
+the Ruby-related packages.  It's actively maintained by the openSUSE community
+and by some Novell employee.
 
 The following packages are automatically added to all appliances:
-- devel_C_C++ and devel_Ruby: these are needed in order to build native gems.
-- rubygem-bundler: this package provides latest version of bundler.
-- rubygem-passenger-apache2: this package is required in order to deploy your
-  rails application using Apache. All the Apache packages will be automatically
-  installed by SUSE Studio because they are dependencies of rubygem-passenger-apache2.
+- <tt>devel_C_C++</tt> and +devel_Ruby+: these are needed in order to build native gems.
+- +rubygem-bundler+: this package provides latest version of bundler.
+- +rubygem-passenger-apache2+: this package is required in order to deploy your
+  Rails application using Apache. All the Apache packages will be automatically
+  installed by SUSE Studio because they are dependencies of +rubygem-passenger-apache2+.
 
 The create task takes care of uploading some custom build and boot scripts.
 These scripts take care of initializing your appliance. You can inspect them
@@ -70,15 +74,30 @@ In order to add your rails application to your SUSE Studio appliance just execut
 This will automatically create (or update) your local bundle and upload it to
 SUSE Studio.
 Your bundle contains:
-- all the gems needed by your rails appliance (this is done using bundler).
+- all the gems needed by your Rails appliance (this is done using bundler).
 - all your code
-- apache configuration
+- Apache configuration
 
 === Build
 Building can be triggered using the following command:
     dister build
 A nice progress bar will be shown.
 
+=== Testdrive
+After your build has completed, you can testdrive your appliance:
+    dister testdrive
+
+Currently you have to access your testdrive using VNC, but support for the
+web-based Flash interface is on the way.
+
+=== Download
+If you're happy with what you saw during your testdrive, you can download the
+appliance:
+    dister download
+
+You can then deploy it. We want to support direct deployment to EC2 in future
+versions.
+
 TODO: write more documentation.
 
 == License

data/Rakefile

@@ -1,6 +1,5 @@
 require 'bundler'
 require 'rake'
-require 'rake/rdoctask'
 require 'rake/testtask'
 Bundler::GemHelper.install_tasks
 
@@ -13,14 +12,9 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-desc 'Generate documentation.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'dister'
-  rdoc.options << '--line-numbers' << "--main" << "README.rdoc"
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  puts "Yard not available. To generate documentation install it with: gem install yard"
 end
-
-desc "Clean files generated by rake tasks"
-task :clobber => [:clobber_rdoc]

data/dister.gemspec

@@ -15,15 +15,17 @@ Gem::Specification.new do |s|
   s.rubyforge_project         = "dister"
 
   s.add_dependency "curb"
+  s.add_dependency "highline", "~>1.6.1"
   s.add_dependency "progressbar"
-  s.add_dependency "studio_api", "~>3.1.1"
+  s.add_dependency "studio_api", "~>3.2"
   s.add_dependency "thor", "~>0.14.0"
 
-  s.add_development_dependency "bundler", "~>1.0.0"
+  s.add_development_dependency "bundler"
   s.add_development_dependency "fakefs"
   s.add_development_dependency "mocha"
   s.add_development_dependency "test-unit", "1.2.3"
   s.add_development_dependency "shoulda"
+  s.add_development_dependency "yard"
   s.files        = `git ls-files`.split("\n")
   s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
   s.require_path = 'lib'

data/lib/dister.rb

@@ -1,10 +1,11 @@
 require 'rubygems'
+require 'erb'
 require 'thor'
 require 'studio_api'
 require 'yaml'
 require 'progressbar'
-require 'bundler'
 require 'curb'
+require 'highline/import'
 
 require File.expand_path('../dister/cli', __FILE__)
 require File.expand_path('../dister/constants', __FILE__)

data/lib/dister/cli.rb

@@ -1,14 +1,23 @@
 module Dister
 
+  # This is the public facing command line interface which is available through
+  # the +dister+ command line tool. Use +dister --help+ for usage instructions.
   class Cli < Thor
+
     include Thor::Actions
 
-    # Returns Dister's root directory.
     # NOTE: Some of Thor's actions require this method to be defined.
+    # @return [String] Dister's root directory.
     def self.source_root
       File.expand_path('../../',__FILE__)
     end
 
+    desc "version", "Show dister version"
+    def version
+      require "dister/version"
+      puts "dister version #{Dister::VERSION}"
+    end
+
     desc "config OPTION VALUE", "set OPTION value to VALUE"
     method_option :local,
       :type => :boolean, :default => false, :required => false
@@ -36,14 +45,13 @@ module Dister
         # attempt to find latest version of openSUSE
         basesystem = basesystems.find_all{|a| a =~ /\d+\.\d+/}.sort.last
         if basesystem.nil?
-          # apparently this server doesn't offer openSUSE basesystem
-          @shell.say "Available base systems:"
-          basesystems.each_with_index { |b,i| @shell.say "#{i+1} - #{b}" }
-          begin
-            choice = @shell.ask("Which base system do you want to use?"\
-                                "[1-#{basesystems.size}]")
-          end while (choice.to_i > basesystems.size || choice.to_i < 1)
-          basesystem = basesystems[choice.to_i - 1]
+          # apparently this server doesn't offer openSUSE basesystem, so we
+          # present the user with a menu with available choices
+          basesystem = choose do |menu|
+            menu.header = "Available base systems"
+            menu.choices *basesystems
+            menu.prompt = "Which base system do you want to use?"
+          end
         end
       else
         basesystem = options[:basesystem]

data/lib/dister/core.rb

@@ -1,16 +1,17 @@
 require 'digest/md5'
-require 'erb'
 
 module Dister
 
+  # Core functionality
   class Core
 
     attr_reader :options, :shell
 
+    # Absolute path to the root of the current application
     APP_ROOT = File.expand_path('.')
 
     # Connect to SUSE Studio and verify the user's credentials.
-    # Sets @options, @shell and @connection for further use.
+    # Sets +@options+, +@shell+ and +@connection+ for further use.
     def initialize
       @options ||= Options.new
       @shell = Thor::Shell::Basic.new
@@ -33,10 +34,10 @@ module Dister
       true
     rescue ActiveResource::UnauthorizedAccess
       puts 'A connection to SUSE Studio could not be established.'
-      keep_trying = @shell.ask(
+      keep_trying = @shell.yes?(
         'Would you like to re-enter your credentials and try again? (y/n)'
       )
-      if keep_trying == 'y'
+      if keep_trying
         update_credentials
         retry
       else
@@ -45,7 +46,13 @@ module Dister
     end
 
     # Creates a new appliance.
-    # Returns the new appliance.
+    #
+    # @param [String] name
+    # @param [String] template
+    # @param [String] basesystem
+    # @param [String] arch
+    #
+    # @return [StudioApi::Appliance] the new appliance
     def create_appliance(name, template, basesystem, arch)
       match = check_template_and_basesystem_availability(template, basesystem)
       exit 1 if match.nil?
@@ -57,15 +64,12 @@ module Dister
       end
       @options.appliance_id = app.id
       ensure_devel_languages_ruby_extensions_repo_is_added
-      self.add_package "devel_C_C++"
-      self.add_package "devel_ruby"
-      self.add_package 'rubygem-bundler'
-      self.add_package 'rubygem-passenger-apache2'
-      unless @db_adapter.nil?
-        @db_adapter.packages.each do |p|
-          self.add_package p
-        end
-      end
+
+      default_packages = %w(devel_C_C++ devel_ruby
+                            rubygem-bundler rubygem-passenger-apache2)
+
+      self.add_packages(default_packages)
+      self.add_packages(@db_adapter.packages) unless @db_adapter.nil?
 
       Utils::execute_printing_progress "Uploading build scripts" do
         upload_configurations_scripts
@@ -75,6 +79,10 @@ module Dister
       app
     end
 
+    # Builds the appliance
+    #
+    # @param [Hash] build_options
+    # @option build_options [Boolean] :force
     def build build_options = {}
       verify_status
       #TODO:
@@ -91,8 +99,7 @@ module Dister
         build = StudioApi::RunningBuild.create(params)
       rescue StudioApi::ImageAlreadyExists
         @shell.say 'An image with the same version already exists'
-        overwrite = @shell.ask 'Do you want to overwrite it? (y/n)'
-        if overwrite == 'y'
+        if @shell.yes? 'Do you want to overwrite it? (y/n)'
           force = true
           retry
         else
@@ -108,9 +115,7 @@ module Dister
         puts "Your build is queued. It will be automatically processed by "\
              "SUSE Studio. You can keep waiting or you can exit from dister."
         puts "Exiting from dister won't remove your build from the queue."
-        shell = Thor::Shell::Basic.new
-        keep_waiting = @shell.ask('Do you want to keep waiting (y/n)')
-        if keep_waiting == 'n'
+        if @shell.no?('Do you want to keep waiting (y/n)')
           exit 0
         end
 
@@ -134,7 +139,8 @@ module Dister
       build.state == 'finished'
     end
 
-    # Returns an app's appliance (or nil if none exist).
+    # Finds the appliance for the current app
+    # @return [StudioApi::Appliance] the app's appliance (or nil if none exist).
     def appliance
       if @appliance.nil?
         begin
@@ -150,6 +156,8 @@ module Dister
       end
     end
 
+    # Finds all builds
+    # @return [Array<StudioApi::Build>]
     def builds
       StudioApi::Build.find(:all, :params => {:appliance_id => @options.appliance_id})
     end
@@ -165,6 +173,8 @@ module Dister
       end
     end
 
+    # Find available base systems
+    # @return [Array<String>] a list of available base systems
     def basesystems
       templates.collect(&:basesystem).uniq
     end
@@ -188,15 +198,21 @@ module Dister
     end
 
     # Uploads a file identified by filename to a SuSE Studio Appliance
-    # options is an hash. it can have the following keys:
-    # - filename (optional) - The name of the file in the filesystem.
-    # - path (optional) - The path where the file will be stored.
-    # - owner (optional) - The owner of the file.
-    # - group (optional) - The group of the file.
-    # - permissions (optional) - The permissions of the file.
-    # - enabled (optional) - Used to enable/disable this file for the builds.
-    # - url (optional) - The url of the file to add from the internet (HTTP and FTP are supported) when using the web upload method
-    # This method returns true if the file has been successfully uploaded
+    #
+    # @param [String] filename name of file to upload
+    # @param [Hash] upload_options upload options (all parameters are optional)
+    # @option upload_options [String] filename The name of the file in the
+    #   filesystem
+    # @option upload_options [String] path The path where the file will be stored
+    # @option upload_options [String] owner The owner of the file
+    # @option upload_options [String] group The group of the file
+    # @option upload_options [String] permissions The permissions of the file
+    # @option upload_options [String] enabled Used to enable/disable this file
+    #   for the builds
+    # @option upload_options [String] url The url of the file to add from the
+    #   internet (HTTP and FTP are supported) when using the web upload method
+    #
+    # @return [Boolean] true if the file has been successfully uploaded
     def file_upload filename, upload_options={}
       if File.exists? filename
         # Delete existing (obsolete) file.
@@ -231,7 +247,11 @@ module Dister
       puts 'Packaging gems...'
       system "cd #{APP_ROOT}"
       system "rm -R vendor/cache" if File.exists?("#{APP_ROOT}/vendor/cache")
-      system 'bundle package'
+      success = system 'bundle package'
+      unless success
+        STDERR.puts "`bundle package` failed, exiting"
+        exit 1
+      end
       puts "Done!"
     end
 
@@ -280,6 +300,8 @@ module Dister
       self.file_upload("#{APP_ROOT}/.dister/create_db_user.sql", upload_options)
     end
 
+    # Add a package to the appliance
+    # @param [String] package the name of the package
     def add_package package
       appliance_basesystem = appliance.basesystem
       result = appliance.search_software(package)#.find{|s| s.name == package }
@@ -288,9 +310,9 @@ module Dister
       if result.empty? #it is not found in available repos
         puts "'#{package}' has not been found in the repositories currently "\
              "added to your appliance."
-        keep_trying = @shell.ask('Would you like to search for this package '\
+        keep_trying = @shell.yes?('Would you like to search for this package '\
                                 'inside other repositories? (y/n)')
-        if keep_trying == 'y'
+        if keep_trying
           matches = appliance.search_software(package, :all_repos => true)\
                              .find_all { |s| s.name == package }
           repositories = matches.map do |r|
@@ -330,6 +352,14 @@ module Dister
       end
     end
 
+    # Add a list of packages at once
+    # @param [Array<String>] packages
+    def add_packages(packages)
+      packages.each { |package| self.add_package(package) }
+    end
+
+    # Remove a package from the appliance
+    # @param [String] package the name of the package
     def rm_package package
       Utils::execute_printing_progress "Removing #{package} package" do
         appliance.remove_package(package)
@@ -337,6 +367,7 @@ module Dister
     end
 
     # Uploads our configuration scripts
+    # @return [true] if the scripts are successfully uploaded
     def upload_configurations_scripts
       rails_root = "/srv/www/#{@options.app_name}"
 
@@ -359,7 +390,7 @@ module Dister
     end
 
     # Asks Studio to mirror a repository.
-    # Returns a StudioApi::Repository object
+    # @return [StudioApi::Repository]
     def import_repository url, name
       StudioApi::Repository.import url, name
     end
@@ -390,6 +421,9 @@ module Dister
       when "SLED11_SP1", "SLES11_SP1", "SLES11_SP1_VMware"
         url += "SLE_11_SP1"
         name += " SLE11 SP1"
+      when "SLES11_SP2", "SLES11_SP2"
+        url += "SLE_11_SP2"
+        name += " SLE11 SP2"
       else
         STDERR.puts "#{appliance.basesystem}: unknown base system"
         exit 1
@@ -418,6 +452,7 @@ module Dister
       end
     end
 
+    # @param [Array] build_set
     def testdrive(build_set)
       build = build_set[0] # for now we just take the first available build
       testdrive = Utils::execute_printing_progress "Starting testdrive" do
@@ -435,37 +470,29 @@ module Dister
       puts "Password: #{vnc.password}"
     end
 
+    # @param [Array] build_set
     def download(build_set)
       # Choose the build(s) to download.
       to_download = []
       if build_set.size == 1
         to_download << build_set.first
       else
-        build_set.each_with_index do |build, index|
-          puts "#{index+1}) #{build.to_s}"
-        end
-        puts "#{build_set.size+1}) All of them."
-        puts "#{build_set.size+2}) None."
-        begin
-          choice = @shell.ask "Which appliance do you want to download? [1-#{build_set.size+1}]"
-        end while (choice.to_i > (build_set.size+2))
-        if choice.to_i == (build_set.size+2)
-          # none selected
-          exit 0
-        elsif choice.to_i == (build_set.size+1)
-          # all selected
-          to_download = build_set
-        else
-          to_download << build_set[choice.to_i-1]
+        to_download = choose do |menu|
+          menu.choices *build_set do |i| [i] end # wrap choice in an array
+          menu.choice("All of them.") { build_set }
+          menu.choice("None.") { exit 0 }
+          menu.prompt = "Which appliance do you want to download?"
         end
       end
+
       # Download selected builds.
       to_download.each do |b|
         puts "Going to download #{b.to_s}"
         d = Downloader.new(b.download_url.sub("https:", "http:"),"Downloading")
         if File.exists? d.filename
-          overwrite = @shell.ask("Do you want to overwrite file #{d.filename}? (y/n)")
-          exit 0 if overwrite == 'n'
+          if @shell.no?("Do you want to overwrite file #{d.filename}? (y/n)")
+            exit 0
+          end
         end
         begin
           d.start
@@ -492,6 +519,7 @@ module Dister
       @options.api_key = @shell.ask("API key:\t")
     end
 
+    # @return [Dister::DbAdapter]
     def get_db_adapter
       db_config_file = "#{APP_ROOT}/config/database.yml"
       if !File.exists?(db_config_file)
@@ -504,5 +532,7 @@ module Dister
         Dister::DbAdapter.new db_config_file
       end
     end
+
   end
+
 end

data/lib/dister/db_adapter.rb

@@ -1,31 +1,40 @@
-require 'erb'
-
 module Dister
+
+  # Wrapper class for the database adapter specified in the application's
+  # +database.yml+. Also handles database credentials, and dump/restore.
+  # Currently this only works with ActiveRecord.
   class DbAdapter
 
+    # Initialize a new DbAdapter. May raise exceptions if the input is erronous.
+    #
+    # @param [String] db_config_file path to the database configuration (.yml)
+    # @param [String] dump filename of dump
     def initialize db_config_file, dump=nil
       config = YAML.load_file(db_config_file)
       if !config.has_key?("production")
         STDERR.puts "There's no configuration for the production environment"
       end
-      
+
       @adapter  = config["production"]["adapter"]
       @user     = config["production"]["username"]
-      @password = config["production"]["password"] 
-      @dbname   = config["production"]["adapter"] 
+      @password = config["production"]["password"]
+      @dbname   = config["production"]["adapter"]
       @dump     = dump
-      
+
       filename = File.expand_path("../../adapters/#{@adapter}.yml", __FILE__)
       raise "There's no adapter for #{@adapter}" if !File.exists?(filename)
 
       @adapter_config = YAML.load_file(filename)
     end
 
+    # Checks if there is a db dump
+    #
+    # @return [Boolean] true if there is a dump file, false otherwise
     def has_dump?
       return false if @dump.nil?
       return File.exists? @dump
     end
-    
+
     def cmdline_tool
       @adapter_config["cmdline_tool"]
     end
@@ -53,5 +62,7 @@ module Dister
       erb = ERB.new cmd
       erb.result(binding)
     end
+
   end
+
 end

data/lib/dister/downloader.rb

@@ -1,12 +1,15 @@
 module Dister
+
+  # Curl wrapper for downloading appliance builds.
   class Downloader
     attr_reader :filename
 
-
+    # @param [String] url URL of file to be downloaded
+    # @param [String] message Message to be displayed while downloading
     def initialize url, message
       @filename = File.basename(url)
       @message  = message
-      
+
       # setup curl
       @curl = Curl::Easy.new
       @curl.url = url
@@ -21,6 +24,7 @@ module Dister
       end
     end
 
+    # Starts the download
     def start
       @file = File.open(@filename, "wb")
       @pbar = ProgressBar.new(@message, 100)
@@ -53,5 +57,7 @@ module Dister
         @file.close
       end
     end
+
   end
+
 end

data/lib/dister/options.rb

@@ -1,15 +1,22 @@
 require 'fileutils'
 
 module Dister
+
+  # Class for handling user- and application-specific settings
   class Options
 
+    # Default API path, used unless a custom path is specified
     SUSE_STUDIO_DOT_COM_API_PATH = 'https://susestudio.com/api/v2/user'
+    # Path to global (per-user) options file
     GLOBAL_PATH = "#{File.expand_path('~')}/.dister"
+    # Path to app-specific options file
     LOCAL_PATH = "#{Dister::Core::APP_ROOT}/.dister/options.yml"
 
     attr_reader :use_only_local
 
     # Read options from file.
+    #
+    # @param [Boolean] use_only_local Use only local options?
     def initialize use_only_local=false
       @use_only_local = use_only_local
       reload
@@ -27,7 +34,8 @@ module Dister
       end
     end
 
-    # Read @global and @local option files.
+    # Read +@global+ and +@local+ option files. Run this method if their
+    # contents has changed.
     def reload
       if @use_only_local
         @global = {}
@@ -104,6 +112,8 @@ module Dister
     # Returns a hash consisting of both global and local options.
     # All options can be read through this method.
     # NOTE: Local options override global options.
+    #
+    # @return [Hash] a hash consisting of both global and local options
     def provide
       @global.merge(@local)
     end

data/lib/dister/utils.rb

@@ -1,6 +1,10 @@
 module Dister
+
+  # Shared utility methods
   module Utils
+
     module_function
+
     # Shows message and prints a dot per second until the block code
     # terminates its execution.
     # Exceptions raised by the block are displayed and program exists with
@@ -31,7 +35,10 @@ module Dister
     MEGA_SIZE = 1048576.0
     KILO_SIZE = 1024.0
 
-    # Return the file size with a readable style.
+    # @param [Number] size Size to be converted
+    # @param [Number] precision Number of decimals desired
+    #
+    # @return [String] Return the file size with a readable style.
     def readable_file_size(size, precision)
       case
         when size == 1 then "1 Byte"

data/lib/dister/version.rb

@@ -1,5 +1,5 @@
 module Dister
 
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 
 end

data/test/cli_test.rb

@@ -131,8 +131,7 @@ class CliTest < Test::Unit::TestCase
         end
 
         should "ask the user which base system to use" do
-          Thor::Shell::Color.any_instance.stubs(:say)
-          Thor::Shell::Color.any_instance.expects(:ask).returns(1)
+          HighLine.any_instance.stubs(:choose).returns("SLED10_SP2")
           fake_app = mock()
           fake_app.stubs(:edit_url).returns("http://susestudio.com")
           Dister::Core.any_instance.expects(:create_appliance).\
@@ -143,7 +142,7 @@ class CliTest < Test::Unit::TestCase
             Dister::Cli.start(['create', 'foo'])
           end
         end
-        
+
         should "not ask the user which base system to use if there's a preference" do
           Thor::Shell::Color.any_instance.expects(:ask).never
           fake_app = mock()

data/test/core_test.rb

@@ -39,6 +39,11 @@ class CoreTest < Test::Unit::TestCase
         @core.stubs(:puts)
       end
 
+      should 'skip packaging gems unless there is a Gemfile' do
+        File.expects(:exists?).returns(false)
+        assert_nil @core.package_gems
+      end
+
       should 'package all required gems' do
         File.expects(:exists?).returns(true)
         @core.expects(:system).with("cd #{Dister::Core::APP_ROOT}").once.returns(true)
@@ -48,6 +53,17 @@ class CoreTest < Test::Unit::TestCase
         @core.package_gems
       end
 
+      should 'exit if gem packaging fails' do
+        File.expects(:exists?).returns(true)
+        @core.expects(:system).with("cd #{Dister::Core::APP_ROOT}").once.returns(true)
+        File.expects(:exists?).returns(true)
+        @core.expects(:system).with("rm -R vendor/cache").once.returns(true)
+        @core.expects(:system).with("bundle package").once.returns(false)
+        assert_raise SystemExit do
+          @core.package_gems
+        end
+      end
+
       should "create a tarball of the application's source files" do
         File.stubs(:exists?).returns(true)
         @core.expects(:system).with("rm .dister/dister_application.tar.gz").once.returns(true)

data/test/test_helper.rb

@@ -1,4 +1,5 @@
 require File.expand_path('../../lib/dister',__FILE__)
+require 'bundler/setup' # Use bundled environment for testing
 require 'test/unit'
 require 'mocha'
 require 'shoulda'

data/test/utils_test.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class UtilsTest < Test::Unit::TestCase
+
+  include Dister::Utils
+
+  should "return readable file sizes" do
+    assert_equal readable_file_size(12233, 0), "12 KB"
+    assert_equal readable_file_size(12233, 2), "11.95 KB"
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dister
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 800522045387967993
   prerelease: 
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Flavio Castelli
@@ -16,8 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-06 00:00:00 +02:00
-default_executable: 
+date: 2012-04-12 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: curb
@@ -27,132 +26,159 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 2002549777813010636
         segments: 
         - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: progressbar
+  name: highline
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 914886426701899987
+        segments: 
+        - 1
+        - 6
+        - 1
+        version: 1.6.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: progressbar
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 2002549777813010636
         segments: 
         - 0
         version: "0"
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: studio_api
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 1
+        hash: 1144350831328566222
         segments: 
         - 3
-        - 1
-        - 1
-        version: 3.1.1
+        - 2
+        version: "3.2"
   type: :runtime
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: thor
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 39
+        hash: 4540094552861788330
         segments: 
         - 0
         - 14
         - 0
         version: 0.14.0
   type: :runtime
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: bundler
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 23
+        hash: 2002549777813010636
         segments: 
-        - 1
         - 0
-        - 0
-        version: 1.0.0
+        version: "0"
   type: :development
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: fakefs
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 2002549777813010636
         segments: 
         - 0
         version: "0"
   type: :development
-  version_requirements: *id006
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: mocha
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 2002549777813010636
         segments: 
         - 0
         version: "0"
   type: :development
-  version_requirements: *id007
+  version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   name: test-unit
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 25
+        hash: 1882242982824780815
         segments: 
         - 1
         - 2
         - 3
         version: 1.2.3
   type: :development
-  version_requirements: *id008
+  version_requirements: *id009
 - !ruby/object:Gem::Dependency 
   name: shoulda
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 2002549777813010636
         segments: 
         - 0
         version: "0"
   type: :development
-  version_requirements: *id009
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 2002549777813010636
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id011
 description: Turn your rails app into a SUSE Studio appliance in a few steps.
 email: 
 - flavio@castelli.name
@@ -165,6 +191,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .yardopts
 - Changelog
 - Gemfile
 - LICENSE
@@ -197,7 +224,7 @@ files:
 - test/fixtures/unsupported_database.yml
 - test/options_test.rb
 - test/test_helper.rb
-has_rdoc: true
+- test/utils_test.rb
 homepage: https://github.com/flavio/dister
 licenses: []
 
@@ -211,7 +238,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 2002549777813010636
       segments: 
       - 0
       version: "0"
@@ -220,7 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 23
+      hash: 2387630629434237851
       segments: 
       - 1
       - 3
@@ -229,9 +256,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: dister
-rubygems_version: 1.6.2
+rubygems_version: 1.8.12
 signing_key: 
 specification_version: 3
 summary: Heroku like solution for SUSE Studio
 test_files: []
 
+has_rdoc: