scide 0.0.12 → 0.1.0

data/lib/scide/program.rb

@@ -0,0 +1,109 @@
+require 'commander'
+
+module Scide
+  
+  class Program < Commander::Runner
+
+    BACKTRACE_NOTICE = ' (use --trace to view backtrace)'
+
+    include Commander::UI
+    include Commander::UI::AskForClass
+
+    def initialize argv = ARGV
+      super argv
+
+      program :name, 'scide'
+      program :version, Scide::VERSION
+      program :description, 'GNU Screen IDE. Scide is a wrapper to launch screen with a .screenrc configuration file in the current directory or in project directories.'
+      program :help, 'H4LP', 'https://github.com/AlphaHydrae/scide/issues'
+
+      global_option '-p', '--projects PROJECTS_DIR', 'Use a custom projects directory (defaults to $SCIDE_PROJECTS or ~/src)'
+
+      command :open do |c|
+
+        c.syntax = 'scide open [PROJECT_NAME]'
+        c.description = 'Open the project in PROJECTS_DIR/PROJECT_NAME or the project in the current directory.'
+
+        c.option '-p', '--projects PROJECTS_DIR', 'Use a custom projects directory (defaults to $SCIDE_PROJECTS or ~/src)'
+        c.option '-a', '--auto', "Automatically use a default screen configuration if the current directory doesn't have a .screenrc file (defaults to $SCIDE_AUTO)"
+        c.option '-b', '--bin BIN', 'Path to screen binary (defaults to $SCIDE_BIN or searches in the PATH)'
+        c.option '-s', '--screen OPTIONS', 'Custom screen options (defaults to $SCIDE_SCREEN or -U)'
+        c.option '-n', '--noop', 'Show the command that would be run'
+
+        c.example 'scide', 'Open the project in the current directory (.screenrc required).'
+        c.example 'scide -p ~/src my-project', 'Open a named project from ~/src (config at ~/src/my-project/.screenrc).'
+        c.example 'scide my-project', 'Open a named project (from $SCIDE_PROJECTS or ~/src).'
+
+        c.action do |args,options|
+          to_trace_or_not_to_trace options.trace do
+            options = extract :projects, :auto, :bin, :screen, :noop, options
+            args << options unless options.empty?
+            result = Scide.open *args
+            puts result if options[:noop]
+          end
+        end
+      end
+
+      command :list do |c|
+
+        c.syntax = 'scide list'
+        c.description = 'List the projects with a .screenrc file in PROJECTS_DIR.'
+
+        c.option '-p', '--projects PROJECTS_DIR', 'Use a custom projects directory (defaults to $SCIDE_PROJECTS or ~/src)'
+
+        c.example 'scide list', 'List the projects with a .screenrc file in $SCIDE_PROJECTS or ~/src.'
+        c.example 'scide -p ~/Projects list', 'List the projects with a .screenrc file in ~/Projects.'
+
+        c.action do |args,options|
+          to_trace_or_not_to_trace options.trace do
+            projects = Scide.list extract(:projects, options)
+            puts projects.join("\n")
+          end
+        end
+      end
+
+      command :setup do |c|
+
+        c.syntax = 'scide setup [PROJECT_NAME]'
+        c.description = 'Create a default .screenrc file in PROJECTS_DIR/PROJECT_NAME or in the current directory.'
+
+        c.option '-p', '--projects PROJECTS_DIR', 'Use a custom projects directory (defaults to $SCIDE_PROJECTS or ~/src)'
+
+        c.example 'scide setup', 'Create a default .screenrc file in the current directory.'
+        c.example 'scide -p ~/src setup my-project', 'Create a default .screenrc file in ~/src/my-project.'
+        c.example 'scide setup my-project', 'Create a default .screenrc file in $SCIDE_PROJECTS/my-project or ~/src/my-project.'
+
+        c.action do |args,options|
+          to_trace_or_not_to_trace options.trace do
+            options = extract :projects, :noop, options
+            args << options unless options.empty?
+            result = Scide.setup *args
+            puts Paint[result, :green]
+          end
+        end
+      end
+
+      default_command :open
+    end
+
+    private
+
+    def to_trace_or_not_to_trace trace = false
+      begin
+        yield
+      rescue Scide::Error => e
+        if trace
+          raise e
+        else
+          warn Paint["#{e.message}#{BACKTRACE_NOTICE}", :red]
+          exit e.code
+        end
+      end
+    end
+
+    def extract *args
+      options = args.pop
+      args.inject({}){ |memo,k| memo[k] = options.__send__(k); memo }.reject{ |k,v| v.nil? }
+    end
+  end
+end

data/lib/scide/setup.rb

@@ -0,0 +1,16 @@
+
+module Scide
+
+  def self.setup *args
+
+    options = args.last.kind_of?(Hash) ? args.pop : {}
+    dir = current_project_dir args, options
+
+    file = File.join dir, '.screenrc'
+    error "#{file} already exists" if File.exists? file
+
+    File.open(file, 'w'){ |f| f.write auto_config }
+
+    file
+  end
+end

data/lib/scide.rb

@@ -1,71 +1,39 @@
 require 'paint'
-require 'upoj-rb'
+require 'which_works'
+require 'shellwords'
 
-# Generator of GNU Screen configuration files.
 module Scide
+  VERSION = '0.1.0'
 
-  # Current version.
-  VERSION = File.open(File.join(File.dirname(__FILE__), '..', 'VERSION'), 'r').read
-
-  # Exit status codes.
-  EXIT = {
-    :unexpected => 1,
-    :invalid_argument => 2,
-    :not_initialized => 3,
-    :screen_not_found => 4,
-    :config_not_found => 10,
-    :config_not_readable => 11,
-    :malformed_config => 12,
-    :invalid_config => 13,
-    :unknown_project => 14
-  }
-
-  # Prints a message on <tt>stderr</tt> and exits.
-  # If <tt>condition</tt> is a key from {EXIT}, the corresponding value
-  # will be used as the exit code. Otherwise, scide exits with
-  # status 1.
-  def self.fail condition, msg
-    if @@exit_on_fail
-      puts
-      warn Paint[msg, :yellow]
-      puts
-      EXIT.key?(condition) ? exit(EXIT[condition]) : exit(1)
-    else
-      raise Scide::Error.new condition, msg
+  # TODO: add detailed error description for non-trace mode
+  class Error < StandardError
+    attr_reader :code
+    
+    def initialize msg, code = 1
+      super msg
+      @code = code
     end
   end
 
-  # By default, scide is meant to be used as a standalone script
-  # and exits if an error occurs. If <tt>exit_on_fail</tt> is
-  # false, a {Scide::Error} will be raised instead. Scide can then
-  # be used by another script.
-  def self.exit_on_fail= exit_on_fail
-    @@exit_on_fail = exit_on_fail
-  end
+  private
 
-  # Indicates whether scide is configured to exit on failure.
-  # See {Scide.exit_on_fail=}.
-  def self.exit_on_fail
-    @@exit_on_fail
+  def self.error msg, code = 1
+    raise Error.new msg, code
   end
 
-  # Scide error. Can be raised if {exit_on_fail} is set to false.
-  class Error < StandardError
-
-    # A symbol indicating the error type. See {EXIT}.
-    attr_reader :condition
-
-    # Returns a new error.
-    def initialize condition, msg
-      super msg
-      @condition = condition
-    end
+  def self.projects_dir options = {}
+    options[:projects] || ENV['SCIDE_PROJECTS'] || File.expand_path('~/src')
   end
 
-  private
-
-  @@exit_on_fail = true
+  def self.current_project_dir args, options = {}
+    project_name = args.shift
+    error "Only one project name must be given, got #{args.unshift project_name}" if args.any?
+    dir = project_name ? File.join(projects_dir(options), project_name) : Dir.pwd
+    error %/Cannot use home directory/ if File.expand_path(dir) == File.expand_path('~')
+    error %/No such directory "#{dir}"/ unless File.directory? dir
+    dir
+  end
 end
 
-# load scide components
-%w( command config global opts overmind project screen window ).each{ |dep| require File.join(File.dirname(__FILE__), 'scide', dep) }
+Dir[File.join File.dirname(__FILE__), File.basename(__FILE__, '.*'), '*.rb'].each{ |lib| require lib }
+

data/scide.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = "scide"
-  s.version = "0.0.12"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["AlphaHydrae"]
-  s.date = "2012-03-09"
-  s.description = "Utility to generate GNU screen configuration files."
+  s.authors = ["Simon Oulevay (AlphaHydrae)"]
+  s.date = "2013-05-02"
+  s.description = "GNU screen wrapper to open projects with a .screenrc file."
   s.email = "hydrae.alpha@gmail.com"
   s.executables = ["scide"]
   s.extra_rdoc_files = [
@@ -18,94 +18,86 @@ Gem::Specification.new do |s|
     "README.md"
   ]
   s.files = [
-    ".document",
     ".rspec",
-    ".rvmrc",
+    ".ruby-version",
+    ".screenrc",
     ".travis.yml",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
     "README.md",
     "Rakefile",
-    "TODO.md",
     "VERSION",
     "bin/scide",
     "lib/scide.rb",
-    "lib/scide/command.rb",
-    "lib/scide/commands/edit.rb",
-    "lib/scide/commands/run.rb",
-    "lib/scide/commands/show.rb",
-    "lib/scide/commands/tail.rb",
-    "lib/scide/config.rb",
-    "lib/scide/global.rb",
-    "lib/scide/opts.rb",
-    "lib/scide/overmind.rb",
-    "lib/scide/project.rb",
-    "lib/scide/screen.rb",
-    "lib/scide/window.rb",
+    "lib/scide/auto.rb",
+    "lib/scide/list.rb",
+    "lib/scide/open.rb",
+    "lib/scide/program.rb",
+    "lib/scide/setup.rb",
     "scide.gemspec",
-    "spec/command_spec.rb",
-    "spec/commands/edit_spec.rb",
-    "spec/commands/run_spec.rb",
-    "spec/commands/show_spec.rb",
-    "spec/commands/tail_spec.rb",
-    "spec/config_spec.rb",
-    "spec/global_spec.rb",
+    "spec/auto_spec.rb",
+    "spec/cli/list_spec.rb",
+    "spec/cli/open_spec.rb",
+    "spec/cli/setup_spec.rb",
     "spec/helper.rb",
-    "spec/opts_spec.rb",
-    "spec/project_spec.rb",
-    "spec/results/config1.yml",
-    "spec/results/malformed_config.yml",
-    "spec/results/project1.screen",
-    "spec/results/screen1.screen",
-    "spec/scide_spec.rb",
-    "spec/screen_spec.rb",
-    "spec/version_spec.rb",
-    "spec/window_spec.rb"
+    "spec/list_spec.rb",
+    "spec/open_spec.rb",
+    "spec/setup_spec.rb",
+    "spec/version_spec.rb"
   ]
   s.homepage = "http://github.com/AlphaHydrae/scide"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.17"
-  s.summary = "GNU Screen IDE."
+  s.rubygems_version = "1.8.25"
+  s.summary = "GNU Screen IDE"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<upoj-rb>, ["~> 0.0.4"])
+      s.add_runtime_dependency(%q<commander>, ["~> 4.1.3"])
+      s.add_runtime_dependency(%q<paint>, ["~> 0.8.6"])
       s.add_runtime_dependency(%q<which_works>, ["~> 0.1.0"])
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<bundler>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<fakefs>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<gemcutter>, [">= 0"])
+      s.add_development_dependency(%q<gem-release>, [">= 0"])
+      s.add_development_dependency(%q<rake-version>, [">= 0"])
       s.add_development_dependency(%q<simplecov>, [">= 0"])
-      s.add_development_dependency(%q<yard>, [">= 0"])
-      s.add_development_dependency(%q<rdiscount>, [">= 0"])
-      s.add_development_dependency(%q<travis-lint>, ["~> 1.3.0"])
+      s.add_development_dependency(%q<travis-lint>, [">= 0"])
     else
-      s.add_dependency(%q<upoj-rb>, ["~> 0.0.4"])
+      s.add_dependency(%q<commander>, ["~> 4.1.3"])
+      s.add_dependency(%q<paint>, ["~> 0.8.6"])
       s.add_dependency(%q<which_works>, ["~> 0.1.0"])
-      s.add_dependency(%q<rspec>, [">= 0"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<bundler>, [">= 0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<fakefs>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<gemcutter>, [">= 0"])
+      s.add_dependency(%q<gem-release>, [">= 0"])
+      s.add_dependency(%q<rake-version>, [">= 0"])
       s.add_dependency(%q<simplecov>, [">= 0"])
-      s.add_dependency(%q<yard>, [">= 0"])
-      s.add_dependency(%q<rdiscount>, [">= 0"])
-      s.add_dependency(%q<travis-lint>, ["~> 1.3.0"])
+      s.add_dependency(%q<travis-lint>, [">= 0"])
     end
   else
-    s.add_dependency(%q<upoj-rb>, ["~> 0.0.4"])
+    s.add_dependency(%q<commander>, ["~> 4.1.3"])
+    s.add_dependency(%q<paint>, ["~> 0.8.6"])
     s.add_dependency(%q<which_works>, ["~> 0.1.0"])
-    s.add_dependency(%q<rspec>, [">= 0"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<bundler>, [">= 0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<fakefs>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<gemcutter>, [">= 0"])
+    s.add_dependency(%q<gem-release>, [">= 0"])
+    s.add_dependency(%q<rake-version>, [">= 0"])
     s.add_dependency(%q<simplecov>, [">= 0"])
-    s.add_dependency(%q<yard>, [">= 0"])
-    s.add_dependency(%q<rdiscount>, [">= 0"])
-    s.add_dependency(%q<travis-lint>, ["~> 1.3.0"])
+    s.add_dependency(%q<travis-lint>, [">= 0"])
   end
 end
 

data/spec/auto_spec.rb

@@ -0,0 +1,72 @@
+require 'helper'
+require 'fileutils'
+
+describe Scide do
+  include FakeFS::SpecHelpers
+
+  before :each do
+    FileUtils.mkdir_p '/tmp'
+  end
+
+  context ".auto_config_file" do
+
+    before(:each){ Scide.stub auto_config: 'foo' }
+
+    it "should create a temporary configuration file" do
+      Scide.auto_config_file do |auto_file|
+        expect(auto_file).to be_a_kind_of(Tempfile)
+      end
+    end
+
+    it "should create a file containing the results of ::auto_config" do
+      Scide.auto_config_file do |auto_file|
+        expect(File.read(auto_file)).to eq('foo')
+      end
+    end
+  end
+
+  context ".auto_config" do
+
+    let(:expected_config){ %|screen -t editor 0\nstuff "\\${PROJECT_EDITOR-\\$EDITOR}\\012"\nscreen -t shell 1\nselect editor| }
+    subject{ Scide.auto_config }
+
+    it{ should eq(expected_config) }
+
+    context "with a .screenrc file in the home directory" do
+      let(:expected_config){ %|source $HOME/.screenrc\n\n#{super()}| }
+      before(:each){ setup '~' }
+      it{ should eq(expected_config) }
+    end
+  end
+
+  context ".auto?" do
+
+    let(:options){ {} }
+    let(:env_auto){ nil }
+    subject{ Scide.auto? options }
+    it{ should be_false }
+
+    before :each do
+      ENV['SCIDE_AUTO'] = env_auto if env_auto
+    end
+    
+    context "with the auto option" do
+      let(:options){ { auto: true } }
+      it{ should be_true }
+    end
+
+    [ '1', 'y', 'yes', 't', 'true' ].each do |valid|
+      context "with $SCIDE_AUTO set to #{valid}" do
+        let(:env_auto){ valid }
+        it{ should be_true }
+      end
+    end
+  end
+
+  def setup dir, config = true
+    dir = File.expand_path dir
+    FileUtils.mkdir_p dir
+    FileUtils.touch File.join(dir, '.screenrc') if config
+    dir
+  end
+end

data/spec/cli/list_spec.rb

@@ -0,0 +1,81 @@
+require 'helper'
+
+describe 'scide list' do
+
+  let(:argv){ [ 'list' ] }
+  let(:expected_options){ {} }
+
+  before :each do
+    Scide.stub :list
+    Scide.stub(:open).and_raise(StandardError.new('open should not be called'))
+    Scide.stub(:setup).and_raise(StandardError.new('setup should not be called'))
+  end
+
+  shared_examples_for "list" do
+
+    it "should output nothing if there are no projects" do
+      Scide.stub list: []
+      expect_success "\n"
+    end
+
+    it "should output the list of projects" do
+      Scide.stub list: [ '.', 'a', 'b', 'c' ]
+      expect_success ".\na\nb\nc\n"
+    end
+
+    context "if it fails" do
+     
+      before :each do
+        Scide.stub(:list).and_raise(Scide::Error.new('fubar'))
+      end
+
+      it "should output the error to stderr" do
+        expect_failure "fubar#{Scide::Program::BACKTRACE_NOTICE}"
+      end
+
+      context "with the trace option" do
+        
+        let(:argv){ super().unshift '--trace' }
+
+        it "should raise the error" do
+          expect_failure "fubar", true
+        end
+      end
+    end
+  end
+
+  it_behaves_like "list"
+
+  [ '-p', '--projects' ].each do |opt|
+    context "with the #{opt} option" do
+      let(:projects_dir){ '~/Projects' }
+      let(:expected_options){ { projects: projects_dir } }
+      let(:argv){ super() + [ opt, projects_dir ] }
+      it_behaves_like "list"
+    end
+  end
+
+  def expect_success output
+    Scide.should_receive(:list).with expected_options
+    program = Scide::Program.new argv
+    stdout, stderr = StringIO.new, StringIO.new
+    $stdout, $stderr = stdout, stderr
+    expect{ program.run! }.to_not raise_error
+    $stdout, $stderr = STDOUT, STDERR
+    expect(stdout.string).to eq(output)
+    expect(stderr.string).to be_empty
+  end
+
+  def expect_failure message, expect_raise = false, code = 1, &block
+    program = Scide::Program.new argv
+    if expect_raise
+      expect{ program.run! }.to raise_error(Scide::Error){ |e| expect(e.message).to eq(message) }
+    else
+      stderr = StringIO.new
+      $stderr = stderr
+      expect{ program.run! }.to raise_error(SystemExit){ |e| expect(e.status).to eq(code) }
+      $stderr = STDERR
+      expect(Paint.unpaint(stderr.string.strip)).to eq(message)
+    end
+  end
+end

data/spec/cli/open_spec.rb

@@ -0,0 +1,131 @@
+require 'helper'
+
+describe 'scide open' do
+
+  let(:argv){ [] }
+  let(:expected_args){ [] }
+  let(:expected_options){ {} }
+  let(:expected_output){ expected_options[:noop] ? fake_command : '' }
+  let(:fake_command){ 'foo' }
+
+  before :each do
+    Scide.stub :open
+    Scide.stub(:list).and_raise(StandardError.new('list should not be called'))
+    Scide.stub(:setup).and_raise(StandardError.new('setup should not be called'))
+  end
+
+  shared_examples_for "open" do
+
+    before :each do
+      Scide.stub open: fake_command
+    end
+
+    it "should open the current directory" do
+      expect_success
+    end
+
+    context "with a project name" do
+      let(:argv){ super().push 'a' }
+      let(:expected_args){ [ 'a' ] }
+
+      it "should open the project" do
+        expect_success
+      end
+    end
+
+    context "if it fails" do
+
+      before :each do
+        Scide.stub(:open).and_raise(Scide::Error.new('fubar'))
+      end
+
+      it "should output the error to stderr" do
+        expect_failure "fubar#{Scide::Program::BACKTRACE_NOTICE}"
+      end
+
+      context "with the trace option" do
+        
+        let(:argv){ super().unshift '--trace' }
+
+        it "should raise the error" do
+          expect_failure "fubar", true
+        end
+      end
+    end
+  end
+
+  it_behaves_like "open"
+
+  [ '-p', '--projects' ].each do |opt|
+    context "with the #{opt} option" do
+      let(:projects_dir){ '~/Projects' }
+      let(:expected_options){ { projects: projects_dir } }
+      let(:argv){ [ opt, projects_dir ] }
+      it_behaves_like "open"
+    end
+  end
+
+  [ '-a', '--auto' ].each do |opt|
+    context "with the #{opt} option" do
+      let(:expected_options){ { auto: true } }
+      let(:argv){ [ opt ] }
+      it_behaves_like "open"
+    end
+  end
+
+  [ '-n', '--noop' ].each do |opt|
+    context "with the #{opt} option" do
+      let(:expected_options){ { noop: true } }
+      let(:argv){ [ opt ] }
+      it_behaves_like "open"
+    end
+  end
+
+  [ '-b', '--bin' ].each do |opt|
+    context "with the #{opt} option" do
+      let(:expected_options){ { bin: '/bin/custom-screen' } }
+      let(:argv){ [ opt, '/bin/custom-screen' ] }
+      it_behaves_like "open"
+    end
+  end
+
+  [ '-s', '--screen' ].each do |opt|
+    context "with the #{opt} option" do
+      let(:expected_options){ { screen: '-a' } }
+      let(:argv){ [ opt, "-a" ] }
+      it_behaves_like "open"
+    end
+  end
+
+  context "with all options" do
+    let(:projects_dir){ '~/Projects' }
+    let(:expected_options){ { projects: projects_dir, auto: true, bin: '/bin/custom-screen', screen: '-r -x', noop: true } }
+    let(:argv){ [ '--projects', projects_dir, '--auto', '--bin', '/bin/custom-screen', '--screen', '-r -x', '--noop' ] }
+    it_behaves_like "open"
+  end
+
+  def expect_success *args
+    args = args.empty? ? expected_args + (expected_options.empty? ? [] : [ expected_options ]) : args
+    Scide.should_receive(:open).with *args
+    program = Scide::Program.new argv
+    stdout, stderr = StringIO.new, StringIO.new
+    $stdout, $stderr = stdout, stderr
+    expect{ program.run! }.to_not raise_error
+    $stdout, $stderr = STDOUT, STDERR
+    expect(Paint.unpaint(stdout.string.chomp "\n")).to eq(expected_output)
+    expect(stderr.string).to be_empty
+  end
+
+  def expect_failure message, expect_raise = false, code = 1, &block
+    program = Scide::Program.new argv
+    if expect_raise
+      expect{ program.run! }.to raise_error(Scide::Error){ |e| expect(e.message).to eq(message) }
+    else
+      stderr = StringIO.new
+      $stderr = stderr
+      expect{ program.run! }.to raise_error(SystemExit){ |e| expect(e.status).to eq(code) }
+      expect(Paint.unpaint(stderr.string.strip)).to eq(message)
+      $stderr = STDERR
+    end
+  end
+end