work-on 0.0.2 → 0.1.0

data/README.rdoc

@@ -1,18 +1,39 @@
 = work-on
 
-Description goes here.
-
-== Contributing to work-on
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
+A utility to manage your projects and make working on them as seemless as possible.
+Basically you edit a small yaml file where you specify your project directory and the terminal windows and tabs
+you want to open.
+
+= Example
+
+this is the actual config file i use for work-on:
+
+  work-on:
+    project-dir: ~/Projects/work-on
+    tab1:
+      - git status
+    tab2:
+      - mvim
+
+this opens 2 new tabs and executes above commands
+you can also open new windows
+
+  work-on:
+    project-dir: ~/Projects/work-on
+    window1:
+      tab1:
+        - ls
+      tab2:
+        - git status
+    window2:
+      tab1:
+        - mvim
+
+You can guess what the above would do.
+
+NOTE: At the moment only Mac OS X is supported, but support for linux is coming real soon.
+
+= Copyright
 
 Copyright (c) 2011 Toon Willems. See LICENSE.txt for
 further details.

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.1.0

data/lib/work-on.rb

@@ -3,7 +3,7 @@ module WorkOn
   autoload :AbstractTerminal , 'work_on/terminal.rb'
   autoload :MacTerminal      , 'work_on/terminals/mac_terminal.rb'
   autoload :Config           , 'work_on/config.rb'
+  autoload :YAMLConfig       , 'work_on/config.rb'
   autoload :Project          , 'work_on/project.rb'
   autoload :Cli              , 'work_on/cli.rb'
-
 end

data/lib/work_on/cli.rb

@@ -5,7 +5,7 @@ module WorkOn
 
     desc "start PROJECT", "start working on the given project"
     def start(project_name)
-      Config.default[project_name].work!
+      Project.new(Config.new(project_name)).work!
     end
 
     # use method_missing to start the project

data/lib/work_on/config.rb

@@ -1,30 +1,93 @@
 require 'yaml'
+require 'abstract'
 
 module WorkOn
 
   class Config
 
-    def self.default
-      @default ||= Config.new(File.expand_path '~/.config/work_on')
+    def self.default_dir
+      File.expand_path '~/.config/work-on/'
     end
 
-    attr_reader :file_name
+    def initialize(project_name)
+      file_name = find_file(project_name)
+      raise "No config file found" unless file_name
+      @config = find_config(file_name)
+    end
+
+    def windows
+      @config.windows
+    end
+
+    def project_dir
+      @config.project_dir
+    end
+
+    private
+
+    def find_config(file_name)
+      case File.extname(file_name)
+      when ".rb", ""
+        DSLConfig.new(file_name)
+      when ".yml", ".yaml"
+        YAMLConfig.new(file_name)
+      else
+        raise "Don't know how to parse #{file_name}"
+      end
+    end
+
+    def find_file(name)
+      base_name = File.join(self.class.default_dir, name)
+      files = Dir.glob(base_name + '.*')
+      # pick the first one
+      files.first
+    end
+
+  end
+
+  class ConfigParser
+
+    # windows is an hash which looks like this
+    # {:tabs => [['ls -al', 'ls'], ['ls']]}
+    # the above hash would open 2 tabs
+    #
+    # if additional windows need to be opened
+    # you can specify the windows key (and provide and array of tab
+    #   hashes)
+    # {:windows => {[{:tabs => []}, {:tabs =>[]}]}}
+    attr_accessor :windows
+
+    # should be set to the complete and expanded path to the project
+    attr_reader :project_dir
 
     def initialize(file_name)
-      self.file_name = file_name
+      @windows = {}
+      parse(file_name)
     end
 
-    def file_name=(file_name)
-      @file_name = file_name
-      @hash = YAML.load_file file_name
+    # It does no harm to expand a path multiple times and prevents somebody from forgetting it
+    def project_dir=(dir)
+      @project_dir = File.expand_path(dir)
     end
 
