deployml 0.3.0

data/.document

@@ -0,0 +1,3 @@
+- 
+LICENSE.txt
+ChangeLog.*

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title 'DeploYML Documentation' --protected

data/ChangeLog.md

@@ -0,0 +1,22 @@
+### 0.3.0 / 2010-11-21
+
+* Initial release:
+  * Requires only **one YAML file** (`config/deploy.yml`) with a minimum of
+    **two** things (`source` and `dest`).
+  * Supports multiple deployment environments (`config/deploy/staging.yml`).
+  * Supports [Git](http://www.git-scm.com/).
+  * Can deploy Ruby web applications or static sites.
+  * Supports common Web Servers:
+    * [Apache](http://www.apache.org/)
+    * [Mongrel](https://github.com/fauna/mongrel)
+    * [Thin](http://code.macournoyer.com/thin/)
+  * Supports common Web Application frameworks:
+    * [Rails](http://rubyonrails.org/):
+      * [Bundler](http://gembundler.com/)
+      * ActiveRecord
+      * [DataMapper](http://datamapper.org/)
+  * **Does not** require anything else to be installed on the servers.
+  * **Does not** use `net-ssh`.
+  * Supports any Operating System that supports Ruby and SSH.
+  * Provides a simple command-line interface using Thor.
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+
+Copyright (c) 2010 Hal Brodigan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,107 @@
+# DeploYML
+
+* [Source](http://github.com/postmodern/deployml)
+* [Issues](http://github.com/postmodern/deployml/issues)
+* Postmodern (postmodern.mod3 at gmail.com)
+
+## Description
+
+DeploYML is a simple deployment solution that uses a single YAML file,
+Git and SSH.
+
+## Features
+
+* Requires only **one YAML file** (`config/deploy.yml`) with a minimum of
+  **two** things (`source` and `dest`).
+* Supports multiple deployment environments (`config/deploy/staging.yml`).
+* Supports [Git](http://www.git-scm.com/).
+* Can deploy Ruby web applications or static sites.
+* Supports common Web Servers:
+  * [Apache](http://www.apache.org/)
+  * [Mongrel](https://github.com/fauna/mongrel)
+  * [Thin](http://code.macournoyer.com/thin/)
+* Supports common Web Application frameworks:
+  * [Rails](http://rubyonrails.org/):
+    * [Bundler](http://gembundler.com/)
+    * ActiveRecord
+    * [DataMapper](http://datamapper.org/)
+* **Does not** require anything else to be installed on the servers.
+* **Does not** use `net-ssh`.
+* Supports any Operating System that supports Ruby and SSH.
+* Provides a simple command-line interface using Thor.
+
+## Examples
+
+Specifying `source` and `dest` URIs as Strings:
+
+    source: git@github.com:user/project.git
+    dest: deploy@www.example.com/var/www/site
+
+Specifying `dest` URI as a Hash:
+      
+    source: git@github.com:user/project.git
+    dest:
+      user: deploy
+      host: www.example.com
+      path: /var/www/site
+
+Specifying a `server` option:
+
+    source: git@github.com:user/project.git
+    dest: deploy@www.example.com/var/www/site
+    server: apache
+
+Specifying a `server` with options:
+
+    source: git@github.com:user/project.git
+    dest: deploy@www.example.com/var/www/site
+    server:
+      name: thin
+      options:
+        servers: 4
+	deamonize: true
+	socket: /var/run/thin.sock
+	rackup: true
+
+## Synopsis
+
+Cold-Deploy a new project:
+
+    $ deployml deploy
+
+Redeploy a project:
+
+    $ deployml redeploy
+
+Run a rake task on the deploy server:
+
+    $ deployml rake 'db:automigrate'
+
+Execute a command on the deploy server:
+
+    $ deployml exec 'whoami'
+
+SSH into the deploy server:
+
+    $ deployml ssh
+
+List available tasks:
+
+    $ deployml help
+
+## Requirements
+
+* [addressable](http://addressable.rubyforge.org/) ~> 2.1.1
+* [rprogram](http://github.com/postmodern/rprogram) ~> 0.2.0
+* [thor](http://github.com/wycats/thor) ~> 0.14.3
+
+## Install
+
+    $ sudo gem install deployml
+
+## Copyright
+
+Copyright (c) 2010 Hal Brodigan
+
+See {file:LICENSE.txt} for license information.
+

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  gem 'ore-tasks', '~> 0.3.0'
+  require 'ore/tasks'
+
+  Ore::Tasks.new
+rescue LoadError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `gem install ore-tasks` to install 'ore/tasks'."
+end
+
+begin
+  gem 'rspec', '~> 2.1.0'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new
+rescue LoadError => e
+  task :spec do
+    abort "Please run `gem install rspec` to install RSpec."
+  end
+end
+task :default => :spec
+
+begin
+  gem 'yard', '~> 0.6.0'
+  require 'yard'
+
+  YARD::Rake::YardocTask.new  
+rescue LoadError => e
+  task :yard do
+    abort "Please run `gem install yard` to install YARD."
+  end
+end

data/bin/deployml

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'deployml/cli'
+
+DeploYML::CLI.start

data/deployml.gemspec

@@ -0,0 +1,10 @@
+# -*- encoding: utf-8 -*-
+
+begin
+  Ore::Specification.new do |gemspec|
+    # custom logic here
+  end
+rescue NameError
+  STDERR.puts "The 'deployml.gemspec' file requires Ore."
+  STDERR.puts "Run `gem install ore-core` to install Ore."
+end

data/gemspec.yml

@@ -0,0 +1,21 @@
+name: deployml
+summary: A simple deployment solution that works.
+description:
+  DeploYML is a simple deployment solution that uses a single YAML file,
+  Git and SSH.
+
+license: MIT
+authors: Postmodern
+email: postmodern.mod3@gmail.com
+homepage: http://github.com/postmodern/deployml
+has_yard: true
+
+dependencies:
+  addressable: ~> 2.1.1
+  rprogram: ~> 0.2.0
+  thor: ~> 0.14.3
+
+development_dependencies:
+  ore-tasks: ~> 0.3.0
+  rspec: ~> 2.1.0
+  yard: ~> 0.6.0

data/lib/deployml/cli.rb

@@ -0,0 +1,192 @@
+require 'deployml/project'
+
+require 'thor'
+require 'pathname'
+
+module DeploYML
+  class CLI < Thor
+
+    namespace 'deploy'
+
+    desc 'exec', 'Runs a command on the deploy server'
+    method_option :environment, :type => :string, :default => 'production'
+    def exec(command)
+      environment.exec(command)
+    end
+
+    desc 'rake', 'Executes a rake task on the deploy server'
+    method_option :environment, :type => :string, :default => 'production'
+    method_option :args, :type => :array
+    def rake(task)
+      environment.rake(task,*(options[:args]))
+    end
+
+    desc 'ssh', 'Starts a SSH session with the deploy server'
+    method_option :environment, :type => :string, :default => 'production'
+    def ssh
+      environment.ssh
+    end
+
+    desc 'setup', 'Sets up the deployment repository for the project'
+    method_option :environment, :type => :string, :default => 'production'
+    def setup
+      status 'Setting up ...'
+
+      project.setup!(options[:environment])
+
+      status 'Setup'
+    end
+
+    desc 'update', 'Updates the deployment repository of the project'
+    method_option :environment, :type => :string, :default => 'production'
+    def update
+      status 'Updating'
+
+      project.update!(options[:environment])
+
+      status 'Updated'
+    end
+
+    desc 'install', 'Installs the project on the deploy server'
+    method_option :environment, :type => :string, :default => 'production'
+    def install
+      status 'Installing ...'
+
+      project.install!(options[:environment])
+
+      status 'Installed'
+    end
+
+    desc 'migrate', 'Migrates the database for the project'
+    method_option :environment, :type => :string, :default => 'production'
+    def migrate
+      status 'Migrating ...'
+
+      project.migrate!(options[:environment])
+
+      status 'Migrated'
+    end
+
+    desc 'config', 'Configures the server for the project'
+    method_option :environment, :type => :string, :default => 'production'
+    def config
+      status 'Configuring ...'
+
+      project.config!(options[:environment])
+
+      status 'Configured'
+    end
+
+    desc 'start', 'Starts the server for the project'
+    method_option :environment, :type => :string, :default => 'production'
+
+    def start
+      status 'Starting ...'
+
+      project.start!(options[:environment])
+
+      status 'Started'
+    end
+
+    desc 'stop', 'Stops the server for the project'
+    method_option :environment, :type => :string, :default => 'production'
+
+    def stop
+      status 'Stopping ...'
+
+      project.stop!(options[:environment])
+
+      status 'Stopped'
+    end
+
+    desc 'restart', 'Restarts the server for the project'
+    method_option :environment, :type => :string, :default => 'production'
+
+    def restart
+      status 'Restarting ...'
+
+      project.restart!(options[:environment])
+
+      status 'Restarted'
+    end
+
+    desc 'deploy', 'Cold-Deploys a new project'
+    method_option :environment, :type => :string, :default => 'production'
+
+    def deploy
+      status 'Deploying ...'
+
+      project.deploy!(options[:environment])
+
+      status 'Deployed'
+    end
+
+    desc 'redeploy', 'Redeploys the project'
+    method_option :environment, :type => :string, :default => 'production'
+
+    def redeploy
+      status 'Redeploying ...'
+
+      project.redeploy!(options[:environment])
+
+      status 'Redeployed'
+    end
+
+    protected
+
+    #
+    # Finds the root of the project, starting at the current working
+    # directory and ascending upwards.
+    #
+    # @return [Pathname]
+    #   The root of the project.
+    #
+    # @since 0.3.0
+    #
+    def find_root
+      Pathname.pwd.ascend do |root|
+        config_dir = root.join(Project::CONFIG_DIR)
+
+        if config_dir.directory?
+          config_file = config_dir.join(Project::CONFIG_FILE)
+          return root if config_file.file?
+
+          environments_dir = config_dir.join(Project::ENVIRONMENTS_DIR)
+          return root if environments_dir.directory?
+        end
+      end
+
+      shell.say "Could not find '#{Project::CONFIG_FILE}' in any parent directories", :red
+      exit -1
+    end
+
+    #
+    # The project.
+    #
+    # @return [Project]
+    #   The project object.
+    #
+    # @since 0.3.0
+    #
+    def project
+      @project ||= Project.new(find_root)
+    end
+
+    #
+    # The selected environment.
+    #
+    # @return [Environment]
+    #   A deployment environment of the project.
+    #
+    # @since 0.3.0
+    #
+    def environment
+      project.environment(options[:environment])
+    end
+
+    def status(message)
+      shell.say_status "[#{options[:environment]}]", message
+    end
+
+  end
+end

data/lib/deployml/configuration.rb

@@ -0,0 +1,149 @@
+require 'deployml/exceptions/missing_option'
+
+require 'addressable/uri'
+
+module DeploYML
+  #
+  # The {Configuration} class loads in the settings from a `deploy.yml`
+  # file.
+  #
+  class Configuration
+
+    # Default SCM to use
+    DEFAULT_SCM = :rsync
+
+    # The server run the deployed project under
+    attr_reader :server_name
+
+    # Options for the server
+    attr_reader :server_options
+
+    # The source URI of the project Git repository.
+    attr_reader :source
+
+    # The destination URI to upload the project to.
+    attr_reader :dest
+
+    # The framework used by the project
+    attr_reader :framework
+
+    # The ORM used by the project
+    attr_reader :orm
+
+    # The environment to run the project in
+    attr_reader :environment
+
+    # Specifies whether to enable debugging.
+    attr_accessor :debug
+
+    #
+    # Creates a new {Configuration} using the given configuration.
+    #
+    # @param [Hash] config
+    #   The configuration for the project.
+    #
+    # @option config [String] :source
+    #   The source URI of the project Git repository.
+    #
+    # @option config [String, Hash] :dest
+    #   The destination URI to upload the project to.
+    #
+    # @option config [Symbol] :framework
+    #   The framework used by the project.
+    #
+    # @option config [Symbol] :orm
+    #   The ORM used by the project.
+    #
+    # @option config [Symbol] :environment
+    #   The environment to run the project in.
+    #
+    # @option config [Boolean] :debug (false)
+    #   Specifies whether to enable debugging.
+    #
+    # @raise [MissingOption]
+    #   The `server` option Hash did not contain a `name` option.
+    #
+    def initialize(config={})
+      @source = nil
+      @dest = nil
+
+      @server_name = nil
+      @server_options = {}
+
+      @framework = nil
+      @orm = nil
+
+      @environment = nil
+      @debug = false
+
+      config = normalize_hash(config)
+
+      if config[:framework]
+        @framework = config[:framework].to_sym
+      end
+
+      if config[:orm]
+        @orm = config[:orm].to_sym
+      end
+
+      case config[:server]
+      when Symbol, String
+        @server_name = config[:server].to_sym
+      when Hash
+        unless config[:server].has_key?(:name)
+          raise(MissingOption,"the 'server' option must contain a 'name' option for which server to use",caller)
+        end
+
+        if config[:server].has_key?(:name)
+          @server_name = config[:server][:name].to_sym
+        end
+
+        if config[:server].has_key?(:options)
+          @server_options.merge!(config[:server][:options])
+        end
+      end
+
+      @source = config[:source]
+      @dest = case config[:dest]
+              when Hash
+                Addressable::URI.new(config[:dest])
+              when String
+                Addressable::URI.parse(config[:dest])
+              end
+
+      if config[:environment]
+        @environment = config[:environment].to_sym
+      end
+
+      if config[:debug]
+        @debug = config[:debug]
+      end
+    end
+
+    protected
+
+    #
+    # Converts all the keys of a Hash to Symbols.
+    #
+    # @param [Hash{Object => Object}] hash
+    #   The hash to be converted.
+    #
+    # @return [Hash{Symbol => Object}]
+    #   The normalized Hash.
+    #
+    def normalize_hash(hash)
+      new_hash = {}
+
+      hash.each do |key,value|
+        new_hash[key.to_sym] = if value.kind_of?(Hash)
+                                 normalize_hash(value)
+                               else
+                                 value
+                               end
+      end
+
+      return new_hash
+    end
+
+  end
+end