tmux-connector 0.0.3 → 0.0.4

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/README.md

@@ -154,7 +154,18 @@ Host dev.node-staging-135
 << ... >>
 ~~~
 
-Here's a 'real world' configuration file that shows of all the available
+Every configuration file needs to define at least the folowing fields:
+__'regex'__, __'regex-parts-to'__, __'group-by'__ and __'sort-by'__
+
+Here's a minimal configuration file that could be used:
+~~~yaml
+regex: !ruby-regexp '^(\w+)\.(\w+)-([\w-]+)-(\d+)$'
+regex-parts-to:
+    group-by: [1]
+    sort-by: [3]
+~~~
+
+And here's a 'real world' configuration file that shows of all the available
 options and could be use with previous ssh config file:
 
 ~~~yaml
@@ -179,18 +190,18 @@ layout:
     group-layouts:
          misc:
             tmux:
-                layout: 'tiled'
+                layout: tiled
                 max-panes: 6
          node:
             tmux:
-                layout: 'tiled'
+                layout: tiled
 ~~~
 
 * * *
-__'regex'__ field is the most important field. Some other field reference
-this one. It provides a rule on how to parse host names from ssh config file.
-The regex should be a valid ruby regex. (If you're not familiar with ruby
-regexes, consider visiting [rubulator] and playing around.)
+(required) __'regex'__ field is the most important field. Some other field
+reference this one. It provides a rule on how to parse host names from ssh
+config file.  The regex should be a valid ruby regex. (If you're not familiar
+with ruby regexes, consider visiting [rubulator] and playing around.)
 
 All host whose host names fail the regex will be ignored.
 
@@ -216,19 +227,19 @@ groups extracted from host names. Those groups are used to crate meaningful
 layouts. I know, sounds more complex than it really is...
 
 * * *
-__'reject-regex'__ (optional) field is used to ignore some hosts while starting
-a session.
-
-* * *
-Fields (__'regex-parts-to'__) __'group-by'__ and __'sort-by'__ are referencing
-before mentioned __'regex'__ field. As their names suggest, they decide which
-servers constitute a group (and share layout and potentially commands) and how
-to sort
-serves in a group. Both fields can reference more than one regex group.
+In (required) __'regex-parts-to'__ section, fields __'group-by'__ and
+__'sort-by'__  are referencing before mentioned __'regex'__ field. As their
+names suggest, they decide which servers constitute a group (and share layout
+and potentially commands) and how to sort serves in a group. Both fields can
+reference more than one regex group.
 
 In the above example, for 'dev.database-staging-1' host name, a group to which
 the host belongs would be 2nd group, which is: 'database'.
 
+* * *
+(optional) __'reject-regex'__ field is used to ignore some hosts while starting
+a session.
+
 * * *
 (optional) field __'name'__ and it's (optional) subfields
 __'regex-ignore-parts'__, __'separator'__ and __'prefix'__ decide how to name
@@ -252,25 +263,27 @@ Note that the servers from merge groups can later be referenced with both
 original and merge-group name.
 
 * * *
-Finally, what's left is the layout definition:
+Finally, what's left is the (optional) __layout__ definition:
 
 There are 2 main ways to specify a layout for a (merge-)group:
 
-1. built-in tmux layouts (even-horizontal, even-vertical, main-horizontal,
-main-vertical or tiled)
-    - defines a tmux layout and (optionally) maximum number of panes in one
-        window (default 9).
-2. custom tiled layout
-    -  defines filed layout with maximal size of rows and columns. There is
-        also an (optional) option to specify if the panes flow from left to
-        right (horizontal - default) or from top to bottom (vertical)
+1. with option __tmux__, built-in tmux layouts: even-horizontal, even-vertical,
+   main-horizontal, main-vertical or tiled
+    - defines a tmux layout, option __'layout'__ and (optionally) maximum
+      number of panes in one window, __'max-panes'__, default 9
+2. with option __custom__, custom tiled layout
+    -  defines filed layout with maximal size of rows, __'max-vertical'__, and
+       columns, __'max-vertical'__. There is also an (optional) option
+       __'panes-flow'__ to specify if the panes flow from left to right
+       (horizontal - default) or from top to bottom (vertical)
+
+If you don't specify layout, 'tmux tiled' will be used
 
 The layouts are applied individually to any merge group and to any normal
 (regex) group not belonging to some merge group. If there are more servers in
 a group then layout allows on a single window, next window for that group is
 added. Servers from different groups never share a window.
 
