taketo 0.0.3 → 0.0.4

data/README.md

@@ -6,6 +6,12 @@ Take Me To
 
 A tiny helper utility to make access to servers easier for different projects and environments.
 
+Taketo is known to work on:
+
+* ree 1.8.7
+* MRI 1.9.2
+* MRI 1.9.3
+
 Important note:
 ---------------
 
@@ -30,6 +36,7 @@ puts a config into ```~/.taketo.rc.rb```:
         env :TERM => "xterm-256color"
         command :console do
           execute "rails c"
+          desc    "Run rails console"
         end
       end
     end
@@ -39,6 +46,8 @@ puts a config into ```~/.taketo.rc.rb```:
 Then execute ```taketo my_project:staging:server -c console``` to execute the "rails c" with corresponding environment variables set on desired server
 or just ```taketo my_project:staging:server``` to open bash
 
+To have a brief overview of the config run ```taketo [destination] --view```
+
 Destination resolving works intelligently. Given the following config:
 
 ```ruby
@@ -81,6 +90,10 @@ To-Do:
 The Changelog:
 --------------
 
+### v0.0.4 (22.07.2012) ###
+* Add --view option. Now you can view your config quickly: ```taketo my_project:environment:server --view``` or just ```taketo --view```
+* Now commands can have description
+
 ### v0.0.3 (22.07.2012) ###
 * Add default_destination config option
 * Add intelligent destination resolving

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/bin/taketo

@@ -24,20 +24,34 @@ end
 
 include Taketo
 
+DEFAULT_CONFIG_FILE = File.join(ENV['HOME'], ".taketo.rc.rb")
+
 def parse_options
-  options = { :config => File.join(ENV['HOME'], ".taketo.rc.rb") }
+  options = { :config => DEFAULT_CONFIG_FILE }
 
   OptionParser.new do |opts|
-    opts.banner = <<-DESC
-A tiny helper utility to make access to servers 
-eaiser for different projects and environments.
-  DESC
+    opts.banner = "Usage: taketo [destination] [options]"
+    opts.version = VERSION
+    opts.separator ""
+    opts.separator "Common options:"
 
-    opts.on("-f CONFIG", "--config") do |c|
+    opts.on("-f CONFIG", "--config", "Use custom config file (default: #{DEFAULT_CONFIG_FILE})") do |c|
       options[:config] = c
     end
 
-    opts.on("--dry-run") do |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("-v", "--view", "Show config contents and exit") do |v|
+      options[:view] = v
+    end
+
+    opts.separator "Special options:"
+
+    opts.on("--dry-run", "Print out what would be run") do |v|
       options[:dry_run] = v
     end
 
@@ -45,10 +59,6 @@ eaiser for different projects and environments.
       options[:debug] = d
     end
 
-    opts.on("-c COMMAND", "--command") do |c|
-      raise OptionParser::MissingArgument if String(c).strip.empty?
-      options[:command] = c
-    end
   end.parse!
 
   options
@@ -72,19 +82,25 @@ def default_command(options)
 end
  
 begin
-  options = parse_options
-  config  = parse_config(options[:config])
-
+  options          = parse_options
+  config           = parse_config(options[:config])
   destination_path = ARGV.shift.to_s
-  server = DestinationResolver.new(config, destination_path).resolve
+  resolver         = DestinationResolver.new(config, destination_path)
 
-  server_command = remote_command(server, options)
-  command_to_execute = Commands::SSHCommand.new(server).render(server_command)
-
-  if options[:dry_run]
-    puts command_to_execute
+  if options[:view]
+    node = resolver.get_node
+    puts ConfigPrinter.new.render(node).chomp
   else
-    system command_to_execute
+    server = resolver.resolve
+
+    server_command = remote_command(server, options)
+    command_to_execute = Commands::SSHCommand.new(server).render(server_command)
+
+    if options[:dry_run]
+      puts command_to_execute
+    else
+      system command_to_execute
+    end
   end
 rescue SystemExit
   # Do nothing

data/features/commands.feature

@@ -9,7 +9,7 @@ Feature:
       """
       project :slots do
         environment :staging do
-          server :s1 do
+          server do
             host "1.2.3.4"
             location "/var/apps/slots"
           end
@@ -27,7 +27,7 @@ Feature:
       """
       project :slots do
         environment :staging do
-          server :s1 do
+          server do
             host "1.2.3.4"
             location "/var/apps/slots"
             command :console do
@@ -37,7 +37,7 @@ Feature:
         end
       end
       """
-    And I successfully run `taketo --config=/tmp/taketo_test_cfg.rb --dry-run --command console slots:staging:s1`
+    And I successfully run `taketo --config=/tmp/taketo_test_cfg.rb --dry-run --command console slots:staging`
     Then the output should contain
       """
       ssh -t 1.2.3.4 "cd /var/apps/slots; RAILS_ENV=staging rails c"

data/features/connect_to_server.feature

@@ -33,7 +33,7 @@ Feature:
       """
       project :slots do
         environment :staging do
-          server :s1 do
+          server do
             host "1.2.3.4"
             location "/var/apps/slots"
           end
@@ -51,7 +51,7 @@ Feature:
       """
       project :slots do
         environment :staging do
-          server :s1 do
+          server do
             host "1.2.3.4"
             location "/var/apps/slots"
             env :FOO => "the value"
@@ -74,7 +74,7 @@ Feature:
       """
       project :slots do
         environment :staging do
-          server :s1 do
+          server do
             host "1.2.3.4"
           end
         end
@@ -82,13 +82,13 @@ Feature:
 
       project :slots do
         environment :staging do
-          server :s1 do
+          server do
             env :FOO => "bar"
           end
         end
       end
       """
-    And I successfully run `taketo --config=/tmp/taketo_test_cfg.rb slots:staging:s1 --dry-run`
+    And I successfully run `taketo --config=/tmp/taketo_test_cfg.rb slots:staging --dry-run`
     Then the output should match /ssh -t 1\.2\.3\.4 "(RAILS_ENV=staging FOO=bar|FOO=bar RAILS_ENV=staging) bash"/
 
   Scenario: Default destination

data/features/help.feature

@@ -0,0 +1,71 @@
+Feature:
+  In order to be able to use the tool effectively
+  As a user
+  I want to view what's set up in config quickly
+
+  Background:
+    When I have the following config in "/tmp/taketo_test_cfg.rb"
+    """
+    project :foo do
+      environment :bar do
+        server do
+          host "1.2.3.4"
+          port 5678
+          user "pivo"
+          location "/var/apps/vodka"
+        end
+      end
+    end
+
+    project :baz do
+      environment :qux do
+        server :bart do
+          host "2.3.4.5"
+          command :console do
+            execute "something_to_execute"
+          end
+          command :killall do
+            execute "killall humans"
+            desc "Kill ALL humans"
+          end
+        end
+      end
+    end
+    """
+
+  Scenario: View full config
+    When I run `taketo --config=/tmp/taketo_test_cfg.rb --view`
+    Then the output should contain exactly:
+      """
+      Project: foo
+        Environment: bar
+          Server: default
+            Host: 1.2.3.4
+            Port: 5678
+            User: pivo
+            Default location: /var/apps/vodka
+            Environment: RAILS_ENV=bar
+      
+      Project: baz
+        Environment: qux
+          Server: bart
+            Host: 2.3.4.5
+            Environment: RAILS_ENV=qux
+            Commands:
+              console
+              killall - Kill ALL humans
+
+      """
+
+  Scenario: View particular server
+    When I run `taketo --config=/tmp/taketo_test_cfg.rb --view foo:bar:default`
+    Then the output should contain exactly:
+      """
+      Server: default
+        Host: 1.2.3.4
+        Port: 5678
+        User: pivo
+        Default location: /var/apps/vodka
+        Environment: RAILS_ENV=bar
+
+      """

data/lib/taketo/config_printer.rb

@@ -0,0 +1,84 @@
+module Taketo
+  class ConfigPrinter
+    def initialize
+      @indent_level = 0
+      @result = ""
+    end
+
+    def result
+      @result.chomp
+    end
+
+    def render(object)
+      method = "render_#{object.class.name.gsub(/[\w:]*::/, '').downcase}"
+      send(method, object)
+    end
+
+    def render_command(command)
+      put command.name.to_s + (" - " + command.description if command.description).to_s
+      result
+    end
+
+    def render_server(server)
+      section("Server: #{server.name}") do
+        put "Host: #{server.host}"
+        put "Port: #{server.port}" if server.port
+        put "User: #{server.username}" if server.username
+        put "Default location: #{server.default_location}" if server.default_location
+        put "Environment: " + server.environment_variables.map { |n, v| "#{n}=#{v}" }.join(" ")
+        unless server.commands.empty?
+          section("Commands:") do
+            server.commands.each { |c| render_command(c) }
+          end
+        end
+      end
+      result
+    end
+
+    def render_environment(environment)
+      section("Environment: #{environment.name}", ("(No servers)" if environment.servers.empty?)) do
+        if environment.servers.any?
+          environment.servers.each { |s| render_server(s) }
+        end
+      end
+      result
+    end
+
+    def render_project(project)
+      section("Project: #{project.name}", ("(No environments)" if project.environments.empty?)) do
+        if project.environments.any?
+          project.environments.each { |e| render_environment(e) }
+        end
+      end
+      put
+      result
+    end
+
+    def render_config(config)
+      if config.projects.any?
+        config.projects.each { |p| render_project(p) }
+
+        put
+        put "Default destination: #{config.default_destination}" if config.default_destination
+      else
+        put "There are no projects yet..."
+      end
+      result
+    end
+
+    private
+
+
+    def section(title = nil, note = nil)
+      put [title, note].compact.join(" ") if title
+      @indent_level += 1
+      yield
+      @indent_level -= 1
+    end
+
+    def put(str = nil)
+      @result += "  " * @indent_level + str.to_s.chomp + "\n"
+    end
+  end
+end
+

data/lib/taketo/constructs/command.rb

@@ -6,7 +6,7 @@ module Taketo
     class Command < BaseConstruct
       include Shellwords
 
-      attr_accessor :command
+      attr_accessor :command, :description
       
       def render(server)
         %Q[#{location(server)} #{environment_variables(server)} #{command}].strip.squeeze(" ")

data/lib/taketo/destination_resolver.rb

@@ -18,6 +18,15 @@ module Taketo
       end
     end
 
+    def get_node
+      case @path.size
+      when 3 then get_server(*@path)
+      when 2 then get_project_and_environment(*@path).last
+      when 1 then get_project(*@path)
+      when 0 then @config
+      end
+    end
+
     private
 
     def set_destination(path)

data/lib/taketo/dsl.rb

@@ -5,12 +5,13 @@ module Taketo
     class ScopeError < StandardError; end
 
     class << self
-      def define_scope(scope, parent_scope)
-        define_method scope do |name, &block|
+      def define_scope(scope, parent_scope, options = {})
+        define_method scope do |*args, &block|
           unless current_scope?(parent_scope)
             raise ScopeError,
               "#{scope} can't be defined in #{current_scope} scope"
           end
+          name = args.shift || options[:default_name] or raise(ArgumentError, "Name not specified")
           scope_object = current_scope_object.find(scope, name) { @factory.create(scope, name) }
           in_scope(scope, scope_object) do
             block.call
@@ -52,7 +53,7 @@ module Taketo
 
     define_scope :project, :config
     define_scope :environment, :project
-    define_scope :server, :environment
+    define_scope :server, :environment, :default_name => :default
     define_scope :command, :server
 
     define_attribute(:default_destination, :config) { |destination| current_scope_object.default_destination = destination }
@@ -62,6 +63,7 @@ module Taketo
     define_attribute(:location, :server)            { |path|        current_scope_object.default_location = path           }
     define_attribute(:env, :server)                 { |env|         current_scope_object.env(env)                          }
     define_attribute(:execute, :command)            { |command|     current_scope_object.command = command                 }
+    define_attribute(:desc, :command)               { |description| current_scope_object.description = description         }
 
     private
 

data/lib/taketo.rb

@@ -7,4 +7,5 @@ require 'taketo/support'
 require 'taketo/dsl'
 require 'taketo/commands'
 require 'taketo/config_validator'
+require 'taketo/config_printer'
 

data/spec/integration/dsl_integration_spec.rb

@@ -7,7 +7,7 @@ describe "Taketo DSL" do
     config = Taketo::DSL.new(factory).configure do
       project :slots do
         environment :staging do
-          server :staging do
+          server do
             host "127.0.0.2"
             user "deployer"
             location "/var/app"
@@ -40,7 +40,8 @@ describe "Taketo DSL" do
     staging = project.environments[:staging]
     
     staging.servers.length.should == 1
-    staging_server = staging.servers[:staging]
+    staging_server = staging.servers[:default]
+    staging_server.name.should == :default
     staging_server.host.should == "127.0.0.2"
     staging_server.username.should == "deployer"
     staging_server.default_location.should == "/var/app"

data/spec/lib/taketo/config_printer_spec.rb

@@ -0,0 +1,115 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+require 'taketo/config_printer'
+
+include Taketo
+
+describe "ConfigPrinter" do
+  describe "#render" do
+    it "should render based on node class name" do
+      printer.should_receive(:render_fixnum)
+      printer.render(1)
+    end
+  end
+
+  describe "#render_command" do
+    let(:command) { stub(:Command, :name => :foo, :description => nil) }
+
+    it "should render command name" do
+      printer.render_command(command).should == "foo"
+    end
+
+    it "should also render description if available" do
+      command.stub(:description => "The description")
+      printer.render_command(command).should == "foo - The description"
+    end
+  end
+
+  describe "#render_server" do
+    let(:server) do
+      stub(:Server,
+           :name => :sponge,
+           :host => "1.2.3.4",
+           :port => 8000,
+           :username => "bob",
+           :default_location => "/var/app",
+           :environment_variables => { :FOO => "bar", :BOO => "baz" })
+    end
+
+    it "should render available server info and commands" do
+      server.stub(:commands => [:the_command])
+      printer.should_receive(:render_command).with(:the_command)
+      printer.render_server(server).should =~ 
+%r[Server: sponge
+  Host: 1\.2\.3\.4
+  Port: 8000
+  User: bob
+  Default location: /var/app
+  Environment: (FOO=bar BOO=baz|BOO=baz FOO=bar)
+  Commands:]
+    end
+
+    it "should not render commands if there are none" do
+      server.stub(:commands => [])
+      printer.render_server(server).should_not include("Commands:")
+    end
+  end
+
+  describe "#render_environment" do
+    let(:environment) do
+      stub(:Environment,
+           :name => :foo)
+    end
+
+    it "should render environment info and servers" do
+      environment.stub(:servers => [:the_server])
+      printer.should_receive(:render_server).with(:the_server)
+      printer.render_environment(environment).should == "Environment: foo"
+    end
+
+    it "should render appropriate message if there are no servers" do
+      environment.stub(:servers => [])
+      printer.render_environment(environment).should == "Environment: foo (No servers)"
+    end
+  end
+
+  describe "#render_project" do
+    let(:project) do
+      stub(:Project,
+           :name => :quux)
+    end
+
+    it "should render project info and it's environments" do
+      project.stub(:environments => [:the_environment])
+      printer.should_receive(:render_environment).with(:the_environment)
+      printer.render_project(project).should == "Project: quux\n"
+    end
+
+    it "should render appropriate message if there are no environments for project" do
+      project.stub(:environments => [])
+      printer.render_project(project).should == "Project: quux (No environments)\n"
+    end
+  end
+
+  describe "#render_config" do
+    let(:config) do
+      stub(:Config,
+           :default_destination => "hello:bye")
+    end
+
+    it "should render default destination and all projects" do
+      config.stub(:projects => [:the_project])
+      printer.should_receive(:render_project).with(:the_project)
+      printer.render_config(config).should == "\nDefault destination: hello:bye"
+    end
+
+    it "should render appropriate message if there are no projects" do
+      config.stub(:projects => [])
+      printer.render_config(config).should == "There are no projects yet..."
+    end
+  end
+
+  def printer
+    @printer ||= ConfigPrinter.new
+  end
+end
+

data/spec/lib/taketo/constructs/command_spec.rb

@@ -11,6 +11,11 @@ describe "Command" do
     cmd.command.should == "rails c"
   end
 
+  specify "#description= should set command description" do
+    cmd.description= "Run rails console"
+    cmd.description.should == "Run rails console"
+  end
+
   describe "#render" do
     it "should pick up server's environment variables and location" do
       server = mock(:Server, :environment_variables => { :FOO => "bar baz" }, :default_location => "/var/apps/the app")

data/spec/lib/taketo/destination_resolver_spec.rb

@@ -157,6 +157,27 @@ describe "DestinationResolver" do
     end
   end
 
+  describe "#get_node" do
+    it "should return server when path has 3 segments and is correct" do
+      resolver(config, "foo:bar:s1").get_node.should == server1
+    end
+
+    it "should return environment when path has 2 segments and is correct" do
+      resolver(config, "foo:bar").get_node.name.should == :bar
+    end
+
+    it "should return project when path has 1 segment and is correct" do
+      resolver(config, "foo").get_node.name.should == :foo
+    end
+
+    it "should return the config if path has is empty" do
+      resolver(config, "").get_node.should == config
+    end
+
+    it "should raise NonExistentDestinationError when path is not correct" do
+      expect { resolver(config, "i").get_node }.to raise_error(NonExistentDestinationError)
+    end
+  end
 
   def resolver(*args)
     DestinationResolver.new(*args)

data/spec/lib/taketo/dsl_spec.rb

@@ -20,29 +20,27 @@ describe "DSL" do
 
     it "should create a #{scope_name} and set it as current scope object" do # it "should create project and set it as current scope object"
       dsl(parent_scope, factory.create(parent_scope_name)) do |c|            #   dsl([:config], factory.create(:config)) do |c|
-        c.current_scope_object.should_receive(:find).with(scope_name, :bar). #     c.current_scope_object.should_receive(:find).with(:project, :bar).
-          and_yield.and_return(:bacon)                                       #       and_yield.and_return(:bacon)
-        factory.should_receive(:create).with(scope_name, :bar)               #     factory.should_receive(:create).with(:project, :bar)
+        stub_find_or_create_scope_object(c, scope_name, :bar)                #     stub_find_or_create_scope_object(c, :project, :bar)
         c.send(scope_name, :bar) do                                          #     c.project(:bar) do
           c.current_scope_object.should_not be_nil                           #       c.current_scope_object.should_not be_nil
-          c.current_scope_object.should == :bacon                            #       c.current_scope_object.should == factory.project
+          c.current_scope_object.should == factory.send(scope_name)          #       c.current_scope_object.should == factory.project
         end                                                                  #     end
       end                                                                    #   end
     end                                                                      # end
 
-    it "should not leak #{scope_name} as current scope object" do              # it "should not leak project as current scope object"
-      dsl(parent_scope, factory.create(parent_scope_name)) do |c|              #   dsl([:config], factory.create(:config)) do |c|
-        c.current_scope_object.stub(:find => factory.create(scope_name, :bar)) #     c.current_scope.stub(:find => factory.create(:project, :bar)) 
-        c.send(scope_name, :bar) do                                            #     c.project(:bar) do
-          c.current_scope_object.should == factory.send(scope_name)            #       c.current_scope_object.should == factory.project
-        end                                                                    #     end
-        c.current_scope_object.should_not == factory.send(scope_name)          #     c.current_scope_object.should_not == factory.project
-      end                                                                      #   end
-    end                                                                        # end
+    it "should not leak #{scope_name} as current scope object" do            # it "should not leak project as current scope object"
+      dsl(parent_scope, factory.create(parent_scope_name)) do |c|            #   dsl([:config], factory.create(:config)) do |c|
+        stub_find_or_create_scope_object(c, scope_name, :bar)                #     stub_find_or_create_scope_object(c, :project, :bar)
+        c.send(scope_name, :bar) do                                          #     c.project(:bar) do
+          c.current_scope_object.should == factory.send(scope_name)          #       c.current_scope_object.should == factory.project
+        end                                                                  #     end
+        c.current_scope_object.should_not == factory.send(scope_name)        #     c.current_scope_object.should_not == factory.project
+      end                                                                    #   end
+    end                                                                      # end
 
     it "should add a #{scope_name} to the #{parent_scope_name}'s #{scope_name}s collection" do # it "should add a project to the config's projects collection" do
       dsl(parent_scope, factory.create(parent_scope_name)) do |c|                              #   dsl([:config], factory.create(:config)) do |c|
-        c.current_scope_object.stub(:find => factory.create(scope_name, :bar))                 #     c.current_scope_object.stub(:find => factory.create(:project, :bar))
+        stub_find_or_create_scope_object(c, scope_name, :bar)                                  #     stub_find_or_create_scope_object(c, :project, :bar)
         c.current_scope_object.should_receive("append_#{scope_name}").                         #     c.current_scope_object.should_receive(:append_project).
           with(factory.send(scope_name))                                                       #       with(factory.project)
         c.send(scope_name, :bar) {}                                                            #     c.project(:bar) {}
@@ -80,6 +78,15 @@ describe "DSL" do
       describe "#server" do
         it_behaves_like "a scope", :server, :environment
 
+        it "should have name optional" do
+          dsl(scopes[:environment], factory.create(:environment, :foo)) do |c|
+            stub_find_or_create_scope_object(c, :server, :default)
+            c.server do
+              c.current_scope_object.name.should == :default
+            end
+          end
+        end
+
         describe "#host" do
           it_behaves_like "an attribute", :host, :server, :host=, "127.0.0.2"
         end
@@ -106,6 +113,10 @@ describe "DSL" do
           describe "#execute" do
             it_behaves_like "an attribute", :execute, :command, :command=, "rails c"
           end
+
+          describe "#desc" do
+            it_behaves_like "an attribute", :desc, :command, :description=, "Run rails console"
+          end
         end
       end
     end
@@ -154,5 +165,10 @@ describe "DSL" do
 
     it "should raise meaningful error if config parse failed"
   end
+
+  def stub_find_or_create_scope_object(scope_object, scope, name)
+    scope_object.current_scope_object.should_receive(:find).and_yield.and_return(factory.create(scope, name))
+    factory.should_receive(:create).with(scope, name)
+  end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: taketo
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -85,6 +85,7 @@ files:
 - bin/taketo
 - lib/taketo/commands/ssh_command.rb
 - lib/taketo/commands.rb
+- lib/taketo/config_printer.rb
 - lib/taketo/config_validator.rb
 - lib/taketo/constructs/base_construct.rb
 - lib/taketo/constructs/command.rb
@@ -103,6 +104,7 @@ files:
 - lib/taketo.rb
 - spec/integration/dsl_integration_spec.rb
 - spec/lib/taketo/commands/ssh_command_spec.rb
+- spec/lib/taketo/config_printer_spec.rb
 - spec/lib/taketo/config_validator_spec.rb
 - spec/lib/taketo/constructs/base_construct_spec.rb
 - spec/lib/taketo/constructs/command_spec.rb
@@ -122,6 +124,7 @@ files:
 - features/commands.feature
 - features/config_validation.feature
 - features/connect_to_server.feature
+- features/help.feature
 - features/step_definitions/main_steps.rb
 - features/support/env.rb
 - Gemfile