consular 1.0.0.rc1 → 1.0.0.rc2

data/.gitignore

@@ -3,3 +3,4 @@ pkg/*
 .bundle
 .rvmrc
 *.swp
+Gemfile.lock

data/README.md

@@ -1,86 +1,106 @@
-Terminitor
+Consular
 ===========
+Formally known as *Terminitor*
 
-Terminitor automates your development workflow setup. Less time setting up, more time getting things done.
+Consular automates your development workflow setup. Less time setting up, more time getting things done.
 
-Upgrading Terminitor from 0.4.1 and under
-------------------------------------------
+WTFBBQ name change?
+-------------------
 
-For those upgrading from Terminitor 0.4.1, please run:
+There are a few reasons why the name change happened. To state it simply:
 
-    $ terminitor update
+  * Terminitor apparently was a pretty difficult name to spell, was
+    a bit awkward, and the 'i' appeared in a place you didn't expect.
+  * It's a pretty long name to type.
+  * console => consul(ar).
 
-This will move your terminitor files to the new directory located at .config/terminitor 
 
-Installation
+So what's new/different? let's start.
+
+Setup && Installation
 ------------
 
-    $ gem install terminitor
-    $ terminitor init
+Install the consular gem and `init`:
+
+```bash
+$ gem install consular --pre
+$ consular init
+```
+
+This will generate a global path directory for your scripts to live in
+at `~/.config/consular` and also a `.consularc` in your home directory.
+You can customize your Consular further with `.consularc`. Say for
+example, that you didn't like the default global path:
+
+```ruby
+# ~/.consularc
+
+Consular.configure do |c|
+  c.global_path = '/a/path/i/like/better'
+end
+```
+
 
 Development Setup
 ---------------------
 
-To begin development on Terminitor, run bundler:
+To begin development on Consular, run bundler:
 
     $ gem install bundler
     $ bundle install
 
-The test suite uses ([Riot](https://www.github.com/thumblemonks/riot/)).
+The test suite uses Minitest
 to run the test run:
 
     $ rake test
 
 or use watchr:
 
-    $ watchr test.watchr
-
-or if you have terminitor installed,
-
-    $ terminitor fetch achiu terminitor
-
-this will git clone the repo and bundle install.
+    $ watchr spec.watchr
 
 Usage
 -------
 
 ### Creating Local Projects ###
 
-Using terminitor is quite easy. To define or edit a project file, simply invoke the command:
+Using consular is quite easy. To define or edit a project file, simply invoke the command:
 
-    $ terminitor edit foo
+    $ consular edit foo
 
 This will open your default editor (set through the $TERM_EDITOR or $EDITOR variable in BASH) and you can proceed to define the commands for that project with the following syntaxes:
 
 #### YAML Syntax ( Legacy ) ####
-    
-    # ~/.config/terminitor/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:
-      - mysql -u root)
-      - use test;
-      - show tables;
-    - tab3: echo "hello world"
-    - tab4: cd ~/baz/ && git pull
-    - tab5:
-      - cd ~/foo/project
-      - autotest
+
+```yaml
+# ~/.config/consular/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:
+  - mysql -u root)
+  - use test;
+  - show tables;
+- tab3: echo "hello world"
+- tab4: cd ~/baz/ && git pull
+- tab5:
+  - cd ~/foo/project
+  - autotest
+```
 
 Simply define each tab and declare the commands. Note that the session for each tab is maintained, so you just declare actions here as
 you would manually type in the terminal. Note that the title for each tab(namely tab1, tab2) are arbitrary, and can be named whatever you want.
 They are simply placeholders for the time being for upcoming features.
 
-To use the legacy syntax, you can invoke it with terminitor like so:
+To use the legacy syntax, you can invoke it with consular by appending
+the 'yml' file extension like so:
 
-    $ terminitor edit foo --syntax yml
+    $ consular edit foo.yml
 
 It is recommended that you move over to the newer Ruby DSL Syntax as it
-provides more robust features, however terminitor will still support the older
+provides more robust features, however consular will still support the older
 YAML syntax.
 
 
@@ -94,10 +114,13 @@ tab "echo 'default'", "echo 'default tab'"
 
 window do
   before { run 'cd /path' } # run this command before each command.
-  
-  run 'padrino start' # run in new window
 
-  tab "echo 'first tab'", "echo 'of window'" # create a new tab in window and run it.
+  # run in new window
+  run 'padrino start'
+
+  # create a new tab in window and run it.
+  tab "echo 'first tab'", "echo 'of window'"
+
   tab "named tab" do
     run "echo 'named tab'"
     run "ls"
@@ -182,83 +205,43 @@ or with a block:
 setup do
   run "echo 'hi'"
   run "bundle install"
-  run 'git remote add upstream git://github.com/achiu/terminitor.git'
+  run 'git remote add upstream git://github.com/achiu/consular.git'
 end
 ````
 
 
 Once defined, you can invoke your projects setup with:
 
-    terminitor setup my_project
-
-##### Settings #####
-_currently only available for Mac OSX Terminal_
-
-You can also set settings on each of your tabs and windows. for example, this is possible:
-
-Open a tab with terminal settings "Grass"
-
-````ruby
-tab :name => "named tab", :settings => "Grass" do
-  run "echo 'named tab'"
-  run "ls"
-end
-````
-
-This will create a tab with a title of 'named tab' using Terminals 'Grass' setting.
-
-
-How about a window with a specific size:
-
-````ruby
-window :bounds => [10,20,300,200] do
-
-end
-````
-
-Currently, the following options are available:
-
-__tabs__
-
-* :settings     - [String]  Set the tab to terminal settings
-* :selected     - [Boolean] Sets whether the tab is active
-* :miniaturized - [Boolean] Sets whether its miniaturized
-* :visible      - [Boolean] Sets whether its visible
-
-
-__windows__
-
-* :bounds       - [Array]  Sets the bounds
-* :miniaturized - [Boolean] Sets whether its miniaturized
-* :visible      - [Boolean] Sets whether its visible
+    consular setup my_project
 
-### Running Terminitor Projects ###
+### Running Consular Projects ###
 
-Once the project file has been declared to your satisfaction, simply execute any project defined in the `~/.config/terminitor` directory with:
+Once the project file has been declared to your satisfaction, simply execute any project defined in the `~/.config/consular` directory with:
 
-    $ terminitor start foo
+    $ consular start foo
 
 This will execute the steps and create the tabs defined and run the various options as expected. That's it. Create as many project files with as many tabs
 as you would like and automate your workflow.
 
-### Removing Terminitor Projects ###
+### Removing Consular Projects ###
 
-If you no longer need a particular project, you can easily remove the terminitor file for the project:
+If you no longer need a particular project, you can easily remove the consular file for the project:
 
-    $ terminitor delete foo
+    $ consular delete foo
     
-to remove a legacy yml syntax file you can run:
+to remove a legacy yml syntax file you can just append the file
+extension and run:
 
-    $ terminitor delete foo -s=yml
+    $ consular delete foo.yml
 
 
-### Listing Terminitor Projects ###
+### Listing Consular Projects ###
 
 You can also see a full list of available projects with:
 
-    $ terminitor list
+    $ consular list
 
-This will print out the available project files that you can execute. The list also returns whatever text you have in the first comment of each terminitor script.
+This will print out the available project files that you can execute. The list also returns whatever text you have in the first comment of each consular script.
 
 ### Creating Termfile for Repo ###
 
@@ -270,18 +253,17 @@ For example, let's say I am in `/code/my/foo/project` directory which is
 a Sinatra application. This application might have a `Gemfile` which includes all dependencies. You can also generate a `Termfile`
 which contains the ideal development setup for OSX. To generate this file, invoke:
 
-    $ terminitor create
+    $ consular create
 
 This will generate a 'Termfile' in the current project directory and open the file to be edited in the default text editor. The format
-of the file is using the new Ruby DSL as described above in the previous section. You should *note* that the project directory is automatically
-the working directory for each tab so you can just say `mate .` and the project directory containing the `Termfile` will open.
+of the file is using the new Ruby DSL as described above in the previous section. 
 
 Now, when you or another developer clones a project, you could simply:
 
     $ git clone git://path/to/my/foo/project.git
     $ cd project
-    $ terminitor setup
-    $ terminitor start
+    $ consular setup
+    $ consular start
 
 This would clone the project repo, and then install all dependencies and then launch the ideal development environment for the project. Clearly
 this makes assumptions about the user's system setup right now, but we have some ideas on how to make this work more effectively on
@@ -289,112 +271,31 @@ different configurations in the future.
 
 In addition, you are in the project folder and you wish to remove the Termfile, you can invoke the command:
 
-    $ terminitor delete
+    $ consular delete
 
 This will clear the `Termfile` for the particular project.
 
-### Capturing Terminal Settings with Terminitor ###
-_Currently Mac OSX Terminal only_
-Terminitor has the ability to also capture your terminal setup and settings simply with:
-
-    $ terminitor edit my_project --capture
-    
-this will open up a new terminitor project with the captured settings for you to continuing modifying as you see fit.
-
-
-### Fetching Github Projects with Terminitor ###
-
-Terminitor can also fetch code repositories off Github. This will have terminitor clone the repo into the current directory:
-
-    $ terminitor fetch achiu terminitor
-
-After the repo has been fetched, terminitor will go ahead and run the setup block from the Termfile included in the repository. In the event you wouldn't want the setup block to be executed, simply set setup to false:
-
-    $ terminitor fetch achiu terminitor --setup=false
-
-Some notes. Terminitor's fetch command is dependent on the ([github-gem](http://github.com/defunkt/github-gem)) at the current moment. It will try to fetch the repository with read/write access first if you have rights, if not, it will default to git read only. Happy fetching!
-
-
 Cores
 -----
 
-Cores allow Terminitor to operate on a variety of platforms. They abstract the general behavior that terminitor needs to run the commands. Each core would inherit from an ([AbstractCore](http://github.com/achiu/terminitor/blob/master/lib/terminitor/abstract_core.rb)) and define the needed methods. At the moment the following Cores are supported:
-
- * MacCore        - Mac OS X Terminal
- * KonsoleCore    - KDE Konsole
- * TerminatorCore - [Terminator](http://www.tenshu.net/terminator/)
- * ITermCore      - Mac OS X iTerm
-
-Feel free to contribute more cores so that Terminitor can support your terminal of choice :)
-
-
-Limitations
------------
-
-#### MacCore ####
-
-Right now the Mac OS X Terminal tabs are created by invoking keystrokes which means there are limitations with the terminal being in
-focus during execution of these commands. Obviously the long term goal is to solve this issue as well but in all honesty, this solution works well enough most of the time.
-
+Cores allow Consular to operate on a variety of platforms. They abstract the general behavior that consular needs to run the commands. 
+Each core inherits from ([Consular::Core](http://github.com/achiu/consular/blob/master/lib/consular/core.rb)) and defines the needed methods.
+Some of the cores that are available are:
 
-#### ITermCore ####
+ * [OSX](http://www.github.com/achiu/consular-osx) - Mac OS X Terminal
+ * [Terminator](https://github.com/ilkka/consular-terminator) - Terminator
 
-Currently the iTerm Core only provides basic functionality such as opening tabs, windows, and executing commands within them. It is also possible to split tabs into panes. The capture
-and settings functionality will be integrated soon.
+Feel free to contribute more cores so that Consular can support your terminal of choice :)
 
-Splitting tabs into panes works as follows:
+To integrate core support for your Consular, you can simply require it
+in your `.consularc` like so:
 
-    tab do
-      pane "gitx" # first pane
-        pane do      # second pane level => horizontal split
-          run "irb"
-        end
-      pane 'ls'   # first pane level => vertical split
-    end
-
-should result into something like this:
-
-    #    ###########################
-    #    #            #            #
-    #    #            #            #
-    #    #   'gitx'   #            #
-    #    #            #            #
-    #    #            #            #
-    #    ##############    'ls'    #
-    #    #            #            #
-    #    #            #            #
-    #    #   'irb'    #            #
-    #    #            #            #
-    #    #            #            #
-    #    ###########################
-
-It is not possible to split the second level panes (the horizontal
-ones). Nevertheless you should be able to split tabs into any kind of pane pattern you wish
-with this syntax.
-
-
-#### Fetching ####
-
-The fetch task only pulls off Github repositories at the moment. Later on, this functionality will be extended to non github repository.
-
-
-#### Settings and Captures ####
-
-This feature is currently only available in Mac OS X at the moment.
-
-
-#### Terminator support ####
-
-This feature currently requires the "xdotool" utility to be installed and in
-the search path. The xdotool homepage is
-http://www.semicomplete.com/blog/projects/xdotool/.
-
-
-#### Windows suppport ####
-
-Windows support is currently limited to plain cmd.exe. It is also
-limited to only creating new windows, as cmd.exe does not support tabs.
+```ruby
+# .consularc
+require 'consular/osx'
+```
 
+Or check the README of each individual core.
 
 Authors
 -------
@@ -415,8 +316,8 @@ Thanks to the following people for their contributions so far:
  * Elliot Winkler  ([mcmire](https://github.com/mcmire)) for adding 1.8.6 compatiblity and ensuring tabs open in order and fixing named tabs
  * Justin Hilemen  ([bobthecow](https://github.com/bobthecow)) for fixing the list command to remove the term extensions.
  * Dave Perrett    ([recurser](https://github.com/recurser)) for adding basic iTerm support.
- * Ilkka Laukkanen ([ilkka](https://github.com/achiu/terminitor/commits/master?author=ilkka)) for Terminator core and other fixes
- * Elia Schito     ([elia](https://github.com/achiu/terminitor/commits/master?author=elia)) for patch to allow usage of "&" for background operations
+ * Ilkka Laukkanen ([ilkka](https://github.com/achiu/consular/commits/master?author=ilkka)) for Terminator core and other fixes
+ * Elia Schito     ([elia](https://github.com/achiu/consular/commits/master?author=elia)) for patch to allow usage of "&" for background operations
  * Dotan J. Nahum  ([jondot](https://github.com/jondot)) for adding windows(cmd.exe) support
  * Kyriacos Souroullas ([kyriacos](https://github.com/kyriacos) for removing params to support generic commands
  * Jerry Cheung ([jch](https://github.com/jch)) for adding ignore for emac backups
@@ -425,8 +326,6 @@ Thanks to the following people for their contributions so far:
 Acknowledgements
 -----------------
 
-
-
 The core terminal scripting code was initially developed by [Jeff Emminger](http://workingwithrails.com/person/2412-jeff-emminger) years ago. The original introduction was made on the [ELCTech Blog](http://blog.elctech.com/2008/01/16/script-terminal-with-terminit/) and a lot of that code was adapted from [Scripting the Terminal in Leopard](http://onrails.org/articles/2007/11/28/scripting-the-leopard-terminal).
 
 This was a great start and made terminal automation easy. However, the repository died long ago, and we had continued using the code for a while.

data/lib/consular/cli.rb

@@ -146,8 +146,33 @@ module Consular
       #
       # @api private
       def valid_core
-        Consular.cores.detect { |core| core.valid_system? }
+        cores = Consular.cores.select { |core| core.valid_system? }
+        if cores.nil? || cores.empty?
+          say "No valid core was found!. Exiting...", :red
+          raise SystemExit
+        elsif cores.size > 1
+          core_selection cores
+        else
+          cores.first
+        end
+      end
+
+      # Returns a dialoag to select the desired core.
+      #
+      # @param [Array<Core>] Array of cores
+      #
+      # @return [Core] core from selection
+      #
+      # @api private
+      def core_selection(cores)
+        say "Multiple cores match the current system:", :yellow
+        cores.each_with_index do |core, index|
+          say "  [#{index}] - #{core.to_s}"
+        end
+        num = ask "Please select the number choice of the core to use: "
+        cores[num.to_i]
       end
+
       # Returns the first comment in file. This is used
       # as the title when listing out the scripts.
       #

data/lib/consular/dsl.rb

@@ -184,15 +184,6 @@ module Consular
       @_context = @_old_context
     end
 
-    def clean_up_context(context = last_open_window, old_context = nil)
-      @_context = context
-      @_old_context = old_context
-    end
-
-    def last_open_window
-      @_windows[@_windows.keys.last]
-    end
-
     # Return the default hash format for windows
     #
     # @api private
@@ -200,6 +191,8 @@ module Consular
       {:tabs => {'default' =>{:commands=>[]}}}.dup
     end
 
+    # Contains interpretation for the legacy YAML format.
+    #
     module Yaml
       # Returns yaml file as formmatted hash
       #

data/lib/consular/version.rb

@@ -1,3 +1,3 @@
 module Consular
-  VERSION = "1.0.0.rc1"
+  VERSION = "1.0.0.rc2"
 end

data/spec/cli_spec.rb

@@ -49,9 +49,14 @@ describe Consular::CLI do
       FileUtils.touch '/tmp/Termfile'
       FileUtils.touch Consular.global_path('foo.term')
       FileUtils.touch Consular.global_path('foo.yml')
+      Consular.instance_variable_set(:@cores,[])
       Consular.add_core FakeCore
     end
 
+    after do
+      Consular.instance_variable_set(:@cores,[])
+    end
+
     it "should start a Termfile" do
       output = capture_io { Consular::CLI.start ['start', '-r=/tmp'] }.join('')
       assert_match /process/, output
@@ -71,6 +76,20 @@ describe Consular::CLI do
       output = capture_io { Consular::CLI.start ['start', 'barr']  }.join('')
       assert_match /does not exist/, output
     end
+
+    it "should SystemExit if no core can be found" do
+      Consular.instance_variable_set(:@cores,[])
+      assert_raises SystemExit do
+        capture_io { Consular::CLI.start ['start', 'foo']  }.join('')
+      end
+    end
+
+    it "should bring up a core selection if more than one matching core" do
+      Consular::CLI.any_instance.expects(:core_selection).with(anything).returns(FakeCore)
+      Consular.add_core FakeCore
+      Consular.add_core FakeCore
+      assert capture_io { Consular::CLI.start ['start', 'foo'] }.join('')
+    end
   end
 
   describe "setup command" do
@@ -79,9 +98,14 @@ describe Consular::CLI do
       FileUtils.touch '/tmp/Termfile'
       FileUtils.touch Consular.global_path('foo.term')
       FileUtils.touch Consular.global_path('foo.yml')
+      Consular.instance_variable_set(:@cores,[])
       Consular.add_core FakeCore
     end
 
+    after do
+      Consular.instance_variable_set(:@cores,[])
+    end
+
     it "should setup a Termfile" do
       output = capture_io { Consular::CLI.start ['setup', '-r=/tmp'] }.join('')
       assert_match /setup/, output
@@ -101,6 +125,20 @@ describe Consular::CLI do
       output = capture_io { Consular::CLI.start ['setup', 'barr']  }.join('')
       assert_match /does not exist/, output
     end
+
+    it "should SystemExit if no core can be found" do
+      Consular.instance_variable_set(:@cores,[])
+      assert_raises SystemExit do
+        capture_io { Consular::CLI.start ['setup', 'foo']  }.join('')
+      end
+    end
+    
+    it "should bring up a core selection if more than one matching core" do
+      Consular::CLI.any_instance.expects(:core_selection).with(anything).returns(FakeCore)
+      Consular.add_core FakeCore
+      Consular.add_core FakeCore
+      assert capture_io { Consular::CLI.start ['setup', 'foo'] }.join('')
+    end
   end
 
   it "init creates a new global script directory and consularc" do

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: consular
 version: !ruby/object:Gem::Version 
-  hash: 15424055
+  hash: 15424049
   prerelease: 6
   segments: 
   - 1
   - 0
   - 0
   - rc
-  - 1
-  version: 1.0.0.rc1
+  - 2
+  version: 1.0.0.rc2
 platform: ruby
 authors: 
 - Arthur Chiu
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-09 00:00:00 -07:00
+date: 2011-10-22 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -102,7 +102,6 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,28 +0,0 @@
-PATH
-  remote: .
-  specs:
-    consular (1.0.0)
-      activesupport
-      thor
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activesupport (3.1.1)
-      multi_json (~> 1.0)
-    fakefs (0.3.1)
-    metaclass (0.0.1)
-    minitest (2.6.1)
-    mocha (0.10.0)
-      metaclass (~> 0.0.1)
-    multi_json (1.0.3)
-    thor (0.14.6)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  consular!
-  fakefs
-  minitest
-  mocha