cldwalker-lightning 0.1.2 → 0.2.0

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT LICENSE
 
-Copyright (c) 2008 Gabriel Horner
+Copyright (c) 2009 Gabriel Horner
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.markdown

@@ -13,14 +13,31 @@ you type or complete
 
     bash> rvim irb.rb
 
-Uneasy about what lightning will execute? Test it out with a -test flag
+Uneasy about what lightning will execute? Test/print it out with a -test flag
 
     bash> rvim -test irb.rb
     rvim '/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/irb.rb'
 
+Want to autocomplete but don't remember how the basename starts? Just use a ruby regular expression:
+
+    # *'s are converted to .*'s for convience sakes
+    bash> rvim *dialog [TAB TAB]
+    canvasprintdialog.rb
+    extfileselectiondialog.rb
+    dialog.rb//System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/tk
+    fileselectiondialog.rb
+    dialog.rb//System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/tkextlib/bwidget
+    finddialog.rb
+
+    #re-edit your line to narrow down your completion to one entry
+    bash> rvim ca*dialog [TAB TAB]
+
+    #once the basename completes, you can execute your command
+    bash> rvim canvasprintdialog.rb
+
 As you can see, you only need to autocomplete the basenames of paths and lightning will resolve their
-full paths.  rvim is a lightning command configured to autocomplete a certain group of paths for vim.
-In this case, rvim is configured to complete my ruby core and standard library files.
+full paths.  In these examples, rvim is a lightning command configured to autocomplete a certain group of paths for vim.
+In my case, rvim is configured to complete my ruby core and standard library files.
 
 
 Install
@@ -60,6 +77,12 @@ Since the globbable paths are interpreted by ruby's Dir.glob(), you can:
 
 `ri Dir.glob` for more examples.
 
+Aliases
+=======
+
+Lightning supports custom aliases for any path, globally and per command. So if there is some
+path that you access often but that's still too slow with completion, alias it away!
+
 Configuration
 =====================
 
@@ -70,7 +93,15 @@ Configuration options are:
 * generated\_file: Location of shell script file generated from config. Defaults to
   ~/.lightning\_completions.
 * ignore\_paths: List of paths to globally ignore when listing completions.
+* complete\_regex: true or false (default is true)
+  Turns on/off Ruby regular expression matching when completing. One convience
+  is that a '*' is converted to '.*' ie glob-like behavior.
+
+  Note: Realize your regular expression normally just match the basename. However, since duplicates
+  list their full paths, their full paths are subject to regex matching.
 * shell: Specifies shell script generator used for generating completions. Defaults to bash.
+* aliases: A hash (pairs) of custom aliases pointing to full paths. These aliases will be globally
+  recognized by any lightning command.
 * commands: A list of lightning commands. A lightning command is just a shell function
   which executes a specified shell function with a defined set of paths to autocomplete on.
   A command consists of the following options/keys:
@@ -80,6 +111,7 @@ Configuration options are:
   * description: Description which is placed as a comment in the generated shell script.
   * paths (required): A list of globbable paths, whose basenames are autocompleted. You can also
     pass this a path name that has been defined in the paths option. 
+  * aliases: A hash (pairs) of custom aliases and full paths only for this command.
 
 * paths: This takes a hash (pairs) of path names and globbable paths. This should be used when
   you have a group of paths that are used in multiple commands. When doing that, you would specify
@@ -124,6 +156,5 @@ I had to do something.
 Todo/Ideas
 ==========
 
-* Aliases for common autocompletions.
 * Allow lightning commands to only path-resolve one of multiple arguments given.
 * Command interface to easily add/remove current directory or globs from a command

data/Rakefile

