teamocil 0.3.2 → 0.3.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    teamocil (0.3.1)
+    teamocil (0.3.3)
 
 GEM
   remote: http://rubygems.org/
@@ -19,7 +19,7 @@ GEM
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.6.0)
     syntax (1.0.0)
-    yard (0.7.2)
+    yard (0.7.5)
 
 PLATFORMS
   ruby

data/Rakefile

@@ -1,11 +1,28 @@
+require "bundler"
+Bundler.require(:development)
+
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :default => :spec
 
-desc "Run specs"
-task :spec do # {{{
-  sh "bundle exec rspec --color --format=nested #{Dir.glob(File.join(File.dirname(__FILE__), "spec/**/*_spec.rb")).join(" ")}"
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec) do |task| # {{{
+  task.pattern = "spec/**/*_spec.rb"
+  task.rspec_opts = "--colour --format=documentation"
 end # }}}
 
-desc "Generate documentation"
-task :doc do # {{{
-  sh "bundle exec yard doc"
+desc "Generate YARD Documentation"
+YARD::Rake::YardocTask.new do |task| # {{{
+  task.options = [
+    "-o", File.expand_path("../doc", __FILE__),
+    "--readme=README.md",
+    "--markup=markdown",
+    "--markup-provider=maruku",
+    "--no-private",
+    "--no-cache",
+    "--protected",
+    "--title=Teamocil",
+  ]
+  task.files   = ["lib/**/*.rb"]
 end # }}}

data/lib/teamocil.rb

@@ -1,5 +1,5 @@
 module Teamocil
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
   autoload :Layout, "teamocil/layout"
   autoload :CLI,    "teamocil/cli"
 end

data/lib/teamocil/cli.rb

@@ -12,8 +12,6 @@ module Teamocil
     # @param argv [Hash] the command line parameters hash (usually `ARGV`).
     # @param env [Hash] the environment variables hash (usually `ENV`).
     def initialize(argv, env) # {{{
-      bail "You must be in a tmux session to use teamocil" unless env["TMUX"]
-
       parse_options! argv
       layout_path = File.join("#{env["HOME"]}", ".teamocil")
 
@@ -22,19 +20,16 @@ module Teamocil
         return print_layouts
       end
 
-      if @options.include?(:layout)
-        file = @options[:layout]
-      else
-        file = ::File.join(layout_path, "#{argv[0]}.yml")
-      end
+      file = @options[:layout] || ::File.join(layout_path, "#{argv[0]}.yml")
 
       if @options[:edit]
         ::FileUtils.touch file unless File.exists?(file)
-        system("$EDITOR \"#{file}\"")
+        Kernel.system("$EDITOR \"#{file}\"")
       else
         bail "There is no file \"#{file}\"" unless File.exists?(file)
-        parsed_layout = YAML.load_file(file)
-        @layout = Teamocil::Layout.new(parsed_layout, @options)
+        bail "You must be in a tmux session to use teamocil" unless env["TMUX"]
+
+        @layout = Teamocil::Layout.new(YAML.load_file(file), @options)
         @layout.compile!
         @layout.execute_commands(@layout.generate_commands)
       end

data/spec/cli_spec.rb

@@ -1,26 +1,63 @@
+# encoding: utf-8
 require File.join(File.dirname(__FILE__), "spec_helper.rb")
 
 describe Teamocil::CLI do
 
   context "executing" do
 
-    before do # {{{
-      @fake_env = { "TMUX" => 1, "HOME" => File.join(File.dirname(__FILE__), "fixtures") }
-    end # }}}
+      before do # {{{
+        @fake_env = { "TMUX" => 1, "HOME" => File.join(File.dirname(__FILE__), "fixtures") }
+      end # }}}
 
-    it "creates a layout" do # {{{
-      @cli = Teamocil::CLI.new(["sample"], @fake_env)
-      @cli.layout.session.name.should == "sample"
-      @cli.layout.session.windows.length.should == 2
-      @cli.layout.session.windows.first.name.should == "foo"
-      @cli.layout.session.windows.last.name.should == "bar"
-    end # }}}
+    context "not in tmux" do
 
-    it "lists available layouts" do # {{{
-      @cli = Teamocil::CLI.new(["--list"], @fake_env)
-      @cli.layouts.should == ["sample", "sample-2"]
-    end # }}}
+      it "should allow editing" do # {{{
+        FileUtils.stub(:touch)
+        Kernel.should_receive(:system).with(any_args())
 
-  end
+        @cli = Teamocil::CLI.new(["--edit", "my-layout"], @fake_env)
+      end # }}}
+
+    end
+
+    context "in tmux" do
+
+      before :each do # {{{
+        Teamocil::CLI.messages = []
+      end # }}}
+
+      it "creates a layout from a name" do # {{{
+        @cli = Teamocil::CLI.new(["sample"], @fake_env)
+        @cli.layout.session.name.should == "sample"
+        @cli.layout.session.windows.length.should == 2
+        @cli.layout.session.windows.first.name.should == "foo"
+        @cli.layout.session.windows.last.name.should == "bar"
+      end # }}}
+
+      it "fails to create a layout from a layout that doesn’t exist" do # {{{
+        lambda { @cli = Teamocil::CLI.new(["i-do-not-exist"], @fake_env) }.should raise_error SystemExit
+        Teamocil::CLI.messages.should include("There is no file \"#{File.join(File.dirname(__FILE__), "fixtures", ".teamocil", "i-do-not-exist.yml")}\"")
+      end # }}}
 
+      it "creates a layout from a specific file" do # {{{
+        @cli = Teamocil::CLI.new(["--layout", "./spec/fixtures/.teamocil/sample.yml"], @fake_env)
+        @cli.layout.session.name.should == "sample"
+        @cli.layout.session.windows.length.should == 2
+        @cli.layout.session.windows.first.name.should == "foo"
+        @cli.layout.session.windows.last.name.should == "bar"
+      end # }}}
+
+      it "fails to create a layout from a file that doesn’t exist" do # {{{
+        lambda { @cli = Teamocil::CLI.new(["--layout", "./spec/fixtures/.teamocil/i-do-not-exist.yml"], @fake_env) }.should raise_error SystemExit
+        Teamocil::CLI.messages.should include("There is no file \"./spec/fixtures/.teamocil/i-do-not-exist.yml\"")
+      end # }}}
+
+      it "lists available layouts" do # {{{
+        @cli = Teamocil::CLI.new(["--list"], @fake_env)
+        @cli.layouts.should == ["sample", "sample-2"]
+      end # }}}
+
+    end
+
+  end
 end

data/spec/layout_spec.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require File.join(File.dirname(__FILE__), "spec_helper.rb")
 
 describe Teamocil::Layout do
@@ -8,90 +9,110 @@ describe Teamocil::Layout do
       @layout = Teamocil::Layout.new(layouts["two-windows"], {})
     end # }}}
 
-    it "creates windows" do # {{{
-      session = @layout.compile!
-      session.windows.each do |window|
-        window.should be_an_instance_of Teamocil::Layout::Window
-      end
-    end # }}}
-
-    it "creates windows with names" do # {{{
-      session = @layout.compile!
-      session.windows[0].name.should == "foo"
-      session.windows[1].name.should == "bar"
-    end # }}}
-
-    it "creates windows with root paths" do # {{{
-      session = @layout.compile!
-      session.windows[0].root.should == "/foo"
-      session.windows[1].root.should == "/bar"
-    end # }}}
-
-    it "creates splits" do # {{{
-      session = @layout.compile!
-      session.windows.first.splits.each do |split|
-        split.should be_an_instance_of Teamocil::Layout::Split
-      end
-    end # }}}
-
-    it "creates splits with dimensions" do # {{{
-      session = @layout.compile!
-      session.windows.first.splits[0].width.should == nil
-      session.windows.first.splits[1].width.should == 50
-    end # }}}
-
-    it "creates splits with commands specified in strings" do # {{{
-      session = @layout.compile!
-      session.windows.first.splits[0].cmd.should == "echo 'foo'"
-    end # }}}
-
-    it "creates splits with commands specified in an array" do # {{{
-      session = @layout.compile!
-      session.windows.last.splits[0].cmd.length.should == 2
-      session.windows.last.splits[0].cmd.first.should == "echo 'bar'"
-      session.windows.last.splits[0].cmd.last.should == "echo 'bar in an array'"
-    end # }}}
-
-    it "creates windows with before filters" do # {{{
-      layout = Teamocil::Layout.new(layouts["two-windows-with-filters"], {})
-      session = layout.compile!
-      session.windows.first.filters["before"].length.should == 2
-      session.windows.first.filters["before"].first.should == "echo first before filter"
-      session.windows.first.filters["before"].last.should == "echo second before filter"
-    end # }}}
-
-    it "creates windows with after filters" do # {{{
-      layout = Teamocil::Layout.new(layouts["two-windows-with-filters"], {})
-      session = layout.compile!
-      session.windows.first.filters["after"].length.should == 2
-      session.windows.first.filters["after"].first.should == "echo first after filter"
-      session.windows.first.filters["after"].last.should == "echo second after filter"
-    end # }}}
-
-    it "should handle blank filters" do # {{{
-      session = @layout.compile!
-      session.windows.first.filters.should have_key "after"
-      session.windows.first.filters.should have_key "before"
-      session.windows.first.filters["after"].should be_empty
-      session.windows.first.filters["before"].should be_empty
-    end # }}}
-
-    it "should handle splits without a target" do # {{{
-      session = @layout.compile!
-      session.windows.last.splits.last.target.should == nil
-    end # }}}
-
-    it "should handle splits with a target" do # {{{
-      session = @layout.compile!
-      session.windows.last.splits.first.target.should == "bottom-right"
-    end # }}}
-
-    it "should handle windows within a session" do # {{{
-      layout = Teamocil::Layout.new(layouts["three-windows-within-a-session"], {})
-      session = layout.compile!
-      session.windows.length.should == 3
-      session.name.should == "my awesome session"
-    end # }}}
+    describe "windows" do
+
+      it "creates windows" do # {{{
+        session = @layout.compile!
+        session.windows.each do |window|
+          window.should be_an_instance_of Teamocil::Layout::Window
+        end
+      end # }}}
+
+      it "creates windows with names" do # {{{
+        session = @layout.compile!
+        session.windows[0].name.should == "foo"
+        session.windows[1].name.should == "bar"
+      end # }}}
+
+      it "creates windows with root paths" do # {{{
+        session = @layout.compile!
+        session.windows[0].root.should == "/foo"
+        session.windows[1].root.should == "/bar"
+      end # }}}
+
+    end
+
+    describe "splits" do
+
+      it "creates splits" do # {{{
+        session = @layout.compile!
+        session.windows.first.splits.each do |split|
+          split.should be_an_instance_of Teamocil::Layout::Split
+        end
+      end # }}}
+
+      it "creates splits with dimensions" do # {{{
+        session = @layout.compile!
+        session.windows.first.splits[0].width.should == nil
+        session.windows.first.splits[1].width.should == 50
+      end # }}}
+
+      it "creates splits with commands specified in strings" do # {{{
+        session = @layout.compile!
+        session.windows.first.splits[0].cmd.should == "echo 'foo'"
+      end # }}}
+
+      it "creates splits with commands specified in an array" do # {{{
+        session = @layout.compile!
+        session.windows.last.splits[0].cmd.length.should == 2
+        session.windows.last.splits[0].cmd.first.should == "echo 'bar'"
+        session.windows.last.splits[0].cmd.last.should == "echo 'bar in an array'"
+      end # }}}
+
+    end
+
+    describe "filters" do
+
+      it "creates windows with before filters" do # {{{
+        layout = Teamocil::Layout.new(layouts["two-windows-with-filters"], {})
+        session = layout.compile!
+        session.windows.first.filters["before"].length.should == 2
+        session.windows.first.filters["before"].first.should == "echo first before filter"
+        session.windows.first.filters["before"].last.should == "echo second before filter"
+      end # }}}
+
+      it "creates windows with after filters" do # {{{
+        layout = Teamocil::Layout.new(layouts["two-windows-with-filters"], {})
+        session = layout.compile!
+        session.windows.first.filters["after"].length.should == 2
+        session.windows.first.filters["after"].first.should == "echo first after filter"
+        session.windows.first.filters["after"].last.should == "echo second after filter"
+      end # }}}
+
+      it "should handle blank filters" do # {{{
+        session = @layout.compile!
+        session.windows.first.filters.should have_key "after"
+        session.windows.first.filters.should have_key "before"
+        session.windows.first.filters["after"].should be_empty
+        session.windows.first.filters["before"].should be_empty
+      end # }}}
+
+    end
+
+    describe "targets" do
+
+      it "should handle splits without a target" do # {{{
+        session = @layout.compile!
+        session.windows.last.splits.last.target.should == nil
+      end # }}}
+
+      it "should handle splits with a target" do # {{{
+        session = @layout.compile!
+        session.windows.last.splits.first.target.should == "bottom-right"
+      end # }}}
+
+    end
+
+    describe "sessions" do
+
+      it "should handle windows within a session" do # {{{
+        layout = Teamocil::Layout.new(layouts["three-windows-within-a-session"], {})
+        session = layout.compile!
+        session.windows.length.should == 3
+        session.name.should == "my awesome session"
+      end # }}}
+
+    end
 
   end
 

