wordpress-deploy 1.0.0.alpha1

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+pkg/*

data/Gemfile

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+# RubyGems Source
+source 'http://rubygems.org'
+
+# Include gem dependencies from the gemspec for development purposes
+gemspec

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    wordpress-deploy (1.0.0)
+      actionpack (~> 3.2.6)
+      colorize (~> 0.5.8)
+      open4 (~> 1.3.0)
+      thor (~> 0.14.6)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+    activesupport (3.2.6)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    builder (3.0.0)
+    colorize (0.5.8)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    journey (1.0.4)
+    metaclass (0.0.1)
+    mocha (0.11.4)
+      metaclass (~> 0.0.1)
+    multi_json (1.3.6)
+    open4 (1.3.0)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rake (0.9.2.2)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.14.6)
+    tilt (1.3.3)
+    timecop (0.3.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mocha
+  rake
+  rspec
+  timecop
+  wordpress-deploy!

data/LICENSE.md

@@ -0,0 +1,24 @@
+
+Copyright (c) 2012 Ryan Lovelett ( [@rlovelett](http://twitter.com/#!/rlovelett) )
+=================================================================================================
+
+The "Wordpress Deploy" RubyGem is released under the **MIT LICENSE**
+----------------------------------------------------------
+
+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,22 @@
+Wordpress Deploy
+======
+
+Wordpress Deploy is a RubyGem, written for Linux and Mac OSX, that allows you to easily perform Wordpress deployment operations. It provides you with an elegant DSL in Ruby for modeling your deployments.
+
+### Author
+
+**[Ryan Lovelett](http://ryan.lovelett.me/) ( [@rlovelett](http://twitter.com/#!/rlovelett) )**
+
+Drop me a message for any questions, suggestions, requests, bugs or submit them to the [issue log](https://github.com/rlovelett/wordpress-deploy/issues).
+
+
+### Installation
+
+To get the latest stable version
+
+    gem install wordpress-deploy
+
+You can view the list of released versions over at [RubyGems.org (Backup)](https://rubygems.org/gems/wordpress-deploy/versions)
+
+
+### Getting Started

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/wp-deploy

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+# Load the WordpressDeploy core library
+require File.expand_path("../../lib/wordpress_deploy", __FILE__)
+
+# Load the WordpressDeploy command line interface utility
+require File.expand_path("../../lib/wordpress_deploy/cli/utility", __FILE__)
+
+# Initialize the WordpressDeploy command line utility
+WordpressDeploy::CLI::Utility.start

data/lib/wordpress_deploy/cli/helpers.rb

@@ -0,0 +1,91 @@
+# encoding: utf-8
+
+module WordpressDeploy
+  module CLI
+    module Helpers
+      UTILITY = {}
+
+      ##
+      # Runs a system command
+      #
+      # All messages generated by the command will be logged.
+      # Messages on STDERR will be logged as warnings.
+      #
+      # If the command fails to execute, or returns a non-zero exit status
+      # an Error will be raised.
+      #
+      # Returns nil
+      def run(command)
+        name = command_name(command)
+        Logger.message "Running system utility '#{ name }'..."
+
+        begin
+          out, err = '', ''
+          ps = Open4.popen4(command) do |pid, stdin, stdout, stderr|
+            stdin.close
+            out, err = stdout.read.strip, stderr.read.strip
+          end
+        rescue Exception => e
+          raise Errors::CLI::SystemCallError.wrap(e, <<-EOS)
+            Failed to execute system command on #{ RUBY_PLATFORM }
+            Command was: #{ command }
+          EOS
+        end
+
+        if ps.success?
+          unless out.empty?
+            Logger.message(
+              out.lines.map {|line| "#{ name }:STDOUT: #{ line }" }.join
+            )
+          end
+
+          unless err.empty?
+            Logger.warn(
+              err.lines.map {|line| "#{ name }:STDERR: #{ line }" }.join
+            )
+          end
+
+          return nil
+        else
+          raise Errors::CLI::SystemCallError, <<-EOS
+            '#{ name }' Failed on #{ RUBY_PLATFORM }
+            The following information should help to determine the problem:
+            Command was: #{ command }
+            Exit Status: #{ ps.exitstatus }
+            STDOUT Messages: #{ out.empty? ? 'None' : "\n#{ out }" }
+            STDERR Messages: #{ err.empty? ? 'None' : "\n#{ err }" }
+          EOS
+        end
+      end
+
+
+      ##
+      # Returns the full path to the specified utility.
+      # Raises an error if utility can not be found in the system's $PATH
+      def utility(name)
+        name = name.to_s.strip
+        raise Errors::CLI::UtilityNotFoundError,
+            'Utility Name Empty' if name.empty?
+
+        path = UTILITY[name] || %x[which #{ name } 2>/dev/null].chomp
+        if path.empty?
+          raise Errors::CLI::UtilityNotFoundError, <<-EOS
+            Could not locate '#{ name }'.
+            Make sure the specified utility is installed
+            and available in your system's $PATH.
+          EOS
+        end
+        UTILITY[name] = path
+      end
+
+      ##
+      # Returns the name of the command name from the given command line
+      def command_name(command)
+        i = command =~ /\s/
+        command = command.slice(0, i) if i
+        command.split('/')[-1]
+      end
+
+    end
+  end
+end

data/lib/wordpress_deploy/cli/utility.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+##
+# Build the WordpressDeploy Command Line Interface using Thor
+module WordpressDeploy
+  module CLI
+    class Utility < Thor
+      include Thor::Actions
+
+      method_option :base, type: :string, aliases: ['-b']
+      method_option :env,  type: :string, required: true, default: 'production', aliases: ['-e']
+      desc "generate", "Generate the wp-config.php file. Accepted environments are production or development."
+      def generate
+        unless %w{production development}.include? options[:env]
+          raise Errors::CLI::SystemCallError.wrap(e, <<-EOS)
+            Failed to execute system command on #{ RUBY_PLATFORM }
+            Command was: #{ command }
+          EOS
+        end
+
+        Config.environment = options[:env]
+        config = Config.wp_config[Config.env]
+
+        # Salt the wp-config.php file if none are provided
+        Config.salt_keys.each do |key|
+          config[key] = Config.salt_array.sample(64).join("") unless config.has_key? key
+        end
+
+        out = File.open(Config.wp_config_output, 'w')
+        File.open(Config.wp_config_sample, 'r') do |file|
+          file.each_line do |line|
+            match = /^define\(['"](?<parameter>\w*)['"]/.match(line)
+            unless match.nil?
+              param = match[:parameter]
+              if config.has_key?(param)
+                # The Wordpress Config file has the key
+                # So now set the value from the config
+                line.gsub!(/['"]((?!#{param})[\s\w\d\!\@\#\$\%\^\&\*\-\(\)]+)?['"]/, "'#{config[param]}'")
+              end
+            end
+            out.puts(line)
+          end
+        end
+      end
+
+
+      desc "deploy", "Deploy #{Config.sites_dir} via FTP to #{Config.ftp_config['hostname']}"
+      def deploy
+
+      end
+    end
+  end
+end

data/lib/wordpress_deploy/config.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+
+module WordpressDeploy
+  module Config
+    DEFAULTS = {
+      :config_file  => 'config.rb',
+      :data_path    => 'data',
+      :log_path     => 'log',
+      :cache_path   => '.cache',
+      :tmp_path     => '.tmp'
+    }
+
+    class << self
+      # These paths are the basis for all scripts
+      attr_reader :base_dir
+      def base_dir
+        @base_dir   ||= Dir.pwd
+      end
+      attr_reader :config_dir
+      def config_dir
+        @config_dir ||= File.join(base_dir, "config")
+      end
+      attr_reader :sites_dir
+      def sites_dir
+        @sites_dir  ||= File.join(base_dir, "site")
+      end
+
+      attr_reader :ftp_config
+      def ftp_config
+        @ftp_config ||= YAML.load_file(File.join(config_dir, "ftp.yml"))
+      end
+
+      attr_reader :wp_config
+      def wp_config
+        @wp_config ||= YAML.load_file(File.join(config_dir, "wp-config.yml"))
+      end
+
+      attr_reader :wp_config_sample
+      def wp_config_sample
+        @wp_config_sample ||= File.join(sites_dir, "wp-config-sample.php")
+      end
+      attr_reader :wp_config_output
+      def wp_config_output
+        @wp_config_output ||= File.join(sites_dir, "wp-config.php")
+      end
+
+      attr_reader :environment
+      def environment
+        @environment ||= "production"
+      end
+      alias :env :environment
+
+      def environment=(new_env)
+        @environment = new_env.downcase
+      end
+
+      # The Salting array
+      def salt_array
+        @salt_array ||= %w{0 1 2 3 4 5 6 7 8 9 a b c d e f g h i j k l m n o p q r s t u v w x y z A B C D E F G H I J K L M N O P Q R S T U V W X Y Z ! @ # $ % ^ & * ( ) - ~ + = | / { } : ; , . ? < > [ ]}
+      end
+
+      def salt_keys
+        @salt_keys ||= %w{AUTH_KEY SECURE_AUTH_KEY LOGGED_IN_KEY NONCE_KEY AUTH_SALT SECURE_AUTH_SALT LOGGED_IN_SALT NONCE_SALT}
+      end
+
+    end
+  end
+end

data/lib/wordpress_deploy/database/base.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+module WordpressDeploy
+  module Database
+    class Base
+      include WordpressDeploy::CLI::Helpers
+      include WordpressDeploy::Configuration::Helpers
+
+      ##
+      # Creates a new instance of the MongoDB database object
+      # * Called using super(model) from subclasses *
+      def initialize(model)
+        @model = model
+        load_defaults!
+      end
+
+      ##
+      # Super method for all child (database) objects. Every database object's #perform!
+      # method should call #super before anything else to prepare
+      def perform!
+        prepare!
+        log!
+      end
+
+      private
+
+      ##
+      # Defines the @dump_path and ensures it exists by creating it
+      def prepare!
+        @dump_path = File.join(
+          Config.tmp_path,
+          @model.trigger,
+          'databases',
+          self.class.name.split('::').last
+        )
+        FileUtils.mkdir_p(@dump_path)
+      end
+
+      ##
+      # Return the database name, with WordpressDeploy namespace removed
+      def database_name
+        self.class.to_s.sub('WordpressDeploy::', '')
+      end
+
+      ##
+      # Logs a message to the console and log file to inform
+      # the client that WordpressDeploy is dumping the database
+      def log!
+        Logger.message "#{ database_name } started dumping and archiving '#{ name }'."
+      end
+    end
+  end
+end

data/lib/wordpress_deploy/database/mysql.rb

@@ -0,0 +1,159 @@
+# encoding: utf-8
+
+module WordpressDeploy
+  module Database
+    class MySQL < Base
+
+      ##
+      # Name of the database that needs to get dumped
+      # To dump all databases, set this to `:all` or leave blank.
+      attr_accessor :name
+
+      ##
+      # Credentials for the specified database
+      attr_accessor :username, :password
+
+      ##
+      # Connectivity options
+      attr_accessor :host, :port, :socket
+
+      ##
+      # Tables to skip while dumping the database
+      attr_accessor :skip_tables
+
+      ##
+      # Tables to dump, tables that aren't specified won't get dumped
+      attr_accessor :only_tables
+
+      ##
+      # Additional "mysqldump" options
+      attr_accessor :additional_options
+
+      ##
+      # Path to mysqldump utility (optional)
+      attr_accessor :mysqldump_utility
+
+      attr_deprecate :utility_path, :version => '3.0.21',
+          :replacement => :mysqldump_utility
+
+      ##
+      # Creates a new instance of the MySQL adapter object
+      def initialize(model, &block)
+        super(model)
+
+        @skip_tables        ||= Array.new
+        @only_tables        ||= Array.new
+        @additional_options ||= Array.new
+
+        instance_eval(&block) if block_given?
+
+        @name ||= :all
+        @mysqldump_utility ||= utility(:mysqldump)
+      end
+
+      ##
+      # Performs the mysqldump command and outputs the
+      # data to the specified path based on the 'trigger'
+      def perform!
+        super
+
+        pipeline = Pipeline.new
+        dump_ext = 'sql'
+
+        pipeline << mysqldump
+        if @model.compressor
+          @model.compressor.compress_with do |command, ext|
+            pipeline << command
+            dump_ext << ext
+          end
+        end
+        pipeline << "cat > '#{ File.join(@dump_path, dump_filename) }.#{ dump_ext }'"
+
+        pipeline.run
+        if pipeline.success?
+          Logger.message "#{ database_name } Complete!"
+        else
+          raise Errors::Database::PipelineError,
+              "#{ database_name } Dump Failed!\n" +
+              pipeline.error_messages
+        end
+      end
+
+      private
+
+      ##
+      # Builds the full mysqldump string based on all attributes
+      def mysqldump
+        "#{ mysqldump_utility } #{ credential_options } #{ connectivity_options } " +
+        "#{ user_options } #{ db_name } #{ tables_to_dump } #{ tables_to_skip }"
+      end
+
+      ##
+      # Returns the filename to use for dumping the database(s)
+      def dump_filename
+        dump_all? ? 'all-databases' : name
+      end
+
+      ##
+      # Builds the credentials MySQL syntax to authenticate the user
+      # to perform the database dumping process
+      def credential_options
+        %w[username password].map do |option|
+          next if send(option).to_s.empty?
+          "--#{option}='#{send(option)}'".gsub('--username', '--user')
+        end.compact.join(' ')
+      end
+
+      ##
+      # Builds the MySQL connectivity options syntax to connect the user
+      # to perform the database dumping process
+      def connectivity_options
+        %w[host port socket].map do |option|
+          next if send(option).to_s.empty?
+          "--#{option}='#{send(option)}'"
+        end.compact.join(' ')
+      end
+
+      ##
+      # Builds a MySQL compatible string for the additional options
+      # specified by the user
+      def user_options
+        additional_options.join(' ')
+      end
+
+      ##
+      # Returns the database name to use in the mysqldump command.
+      # When dumping all databases, the database name is replaced
+      # with the command option to dump all databases.
+      def db_name
+        dump_all? ? '--all-databases' : name
+      end
+
+      ##
+      # Builds the MySQL syntax for specifying which tables to dump
+      # during the dumping of the database
+      def tables_to_dump
+        only_tables.join(' ') unless dump_all?
+      end
+
+      ##
+      # Builds the MySQL syntax for specifying which tables to skip
+      # during the dumping of the database
+      def tables_to_skip
+        skip_tables.map do |table|
+          table = (dump_all? || table['.']) ? table : "#{ name }.#{ table }"
+          "--ignore-table='#{ table }'"
+        end.join(' ')
+      end
+
+      ##
+      # Return true if we're dumping all databases.
+      # `name` will be set to :all if it is not set,
+      # so this will be true by default
+      def dump_all?
+        name == :all
+      end
+
+    end
+  end
+end

data/lib/wordpress_deploy/errors.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+
+module WordpressDeploy
+  module Errors
+
+    class Error < StandardError
+
+      def self.wrap(orig_err, msg = nil)
+        new(msg, orig_err)
+      end
+
+      def initialize(msg = nil, orig_err = nil)
+        super(msg)
+        set_backtrace(orig_err.backtrace) if @orig_err = orig_err
+      end
+
+      def to_s
+        return @to_s if @to_s
+        orig_to_s = super()
+
+        if orig_to_s == self.class.to_s
+          msg = orig_err_msg ?
+              "#{orig_err_class}: #{orig_err_msg}" : orig_err_class
+        else
+          msg = format_msg(orig_to_s)
+          msg << "\n  Reason: #{orig_err_class}" + (orig_err_msg ?
+              "\n  #{orig_err_msg}" : ' (no message given)') if @orig_err
+        end
+
+        @to_s = msg ? msg_prefix + msg : class_name
+      end
+
+      private
+
+      def msg_prefix
+        @msg_prefix ||= class_name + ': '
+      end
+
+      def orig_msg
+        @orig_msg ||= to_s.sub(msg_prefix, '')
+      end
+
+      def class_name
+        @class_name ||= self.class.to_s.sub('WordpressDeploy::Errors::', '')
+      end
+
+      def orig_err_class
+        return unless @orig_err
+
+        @orig_err_class ||= @orig_err.is_a?(Errors::Error) ?
+            @orig_err.send(:class_name) : @orig_err.class.to_s
+      end
+
+      def orig_err_msg
+        return unless @orig_err
+        return @orig_err_msg unless @orig_err_msg.nil?
+
+        msg = @orig_err.is_a?(Errors::Error) ?
+            @orig_err.send(:orig_msg) : @orig_err.to_s
+        @orig_err_msg = (msg == orig_err_class) ?
+            false : format_msg(msg)
+      end
+
+      def format_msg(msg)
+        msg.gsub(/^ */, '  ').strip
+      end
+    end
+
+  end
+end