lightning 0.3.1 → 0.3.2

data/test/function_commands_test.rb

@@ -0,0 +1,122 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+context "function command" do
+  def function(*args)
+    run_command :function, args
+  end
+
+  def command_should_print(action, fn)
+    mock(Commands).save_and_say("#{action} function '#{fn}'")
+  end
+
+  test "list lists functions" do
+    mock(Commands).puts Lightning.functions.keys.sort
+    function('list')
+  end
+
+  test "list lists functions with --bolt" do
+    mock(Commands).puts Lightning.functions.keys.sort
+    function('list', '--bolt=app')
+  end
+
+  test "list lists functions with --command" do
+    mock(Commands).puts ['less-app']
+    function('list', '--command=less')
+  end
+
+  context "create:" do
+    test "creates a function" do
+      command_should_print 'Created', 'cp-app'
+      function 'create', 'cp', 'app'
+      config.bolts['app']['functions'][-1].should == {'name'=>'cp-app', 'shell_command'=>'cp'}
+    end
+
+    test "creates a function with an aliased bolt" do
+      command_should_print 'Created', 'grep-w'
+      function 'create', 'grep', 'w'
+      config.bolts['wild_dir']['functions'][-1].should == 'grep'
+    end
+
+    test "creates a function with an aliased global command" do
+      command_should_print 'Created', 'v-w'
+      function 'create', 'vim', 'wild_dir'
+      config.bolts['wild_dir']['functions'][-1].should == 'vim'
+    end
+
+    test "creates a function similar to a global function" do
+      command_should_print 'Created', 'vapp'
+      function 'create', 'vim', 'app', 'vapp'
+      config.bolts['app']['functions'][-1].should == {"name"=>"vapp", "shell_command"=>"vim"}
+    end
+
+    test "creates a function with explicit function name" do
+      command_should_print 'Created', 'eap'
+      function 'create', 'emacs', 'app', 'eap'
+      config.bolts['app']['functions'][-1].should == {"name"=>"eap", "shell_command"=>"emacs"}
+    end
+
+    test "fails to generate a bolt and doesn't create a function" do
+      mock(Generator).run('bin', :once=>'bin') { false }
+      mock(Commands).create_function(anything, anything, anything).never
+      function 'create', 'less', 'bin'
+    end
+
+    test "generates a bolt and creates a function" do
+      mock(Generator).run('bin', :once=>'bin') { true }
+      mock(Commands).create_function(anything, anything, anything)
+      function 'create', 'less', 'bin'
+    end
+
+    test "prints error if trying to create a function with an existing name" do
+      mock(Commands).puts(/'less-app'.*exists/)
+      function 'create', 'less', 'app'
+    end
+  end
+
+  # deletes functions created in create context
+  context "delete:" do
+    # reloads bolts/functions
+    before_all { Lightning.functions = nil; Lightning.bolts.delete_if { true } }
+
+    def function_count(bolt)
+      config.bolts[bolt]['functions'].size
+    end
+
+    context "deletes" do
+      before { @previous_count = function_count('app') }
+      after { function_count('app').should == @previous_count - 1 }
+
+      test "a function" do
+        command_should_print 'Deleted', 'cp-app'
+        function 'delete', 'cp-app'
+      end
+
+      test "a function with an aliased global command" do
+        command_should_print 'Deleted', 'v-app'
+        function 'delete', 'v-app'
+      end
+
+      test "a function with explicit name" do
+        command_should_print 'Deleted', 'eap'
+        function 'delete', 'eap'
+      end
+    end
+
+    test "deletes a function with an aliased bolt" do
+      @previous_count = function_count('wild_dir')
+      command_should_print 'Deleted', 'grep-w'
+      function 'delete', 'grep-w'
+      function_count('wild_dir').should == @previous_count - 1
+    end
+
+    test "prints error if global function" do
+      mock(Commands).puts /Can't.*'grep-app'/, anything
+      function 'delete', 'grep-app'
+    end
+
+    test "prints error for nonexistent function" do
+      mock(Commands).puts /Can't.*'zzz'/
+      function 'delete', 'zzz'
+    end
+  end
+end

data/test/function_test.rb

@@ -79,7 +79,7 @@ context "Function" do
     translate 'a1', @map['a1']
   end
 
-  after_all { Lightning.config[:aliases] = {}}
+  after_all { config[:aliases] = {}}
 
   context "function attributes:" do
     test "post_path added after each translation" do

data/test/generator_test.rb

@@ -2,72 +2,104 @@ require File.join(File.dirname(__FILE__), 'test_helper')
 
 context "Generator" do
 
-  def temporary_config_file
-    old_config = Lightning.config
-    old_config_file = Lightning::Config.config_file
-    new_config_file = File.dirname(__FILE__) + '/another_lightning.yml'
-    Lightning::Config.config_file = new_config_file
-    yield(new_config_file)
-    Lightning::Config.config_file = old_config_file
-    Lightning.config = old_config
-    FileUtils.rm_f new_config_file
-  end
-
   def generate(*args)
