lightning 0.2.1

data/test/bolt_test.rb

@@ -0,0 +1,36 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class Lightning::BoltTest < Test::Unit::TestCase
+  context "Bolt" do
+    before(:each) do
+      @completion_map = {'path1'=>'/dir/path1','path2'=>'/dir/path2'}
+      @bolt = Lightning::Bolt.new('blah')
+      @bolt.completion_map.map = @completion_map
+    end
+    
+    test "fetches correct completions" do
+      assert_equal @bolt.completions, @completion_map.keys
+    end
+
+    test "resolves completion" do
+      assert_equal @completion_map['path1'], @bolt.resolve_completion('path1')
+    end
+
+    test "resolves completion with test flag" do
+      assert_equal @completion_map['path1'], @bolt.resolve_completion('-test path1')
+    end
+
+    test "creates completion_map only once" do
+      assert_equal @bolt.completion_map.object_id, @bolt.completion_map.object_id
+    end
+  end
+  
+  test "Bolt's completion_map sets up alias map with options" do
+    old_config = Lightning.config
+    Lightning.stub!(:current_command, :return=>'blah')
+    Lightning.config = {:aliases=>{'path1'=>'/dir1/path1'}, :commands=>[{'name'=>'blah'}], :paths=>{}}
+    @bolt = Lightning::Bolt.new('blah')
+    assert_equal({'path1'=>'/dir1/path1'}, @bolt.completion_map.alias_map)
+    Lightning.config = old_config
+  end
+end

data/test/completion_map_test.rb

@@ -0,0 +1,58 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class Lightning::CompletionMapTest < Test::Unit::TestCase
+
+  context "CompletionMap" do    
+    def create_map(path_hash, new_options={})
+      Dir.stub!(:glob) { path_hash.values }
+      @completion_map = Lightning::CompletionMap.new('blah', new_options)
+    end
+    
+    test "creates basic map" do
+      expected_map = {"path1"=>"/dir1/path1", "path2"=>"/dir1/path2"}
+      create_map(expected_map)
+      assert_equal expected_map, @completion_map.map
+    end
+    
+    test "ignores paths from Lightning.ignore_paths" do
+      Lightning.stub!(:ignore_paths, :return=>['path1'])
+      expected_map = {"path1"=>"/dir1/path1", "path2"=>"/dir1/path2"}
+      create_map(expected_map)
+      assert_equal expected_map.slice('path2'), @completion_map.map
+    end
+    
+    test "creates map with duplicates" do
+      expected_map = {"path1//dir3"=>"/dir3/path1", "path2"=>"/dir1/path2", "path1//dir1"=>"/dir1/path1", "path1//dir2"=>"/dir2/path1"}
+      create_map(expected_map)
+      assert_equal expected_map, @completion_map.map
+    end
+    
+    test "fetches correct path completion" do
+      map = {"path1"=>"/dir1/path1", "path2"=>"/dir1/path2"}
+      create_map(map)
+      assert_equal '/dir1/path1', @completion_map['path1']
+    end
+    
+    test "creates alias map" do
+      create_map({}, :aliases=>{'path3'=>'/dir1/path3'}, :global_aliases=>{'path2'=>'/dir1/path2'})
+      assert_equal({"path2"=>"/dir1/path2", "path3"=>"/dir1/path3"}, @completion_map.alias_map)
+    end
+    
+    test "fetches correct alias completion" do
+      create_map({}, :aliases=>{'path3'=>'/dir1/path3'})
+      assert_equal '/dir1/path3', @completion_map['path3']
+    end
+    
+    test "fetches correct global alias completion" do
+      map = {"path1"=>"/dir1/path1", "path2"=>"/dir1/path2"}
+      create_map(map, :global_aliases=>{'path3'=>'/dir1/path3'})
+      assert_equal '/dir1/path3', @completion_map['path3']
+    end
+    
+    test "keys include aliases" do
+      map = {"path2"=>"/dir1/path2"}
+      create_map(map, :global_aliases=>{'path3'=>'/dir1/path3'})
+      assert_arrays_equal ['path2','path3'], @completion_map.keys
+    end
+  end
+end

data/test/completion_test.rb

