Module: Capifony::Symfony2

Defined in:

lib/capifony_symfony2.rb

Class Method Summary

• .load_into(configuration) ⇒ Object

Class Method Details

.load_into(configuration) ⇒ Object

# File 'lib/capifony_symfony2.rb', line 13

def self.load_into(configuration)
  configuration.load do

    load_paths.push File.expand_path('../', __FILE__)
    load 'capifony'
    load 'symfony2/symfony'
    load 'symfony2/database'
    load 'symfony2/deploy'
    load 'symfony2/doctrine'
    load 'symfony2/propel'
    load 'symfony2/web'
    load 'symfony2/shared'

    # Symfony application path
    set :app_path,              "app"

    # Symfony web path
    set :web_path,              "web"

    # Symfony console bin
    set :symfony_console,       app_path + "/console"

    # Symfony debug flag for console commands
    set :symfony_debug,         false

    # Symfony log path
    set :log_path,              app_path + "/logs"

    # Symfony cache path
    set :cache_path,            app_path + "/cache"

    # Symfony config file path
    set :app_config_path,       app_path + "/config"

    # Symfony config file (parameters.(ini|yml|etc...)
    set :app_config_file,       "parameters.yml"

    # Symfony bin vendors
    set :symfony_vendors,       "bin/vendors"

    # Symfony build_bootstrap script
    set :build_bootstrap,       "bin/build_bootstrap"

    # Whether to use composer to install vendors.
    # If set to false, it will use the bin/vendors script
    set :use_composer,          true

    # Whether to use composer to install vendors to a local temp directory.
    set :use_composer_tmp,     false

    # Path to composer binary
    # If set to false, Capifony will download/install composer
    set :composer_bin,          false

    # Release number to composer
    # If you would like to instead update to a specific release simply specify it (for example '1.0.0-alpha8')
    set :composer_version,      ""

    # Options to pass to composer when installing/updating
    set :composer_options,      "--no-dev --verbose --prefer-dist --optimize-autoloader --no-progress"

    # Options to pass to composer when dumping the autoloader (dump-autoloader)
    set :composer_dump_autoload_options, "--optimize"

    # Whether to update vendors using the configured dependency manager (composer or bin/vendors)
    set :update_vendors,        false

    # run bin/vendors script in mode (upgrade, install (faster if shared /vendor folder) or reinstall)
    set :vendors_mode,          "reinstall"

    # Copy vendors from previous release
    set :copy_vendors,          false

    # Whether to run cache warmup
    set :cache_warmup,          true

    # Use AsseticBundle
    set :dump_assetic_assets,   false

    # Assets install
    set :assets_install,        false
    set :assets_symlinks,       false
    set :assets_relative,       false
    set :assets_install_path,   web_path

    # Whether to update `assets_version` parameter in `assets_version.yml`
    set :update_assets_version, false

    # Whether to normalize assets timestamps
    set :normalize_asset_timestamps, false

    # Need to clear *_dev controllers
    set :clear_controllers,     true

    # Controllers to clear
    set :controllers_to_clear, ['app_*.php']

    # Files that need to remain the same between deploys
    set :shared_files,          false

    # Dirs that need to remain the same between deploys (shared dirs)
    set :shared_children,       [log_path, web_path + "/uploads"]

    # Asset folders (that need to be timestamped)
    set :asset_children,        [web_path + "/css", web_path + "/images", web_path + "/js"]

    # Dirs that need to be writable by the HTTP Server (i.e. cache, log dirs)
    set :writable_dirs,         [log_path, cache_path]

    # Name used by the Web Server (i.e. www-data for Apache)
    set :webserver_user,        "www-data"

    # Method used to set permissions (:chmod, :acl, or :chown)
    set :permission_method,     false

    # Execute set permissions
    set :use_set_permissions,   false

    # Model manager: (doctrine, propel)
    set :model_manager,         "doctrine"

    # Doctrine custom entity manager
    set :doctrine_em,           false

    # Database backup folder
    set :backup_path,           "backups"

    # Use --flush option in doctrine:clear_* task
    set :doctrine_clear_use_flush_option, false

    # Symfony2 version
    set(:symfony_version)       { guess_symfony_version }

    # If set to false, it will never ask for confirmations (migrations task for instance)
    # Use it carefully, really!
    set :interactive_mode,      true

    def load_database_config(data, env)
      read_parameters(data)['parameters']
    end

    def read_parameters(data)
      if '.ini' === File.extname(app_config_file) then
        File.readable?(data) ? IniFile::load(data) : IniFile.new(data)
      else
        YAML::load(data)
      end
    end

    def guess_symfony_version
      capture("cd #{latest_release} && #{php_bin} #{symfony_console} --version |cut -d \" \" -f 3")
    end

    def remote_file_exists?(full_path)
      'true' == capture("if [ -e #{full_path} ]; then echo 'true'; fi").strip
    end

    def remote_command_exists?(command)
      'true' == capture("if [ -x \"$(which #{command})\" ]; then echo 'true'; fi").strip
    end

    def console_options
      console_options = "--env=#{symfony_env_prod}"

      if !symfony_debug
         console_options += " --no-debug"
      end

      return console_options
    end

    STDOUT.sync
    $error = false
    $pretty_errors_defined = false

    # Be less verbose by default
    logger.level = Capistrano::Logger::IMPORTANT

    def capifony_pretty_print(msg)
      if logger.level == Capistrano::Logger::IMPORTANT
        pretty_errors

        msg = msg.slice(0, 57)
        msg << '.' * (60 - msg.size)
        print msg
      else
        puts msg.green
      end
    end

    def capifony_puts_ok
      if logger.level == Capistrano::Logger::IMPORTANT && !$error
        puts '✔'.green
      end

      $error = false
    end

    def pretty_errors
      if !$pretty_errors_defined
        $pretty_errors_defined = true

        class << $stderr
          @@firstLine = true
          alias _write write

          def write(s)
            if @@firstLine
              _write('✘'.red << "\n")  
              @@firstLine = false
            end

            _write(s.red)
            $error = true
          end
        end
      end
    end

    $progress_bar = nil
    $download_msg_padding = nil

    def capifony_progress_start(msg = "--> Working")
      $download_msg_padding = '.' * (60 - msg.size)
      # Format is equivalent to "Title............82% ETA: 00:00:12"
      $progress_bar = ProgressBar.create(
        :title => msg,
        :format => "%t%B %p%% %e",
        :length => 60,
        :progress_mark => "."
      )
    end

    def capifony_progress_update(current, total)
      unless $progress_bar
        raise "Please create a progress bar using capifony_progress_start"
      end

      percent = (current.to_f / total.to_f * 100).floor

      if percent > 99
        green_tick = '✔'.green
        # Format is equivalent to "Title.............✔"
        $progress_bar.format("%t#{$download_msg_padding}#{green_tick}")
      end

      $progress_bar.progress = percent
    end

    [
      "symfony:doctrine:cache:clear_metadata",
      "symfony:doctrine:cache:clear_query",
      "symfony:doctrine:cache:clear_result",
      "symfony:doctrine:schema:create",
      "symfony:doctrine:schema:drop",
      "symfony:doctrine:schema:update",
      "symfony:doctrine:load_fixtures",
      "symfony:doctrine:migrations:migrate",
      "symfony:doctrine:migrations:status",
    ].each do |action|
      before action do
        set :doctrine_em_flag, doctrine_em ? " --em=#{doctrine_em}" : ""
      end
    end

    ["symfony:composer:install", "symfony:composer:update", "symfony:vendors:install", "symfony:vendors:upgrade"].each do |action|
      before action do
        if copy_vendors
          symfony.composer.copy_vendors
        end
      end
    end

    after "deploy:finalize_update" do
      if update_assets_version
        symfony.assets.update_version
      end

      if normalize_asset_timestamps
        symfony.assets.normalize_timestamps
      end

      if use_composer && !use_composer_tmp
        if update_vendors
          symfony.composer.update
        else
          symfony.composer.install
        end
      else
        if update_vendors
          vendors_mode.chomp # To remove trailing whiteline
          case vendors_mode
          when "upgrade" then symfony.vendors.upgrade
          when "install" then symfony.vendors.install
          when "reinstall" then symfony.vendors.reinstall
          end
        end
      end

      if model_manager == "propel"
        symfony.propel.build.model
      end

      if assets_install
        symfony.assets.install          # Install assets
      end

      if dump_assetic_assets
        symfony.assetic.dump            # Dump assetic assets
      end

      if cache_warmup
        symfony.cache.warmup            # Warmup clean cache
      end

      if clear_controllers
        # If clear_controllers is an array set controllers_to_clear,
        # else use the default value 'app_*.php'
        if clear_controllers.is_a? Array
          set(:controllers_to_clear) { clear_controllers }
        end
        symfony.project.clear_controllers
      end

      if use_set_permissions
        # Set permissions after all cache files have been created
        symfony.deploy.set_permissions
      end
    end

    before "deploy:update_code" do
      msg = "--> Updating code base with #{deploy_via} strategy"

      if logger.level == Capistrano::Logger::IMPORTANT
        pretty_errors
        puts msg
      else
        puts msg.green
      end
    end

    after "deploy:create_symlink" do
      puts "--> Successfully deployed!".green
    end
  end

end