terminitor 0.0.2 → 0.0.3

data/README.md

@@ -12,13 +12,15 @@ Installation
 Usage
 -------
 
+### Creating Local Projects ###
+
 Using terminitor is quite easy. To define or edit a project file, simply invoke the command:
 
     $ terminitor open foo
 
-This will open your default editor (set by 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 $EDITOR variable in BASH) and you can proceed to define the commands for that project:
 
-    # ~/.terminit/foo.yml
+    # ~/.terminitor/foo.yml
     # you can make as many tabs as you wish...
     # tab names are actually arbitrary at this point too.
     ---
@@ -35,31 +37,76 @@ This will open your default editor (set by the $EDITOR variable in BASH) and you
       - cd ~/foo/project
       - autotest
 
-Simply define the tabs and declare each command. Note that the session of 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
+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.
 
-Once the project file has been declared to your satisfaction, simply execute any project defined in the @.terminit@ directory with:
+Once the project file has been declared to your satisfaction, simply execute any project defined in the `~/.terminitor` directory with:
 
     $ terminitor 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.
 
+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.
+
+### Creating Termfile for Repo ###
+
+In addition to creating 'local' projects which can run on your computer (and are stored in your home directory), we also
+optionally allow you to create a `Termfile` within any directory and then you can execute this any time to setup the
+environment for that particular project source.
+
+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
+
+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.
+
+Now, when you or another developer clones a project, you could simply:
+
+    $ git clone git://path/to/my/foo/project.git
+    $ cd project
+    $ bundle install
+    $ terminitor 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
+different configurations in the future.
+
 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.
 
+Another issue is that right now 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.
+
 Authors
 -------
 
-The core code was adapted before by Nathan Esquenazi and Thomas Shafer. In September 2010, Arthur Chiu and Nathan Esquenazi gemified and released this to gemcutter.
+The core code was adapted before by Nathan Esquenazi and Thomas Shafer.
+In September 2010, Arthur Chiu and Nathan Esquenazi gemified and released this to gemcutter.
+
+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.
 
 Acknowledgements
 -----------------
 
-This code came originally years ago from: http://blog.elctech.com/2008/01/16/script-terminal-with-terminit/ .
+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.

data/lib/templates/example.yml.tt

@@ -0,0 +1,16 @@
+# COMMENT OF SCRIPT HERE
+# 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

data/lib/terminitor.rb

@@ -10,9 +10,28 @@ module Terminitor
     include Terminitor::Runner
     include Appscript
 
+    def self.source_root; File.dirname(__FILE__); end
+
     desc "start PROJECT_NAME", "runs the terminitor project"
