lightning 0.2.1 → 0.3.0

data/test/generator_test.rb

@@ -0,0 +1,73 @@
+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, {}
+  end
+
+  test "generates default generators when none given" do
+    stub.instance_of(Generator).call_generator { [] }
+    temporary_config_file do |config_file|
+      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
+
+  # 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
+
+  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 == ['**/*']
+    end
+
+    test "a user-specified bolt" do
+      Lightning.config[:bolts]['user_bolt']['globs'].should == ['glob1', 'glob2']
+    end
+
+    test "and overwrites existing bolts" do
+      Lightning.config[:bolts]['overwrite']['globs'].should == ["overwritten"]
+    end
+
+    test "and preserves bolts that aren't being generated" do
+      Lightning.config[:bolts]['app'].class.should == Hash
+    end
+  end
+end

data/test/lightning.yml

@@ -1,39 +1,31 @@
 ---
-generated_file: lightning_completions
+source_file: lightning_completions
 
 ignore_paths:
-    - .DS_Store
-    - .git
+- .DS_Store
+- .git
 
-#only oa command is currently used
-commands:
+bolts: 
+  app:
+    global: true
+    functions:
+    - shell_command: more
+      name: bling
+    - less
+    - shell_command: cd
+      name : c
     - 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/*
+      shell_command : open -a
+      desc : open mac applications
+    aliases:
+      a1: /dir/a1
+      a2: /dir/a2
+      path3: /dir/a3
+    desc: Desktop applications
+    globs:
+      - /Applications/*.app
+      - /Applications/Utilities/*.app
+shell_commands:
+  vim: v
+  grep: grep
+  cd: cd

data/test/test_helper.rb

@@ -1,24 +1,89 @@
-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 'bacon'
+require 'rr'
 require 'lightning'
 #set up valid global config file
-Lightning::Config.config_file = File.join(File.dirname(__FILE__), 'lightning.yml') 
+Lightning::Config.config_file = File.join(File.dirname(__FILE__), 'lightning.yml')
+include Lightning
 
-
-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
+module Helpers
+  def run_command(command, args=[])
+    Commands.run([command] + args)
   end
   
+  def assert_arrays_equal(a1, a2)
+    a1.map {|e| e.to_s}.sort.should == a2.map{|e| e.to_s}.sort
+  end
+
+  def capture_stdout(&block)
+    original_stdout = $stdout
+    $stdout = fake = StringIO.new
+    begin
+      yield
+    ensure
+      $stdout = original_stdout
+    end
+    fake.string
+  end
+
+  # from ActiveSupport
+  def slice_hash(*keys)
+    keys.shift.reject { |key,| !keys.include?(key) }
+  end
 end
 
-#from ActiveSupport
-class Hash
-  def slice(*keys)
-    reject { |key,| !keys.include?(key) }
+module BaconExtensions
+  def self.included(mod)
+    mod.module_eval do
+      # nested context methods automatically inherit methods from parent contexts
+      def describe(*args, &block)
+        context = Bacon::Context.new(args.join(' '), &block)
+        (parent_context = self).methods(false).each {|e|
+          class<<context; self end.send(:define_method, e) {|*args| parent_context.send(e, *args)}
+        }
+        @before.each { |b| context.before(&b) }
+        @after.each { |b| context.after(&b) }
+        context.run
+      end
+    end
   end
+
+  def xtest(*args); end
+  def xcontext(*args); end
+  def before_all; yield; end
+  def after_all; yield; end
+  def assert(description, &block)
+    it(description) do
+      block.call.should == true
+    end
+  end
+end
+
+class Bacon::Context
+  include Helpers
+  include BaconExtensions
+
+  # RR adapter
+  def self.silent?
+    @silent ||= class << Bacon; self; end.ancestors.include?(Bacon::TestUnitOutput)
+  end
+  include RR::Adapters::RRMethods
+  RR.trim_backtrace = true
+  alias_method :old_it, :it
+	def it(description)
+    old_it(description) do
+      # Add at least one requirement to ensure mock-only tests don't fail
+      Bacon::Counter[:requirements] += 1
+      yield
+      Bacon::Counter[:requirements] -= 1 if RR.double_injections.size.zero?
+      RR.verify unless self.class.silent?
+      RR.reset
+    end
+	end
+
+  alias_method :test, :it
+  alias_method :context, :describe
 end
+
+class <<self
+  alias_method :context, :describe
+end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: lightning
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Gabriel Horner
@@ -9,16 +14,16 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-23 00:00:00 -04:00
+date: 2010-04-09 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.
+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.
 email: gabriel.horner@gmail.com
 executables: 
+- lightning
 - lightning-complete
-- lightning-full_path
-- lightning-install
+- lightning-translate
 extensions: []
 
 extra_rdoc_files: 
@@ -29,59 +34,76 @@ files:
 - LICENSE.txt
 - README.rdoc
 - Rakefile
-- VERSION.yml
+- bin/lightning
 - bin/lightning-complete
-- bin/lightning-full_path
-- bin/lightning-install
+- bin/lightning-translate
 - lib/lightning.rb
 - lib/lightning/bolt.rb
-- lib/lightning/bolts.rb
+- lib/lightning/builder.rb
 - lib/lightning/commands.rb
+- lib/lightning/commands/bolt.rb
+- lib/lightning/commands/core.rb
+- lib/lightning/commands/function.rb
+- lib/lightning/commands/shell_command.rb
+- lib/lightning/commands_util.rb
 - lib/lightning/completion.rb
 - lib/lightning/completion_map.rb
 - lib/lightning/config.rb
+- lib/lightning/function.rb
 - lib/lightning/generator.rb
-- lightning.yml.example
-- lightning_completions.example
+- lib/lightning/generators.rb
+- lib/lightning/generators/misc.rb
+- lib/lightning/generators/ruby.rb
+- lib/lightning/util.rb
+- lib/lightning/version.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/function_test.rb
+- test/generator_test.rb
 - test/lightning.yml
-- test/lightning_test.rb
 - test/test_helper.rb
-has_rdoc: true
-homepage: http://github.com/cldwalker/lightning
+has_rdoc: yard
+homepage: http://tagaholic.me/lightning
 licenses: []
 
 post_install_message: 
 rdoc_options: 
-- --charset=UTF-8
+- --title
+- Lightning 0.3.0 Documentation
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: tagaholic
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Path completions for your shell that will let you navigate like lightning.
+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_test.rb
+- test/builder_test.rb
+- test/commands_test.rb
 - test/completion_map_test.rb
 - test/completion_test.rb
 - test/config_test.rb
-- test/lightning_test.rb
+- test/function_test.rb
+- test/generator_test.rb
 - test/test_helper.rb

data/VERSION.yml

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

data/bin/lightning-full_path

@@ -1,18 +0,0 @@
-#!/usr/bin/env ruby
-
-# == Description
-# Used by path completion functions to return first possible full path which matches the given basename for the given command.
-
-require File.expand_path(File.join(File.dirname(__FILE__), "..","lib","lightning"))
-
-command = ARGV.shift 
-if command.nil?
-  puts "No command given"
-  exit 1
-end
-if ARGV.empty?
-  puts "No arguments given" 
-  exit 1
-end
-puts Lightning.translate(command, ARGV)
-exit 0

data/bin/lightning-install

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-
-# == Description
-# Used to generate shell file from configuration
-
-require File.expand_path(File.join(File.dirname(__FILE__), "..","lib","lightning"))
-Lightning::Generator.generate_completions ARGV.shift

data/lib/lightning/bolts.rb

@@ -1,12 +0,0 @@
-# Hash of bolts accessed by their keys
-class Lightning
-  class Bolts
-    def initialize
-      @hash = {}
-    end
-  
-    def [](key)
-      @hash[key] ||= Lightning::Bolt.new(key)
-    end    
-  end
-end

data/lightning.yml.example

@@ -1,87 +0,0 @@
----
-generated_file: lightning_completions
-
-ignore_paths:
-    - .DS_Store
-    - .git
-
-# You'll notice that most commands have the format of "#{original_command_alias}-#{path_alias}"
-# I recommend this for most of these commands as you can then easily autocomplete them for recall.
-commands:
-    - name : c
-      map_to : cd
-      description : my code directories
-      paths: 
-        - /Users/bozo/code/gems/*
-        - /Users/bozo/code/repo/*
-        - /Users/bozo/code/tds/gems/*
-        
-    - name : cd-g
-      map_to : cd
-      paths: gem
-      
-    - name : m-g
-      map_to : mate
-      paths: gem
-      
-    - name : o-g
-      map_to : open
-      description : open gem's doc in browser
-      post_path : /rdoc/index.html
-      paths: gem_rdoc
-    
-    - name : v-r
-      map_to : vim
-      description : ruby core files
-      paths: 
-      #picked from $LOAD_PATH
-        - /Library/Ruby/Site/1.8/**/*.rb
-        - /System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/**/*.rb
-
-    - name : cd-r
-      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/**/
-      aliases:
-        r1: /System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8
-    
-    - name : oa
-      map_to : open -a
-      description : open mac applications
-      paths:
-        - /Applications/*.app
-        - /Applications/Utilities/*.app
-        
-    - name : v-g
-      map_to : vim
-      description : open files when in the base directory of a ruby gem project
-      paths:
-        - lib/**/*.rb
-        - test/**/*.rb
-        - spec/**/*.rb
-        - bin/**
-    
-    - name : v-rr
-      map_to : vim
-      description: open files when in the base directory of a rails project
-      paths:
-        - config/**/*.rb
-        - app/**/*.{rb,erb,rhtml}
-        - lib/**/*.rb
-        - test/**/*.rb
-        - spec/**/*.rb
-      
-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/*