scide 0.0.12 → 0.1.0

data/.rspec

@@ -1,2 +1 @@
 --color
---format doc

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3

data/.screenrc

@@ -0,0 +1,8 @@
+source $HOME/.screenrc
+
+screen -t vim 0
+stuff "\${PROJECT_EDITOR-\$EDITOR}\012"
+screen -t zsh 1
+screen -t spec 2
+stuff "rake"
+select vim

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
 rvm:
-  - 1.8.7
   - 1.9.2
   - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -3,22 +3,21 @@ source "http://rubygems.org"
 # Example:
 #   gem "activesupport", ">= 2.3.5"
 
-gem 'upoj-rb', '~> 0.0.4'
+gem 'commander', '~> 4.1.3'
+gem 'paint', '~> 0.8.6'
 gem 'which_works', '~> 0.1.0'
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem 'rspec'
-  gem 'shoulda'
   gem 'bundler'
-  gem 'jeweler', '~> 1.6.4'
+  gem 'rake'
+  gem 'rspec'
+  gem 'fakefs', require: 'fakefs/safe', git: 'git@github.com:AlphaHydrae/fakefs.git', branch: 'executable-bug'
+  gem 'jeweler'
+  gem 'gemcutter'
+  gem 'gem-release'
+  gem 'rake-version'
   gem 'simplecov'
-  gem 'yard'
-  gem 'rdiscount'
-  gem 'travis-lint', '~> 1.3.0'
-end
-
-group :test do
-  gem 'active_support', '>= 2'
+  gem 'travis-lint'
 end

data/Gemfile.lock

@@ -1,57 +1,64 @@
+GIT
+  remote: git@github.com:AlphaHydrae/fakefs.git
+  revision: f4814af1ce3970b4b7eba383717c0e10dec7b5e8
+  branch: executable-bug
+  specs:
+    fakefs (0.4.2)
+
 GEM
   remote: http://rubygems.org/
   specs:
-    active_support (3.0.0)
-      activesupport (= 3.0.0)
-    activesupport (3.0.0)
-    diff-lcs (1.1.3)
+    commander (4.1.3)
+      highline (~> 1.6.11)
+    diff-lcs (1.2.4)
+    gem-release (0.5.5)
+    gemcutter (0.7.1)
     git (1.2.5)
-    hashr (0.0.19)
-    jeweler (1.6.4)
+    hashr (0.0.22)
+    highline (1.6.18)
+    jeweler (1.8.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    multi_json (1.1.0)
-    paint (0.8.4)
-    rake (0.9.2.2)
-    rdiscount (1.6.8)
-    rspec (2.8.0)
-      rspec-core (~> 2.8.0)
-      rspec-expectations (~> 2.8.0)
-      rspec-mocks (~> 2.8.0)
-    rspec-core (2.8.0)
-    rspec-expectations (2.8.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.8.0)
-    shoulda (3.0.1)
-      shoulda-context (~> 1.0.0)
-      shoulda-matchers (~> 1.0.0)
-    shoulda-context (1.0.0)
-    shoulda-matchers (1.0.0)
-    simplecov (0.6.1)
+      rdoc
+    json (1.7.7)
+    multi_json (1.7.2)
+    paint (0.8.6)
+    rake (10.0.4)
+    rake-version (0.3.1)
+      rake (~> 10)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    simplecov (0.7.1)
       multi_json (~> 1.0)
-      simplecov-html (~> 0.5.3)
-    simplecov-html (0.5.3)
-    travis-lint (1.3.0)
-      hashr (>= 0.0.19)
-    upoj-rb (0.0.5)
-      active_support (>= 2)
-      paint
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    travis-lint (1.7.0)
+      hashr (~> 0.0.22)
     which_works (0.1.0)
-    yard (0.7.5)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  active_support (>= 2)
   bundler
-  jeweler (~> 1.6.4)
-  rdiscount
+  commander (~> 4.1.3)
+  fakefs!
+  gem-release
+  gemcutter
+  jeweler
+  paint (~> 0.8.6)
+  rake
+  rake-version
   rspec
-  shoulda
   simplecov
-  travis-lint (~> 1.3.0)
-  upoj-rb (~> 0.0.4)
+  travis-lint
   which_works (~> 0.1.0)
-  yard

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011 AlphaHydrae
+Copyright (c) 2011 Simon Oulevay (AlphaHydrae)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,171 +1,63 @@
-# scide
+# scide [![Build Status](https://secure.travis-ci.org/AlphaHydrae/scide.png?branch=develop)](http://travis-ci.org/AlphaHydrae/scide)
 
-GNU Screen IDE.
+**[GNU Screen](http://www.gnu.org/software/screen/) IDE.**
 
-The purpose of this tool is to generate several GNU screen configurations from a single YAML configuration file.
-This can be used to easily setup a multi-windows development environment with screen.
+The `scide` command wraps `screen` to automatically use `.screenrc` files in the current directory or in project directories.
 
-Tested with <a href="https://www.relishapp.com/rspec">RSpec</a>, <a href="https://github.com/thoughtbot/shoulda">shoulda</a> and <a href="http://travis-ci.org/#!/AlphaHydrae/scide">Travis CI</a>.
-
-* master [![Build Status](https://secure.travis-ci.org/AlphaHydrae/scide.png?branch=master)](http://travis-ci.org/AlphaHydrae/scide)
-* develop [![Build Status](https://secure.travis-ci.org/AlphaHydrae/scide.png?branch=develop)](http://travis-ci.org/AlphaHydrae/scide)
-
-## Using
-
-You can install scide with:
+## Installation
 
     gem install scide
 
-Then use it on the command line:
-
-    scide --version
-    scide my_project
-
-__Interactive configuration will be introduced in v0.2.*.__
-__Until then, the configuration file must be prepared manually before using scide.__
-
-## Configuration File
-
-The configuration file is expected to be at the following location by default:
-
-    $HOME/.scide/config.yml
-
-You can load another file by running scide with the `-c` flag:
-
-    scide -c my_config.yml
-
-### Basics
-
-This is a simple scide configuration file:
-
-    projects:
-      mywebsite:
-        path: /home/jdoe/projects/mywebsite
-        windows:
-          - 'project EDIT'
-          - 'db-log TAIL log/db.log'
-          - 'server RUN rails server'
-          - 'shell'
-        default_window: project
-
-By running `scide mywebsite`, screen would open with four windows:
-
-* a __project__ window with your favorite `$EDITOR` launched;
-* a __db-log__ window with a tail of the project's database log;
-* a __server__ window with your Ruby on Rails server launched;
-* a __shell__ window with your shell running.
-
-The __project__ window would be opened as specified by the
-`default_window` option.
-
-The format for a window is `NAME [COMMAND] [CONTENTS]`.
-This opens a window with the given name. An optional command
-can be run in the window, which can receive arguments/contents.
-
-### Options
-
-Projects can have a hash of options that commands can use:
-
-    projects:
-      mywebsite:
-        path: /home/jdoe/projects/mywebsite
-        options:
-          log_dir: /var/log
-          server: thin
-        windows:
-          - 'project EDIT'
-          - 'db-log TAIL %{log_dir}/db.log'
-          - 'app-log TAIL %{log_dir}/development.log'
-          - 'server RUN %{server} start'
-          - 'shell'
-
-### Globals
-
-You can configure a base path and options for all projects.
-
-    global:
-      path: /home/jdoe/projects
-      options:
-        log_dir: /var/log
-    projects:
-      mywebsite:
-        path: mywebsite # this is now relative to the global path
-        options:
-          server: thin
-        windows:
-          - 'project EDIT'
-          - 'db-log TAIL %{log_dir}/db.log'
-          - 'app-log TAIL %{log_dir}/development.log'
-          - 'server RUN %{server} start'
-          - 'shell'
-
-Options at the project level override global options if they have the same name.
-
-### Commands
-
-Scide currently provides four commands.
-
-#### RUN
+## Usage
 
-Runs the given contents in the window.
+Assuming your project screen configuration is in `~/src/my-project/.screenrc`.
 
-For example, `RUN rails server` launches a Ruby on Rails server in the project folder.
+    cd ~/src/my-project
+    scide
 
-#### EDIT
+With the **-p, --projects PROJECTS_DIR** option, `scide` will know your project directory so you can open from elsewhere.
 
-Simply runs `$EDITOR`, your preferred editor.
+    cd /elsewhere
+    scide -p ~/src my-project
 
-If the `edit` option is present, it will be used as arguments to the editor.
+You can also set the `$SCIDE_PROJECTS` environment variable:
 
-    # project configuration:
-    mywebsite:
-      options:
-        edit: '-c MyVimCommand'
-      windows:
-        - 'project EDIT app/controllers/application_controller.erb'
+    export SCIDE_PROJECTS=~/src
+    scide my-project
 
-    # resulting command in "project" window:
-    $EDITOR -c MyVimCommand app/controllers/application_controller.erb
+### Without a .screenrc file
 
-#### TAIL
+If you don't already have a .screenrc configuration file, `scide` can open your project with a default configuration.
 
-Runs the `tail` command with the given file as the `-f` argument.
+    cd ~/other-project
+    scide --auto
 
-For example, `TAIL log/db.log` would generate the following command:
+This will open `screen` with two named windows:
 
-    tail -f log/db.log
+* **editor** will launch your favorite editor (`$PROJECT_EDITOR` or `$EDITOR`);
+* **shell** will launch a new shell.
 
-If the `tail` option is present, it will be used as arguments to tail.
+### Add a .screenrc file
 
-    # project configuration:
-    mywebsite:
-      options:
-        tail: '-n 1000'
-      windows:
-        - 'db.log TAIL log/db.log'
+To add a .screenrc file to your project:
 
-    # resulting command in "project" window:
-    tail -n 1000 -f log/db.log
+    cd ~/other-project
+    scide setup
+    cat .screenrc
 
-#### SHOW
+## Screen options
 
-Shows the given contents in the window, without running them.
+* **-b BIN, --bin BIN**
 
-For example, `SHOW ssh example.com` would pre-type this ssh command in the window, but not run it.
-That way, you can have special commands ready to run in a separate window.
+  Use the bin option to give the path to your screen binary if it's not in the PATH or has a different name.
+  This can also be set with the `$SCIDE_BIN` environment variable.
 
-## Contributing to scide
- 
-* 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.
+* **-s OPTIONS, --screen OPTIONS**
 
-## Copyright
+  Customize screen options (`-U` by default).
+  This can also be set with the `$SCIDE_SCREEN` environment variable.
 
-Copyright (c) 2011 AlphaHydrae. See LICENSE.txt for
-further details.
+## Meta
 
+* **Author:** Simon Oulevay (Alpha Hydrae)
+* **License:** MIT (see [LICENSE.txt](https://raw.github.com/AlphaHydrae/scide/master/LICENSE.txt))

data/Rakefile

@@ -17,14 +17,30 @@ Jeweler::Tasks.new do |gem|
   gem.name = "scide"
   gem.homepage = "http://github.com/AlphaHydrae/scide"
   gem.license = "MIT"
-  gem.summary = %Q{GNU Screen IDE.}
-  gem.description = %Q{Utility to generate GNU screen configuration files.}
+  gem.summary = %Q{GNU Screen IDE}
+  gem.description = %Q{GNU screen wrapper to open projects with a .screenrc file.}
   gem.email = "hydrae.alpha@gmail.com"
-  gem.authors = ["AlphaHydrae"]
+  gem.authors = ["Simon Oulevay (AlphaHydrae)"]
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new
 
+Rake::TaskManager.class_eval do
+  def remove_task(task_name)
+    @tasks.delete(task_name.to_s)
+  end
+end
+
+[ 'version', 'version:bump:major', 'version:bump:minor', 'version:bump:patch', 'version:write' ].each do |task|
+  Rake.application.remove_task task
+end
+
+# version tasks
+require 'rake-version'
+RakeVersion::Tasks.new do |v|
+  v.copy 'lib/scide.rb'
+end
+
 require 'rspec/core/rake_task'
 desc "Run specs"
 RSpec::Core::RakeTask.new do |t|
@@ -33,26 +49,3 @@ RSpec::Core::RakeTask.new do |t|
 end
 
 task :default => :spec
-
-desc "Generate documentation"
-task :doc => ['doc:generate']
-namespace :doc do
-  project_root = File.dirname __FILE__
-  doc_destination = File.join project_root, 'doc'
-
-  begin
-    require 'yard'
-    require 'yard/rake/yardoc_task'
-
-    YARD::Rake::YardocTask.new(:generate) do |yt|
-      yt.files   = Dir.glob(File.join(project_root, 'lib', '**', '*.rb')) + 
-                   [ File.join(project_root, 'README.md') ]
-      yt.options = ['--output-dir', doc_destination, '--readme', 'README.md', '--private', '--protected']
-    end
-  rescue LoadError
-    desc "Generate YARD Documentation"
-    task :generate do
-      abort "Please install the YARD gem to generate rdoc."
-    end
-  end
-end

data/VERSION

@@ -1 +1 @@
-0.0.12
+0.1.0

data/bin/scide

@@ -1,4 +1,3 @@
 #!/usr/bin/env ruby
 require File.join(File.dirname(__FILE__), '..', 'lib', 'scide')
-
-Scide::Overmind.new.brood.dominate
+Scide::Program.new.run!

data/lib/scide/auto.rb

@@ -0,0 +1,33 @@
+
+module Scide
+
+  def self.auto_config
+    # TODO: option to specify custom default configuration file
+    String.new.tap do |c|
+      c << %|source $HOME/.screenrc\n\n| if File.exists? home_config_file
+      c << %|screen -t editor 0\n|
+      c << %|stuff "\\${PROJECT_EDITOR-\\$EDITOR}\\012"\n|
+      c << %|screen -t shell 1\n|
+      c << %|select editor|
+    end
+  end
+
+  def self.auto_config_file
+    file = Tempfile.new 'scide'
+    file.write auto_config
+    file.rewind
+    file.close
+    yield file
+    file.unlink
+  end
+
+  def self.auto? options = {}
+    options[:auto] or (ENV['SCIDE_AUTO'] and ENV['SCIDE_AUTO'].match(/\A(1|y|yes|t|true)\Z/i))
+  end
+
+  private
+
+  def self.home_config_file
+    File.join File.expand_path('~'), '.screenrc'
+  end
+end

data/lib/scide/list.rb

@@ -0,0 +1,33 @@
+
+module Scide
+
+  def self.list options = {}
+
+    dir = projects_dir options
+
+    projects = []
+
+    config_file = '.screenrc'
+    projects << '.' if Dir.pwd != File.expand_path('~') and File.file?(config_file)
+
+    if File.directory? dir
+
+      Dir.entries(dir).each do |project|
+
+        next if project.match /\A\.+\Z/
+        project_dir = File.join dir, project
+
+        next unless File.directory? project_dir
+        config_file = File.join project_dir, '.screenrc'
+
+        next unless File.file? config_file
+        projects << project
+      end
+
+    elsif projects.empty?
+      error %/No such directory "#{dir}"/
+    end
+
+    projects
+  end
+end

data/lib/scide/open.rb

@@ -0,0 +1,57 @@
+
+module Scide
+  SCREEN_BIN = 'screen'
+  SCREEN_OPTIONS = '-U'
+
+  def self.open *args
+
+    error "screen must be in the path" unless Which.which 'screen'
+
+    options = args.last.kind_of?(Hash) ? args.pop : {}
+    dir = current_project_dir args, options
+
+    file = File.join dir, '.screenrc'
+    exists = File.exists? file
+
+    if auto?(options) and !exists
+      auto_config_file do |auto_file|
+        return run dir, options.merge(screenrc: auto_file.path)
+      end
+    end
+
+    error %/No such configuration "#{file}"/ unless exists
+    error %/"#{file}" is not a file/ unless File.file? file
+
+    run dir, options
+  end
+
+  private
+
+  def self.run dir, options = {}
+    if options[:noop]
+      command dir, options
+    else
+      error "Could not open project" unless Kernel.system command(dir, options)
+      true
+    end
+  end
+
+  def self.command dir, options = {}
+    # TODO: look for other config file names (e.g. "screenrc") or add option to customize?
+    command = "#{screen_bin(options)} #{screen_options(options)} -c #{screen_config(options)}"
+    command = "cd #{Shellwords.escape dir} && #{command}" if dir != Dir.pwd
+    command
+  end
+
+  def self.screen_config options = {}
+    options[:screenrc] || '.screenrc'
+  end
+
+  def self.screen_bin options = {}
+    options[:bin] || ENV['SCIDE_BIN'] || SCREEN_BIN
+  end
+
+  def self.screen_options options = {}
+    options[:screen] || ENV['SCIDE_SCREEN'] || SCREEN_OPTIONS
+  end
+end