-    def start(project)
-      do_project(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
+      Dir.glob("#{ENV['HOME']}/.terminitor/*").each do |file|
+        say "#{File.basename(file)} - #{File.read(file).first.gsub("#",'')}"
+      end
     end
 
     desc "setup", "create initial root terminitor folder"
@@ -21,10 +40,18 @@ module Terminitor
     end
 
     desc "open PROJECT_NAME", "open project yaml"
-    def open(project)
-      path = "#{ENV['HOME']}/.terminitor/#{project}.yml"
-      create_file path, :skip => true
+    method_option :root, :type => :string, :default => '.', :aliases => '-r'
+    def open(project="")
+      path =  resolve_path(project)
+      template "templates/example.yml.tt", path, :skip => true
       open_in_editor(path)
     end
+    
+    desc "generate", "create a Termfile in directory"
+    method_option :root, :type => :string, :default => '.', :aliases => '-r'
+    def create
+      invoke :open, [], :root => options[:root]
+    end
+        
   end
 end

data/lib/terminitor/runner.rb

@@ -6,9 +6,10 @@ module Terminitor
       `#{ENV['EDITOR']} #{path}`
     end
 
-    def do_project(project)
+    def do_project(path)
       terminal = app('Terminal')
-      tabs = load_config(project)
+      tabs = load_config(path)
+
       tabs.each do |hash|
         tabname = hash.keys.first
         cmds = hash.values.first
@@ -21,20 +22,15 @@ module Terminitor
       end
     end
 
-    # def usage
-    #   puts "
-    #   Usage:
-    #   #{File.basename(@file)} project_name
-    #   where project_name is the name of a terminit project yaml file
-    # 
-    #   See the README for more information.
-    #   "
-    #   exit 0
-    # end
+    def resolve_path(project)
+      unless project.empty?
+        File.join(ENV['HOME'],'.terminitor', "#{project.sub(/\.yml$/, '')}.yml")
+      else
+        File.join(options[:root],"Termfile")
+      end
+    end
 
-    def load_config(project)
-      path = File.join(ENV['HOME'],'.terminitor', "#{project.sub(/\.yml$/, '')}.yml")
-      return false unless File.exists?(path)
+    def load_config(path)
       YAML.load(File.read(path))
     end
 
@@ -51,15 +47,17 @@ module Terminitor
         app("System Events").application_processes["Terminal.app"].keystroke("t", :using => :command_down)
       end
       @got_first_tab_already = true
-      local_window = terminal.windows[terminal.windows.count - 1]
+      local_window = active_window(terminal)
       local_tabs = local_window.tabs if local_window
       local_tabs.last.get if local_tabs
     end
-    
-    # checks to see if the user has Visor installed
-    def has_visor?
-      File.exists?("#{ENV['HOME']}/Library/Application\ Support/SIMBL/Plugins/Visor.bundle/")
+
+    # makes sure to set active window as frontmost.
+    def active_window(terminal)
+      (1..terminal.windows.count).each do |i|
+        window = terminal.windows[i]
+        return window if window.properties_.get[:frontmost]
+      end
     end
-    
   end
 end

data/lib/terminitor/version.rb

@@ -1,3 +1,3 @@
 module Terminitor
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/terminitor.gemspec

@@ -20,7 +20,15 @@ Gem::Specification.new do |s|
   s.add_development_dependency "riot", "~>0.14.0"
   s.add_development_dependency "rr"
   s.add_development_dependency "fakefs"
+  s.post_install_message = %q{********************************************************************************
 
+    Terminitor is installed! 
+    Please run 'terminitor setup'. 
+    This will create a directory at ~/.terminitor which will hold all your global scripts.
+    Thanks!
+
+********************************************************************************
+  }
   s.files        = `git ls-files`.split("\n")
   s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
   s.require_path = 'lib'

data/test/fixtures/foo.yml

@@ -1,18 +1,9 @@
 # you can make as many tabs as you wish...
 # tab names are actually arbitrary at this point too.
 ---
-
-- workflow:
-  - default:
-    - cd /path/to/
-    - gitx
-  - padrino:
-    - cd /padrino/app
-    - padrino start
-- project:
-  - tab1: 
-    - cd /foo/bar
-    - gitx
-  - tab2:
-    - ls
-    - mate .
+- tab1: 
+  - cd /foo/bar
+  - gitx
+- tab2:
+  - ls
+  - mate .

data/test/terminitor_test.rb

@@ -2,6 +2,7 @@ require File.expand_path('../teststrap',__FILE__)
 
 context "Terminitor" do
   setup     { @yaml = File.read(File.expand_path('../fixtures/foo.yml', __FILE__)) }
+  setup     { @template = File.read(File.expand_path('../../lib/templates/example.yml.tt', __FILE__)) }
   setup     { FakeFS.activate! }
   teardown  { FakeFS.deactivate! }
 
@@ -12,32 +13,82 @@ context "Terminitor" do
     asserts_topic.matches   %r{open PROJECT_NAME}
   end
 
+  context "list" do
+    setup { @path = "#{ENV['HOME']}/.terminitor/" }
+    setup { File.open(File.join(@path,'foo.yml'),"w") { |f| f.puts @template } }
+    setup { File.open(File.join(@path,'bar.yml'),"w") { |f| f.puts @template } }
+    setup { capture(:stdout) { Terminitor::Cli.start(['list']) } }
+    asserts_topic.matches %r{foo.yml -  COMMENT OF SCRIPT HERE}
+    asserts_topic.matches %r{bar.yml -  COMMENT OF SCRIPT HERE}
+  end
+
   context "setup" do
     setup { capture(:stdout) { Terminitor::Cli.start(['setup']) } }
     asserts("creates .terminitor") { File.exists?("#{ENV['HOME']}/.terminitor") }
   end
 
   context "open" do
-    setup { mock.instance_of(Terminitor::Cli).open_in_editor("#{ENV['HOME']}/.terminitor/foo.yml") { true }.once }
-    setup { capture(:stdout) { Terminitor::Cli.start(['open','foo']) } }
-    asserts_topic.matches %r{create}
+    setup     { FakeFS.deactivate! }
+    setup     { `rm -rf #{ENV['HOME']}/.terminitor/test_foo_bar2.yml`}
+
+    teardown  { `rm -rf /tmp/sample_project` }
+    
+    context "for project yaml" do
+      setup { mock.instance_of(Terminitor::Cli).open_in_editor("#{ENV['HOME']}/.terminitor/test_foo_bar2.yml") { true }.once }
+      setup { capture(:stdout) { Terminitor::Cli.start(['open','test_foo_bar2']) } }
+      asserts_topic.matches %r{create}
+      asserts_topic.matches %r{test_foo_bar2.yml}
+    end
+
+    context "for Termfile" do
+      context "with open" do
+        setup { mock.instance_of(Terminitor::Cli).open_in_editor("/tmp/sample_project/Termfile") { true }.once }
+        setup { capture(:stdout) { Terminitor::Cli.start(['open','-r=/tmp/sample_project']) } }
+        asserts_topic.matches %r{create}
+        asserts_topic.matches %r{Termfile}
+      end
+
+      context "with create" do
+        setup { mock.instance_of(Terminitor::Cli).invoke(:open, [], :root => '/tmp/sample_project') { true }.once }
+        asserts('calls open') { capture(:stdout) { Terminitor::Cli.start(['create','-r=/tmp/sample_project']) } }
+      end
+    end
+    
+    
+
   end
 
   context "start" do
-    setup do
-      @test_item = TestItem.new
-      @test_runner = TestRunner.new
-      stub(@test_runner).open_tab(anything) { true }.twice
-      mock(@test_item).do_script('cd /foo/bar', anything) { true }.once
-      mock(@test_item).do_script('gitx', anything) { true }.once
-      mock(@test_item).do_script('ls', anything) { true }.once
-      mock(@test_item).do_script('mate .', anything) { true }.once
-      stub(@test_runner).app('Terminal') { TestObject.new(@test_item) }
+    
+    context "for project yaml" do
+      setup do
+        @test_item = TestItem.new
+        @test_runner = TestRunner.new
+        stub(@test_runner).open_tab(anything) { true }.twice
+        mock(@test_item).do_script('cd /foo/bar', anything) { true }.once
+        mock(@test_item).do_script('gitx', anything) { true }.once
+        mock(@test_item).do_script('ls', anything) { true }.once
+        mock(@test_item).do_script('mate .', anything) { true }.once
+        stub(@test_runner).app('Terminal') { TestObject.new(@test_item) }
+      end
+      setup { capture(:stdout) { Terminitor::Cli.start(['setup']) } }
+      setup { @path = "#{ENV['HOME']}/.terminitor/foo.yml" }
+      setup { File.open(@path,"w") { |f| f.puts @yaml } }
+      asserts("runs project") { @test_runner.do_project(@path) }
     end
-    setup { capture(:stdout) { Terminitor::Cli.start(['setup']) } }
-    setup { File.open("#{ENV['HOME']}/.terminitor/foo.yml","w") { |f| f.puts @yaml } }
-    asserts("runs project") { @test_runner.do_project("foo") }
-  end
 
+    context "for Termfile" do
+      setup { FileUtils.mkdir_p('/tmp/sample_project') }
+      setup { @path = '/tmp/sample_project/Termfile' }
+      setup { File.open(@path,"w") { |f| f.puts @yaml } }
+      setup { mock.instance_of(Terminitor::Cli).do_project(@path) { true }.once }
+      asserts("runs .terminit") { capture(:stdout) { Terminitor::Cli.start(['start','-r=/tmp/sample_project']) } }
+    end
+
+    context "with invalid project" do
+      setup { capture(:stdout) { Terminitor::Cli.start(['start','nonono']) } }
+      asserts_topic.matches %r{'nonono.yml' doesn't exist! Please run 'terminitor open nonono'}
+    end
 
+  end  
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: terminitor
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Arthur Chiu
@@ -125,6 +125,7 @@ files:
 - README.md
 - Rakefile
 - bin/terminitor
+- lib/templates/example.yml.tt
 - lib/terminitor.rb
 - lib/terminitor/runner.rb
 - lib/terminitor/version.rb
@@ -136,7 +137,8 @@ has_rdoc: true
 homepage: http://rubygems.org/gems/terminitor
 licenses: []
 
-post_install_message: 
+post_install_message: "********************************************************************************\n\n    Terminitor is installed! \n    Please run 'terminitor setup'. \n    This will create a directory at ~/.terminitor which will hold all your global scripts.\n    Thanks!\n\n\
+  ********************************************************************************\n  "
 rdoc_options: []
 
 require_paths: