do 0.0.1 → 0.0.2

data/CHANGES.md

@@ -0,0 +1,6 @@
+## 0.0.2 - August 9, 2011
+
+* Added `doit do:setup` task that generate a template in `~./do/dorc`
+* Improved support of plugins
+* Added `doit download[http://raw.github...]` task which download and update for you a given rake task
+* Improved output messages

data/README.md

@@ -2,35 +2,37 @@
 
 DO is a thin framework useful to manage remote servers through ssh.
 
-There are many other alternative, once of them is [capistrano](https://github.com/capistrano/capistrano)
+There are many other alternatives, once of them is
+[capistrano](https://github.com/capistrano/capistrano).
 
 So why another one? Basically I need:
 
 * easy creation of my recipes
 * see perfectly what's happening on my remote servers
 * highly focus on smart actions, upload, download, sudo, replace.
-* manage more than one server each
-* use same behaviour for manage local tasks
+* manage easily more than one server at same time
+* use same syntax to manage local tasks
 
-## Installation
+## DO - Installation and Setup
 
 ```sh
 $ sudo gem install do
-$ doit do:setup
+$ doit setup # setup DO directory
+$ doit -T    # show DO tasks
 ```
 
-Now start to edit your `~/do/dorc` file and have fun!
+Now you can edit your `~/.do/dorc` adding your **servers** or **plugins**.
 
-## Files
+## DO - Files
 
 There are some way to generate **DO** tasks, you can:
 
-* Create a file called `Do` in your project directory
-* Create a file called `Dofile` in your project directory
-* Create `*.rake` files in `~/.do` directory, aka **home dir**
-* Create a file called `dorc` in `~/.do` directory
+* Create a file called `Do` or `Dofile` in your project directory (_project wide_)
+* Create `*.rake` files in `~/.do` directory (_system wide_)
+* Create a file called `dorc` in `~/.do` directory (_system wide_)
 
-You can change your **do home directory** with:
+You can change the *DO* home directory (default: `~/.do`) with these
+commands:
 
 ```
 DO_PATH='/my/new/.do/path'
@@ -38,7 +40,9 @@ ENV['DO_PATH']='/my/new/.do/path'
 export DO_PATH='/my/new/.do/path'
 ```
 
-## Features
+In this guide we assume that your `DO_PATH` is `~/.do`.
+
+## DO - Features
 
 * Easily server logging
 * SSH connections
@@ -59,7 +63,7 @@ server.run 'uname', '-a'
 # root@srv1 ~ # uname -a
 # Linux srv1.lipsiasoft.net 2.6.18-194.32.1.el5  x86_64 x86_64 x86_64 GNU/Linux
 
-server.run 'mysqladmin -u root -p password 'oldone', 'newpassword'
+server.run 'mysqladmin -u root -p password "oldone"', 'newpassword'
 # root@srv1 ~ # mysqladmin -u root -p password 'oldone'
 # Enter password: oldone
 # mysqladmin: connect to server at 'localhost' failed
@@ -119,29 +123,67 @@ server.wait
 # Press ENTER to continue...
 ```
 
+## DO - Plugins
+
+DO, support plugins, you can manually add new one in your `~/.do/dorc`
+with a simple line:
+
+```rb
+plugin :vim, 'https://raw.github.com/DAddYE/.do/master/vim.rake'
+```
+
+However we have a `doit` command for that:
+
+```sh
+$ doit download[https://raw.github.com/DAddYE/.do/master/l.rake]
+```
+
+This command add for you a new line in your `~/.do/dorc` and perform:
+
+```sh
+$ doit plugin:vim
+```
+
+which download and install in your `~/.do/dorc` directory a new rake
+file.
+
+Once this happen you are be able to see new tasks:
+
+```sh
+$ doit -T
+
+************************************************************
+*                         DO - IT!                         *
+************************************************************
+
+doit plugin:vim                  # install vim plugin
+doit setup                       # setup a working home directory
+doit vim:configure               # configure with a janus custom template
+doit vim:install                 # install vim with python and ruby support
+```
+
 ## Scenario and examples
 
-I'm porting my custom recipes to do, you can found my dot files
-[here](https://github.com/daddye/.do)
+I'm porting my custom recipes to *DO*, you can find my dot files
+[here](https://github.com/daddye/.do).
 
-I've server config in `~/.do/dorc`:
+Here servers definitions:
 
 ```rb
+# ~/.do/dorc
 keys = %w(/keys/master.pem /keys/instances.pem /keys/stage.pem)
 server :sho0, 'sho0.lipsiasoft.biz', 'root', :keys => keys
 server :srv0, 'srv0.lipsiasoft.biz', 'root', :keys => keys
 server :srv1, 'srv1.lipsiasoft.biz', 'root', :keys => keys
 server :srv2, 'srv2.lipsiasoft.biz', 'root', :keys => keys
-
-plugin "configure-server", "https://raw.github.com/gist/112..."
 ```
 
-Then I've some recipes in my `~/.do` path where I do common tasks.
+I've also some recipes in my `~/.do` path:
 
 ```rb
-# ~/.do/configure.
+# ~/.do/configure.rake
 namespace :configure
-  desc "upgrade rubygems and install usefull gems"
+  desc "upgrade rubygems and install useful gems"
   task :gems => :ree do
     run "gem update --system" if yes?("Do you want to update rubygems?")
     run "gem install rake"
@@ -174,7 +216,7 @@ namespace :configure
 ...
 ```
 
-I call those with:
+I call these task with:
 
 ```sh
 $ doit configure:gems
@@ -182,8 +224,8 @@ $ doit configure:motd
 $ doit configure:mysql
 ```
 
-**NOTE** that like rake tasks you are be able to add prerequisites to
-any task, in this case:
+**NOTE** like rake tasks you are be able to add prerequisites to
+any task, ex:
 
 ```rb
 task :mysql => :yum do; ...; end
@@ -220,31 +262,33 @@ namespace :l do
 end
 ```
 
-When I need to setup a new project I do:
+When I need to setup a new project:
 
 ``` sh
 $ doit l:setup
 $ doit l:commit # to make a fast commit and push
 ```
 
-As you can see define remote and local task is simple like making common
-rake tasks, infact this gem handle rake.
+As you can see, define remote and local task, is simple like making
+standard rake tasks. *DO* extend `Rake`.
 
-## Filtering
+## DO - Filtering
 
-Sometimes you want to perform a task only on one or some servers:
+Sometimes you want to perform a task only on some servers:
 
 ```sh
 $ doit configure:new --only-srv1 --only-srv2
 $ doit configure:new --except-srv1
 ```
 
-## Awesome output
+## DO - Output (Awesome...)
 
-What I really need is a great understandable, colored output that clarify
+What I really wanted was a great understandable, colored output that clarify
 me what's happen on my remote servers.
 
-```
+Here a example output of my tasks:
+
+```sh
 root@sho0 ~ # touch /root/.bashrc
 root@sho0 ~ # replace all in '/root/.bashrc'
 root@sho0 ~ # replace all in '/etc/motd'

data/Rakefile

@@ -11,9 +11,12 @@ end
 
 desc "Bump version on github"
 task :bump do
-  puts "\e[31mNothing to commit (working directory clean)\e[0m" and return unless `git status -s`.chomp == ""
-  version  = Bundler.load_gemspec(Dir[File.expand_path('../*.gemspec', __FILE__)].first).version
-  sh "git add .; git commit -a -m \"Bump to version #{version}\""
+  if `git status -s`.chomp == ""
+    puts "\e[31mNothing to commit (working directory clean)\e[0m"
+  else
+    version  = Bundler.load_gemspec(Dir[File.expand_path('../*.gemspec', __FILE__)].first).version
+    sh "git add .; git commit -a -m \"Bump to version #{version}\""
+  end
 end
 
 task :release => :bump

data/bin/doit

@@ -14,7 +14,7 @@ ARGV.delete_if { |a| a =~ /--(only|except)/ }
 
 puts "\e[32m"
 puts "*" * 60
-puts "*" + "DO".center(58) + "*"
+puts "*" + "DO - IT!".center(58) + "*"
 puts "*" * 60
 puts "\e[0m"
 

data/do.gemspec

@@ -18,4 +18,8 @@ Gem::Specification.new do |gem|
   gem.add_dependency "net-ssh",  "~>2.1.4"
   gem.add_dependency "net-sftp", "~>2.0.5"
   gem.add_development_dependency "rspec"
+
+  gem.post_install_message  = "\e[32m" + ("*" * 60) + "\n"
+  gem.post_install_message += "*" + "DO - IT! $ doit setup".center(58) + "*" + "\n"
+  gem.post_install_message += ("*" * 60) + "\n\e[0m"
 end

data/lib/do/commands.rb

@@ -51,10 +51,11 @@ module DO
     #   plugin "configuration", "https://gist.github.com/raw/xys.rake"
     #
     def plugin(name, repo)
-      desc "Install #{name} plugin"
-      local("plugin:#{name}" => "do:setup") do
+      desc "install #{name} plugin"
+      local("plugin:#{name}" => :setup) do
+        log "\e[36m## Installing plugin %s\e[0m" % name
         Dir.mkdir(DO_PATH) unless File.exist?(DO_PATH)
-        sh "curl --location --progress-bar #{repo} > #{File.join(DO_PATH, name + '.rake')}"
+        sh "curl --location --progress-bar #{repo} > #{File.join(DO_PATH, '%s.rake' % name)}"
       end
     end
 
@@ -129,7 +130,7 @@ module DO
     ##
     # Log text under current_server if available
     #
-    def log(text, new_line=true)
+    def log(text="", new_line=true)
       if current_server
         current_server.log(text, new_line)
       else
@@ -142,15 +143,4 @@ end # DO
 
 self.extend DO::Commands
 
-local :servers do
-  servers_selected.replace(servers)
-end
-
-namespace :do do
-  desc "setup a working home directory"
-  local :setup do
-    File.mkdir(DO_PATH) unless File.exist?(DO_PATH)
-    sh 'touch %s' % File.join(DO_PATH, 'dorc')
-    sh 'ln -s %s %s' % [File.join(DO_PATH, 'dorc'), File.expand_path("~/.dorc")]
-  end
-end
+load(File.expand_path('../common.rb', __FILE__))

data/lib/do/common.rb

@@ -0,0 +1,56 @@
+##
+# Common tasks performed by doit
+#
+
+local :servers do
+  servers_selected.replace(servers)
+end
+
+local :download, [:recipe] => :setup  do |t, options|
+  if options[:recipe]
+    name = File.basename(options[:recipe], '.rake')
+    rc   = File.join(DO_PATH, 'dorc')
+    buf  = File.read(rc)
+
+    if buf.include?(options[:recipe])
+      log "\e[31mYour '\e[1m%s\e[31m' already has the plugin '\e[1m%s\e[0m'" % [rc, options[:recipe]]
+      log "Please run: $ doit plugin:%s" % name
+      exit
+    else
+      plugin = "plugin :%s, '%s'\n" % [name, options[:recipe]]
+      File.open(rc, 'a') { |f| f.write plugin }
+      load(rc)
+      Rake::Task['plugin:%s' % name].invoke
+    end
+  else
+    log "\e[31mYou must provide a recipe path ex:\e[0m"
+    log
+    log "  $ doit download[https://raw.github.com/DAddYE/.do/master/l.rake]"
+    log
+  end
+end
+
+desc "setup a working home directory"
+local :setup do
+  File.mkdir(DO_PATH) unless File.exist?(DO_PATH)
+  hrc = File.expand_path("~/.dorc")
+  orc = File.join(DO_PATH, 'dorc')
+  unless File.exist?(orc)
+    template = <<-RUBY.gsub(/^ {6}/, '')
+      ##
+      # Server definitions
+      #
+      # keys = %w(/path/to/key1.pem /path/to/key2.pem)
+      # server :srv1, 'srv1.domain.local', 'root', :keys => keys
+      # server :srv2, 'srv2.domain.local', 'root', :keys => keys
+      #
+
+      ##
+      # Here my plugins
+      #
+    RUBY
+    File.open(orc, 'w') { |f| f.write template }
+    log "\e[36mGenerated template, now you can add your config to: '%s'\e[0m" % orc
+  end
+  sh 'ln -s %s %s' % [orc, hrc] unless File.exist?(hrc)
+end

data/lib/do/server.rb

@@ -39,7 +39,7 @@ module DO
     # ==== Examples:
     #   DO::Server::LOG_FORMAT = "%s@%s$ %s"
     #
-    def log(text, new_line=true)
+    def log(text="", new_line=true)
       text += "\n" if new_line && text[-1] != ?\n
       logger.print LOG_FORMAT % [user, name, text]
     end

data/lib/do/version.rb

@@ -1,3 +1,3 @@
 module DO
-  VERSION = "0.0.1" unless defined?(DO::VERSION)
+  VERSION = "0.0.2" unless defined?(DO::VERSION)
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: do
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Davide D'Agostino
@@ -91,6 +91,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- CHANGES.md
 - Gemfile
 - README.md
 - Rakefile
@@ -98,10 +99,10 @@ files:
 - do.gemspec
 - lib/do.rb
 - lib/do/commands.rb
+- lib/do/common.rb
 - lib/do/server.rb
 - lib/do/utils.rb
 - lib/do/version.rb
-- recipes/.servorc
 - spec/fixtures/sample
 - spec/server_spec.rb
 - spec/spec_helper.rb
@@ -109,7 +110,10 @@ has_rdoc: true
 homepage: https://github.com/daddye/do
 licenses: []
 
-post_install_message: 
+post_install_message: "\e[32m************************************************************\n\
+  *                  DO - IT! $ doit setup                   *\n\
+  ************************************************************\n\
+  \e[0m"
 rdoc_options: []
 
 require_paths: 

data/recipes/.servorc

@@ -1,14 +0,0 @@
-keys = %w(/Developer/src/LipsiaSoft/lipsiahosting/lib/lipsiarec/recipes/servers/resources/keys/Lipsiasoft.pem)
-server :srv1, 'srv1.lipsiasoft.biz', 'root', :keys => keys
-server :srv2, 'srv2.lipsiasoft.biz', 'root', :keys => keys
-
-plugin "configure-server", "https://raw.github.com/gist/112..."
-
-namespace :status do
-
-  desc "Show processes"
-  task :ps do
-    run "ps aux --sort -rss"
-    wait
-  end
-end