lightning 0.2.1

data/lib/lightning/completion.rb

@@ -0,0 +1,43 @@
+# derived from http://github.com/ryanb/dotfiles/tree/master/bash/completion_scripts/project_completion
+#This class handles completions given a path key and the text already typed.
+class Lightning
+  class Completion
+    def self.complete(text_to_complete, bolt_key)
+      new(text_to_complete, bolt_key).matches
+    end
+      
+    def initialize(text_typed, bolt_key)
+      @text_typed = text_typed
+      @bolt_key = bolt_key
+    end
+  
+    def matches
+      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] || ''
+      text = @text_typed[/^(\S+)\s+(#{Lightning::TEST_FLAG})?\s*(.+?)$/, 3] || ''
+      text.strip
+    end
+  
+    def possible_completions
+      Lightning.bolts[@bolt_key].completions
+    end    
+  end
+end

data/lib/lightning/completion_map.rb

@@ -0,0 +1,59 @@
+#This class maps completions to their full paths for the given blobs
+class Lightning
+  class CompletionMap
+    attr_accessor :map
+    attr_reader :alias_map
+    
+    def initialize(*globs)
+      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] || @alias_map[completion]
+     end
+     
+     def keys
+       (@map.keys + @alias_map.keys).uniq
+     end
+    
+    #should return hash
+    def create_map_for_globs(globs)
+      path_hash = {}
+      ignore_paths = ['.', '..'] + Lightning.ignore_paths
+      globs.each do |d|
+        Dir.glob(d, File::FNM_DOTMATCH).each do |e|
+          basename = File.basename(e)
+          unless ignore_paths.include?(basename)
+            #save paths of duplicate basenames to process later
+            if path_hash.has_key?(basename)
+              if path_hash[basename].is_a?(Array)
+                path_hash[basename] << e
+              else
+                path_hash[basename] = [path_hash[basename], e]
+              end
+            else
+              path_hash[basename] = e
+            end
+          end
+        end
+      end
+      map_duplicate_basenames(path_hash)
+      path_hash
+    end
+    
+    #map saved duplicates
+    def map_duplicate_basenames(path_hash)
+      path_hash.select {|k,v| v.is_a?(Array)}.each do |key,paths|
+        paths.each do |e|
+          new_key = "#{key}/#{File.dirname(e)}"
+          path_hash[new_key] = e
+        end
+        path_hash.delete(key)
+      end
+    end
+    
+  end
+end

data/lib/lightning/config.rb

@@ -0,0 +1,72 @@
+class Lightning  
+  class Config < ::Hash
+    class <<self
+      attr_accessor :config_file
+      def config_file
+        @config_file ||= (File.exists?('lightning.yml') ? 'lightning.yml' : File.expand_path(File.join("~",".lightning.yml")))
+      end
+
+      def create(options={})
+        hash = read_config_file
+        obj = new(hash)
+        configure_commands_and_paths(obj) if options[:read_only]
+        obj
+      end
+    
+      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 if file
+        hash = YAML::load_file(config_file)
+        default_config.merge(hash)
+      end
+      
+      def commands_to_bolt_key(map_to_command, new_command)
+        "#{map_to_command}-#{new_command}"
+      end
+
+      def configure_commands_and_paths(hash)
+        hash[:paths] ||= {}
+        hash[:commands].each do |e|
+          #mapping a referenced path
+          if e['paths'].is_a?(String)
+            e['bolt_key'] = e['paths'].dup
+          end
+          #create a path entry + key if none exists
+          if e['bolt_key'].nil?
+            #extract command in case it has options after it
+            e['map_to'] =~ /\s*(\w+)/
+            bolt_key = commands_to_bolt_key($1, e['name'])
+            e['bolt_key'] = bolt_key
+            hash[:paths][bolt_key] = e['paths'] || []
+          end
+        end
+        hash
+      end
+    end
+    
+    def save
+      File.open(self.class.config_file, "w") { |f| f.puts self.to_hash.to_yaml }
+    end
+
+    def initialize(hash)
+      super
+      replace(hash)
+      self.replace(self.symbolize_keys)
+    end
+    
+    def to_hash
+      hash = Hash.new
+      hash.replace(self)
+    end
+    
+    #from Rails' ActiveSupport
+    def symbolize_keys
+      inject({}) do |options, (key, value)|
+        options[(key.to_sym rescue key) || key] = value
+        options
+      end
+    end
+    
+  end
+end

data/lib/lightning/generator.rb

@@ -0,0 +1,48 @@
+#This class generates shell scripts from a configuration.
+class Lightning
+  class Generator
+    class<<self
+    def generate_completions(generated_file=nil)
+      generated_file ||= Lightning.config[:generated_file]
+      output = generate(Lightning.config[:shell], Lightning.config[:commands])
+      File.open(generated_file, 'w'){|f| f.write(output) }
+      output
+    end
+          
+    def generate(*args)
+      shell = args.shift
+      send("#{shell}_generator", *args)
+    end
+    
+    def bash_generator(commands)
+      body = <<-INIT
+      #### This file was generated by Lightning. ####
+      #LBIN_PATH="$PWD/bin/" #only use for development
+      LBIN_PATH="" 
+      
+      INIT
+      commands.each do |e|
+        body += <<-EOS
+          
+          #{'#' + e['description'] if e['description']}
+          #{e['name']} () {
+            if [ -z "$1" ]; then
+              echo "No arguments given"
+              return
+            fi
+            FULL_PATH="`${LBIN_PATH}lightning-full_path #{e['name']} $@`#{e['post_path'] if e['post_path']}"
+            if [ $1 == '#{Lightning::TEST_FLAG}' ]; then
+              CMD="#{e['map_to']} '$FULL_PATH'#{' '+ e['add_to_command'] if e['add_to_command']}"
+              echo $CMD
+            else
+              #{e['map_to']} "$FULL_PATH"#{' '+ e['add_to_command'] if e['add_to_command']}
+            fi
+          }
+          complete -o default -C "${LBIN_PATH}lightning-complete #{e['name']}" #{e['name']}
+        EOS
+      end
+      body.gsub(/^\s{6,10}/, '')
+    end
+    end
+  end
+end