@@ -0,0 +1,49 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class Lightning::CompletionTest < Test::Unit::TestCase
+  context "Completion" do
+    before(:each) {
+      @key = 'blah'; 
+      Lightning.bolts[@key].stub!(:completions, :return=>%w{at ap blah})
+      Lightning.config[:complete_regex] = true
+    }
+    test "from script matches" do
+      Lightning.config[:complete_regex] = false
+      assert_arrays_equal %w{at ap}, Lightning::Completion.complete('cd-test a', @key)
+    end
+    
+    test "for basic case matches" do
+      Lightning.config[:complete_regex] = false
+      @completion = Lightning::Completion.new('cd-test a', @key)
+      assert_arrays_equal %w{at ap}, @completion.matches
+    end
+    
+    test "with test flag matches" do
+      Lightning.config[:complete_regex] = false
+      @completion = Lightning::Completion.new('cd-test -test a', @key)
+      assert_arrays_equal %w{at ap}, @completion.matches
+    end
+    
+    test "with complete_regex on matches" do
+      Lightning.config[:complete_regex] = true
+      @completion = Lightning::Completion.new('cd-test *', @key)
+      assert_arrays_equal %w{at ap blah}, @completion.matches
+    end
+    
+    test "with invalid regex is rescued" do
+      Lightning.config[:complete_regex] = true
+      @completion = Lightning::Completion.new('cd-test []', @key)
+      assert !@completion.matches.grep(/Error/).empty?
+    end
+  end
+  
+  test "blob_to_regex converts * to .*" do
+    @lc = Lightning::Completion.new('blah', @key)
+    assert_equal '.*a.*blah', @lc.blob_to_regex('*a*blah')
+  end
+  
+  test "blob_to_regex doesn't modify .*" do
+    @lc = Lightning::Completion.new('blah', @key)
+    assert_equal '.*blah.*', @lc.blob_to_regex('.*blah.*')
+  end
+end

data/test/config_test.rb

@@ -0,0 +1,62 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class Lightning::ConfigTest < Test::Unit::TestCase
+  context "A config" do
+    before(:all) {
+      @config = Lightning::Config.create
+    }
+    
+    should "be a hash" do
+      assert @config.is_a?(Hash)
+    end
+    
+    should "have keys that are symbols" do
+      assert @config.keys.all? {|e| e.is_a?(Symbol)}
+    end
+    
+    should "have read supported keys" do
+      supported_keys = [:generated_file, :commands, :ignore_paths, :paths, :shell, :complete_regex]
+      assert_arrays_equal supported_keys, @config.keys 
+    end
+    
+    should "have a generated_file key which is a string" do
+      assert @config[:generated_file].is_a?(String)
+    end
+    
+    should "have a commands key which is an array" do
+      assert @config[:commands].is_a?(Array)
+    end
+    
+    should "have a command with valid keys" do
+      assert @config[:commands][0].slice('name', 'map_to', 'description').values.all? {|e| e.is_a?(String)}
+      assert @config[:commands][0]['paths'].is_a?(Array)
+    end
+    
+    should "have a paths key which is a hash" do
+      assert @config[:paths].is_a?(Hash)
+    end
+    
+    should "have an ignore_paths key which is an array" do
+      assert @config[:ignore_paths].is_a?(Array)
+    end
+  end
+  
+  context ":configure_commands_and_paths" do
+    test "generates bolt key if none exists" do
+      config = {:commands=>[{'name'=>'c1', 'map_to'=>'s1'}]}
+      assert ! Lightning::Config.configure_commands_and_paths(config)[:commands][0]['bolt_key'].nil?
+    end
+    
+    test "adds generated bolt key to config.paths if it didn't exist" do
+      config = {:commands=>[{'name'=>'c1', 'map_to'=>'s1', 'paths'=>['*']}]}
+      new_config = Lightning::Config.configure_commands_and_paths(config)
+      bolt_key = new_config[:commands][0]['bolt_key']
+      assert new_config[:paths].has_key?(bolt_key)
+    end
+    
+    test "adds reference to bolt key if command.paths is a string" do
+      config = {:commands=>[{'name'=>'c1', 'map_to'=>'s1', 'paths'=>'blah'}]}
+      assert_equal 'blah', Lightning::Config.configure_commands_and_paths(config)[:commands][0]['bolt_key']
+    end
+  end
+end

data/test/lightning.yml

