consular-osx 1.0.0.rc1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in consular-osx.gemspec
+gemspec
+
+gem 'rake'
+gem 'consular', :path => '/Volumes/Storage/code/github/terminitor'

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:spec) do |test|
+  test.libs << 'lib' << 'spec'
+  test.pattern = 'spec/**/*_spec.rb'
+  test.verbose = true
+end

data/consular-osx.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "consular-osx"
+  s.version     = '1.0.0.rc1'
+  s.authors     = ["Arthur Chiu"]
+  s.email       = ["mr.arthur.chiu@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Mac OSX Terminal core for Consular}
+  s.description = %q{Automate Mac OSX Terminal with Consular}
+
+  s.rubyforge_project = "consular-osx"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'consular'
+  s.add_dependency 'rb-appscript'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'mocha'
+end

data/lib/consular/osx.rb

@@ -0,0 +1,245 @@
+require 'consular'
+require 'appscript'
+
+module Consular
+  # Consular Core to interact with Mac OS X Terminal.
+  #
+  class OSX < Core
+    include Appscript
+
+    Consular.add_core self
+
+    # The acceptable options that OSX Terminal will register.
+    #
+    ALLOWED_OPTIONS = {
+      :window => [:bounds, :visible, :miniaturized],
+      :tab    => [:settings, :selected]
+    } unless defined?(ALLOWED_OPTIONS)
+
+    class << self
+
+      # Checks to see if the current system is on darwin.
+      # TODO: strengthen this system check.
+      #
+      # @api public
+      def valid_system?
+        RUBY_PLATFORM.downcase =~ /darwin/
+      end
+    end
+
+
+    # Initializes a reference to the Terminal.app via appscript
+    #
+    # @param [String] path
+    #   path to Termfile.
+    #
+    # @api public
+    def initialize(path)
+      super
+      @terminal = app('Terminal')
+    end
+
+    # Method called by runner to Execute Termfile setup.
+    #
+    # @api public
+    def setup!
+      @termfile[:setup].each { |cmd| execute_command(cmd, :in => active_window) }
+    end
+
+    # Method called by runner to execute Termfile.
+    #
+    # @api public
+    def process!
+      windows = @termfile[:windows]
+      default = windows.delete('default')
+      execute_window(default, :default => true) unless default[:tabs].empty?
+      windows.each_pair { |_, cont| execute_window(cont) }
+    end
+
+    # Executes the commands for each designated window.
+    # .run_windows will iterate through each of the tabs in
+    # sorted order to execute the tabs in the order they were set.
+    # The logic follows this:
+    #
+    #   If the content is for the 'default' window,
+    #   then use the current active window and generate the commands.
+    #
+    #   If the content is for a new window,
+    #   then generate a new window and activate the windows.
+    #
+    #   Otherwise, open a new tab and execute the commands.
+    #
+    # @param [Hash] content
+    #   The hash contents of the window from the Termfile.
+    # @param [Hash] options
+    #   Addional options to pass. You can use:
+    #     :default - Whether this is being run as the default window.
+    #
+    # @example
+    #   @core.execute_window contents, :default => true
+    #   @core.execute_window contents, :default => true
+    #
+    # @api public
+    def execute_window(content, options = {})
+      window_options = content[:options]
+      _contents      = content[:tabs]
+      _first_run     = true
+
+      _contents.keys.sort.each do |key|
+        _content = _contents[key]
+        _options = content[:options]
+        _name    = options[:name]
+
+        _tab =
+        if _first_run && !options[:default]
+          open_window options.merge(window_options)
+        else
+          key == 'default' ? active_window : open_tab(_options)
+        end
+
+        _first_run = false
+        commands = prepend_befores _content[:commands], _contents[:befores]
+        commands = set_title _name, commands
+        commands.each { |cmd| execute_command cmd, :in => _tab }
+      end
+
+    end
+
+    # Prepend a title setting command prior to the other commands.
+    #
+    # @param [String] title
+    #   The title to set for the context of the commands.
+    # @param [Array<String>] commands
+    #   The context of commands to preprend to.
+    #
+    # @api public
+    def set_title(title, commands)
+      cmd = "PS1=\"$PS1\\[\\e]2;#{title}\\a\\]\""
+      title ? commands.insert(0, cmd) : commands
+    end
+
+    # Prepends the :before commands to the current context's
+    # commands if it exists.
+    #
+    # @param [Array<String>] commands
+    #   The current tab commands
+    # @param [Array<String>] befores
+    #   The current window's :befores
+    #
+    # @return [Array<String>]
+    #   The current context commands with the :before commands prepended
+    #
+    # @api public
+    def prepend_befores(commands, befores = nil)
+      unless befores.nil? || befores.empty?
+        commands.insert(0, befores).flatten! 
+      else
+        commands
+      end
+    end
+
+    # Execute the given command in the context of the
+    # active window.
+    #
+    # @param [String] cmd
+    #   The command to execute.
+    # @param [Hash] options
+    #   Additional options to pass into appscript for the context.
+    #
+    # @example
+    #   @osx.execute_command 'ps aux', :in => @tab_object
+    #
+    # @api public
+    def execute_command(cmd, options = {})
+      active_window.do_script cmd, options
+    end
+
+
+    # Opens a new tab and return the last instantiated tab(itself).
+    #
+    # @param [Hash] options
+    #   Options to further customize the window. You can use:
+    #     :settings -
+    #     :selected -
+    #
+    # @return
+    #   Returns a refernce to the last instantiated tab of the
+    #   window.
+    #
+    # @api public
+    def open_tab(options = nil)
+      open_terminal_with 't', options
+    end
+
+    # Opens a new window and returns its
+    # last instantiated tab.(The first 'tab' in the window).
+    #
+    # @param [Hash] options
+    #   Options to further customize the window. You can use:
+    #     :bound        - Set the bounds of the windows
+    #     :visible      - Set whether or not the current window is visible
+    #     :miniaturized - Set whether or not the window is minimized
+    #
+    # @return
+    #   Returns a refernce to the last instantiated tab of the
+    #   window.
+    #
+    # @api public
+    def open_window(options = nil)
+      open_terminal_with 'n', options
+    end
+
+
+    # Sets the options for the windows/tabs. Will filter options
+    # based on what options can be set for either windows or tabs.
+    #
+    # @param [Hash] options
+    #   Options to set for the window/tab
+    #
+    # @api semipublic
+    def set_options(options = {})
+      # raise NotImplementedError
+    end
+
+    # Returns the current terminal process.
+    # We need this method to workaround appscript so that we can
+    # instantiate new tabs and windows. Otherwise it would have
+    # looked something like # window.make(:new => :tab) but that
+    # doesn't work.
+    #
+    # @api semipublic
+    def terminal_process
+      app('System Events').application_processes['Terminal.app']
+    end
+
+    # Returns the last instantiated tab from active window
+    #
+    # @api semipublic
+    def active_tab
+      window = active_window
+      tabs   = window.tabs if window
+      tabs.last.get        if tabs
+    end
+
+    # Returns the currently active window by
+    # checking to see if it is the :frontmost window.
+    #
+    # @api semipublic
+    def active_window
+      windows = @terminal.windows.get
+      windows.detect do |window|
+        window.properties_.get[:frontmost] rescue false
+      end
+    end
+
+    private
+
+    # @api private
+    def open_terminal_with(key, options = nil)
+      terminal_process.keystroke(key, :using => :command_down)
+      set_options options
+      active_tab
+    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

data/spec/osx_spec.rb

@@ -0,0 +1,85 @@
+require File.expand_path('../spec_helper', __FILE__)
+require File.expand_path('../../lib/consular/osx',__FILE__)
+
+describe Consular::OSX do
+  before do
+    @core = Consular::OSX.new File.expand_path('../fixtures/bar.term', __FILE__)
+  end
+
+  it "should have ALLOWED_OPTIONS" do
+    options = Consular::OSX::ALLOWED_OPTIONS
+
+    assert_equal [:bounds, :visible, :miniaturized], options[:window]
+    assert_equal [:settings, :selected],             options[:tab]
+  end
+
+  it "should be added as a core to Consular" do
+    assert_includes Consular.cores, Consular::OSX
+  end
+
+  it "should set ivars on .initialize" do
+    refute_nil @core.instance_variable_get(:@termfile)
+    refute_nil @core.instance_variable_get(:@terminal)
+  end
+
+  it "should set .set_title" do
+    assert_equal ["PS1=\"$PS1\\[\\e]2;hey\\a\\]\"",'ls'], @core.set_title('hey', ['ls'])
+    assert_equal ['ls'],                                  @core.set_title(nil,   ['ls'])
+  end
+
+  it "should prepend commands with .prepend_befores" do
+    assert_equal ['ps', 'ls'], @core.prepend_befores(['ls'], ['ps'])
+    assert_equal ['ls'],       @core.prepend_befores(['ls'])
+  end
+
+  it "should .execute_command" do
+    window = mock()
+    window.expects(:do_script).with('ls',{}).returns(true)
+    @core.expects(:active_window).returns(window)
+    assert @core.execute_command('ls', {}), "that core executes do_script"
+  end
+
+  it "should executes setup block with .setup!" do
+    @core.termfile[:setup] = ['ls','ls']
+    @core.expects(:execute_command).with('ls', anything).twice
+    assert @core.setup!
+  end
+
+  it "should executes window context with .process!" do
+    @core.termfile[:windows] = {
+      'default' => { :tabs => {'default' => {:commands => ['ls']}}},
+      'window1' => { :tabs => {'default' => {:commands => ['whoami']}}},
+      'window2' => { :tabs => {'default' => {:commands => ['whoami']}}},
+    }
+
+    @core.expects(:execute_window).with(@core.termfile[:windows]['default'], :default => true).once
+    @core.expects(:execute_window).with(@core.termfile[:windows]['window1']).twice
+    assert @core.process!
+  end
+
+  it "should .open_tab" do
+    @core.expects(:open_terminal_with).with('t', nil).returns(true)
+    assert @core.open_tab
+  end
+
+  it "should .open_window" do
+    @core.expects(:open_terminal_with).with('n', nil).returns(true)
+    assert @core.open_window
+  end
+
+  describe ".execute_window" do
+    it "should use the current active window with 'default' window" do
+      skip
+    end
+
+    it "should use the open a new window if its teh first run and not the 'default' window" do
+      skip
+    end
+
+    it "should open a new tab if its not the 'default' window" do
+      skip
+    end
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,53 @@
+require 'rubygems'
+gem 'minitest'
+require 'minitest/autorun'
+require 'mocha'
+require File.expand_path('../../lib/consular/osx', __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

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification 
+name: consular-osx
+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: consular
+  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: rb-appscript
+  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
+description: Automate Mac OSX Terminal with Consular
+email: 
+- mr.arthur.chiu@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- consular-osx.gemspec
+- lib/consular/osx.rb
+- spec.watchr
+- spec/fixtures/bar.term
+- spec/osx_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+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-osx
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Mac OSX Terminal core for Consular
+test_files: 
+- spec/fixtures/bar.term
+- spec/osx_spec.rb
+- spec/spec_helper.rb