data/lightning.yml.example

@@ -0,0 +1,87 @@
+---
+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/*

data/lightning_completions.example

@@ -0,0 +1,147 @@
+#### This file was generated by Lightning. ####
+#LBIN_PATH="$PWD/bin/" #only use for development
+LBIN_PATH="" 
+       
+#my code directories
+c () {
+  if [ -z "$1" ]; then
+    echo "No arguments given"
+    return
+  fi
+  FULL_PATH="`${LBIN_PATH}lightning-full_path cd-c $@`"
+  if [ $1 == '-test' ]; then
+    CMD="cd '$FULL_PATH'"
+    echo $CMD
+  else
+    cd "$FULL_PATH"
+  fi
+}
+complete -o default -C "${LBIN_PATH}lightning-complete cd-c" c
+
+
+cd-g () {
+  if [ -z "$1" ]; then
+    echo "No arguments given"
+    return
+  fi
+  FULL_PATH="`${LBIN_PATH}lightning-full_path gem $@`"
+  if [ $1 == '-test' ]; then
+    CMD="cd '$FULL_PATH'"
+    echo $CMD
+  else
+    cd "$FULL_PATH"
+  fi
+}
+complete -o default -C "${LBIN_PATH}lightning-complete gem" cd-g
+
+
+m-g () {
+  if [ -z "$1" ]; then
+    echo "No arguments given"
+    return
+  fi
+  FULL_PATH="`${LBIN_PATH}lightning-full_path gem $@`"
+  if [ $1 == '-test' ]; then
+    CMD="mate '$FULL_PATH'"
+    echo $CMD
+  else
+    mate "$FULL_PATH"
+  fi
+}
+complete -o default -C "${LBIN_PATH}lightning-complete gem" m-g
+
+#open gem's doc in browser
+o-g () {
+  if [ -z "$1" ]; then
+    echo "No arguments given"
+    return
+  fi
+  FULL_PATH="`${LBIN_PATH}lightning-full_path gem_rdoc $@`/rdoc/index.html"
+  if [ $1 == '-test' ]; then
+    CMD="open '$FULL_PATH'"
+    echo $CMD
+  else
+    open "$FULL_PATH"
+  fi
+}
+complete -o default -C "${LBIN_PATH}lightning-complete gem_rdoc" o-g
+
+#ruby core files
+v-r () {
+  if [ -z "$1" ]; then
+    echo "No arguments given"
+    return
+  fi
+  FULL_PATH="`${LBIN_PATH}lightning-full_path vim-v-r $@`"
+  if [ $1 == '-test' ]; then
+    CMD="vim '$FULL_PATH'"
+    echo $CMD
+  else
+    vim "$FULL_PATH"
+  fi
+}
+complete -o default -C "${LBIN_PATH}lightning-complete vim-v-r" v-r
+
+#ruby core directories
+cd-r () {
+  if [ -z "$1" ]; then
+    echo "No arguments given"
+    return
+  fi
+  FULL_PATH="`${LBIN_PATH}lightning-full_path cd-cd-r $@`"
+  if [ $1 == '-test' ]; then
+    CMD="cd '$FULL_PATH'"
+    echo $CMD
+  else
+    cd "$FULL_PATH"
+  fi
+}
+complete -o default -C "${LBIN_PATH}lightning-complete cd-cd-r" cd-r
+
+#open mac applications
+oa () {
+  if [ -z "$1" ]; then
+    echo "No arguments given"
+    return
+  fi
+  FULL_PATH="`${LBIN_PATH}lightning-full_path open-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 open-oa" oa
+
+#open files when in the base directory of a ruby gem project
+v-g () {
+  if [ -z "$1" ]; then
+    echo "No arguments given"
+    return
+  fi
+  FULL_PATH="`${LBIN_PATH}lightning-full_path vim-v-g $@`"
+  if [ $1 == '-test' ]; then
+    CMD="vim '$FULL_PATH'"
+    echo $CMD
+  else
+    vim "$FULL_PATH"
+  fi
+}
+complete -o default -C "${LBIN_PATH}lightning-complete vim-v-g" v-g
+
+#open files when in the base directory of a rails project
+v-rr () {
+  if [ -z "$1" ]; then
+    echo "No arguments given"
+    return
+  fi
+  FULL_PATH="`${LBIN_PATH}lightning-full_path vim-v-rr $@`"
+  if [ $1 == '-test' ]; then
+    CMD="vim '$FULL_PATH'"
+    echo $CMD
+  else
+    vim "$FULL_PATH"
+  fi
+}
+complete -o default -C "${LBIN_PATH}lightning-complete vim-v-rr" v-rr