consular 1.0.0.rc1

data/spec/cli_spec.rb

@@ -0,0 +1,194 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+class FakeCore < Consular::Core
+
+  def self.valid_system?
+    true
+  end
+
+  def process!; puts('process'); end
+  def setup!;   puts('setup');   end
+end
+
+describe Consular::CLI do
+
+  before do
+    @template = File.read File.expand_path('../../lib/templates/example.yml.tt', __FILE__)
+    FakeFS.activate!
+    FileUtils.mkdir_p Consular.global_path
+  end
+
+  after do
+    FakeFS.deactivate!
+    Consular.instance_variable_set(:@global_path, nil)
+  end
+
+  it "displays help" do
+    output = capture_io { Consular::CLI.start ['-h'] }.join('')
+
+    assert_match /start \[PROJECT\]/, output
+    assert_match /init/,          output
+    assert_match /edit \[PROJECT\]/,  output
+  end
+
+  it "lists out all global scripts" do
+    File.open(Consular.global_path('foo.yml'),   "w") { |f| f.puts @template }
+    File.open(Consular.global_path('bar.term'),  "w") { |f| f.puts @template }
+    File.open(Consular.global_path('bar.term~'), "w") { |f| f.puts @template }
+    output = capture_io { Consular::CLI.start ['list'] }.join('')
+
+    assert_match /foo\.yml -  COMMENT OF SCRIPT HERE/,   output
+    assert_match /bar -  COMMENT OF SCRIPT HERE/,        output
+    refute_match /bar\.term -  COMMENT OF SCRIPT HERE/,  output
+    refute_match /bar\.term~/, output
+  end
+
+  describe "start command" do
+    before do
+      FileUtils.mkdir_p '/tmp'
+      FileUtils.touch '/tmp/Termfile'
+      FileUtils.touch Consular.global_path('foo.term')
+      FileUtils.touch Consular.global_path('foo.yml')
+      Consular.add_core FakeCore
+    end
+
+    it "should start a Termfile" do
+      output = capture_io { Consular::CLI.start ['start', '-r=/tmp'] }.join('')
+      assert_match /process/, output
+    end
+
+    it "should start a global term script" do
+      output = capture_io { Consular::CLI.start ['start', 'foo']  }.join('')
+      assert_match /process/, output
+    end
+
+    it "should start a global yaml script" do
+      output = capture_io { Consular::CLI.start ['start', 'foo.yml']  }.join('')
+      assert_match /process/, output
+    end
+
+    it "should return an error message if it doesn't exist" do
+      output = capture_io { Consular::CLI.start ['start', 'barr']  }.join('')
+      assert_match /does not exist/, output
+    end
+  end
+
+  describe "setup command" do
+    before do
+      FileUtils.mkdir_p '/tmp'
+      FileUtils.touch '/tmp/Termfile'
+      FileUtils.touch Consular.global_path('foo.term')
+      FileUtils.touch Consular.global_path('foo.yml')
+      Consular.add_core FakeCore
+    end
+
+    it "should setup a Termfile" do
+      output = capture_io { Consular::CLI.start ['setup', '-r=/tmp'] }.join('')
+      assert_match /setup/, output
+    end
+
+    it "should setup a global term script" do
+      output = capture_io { Consular::CLI.start ['setup', 'foo']  }.join('')
+      assert_match /setup/, output
+    end
+
+    it "should setup a global yaml script" do
+      output = capture_io { Consular::CLI.start ['setup', 'foo.yml']  }.join('')
+      assert_match /setup/, output
+    end
+
+    it "should return an error message if it doesn't exist" do
+      output = capture_io { Consular::CLI.start ['setup', 'barr']  }.join('')
+      assert_match /does not exist/, output
+    end
+  end
+
+  it "init creates a new global script directory and consularc" do
+    FileUtils.rm_rf Consular.global_path
+    capture_io { Consular::CLI.start ['init'] }.join('')
+
+    assert File.exists?(Consular.global_path), "global script directory exists"
+  end
+
+  describe "delete command" do
+
+    it "removes Termfile" do
+      FileUtils.mkdir_p '/tmp/sample_project'
+      FileUtils.touch "/tmp/sample_project/Termfile"
+      capture_io { Consular::CLI.start ['delete',"-r=/tmp/sample_project"] }
+
+      refute File.exists?("/tmp/sample_project/Termfile"), 'deletes Termfile'
+    end
+
+    it "removes .yml files" do
+      FileUtils.touch Consular.global_path('foo.yml')
+      capture_io { Consular::CLI.start ['delete','foo.yml'] }
+
+      refute File.exists?(Consular.global_path('foo.yml')), 'deletes .yml files'
+    end
+
+    it "removes .term file" do
+      FileUtils.touch Consular.global_path('delete_this.term')
+      capture_io { Consular::CLI.start ['delete','delete_this'] }
+
+      refute File.exists?(Consular.global_path('delete_this.term')), 'deletes .term file'
+    end
+
+    it "removes .term file" do
+      output = capture_io { Consular::CLI.start ['delete','barr'] }.join('')
+
+      assert_match /does not exist/, output
+    end
+
+  end
+
+  describe "edit command" do
+    before do
+      FakeFS.deactivate!
+      @path = File.join ENV['HOME'], '.config', 'consular'
+      @yaml = File.join @path, 'foobar.yml'
+      @term = File.join @path, 'foobar.term'
+      `rm -f #{@yaml}`
+      `rm -f #{@term}`
+      `rm -f /tmp/Termfile`
+    end
+
+    after do
+      `rm -f #{@yaml}`
+      `rm -f #{@term}`
+      `rm -f /tmp/Termfile`
+    end
+
+    it "edits yaml files" do
+      FakeFS.deactivate!
+      Consular::CLI.any_instance.expects(:open_in_editor).with(@yaml, nil).returns(true)
+      output = capture_io { Consular::CLI.start ['edit', 'foobar.yml'] }.join('')
+
+      assert_match /create/,      output
+      assert_match /foobar\.yml/, output
+      assert_match /- tab1/,      File.read(@yaml)
+    end
+
+    it "edits .term file" do
+      FakeFS.deactivate!
+      Consular::CLI.any_instance.expects(:open_in_editor).with(@term, nil).returns(true)
+      output = capture_io { Consular::CLI.start ['edit', 'foobar'] }.join('')
+
+      assert_match /create/,       output
+      assert_match /foobar\.term/, output
+      assert_match /setup/,        File.read(@term)
+    end
+
+    it "edits a Termfile" do
+      FakeFS.deactivate!
+      Consular::CLI.any_instance.expects(:open_in_editor).with('/tmp/Termfile', nil).returns(true)
+      output = capture_io { Consular::CLI.start ['edit', '-r=/tmp'] }.join('')
+
+      assert_match /create/,       output
+      assert_match /Termfile/,     output
+      assert_match /setup/,        File.read('/tmp/Termfile')
+    end
+
+  end
+
+end

data/spec/consular_spec.rb

@@ -0,0 +1,30 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Consular do
+
+  after do 
+    Consular.instance_variable_set(:@cores,[])
+    Consular.instance_variable_set(:@global_path,nil)
+  end
+
+  it "can add cores" do
+    Consular.add_core Consular::Core
+    assert_equal 1, Consular.cores.size
+  end
+
+  it "has default configurations" do
+    assert_equal File.join(ENV['HOME'],'.config','consular',''), Consular.global_path
+  end
+
+  it "can be configured" do
+    Consular.configure do |c|
+      c.global_path    = '/tmp/'
+      c.default_editor = 'vim'
+    end
+
+    assert_equal '/tmp/',         Consular.global_path
+    assert_equal 'vim',           Consular.default_editor
+    assert_equal '/tmp/Termfile', Consular.global_path('Termfile')
+  end
+
+end

data/spec/core_spec.rb

@@ -0,0 +1,19 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Consular::Core do
+  before do
+    @core = Consular::Core.new File.expand_path('../fixtures/bar.term', __FILE__)
+  end
+
+  it "on .initialize assigns the right values" do
+    refute_nil @core.termfile
+  end
+
+  it "stubs out the methods that need to be defined" do
+    assert_raises(NotImplementedError) { @core.class.valid_system?   }
+    assert_raises(NotImplementedError) { @core.class.capture!        }
+    assert_raises(NotImplementedError) { @core.setup!                }
+    assert_raises(NotImplementedError) { @core.process!              }
+  end
+
+end

data/spec/dsl_spec.rb

