script_finder 0.2.3 → 1.0.0

data/README.md

@@ -0,0 +1,90 @@
+# 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 2.x app):
+
+    ~/rails_app/app/views$ s c
+    --> calling '/Users/tobias/rails_app/script/console'
+    Loading development environment (Rails 2.1.0)
+    >> exit
+    ~/rails_app/app/views$ s r 'some ruby'
+    's r' was 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/script_finder'
+  
+    # looks for executables in a commands/ dir instead of script/.
+    ScriptFinder.find_and_execute(ARGV, 'commands')
+
+## Rails 3 Support
+
+This gem also provides a `r` script for rails 3.x support. Example:
+
+    ~/rails_app/app/views$ r c
+    --> calling 'rails console'
+    Loading development environment (Rails 3.0.3)
+    >> exit 
+    ~/rails_app/app/views$ r d some_model
+    'r d' was ambiguous. Try:
+	'r de' for 'rails destroy'
+    	'r db' for 'rails dbconsole'
+    ~/rails_app/app/views$ r de some_model
+    --> calling 'rails destroy some_model'
+    ...
+
+## Known Issues
+
+* The rails script ('`r`') currently only supports the builtin rails commands
+* The gem may not yet properly handle quoted arguments
+
+Email me at: tcrawley@gmail.com if you find any problems.
+
+## Install
+
+* gem install script_finder
+
+## Contributors
+
+* [Blue-Dog-Archolite](https://github.com/Blue-Dog-Archolite)
+
+## License
+
+Copyright (c) 2009-2010 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

@@ -1,5 +1,5 @@
 --- 
-:major: 0
-:minor: 2
-:patch: 3
+:major: 1
+:minor: 0
 :build: 
+:patch: 0

data/bin/r

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'script_finder/rails_finder'
+
+#Rewrite in order to enable finding Rails3 arugments and tasks
+#Runs by default "rails ARGV" 
+#Verification and feeback provided as in find_and_execute
+# BlueDogArcholite - Robert R. Meyer
+RailsFinder.find_and_execute(ARGV)

data/bin/s

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require 'script_finder'
+require 'script_finder/script_finder'
 
 # by default, this looks for executables in a script/ dir. To change,
 # pass the bin dir name as a second argument:

data/lib/script_finder.rb

@@ -1,4 +1,3 @@
-$:.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')
+# nothing to see here. Instead, take a gander at:
+# - script_finder/script_finder
+# - script_finder/rails_finder

data/lib/script_finder/base_finder.rb

@@ -0,0 +1,120 @@
+require 'abbrev'
+begin
+  require 'ftools'
+rescue LoadError
+  #ignore, not needed under ruby 1.9
+end
+
+class BaseFinder
+
+  attr_accessor :bin_dir
+  attr_reader :command
+
+  DEFAULT_BIN_DIR = 'script'
+
+  def self.find_and_execute(command, bin_dir = nil)
+    command = command.split(' ') if command.is_a?(String)
+    finder = new(command, bin_dir).execute_command
+  end
+
+  def initialize(command, bin_dir = nil)
+    @command = command
+    self.bin_dir = bin_dir || DEFAULT_BIN_DIR
+  end
+
+  def execute_command
+    raise NotImplementedError.new("You must implement execute_command for subclasses of BaseFinder!")
+  end
+  
+  protected
+
+  def cmd_not_found
+    raise NotImplementedError.new("You must implement cmd_not_found for subclasses of BaseFinder!")
+  end
+
+  #Prefix and string join utilities
+  def unique_prefixes(possibles)
+    all_prefixes = possibles.abbrev
+    all_prefixes.keys.sort.inject({ }) do |prefixes, abbrev|
+      prefixes[all_prefixes[abbrev]] ||= abbrev
+      prefixes
+    end
+  end
+
+  def commands_to_command_string(commands)
+    commands.collect {|x| "'#{x}'"}.join(' ')
+  end
+
+  #Command utilities
+  def bin_dir_not_found
+    puts "No #{bin_dir} dir found"
+  end
+
+  def too_many_cmds_found(possibles)
+    exec_name = File.basename($0)
+    puts "'#{exec_name} #{command.first}' was ambiguous. Try:"
+    unique_prefixes(possibles).each do |cmd, prefix|
+      puts "\t'#{exec_name} #{prefix}' for '#{yield(cmd)}'"
+    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
+
+  #Bin Utilities
+  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 bin_dir_exists_in_pwd?
+    File.exists?(bin_dir) and
+      File.directory?(bin_dir) and
+      File.readable?(bin_dir)
+  end
+
+  def cmd_exec(cmd)
+    cmd.strip!
+    puts "--> calling '#{cmd}'"
+    exec cmd
+  end
+  
+  def execute_command_if_singleton(commands)
+    commands = commands.respond_to?(:to_a) ? commands.to_a : [commands] 
+    if commands.empty?
+      cmd_not_found
+    elsif commands.size > 1
+      too_many_cmds_found(commands)
+    else
+      command.shift
+      cmd_exec "#{commands.first} #{commands_to_command_string(command)}"
+    end
+  end
+
+end

data/lib/script_finder/rails_finder.rb

@@ -0,0 +1,52 @@
+require 'script_finder/base_finder'
+
+class RailsFinder < BaseFinder
+
+  def execute_command
+    execute_command_if_singleton(matching_commands)
+  end
+
+  private
+
+  def too_many_cmds_found(commands)
+    super(commands) { |c| "rails #{c}" }
+  end
+
+  def cmd_exec(cmd)
+    super("rails #{cmd}")
+  end
+    
+  def matching_commands
+    known_commands.select{ |cmd| cmd =~ /^#{command.first}.*/ }
+  end
+
+  def cmd_not_found
+    puts "No rails command found matching '#{command.first}'"
+  end
+
+  def known_commands
+    # it may be worthwhile to ask rails for the commands and cache
+    # them in a .file, in case the rails command is extended to
+    # provide more commands
+    @known_commands ||= %w{ generate console server dbconsole new application
+                             destroy benchmarker profiler plugin runner }
+  end
+
+  #Cheat Sheet for Rails Commands
+  # generate    Generate new code (short-cut alias: "g")
+  # console     Start the Rails console (short-cut alias: "c")
+  # server      Start the Rails server (short-cut alias: "s")
+  # dbconsole   Start a console for the database specified in config/database.yml
+  #             (short-cut alias: "db")
+  # new         Create a new Rails application. "rails new my_app" creates a
+  #             new application called MyApp in "./my_app"
+
+  #In addition to those, there are:
+  # application  Generate the Rails application code
+  # destroy      Undo code generated with "generate"
+  # benchmarker  See how fast a piece of code runs
+  # profiler     Get profile information from a piece of code
+  # plugin       Install a plugin
+  # runner       Run a piece of code in the application environment
+  #
+end

data/lib/script_finder/script_finder.rb

@@ -1,114 +1,23 @@
-require 'abbrev'
-begin
-  require 'ftools'
-rescue LoadError
-  #not available (and not needed) in ruby 1.9
-end
-
-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
+require 'script_finder/base_finder'
 
-  class Finder
-    attr_accessor :bin_dir
-    attr_reader :command
-    
-    def initialize(command, bin_dir = nil)
-      @command = command
-      self.bin_dir = bin_dir || DEFAULT_BIN_DIR
-    end
+class ScriptFinder < BaseFinder
+  def execute_command
+    dir = find_bin_dir
 
-    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
+    if dir
+      execute_command_if_singleton(find_command_in_dir(dir))
+    else
+      bin_dir_not_found
     end
-    
-    def find_bin_dir(starting_dir = '.', last_dir = nil)
-      starting_dir = File.expand_path(starting_dir)
+  end
 
-      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)
-      all_prefixes = possibles.abbrev
-      all_prefixes.keys.sort.inject({ }) do |prefixes, abbrev|
-        prefixes[all_prefixes[abbrev]] ||= abbrev
-        prefixes
-      end
-    end
-    
-    protected
-    
-    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
+  private
+  def too_many_cmds_found(cmd)
+    super(cmd) { |c| File.join(bin_dir, c) }
+  end
 
-    def too_many_cmds_found(possibles)
-      exec_name = File.basename($0)
-      puts "'#{exec_name} #{command.first}' was 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
+  def cmd_not_found
+    puts "No script found matching '#{command.first}'"
   end
+
 end

data/test/base_finder_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+require 'script_finder/base_finder'
+
+class BaseFinderTest < Test::Unit::TestCase
+  def test_correct_creation_of_class
+    assert f = BaseFinder.new("g")
+    assert_equal f.bin_dir, "script"
+    assert_equal f.command, "g"
+  end
+
+  def test_creation_with_diffent_bin
+    assert f = BaseFinder.new("g","robs_special_base_bin")
+    assert_equal f.command, "g"
+    assert_equal f.bin_dir, "robs_special_base_bin"
+  end
+
+  def test_required_class_method_overide
+    assert_raise(NotImplementedError){BaseFinder.find_and_execute("hope")}
+  end
+
+  def test_unique_prefixes
+    prefixes = BaseFinder.new('blah').send(: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 = BaseFinder.new('blah').send(: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

@@ -1,12 +1,9 @@
 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

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: script_finder
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: false
   segments: 
+  - 1
   - 0
-  - 2
-  - 3
-  version: 0.2.3
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Tobias Crawley
@@ -15,26 +15,30 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-03 00:00:00 -04:00
-default_executable: s
+date: 2010-12-26 00:00:00 -05:00
+default_executable: 
 dependencies: []
 
 description: 
 email: tcrawley@gmail.com
 executables: 
+- r
 - s
 extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.textile
+- README.md
 files: 
-- README.textile
+- README.md
 - VERSION.yml
+- bin/r
 - bin/s
 - lib/script_finder.rb
+- lib/script_finder/base_finder.rb
+- lib/script_finder/rails_finder.rb
 - lib/script_finder/script_finder.rb
-- test/script_finder_test.rb
+- test/base_finder_test.rb
 - test/test_helper.rb
 - LICENSE
 has_rdoc: true
@@ -42,8 +46,8 @@ homepage: http://github.com/tobias/script_finder
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -72,5 +76,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/base_finder_test.rb
 - test/test_helper.rb

data/README.textile

@@ -1,77 +0,0 @@
-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 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
-
-From "gemcutter":http://gemcutter.org/:
-
-* gem install 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/test/script_finder_test.rb

@@ -1,21 +0,0 @@
-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