tmux-connector 0.8.5 → 0.8.6

data/README.md

@@ -11,6 +11,7 @@ Manage multiple servers using SSH and [tmux].
 * multiple connections to individual servers possible
 * sessions can be persisted (actually recreated) after computer restarts
     - they are lost only if you delete them explicitly
+* panes not associated with hosts
 
 
 ## Quick tease
@@ -178,6 +179,9 @@ name:
     regex-ignore-parts: [0, 2]
     separator: '-'
     prefix: 'dev--'
+hostless:
+    ctrl: 1
+    additional: 2
 merge-groups:
     misc: ['cache', 'db', 'mongodb']
     lbs: ['haproxy', 'nginx']
@@ -254,6 +258,25 @@ Filed __'regex-ignore-parts'__ potentially removes some regex groups from name,
 __'separator'__ is used to separate left-over groups and it's possible to
 specify __'prefix'__ for the name.
 
+* * *
+(optional) field __'hostless'__ defines groups of panes that are not associated
+with hosts. Each group is defined by the name and the number of panes.
+
+For example,
+~~~yaml
+hostless:
+    ctrl: 1
+    additional: 2
+~~~
+defines 2 groups of panes without hosts. First group, 'ctrl', has only one
+pane, while the second group, 'additional', has 2 panes.
+
+Hostless panes can be used to:
+* issue the tcon commands to other panes
+    - e.g. one control pane, in a separate window
+* manage local work
+* connect to a host at some point in the future
+
 * * *
 (optional) field __'merge-groups'__ contains groups that should be merged (for
 layout purposes) together. This can be used to group a few servers that are
@@ -264,9 +287,11 @@ lbs: ['haproxy', 'nginx']
 ~~~
 In this example two different kinds of loadbalancers are grouped together.
 
-Note that the servers from merge groups can later be referenced with both
+Note that the servers/panes from merge groups can later be referenced with both
 original and merge-group name.
 
+Hostless groups can also be merged.
+
 * * *
 (optional) field __'multiple-hosts'__ contains __'regexes'__ and __'counts'__
 fields. With those, some hosts can have multiple connections established, not
@@ -308,6 +333,10 @@ The layouts are applied individually to any merge group and to any normal
 a group then layout allows on a single window, next window for that group is
 added. Servers from different groups never share a window.
 
+* * *
+Take a look at [`spec/fixtures/configs.yml`][configs] for some configuration
+possibilities (sections under 'input' fields).
+
 
 ## Requirements
 To be able to use the gem you should have ruby 1.9+ and tmux installed on a *nix
@@ -323,6 +352,9 @@ For a start, switching between panes/windows and attaching/detaching is enough:
 * navigate windows (next/previous): `<prefix>n` & `<prefix>p`
 * navigate panes: `<prefix><arrow>`
 
+Also useful:
+* toggle pane zoom: `<prefix>z`
+
 (prefix is by default `C-b`)
 
 
@@ -392,7 +424,10 @@ ivan@<< username >>.com
 
 I'd be happy to hear from you.
 
+Also, visit my [homepage].
+
 
+[configs]: /spec/fixtures/configs.yml
 [docopt]: https://github.com/docopt/docopt
 [tmux]: http://en.wikipedia.org/wiki/Tmux
 [CLI]: http://en.wikipedia.org/wiki/Command-line_interface
@@ -400,3 +435,4 @@ I'd be happy to hear from you.
 [dotfiles]: https://github.com/ikusalic/dotfiles
 [YAML]: http://en.wikipedia.org/wiki/YAML
 [rubulator]: http://rubular.com/
+[homepage]: http://www.ikusalic.com/

data/lib/tmux-connector/commands/start.rb

@@ -42,6 +42,11 @@ module TmuxConnector
           acc[e.group_id] << e
           acc
         end
+
+        if (hostless = config['hostless'])
+          @groups.merge! Hash[hostless.map { |name, count| [ name, [FakeHost.new(name, count)] ] }]
+        end
+
         sort_groups!
       end
 
@@ -52,11 +57,11 @@ module TmuxConnector
             elements.each { |e| @merge_rules[e] = name }
           end
         end
-        @groups.keys.each { |e| @merge_rules[e] ||= e }
+        groups.keys.each { |e| @merge_rules[e] ||= e }
       end
 
       def sort_groups!()
