ors 0.2.10 → 0.3.0

data/README.markdown

@@ -0,0 +1,71 @@
+# Set Up
+
+Required Files:
+
+* .rvmrc
+* Gemfile
+* Gemfile.lock
+* config/database.yml
+* .git/config
+* config/unicorn.rb
+
+
+### Setting up .git/config
+
+
+Your .git/config should know about the remotes you will be using to deploy to the server (usually just origin) as it will pull information about the remote from your local config file
+
+
+### Setting up RVM
+
+On your ruby servers you should create a .rvmrc in the home directory of the user running unicorn.
+
+```bash
+rvm_install_on_use_flag=1
+
+rvm_gemset_create_on_use_flag=1
+
+rvm_trust_rvmrcs_flag=1
+```
+
+
+### Required gems
+
+* rake
+* bundler
+* unicorn
+
+ors deploy commands assume you are using unicorn for your servers.
+
+
+
+# Usage
+
+run `ors help` for a list of commands to use.
+
+
+### Brief Examples
+
+Deploying to the staging website
+
+```bash
+bundle exec ors deploy to staging
+```
+
+Deploying a feature branch to the production website
+
+```bash
+bundle exec ors deploy origin/feature_branch
+```
+
+Deploying a feature branch to the staging website
+
+```bash
+bundle exec ors deploy origin/feature_branch to staging
+```
+
+### Notes
+* By default the environment is assumed to be production and the branch you are deploying is assumed to be origin/#{environment}.
+* You can override settings by implementing a config/deploy.yml file in your repo.
+
+

data/bin/ors

@@ -5,4 +5,4 @@ $LOAD_PATH.unshift(lib) if File.directory?(lib) and (not $LOAD_PATH.include? lib
 
 require "ors"
 
-ORS::Command.run ARGV
+ORS.new.run ARGV

data/lib/ors.rb

@@ -3,9 +3,28 @@ require "git"
 require "yaml"
 require "erb"
 
+require "ors/base"
 require "ors/version"
-require "ors/core_ext"
 require "ors/log_unifier"
 require "ors/config"
 require "ors/helpers"
-require "ors/command"
+
+# commands
+require "ors/commands/base"
+require "ors/commands/changes"
+require "ors/commands/console"
+require "ors/commands/deploy"
+require "ors/commands/env"
+require "ors/commands/exec"
+require "ors/commands/help"
+require "ors/commands/logs"
+require "ors/commands/migrate"
+require "ors/commands/restart"
+require "ors/commands/ruby"
+require "ors/commands/runner"
+require "ors/commands/setup"
+require "ors/commands/start"
+require "ors/commands/stop"
+require "ors/commands/symlink"
+require "ors/commands/timestamps"
+require "ors/commands/update"

data/lib/ors/base.rb

@@ -0,0 +1,30 @@
+class ORS
+  def self.config(options = [])
+    @config ||= ORS::Config.new(options)
+  end
+
+  def run args
+    command, *options = args
+    klass_string = command.to_s.capitalize
+
+    # setup initial config
+    ORS.config(options)
+
+    # determine command to use
+    if command =~ /-*version/i
+      puts "ORS v#{ORS::VERSION}"
+    else
+      if available_commands.include? klass_string
+        ORS::Commands.const_get(klass_string).run
+      else
+        ORS::Commands::Help.run
+      end
+    end
+  end
+
+  private
+
+  def available_commands
+    ORS::Commands.constants.map {|klass| klass.to_s }
+  end
+end

data/lib/ors/commands/base.rb

@@ -1,18 +1,62 @@
-module ORS::Commands
-  class Base
-    include ORS::Helpers
+class ORS
+  module Commands
+    class Base
+      include ORS::Helpers
 
-    module ClassMethods
-      def run klass
-        klass.new.execute
+      module ClassMethods
+        def run_without_setup
+          new.execute
+        end
+
+        def run
+          command = new
+          command.setup
+
+          # now that the command has had a chance at the args
+          # we let our config finish its setup of variables
+          ORS.config.finalize!
+
+          if ORS.config.valid?
+            # now execute the command
+            command.execute
+          else
+            info "ERROR: Invalid options given."
+            ORS::Commands::Help.run_without_setup
+          end
+        end
       end
-    end
-    extend ClassMethods
+      extend ClassMethods
 
-    def run klass
-      self.class.run klass
-    end
+      def setup
+      end
 
-  end
+      def usage
+        "./ors base [options]"
+      end
 
+      def description
+        "Base Command Class"
+      end
+
+      def help_options
+        <<-END
+=== Options
+from|to environment    Set which environment to use (default production)
+--pretend    (or -p)   Don't execute anything, just show me what you're going to do
+--no-gateway (or -ng)  Don't use a gateway (if you're inside the firewall)
+        END
+      end
+
+      def help
+        puts <<-END
+Usage: #{usage}
+
+=== Description
+#{description}
+
+#{help_options}
+        END
+      end
+    end
+  end
 end

data/lib/ors/commands/changes.rb

@@ -1,13 +1,27 @@
-module ORS::Commands
+class ORS
+  module Commands
+    class Changes < Base
+      def setup
+        @local_ref = ORS.config[:args].shift
+        parse_remote_and_or_branch
+      end
 
-  class Changes < Base
+      def execute
+        results = execute_command(ORS.config[:console_server],
+                                  prepare_environment_with_rvm,
+                                  %(git show | head -1),
+                                  :capture => true)
 
-    def execute
-      results = execute_command console_server, prepare_environment, %(git show | head -1), :capture => true
+        system('git', 'log', [@local_ref, "remotes/#{ORS.config[:remote]}/#{ORS.config[:branch]}"].join("..")) if results =~ /commit (.*)/
+      end
 
-      system('git', 'log', [$1, "remotes/origin/#{environment}"].join("..")) if results =~ /commit (.*)/
-    end
+      def usage
+        "./ors changes local_ref [remote|remote/branch] [options]"
+      end
 
+      def description
+        "Detects changes between local commits and what is deployed"
+      end
+    end # Changes < Base
   end
-
 end

data/lib/ors/commands/console.rb

@@ -1,22 +1,20 @@
-module ORS::Commands
-  class Console < Base
-    def execute
-      execute_command console_server, prepare_environment,
-                                      %(if [ -f script/rails ]; then bundle exec rails console #{environment}; else ./script/console #{environment}; fi),
-                                      :exec => true
-    end
+class ORS
+  module Commands
+    class Console < Base
+      def execute
+        execute_command(ORS.config[:console_server],
+                        prepare_environment_with_rvm,
+                        %(if [ -f script/rails ]; then bundle exec rails console #{ORS.config[:environment]}; else ./script/console #{ORS.config[:environment]}; fi),
+                        :exec => true)
+      end
 
-    def help
-      puts <<-END
-Usage: ./ors console [environment=production] [options]
+      def usage
+        "./ors console [options]"
+      end
 
-=== Description
-Replaces current process and runs rails console.
-
-=== Options
---pretend    (or -p)   Don't execute anything, just show me what you're going to do
---no-gateway (or -ng)  Don't use a gateway (if you're inside the firewall)
-      END
-    end
+      def description
+        "Replaces current process and runs rails console."
+      end
+    end # Console < Base
   end
 end

data/lib/ors/commands/deploy.rb

@@ -1,23 +1,34 @@
-module ORS::Commands
+class ORS
+  module Commands
+    class Deploy < Base
 
-  class Deploy < Base
+      def setup
+        parse_remote_and_or_branch
+      end
 
-    def execute
-      info "deploying #{name} #{environment}..."
+      def execute
+        info "deploying #{ORS.config[:name]} #{ORS.config[:environment]}..."
 
-      [Update, Migrate].each {|command| run command }
+        [Update, Symlink, Migrate].each {|command| command.run_without_setup }
 
-      if remote_deploy_hook
-        execute_in_parallel(app_servers) do |server|
-          execute_command server, prepare_environment, "RAILS_ENV=#{environment} #{remote_deploy_hook}"
+        if ORS.config[:remote_deploy_hook]
+          execute_in_parallel(ORS.config[:app_servers]) do |server|
+            execute_command server, prepare_environment, "RAILS_ENV=#{ORS.config[:environment]} #{ORS.config[:remote_deploy_hook]}"
+          end
         end
-      end
 
-      run Restart
+        Restart.run_without_setup
 
-      eval ERB.new(deploy_hook).result(binding) if deploy_hook
-    end
+        eval ERB.new(ORS.config[:deploy_hook]).result(binding) if ORS.config[:deploy_hook]
+      end
 
-  end
+      def usage
+        "./ors deploy [remote|remote/branch] [options]"
+      end
 
+      def description
+        "Deploys given branch (origin/environment by default) to given environment"
+      end
+    end # Deploy < Base
+  end
 end

data/lib/ors/commands/env.rb

@@ -1,15 +1,15 @@
-module ORS::Commands
+class ORS
+  module Commands
+    class Env < Base
 
-  class Env < Base
+      def execute
+        puts "ORS v#{ORS::VERSION} configuration:\n\n"
 
-    def execute
-      puts "ORS v#{ORS::VERSION} configuration:\n\n"
 
-      [:name, :environment, :use_gateway, :pretending, :log_lines, :rails2, :gateway, :deploy_user, :repo,
-       :base_path, :deploy_hook, :remote_deploy_hook, :web_servers, :app_servers, :migration_server, :console_server, :cron_server].each do |config_variable|
-        puts "%20s: %-40s" % [config_variable, ORS::Config.send(config_variable).inspect]
+        ORS.config._options.each_pair do |key, value|
+          puts "%20s: %-40s" % [key, value.inspect]
+        end
       end
-    end
-
+    end # Env < Base
   end
 end

data/lib/ors/commands/exec.rb

@@ -1,13 +1,20 @@
-module ORS::Commands
+class ORS
+  module Commands
+    class Exec < Base
 
-  class Exec < Base
+      def setup
+        @command = ORS.config[:args].shift
+      end
 
-    def execute
-      info "executing command for #{name} #{environment}..."
+      def execute
+        info "executing command for #{ORS.config[:name]} #{ORS.config[:environment]}..."
 
-      execute_command migration_server, prepare_environment, %(bundle exec #{ENV["CMD"]})
-    end
+        execute_command migration_server, prepare_environment, %(bundle exec #{@command})
+      end
 
+      def usage
+        "./ors exec command [options]"
+      end
+    end # Exec < Base
   end
-
 end

data/lib/ors/commands/help.rb

@@ -1,9 +1,9 @@
-module ORS::Commands
+class ORS
+  module Commands
+    class Help < Base
 
-  class Help < Base
-
-    def execute
-      puts <<-END
+      def execute
+        puts <<-END
 Usage: ./ors <action> [environment=production] [options]
 
 === Actions
@@ -25,11 +25,9 @@ update        Updates the code on all servers
 Must be one of: production demo staging
 Defaults to production.
 
-=== Options
---pretend    (or -p)   Don't execute anything, just show me what you're going to do (default: false)
---no-gateway (or -ng)  Don't use a gateway (if you're inside the firewall)          (default: true)
-      END
-    end
-
+#{help_options}
+        END
+      end
+    end # Help < Base
   end
 end

data/lib/ors/commands/logs.rb

@@ -1,18 +1,20 @@
-module ORS::Commands
-  class Logs < Base
+class ORS
+  module Commands
+    class Logs < Base
 
-    def execute
-      all_logs = app_servers.map do |server|
-        [
-         server,
-         execute_command(server, prepare_environment,
-                                 %(tail -n #{log_lines} log/#{environment}.log),
-                                 :capture => true)
-        ]
-      end
-
-      puts ORS::LogUnifier.new(all_logs).unify unless pretending
-    end
+      def execute
+        all_logs = ORS.config[:app_servers].map do |server|
+          [
+           server,
+           execute_command(server,
+                           prepare_environment,
+                           %(tail -n #{ORS.config[:log_lines]} log/#{ORS.config[:environment]}.log),
+                           :capture => true)
+          ]
+        end
 
+        puts ORS::LogUnifier.new(all_logs).unify unless ORS.config[:pretending]
+      end
+    end # Logs < Base
   end
 end