paulcoyle-termsaver 0.1.2

data/COPYING

@@ -0,0 +1,18 @@
+Copyright (c) 2009 Paul Coyle
+ 
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+  
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+   
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,52 @@
+TermSaver
+=========
+TermSaver is just a simple library built around the Appscript library to
+automate saving the geometry of Mac OS' Terminal.app windows and provide a way
+to rebuild them and provide them with initial commands on their creation.
+
+Usage
+-----
+Arrange your terminal windows however you like.  Use the `save` command to
+generate a file with the saved window states.
+
+    termsaver -s saved_state.yml
+
+or
+
+    termsaver --save saved_state.yml
+
+You can then edit this file and enter shell commands in the "command" property
+of each `State`.  These commands will be executed once the terminal windows are
+re-instated.
+
+Example:
+
+    --- 
+    - !ruby/object:TermSaver::State 
+      background_color: !ruby/object:TermSaver::Colour 
+        b: 53971
+        g: 65535
+        r: 48805
+      command: "echo 'Sugarnipples.'"
+      number_of_columns: 80
+      number_of_rows: 24
+      position: !ruby/object:TermSaver::Position 
+        x: -614
+        y: 17
+
+To load in your saved states, use the `load` command.
+
+    termsaver -l saved_state.yml
+
+or
+
+    termsaver --load saved_state.yml
+
+Notes & Limitations
+-------------------
+If you do not already have an instance of Terminal.app running, then it seems
+that an additional Terminal window will be opened.  Currently there is nothing
+to handle this.
+
+Currently, the only properties of windows being stored are: position, background
+colour, number of rows and number of columns.

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rake/testtask'
+
+task :default => :test
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Writes out the current Terminal.app window states to a file.'
+task :save, [:file_path] do |t, args|
+  args.with_defaults(:file_path => 'term_settings.yml')
+  TermSaver::save(args[:file_path])
+end
+
+desc 'Loads a windows states file created with the save task and build out the windows.'
+task :load, [:file_path] do |t, args|
+  args.with_defaults(:file_path => 'term_settings.yml')
+  TermSaver::load(args[:file_path])
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "termsaver"
+    s.summary = "Saves and restores the position, colour and runs inital commands on Mac OS X Terminal.app windows."
+    s.email = "paul@paulcoyle.com"
+    s.homepage = "http://github.com/paulcoyle/termsaver"
+    s.description = <<-EOF
+      TermSaver is just a simple library built around the Appscript library to
+      automate saving the geometry of Mac OS' Terminal.app windows and provide
+      a way to rebuild them and provide them with initial commands on their
+      creation.
+    EOF
+    s.authors = ["Paul Coyle"]
+    s.files = FileList["[A-Z]*", "{bin,lib,test}/**/*"]
+    s.add_dependency('activesupport', '>= 2.2.2')
+    s.add_dependency('rb-appscript', '>= 0.5.1')
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/TODO

@@ -0,0 +1,3 @@
+= TODO
+ - Support tabs.
+ - Serialize and restore foreground colours.

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 2
+:major: 0
+:minor: 1

data/bin/termsaver

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'termsaver'
+
+TermSaver::Application.run!(*ARGV)

data/lib/termsaver.rb

@@ -0,0 +1,3 @@
+require 'termsaver/application'
+require 'termsaver/options'
+require 'termsaver/types'

data/lib/termsaver/application.rb

@@ -0,0 +1,62 @@
+require 'rubygems'
+require 'appscript'
+
+class TermSaver
+  class Application
+    class << self
+      include Appscript
+      
+      def run!(*args)
+        options = TermSaver::Options.new(args)
+        unless options[:mode].nil?
+          self.send(options[:mode], options[:file_path])
+        else
+          raise StandardError.new('Must have a mode flag of either -s or -l to run.')
+        end
+      end
+
+      # Saves all the states from Terminal.app to the file_path provided.
+      def save(file_path)
+        @states = []
+        terminal = get_app
+        (1..terminal.windows.count).each { |window_id| @states << save_state(terminal.windows[window_id]) }
+        File.open(file_path, 'w') do |file|
+          YAML::dump(@states, file)
+        end
+      end
+
+      # Expects a path to a file that is a YAML serialization of State objects.
+      def load(file_path)
+        File.open(file_path) { |file| @states = YAML::load(file) }
+        terminal = get_app
+        @states.each { |state| load_state(state, terminal) }
+      end
+
+      # Saves the state of a window to a State object.
+      def save_state(window)
+        TermSaver::Type::State.new do |s|
+          s.position = TermSaver::Type::Position.new(*window.position.get)
+          s.background_color = TermSaver::Type::Colour.new(*window.background_color.get)
+          s.number_of_columns = window.number_of_columns.get
+          s.number_of_rows = window.number_of_rows.get
+        end
+      end
+
+      # Recreates the given state.
+      def load_state(state, terminal = nil)
+        terminal ||= get_app
+        terminal.do_script(state.command)
+        window = terminal.windows[1]
+        window.background_color.set(state.background_color.to_appscript_format)
+        window.position.set(state.position.to_appscript_format)
+        window.number_of_columns.set(state.number_of_columns)
+        window.number_of_rows.set(state.number_of_rows)
+      end
+
+      protected
+        def get_app
+          app('Terminal.app')
+        end
+    end
+  end
+end

data/lib/termsaver/options.rb

@@ -0,0 +1,27 @@
+require 'optparse'
+
+class TermSaver
+  class Options < Hash
+    def initialize(args)
+      super()
+      
+      self[:file_path] = 'termsaver_save.yml'
+      
+      opts = OptionParser.new do |opts|
+        opts.banner = "Usage: termsaver [options]"
+        
+        opts.on('-s', '--save [FILEPATH]', String, 'Save the Terminal.app window states to the file specified. (default: termsaver_save.yml)') do |save|
+          self[:mode] = :save
+          self[:file_path] = save unless save.nil?
+        end
+        
+        opts.on('-l', '--load [FILEPATH]', String, 'Loads saved windows states from the file specified. (default: termsaver_save.yml)') do |load|
+          self[:mode] = :load
+          self[:file_path] = load unless load.nil?
+        end
+      end
+      
+      opts.parse!(args)
+    end
+  end
+end

data/lib/termsaver/types.rb

@@ -0,0 +1,37 @@
+class TermSaver
+  class Type
+    class State
+      attr_accessor :position, :background_color, :number_of_columns,
+                    :number_of_rows, :command
+  
+      def initialize
+        self.command = ''
+        yield self if block_given?
+      end
+    end
+
+    class Position
+      attr_accessor :x, :y
+  
+      def initialize(x = 0, y = 0)
+        self.x, self.y = x, y
+      end
+    
+      def to_appscript_format
+        [self.x, self.y]
+      end
+    end
+  
+    class Colour
+      attr_accessor :r, :g, :b
+    
+      def initialize(r = 0, g = 0, b = 0)
+        self.r, self.g, self.b = r, g, b
+      end
+    
+      def to_appscript_format
+        [self.r, self.g, self.b]
+      end
+    end
+  end
+end

data/test/colour_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class ColourTest < Test::Unit::TestCase
+  def test_appscript_formatted_attributes
+    colour = TermSaver::Type::Colour.new(1, 2, 3)
+    assert_equal [1, 2, 3], colour.to_appscript_format
+  end
+end

data/test/position_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class PositionTest < Test::Unit::TestCase
+  def test_appscript_formatted_attributes
+    position = TermSaver::Type::Position.new(123, 456)
+    assert_equal [123, 456], position.to_appscript_format
+  end
+end

data/test/state_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class StateTest < Test::Unit::TestCase
+  def test_default_command_is_empty_string
+    assert_equal '', TermSaver::Type::State.new.command
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+require 'termsaver'
+require 'test/unit'

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: paulcoyle-termsaver
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Paul Coyle
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-09 00:00:00 -07:00
+default_executable: termsaver
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.2.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rb-appscript
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.1
+    version: 
+description: TermSaver is just a simple library built around the Appscript library to automate saving the geometry of Mac OS' Terminal.app windows and provide a way to rebuild them and provide them with initial commands on their creation.
+email: paul@paulcoyle.com
+executables: 
+- termsaver
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- COPYING
+- Rakefile
+- README.markdown
+- TODO
+- VERSION.yml
+- bin/termsaver
+- lib/termsaver
+- lib/termsaver/application.rb
+- lib/termsaver/options.rb
+- lib/termsaver/types.rb
+- lib/termsaver.rb
+- test/colour_test.rb
+- test/position_test.rb
+- test/state_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/paulcoyle/termsaver
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Saves and restores the position, colour and runs inital commands on Mac OS X Terminal.app windows.
+test_files: []
+