-        @groups.each do |k, v|
+        groups.each do |k, v|
           numbers_only = v.all? { |e| e.sort_value =~ /^[-+]?[0-9]+$/ }
           if numbers_only
             v.sort! { |a, b| a.sort_value.to_i <=> b.sort_value.to_i }

data/lib/tmux-connector/config_handler.rb

@@ -6,7 +6,7 @@ module TmuxConnector
 
   def self.get_config(config_file)
     config = read_config config_file
-    process_config! config
+    process_config!(config) rescue raise 'configuration file parsing failed'
     return config
   end
 
@@ -21,8 +21,7 @@ module TmuxConnector
   def self.process_config!(config)
     config['regex'] = Regexp.new config['regex']
     config['reject-regex'] = Regexp.new(config['reject-regex']) if config['reject-regex']
-    if config['name']
-      c = config['name']
+    if (c = config['name'])
       c['regex-ignore-parts'] ||= []
       c['separator'] ||= '-'
       c['prefix'] ||= ''

data/lib/tmux-connector/host.rb

@@ -33,7 +33,7 @@ module TmuxConnector
           return config['name']['prefix'] + parts.join(config['name']['separator'])
         end
 
-        return @ssh_name
+        return ssh_name
       end
 
       def get_count(config)
@@ -47,4 +47,23 @@ module TmuxConnector
         return 1
       end
   end
+
+  class FakeHost
+    attr_reader :count
+    attr_reader :display_name
+    attr_reader :group_id
+    attr_reader :sort_value
+    attr_reader :ssh_name
+
+    def initialize(name, count)
+      @display_name = @group_id = @ssh_name = name
+      @count = count
+
+      @sort_value = nil
+    end
+
+    def to_s()
+      return "<fake-host::#{ display_name }-#{ count }>"
+    end
+  end
 end

data/lib/tmux-connector/tmux_handler.rb

@@ -44,6 +44,7 @@ module TmuxConnector
         else
           matches = server_regex.nil? && group_regex.nil?
           matches ||= !server_regex.nil? && pane.host.ssh_name.match(server_regex)
+          matches ||= !group_regex.nil? && pane.host.group_id.match(group_regex)
           matches ||= !group_regex.nil? && session.merge_rules[pane.host.group_id].match(group_regex)
         end
 
@@ -114,6 +115,8 @@ HERE
         ssh_config_path = File.expand_path session.args['--ssh-config']
 
         each_pane do |window_index, pane_index, pane|
+          next unless pane.host.instance_of? TmuxConnector::Host
+
           ssh_command = "ssh -F #{ ssh_config_path } #{ pane.host.ssh_name }"
           commands << "tmux send-keys -t #{ name }:#{ window_index }.#{ pane_index } '#{ ssh_command }' C-m"
         end

data/lib/tmux-connector/version.rb

@@ -1,3 +1,3 @@
 module TmuxConnector
-  VERSION = "0.8.5"
+  VERSION = "0.8.6"
 end

data/spec/config_spec.rb

@@ -50,5 +50,10 @@ describe "Configuration file" do
     describe "multiple hosts" do
       it_should_behave_like "config test", 'multiple-hosts'
     end
+
+    describe "panes without hosts" do
+      it_should_behave_like "config test", 'hostless'
+      it_should_behave_like "config test", 'hostless-merge'
+    end
   end
 end

data/spec/fixtures/configs.yml

@@ -129,3 +129,29 @@ multiple-hosts:
             - !ruby-regexp '(loadbalancer)-'
             - !ruby-regexp '(database)-'
         counts: [2, 3]
+
+hostless:
+  input:
+    <<: *input-min
+    hostless:
+        ctrl: 2
+        smt: 4
+  expected:
+    <<: *expected-min
+    hostless:
+        ctrl: 2
+        smt: 4
+
+hostless-merge:
+  input:
+    <<: *input-min
+    hostless:
+        ctrl: 2
+    merge-groups:
+      misc: ['ctrl', 'repo']
+  expected:
+    <<: *expected-min
+    hostless:
+        ctrl: 2
+    merge-groups:
+      misc: ['ctrl', 'repo']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tmux-connector
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.8.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-08 00:00:00.000000000 Z
+date: 2013-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt