lightning 0.3.4 → 0.4.0

data/CHANGELOG.rdoc

@@ -1,3 +1,7 @@
+== 0.4.0
+* Add shell variables to globs
+* Allow globs to call generators to be used at runtime
+
 == 0.3.4
 * Fix lightning-reload and source_file command
 

data/README.rdoc

@@ -77,7 +77,7 @@ To install and view lightning's man page:
   $ man lightning
 
   # If installed with rubygems
-  $ sudo gem install gem-man
+  $ gem install gem-man
   $ gem man lightning
 
 == Bugs/Issues

data/lib/lightning/bolt.rb

@@ -29,9 +29,9 @@ module Lightning
       @globs = []
       @functions = []
       @aliases = {}
-      (Lightning.config.bolts[@name] || {}).each do |k,v|
-        instance_variable_set("@#{k}", v)
-      end
+      config = Lightning.config.bolts[@name] || {}
+      config.each { |k,v| instance_variable_set("@#{k}", v) }
+      @globs = Generator.run(@name, :live => true) unless config.key?('globs')
     end
 
     # Generates functions from a bolt's functions and global shell commands

data/lib/lightning/config.rb

@@ -19,7 +19,10 @@ module Lightning
   #     over name when generating function names.
   #   * *global*: true or false (default is false). When set, uses bolt to generate functions with each command
   #     in :shell_commands.
-  #   * *globs*(required): Array of globs which defines group of paths bolt handles
+  #   * *globs*(required): Array of globs which defines group of paths bolt handles. A glob can
+  #     any number of shell variables i.e. $HOME which are translated at runtime. If globs is not
+  #     present, lightning will generate them using a Lightning::Generator method with the same name as the
+  #     bolt, if it exists.
   #   * *functions*: Array of lightning functions. A function can either be a string (shell command with default
   #     options) or a hash with the following keys:
   #     * *name*: Name of the lightning function

data/lib/lightning/function.rb

@@ -37,13 +37,13 @@ module Lightning
 
     # @return [Array] Globs used to create {Function#completion_map completion_map}
     def globs
-      @globs ||= @bolt.globs
+      @globs ||= @bolt.globs.map {|g| gsub_shell_vars(g) }
     end
 
     # User-defined aliases for any path. Defaults to its bolt's aliases.
     # @return [Hash] Maps aliases to full paths
     def aliases
-      @aliases ||= @bolt.aliases
+      @aliases ||= Hash[@bolt.aliases.map {|k,v| [k, gsub_shell_vars(v)] }]
     end
 
     # @return [CompletionMap] Map of basenames to full paths used in completion
@@ -66,5 +66,11 @@ module Lightning
         new_arg
       }
     end
+
+    private
+    def gsub_shell_vars(str)
+      str.gsub(/\$(\w+)/) {|e| ENV[$1] }
+    end
+
   end
-end
+end

data/lib/lightning/generator.rb

@@ -17,6 +17,7 @@ module Lightning
     # @option options [String] :once Generator to run once
     # @option options [Boolean] :test Runs generators in test mode which only displays
     #   generated globs and doesn't save them
+    # @option options [Boolean] :live Generates globs for use at runtime
     def self.run(gens=[], options={})
       load_plugins
       new.run(gens, options)
@@ -43,6 +44,8 @@ module Lightning
     def run(gens, options)
       if options.key?(:once)
         run_once(gens, options)
+      elsif options.key?(:live)
+        Array(call_generator(gens, false))
       else
         gens = DEFAULT_GENERATORS if Array(gens).empty?
         gens = Hash[*gens.zip(gens).flatten] if gens.is_a?(Array)
@@ -72,11 +75,14 @@ module Lightning
       results.all?
     end
 
-    def call_generator(gen)
-      raise "Generator method doesn't exist." unless @underling.respond_to?(gen)
-      Array(@underling.send(gen)).map {|e| e.to_s }
+    def call_generator(gen, strict=true)
+      if @underling.respond_to?(gen)
+        Array(@underling.send(gen)).map {|e| e.to_s }
+      elsif strict
+        raise("Generator method doesn't exist.")
+      end
     rescue
       $stdout.puts "Generator '#{gen}' failed with: #{$!.message}"
     end
   end
-end
+end

data/lib/lightning/version.rb

@@ -1,3 +1,3 @@
 module Lightning
-  VERSION = '0.3.4'
+  VERSION = '0.4.0'
 end

data/test/bolt_commands_test.rb

@@ -19,7 +19,7 @@ context "bolt command" do
   end
 
   test 'list lists bolts and aliases with --alias' do
-    mock(Commands).print_sorted_hash({"app"=>nil, "wild_dir"=>"w"})
+    mock(Commands).print_sorted_hash({"app"=>nil, "wild_dir"=>"w", 'live_glob' => nil})
     bolt 'list', '--alias'
   end
 

data/test/function_commands_test.rb

@@ -15,7 +15,7 @@ context "function command" do
   end
 
   test "list lists functions with --bolt" do
-    mock(Commands).puts Lightning.functions.keys.sort
+    mock(Commands).puts Lightning.functions.keys.delete_if {|e| e[/live_glob/] }.sort
     function('list', '--bolt=app')
   end
 
@@ -119,4 +119,4 @@ context "function command" do
       function 'delete', 'zzz'
     end
   end
-end
+end

data/test/function_test.rb

@@ -1,90 +1,113 @@
 require File.join(File.dirname(__FILE__), 'test_helper')
 
 context "Function" do
+  # bolt, path and aliases depend on test/lightning.yml
   def create_function(attributes={})
-    # bolt, path and aliases depend on test/lightning.yml
-    @fn = Function.new({'name'=>'blah', 'bolt'=>Bolt.new('app'), 'desc'=>'blah'}.merge(attributes))
-    @fn.completion_map.map = {'path1'=>'/dir/path1','path2'=>'/dir/path2',
-      'path3'=>'/dir/path3', 'file 1'=>'/dir/file 1'}
+    Function.new({'name'=>'blah', 'bolt'=>Bolt.new('app'), 'desc'=>'blah'}.merge(attributes))
   end
 
-  def translate(input, *expected)
-    Lightning.functions['blah'] = @fn
-    mock(Commands).puts(expected.join("\n"))
-    run_command :translate, ['blah'] + input.split(' ')
-  end
+  context "basic function" do
+    def translate(*args); super(@fn, *args); end
+    def map; @fn.completion_map; end
 
-  before_all do
-    create_function
-    @map = @fn.completion_map
-  end
+    before do
+      @fn = create_function
+      @fn.completion_map.map = {'path1'=>'/dir/path1','path2'=>'/dir/path2',
+        'path3'=>'/dir/path3', 'file 1'=>'/dir/file 1'}
+    end
 
-  test "has correct completions" do
-    assert_arrays_equal %w{a1 a2}+['file 1']+%w{path1 path2 path3}, @fn.completions
-  end
+    test "has correct completions" do
+      assert_arrays_equal %w{a1 a2}+['file 1']+%w{path1 path2 path3}, @fn.completions
+    end
 
-  test "has bolt's globs" do
-    @fn.globs.should.not.be.empty?
-    @fn.globs.should == @fn.bolt.globs
-  end
+    test "has bolt's globs" do
+      @fn.globs.should.not.be.empty?
+      @fn.globs.should == @fn.bolt.globs
+    end
 
-  test "has bolt's aliases" do
-    @fn.aliases.should.not.be.empty?
-    @fn.aliases.should == @fn.bolt.aliases
-  end
+    test "has bolt's aliases" do
+      @fn.aliases.should.not.be.empty?
+      @fn.aliases.should == @fn.bolt.aliases
+    end
 
-  test "can have a desc" do
-    @fn.desc.should.not.be.empty?
-  end
+    test "can have a desc" do
+      @fn.desc.should.not.be.empty?
+    end
 
-  test "translates a completion" do
-    translate 'path1', @map['path1']
-  end
+    test "translates a completion" do
+      translate 'path1', map['path1']
+    end
 
-  test "translates multiple completions separately" do
-    translate 'path1 path2', @map['path1'], @map['path2']
-  end
+    test "translates multiple completions separately" do
+      translate 'path1 path2', map['path1'], map['path2']
+    end
 
-  test "translates instant multiple completions (..)" do
-    translate 'path.. blah a1', @map['path1'], @map['path2'], @map['path3'], 'blah', @map['a1']
-  end
+    test "translates instant multiple completions (..)" do
+      translate 'path.. blah a1', map['path1'], map['path2'], map['path3'], 'blah', map['a1']
+    end
 
-  test "translates instant multiple completions containing spaces" do
-    translate 'file..', @map['file 1']
-  end
+    test "translates instant multiple completions containing spaces" do
+      translate 'file..', map['file 1']
+    end
 
-  test "translates non-completion to same string" do
-    translate 'blah', 'blah'
-  end
+    test "translates non-completion to same string" do
+      translate 'blah', 'blah'
+    end
 
-  test "translates completion anywhere amongst non-completions" do
-    translate '-r path1', "-r", "#{@map['path1']}"
-    translate '-r path1 doc/', "-r", "#{@map['path1']}", "doc/"
-  end
+    test "translates completion anywhere amongst non-completions" do
+      translate '-r path1', "-r", "#{map['path1']}"
+      translate '-r path1 doc/', "-r", "#{map['path1']}", "doc/"
+    end
 
-  test "translates completion embedded in subdirectory completion" do
-    translate '-r path1/sub/dir', "-r", "#{@map['path1']}/sub/dir"
-  end
+    test "translates completion embedded in subdirectory completion" do
+      translate '-r path1/sub/dir', "-r", "#{map['path1']}/sub/dir"
+    end
 
-  test "translates completion with a superdirectory" do
-    mock(File).expand_path("#{@map['path1']}/../file1") { '/dir/file1' }
-    translate 'path1/../file1', '/dir/file1'
-  end
+    test "translates completion with a superdirectory" do
+      mock(File).expand_path("#{map['path1']}/../file1") { '/dir/file1' }
+      translate 'path1/../file1', '/dir/file1'
+    end
 
-  test "translates completion over alias" do
-    translate 'path3', '/dir/path3'
-  end
+    test "translates completion over alias" do
+      translate 'path3', '/dir/path3'
+    end
+
+    test "translates alias" do
+      translate 'a1', map['a1']
+    end
 
-  test "translates alias" do
-    translate 'a1', @map['a1']
+    after_all { config[:aliases] = {}}
   end
 
-  after_all { config[:aliases] = {}}
+  context "function with global variables" do
+    before { @fn = create_function; ENV['MY_HOME'] = '/my/home' }
+    after { ENV.delete 'MY_HOME' }
+
+    test "has globs that expand shell variables" do
+      orig = @fn.bolt.globs.dup
+      @fn.bolt.globs << '$MY_HOME/*.rc'
+      @fn.globs.should == orig << '/my/home/*.rc'
+    end
 
-  context "function attributes:" do
+    test "has aliases that expand shell variables" do
+      orig = @fn.bolt.aliases.dup
+      @fn.bolt.aliases['f'] = '$MY_HOME/file'
+      @fn.aliases.should == orig.merge('f' => '/my/home/file')
+    end
+  end
+
+  context "with" do
+    test "live globs" do
+      live_globs = %w{one two three}
+      Lightning::Generators.send(:define_method, :live_glob) { live_globs * 2 }
+      @fn = create_function 'bolt' => Bolt.new('live_glob')
+      @fn.globs.should == live_globs * 2
+    end
     test "post_path added after each translation" do
-      create_function 'post_path'=>'/rdoc/index.html'
-      translate '-r path1 path2', "-r", "/dir/path1/rdoc/index.html", "/dir/path2/rdoc/index.html"
+      @fn = create_function 'post_path'=>'/rdoc/index.html'
+      @fn.completion_map.map = {'path1'=>'/dir/path1','path2'=>'/dir/path2',
+        'path3'=>'/dir/path3', 'file 1'=>'/dir/file 1'}
+      translate @fn, '-r path1 path2', "-r", "/dir/path1/rdoc/index.html", "/dir/path2/rdoc/index.html"
     end
   end
 end

data/test/lightning.yml

@@ -29,7 +29,10 @@ bolts:
     globs:
       - /Applications/*.app
       - /Applications/Utilities/*.app
+  live_glob:
+    functions:
+    - cd
 shell_commands:
   vim: v
   grep: grep
-  cd: cd
+  cd: cd

data/test/test_helper.rb

@@ -35,6 +35,12 @@ module Helpers
   def slice_hash(*keys)
     keys.shift.reject { |key,| !keys.include?(key) }
   end
+
+  def translate(fn, input, *expected)
+    Lightning.functions['blah'] = fn
+    mock(Commands).puts(expected.join("\n"))
+    run_command :translate, ['blah'] + input.split(' ')
+  end
 end
 
 class Bacon::Context

metadata

@@ -2,7 +2,7 @@
 name: lightning
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors: 
 - Gabriel Horner
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-08 00:00:00 -04:00
+date: 2011-04-20 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -120,7 +120,7 @@ licenses:
 post_install_message: 
 rdoc_options: 
 - --title
-- Lightning 0.3.4 Documentation
+- Lightning 0.4.0 Documentation
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement