terminitor 0.0.5 → 0.1.0

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    terminitor (0.0.5)
+      github
+      rb-appscript
+      thor (~> 0.14.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    fakefs (0.2.1)
+    github (0.4.3)
+      highline (~> 1.5.1)
+      json (>= 1.2.0)
+      text-format (>= 1.0.0)
+    highline (1.5.2)
+    json (1.4.6)
+    rb-appscript (0.5.3)
+    riot (0.11.4)
+      rr
+      term-ansicolor
+    rr (1.0.0)
+    term-ansicolor (1.0.5)
+    text-format (1.0.0)
+      text-hyphen (~> 1.0.0)
+    text-hyphen (1.0.0)
+    thor (0.14.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  fakefs
+  github
+  rb-appscript
+  riot (~> 0.11.0)
+  rr
+  terminitor!
+  thor (~> 0.14.0)

data/README.md

@@ -7,7 +7,7 @@ Installation
 ------------
 
     $ gem install terminitor
-    $ terminitor setup
+    $ terminitor init
 
 Usage
 -------
@@ -16,10 +16,12 @@ Usage
 
 Using terminitor is quite easy. To define or edit a project file, simply invoke the command:
 
-    $ terminitor open foo
+    $ terminitor edit foo
 
-This will open your default editor (set through the $EDITOR variable in BASH) and you can proceed to define the commands for that project:
+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 ) ####
+    
     # ~/.terminitor/foo.yml
     # you can make as many tabs as you wish...
     # tab names are actually arbitrary at this point too.
@@ -41,6 +43,71 @@ Simply define each tab and declare the commands. Note that the session for each
 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:
+
+    $ terminitor edit foo --syntax yml
+
+
+#### Ruby DSL Syntax ####
+
+    setup 'echo "setup"'
+
+    tab "echo 'default'", "echo 'default tab'"
+
+    window do
+      tab "echo 'first tab'", "echo 'of window'"
+  
+      tab "named tab" do
+        run "echo 'named tab'"
+        run "ls"
+      end
+    end
+
+The newer Ruby DSL syntax allows for more complicated behavior such as window creation as well as setup blocks that can be executed prior loading a project.
+
+##### Tabs #####
+
+to create tabs, we can simply invoke the tab command with either the command arguments like:
+
+    tab "echo 'hi'", "gitx"
+    
+or even pass it a block:
+
+    tab do
+      run "echo 'hi'"
+      run "mate ."
+    end
+
+##### Windows #####
+
+to create windows, we can simply invoke the window command with a block containing additional commands like:
+
+    window do
+      tab "echo 'hi'"
+      tab "mate ."
+      tab do
+        run "open http://www.google.com"
+      end
+    end
+
+##### Setup #####
+
+The setup block allows you to store commands that can be ran specifically before a project and can be defined with:
+
+the command arguments:
+
+    setup "bundle install", "gitx"
+    
+or with a block:
+
+    setup do
+      run "echo 'hi'"
+      run "bundle install"
+    end
+
+
+### Running Terminitor Projects ###
+
 Once the project file has been declared to your satisfaction, simply execute any project defined in the `~/.terminitor` directory with:
 
     $ terminitor start foo
@@ -48,15 +115,24 @@ Once the project file has been declared to your satisfaction, simply execute any
 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.
 
-If you no longer need a particular project, you can easily remove the yml file for the project:
+### Removing Terminitor Projects ###
+
+If you no longer need a particular project, you can easily remove the terminitor file for the project:
 
     $ terminitor delete foo
+    
+to remove a legacy yml syntax file you can run:
+
+    $ terminitor delete foo -s=yml
+
+
+### Listing Terminitor Projects ###
 
 You can also see a full list of available projects with:
 
     $ terminitor list
 
-This will print out the available project files that you can execute.
+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.
 
 ### Creating Termfile for Repo ###
 
@@ -71,7 +147,7 @@ which contains the ideal development setup for OSX. To generate this file, invok
     $ terminitor 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 still YAML as described above in the previous section. You should *note* that the project directory is automatically
+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.
 
 Now, when you or another developer clones a project, you could simply:
@@ -91,16 +167,44 @@ In addition, you are in the project folder and you wish to remove the Termfile,
 
 This will clear the `Termfile` for the particular project.
 
+
+### Fetching Github Projects with Terminitor ###
+
+Terminitor can also fetch code repositories off Skynet, I mean 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
+
+Feel free to contribute more cores so that Terminitor can support your terminal of choice :)
+
+
 Limitations
 -----------
 