@@ -0,0 +1,76 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Consular::DSL do
+  before do
+    @dsl  = Consular::DSL.new File.expand_path('../fixtures/bar.term', __FILE__)
+    @yaml = Consular::DSL.new File.expand_path('../fixtures/foo.yml', __FILE__)
+  end
+
+  it "on .initialize setup some variables" do
+    refute_nil @dsl._setup
+    refute_nil @dsl._windows
+    refute_nil @dsl._context
+  end
+
+  describe ".to_hash with DSL" do
+    before do
+      @result = @dsl.to_hash
+    end
+
+    it "returns the initial setup" do
+      assert_equal @result[:setup], ['setup']
+    end
+
+    it "returns the first window" do
+      @window1 = @result[:windows]['window1']
+      @tab1    = @window1[:tabs]
+
+      assert_equal @window1[:before],  ['before']
+      assert_equal @window1[:options], :size => [70, 30]
+
+      assert_equal @tab1['default'][:commands], ['whoami && who && ls']
+      assert_equal @tab1['tab1'][:commands],    ['first-tab', 'motion &', 'foo']
+
+      assert_equal @tab1['tab2'][:options],  :settings => 'Grass', :name => 'second'
+      assert_equal @tab1['tab2'][:commands], ['second-tab','second-tab:ls']
+
+      assert_equal @tab1['tab3'][:options],  :settings => 'Pro', :name => 'third'
+      assert_equal @tab1['tab3'][:commands], ['third-tab', "(mvim &) && (gitx &) && uptime"]
+
+      assert_equal @tab1['tab4'][:options],  :settings => 'Grass', :name => 'fourth'
+      assert_equal @tab1['tab4'][:commands], ['fourth-tab']
+    end
+
+    it "returns the second window" do
+      @window2 = @result[:windows]['window2']
+      @tab2    = @window2[:tabs]
+
+      assert_equal @window2[:before],  ['name:before']
+      assert_equal @window2[:options], :name => 'name'
+
+      assert_equal @tab2['tab1'][:commands], ['name:tab']
+    end
+
+  end
+
+  describe ".to_hash with YAML" do
+    before do
+      @result = @yaml.to_hash
+    end
+
+    it "returns no setup" do
+      assert_equal @result[:setup], nil
+    end
+
+    it "returns the default window" do
+      @tabs = @result[:windows]['default'][:tabs]
+
+      assert_equal @tabs['tab1'][:commands], ['cd /foo/bar', 'gitx']
+      assert_equal @tabs['tab1'][:options],  {}
+
+      assert_equal @tabs['tab2'][:commands], ['ls', 'mate .']
+      assert_equal @tabs['tab2'][:options],  {}
+    end
+
+  end
+end

data/spec/fixtures/bar.term

@@ -0,0 +1,32 @@
+setup 'setup'
+
+tab 'default', 'default-tab'
+
+window :size => [70,30] do
+
+  before 'before'
+
+	run 'whoami', 'who', 'ls'
+	
+	tab 'first-tab', 'motion &', 'foo'
+
+	tab 'second', :settings => 'Grass' do
+		run 'second-tab'
+		run 'second-tab:ls'
+	end
+
+	tab 'third', :settings => 'Pro' do
+		run 'third-tab'
+		run 'mvim &', 'gitx &', 'uptime'
+	end
+
+	tab 'fourth', :settings => 'Grass' do
+		run 'fourth-tab'
+	end
+end
+
+window 'name' do
+	before { run 'name:before' }
+
+	tab 'name:tab'
+end

data/spec/fixtures/foo.yml

@@ -0,0 +1,10 @@
+# Foo.yml
+# you can make as many tabs as you wish...
+# tab names are actually arbitrary at this point too.
+---
+- tab1: 
+  - cd /foo/bar
+  - gitx
+- tab2:
+  - ls
+  - mate .

data/spec/spec_helper.rb

@@ -0,0 +1,54 @@
+require 'rubygems'
+gem 'minitest'
+require 'minitest/autorun'
+require 'fakefs/safe'
+require 'mocha'
+require File.expand_path('../../lib/consular', __FILE__)
+
+
+class ColoredIO
+  ESC = "\e["
+  NND = "#{ESC}0m"
+
+  def initialize(io)
+    @io = io
+  end
+
+  def print(o)
+    case o
+    when "."
+      @io.send(:print, "#{ESC}32m#{o}#{NND}")
+    when "E"
+      @io.send(:print, "#{ESC}33m#{o}#{NND}")
+    when "F"
+      @io.send(:print, "#{ESC}31m#{o}#{NND}")
+    else
+      @io.send(:print, o)
+    end
+  end
+
+  def puts(*o)
+    super
+  end
+end
+
+MiniTest::Unit.output = ColoredIO.new(MiniTest::Unit.output)
+
+# This is to silence the 'task' warning for the mocks.
+#
+class Thor
+  class << self
+    def create_task(meth) #:nodoc:
+      if @usage && @desc
+        base_class = @hide ? Thor::HiddenTask : Thor::Task
+        tasks[meth] = base_class.new(meth, @desc, @long_desc, @usage, method_options)
+        @usage, @desc, @long_desc, @method_options, @hide = nil
+        true
+      elsif self.all_tasks[meth] || meth == "method_missing"
+        true
+      else
+        false
+      end
+    end
+  end
+end