-
 ## Requirements
 To be able to use the gem you should have ruby 1.9+ and tmux installed on a *nix
 (Mac OS X, Linux, ...) machine. (Windows: here be dragons)

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

@@ -20,6 +20,8 @@ module TmuxConnector
         ( acc << Host.new(name, config) ) rescue nil
         acc
       end
+      raise "no hosts matching given configuration found, check your configuration file" if hosts.empty?
+
 
       generate_groups
       generate_merge_rules
@@ -45,8 +47,10 @@ module TmuxConnector
 
       def generate_merge_rules()
         @merge_rules = {}
-        config['merge-groups'].each do |name, elements|
-          elements.each { |e| @merge_rules[e] = name }
+        if config['merge-groups']
+          config['merge-groups'].each do |name, elements|
+            elements.each { |e| @merge_rules[e] = name }
+          end
         end
         @groups.keys.each { |e| @merge_rules[e] ||= e }
       end

data/lib/tmux-connector/config_handler.rb

@@ -7,7 +7,6 @@ module TmuxConnector
   def self.get_config(config_file)
     config = read_config config_file
     process_config! config
-    validate_config config
     return config
   end
 
@@ -21,7 +20,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']
+    config['reject-regex'] = Regexp.new(config['reject-regex']) if config['reject-regex']
     if config['name']
       c = config['name']
       c['regex-ignore-parts'] ||= []
@@ -29,19 +28,25 @@ module TmuxConnector
       c['prefix'] ||= ''
     end
 
-    process_layout config['layout']['default']
-    config['layout']['group-layouts'].each { |k, v| process_layout v }
+    layout = config['layout'] ||= {}
+
+    if layout['default'].nil?
+      layout['default'] = {
+        'tmux' => { 'layout' => 'tiled' }
+      }
+    end
+    expand_layout layout['default']
+
+    if layout['group-layouts']
+      layout['group-layouts'].each { |k, v| expand_layout v }
+    end
   end
 
-  def self.process_layout(config)
+  def self.expand_layout(config)
     if config['tmux']
       config['tmux']['max-panes'] ||= 9
     else
       config['custom']['panes-flow'] ||= 'horizontal'
     end
   end
-
-  def self.validate_config(config)
-    # TODO
-  end
 end

data/lib/tmux-connector/layout.rb

@@ -34,7 +34,9 @@ module TmuxConnector
       end
 
       def process_layout_config()
-        { 'default' => raw_config['default'] }.merge raw_config['group-layouts']
+        r = { 'default' => raw_config['default'] }
+        r.merge!(raw_config['group-layouts']) if raw_config['group-layouts']
+        return r
       end
 
       def add_group_to_layout(group_name, hosts, config)

data/lib/tmux-connector/version.rb

@@ -1,3 +1,3 @@
 module TmuxConnector
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/config_spec.rb

@@ -0,0 +1,50 @@
+require 'yaml'
+require 'spec_helper'
+
+require_relative '../lib/tmux-connector/config_handler'
+
+
+shared_examples "config test" do |config_name|
+  let(:input) { configs[config_name]["input"] }
+  let(:expected) do
+    r = configs[config_name]["expected"]
+    %w[ regex reject-regex ].each { |e| r[e] = Regexp.new r[e] if r[e] }
+    r
+  end
+
+  it "process_config returns correct value" do
+    configuration = input
+    TmuxConnector.process_config! configuration
+    configuration.should == expected
+  end
+end
+
+describe "Configuration file" do
+  let(:configs) do
+    YAML.load_file(File.expand_path '../fixtures/configs.yml', __FILE__)
+  end
+
+  describe "minimal" do
+    it_should_behave_like "config test", 'minimal'
+  end
+
+  describe "optional elements" do
+    describe "reject-regex" do
+      it_should_behave_like "config test", 'reject'
+    end
+
+    describe "name" do
+      it_should_behave_like "config test", 'name'
+    end
+
+    describe "merge-groups" do
+      it_should_behave_like "config test", 'merge'
+    end
+
+    describe "layout" do
+      it_should_behave_like "config test", 'layout-default'
+      it_should_behave_like "config test", 'layout-group'
+      it_should_behave_like "config test", 'layout-both'
+    end
+  end
+end

