elscripto 0.5.1 → 0.6.0

data/README.md

@@ -4,7 +4,7 @@ elscripto is a command line automator. It was initially written to start up a fe
 
 ## Platforms
 
-This gem currently works on Mac OSX, and Linux with Gnome or KDE desktops.
+This gem currently works on Mac OSX and Linux with Gnome or KDE desktops.
 It uses Applescript, gnome-terminal and konsole automation via qdbus depending on the platform.
 
 ## Installation
@@ -23,34 +23,55 @@ Or install it yourself as:
 
 ## Usage
 
-From within a project directory, run the following command to bootstrap Elscripto.
+As of version 0.6.0 there are a few different ways of using elscripto.
+
+
+### Supply commands from the command line:
+You can simply use the `-c (--commands)` argument to pass an array or shell commands directly:
+
+    $ elscripto start -c 'ssh server1; ssh server2;ssh server3'
+
+Elscripto will run each command in a different tab.
+
+### Use a configuration file:
+Run the following command to bootstrap a configuration file in the current directory:
 
     $ elscripto init
 
 This will create an `.elscripto` file, containing a few command definitions that you can edit to your liking.
 From then on, every time you call `elscripto` from within that folder, the specified commands will be ran in different tabs. [This is an example configuration](https://github.com/Achillefs/elscripto/blob/master/config/elscripto.init.yml) file that also tells you how to add your own definitions in a project.
 
-### Command Definitions
+If the default configuration file path doesn't suit your needs, you can always call `elscripto` with the -f (or --file) option, pointing to your custom configuration file.
+
+Example:
+
+    $ elscripto start -f /path/to/my/conf.yml
 
+### Supply command definitions from the command line:
+Finally, you can call `elscripto` with the `-d (--definitions)` argument:
+
+    $ elscripto start -d 'rails:server;rails:watchr;spork;custom_command'
+
+This command goes through your system's configuration files (see [Command Definitions](#command-definitions)) and expands the definitions you provided. This allows you to create your own commands just the way you like 'em, and easily call them from anywhere in the system.
+
+## Command Definitions
 Elscripto comes with a few built-in shell commands; Upon first run, a default configuration file is installed in a platform-dependent directory 
   
-  * **OSX**: `/usr/local/etc/elscripto/_default.conf`
-  * **Linux**: `<your home dir>/.config/elscripto/_default.conf`
+* **OSX**: `/usr/local/etc/elscripto/_default.conf`
+* **Linux**: `<your home dir>/.config/elscripto/_default.conf`
 
 Have a look at the bundled [elscripto.conf.yml](https://github.com/Achillefs/elscripto/blob/master/config/elscripto.conf.yml) for a list of built-in commands.
 
 You can drop in more files in there and as long as the file extension is conf, Elscripto will attempt to load the definitions. Bear in mind the following:
 
-  * Definition files are loaded alphabetically, so you can overwrite a default definition (or one of yours for that matter) by re-defining it in a latter custom configuration file
-  * Overwriting `default.conf` is not a good idea, your changes are probably gonna get overwritten by a gem update
+* Definition files are loaded alphabetically, so you can overwrite a default definition (or one of yours for that matter) by re-defining it in a latter custom configuration file
+* Overwriting `default.conf` is not a good idea, your changes are probably gonna get overwritten by a gem update
 
 ## Suggestions, comments, bugs, whatever
-
 Feel free to use Issues to submit bugs, suggestions or feature requests. 
 Elscripto should work on all major platforms (yes, even Windows), let not my limited knowledge / experience and time stand in the way!
 
 ## Contributing
-
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
@@ -58,9 +79,9 @@ Elscripto should work on all major platforms (yes, even Windows), let not my lim
 5. Create new Pull Request
 
 ## Changelog
-
-  * 0.5.0 KDE support
-  * 0.4.0 Custom configuration files support
-  * 0.3.0 GNOME support
-  * 0.2.0 OSX support
-  * 0.1.0 Initial release
+* 0.6.0 Added `--definitions`, `--commands` and `--file` cli arguments
+* 0.5.0 KDE support
+* 0.4.0 Custom configuration files support
+* 0.3.0 GNOME support
+* 0.2.0 OSX support
+* 0.1.0 Initial release

data/bin/elscripto

@@ -1,44 +1,17 @@
 #!/usr/bin/env ruby
 require 'rubygems'
 require 'elscripto'
+require 'optparse'
 require 'nutrun-string'
 
-def run(command)
-  executable_name = File.basename($PROGRAM_NAME)
-  
-  if command != nil and %{init start --version}.include?(command) # valid command?
-    case command
-    when 'init'
-      print "\nInitializing elscripto...".yellow
-      begin
-        Elscripto::App.init!
-        puts " done."
-        puts "Before continuing, update ./.elscripto with the desired script definitions\n\n".yellow
-      rescue Elscripto::AlreadyInitializedError
-        puts " nah, it's already there!\n".green
-      end
-    when 'start'
-      if File.exists? Elscripto::App::CONFIG_FILE
-        begin
-          app = Elscripto::App.new(Elscripto::App::CONFIG_FILE)
-          puts 'Starting ElScripto Spctacularrr!'.green
-          app.exec!
-        rescue Elscripto::NoDefinitionsError,Elscripto::UnsupportedOSError,Elscripto::LaunchFailedError => e
-          puts "\n#{e.message}\n".red
-        end
-      else
-        print "No configuration found, initializing...".yellow
-        Elscripto::App.init!
-        puts "done.".green
-        puts "Before continuing, update ./.elscripto with the desired script definitions".yellow
-      end
-    when '--version', '-v'
-      puts "\n#{executable_name.capitalize} version #{Elscripto::VERSION}".white
-      puts "(c) 2012, Achillefs Charmpilas\n".green
-    end
-  else # valid command?
-    puts "\nUsage: #{executable_name} init|start\n".white
-  end # valid command?
-end
-
-run(ARGV[0]) unless ENV['NO_RUN']
+begin
+  command = Elscripto::Options::VALID_COMMANDS.include?(ARGV[0]) ? ARGV[0] : ''
+  options = Elscripto::Options.parse command, ARGV
+  app = Elscripto::App.new(options)
+  app.exec!
+rescue Elscripto::InvalidCommandError,
+  Elscripto::NoDefinitionsError, Elscripto::UnsupportedOSError,
+  Elscripto::AlreadyInitializedError, Elscripto::LaunchFailedError => e
+  puts "\nElscripto error: #{e.message}\n".red
+  puts e.backtrace.join("\n") if options.enviroment == :development
+end

data/config/elscripto.conf.yml

@@ -7,4 +7,7 @@
   rails:logtail: 'rake log:clear && tail -f log/development.log'
   rails:compass: 'compass watch'
   rails:watchr: 'watchr ./config/specs.watchr'
-  test: "echo 'SPECTACULARRR!'"
+  test: "echo 'SPECTACULARRR!'"
+  git:pull: 'git pull'
+  svn:up: 'svn update'
+  textmate: 'mate .'

data/lib/elscripto.rb

@@ -1,3 +1,3 @@
-%W{app command version}.each {|r| require "elscripto/#{r}"}
+%W{app command version options}.each {|r| require "elscripto/#{r}"}
 module Elscripto
 end

data/lib/elscripto/app.rb

@@ -22,7 +22,11 @@ module Elscripto # :nodoc:
   
   class NoDefinitionsError < Exception # :nodoc:
     def initialize
-      super "No definitions in your configuration file. What's the deal, guy?"
+      super "No commands or definitions gived.\n
+You need to specify at least one of the following: 
+  --file CONFIG_FILE
+  --commands CMD1;CMD2...
+  --definitions DEF1;DE2..."
     end
   end
   
@@ -36,31 +40,72 @@ module Elscripto # :nodoc:
   # Initialize it by passing a config file to it. 
   # Default file path is <current_dir>/.elscripto
   class App
-    attr_accessor :commands, :platform, :enviroment, :generated_script
+    attr_accessor :command, :opts, :commands, :platform, :enviroment, :generated_script
     CONFIG_FILE = File.join('.','.elscripto')
     
-    def initialize opts_file, opts = {}
+    def initialize opts
+      @opts = opts
       @commands = []
+      @command = @opts.command
       @generated_script = ""
       @platform = self.class.get_platform(RbConfig::CONFIG['host_os'])
       first_run?
-      @enviroment = opts.delete(:enviroment) || :production
-      config_file = opts_file ? opts_file : CONFIG_FILE
-      raise ArgumentError.new "Elscripto needs a config file spectacularrr" unless File.exists?(config_file)
-      opts = YAML.load_file(config_file)
-      raise Elscripto::NoDefinitionsError.new unless opts['commands'].class == Array
-      opts['commands'].each do |cmd|
+      @enviroment = @opts.enviroment
+      
+      if @command == 'start'
+        expand_commands!
+        add_adhoc_commands!
+        raise NoDefinitionsError if @commands.size == 0
+      end
+    end
+    
+    def expand_commands!
+      # load configuration from file
+      if File.exists?(@opts.config_file)
+        file_opts = YAML.load_file(@opts.config_file)
+        @commands << file_opts['commands'] if file_opts['commands'].class == Array
+      end
+      # add in definitions
+      @commands << @opts.definitions unless @opts.definitions.size == 0
+      
+      @commands = @commands.flatten.map do |cmd|
         case cmd.class.to_s
         when 'Hash'
-          @commands << Command.new(cmd['name'], :command => cmd['command'])
+          Command.new(cmd['name'], :command => cmd['command'])
         when 'String'
-          @commands << Command.new(cmd)
+          Command.new(cmd)
         end
       end
     end
     
+    def add_adhoc_commands!
+      # add in incoming adhoc commands
+      i = 1
+      @opts.commands.each do |c|
+        @commands << Command.new("cmd#{i}",:command => c)
+        i+=1
+      end
+    end
+    
     def exec!
+      send(@command.to_sym)
+    end
+    
+    def init
+      print "\nInitializing elscripto...".yellow
+      begin
+        self.class.init!
+        puts_unless_test " done."
+        puts_unless_test "Before continuing, update ./.elscripto with the desired script definitions\n\n".yellow
+      rescue Elscripto::AlreadyInitializedError
+        puts_unless_test " nah, it's already there!\n".green
+      end
+    end
+    
+    def start
       raise Elscripto::NoDefinitionsError.new if self.commands.size == 0
+      
+      puts_unless_test 'Starting ElScripto Spctacularrr!'.green
       case self.platform
       # tell application "Terminal"
       # 	activate
@@ -153,11 +198,15 @@ done}
           File.open(global_conf_file,'w') do |f|
             f.write(File.read(File.join(File.dirname(__FILE__),'..','..','config','elscripto.conf.yml')))
           end
-          puts "Wrote global configuration to #{global_conf_file}".yellow
+          puts_unless_test "Wrote global configuration to #{global_conf_file}".yellow
         end
       end
     end
     
+    def puts_unless_test msg
+      puts msg unless enviroment == :test
+    end
+    
     class << self
       def init!
         if File.exists?(CONFIG_FILE)

data/lib/elscripto/options.rb

@@ -0,0 +1,68 @@
+require 'optparse'
+require 'ostruct'
+require 'fileutils'
+
+module Elscripto
+  class InvalidCommandError < StandardError
+  end
+  
+  class Options
+    VALID_COMMANDS = %W[init start]
+    
+    # A customized OptionsParser
+    def self.parse(command,args)
+      # The options specified on the command line will be collected in *options*.
+      # We set default values here.
+      options = OpenStruct.new
+      options.verbose = false
+      options.path = FileUtils.pwd
+      options.command = command
+      options.config_file = './.elscripto'
+      options.commands = options.definitions = []
+      options.enviroment = :production
+      opts = OptionParser.new do |opts|
+        opts.program_name = 'elscripto'
+        opts.banner = "Usage: #{opts.program_name} init|start [options]".green
+        opts.separator ""
+        opts.separator "Options:".green
+        
+        opts.on('-p','--path PATH',"Set elscripto's working directory") do |path|
+          options.path = path
+        end
+        
+        opts.on('-c','--commands CMD1;CMD2;CMD3...','Pass a list of comma-separated commands') do |cmds|
+          options.commands = cmds.split(';').map(&:strip)
+        end
+        
+        opts.on('-d','--definitions DEF1;DEF2;DEF3...','Pass a list of comma-separated command definitions') do |defs|
+          options.definitions = defs.split(';').map(&:strip)
+        end
+        
+        opts.on('-f','--file CONFIG FILE PATH','Pass a path to a config file') do |conf_file|
+          options.config_file = conf_file
+        end
+        
+        opts.on('-e','--enviroment [production|development]','Define runtime enviroment') do |env|
+          options.enviroment = env.to_sym
+        end
+      end
+      
+      opts.separator ""
+      opts.separator "Common options:".green
+      
+      opts.on_tail("-h", "--help", "Show this message") do
+        puts opts
+        exit
+      end
+      
+      opts.on_tail("-v", "--version", "Show version") do
+        puts "#{opts.program_name} #{Elscripto::VERSION}\n(c) 2013, Achillefs Charmpilas".green
+        exit
+      end
+      
+      opts.parse!(args)
+      raise Elscripto::InvalidCommandError, "Please specify a valid command [#{VALID_COMMANDS.join('|')}]" unless VALID_COMMANDS.include?(options.command)
+      options
+    end
+  end
+end

data/lib/elscripto/version.rb

@@ -1,3 +1,3 @@
 module Elscripto
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

data/spec/elscripto_spec.rb

@@ -16,7 +16,7 @@ describe Elscripto::App do
     end
   end
   
-  subject { Elscripto::App.new 'spec/files/sample_options.yml', :enviroment => :development }
+  subject { Elscripto::App.new(Elscripto::Options.parse('start',%W{-e test -d spork;autotest;rails:server;rails:console})) }
   
   describe 'with valid options' do
     it { subject.commands.size.should eq(4) }
@@ -27,12 +27,18 @@ describe Elscripto::App do
   end
   
   describe 'with invalid options' do
-    subject { Elscripto::App.new 'spec/files/nonexistent_command.yml' }
+    subject { 
+      conf = Elscripto::Options.parse('start',%W{-f spec/files/nonexistent_command.yml})
+      Elscripto::App.new(conf) 
+    }
     it { expect { subject }.to raise_error(ArgumentError) }
   end
   
   describe 'with inline command input' do
-    subject { Elscripto::App.new 'spec/files/new_definition.yml' }
+    subject { 
+      conf = Elscripto::Options.parse('start',%W{-f spec/files/new_definition.yml})
+      Elscripto::App.new(conf) 
+    }
     it { subject.commands.last.system_call.should eq('rake log:clear') }
     it { subject.commands.last.name.should eq('rails:logs') }
   end
@@ -65,7 +71,7 @@ describe Elscripto::App do
     end
     
     describe "with no definitions" do
-      it { expect { Elscripto::App.new('spec/files/empty.yml') }.to raise_error(Elscripto::NoDefinitionsError) }
+      it { expect { Elscripto::App.new(Elscripto::Options.parse('start',[])) }.to raise_error(Elscripto::NoDefinitionsError) }
     end
   end
 end

data/spec/options_spec.rb

@@ -0,0 +1,50 @@
+require 'elscripto'
+describe Elscripto::Options do
+  let(:cmd) { 'start' }
+  subject { Elscripto::Options }
+  describe 'defaults' do
+    subject { Elscripto::Options.parse(cmd,[]) }
+    its(:verbose) { should eq(false) }
+    its(:path) { should eq(FileUtils.pwd) }
+    its(:command) { should eq(cmd) }
+    its(:config_file) { should eq('./.elscripto') }
+  end
+  
+  describe 'enviroment' do
+    it { subject.parse(cmd,%W{-e development}).enviroment.should eq(:development) }
+    it { subject.parse(cmd,%W{--enviroment=development}).enviroment.should eq(:development) }
+  end
+  
+  describe 'invalid command' do
+    it {expect { subject.parse('random',[])}.to raise_error(Elscripto::InvalidCommandError)  }
+  end
+  
+  describe 'path options' do
+    let(:path) { '/test/path' }
+    
+    describe '--path PATH' do
+      it { subject.parse(cmd,%W{-p #{path}}).path.should eq(path) }
+      it { subject.parse(cmd,%W{--path #{path}}).path.should eq(path) }
+    end
+    
+    describe '--file PATH' do
+      it { subject.parse(cmd,%W{-f #{path}}).config_file.should eq(path) }
+      it { subject.parse(cmd,%W{--file #{path}}).config_file.should eq(path) }
+    end
+  end
+  
+  describe 'array options' do |variable|
+    let(:commands) { 'cmd1;cmd2; cmd3  ;cmd4' }
+    let(:parsed) { %W{cmd1 cmd2 cmd3 cmd4}}
+    
+    describe '--commands CMDS' do
+      it { subject.parse(cmd,%W{-c #{commands}}).commands.should eq(parsed) }
+      it { subject.parse(cmd,%W{--commands #{commands}}).commands.should eq(parsed) }
+    end
+
+    describe '--definitions DEFS' do
+      it { subject.parse(cmd,%W{-d #{commands}}).definitions.should eq(parsed) }
+      it { subject.parse(cmd,%W{--definitions #{commands}}).definitions.should eq(parsed) }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elscripto
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-01 00:00:00.000000000Z
+date: 2013-01-10 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nutrun-string
-  requirement: &2152682660 !ruby/object:Gem::Requirement
+  requirement: &2164952280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152682660
+  version_requirements: *2164952280
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2164735980 !ruby/object:Gem::Requirement
+  requirement: &2164985120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164735980
+  version_requirements: *2164985120
 description: Console window group automation for developers
 email:
 - ac@humbuckercode.co.uk
@@ -54,6 +54,7 @@ files:
 - lib/elscripto.rb
 - lib/elscripto/app.rb
 - lib/elscripto/command.rb
+- lib/elscripto/options.rb
 - lib/elscripto/version.rb
 - spec/command_spec.rb
 - spec/elscripto_spec.rb
@@ -65,6 +66,7 @@ files:
 - spec/files/nonexistent_command.yml
 - spec/files/osascript.txt
 - spec/files/sample_options.yml
+- spec/options_spec.rb
 homepage: http://github.com/Achillefs/elscripto
 licenses:
 - MIT
@@ -101,3 +103,4 @@ test_files:
 - spec/files/nonexistent_command.yml
 - spec/files/osascript.txt
 - spec/files/sample_options.yml
+- spec/options_spec.rb