tobias-script_finder 0.0.2

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2009-03-10
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,8 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/script_finder.rb
+lib/script_finder/script_finder.rb
+bin/s

data/PostInstall.txt

@@ -0,0 +1,5 @@
+
+For more information on script_finder, see http://github.com/tobias/script_finder
+
+
+

data/README.rdoc

@@ -0,0 +1,71 @@
+= script_finder
+
+* http://github.com/tobias/script_finder
+
+== 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):
+  
+  ~/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'
+  ...
+
+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'):
+  
+  #!/usr/bin/env ruby
+
+  require 'script_finder'
+  
+  # looks for executables in a commands/ dir instead of script/.
+  ScriptFinder.find_and_execute(ARGV, 'commands')
+  
+== FEATURES/PROBLEMS:
+
+* may not yet properly handle quoted arguments
+
+Email me at: tcrawley@gmail.com if you find any problems.
+
+== INSTALL:
+
+* gem sources -a http://gems.github.com
+* sudo gem install tobias-script_finder
+
+== 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/Rakefile

@@ -0,0 +1,28 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/script_finder'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('script_finder', ScriptFinder::VERSION) do |p|
+  p.developer('Tobias Crawley', 'tcrawley@gmail.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

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/script_finder.rb

@@ -0,0 +1,130 @@
+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(command)
+        elsif cmd.is_a?(Array)
+          too_many_cmds_found(cmd)
+        else
+          command.shift
+          cmd_string = "#{cmd} #{command.join(' ')}".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
+
+  end
+end

data/lib/script_finder.rb

@@ -0,0 +1,7 @@
+$:.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')
+module ScriptFinder
+  VERSION = '0.0.2'
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/script_finder'

data/test/test_script_finder.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestScriptFinder < 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
+  
+  
+  def test_truth
+    assert true
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: tobias-script_finder
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Tobias Crawley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-11 00:00:00 -07:00
+default_executable: s
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+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):  ~/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' ...  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'):  #!/usr/bin/env ruby  require 'script_finder'  # looks for executables in a commands/ dir instead of script/. ScriptFinder.find_and_execute(ARGV, 'commands')"
+email: 
+- tcrawley@gmail.com
+executables: 
+- s
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/script_finder.rb
+- lib/script_finder/script_finder.rb
+- bin/s
+- test/test_helper.rb
+- test/test_script_finder.rb
+has_rdoc: true
+homepage: http://github.com/tobias/script_finder
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+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: script_finder
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: "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"
+test_files: 
+- test/test_helper.rb
+- test/test_script_finder.rb