-    def [](project)
-      config = @hash[project]
-      raise ArgumentError, "No config found for that project" unless config
-      Project.new project, config
+    # this method should read and parse the file
+    # will be called when initialized
+    # implementations should set @windows and @project_dir
+    def parse(file_name)
+      not_implemented
     end
+  end
 
+  class YAMLConfig < ConfigParser
+    def parse(file_name)
+      hash = YAML.load_file(file_name)
+      self.project_dir = hash['project-dir']
+
+      windows = hash.select {|k,v| /window/ === k}
+      tabs = hash.select {|k,v| /tab/ === k}
+      self.windows[:tabs] = tabs.values
+      self.windows[:windows] = windows.values.map {|hash| {:tabs => hash.values}}
+    end
   end
 
 end

data/lib/work_on/project.rb

@@ -2,13 +2,15 @@ module WorkOn
 
   class Project
 
-    def initialize(name, config)
-      @name = name
+    def initialize(config)
       @config = config
-      @project_dir = @config['project-dir']
       @terminal = Terminal.instance
     end
 
+    def project_dir
+      @config.project_dir
+    end
+
     # Start working on this project
     def work!
       initialize_windows
@@ -18,16 +20,13 @@ module WorkOn
 
     # Sets up the terminal according the config file
     def initialize_windows
-      windows = @config.select {|k,v| /window/ === k }
-      # if there is no window specified, i will assume the users wants to open the tabs in the current
-      # terminal window
-      if windows.empty?
-        tabs = @config.select {|k,v| /tab/ === k }
-        create_tabs(@terminal.selected_window, tabs, false)
-      else
-        windows.each do |window, tabs_hash|
-          create_window(tabs_hash)
-        end
+      # first create the tabs
+      tabs = @config.windows[:tabs]
+      create_tabs(@terminal.selected_window, tabs, false)
+
+      # then the windows
+      @config.windows[:windows].each do |tabs_hash|
+        create_window(tabs_hash[:tabs])
       end
     end
 
@@ -37,10 +36,10 @@ module WorkOn
       create_tabs(window, tabs)
     end
 
-    def create_tabs(window, hash, use_current = true)
+    def create_tabs(window, array, use_current = true)
       # create as many tabs as needed
       # if use_current is true, create one less and use the current one
-      count = hash.keys.size
+      count = array.size
       if use_current
         count -= 1
         first_tab = window.selected_tab
@@ -48,8 +47,8 @@ module WorkOn
       tabs = count.times.map { window.new_tab }
       tabs.unshift first_tab if use_current
 
-      hash.values.each.with_index do |commands, i|
-        tabs[i].execute "cd #{@project_dir}"
+      array.each.with_index do |commands, i|
+        tabs[i].execute "cd #{project_dir}"
         commands.each do |command|
           tabs[i].execute(command)
         end

data/test/core/config_test.rb

@@ -1,17 +1,50 @@
 require 'teststrap'
 require 'yaml' # otherwise mock fails
 
-context "Config" do
+context "YAMLConfig" do
+  helper(:basic_config) do
+    {"project-dir"=>"~/Projects/work-on", "window1"=>{"tab1"=>["rails server"], "tab2"=>["rails console"], "tab3"=>["git status", "mvim"]}}
+  end
   setup do
-    mock(YAML).load_file("test_name") do
-      {'test' => {'project-dir' => 'test-dir'}}
-    end
-    WorkOn::Config.new("test_name")
+    mock(YAML).load_file("test_name.yml") { basic_config }
+    WorkOn::YAMLConfig.new("test_name.yml")
+  end
+
+  asserts(:project_dir).equals(Dir.home + "/Projects/work-on")
+
+  context "windows hash" do
+    setup { topic.windows[:windows] }
+    asserts(:first).equals({:tabs => [['rails server'], ['rails console'], ['git status', 'mvim']]})
   end
 
-  denies(:[], 'test').nil
-  asserts_topic.assigns(:file_name)
+  context 'with multiple windows' do
+    helper(:complex_config) do
+      {"project-dir"=>"~/Projects/work-on",
+        "window1"=>{"tab1"=>["rails server"], "tab2"=>["rails console"], "tab3"=>["git status", "mvim"]},
+        "window2"=>{"tab1"=>["rails server"], "tab2"=>["rails console"], "tab3"=>["git status", "mvim"]},
+        "tab1"=>["rails server"], "tab2"=>["rails console"], "tab3"=>["git status", "mvim"]
+      }
+    end
+    setup do
+      mock(YAML).load_file("test_name.yml") { complex_config }
+      WorkOn::YAMLConfig.new("test_name.yml")
+    end
+
+    asserts(:project_dir).equals(Dir.home + "/Projects/work-on")
 
-  asserts(:[], 'blah').raises(ArgumentError)
+    context "window hash" do
+      setup { topic.windows[:windows] }
 
+      asserts(:first).equals({:tabs => [['rails server'], ['rails console'], ['git status', 'mvim']]})
+      asserts("both windows have the same config") { topic.first == topic.last }
+
+    end
+
+    context "tab hash" do
+      setup { topic.windows[:tabs] }
+
+      asserts_topic.equals([['rails server'], ['rails console'], ['git status', 'mvim']])
+    end
+
+  end
 end

data/test/core/project_test.rb

@@ -1,12 +1,17 @@
+require 'yaml'
+
 context "Project" do
-  helper(:config_hash) do
-    {'project-dir' => '~/test',
-     'tab1' => [],
-     'tab2' => []
-    }
+  helper(:config) do
+    mock(YAML).load_file('test.yml') do
+      {'project-dir' => '~/test',
+       'tab1' => [],
+       'tab2' => []
+      }
+    end
+    WorkOn::YAMLConfig.new('test.yml')
   end
 
-  setup { WorkOn::Project.new 'test', config_hash }
+  setup { WorkOn::Project.new config }
 
   hookup do
     terminal = stub(WorkOn::Terminal.instance)
@@ -15,6 +20,6 @@ context "Project" do
     topic.work!
   end
 
-  asserts_topic.assigns(:project_dir, '~/test')
+  asserts(:project_dir).equals(Dir.home + '/test')
 
 end

data/work-on.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{work-on}
-  s.version = "0.0.2"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Toon Willems}]
-  s.date = %q{2011-09-19}
+  s.date = %q{2011-09-20}
   s.description = %q{utility to manage projects and the terminal windows you open when you work on them.}
   s.email = %q{willemstoon@gmail.com}
   s.executables = [%q{work-on}]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: work-on
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-19 00:00:00.000000000Z
+date: 2011-09-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: abstract
-  requirement: &70327813960780 !ruby/object:Gem::Requirement
+  requirement: &70198776254500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70327813960780
+  version_requirements: *70198776254500
 - !ruby/object:Gem::Dependency
   name: rb-appscript
-  requirement: &70327813960020 !ruby/object:Gem::Requirement
+  requirement: &70198776252800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70327813960020
+  version_requirements: *70198776252800
 - !ruby/object:Gem::Dependency
   name: riot
-  requirement: &70327813959420 !ruby/object:Gem::Requirement
+  requirement: &70198776251720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70327813959420
+  version_requirements: *70198776251720
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70327813958520 !ruby/object:Gem::Requirement
+  requirement: &70198776234500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70327813958520
+  version_requirements: *70198776234500
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70327813957680 !ruby/object:Gem::Requirement
+  requirement: &70198776233260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70327813957680
+  version_requirements: *70198776233260
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70327813956380 !ruby/object:Gem::Requirement
+  requirement: &70198776231900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70327813956380
+  version_requirements: *70198776231900
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70327813955680 !ruby/object:Gem::Requirement
+  requirement: &70198776230820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70327813955680
+  version_requirements: *70198776230820
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &70327813954700 !ruby/object:Gem::Requirement
+  requirement: &70198776229620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70327813954700
+  version_requirements: *70198776229620
 description: utility to manage projects and the terminal windows you open when you
   work on them.
 email: willemstoon@gmail.com
@@ -143,7 +143,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3114304915361326102
+      hash: -4148861926533244809
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: