ruby-screen 0.9.0

data/History.txt

@@ -0,0 +1,3 @@
+== 0.0.9 2008-06-04
+
+* Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008
+
+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 OR COPYRIGHT HOLDERS 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/Manifest.txt

@@ -0,0 +1,44 @@
+History.txt
+License.txt
+Manifest.txt
+README.textile
+README.txt
+Rakefile
+bin/ruby-screen
+config/hoe.rb
+config/requirements.rb
+lib/ruby_screen.rb
+lib/ruby_screen/version.rb
+lib/ruby_screen/preferences_loader.rb
+lib/ruby_screen/executer.rb
+lib/ruby_screen/configuration/description.rb
+lib/ruby_screen/configuration/generator.rb
+lib/ruby_screen/configuration/parser.rb
+lib/ruby_screen/configuration/parser/block_processor.rb
+lib/ruby_screen/configuration/parser/nesting_hash.rb
+lib/ruby_screen/configuration/parser/iterator.rb
+log/debug.log
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+spec/ruby_screen_spec.rb
+spec/preferences_loader_spec.rb
+spec/executer_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+spec/configuration/description_spec.rb
+spec/configuration/parser_spec.rb
+spec/configuration/generator_spec.rb
+spec/configuration/parser/block_processor_spec.rb
+spec/configuration/parser/iterator_spec.rb
+spec/configuration/parser/nesting_hash_spec.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/rspec.rake
+tasks/website.rake
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.textile

@@ -0,0 +1,226 @@
+h1. RubyScreen
+
+RubyScreen is a utility for managing and launching GNU Screen configurations.  Though written in Ruby and requiring a valid Ruby installation, it should be useful for a developer in any language.  If you often find yourself opening up the same multiple windows and running various commands, or juggling multiple similar Screen configurations with various window setups, this may help.
+
+Usage is best described through a few examples, which are followed by detailed information on the available elements in the configuration file.
+
+h2. Installation
+
+RubyScreen is packaged as a Ruby Gem, and requires a valid installation of Ruby along with the RubyGems package manager.  Rather than document that process, you're likely to find more helpful instructions for installing those two components "here":http://www.rubyonrails.org/down at the Ruby on Rails installation page.
+
+Once you have gems, you're just a command away:
+
+        gem install ruby-screen
+
+On non-Windows systems, you may need to use *sudo* to elevate you privileges.
+
+To verify installation, try *ruby-screen* at your command prompt.  You should see a helpful message about your lack of configuration file.  You can build your own configuration file after reading the documentation below.
+
+h2. Examples
+
+RubyScreen consists of a "YAML":http://www.yaml.org/ configuration file and a command line utility.  The configuration file must be located in your home directory and named _.ruby-screen.yml_.  The simplest example:
+
+<pre><code>
+startup_message: off
+defscrollback: 5000
+</pre></code>
+
+The command for launching RubyScreen is *ruby-screen*.  It will load your YAML configuration file and launch Screen with the appropriate options.  With the configuration file above, you'll have no splash screen and a 5000 line scroll buffer.  Not exactly revolutionary.
+
+Let's say you're a web developer working on a cool new project.  You're using your favorite text editor, watching some logs, keeping a window open for miscellaneous tasks.  Your configuration file would look something like this:
+
+<pre><code>
+startup_message: off
+defscrollback: 5000
+
+cool_site:
+  working_directory: ~/web_projects/cool_site
+  windows:
+    -
+      title: Editor
+      command: vim .
+    -
+      title: Misc
+    -
+      title: Logs
+      number: 9
+      command: tail -f /var/log/web_server.log
+</pre></code>
+
+Now you still have your generic configuration, along with an additional configuration for your cool project.  Running *ruby-screen cool_site* will move into your projects' directory and start a text editor, a window with a fresh command line, and a window tailing your server log.  The first two windows take whatever number Screen assigns to them (0 and 1 in this case), while the log window will always be assigned to number 9.
+
+That's great, but you are working on more than just that one cool project.  You have multiple sites located in <notextile>~</notextile>_/web_projects_, and they all have they all have similar needs: an editor, a terminal, and a log viewer.
+
+<pre><code>
+startup_message: off
+defscrollback: 5000
+
+web_work:
+  working_directory: ~/web_projects
+  windows:
+    -
+      title: Editor
+      command: vim .
+    -
+      title: Misc
+    -
+      title: Logs
+      number: 9
+      command: tail -f /var/log/web_server.log
+</pre></code>
+
+This configuration is identical to the last, except that it is a bit more generic.  The configuration named _cool_site_ is now _web_work_, and the *working_directory* now points to your generic projects directory.  When you use the *ruby-screen* command line utility, the first argument is usually going to refer to the name of one of your nested configurations, with any additional arguments being tacked on as directories relative to the *working_directory* specified in that configuration.
+
+If you had a couple of web projects you are working on, like <notextile>~</notextile>_/web_projects/cool_project_, or <notextile>~</notextile>_/web_projects/legacy_work_, those specific projects can be launched using the generic _web_work_ configuration by typing *ruby-screen web_work cool_project* and *ruby-screen web_work legacy_work* respectively.  Any new projects added to <notextile>~</notextile>_/web_projects_ can be launched by name through the *web_work* configuration.
+
+Finally, let's return to your cool site.  You have added some fancy new chat functionality to it, but that requires the chat server to be running during every development session.  Aside from the chat server, it's the same as all of your other web projects.
+
+<pre><code>
+startup_message: off
+defscrollback: 5000
+
+web_work:
+  working_directory: ~/web_projects
+  windows:
+    -
+      title: Editor
+      command: vim .
+    -
+      title: Misc
+    -
+      title: Logs
+      number: 9
+      command: tail -f /var/log/web_server.log
+
+  cool_site:
+    relative_directory: cool_site
+    windows:
+      -
+        title: Chat Server
+        command: /bin/my_awesome_chat_server
+</pre></code>
+
+You've added on to the previous example and added a nested configuration, called _cool_site_.  It's under _web_work_, and inherits all the Customizations and Windows defined above it, while defining a new window that will launch your chat server.  This nested configuration can be launched from the command line with *ruby-screen cool_site*.
+
+h2. The Configuration File
+
+RubyScreen looks for a file in your home directory named *.ruby-screen.yml*.  It must be a valid YAML file.  It can contain multiple elements that will be translated into a Screen-compatible plain text configuration file, depending on the command line arguments that are passed in when RubyScreen is launched.
+
+h3. Customizations
+
+The simplest element, customizations consist of simple key/value pairs.  Valid customizations can be found in the "Customization" section of the Screen manpage.
+
+<pre><code>
+startup_message: off
+defscrollback: 5000
+</pre></code>
+
+This will result in a Screen configuration without the welcoming splash page, with a 5000 line scroll buffer.
+
+(YAML veterans may wonder that the 'off' value need not be quoted.  Pay no attention to the man behind the curtain.  It just doesn't.)
+
+h3. Windows
+
+Windows in Screen are somewhat analogous to tabs in a browser.  You can use window definitions to specify the windows you want open at launch.  You can optionally title and number them, as well as giving them an initial command to execute at launch.
+
+<pre><code>
+windows:
+  -
+    title: Miscellaneous
+  -
+    number: 0
+    title: First Window
+  -
+    number: 1
+    title: Processes
+    command: top
+</pre></code>
+
+This would result in 3 windows at launch.  Window 0 would be named _First Window_ with a fresh command prompt, window 1 would be named _Processes_ and would be running the _top_ command.  A third window, named _Miscellaneous_ would have a fresh command prompt, and be assigned to the first available number by Screen.
+
+The *title*, *number*, and *command* definitions are all optional, though you must supply one.   The value of the *command* is executed by Screen on launch, as-is.  If you decide that _rm -FR_ is your command, it's not going to stop you.
+
+h3. Nested Configurations
+
+A nested configuration can be called by name from the ruby-screen command line utility.  They can contain the same elements as a top-level configuration.
+
+<pre><code>
+startup_message: off
+defscrollback: 5000
+
+generic:
+  windows:
+    -
+      title: Miscellaneous
+    -
+      number: 1
+      title: Other Window
+
+  specific:
+    defscrollback: 1000
+    windows:
+      -
+        number: 1
+        title: Nested Window
+</pre></code>
+
+Nested configuration names are passed as the first argument to the *ruby-screen* command line utility.  When this happens, the programs processes the configuration from the highest level down through the hierarchy to the configuration you specified, merging customizations and windows as it goes.  Any customization keys or numbered windows that are duplicated deeper in the hierarchy will override those above them.  
+
+Calling the nested configuration named _specific_ above would use the Windows and Customizations specified in the top level and _generic_ configurations, but would override the number of lines of scroll buffer and the name of Window 1.
+
+There is no limit on how far you can nest, apart from your own sanity.
+
+h3. Paths
+
+Use *working_directory* and *relative_directory* in instances where you will always want a certain configuration to launch with a specific working directory.  This is the equivalent to manually traversing to the intended directory before launching the Screen command.
+
+<pre><code>
+startup_message: off
+
+web_server_edit:
+  working_directory: /usr/local/my_web_server
+  windows:
+    -
+      name: Config
+      command: vim conf/my_web_server.conf
+    -
+      name: Log
+      command: tail -f server.log
+</pre></code>
+
+When running the *web_server_edit* configuration above, the commands will be executed in _/usr/local/my_web_server_.  Any new windows you open within Screen will also default to that directory.
+
+The working directory can also begin with a tilde character to indicate your home directory.  _~/projects_ on a Linux system would translate to _/home/your_username/projects_.  It is suggested that you use the tilde or a full path for your *working_directory* settings, so that RubyScreen can work as intended no matter where it is called from.
+
+The *relative_directory* setting can be used in nested configurations and will be appended to the end of the current working directory.
+
+h3.  Misc
+
+Before your configuration file is loaded by the YAML library it is processed by ERB, a Ruby templating system.  Information on its syntax is available "here":http://www.ruby-doc.org/stdlib/libdoc/erb/rdoc/.  Any Ruby can be executed inside of ERB, so review any configuration files before executing.
+
+h2. Thanks
+
+Thanks to the author of "this":http://mikeburnscoder.wordpress.com/2007/06/21/my-rails-development-environment-version-1-vim-and-screen/ blog posting, which got the ball rolling for me on launching Screen with predefined windows and commands.
+
+h2. License
+
+Copyright (c) 2008
+
+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 OR COPYRIGHT HOLDERS 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.txt

@@ -0,0 +1 @@
+The documentation is in Readme.textile, but you're better off reading it here: http://github.com/dpetersen/ruby-screen/tree/master

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/bin/ruby-screen

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) + '/../lib/ruby_screen'
+
+RubyScreen.process ARGV
+
+# vim: syntax=Ruby

data/config/hoe.rb

@@ -0,0 +1,71 @@
+require 'ruby_screen/version'
+
+AUTHOR = 'Don Petersen'  # can also be an array of Authors
+EMAIL = "don@donpetersen.net"
+DESCRIPTION = "Ruby command line utility to manage GNU Screen configurations, and launch Screen using those configuration."
+GEM_NAME = 'ruby-screen' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'ruby-screen' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "dpetersen"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = RubyScreen::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'ruby_screen documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+#hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.remote_rdoc_dir = '' # Release to root
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'ruby_screen'

data/lib/ruby_screen.rb

@@ -0,0 +1,14 @@
+$:.unshift File.dirname(__FILE__)
+require 'ruby_screen/preferences_loader'
+require 'ruby_screen/executer'
+require 'ruby_screen/configuration/description'
+require 'ruby_screen/configuration/parser'
+require 'ruby_screen/configuration/generator'
+
+module RubyScreen
+  def self.process(arguments)
+    preferences_hash = PreferencesLoader.load
+    description = Configuration::Parser.parse(arguments, preferences_hash)
+    Executer.new(description)
+  end
+end

data/lib/ruby_screen/configuration/description.rb

@@ -0,0 +1,60 @@
+module RubyScreen::Configuration
+  class Description
+    attr_reader :customizations, :numbered_windows, :numberless_windows, :working_directory
+
+    def initialize
+      @customizations = {}
+      @numberless_windows = []
+      @numbered_windows = {}
+    end
+
+    def working_directory=(directory)
+      @working_directory ||= ""
+      process_directory(directory)
+    end
+
+    def append_directory(directory)
+      process_directory(directory, @working_directory)
+    end
+
+    def add_customization(key, value)
+      @customizations.store(key, value)
+    end
+
+    def add_window(options)
+      options.include?("number") ? add_numbered_window(options) : add_numberless_window(options)
+    end
+
+    def to_screen_configuration
+      Generator.new(self).to_screen_configuration
+    end
+
+    protected
+
+    def process_directory(directory, append = false)
+      @working_directory =
+        if directory[0].chr == "~"
+          File.expand_path(directory)
+        elsif append
+          @working_directory + "/" + strip_slashes(directory)
+        else
+          directory
+        end
+    end
+
+    def strip_slashes(s)
+      s.gsub!(/^\//, "")
+      s.gsub!(/\/$/, "")
+      s
+    end
+
+    def add_numberless_window(options)
+      @numberless_windows << options
+    end
+
+    def add_numbered_window(options)
+      number = options.delete("number")
+      @numbered_windows[number] = options
+    end
+  end
+end