data/spec/mock/cli.rb

@@ -5,10 +5,28 @@ module Teamocil
       def self.included(base) # {{{
         base.class_eval do
 
+          # Return all messages
+          def self.messages # {{{
+            @@messages
+          end # }}}
+
+          # Change messages
+          def self.messages=(messages) # {{{
+            @@messages = messages
+          end # }}}
+
           # Do not print anything
-          def print_layouts
+          def print_layouts # {{{
             # Nothing
-          end
+          end # }}}
+
+          # Print an error message and exit the utility
+          #
+          # @param msg [Mixed] something to print before exiting.
+          def bail(msg) # {{{
+            Teamocil::CLI.messages << msg
+            exit 1
+          end # }}}
 
         end
       end # }}}

data/teamocil.gemspec

@@ -25,5 +25,4 @@ spec = Gem::Specification.new do |s|
   s.add_development_dependency "rspec"
   s.add_development_dependency "yard"
   s.add_development_dependency "maruku"
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teamocil
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-05 00:00:00.000000000Z
+date: 2012-03-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70203537739940 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70203537739940
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70203539182320 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70203539182320
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70203539181900 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70203539181900
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: maruku
-  requirement: &70203539181480 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +69,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70203539181480
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Teamocil helps you set up window and splits layouts for tmux using YAML
   configuration files.
 email: remi@exomel.com
@@ -65,7 +85,6 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
-- .yardopts
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -104,15 +123,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2252634995689640042
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2252634995689640042
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.18
 signing_key: 
 specification_version: 3
 summary: Easy window and split layouts for tmux

data/.yardopts

@@ -1,13 +0,0 @@
---title             "Teamocil"
-
---no-cache
---protected
---no-private
-
---markup            "markdown"
---markup-provider   "maruku"
-
---format html
-
-"README.mkd"
-"lib/**/*.rb"