-    args[-1].is_a?(Hash) ? args.pop : {}
-    Generator.run args, {}
+    Generator.run *args
   end
 
-  test "generates default generators when none given" do
-    stub.instance_of(Generator).call_generator { [] }
-    temporary_config_file do |config_file|
+  context "#run" do
+    def temporary_config_file
+      old_config = config
+      old_config_file = Lightning::Config.config_file
+      new_config_file = File.dirname(__FILE__) + '/another_lightning.yml'
+      Lightning::Config.config_file = new_config_file
+      yield(new_config_file)
+      Lightning::Config.config_file = old_config_file
+      Lightning.config = old_config
+      FileUtils.rm_f new_config_file
+    end
+
+    test "generates default generators when none given" do
+      stub.instance_of(Generator).call_generator { [] }
+      temporary_config_file do |config_file|
+        generate
+        conf = YAML::load_file(config_file)
+        Generator::DEFAULT_GENERATORS.all? {|e| conf[:bolts].key?(e) }.should == true
+      end
+    end
+
+    test "generates given generators" do
+      mock.instance_of(Generator).generate_bolts('gem'=>'gem')
+      generate ['gem']
+    end
+
+    test "handles unexpected error while generating bolts" do
+      mock.instance_of(Generator).generate_bolts(anything) { raise "Totally unexpected" }
+      mock($stderr).puts(/Error: Totally/)
       generate
-      config = YAML::load_file(config_file)
-      Generator::DEFAULT_GENERATORS.all? {|e| config[:bolts].key?(e) }.should == true
     end
   end
 
-  test "generates given generators" do
-    mock.instance_of(Generator).generate_bolts('gem'=>'gem')
-    generate 'gem'
-  end
+  context "#generate_bolts" do
+    test "prints error for invalid generator" do
+      mock($stdout).puts /'bad' failed.*exist/
+      generate ['bad']
+    end
 
-  # test "prints nonexistant generators while continuing with good generators" do
-  #   stub.instance_of(Generator).underling.stub(send) { {} } #`
-  #   capture_stdout {
-  #     generate :gem, :bad
-  #   }.should =~ /^Generator 'bad' failed/
-  # end
-
-  test "handles unexpected error while generating bolts" do
-    mock.instance_of(Generator).generate_bolts(anything) { raise "Totally unexpected" }
-    mock($stderr).puts(/Error: Totally/)
-    generate :gem
-  end
+    test "handles valid and invalid generators" do
+      mock($stdout).puts /'bad' failed.*exist/
+      mock(config).save
+      generate ['wild', 'bad']
+    end
+
+    context "generates" do
+      before_all {
+        @old_bolts = config[:bolts]
+        config[:bolts]['overwrite'] = {'globs'=>['overwrite me']}
+        Generators.send(:define_method, :user_bolt) { ['glob1', 'glob2'] }
+        Generators.send(:define_method, :overwrite) { ['overwritten'] }
+        mock(config).save
+        generate ['wild', 'user_bolt', 'overwrite']
+      }
+
+      test "a default bolt" do
+        config[:bolts]['wild']['globs'].should == ['**/*']
+      end
+
+      test "a user-specified bolt" do
+        config[:bolts]['user_bolt']['globs'].should == ['glob1', 'glob2']
+      end
 
-  context "generates" do
-    before_all {
-      Lightning.config[:bolts]['overwrite'] = {'globs'=>['overwrite me']}
-      Generators.send(:define_method, :user_bolt) { ['glob1', 'glob2'] }
-      Generators.send(:define_method, :overwrite) { ['overwritten'] }
-      mock(Lightning.config).save
-      generate 'wild', 'user_bolt', 'overwrite'
-    }
-
-    test "a default bolt" do
-      Lightning.config[:bolts]['wild']['globs'].should == ['**/*']
+      test "and overwrites existing bolts" do
+        config[:bolts]['overwrite']['globs'].should == ["overwritten"]
+      end
+
+      test "and preserves bolts that aren't being generated" do
+        config[:bolts]['app'].class.should == Hash
+      end
+
+      after_all { config[:bolts] = @old_bolts }
     end
+  end
+
+  context "#run with :once" do
+    before_all { @old_bolts = config[:bolts] }
 
-    test "a user-specified bolt" do
-      Lightning.config[:bolts]['user_bolt']['globs'].should == ['glob1', 'glob2']
+    test "and :test generates a test run" do
+      mock($stdout).puts ['**/*']
+      generate 'wild', :once=>nil, :test=>true
     end
 
-    test "and overwrites existing bolts" do
-      Lightning.config[:bolts]['overwrite']['globs'].should == ["overwritten"]
+    test "generates a valid bolt" do
+      mock($stdout).puts /Generated following/, ["  **/*"]
+      mock(config).save
+      generate 'wild', :once=>nil
     end
 
