script_finder 0.2.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 tobias
+
+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.textile

@@ -0,0 +1,75 @@
+h1. script_finder
+
+* http://github.com/tobias/script_finder
+
+h1. DESCRIPTION
+
+script_finder provides a script (called @s@) that searches in and up from the current dir 
+for a folder (default: @script/@) containing an executable file uniquely identified by the a 
+prefix given as the first argument. It then calls that executable, passing the rest of the 
+arguments to the called executable. If the given prefix is ambiguous, the script suggests
+unique prefixes.
+
+Examples (in a rails app):
+
+<pre lang="ruby">
+  ~/rails_app/app/views$ s c
+  --> calling '/Users/tobias/rails_app/script/console'
+  Loading development environment (Rails 2.1.0)
+  RowsLogger plugin enables mysql
+  >> exit
+  ~/rails_app/app/views$ s r 'some ruby'
+  's r' was too ambiguous. Try:
+    's ru' for 'script/runner'
+    's re' for 'script/remote'
+  ~/rails_app/app/views$ s ru 'some ruby'
+  --> calling '/Users/tobias/rails_app/script/runner some ruby'
+  ...
+</pre>
+
+The gem is not rails specific - out of the box it will work with any project that has a 
+@script/@ directory. If you want to make your own version of the @s@ script that looks for 
+executables in a different dir (I would save this one as @c@):
+
+<pre lang="ruby">
+  #!/usr/bin/env ruby
+
+  require 'script_finder'
+  
+  # looks for executables in a commands/ dir instead of script/.
+  ScriptFinder.find_and_execute(ARGV, 'commands')
+</pre>
+
+h1. FEATURES/PROBLEMS
+
+* may not yet properly handle quoted arguments
+
+Email me at: tcrawley@gmail.com if you find any problems.
+
+h1. INSTALL
+
+* gem sources -a http://gems.github.com
+* sudo gem install tobias-script_finder
+
+h1. LICENSE
+
+Copyright (c) 2009 Tobias Crawley
+
+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/VERSION.yml

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

data/bin/s

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'script_finder'
+
+# by default, this looks for executables in a script/ dir. To change,
+# pass the bin dir name as a second argument:
+# ScriptFinder.find_and_execute(ARGV, 'commands')
+ScriptFinder.find_and_execute(ARGV)

data/lib/script_finder.rb

@@ -0,0 +1,4 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require File.join(File.dirname(__FILE__), 'script_finder', 'script_finder')

data/lib/script_finder/script_finder.rb

