taketo 0.1.3 → 0.2.0.alpha

data/Gemfile

@@ -5,5 +5,6 @@ group :development do
   gem "rake",  "~> 0.9"
   gem 'simplecov', '~> 0.6', :require => false
   gem 'open4', '~> 1.3'
+  gem 'pry'
 end
 

data/Gemfile.lock

@@ -1,9 +1,15 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    coderay (1.0.7)
     diff-lcs (1.1.3)
+    method_source (0.8)
     multi_json (1.3.7)
     open4 (1.3.0)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
     rake (0.9.5)
     rspec (2.12.0)
       rspec-core (~> 2.12.0)
@@ -17,12 +23,14 @@ GEM
       multi_json (~> 1.0)
       simplecov-html (~> 0.7.1)
     simplecov-html (0.7.1)
+    slop (3.3.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   open4 (~> 1.3)
+  pry
   rake (~> 0.9)
   rspec (~> 2.11)
   simplecov (~> 0.6)

data/README.md

@@ -3,6 +3,7 @@ Take Me To
 
 [![Build Status](https://secure.travis-ci.org/v-yarotsky/taketo.png)](http://travis-ci.org/v-yarotsky/taketo)
 [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/v-yarotsky/taketo)
+[![Gem Version](https://badge.fury.io/rb/taketo.png)](http://badge.fury.io/rb/taketo)
 
 A tiny helper utility to make access to servers easier for different projects and environments.
 
@@ -30,7 +31,7 @@ However, I recommend doing a few things for better user experience:
 1. In ~/.zshrc (or ~/.bashrc if you use Bash) create an alias for taketo:
    ```alias to="taketo"```
 2. In case you use RVM, I recommend to create a wrapper for taketo,
-   which would use newest ruby: ```rvm wrapper ruby-1.9.3-p194-perf@global --no-prefix taketo```.  
+   which would use newest ruby: ```rvm wrapper ruby-1.9.3-p194-perf@global --no-prefix taketo```.
    Of course, you will need to install taketo for corresponding ruby and gemset.
    Also, keep in mind that the fewer gems are installed into the gemset, the faster things will work.
 3. In case you use ZSH – install [taketo ZSH completion](https://raw.github.com/v-yarotsky/taketo/master/scripts/zsh/completion/_taketo).
@@ -157,11 +158,25 @@ Default configs are merged appropriately.
 
 An SSH config file can be generated from taketo config. To do so, run ```taketo --generate-ssh-config```.
 
+Tips:
+-----
 
+Taketo is especially useful in conjunction with [tmuxall](https://github.com/v-yarotsky/tmuxall) gem:
+
+    $ taketo my_project:frontends --list | sed 's/^/taketo /' | tmuxall -n MY_PROJECT_FRONTENDS
+
+This will work since taketo v0.2.0, so stay tuned
 
 The Changelog:
 --------------
 
+### v0.2.0.alpha (11.02.2013) ###
+* Add support for server groups. The list of servers in particular group can be obtained
+  with the following command:
+  ```taketo <group_name> --list```
+
+  This becomes especially useful with [tmuxall](https://github.com/v-yarotsky/tmuxall).
+
 ### v0.1.2 (12.12.2012) ###
 * Fix server aliases bug, bump version to 0.1.2 at 12.12.2012 :)
 

data/Rakefile

@@ -1,6 +1,7 @@
 # encoding: utf-8
 require 'rubygems'
 require 'bundler'
+require 'bundler/gem_tasks'
 
 begin
   Bundler.setup(:default, :development)

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.2.0.alpha

data/bin/taketo

@@ -2,12 +2,10 @@
 
 require 'rubygems'
 
+require 'optparse'
 require 'taketo'
-require 'taketo/constructs_factory'
 require 'taketo/commands'
-require 'taketo/destination_resolver'
-require 'taketo/destination_matcher'
-require 'optparse'
+require 'taketo/actions'
 
 Signal.trap("SIGINT") do
   puts "Terminating"
@@ -19,107 +17,37 @@ include Taketo
 DEFAULT_CONFIG_FILE = File.join(ENV['HOME'], ".taketo.rc.rb")
 
 def parse_options
-  options = { :config => DEFAULT_CONFIG_FILE }
+  options = { :config => DEFAULT_CONFIG_FILE, :action => :login }
 
   OptionParser.new do |opts|
     opts.banner = "Usage: taketo [destination] [options]"
     opts.version = ::Taketo::VERSION
+
     opts.separator ""
     opts.separator "Common options:"
 
-    opts.on("-f CONFIG", "--config", "Use custom config file (default: #{DEFAULT_CONFIG_FILE})") do |c|
-      options[:config] = c
-    end
-
+    opts.on("-f CONFIG", "--config", "Use custom config file (default: #{DEFAULT_CONFIG_FILE})") { |v| options[:config] = v }
     opts.on("-c COMMAND", "--command", "Command to execute on destination server",
-            "  (COMMAND either declared in config or passed as an argument)") do |c|
-      raise OptionParser::MissingArgument if String(c).strip.empty?
-      options[:command] = c
-    end
-
-    opts.on("-d DIRECTORY", "--directory", "Directory on destination server to cd to") do |d|
-      raise OptionParser::MissingArgument if String(d).strip.empty?
-      options[:directory] = d
-    end
-
-    opts.on("-v", "--view", "Show config contents and exit") do |v|
-      require 'taketo/config_printer_visitor'
-      options[:view] = v
-    end
-
-    opts.on("--generate-ssh-config", "Generate SSH config from taketo config") do |g|
-      require 'taketo/ssh_config_generator_visitor'
-      options[:generate_ssh_config] = g
-    end
+            "  (COMMAND either declared in config or passed as an argument)")                    { |v| options[:command] = v }
+    opts.on("-d DIRECTORY", "--directory", "Directory on destination server to cd to")           { |v| options[:directory] = v }
+    opts.on("-v", "--view", "Show config contents and exit")                                     { |v| options[:action] = :view; options[:view] = true }
+    opts.on("--generate-ssh-config", "Generate SSH config from taketo config")                   { |v| options[:action] = :generate_ssh_config }
+    opts.on("--list", "List servers in given group")                                             { |v| options[:action] = :list; options[:list] = true }
 
     opts.separator "Special options:"
 
-    opts.on("--dry-run", "Print out what would be run") do |v|
-      options[:dry_run] = v
-    end
-
-    opts.on("--debug") do |d|
-      options[:debug] = d
-    end
-
-    opts.on("--matches") do |m|
-      options[:matches] = m
-    end
-
+    opts.on("--dry-run", "Print out what would be run") { |v| options[:dry_run] = v }
+    opts.on("--debug")                                  { |v| options[:debug] = v }
+    opts.on("--matches")                                { |v| options[:action] = :matches }
   end.parse!
 
-  options
-end
-
-def parse_config(config)
-  DSL.new.configure(config).tap do |config|
-    traverser = ConfigTraverser.new(config)
-    ConfigValidator.new(traverser).validate!
-  end
-end
-
-def remote_command(server, options)
-  command = options[:command]
-  if String(command).empty?
-    server.default_command
-  else
-    server.find_command(command.to_sym) || Constructs::Command.explicit_command(command)
-  end
-end
-
-def execute(shell_command, options)
-  if options[:dry_run]
-    puts shell_command
-  else
-    system shell_command
-  end
+  options.merge!(:destination_path => ARGV.shift.to_s)
 end
 
 begin
-  options          = parse_options
-  config           = parse_config(options[:config])
-  destination_path = ARGV.shift.to_s
-  resolver         = DestinationResolver.new(config, destination_path)
-
-  if options.delete(:matches)
-    puts DestinationMatcher.new(resolver.servers).matches.join(" ")
-  elsif options.delete(:view)
-    node = resolver.get_node
-    traverser = ConfigTraverser.new(node)
-    config_printer = ConfigPrinterVisitor.new
-    traverser.visit_depth_first(config_printer)
-    puts config_printer.result
-  elsif options.delete(:generate_ssh_config)
-    traverser = ConfigTraverser.new(config)
-    ssh_config_generator = SSHConfigGeneratorVisitor.new
-    traverser.visit_depth_first(ssh_config_generator)
-    puts ssh_config_generator.result
-  else
-    server = resolver.resolve
-    server_command = remote_command(server, options)
-    command_to_execute = Commands::SSHCommand.new(server).render(server_command.render(server, options))
-    execute(command_to_execute, options)
-  end
+  options = parse_options
+  action = Actions[options[:action]].new(options)
+  action.run
 rescue SystemExit
   # Do nothing
 rescue Exception => e

data/lib/taketo/actions/base_action.rb

@@ -0,0 +1,29 @@
+require 'taketo/config_traverser'
+require 'taketo/config_validator'
+
+module Taketo
+  module Actions
+
+    class BaseAction
+      attr_reader :options, :destination_path
+
+      def initialize(options)
+        @options          = options
+        @destination_path = options[:destination_path]
+      end
+
+      def config
+        @config ||= begin
+          config_file = options[:config]
+
+          DSL.new.configure(config_file).tap do |config|
+            traverser = ConfigTraverser.new(config)
+            ConfigValidator.new(traverser).validate!
+          end
+        end
+      end
+    end
+
+  end
+end
+

data/lib/taketo/actions/generate_ssh_config.rb

@@ -0,0 +1,22 @@
+require 'taketo/config_traverser'
+require 'taketo/ssh_config_generator_visitor'
+require 'taketo/actions/base_action'
+require 'taketo/actions/server_action'
+
+module Taketo
+  module Actions
+
+    class GenerateSshConfig < BaseAction
+      include ServerAction
+
+      def run
+        traverser = ConfigTraverser.new(config)
+        ssh_config_generator = SSHConfigGeneratorVisitor.new
+        traverser.visit_depth_first(ssh_config_generator)
+        puts ssh_config_generator.result
+      end
+    end
+
+  end
+end
+

data/lib/taketo/actions/group_action.rb

@@ -0,0 +1,15 @@
+require 'taketo/group_resolver'
+
+module Taketo
+  module Actions
+
+    module GroupAction
+      def resolver
+        @resolver ||= GroupResolver.new(config, destination_path)
+      end
+    end
+
+  end
+end
+
+

data/lib/taketo/actions/list.rb

@@ -0,0 +1,22 @@
+require 'taketo/group_list_visitor'
+require 'taketo/actions/base_action'
+require 'taketo/actions/group_action'
+
+module Taketo
+  module Actions
+
+    class List < BaseAction
+      include GroupAction
+
+      def run
+        node = resolver.resolve
+        traverser = ConfigTraverser.new(node)
+        lister = GroupListVisitor.new
+        traverser.visit_depth_first(lister)
+        puts lister.result
+      end
+    end
+
+  end
+end
+

data/lib/taketo/actions/login.rb

@@ -0,0 +1,40 @@
+require 'taketo/commands/ssh_command'
+require 'taketo/actions/base_action'
+require 'taketo/actions/server_action'
+
+module Taketo
+  module Actions
+
+    class Login < BaseAction
+      include ServerAction
+
+      def run
+        server = resolver.resolve
+        server_command = remote_command(server)
+        command_to_execute = Commands::SSHCommand.new(server).render(server_command.render(server, options))
+        execute(command_to_execute)
+      end
+
+      private
+
+      def remote_command(server)
+        command = options[:command]
+        if String(command).empty?
+          server.default_command
+        else
+          server.find_command(command.to_sym) || Constructs::Command.explicit_command(command)
+        end
+      end
+
+      def execute(shell_command)
+        if options[:dry_run]
+          puts shell_command
+        else
+          system shell_command
+        end
+      end
+    end
+
+  end
+end
+

data/lib/taketo/actions/matches.rb

@@ -0,0 +1,28 @@
+require 'taketo/destination_matcher'
+require 'taketo/actions/base_action'
+require 'taketo/actions/server_action'
+require 'taketo/actions/group_action'
+require 'taketo/actions/node_action'
+
+module Taketo
+  module Actions
+
+    class Matches < BaseAction
+      def initialize(options)
+        super
+        if options[:list]
+          self.extend(GroupAction)
+        elsif options[:view]
+          self.extend(NodeAction)
+        else
+          self.extend(ServerAction)
+        end
+      end
+
+      def run
+        puts DestinationMatcher.new(resolver.nodes).matches.join(" ")
+      end
+    end
+
+  end
+end

data/lib/taketo/actions/node_action.rb

@@ -0,0 +1,15 @@
+require 'taketo/node_resolver'
+
+module Taketo
+  module Actions
+
+    module NodeAction
+      def resolver
+        @resolver ||= NodeResolver.new(config, destination_path)
+      end
+    end
+
+  end
+end
+
+

data/lib/taketo/actions/server_action.rb

@@ -0,0 +1,14 @@
+require 'taketo/server_resolver'
+
+module Taketo
+  module Actions
+
+    module ServerAction
+      def resolver
+        @resolver ||= ServerResolver.new(config, destination_path)
+      end
+    end
+
+  end
+end
+

data/lib/taketo/actions/view.rb

@@ -0,0 +1,24 @@
+require 'taketo/config_traverser'
+require 'taketo/config_printer_visitor'
+require 'taketo/actions/base_action'
+require 'taketo/actions/node_action'
+
+module Taketo
+  module Actions
+
+    class View < BaseAction
+      include NodeAction
+
+      def run
+        config.default_destination = nil
+        node = resolver.resolve
+        traverser = ConfigTraverser.new(node)
+        config_printer = ConfigPrinterVisitor.new
+        traverser.visit_depth_first(config_printer)
+        puts config_printer.result
+      end
+    end
+
+  end
+end
+

data/lib/taketo/actions.rb

@@ -0,0 +1,21 @@
+require 'taketo/actions/login'
+require 'taketo/actions/view'
+require 'taketo/actions/list'
+require 'taketo/actions/matches'
+require 'taketo/actions/generate_ssh_config'
+
+module Taketo
+  module Actions
+    def self.[](name)
+      actions_map = {
+        :login               => Login,
+        :view                => View,
+        :list                => List,
+        :matches             => Matches,
+        :generate_ssh_config => GenerateSshConfig
+      }
+      actions_map.fetch(name) { Login }
+    end
+  end
+end
+

data/lib/taketo/associated_nodes.rb

@@ -78,6 +78,10 @@ module Taketo
         @nodes.fetch(name_plural) { [] }.any?
       end
 
+      def has_deeply_nested_nodes?(name_plural)
+        has_nodes?(name_plural) || self.class.node_types.any? { |n| nodes(n).any? { |node| node.has_deeply_nested_nodes?(name_plural) } }
+      end
+
       ##
       # Ovverride for better error messages
       def qualified_name

data/lib/taketo/commands.rb

@@ -3,4 +3,5 @@ module Taketo
   end
 end
 
-Dir.glob(File.expand_path('../commands/*.rb', __FILE__)).each { |c| require c }
+require 'taketo/commands/ssh_command'
+

data/lib/taketo/config_validator.rb

@@ -21,6 +21,10 @@ module Taketo
       raise ConfigError, "Environment #{e.path}: no servers" unless e.has_servers?
     end
 
+    visit Group do |g|
+      raise ConfigError, "Group #{g.path}: no servers" unless g.has_servers?
+    end
+
     visit Server do |s|
       if !String(s.global_alias).empty?
         if @global_server_aliases.key?(s.global_alias)

data/lib/taketo/config_visitor.rb

@@ -1,7 +1,9 @@
 require 'taketo/constructs'
 
 module Taketo
-  def self.downcased_construct_class_name(klass)
+  extend self
+
+  def downcased_construct_class_name(klass)
     klass.name.gsub("Taketo::Constructs::", "").gsub(/[A-Z][^A-Z]*/) { |s| s.gsub("::", "").downcase + "_" }.chop
   end
 

data/lib/taketo/constructs/config.rb

@@ -4,6 +4,7 @@ require 'taketo/support'
 module Taketo
   module Constructs
     class Config < BaseConstruct
+      has_nodes :groups, :group
       has_nodes :projects, :project
       has_nodes :servers, :server
 
@@ -14,7 +15,7 @@ module Taketo
       end
 
       def has_servers?
-        has_nodes?(:servers) || projects.any?(&:has_servers?)
+        has_deeply_nested_nodes?(:servers)
       end
     end
   end

data/lib/taketo/constructs/environment.rb

@@ -6,6 +6,7 @@ module Taketo
   module Constructs
     class Environment < BaseConstruct
       has_nodes :servers, :server
+      has_nodes :groups, :group
 
       def initialize(name)
         super(name)
@@ -18,6 +19,14 @@ module Taketo
           ""
         end
       end
+
+      def rails_env
+        name.to_s
+      end
+
+      def has_servers?
+        has_deeply_nested_nodes?(:servers)
+      end
     end
   end
 end

data/lib/taketo/constructs/group.rb

@@ -0,0 +1,20 @@
+require 'taketo/constructs/base_construct'
+require 'taketo/support'
+
+module Taketo
+  module Constructs
+    class Group < BaseConstruct
+      has_nodes :servers, :server
+
+      def rails_env
+        parent.rails_env if parent.respond_to?(:rails_env)
+      end
+
+      def has_servers?
+        has_deeply_nested_nodes?(:servers)
+      end
+    end
+  end
+end
+
+

data/lib/taketo/constructs/project.rb

@@ -6,9 +6,10 @@ module Taketo
     class Project < BaseConstruct
       has_nodes :environments, :environment
       has_nodes :servers, :server
+      has_nodes :groups, :group
 
       def has_servers?
-        has_nodes?(:servers) || environments.any?(&:has_servers?)
+        has_deeply_nested_nodes?(:servers)
       end
     end
   end

data/lib/taketo/constructs/server.rb

@@ -21,7 +21,7 @@ module Taketo
 
       def parent=(parent)
         super
-        env(:RAILS_ENV => parent.name.to_s) if parent.is_a?(Environment)
+        env(:RAILS_ENV => parent.rails_env) if parent.respond_to?(:rails_env)
       end
 
       def global_alias=(alias_name)

data/lib/taketo/constructs.rb

@@ -8,4 +8,5 @@ require 'taketo/constructs/config'
 require 'taketo/constructs/project'
 require 'taketo/constructs/environment'
 require 'taketo/constructs/server'
+require 'taketo/constructs/group'
 require 'taketo/constructs/command'

data/lib/taketo/constructs_factory.rb

@@ -23,6 +23,10 @@ module Taketo
       Constructs::Server.new(*args)
     end
 
+    def create_group(*args)
+      Constructs::Group.new(*args)
+    end
+
     def create_command(*args)
       Constructs::Command.new(*args)
     end

data/lib/taketo/destination_matcher.rb

@@ -1,7 +1,7 @@
 module Taketo
   class DestinationMatcher
-    def initialize(servers)
-      @servers = servers
+    def initialize(nodes)
+      @nodes = nodes
     end
 
     def matches
@@ -11,11 +11,11 @@ module Taketo
     private
 
     def path_matches
-      @servers.map(&:path)
+      @nodes.map(&:path)
     end
 
     def global_alias_matches
-      @servers.map(&:global_alias).map(&:to_s).reject(&:empty?)
+      @nodes.select { |n| n.respond_to?(:global_alias) }.map(&:global_alias).map(&:to_s).reject(&:empty?)
     end
   end
 end