data/spec/fixtures/configs.yml

@@ -0,0 +1,115 @@
+minimal:
+  input: &input-min
+    regex: !ruby-regexp '^dev\.(\w+)([\w-]*)-(\d+)$'
+    regex-parts-to:
+      group-by: [0]
+      sort-by: [2]
+  expected: &expected-min
+    regex: !ruby-regexp '^dev\.(\w+)([\w-]*)-(\d+)$'
+    regex-parts-to:
+      group-by: [0]
+      sort-by: [2]
+    layout:
+      default:
+        tmux:
+          layout: tiled
+          max-panes: 9
+
+reject:
+  input:
+    <<: *input-min
+    reject-regex: !ruby-regexp '(loadbalancer|ngx)-'
+  expected:
+    <<: *expected-min
+    reject-regex: !ruby-regexp '(loadbalancer|ngx)-'
+
+name:
+  input:
+    <<: *input-min
+    name:
+      regex-ignore-parts: [1]
+      prefix: 'dev--'
+  expected:
+    <<: *expected-min
+    name:
+      regex-ignore-parts: [1]
+      prefix: 'dev--'
+      separator: '-'
+
+merge:
+  input:
+    <<: *input-min
+    merge-groups:
+      misc: ['repo', 'mongodb', 'sshforwarder']
+      lbs: ['loadbalancer', 'ngx']
+  expected:
+    <<: *expected-min
+    merge-groups:
+      misc: ['repo', 'mongodb', 'sshforwarder']
+      lbs: ['loadbalancer', 'ngx']
+
+layout-default:
+  input:
+    <<: *input-min
+    layout:
+      default:
+        tmux:
+          layout: 'main-vertical'
+  expected:
+    <<: *expected-min
+    layout:
+      default:
+        tmux:
+          layout: 'main-vertical'
+          max-panes: 9
+
+layout-group:
+  input:
+    <<: *input-min
+    layout:
+      group-layouts:
+        lxc:
+          custom:
+            max-horizontal: 3
+            max-vertical: 3
+  expected:
+    <<: *expected-min
+    layout:
+      default:
+        tmux:
+          layout: tiled
+          max-panes: 9
+      group-layouts:
+        lxc:
+          custom:
+            max-horizontal: 3
+            max-vertical: 3
+            panes-flow: horizontal
+
+layout-both:
+  input:
+    <<: *input-min
+    layout:
+      default:
+        tmux:
+          layout: 'main-vertical'
+          max-panes: 4
+      group-layouts:
+        bee:
+          custom:
+            max-horizontal: 2
+            max-vertical: 2
+            panes-flow: vertical
+  expected:
+    <<: *expected-min
+    layout:
+      default:
+        tmux:
+          layout: 'main-vertical'
+          max-panes: 4
+      group-layouts:
+        bee:
+          custom:
+            max-horizontal: 2
+            max-vertical: 2
+            panes-flow: vertical

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/tmux-connector.gemspec

@@ -13,6 +13,7 @@ Gem::Specification.new do |gem|
   gem.homepage      = "http://www.ikusalic.com"
 
   gem.add_dependency('docopt')
+  gem.add_development_dependency('rspec')
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tmux-connector
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-29 00:00:00.000000000 Z
+date: 2013-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docopt
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: tcon enables establishing connections (ssh) to multiple servers and executing
   commands on those servers. The sessions can be persisted (actually recreated) even
   after computer restarts. Complex sessions with different layouts for different kinds
@@ -39,6 +55,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -60,6 +77,9 @@ files:
 - lib/tmux-connector/ssh_config_parser.rb
 - lib/tmux-connector/tmux_handler.rb
 - lib/tmux-connector/version.rb
+- spec/config_spec.rb
+- spec/fixtures/configs.yml
+- spec/spec_helper.rb
 - tmux-connector.gemspec
 homepage: http://www.ikusalic.com
 licenses: []
@@ -85,4 +105,7 @@ rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Manage multiple servers using SSH and tmux.
-test_files: []
+test_files:
+- spec/config_spec.rb
+- spec/fixtures/configs.yml
+- spec/spec_helper.rb