@@ -0,0 +1,133 @@
+require 'ftools'
+
+module ScriptFinder
+  DEFAULT_BIN_DIR = 'script'
+  
+  def self.find_and_execute(command, bin_dir = nil)
+    command = command.split(' ') if command.is_a?(String)
+    finder = Finder.new(command, bin_dir).execute_command
+  end
+
+  class Finder
+    def initialize(command, bin_dir = nil)
+      @command = command
+      self.bin_dir = bin_dir
+    end
+
+    def bin_dir=(dir)
+      @bin_dir = dir
+    end
+
+    def bin_dir
+      @bin_dir ||= DEFAULT_BIN_DIR
+    end
+    
+    def command
+      @command
+    end
+    
+    def execute_command
+      dir = find_bin_dir
+      
+      if dir
+        cmd = find_command_in_dir(dir)
+        if cmd.nil?
+          cmd_not_found
+        elsif cmd.is_a?(Array)
+          too_many_cmds_found(cmd)
+        else
+          command.shift
+          cmd_string = "#{cmd} #{commands_to_command_string(command)}".strip
+          puts "--> calling '#{cmd_string}'"
+          exec cmd_string
+        end
+      else
+        bin_dir_not_found
+      end
+    end
+    
+    def find_bin_dir(starting_dir = '.', last_dir = nil)
+      starting_dir = File.expand_path(starting_dir)
+
+      Dir.chdir(starting_dir) do
+        if starting_dir == last_dir
+          nil
+        elsif bin_dir_exists_in_pwd?
+          File.join(starting_dir, bin_dir)
+        else
+          find_bin_dir('..', starting_dir)
+        end
+      end
+    end
+    
+    def find_command_in_dir(dir)
+      cmd = command.first
+      Dir.chdir(dir) do
+        if cmd and File.executable?(cmd)
+          possibles = [cmd]
+        else
+          possibles = Dir.glob("#{cmd}*").select {|f| File.executable?(f)}
+        end
+        
+        if possibles.size == 0
+          nil
+        elsif possibles.size == 1
+          File.expand_path(possibles.first)
+        else
+          possibles
+        end
+      end
+    end
+
+    def unique_prefixes(possibles, prefixes = {})
+      if prefixes.values.uniq.size < possibles.size
+        possibles.each do |cmd|
+          prefixes[cmd] ||= ""
+          if prefix_is_not_unique?(cmd, prefixes[cmd], possibles)
+            prefixes[cmd] += cmd[prefixes[cmd].size,1]
+          end
+        end
+        unique_prefixes(possibles, prefixes)
+      else
+        prefixes
+      end
+    end
+
+    protected
+    
+    def prefix_is_not_unique?(current_cmd, current_prefix, possibles)
+      other_possibles = possibles.clone
+      other_possibles.delete(current_cmd)
+
+      (current_prefix.empty? or
+       other_possibles.inject(false) {|accum, c| accum || c[0,current_prefix.length] == current_prefix}) and
+        current_cmd.length > current_prefix.length
+    end
+    
+    def bin_dir_exists_in_pwd?
+      File.exists?(bin_dir) and
+        File.directory?(bin_dir) and
+        File.readable?(bin_dir)
+    end
+    
+    def bin_dir_not_found
+      puts "No #{bin_dir} dir found"
+    end
+    
+    def cmd_not_found
+      puts "No script found matching '#{command.first}'"
+    end
+
+    def too_many_cmds_found(possibles)
+      exec_name = File.basename($0)
+      puts "'#{exec_name} #{command.first}' was too ambiguous. Try:"
+      unique_prefixes(possibles).each do |cmd, prefix|
+        puts "\t'#{exec_name} #{prefix}' for '#{File.join(bin_dir, cmd)}'"
+      end
+    end
+    
+    def commands_to_command_string(commands)
+      commands.collect {|x| "'#{x}'"}.join(' ')
+    end
+  end
+end

data/test/script_finder_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+class ScriptFinderTest < Test::Unit::TestCase
+  
+  def test_unique_prefixes
+    prefixes = ScriptFinder::Finder.new([]).unique_prefixes( %w{db dbconsole destroy desmond})
+    assert_equal prefixes.values.size, prefixes.values.uniq.size
+  end
+  
+  def test_unique_prefixes_gives_shortest_prefix
+    prefixes = ScriptFinder::Finder.new([]).unique_prefixes(%w{db dbconsole destroy desmond funball})
+    assert_equal 'db', prefixes['db']
+    assert_equal 'dbc', prefixes['dbconsole']
+    assert_equal 'dest', prefixes['destroy']
+    assert_equal 'desm', prefixes['desmond']
+    assert_equal 'f', prefixes['funball']
+    
+  end
+  
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'script_finder'
+
+class Test::Unit::TestCase
+
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: script_finder
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Tobias Crawley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-01 00:00:00 -04:00
+default_executable: s
+dependencies: []
+
+description: 
+email: tcrawley@gmail.com
+executables: 
+- s
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- README.textile
+- VERSION.yml
+- bin/s
+- lib/script_finder.rb
+- lib/script_finder/script_finder.rb
+- test/script_finder_test.rb
+- test/test_helper.rb
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/tobias/script_finder
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --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.3.5
+signing_key: 
+specification_version: 3
+summary: A gem that provides tools to find and execute scripts in a project.
+test_files: 
+- test/script_finder_test.rb
+- test/test_helper.rb