-    test "and preserves bolts that aren't being generated" do
-      Lightning.config[:bolts]['app'].class.should == Hash
+    test "and explicit generator generates a valid bolt" do
+      mock($stdout).puts /Generated following/, ["  **/*"]
+      mock(config).save
+      generate 'blah', :once=>'wild'
     end
+    after_all { config[:bolts] = @old_bolts }
   end
 end

data/test/lightning.yml

@@ -6,6 +6,10 @@ ignore_paths:
 - .git
 
 bolts: 
+  wild_dir:
+    globs: 
+    - **/
+    alias: w
   app:
     global: true
     functions:

data/test/shell_command_commands_test.rb

@@ -0,0 +1,43 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+context "shell_command command" do
+  def shell_command(*args)
+    run_command :shell_command, args
+  end
+
+  test "lists shell commands" do
+    mock(Commands).puts config.global_commands.sort
+    shell_command('list')
+  end
+
+  context "create" do
+    test "prints error if command alias already exists" do
+      mock(Commands).puts(/Alias/)
+      shell_command 'create', 'cd'
+    end
+
+    test "creates a shell command" do
+      mock(Commands).save_and_say /^Created.*'man'/
+      shell_command 'create', 'man'
+      config.shell_commands['man'].should == 'man'
+    end
+
+    test "creates a shell command with alias" do
+      mock(Commands).save_and_say /Created.*'man'/
+      shell_command 'create', 'man', 'm'
+      config.shell_commands['man'].should == 'm'
+    end
+  end
+
+  test "delete deletes a shell command" do
+    mock(Commands).save_and_say /Deleted.*'man'/
+    config.shell_commands['man'].should.not.be.empty
+    shell_command 'delete', 'man'
+    config.shell_commands['man'].should.be.nil
+  end
+
+  test "delete prints error if nonexistent shell command" do
+    mock(Commands).puts /Can't.*'doy'/
+    shell_command 'delete', 'doy'
+  end
+end

data/test/test_helper.rb

@@ -6,6 +6,10 @@ Lightning::Config.config_file = File.join(File.dirname(__FILE__), 'lightning.yml
 include Lightning
 
 module Helpers
+  def config
+    Lightning.config
+  end
+
   def run_command(command, args=[])
     Commands.run([command] + args)
   end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - Gabriel Horner
@@ -14,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-09 00:00:00 -04:00
+date: 2010-04-13 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
-description: Lightning is a commandline framework that changes how you use paths in your filesystem. Lightning generates shell functions which wrap any command with the ability to autocomplete and interpret paths simply by their basenames. With these functions you don't have to ever type the full path to any file for any command again.
+description: Lightning is a commandline framework that lets users wrap commands with shell functions that are able to refer to any filesystem path by its basename. To achieve this, a group of paths to be translated are defined with shell globs. These shell globs, known as a lightning _bolt_, are then applied to commands to produce functions. In addition to translating basenames to full paths, lightning _functions_ can autocomplete these basenames, resolve conflicts if they have the same name, leave any non-basename arguments untouched, and autocomplete directories above and below a basename.
 email: gabriel.horner@gmail.com
 executables: 
 - lightning
@@ -56,15 +56,21 @@ files:
 - lib/lightning/generators/ruby.rb
 - lib/lightning/util.rb
 - lib/lightning/version.rb
+- man/lightning.1
+- man/lightning.1.ronn
+- test/bolt_commands_test.rb
 - test/bolt_test.rb
 - test/builder_test.rb
 - test/commands_test.rb
 - test/completion_map_test.rb
 - test/completion_test.rb
 - test/config_test.rb
+- test/core_commands_test.rb
+- test/function_commands_test.rb
 - test/function_test.rb
 - test/generator_test.rb
 - test/lightning.yml
+- test/shell_command_commands_test.rb
 - test/test_helper.rb
 has_rdoc: yard
 homepage: http://tagaholic.me/lightning
@@ -73,7 +79,7 @@ licenses: []
 post_install_message: 
 rdoc_options: 
 - --title
-- Lightning 0.3.1 Documentation
+- Lightning 0.3.2 Documentation
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -98,12 +104,16 @@ signing_key:
 specification_version: 3
 summary: Lightning is a commandline framework that generates shell functions which wrap around commands to autocomplete and translate full paths by their basenames.
 test_files: 
+- test/bolt_commands_test.rb
 - test/bolt_test.rb
 - test/builder_test.rb
 - test/commands_test.rb
 - test/completion_map_test.rb
 - test/completion_test.rb
 - test/config_test.rb
+- test/core_commands_test.rb
+- test/function_commands_test.rb
 - test/function_test.rb
 - test/generator_test.rb
+- test/shell_command_commands_test.rb
 - test/test_helper.rb