-This only works on OS X because of the dependency on applescript. It would presumably not be impossible to port this to Linux or Windows, and
-of course patches and suggestions are welcome.
+#### MacCore ####
 
-Another issue is that right now tabs are created by invoking keystrokes which means there are limitations with the terminal being in
+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.
 
+#### Fetching ####
+
+The fetch task only pulls off Github repositories at the moment(which is cool). Later on, this functionality will be extended to non github repository(probably later this week.)
+
 Authors
 -------
 
@@ -113,14 +217,17 @@ Contributors
 Thanks to the following people for their contributions so far:
 
  * Pat George ([pcg79](http://github.com/pcg79)) for contributing a patch for when a project is not found.
+ * Flavio Castelli ([flavio](http://github.com/flavio)) for contributing Konsole(KDE) core.
 
 Acknowledgements
 -----------------
 
-This code came originally years ago from: [ELCTech](http://blog.elctech.com/2008/01/16/script-terminal-with-terminit/).
-This was a great start and made terminal automation easy. However, the repository is dead, but we had continued using the code for a while.
-Finally, we decided the time had come to release this code back to the world as a gem. Thanks to ELC for creating the original
-source for this project.
+
+
+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.
+Finally, we decided the time had come to release this code back to the world as a gem. Thanks to ELC for creating the original source for this project.
 
 Also, we didn't take any code from [Project](http://github.com/joshnesbitt/project) by Josh but that project did inspire us to setup terminit
 as a gem. Basically, project is a great gem but there were a couple issues with the fact that the terminal doesn't save the session state in some cases.

data/Termfile

@@ -1,11 +1,11 @@
-# COMMENT OF SCRIPT HERE
-# you can make as many tabs as you wish...
-# tab names are actually arbitrary at this point too.
----
-- tab1:
-  - gitx
-- tab2:
-  - mate .
-  - irb
-- tab3:
-  - open 'http://github.com/achiu/terminitor'
+# Terminitor Termfile
+
+setup do
+  run 'bundle install'
+end
+
+window do
+  tab 'watchr test.watchr'
+  tab "gitx", "irb"
+  tab "open 'http://www.github.com/achiu/terminitor/issues'"
+end

data/lib/templates/example.term.tt

@@ -0,0 +1,17 @@
+# COMMENT OF SCRIPT HERE
+# you can make as many tabs as you wish...
+# tab names are actually arbitrary at this point too.
+
+setup 'echo "setup"'
+
+tab "echo 'default'", "echo 'default tab'"
+
+window do
+  tab "echo 'first tab'", "echo 'of window'"
+  
+  tab "named tab" do
+    run "echo 'named tab'"
+    run "ls"
+  end
+end
+

data/lib/terminitor.rb

@@ -1,74 +1,18 @@
 require 'rubygems'
-require 'thor'
-require 'appscript'
-require 'yaml'
-require File.expand_path('../terminitor/runner',__FILE__)
+require File.expand_path('../terminitor/yaml', __FILE__)
+require File.expand_path('../terminitor/dsl', __FILE__)
+require File.expand_path('../terminitor/runner', __FILE__)
+require File.expand_path('../terminitor/abstract_core', __FILE__)
+require File.expand_path('../terminitor/cli', __FILE__)
 
 module Terminitor
-  class Cli < Thor
-    include Thor::Actions
-    include Terminitor::Runner
-    include Appscript
-
-    def self.source_root; File.dirname(__FILE__); end
-
-    desc "start PROJECT_NAME", "runs the terminitor project"
-    method_option :root, :type => :string, :default => '.', :aliases => '-r'
-    def start(project="")
-      path = resolve_path(project)
-      if File.exists?(path)
-        do_project(path)
-      else
-        if project
-          say "'#{File.basename(path)}' doesn't exist! Please run 'terminitor open #{project}'"
-        else
-          say "Termfile doesn't exist! Please run 'terminitor open' in project directory"
-        end
-      end
-    end
-
-    desc "list", "lists all terminitor scripts"
-    def list
-      say "Global scripts: \n"
-      Dir.glob("#{ENV['HOME']}/.terminitor/*").each do |file|
-        say "  * #{File.basename(file).gsub('.yml','')} #{grab_comment_for_file(file)}"
-      end
-    end
-
-    desc "setup", "create initial root terminitor folder"
-    def setup
-      empty_directory "#{ENV['HOME']}/.terminitor"
-    end
-
-    desc "open PROJECT_NAME", "open project yaml"
-    method_option :root,    :type => :string, :default => '.', :aliases => '-r'
-    method_option :editor,  :type => :string, :default => nil, :aliases => '-c'
-    def open(project="")
-      path =  resolve_path(project)
-      template "templates/example.yml.tt", path, :skip => true
-      open_in_editor(path,options[:editor])
-    end
-    
-    desc "generate", "create a Termfile in directory"
-    method_option :root, :type => :string, :default => '.', :aliases => '-r'
-    def create
-      invoke :open, [], :root => options[:root]
-    end
-    
-    desc "delete PROJECT", "delete project script"
-    method_option :root, :type => :string, :default => '.', :aliases => '-r'
-    def delete(project="")
-      path = resolve_path(project)
-      remove_file path
-    end
-    
-    no_tasks do
-      
-      def grab_comment_for_file(file)
-        first_line = File.read(file).first
-        first_line =~ /^\s*?#/ ? ("-" + first_line.gsub("#","")) : "\n"
-      end
-    end
-        
+  autoload :Version, File.expand_path('../terminitor/version', __FILE__)
+  case RUBY_PLATFORM.downcase
+  when %r{darwin}
+    require 'appscript'
+    autoload :MacCore,     File.expand_path('../terminitor/cores/mac_core', __FILE__)
+  when %r{linux}
+    require 'dbus'
+    autoload :KonsoleCore, File.expand_path('../terminitor/cores/konsole_core', __FILE__)
   end
 end

data/lib/terminitor/abstract_core.rb

@@ -0,0 +1,68 @@
+module Terminitor
+  # This AbstractCore defines the basic methods that the Core should inherit
+  class AbstractCore
+    attr_accessor :terminal, :windows, :working_dir, :termfile
+
+    # set the terminal object, windows, and load the Termfile.
+    def initialize(path)
+      @termfile = load_termfile(path)
+    end
+
+    # Run the setup block in Termfile
+    def setup!
+      @working_dir = Dir.pwd
+      commands = @termfile[:setup].insert(0, "cd #{working_dir}")
+      commands.each { |cmd| execute_command(cmd, :in => active_window) }
+    end
+
+    # Executes the Termfile
+    def process!
+      term_windows = @termfile[:windows]
+      run_in_window(term_windows['default'], :default => true) unless term_windows['default'].to_s.empty?
+      term_windows.delete('default')
+      term_windows.each_pair { |window_name, tabs| run_in_window(tabs) }
+    end
+
+    # this command will run commands in the designated window
+    # run_in_window {:tab1 => ['ls','ok']}
+    def run_in_window(tabs, options = {})
+      open_window unless options[:default]
+      tabs.each_pair do |tab_name,commands|
+        tab = open_tab
+        commands.insert(0,  "cd \"#{@working_dir}\"") unless @working_dir.to_s.empty?
+        commands.each do |cmd|
+          execute_command(cmd, :in => tab)
+        end
+      end
+    end
+
+    # Loads commands via the termfile and returns them as a hash
+    # if it matches legacy yaml, parse as yaml, else use new dsl
+    def load_termfile(path)
+      File.extname(path) == '.yml' ? Terminitor::Yaml.new(path).to_hash : Terminitor::Dsl.new(path).to_hash
+    end
+
+
+    ## These methods are core specific methods that need to be defined.
+    # yay.
+
+    # Executes the Command
+    # execute_command 'cd /path/to', {}
+    def execute_command(cmd, options = {})
+    end
+
+    # Opens a new tab and returns itself.
+    def open_tab
+      @working_dir = Dir.pwd # pass in current directory.
+    end
+
+    # Returns the current window
+    def active_window
+    end
+
+    # Opens a new window and returns the tab object.
+    def open_window
+    end
+
+  end
+end

data/lib/terminitor/cli.rb

@@ -0,0 +1,77 @@
+require 'thor'
+
+module Terminitor
+  class Cli < Thor
+    include Thor::Actions
+    include Terminitor::Runner
+
+    def self.source_root; File.expand_path('../../',__FILE__); end
+
+    desc "start PROJECT_NAME", "runs the terminitor script"
+    method_option :root,    :type => :string, :default => '.',    :aliases => '-r'
+    def start(project="")
+      execute_core :process!, project
+    end
+
+    desc "setup PROJECT_NAME", "execute setup in the terminitor script"
+    method_option :root,    :type => :string, :default => '.',    :aliases => '-r'
+    def setup(project="")
+      execute_core :setup!, project
+    end
+
+    desc "fetch USERNAME PROJECT_NAME", "clone the designated repo and run setup"
+    method_option :root,    :type => :string, :default => '.',    :aliases => '-r'
+    method_option :setup, :type => :boolean, :default => true
+    def fetch(username, project)
+      fetch_repo username, project, options
+    end
+
+    desc "list", "lists all terminitor scripts"
+    def list
+      say "Global scripts: \n"
+      Dir.glob("#{ENV['HOME']}/.terminitor/*").each do |file|
+        say "  * #{File.basename(file).gsub('.yml','')} #{grab_comment_for_file(file)}"
+      end
+    end
+
+    desc "init", "create initial root terminitor folder"
+    def init
+      empty_directory "#{ENV['HOME']}/.terminitor"
+    end
+
+    desc "edit PROJECT_NAME", "open termitor script"
+    method_option :root,    :type => :string, :default => '.',    :aliases => '-r'
+    method_option :editor,  :type => :string, :default => nil,    :aliases => '-c'
+    method_option :syntax,  :type => :string, :default => 'term', :aliases => '-s'
+    def edit(project="")
+      syntax = project.empty? ? 'term' : options[:syntax] # force Termfile to use term syntax
+      path =  config_path(project, syntax.to_sym)
+      template "templates/example.#{syntax}.tt", path, :skip => true
+      open_in_editor(path,options[:editor])
+    end
+
+    desc "open PROJECT_NAME", "this is deprecated. please use 'edit' instead"
+    method_option :root,    :type => :string, :default => '.', :aliases => '-r'
+    method_option :syntax,  :type => :string, :default => 'term', :aliases => '-s'
+    def open(project="")
+      say "'open' is now deprecated. Please use 'edit' instead"
+      invoke :edit, [project], options
+    end
+
+
+    desc "create", "create a Termfile in directory"
+    method_option :root, :type => :string, :default => '.', :aliases => '-r'
+    def create
+      invoke :edit, [], options
+    end
+
+    desc "delete PROJECT_NAME", "delete terminitor script"
+    method_option :root,    :type => :string, :default => '.',    :aliases => '-r'
+    method_option :syntax,  :type => :string, :default => 'term', :aliases => '-s'
+    def delete(project="")
+      path = config_path(project, options[:syntax].to_sym)
+      remove_file path
+    end
+
+  end
+end