data/spec.watchr

@@ -0,0 +1,67 @@
+ENV["WATCHR"] = "1"
+system 'clear'
+
+def growl(message)
+  growlnotify = `which growlnotify`.chomp
+  if not growlnotify.empty?
+    title = "Watchr Test Results"
+    image = message.include?('0 failures, 0 errors') ? "~/.watchr_images/passed.png" : "~/.watchr_images/failed.png"
+    options = "-w -n Watchr --image '#{File.expand_path(image)}' -m '#{message}' '#{title}'"
+    system %(#{growlnotify} #{options} &)
+  else
+    puts message
+  end
+end
+
+def run(cmd)
+  puts(cmd)
+  `#{cmd}`
+end
+
+def run_test_file(file)
+  system('clear')
+  result = run(%Q(ruby -I"lib:test" -rubygems #{file}))
+  growl result.split("\n").last rescue nil
+  puts result
+end
+
+def run_all_tests
+  system('clear')
+  result = run "rake spec"
+  growl result.split("\n").last rescue nil
+  puts result
+end
+
+def related_test_files(path)
+  Dir['spec/**/*.rb'].select { |file| file =~ /#{File.basename(path).split(".").first}_spec.rb/ }
+end
+
+def run_suite
+  run_all_tests
+end
+
+watch('spec/spec_helper\.rb') { run_all_tests }
+watch('spec/(.*).*_spec\.rb') { |m| run_test_file(m[0]) }
+watch('lib/.*/.*\.rb') { |m| related_test_files(m[0]).map {|tf| run_test_file(tf) } }
+
+# Ctrl-\
+Signal.trap 'QUIT' do
+  puts " --- Running all tests ---\n\n"
+  run_all_tests
+end
+
+@interrupted = false
+
+# Ctrl-C
+Signal.trap 'INT' do
+  if @interrupted then
+    @wants_to_quit = true
+    abort("\n")
+  else
+    puts "Interrupt a second time to quit"
+    @interrupted = true
+    Kernel.sleep 1.5
+    # raise Interrupt, nil # let the run loop catch it
+    run_suite
+  end
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification 
+name: consular
+version: !ruby/object:Gem::Version 
+  hash: 15424055
+  prerelease: 6
+  segments: 
+  - 1
+  - 0
+  - 0
+  - rc
+  - 1
+  version: 1.0.0.rc1
+platform: ruby
+authors: 
+- Arthur Chiu
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-09 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: fakefs
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: Terminal Automation to get you on your projects quickly
+email: 
+- mr.arthur.chiu@gmail.com
+executables: 
+- consular
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- Termfile
+- bin/consular
+- consular.gemspec
+- lib/consular.rb
+- lib/consular/cli.rb
+- lib/consular/core.rb
+- lib/consular/dsl.rb
+- lib/consular/version.rb
+- lib/templates/consularc.tt
+- lib/templates/example.term.tt
+- lib/templates/example.yml.tt
+- spec.watchr
+- spec/cli_spec.rb
+- spec/consular_spec.rb
+- spec/core_spec.rb
+- spec/dsl_spec.rb
+- spec/fixtures/bar.term
+- spec/fixtures/foo.yml
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://www.github.com/achiu/consular
+licenses: []
+
+post_install_message: "********************************************************************************\n\n    Consular has been installed!  Please run:\n\n      consular init\n\n    This will create a directory at ~/.config/consular which will hold all your global scripts.\n    Also a .consularc file will be generated in your HOME directory which you can further configure\n    Consular.\n\n\
+  ********************************************************************************\n  "
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      hash: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: consular
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Quickly setup your terminal windows for your projects
+test_files: 
+- spec/cli_spec.rb
+- spec/consular_spec.rb
+- spec/core_spec.rb
+- spec/dsl_spec.rb
+- spec/fixtures/bar.term
+- spec/fixtures/foo.yml
+- spec/spec_helper.rb