@@ -0,0 +1,68 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+begin
+  require 'rcov/rcovtask'
+
+  Rcov::RcovTask.new do |t|
+    t.libs << 'test'
+    t.test_files = FileList['test/**/*_test.rb']
+    t.rcov_opts = ["-T -x '/Library/Ruby/*'"]
+    t.verbose = true
+  end
+rescue LoadError
+  puts "Rcov not available. Install it for rcov-related tasks with: sudo gem install rcov"
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "lightning"
+    s.executables = ["lightning-complete", "lightning-full_path", "lightning-install"]
+    s.summary = "Path completions for your shell that will let you navigate like lightning."
+    s.email = "gabriel.horner@gmail.com"
+    s.homepage = "http://github.com/cldwalker/lightning"
+    s.description = "Path completions for your shell that will let you navigate like lightning."
+    s.authors = ["Gabriel Horner"]
+    s.files =  FileList["Rakefile", "VERSION.yml", "lightning_completions.example", "lightning.yml.example","README.markdown", "LICENSE.txt", "{bin,lib,test}/**/*"]
+    s.has_rdoc = true
+    s.extra_rdoc_files = ["README.markdown", "LICENSE.txt"]
+  end
+
+rescue LoadError
+  puts "Jeweler not available. Install it for jeweler-related tasks with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'test'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+namespace :dev do
+  desc "Generates completion, modifies it for local development"
+  task :reload=>:generate_completions do
+    file = 'lightning_completions'
+    string = File.read(file)
+    string.sub!(/^LBIN_PATH/,'#LBIN_PATH')
+    string.sub!(/^#LBIN_PATH/,'LBIN_PATH')
+    File.open(file,'w') {|f| f.write(string) }
+  end
+
+  desc "Generates local completion file to be sourced by your shell"
+  task :generate_completions do
+    $:.unshift 'lib'
+    require 'lightning'
+    Lightning::Generator.generate_completions 'lightning_completions'
+  end
+end
+
+task :default => :test

data/VERSION.yml

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

data/lib/lightning.rb

@@ -4,7 +4,7 @@ require 'lightning/bolt'
 require 'lightning/bolts'
 require 'lightning/completion'
 require 'lightning/config'
-require 'lightning/path_map'
+require 'lightning/completion_map'
 require 'lightning/core_extensions'
 require 'lightning/generator'
 

data/lib/lightning/bolt.rb

@@ -7,11 +7,13 @@ class Lightning
     end
     
     def completions
-      path_map.keys
+      completion_map.keys
     end
     
-    def path_map
-      @path_map ||= Lightning::PathMap.new(self.paths)
+    def completion_map
+      @completion_map ||= Lightning::CompletionMap.new(self.paths,
+        :global_aliases=>Lightning.config[:aliases], 
+        :aliases=>Lightning.config_command(Lightning.current_command)['aliases'])
     end
     
     def resolve_completion(basename)
@@ -21,11 +23,11 @@ class Lightning
       # if (regex = Lightning.config_command(Lightning.current_command)['completion_regex'])
       #   basename = basename[/#{regex}/]
       # end
-      path_map[basename] || ''
+      completion_map[basename] || ''
     end
     
     def paths
       @paths ||= Lightning.config[:paths][key] || []
     end
   end
-end
+end

data/lib/lightning/completion.rb

@@ -12,10 +12,23 @@ class Lightning
     end
   
     def matches
-      possible_completions.select do |e|
-        e[0, typed.length] == typed
+      if Lightning.config[:complete_regex]
+        begin 
+          possible_completions.grep(/#{blob_to_regex(typed)}/)
+        rescue RegexpError
+          ['Error: Invalid regular expression']
+        end
+      else
+        possible_completions.select do |e|
+          e[0, typed.length] == typed
+        end
       end
     end
+    
+    #just converts * to .*  to make a glob-like regex
+    def blob_to_regex(string)
+      string.gsub(/^\*|([^\.])\*/) {|e| $1 ? $1 + ".*" : ".*" }
+    end
   
     def typed
       # @text_typed[/\s(.+?)$/, 1] || ''

data/lib/lightning/{path_map.rb → completion_map.rb}

@@ -1,20 +1,22 @@
 #This class maps completions to their full paths for the given blobs
 class Lightning
-  class PathMap
+  class CompletionMap
     attr_accessor :map
+    attr_reader :alias_map
     
     def initialize(*globs)
-      #globs need to be an array
+      options = globs[-1].is_a?(Hash) ? globs.pop : {}
       globs.flatten!
       @map = create_map_for_globs(globs)
+      @alias_map = (options[:global_aliases] || {}).merge(options[:aliases] || {})
     end
     
      def [](completion)
-       @map[completion]
+       @map[completion] || @alias_map[completion]
      end
      
      def keys
-       @map.keys
+       (@map.keys + @alias_map.keys).uniq
      end
     
     #should return hash

data/lib/lightning/config.rb

@@ -1,4 +1,5 @@
 module Lightning::Config
+  attr_accessor :config_file
   def load_config
     @config = setup_config
   end
@@ -7,16 +8,21 @@ module Lightning::Config
     @config ||= setup_config
   end
   
+  def config=(value)
+    @config = value
+  end
+  
   def setup_config
     hash = read_config_file
     configure_commands_and_paths(hash)
     hash
   end
   
-  def read_config_file(config_file=nil)
-    default_config = {:shell=>'bash', :generated_file=>File.expand_path(File.join('~', '.lightning_completions'))}
-    config_file ||= File.exists?('lightning.yml') ? 'lightning.yml' : File.expand_path(File.join("~",".lightning.yml"))
-    hash = YAML::load(File.new(config_file))
+  def read_config_file(file=nil)
+    default_config = {:shell=>'bash', :generated_file=>File.expand_path(File.join('~', '.lightning_completions')), 
+      :complete_regex=>true}
+    @config_file = file || @config_file || (File.exists?('lightning.yml') ? 'lightning.yml' : File.expand_path(File.join("~",".lightning.yml")))
+    hash = YAML::load(File.new(@config_file))
     default_config.merge(hash.symbolize_keys)
   end
   

data/lightning.yml.example

@@ -44,6 +44,8 @@ commands:
       paths:
          - /Library/Ruby/Site/1.8/**/
          - /System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/**/
+      aliases:
+        r1: /System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8
     
     - name : oa
       map_to : open -a

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/{lightning_config_test.rb → config_test.rb}

@@ -1,6 +1,6 @@
-require File.dirname(__FILE__) + '/test_helper'
+require File.join(File.dirname(__FILE__), 'test_helper')
 
-class LightningConfigTest < Test::Unit::TestCase
+class Lightning::ConfigTest < Test::Unit::TestCase
   context "A config" do
     before(:all) {
       @config = Lightning.read_config_file(File.dirname(__FILE__) + '/lightning.yml')
@@ -15,7 +15,7 @@ class LightningConfigTest < Test::Unit::TestCase
     end
     
     should "have read supported keys" do
-      supported_keys = [:generated_file, :commands, :ignore_paths, :paths, :shell]
+      supported_keys = [:generated_file, :commands, :ignore_paths, :paths, :shell, :complete_regex]
       assert_arrays_equal supported_keys, @config.keys 
     end
     

data/test/lightning_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/test_helper'
+require File.join(File.dirname(__FILE__), 'test_helper')
 
 class LightningTest < Test::Unit::TestCase
   context "Generator" do

data/test/test_helper.rb

@@ -3,8 +3,11 @@ 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.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'lightning'
+#set up valid global config file
+Lightning.config_file = File.join(File.dirname(__FILE__), 'lightning.yml') 
+
 
 class Test::Unit::TestCase
   def assert_arrays_equal(a1, a2)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cldwalker-lightning
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors: 
 - Gabriel Horner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-16 00:00:00 -08:00
+date: 2009-01-28 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -25,6 +25,8 @@ extra_rdoc_files:
 - README.markdown
 - LICENSE.txt
 files: 
+- Rakefile
+- VERSION.yml
 - lightning_completions.example
 - lightning.yml.example
 - README.markdown
@@ -36,16 +38,16 @@ files:
 - lib/lightning/bolt.rb
 - lib/lightning/bolts.rb
 - lib/lightning/completion.rb
+- lib/lightning/completion_map.rb
 - lib/lightning/config.rb
 - lib/lightning/core_extensions.rb
 - lib/lightning/generator.rb
-- lib/lightning/path_map.rb
 - lib/lightning.rb
+- test/bolt_test.rb
+- test/completion_map_test.rb
+- test/completion_test.rb
+- test/config_test.rb
 - test/lightning.yml
-- test/lightning_bolt_test.rb
-- test/lightning_completion_test.rb
-- test/lightning_config_test.rb
-- test/lightning_path_map_test.rb
 - test/lightning_test.rb
 - test/test_helper.rb
 has_rdoc: true

data/test/lightning_bolt_test.rb

@@ -1,27 +0,0 @@
-require File.dirname(__FILE__) + '/test_helper'
-
-class LightningBoltTest < Test::Unit::TestCase
-  context "Bolt" do
-    before(:each) do
-      @path_map = {'path1'=>'/dir/path1','path2'=>'/dir/path2'}
-      @bolt = Lightning::Bolt.new('blah')
-      @bolt.path_map.map = @path_map
-    end
-    
-    test "fetches correct completions" do
-      assert_equal @bolt.completions, @path_map.keys
-    end
-
-    test "resolves completion" do
-      assert_equal @path_map['path1'], @bolt.resolve_completion('path1')
-    end
-
-    test "resolves completion with test flag" do
-      assert_equal @path_map['path1'], @bolt.resolve_completion('-test path1')
-    end
-
-    test "creates path_map only once" do
-      assert_equal @bolt.path_map.object_id, @bolt.path_map.object_id
-    end
-  end
-end

data/test/lightning_completion_test.rb

@@ -1,23 +0,0 @@
-require File.dirname(__FILE__) + '/test_helper'
-
-class LightningCompletionTest < Test::Unit::TestCase
-  context "Completion" do
-    before(:each) {
-      @key = 'blah'; 
-      Lightning.bolts[@key].stub!(:completions, :return=>%w{at ap blah})
-    }
-    test "from script matches correctly" do
-      assert_arrays_equal Lightning::Completion.complete('cd-test a', @key), %w{at ap}
-    end
-    
-    test "for basic case matches correctly" do
-      @completion = Lightning::Completion.new('cd-test a', @key)
-      assert_arrays_equal @completion.matches, %w{at ap}
-    end
-    
-    test "with test flag matches correctly" do
-      @completion = Lightning::Completion.new('cd-test -test a', @key)
-      assert_arrays_equal @completion.matches, %w{at ap}
-    end
-  end
-end

data/test/lightning_path_map_test.rb

@@ -1,30 +0,0 @@
-require File.dirname(__FILE__) + '/test_helper'
-
-class LightningPathMapTest < Test::Unit::TestCase
-
-  context "PathMap" do    
-    def create_map(path_hash)
-      Dir.stub!(:glob) { path_hash.values }
-      @path_map = Lightning::PathMap.new('blah') 
-    end
-    
-    test "creates basic map" do
-      expected_map = {"path1"=>"/dir1/path1", "path2"=>"/dir1/path2"}
-      create_map(expected_map)
-      assert_equal expected_map, @path_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'), @path_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, @path_map.map
-    end    
-  end
-end