@@ -0,0 +1,39 @@
+---
+generated_file: lightning_completions
+
+ignore_paths:
+    - .DS_Store
+    - .git
+
+#only oa command is currently used
+commands:
+    - name : oa
+      map_to : open -a
+      description : open mac applications
+      paths:
+        - /Applications/*.app
+        - /Applications/Utilities/*.app
+      
+    - name : gcd
+      map_to : cd
+      paths: gem
+      
+    - name : rcd
+      map_to : cd
+      description : ruby core directories
+      paths:
+         - /Library/Ruby/Site/1.8/**/
+         - /System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/**/
+    
+paths: 
+    # to obtain your own paths to your ruby gems:
+    # `gem environment path`.split(":").map {|e| e +"/gems/*" }
+    gem:
+      - /Users/bozo/.gem/ruby/1.8/gems/*
+      - /Library/Ruby/Gems/1.8/gems/*
+      - /System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/gems/1.8/gems/*
+
+    gem_rdoc:
+      - /Users/bozo/.gem/ruby/1.8/doc/*
+      - /Library/Ruby/Gems/1.8/doc/*
+      - /System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/gems/1.8/doc/*

data/test/lightning_test.rb

@@ -0,0 +1,58 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class LightningTest < Test::Unit::TestCase
+  context "Generator" do
+    before(:all) do
+      @config_file =  File.dirname(__FILE__) + '/lightning_completions'
+      Lightning.config[:generated_file] = @config_file
+      Lightning::Generator.generate_completions
+    end
+    after(:all) {  FileUtils.rm_f(Lightning.config[:generated_file]) }
+    
+    test "generates file in expected location" do
+      assert File.exists?(@config_file)
+    end
+
+    #this depends on oa 
+    test "generates expected output for a command" do
+      generated_command = <<-EOS.gsub(/^\s{6}/,'')
+      #open mac applications
+      oa () {
+        if [ -z "$1" ]; then
+          echo "No arguments given"
+          return
+        fi
+        FULL_PATH="`${LBIN_PATH}lightning-full_path oa $@`"
+        if [ $1 == '-test' ]; then
+          CMD="open -a '$FULL_PATH'"
+          echo $CMD
+        else
+          open -a "$FULL_PATH"
+        fi
+      }
+      complete -o default -C "${LBIN_PATH}lightning-complete oa" oa
+      EOS
+      output = File.read(@config_file)
+      assert output.include?(generated_command)
+    end
+  end
+  
+  context "Lightning" do
+    test "complete() returns correctly for valid command" do
+      Lightning::Completion.stub!(:complete, :return=>'blah')
+      assert_equal 'blah', Lightning.complete('oa', 'blah')
+    end
+  
+    test "complete() reports error for invalid command" do
+      assert ! Lightning.complete('invalid','invalid').grep(/Error/).empty?
+    end
+  
+    test "translate() returns errorless for valid command" do
+      assert Lightning.translate('oa', 'blah').grep(/Error/).empty?
+    end
+    
+    test "translate() reports error for invalid command" do
+      assert ! Lightning.translate('invalid', 'blah').grep(/Error/).empty?
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'test/unit'
+require 'context' #gem install jeremymcanally-context -s http://gems.github.com
+require 'stump' #gem install jeremymcanally-stump -s http://gems.github.com
+#require 'pending' #gem install jeremymcanally-pending -s http://gems.github.com
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'lightning'
+#set up valid global config file
+Lightning::Config.config_file = File.join(File.dirname(__FILE__), 'lightning.yml') 
+
+
+class Test::Unit::TestCase
+  def assert_arrays_equal(a1, a2)
+    assert_equal a1.map {|e| e.to_s}.sort, a2.map{|e| e.to_s}.sort
+  end
+  
+end
+
+#from ActiveSupport
+class Hash
+  def slice(*keys)
+    reject { |key,| !keys.include?(key) }
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: lightning
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- Gabriel Horner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-23 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Lightning creates shell commands that each autocomplete to a configured group of files and directories. Autocompleting is quick since you only need to type the basename and can even use regex completion.
+email: gabriel.horner@gmail.com
+executables: 
+- lightning-complete
+- lightning-full_path
+- lightning-install
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- CHANGELOG.rdoc
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- bin/lightning-complete
+- bin/lightning-full_path
+- bin/lightning-install
+- lib/lightning.rb
+- lib/lightning/bolt.rb
+- lib/lightning/bolts.rb
+- lib/lightning/commands.rb
+- lib/lightning/completion.rb
+- lib/lightning/completion_map.rb
+- lib/lightning/config.rb
+- lib/lightning/generator.rb
+- lightning.yml.example
+- lightning_completions.example
+- test/bolt_test.rb
+- test/completion_map_test.rb
+- test/completion_test.rb
+- test/config_test.rb
+- test/lightning.yml
+- test/lightning_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/cldwalker/lightning
+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: tagaholic
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Path completions for your shell that will let you navigate like lightning.
+test_files: 
+- test/bolt_test.rb
+- test/completion_map_test.rb
+- test/completion_test.rb
+- test/config_test.rb
+- test/lightning_test.rb
+- test/test_helper.rb