qwandry 0.0.1

data/README.markdown

@@ -0,0 +1,33 @@
+Qwandry, a questionable tool
+=============================
+
+Why spend time trying to remember where libraries, projects, and packages are 
+lurking when your computer can do it faster?
+
+		qw matrix	       # opens ruby's matrix class in your editor
+		qw rails         # will ask you which version of rails you want to open
+		qw activerec 3.1 # will find the gem activerecord 3.1 and open it
+		
+Installation
+------------
+Qwandry is a standard ruby gem, on any system with ruby installed already 
+simply install with:
+
+    gem install qwandry
+
+Usage
+-----
+Just type `qw` and the first few letters of what you're looking for.  By 
+default Qwandry is set up for locating and editing ruby libraries.
+
+    qw date # opens ruby's date library
+
+Want to use Qwandry with Python, Perl, or other languages?
+
+    qw --customize 
+
+Contact
+-------
+Adam Sanderson, netghost@gmail.com
+
+Issues and Source: https://github.com/adamsanderson/qwandry

data/Rakefile

@@ -0,0 +1,33 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "qwandry"
+    s.summary = "Qwandry lets you quickly edit ruby gems and libraries"
+    s.description = <<-DESC
+      Open a gem or library's source directory with your default editor.
+    DESC
+    s.email = "netghost@gmail.com"
+    s.homepage = "http://github.com/adamsanderson/qwandry"
+    s.authors = ["Adam Sanderson"]
+    s.has_rdoc = false
+    s.files = FileList["[A-Z]*", "{bin,lib,test}/**/*"]
+    
+    # Testing
+    s.test_files = FileList["test/**/*_test.rb"]
+  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
+
+task :default => :test

data/TODO

@@ -0,0 +1,7 @@
+TODO, or perhaps not...
+
+- Differentiate multiple similar matches (show path or repository label)
+- Allow better customization of repositories
+  - Customize collection phase (see LibraryRepository)
+  - Customize naming phase
+- Match multiword args, ie: 'activerec 3.' => 'activerec*3.*' => 'activerecord-3.0.3' @done

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/qw

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+# Add qwandry's library to the load path
+$:.unshift File.dirname(__FILE__) + '/../lib'
+# Require it
+require "qwandry.rb"
+
+# Create launcher
+@qwandry = Qwandry::Launcher.new
+
+opts = OptionParser.new do |opts|    
+  opts.banner = "Usage: qwandry [options] name"
+  opts.separator ""
+  
+  opts.on("-r", "--repo LABELS", Array, "Search in LABELS, default: #{@qwandry.active.to_a.join(',')}","Available Repositories:", *@qwandry.repositories.keys.map{|k| "  #{k}"}) do |labels|
+    @qwandry.active.replace(labels)
+  end
+  
+  opts.separator ""
+  opts.on("-e", "--editor EDITOR", "Use EDITOR to open the package") do |editor|
+    @editor = editor
+  end
+  
+  opts.separator "Additional Commands"
+  
+  opts.on("--paths", "Prints all repositories and their paths") do
+    @qwandry.repositories.each do |label, entries|
+      puts "#{label} #{"[default]" if @qwandry.active.include? label}"
+      entries.each do |repo|
+        puts "\t#{repo.path} (#{repo.class.to_s.split('::').last})"
+      end
+      puts ""
+    end
+    exit(0)
+  end
+  
+  opts.on("--customize", "Create and edit files for customizing Qwandry") do
+    dir = ENV['HOME'] && ENV['HOME'] + '/.qwandry/'
+    if !dir
+      puts "Home directory must be defined."
+      exit(1)
+    else
+      FileUtils.mkdir(dir, :verbose=>true) unless File.exist?(dir)
+      Dir[File.dirname(__FILE__) + '/../templates/*'].each do |path|
+        FileUtils.cp(path, dir, :verbose=>true, :preserve=>true)
+      end
+      @qwandry.launch dir
+    end
+    exit(0)
+  end
+  
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end
+
+opts.parse! ARGV
+if ARGV.length == 0
+  puts opts
+  exit(1)
+end
+
+# Configure default values
+@qwandry.editor = @editor if @editor
+
+name = ARGV.join(' ')
+packages = @qwandry.find(*ARGV)
+ARGV.clear # for the gets below
+
+package = nil
+case packages.length
+when 0
+  puts "No packages matched '#{name}'"
+  exit 404 # Package not found -- hehe, super lame.
+when 1
+  package = packages.first
+else
+  packages.each_with_index do |package, index|
+    puts "%3d. %s" % [index+1, package.name]
+  end
+
+  print ">> "
+  index = gets.to_i - 1
+  package = packages[index]
+end
+
+@qwandry.launch(package) if package

data/lib/qwandry.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'set'
+require 'fileutils'
+
+# Informal Spec:
+# 
+# A User may have multiple Repositories
+# A Repositories contains Packages
+# 
+# A User will search for a repository giving a name and optional version
+# Each Repository will be scanned for matching Packages
+# If only one Package matches, that Package will be opened
+# If more than one Package matches, then the user will be prompted to pick one
+#   While any two Packages share the same name their parent dir is appended
+# If no Repository matches, then qwandry will exit with a 404 (repo not found)
+#
+module Qwandry
+  autoload :Launcher,                   "qwandry/launcher"
+  autoload :Repository,                 "qwandry/repository"
+  autoload :FlatRepository,             "qwandry/flat_repository"
+  autoload :LibraryRepository,          "qwandry/library_repository"
+  autoload :Package,                    "qwandry/package"
+end

data/lib/qwandry/flat_repository.rb

@@ -0,0 +1,17 @@
+module Qwandry
+  # Directories look like:
+  #       ./lib-0.1
+  #       ./lib-0.2
+  class FlatRepository < Qwandry::Repository
+    def scan(pattern)
+      results = []
+      all_paths.select do |path|
+        if File.fnmatch?(pattern, File.basename(path))
+          results << package(File.basename(path), [path])
+        end
+      end
+      
+      results
+    end
+  end
+end

data/lib/qwandry/launcher.rb

@@ -0,0 +1,99 @@
+# Launcher is the core Qwandry class, it coordinates finding and launching
+# a package.  It is driven externaly by a UI, for instance the `bin/qw`.
+module Qwandry 
+  class Launcher
+    # The default editor to be used by Qwandry#launch.
+    attr_accessor :editor 
+    
+    # The set of active repositories
+    attr_reader :active
+  
+    # Returns the repositories the Launcher will use.
+    attr_reader :repositories
+  
+    def initialize
+      @repositories = Hash.new{|h,k| h[k] = []}
+      @active = Set.new
+      configure_repositories!
+      custom_configuration!
+    end
+    
+    # Adds a repository path to Qwandry's Launcher. `label` is used to label packages residing in the folder `path`.
+    # 
+    # The `options` can be used to customize the repository.
+    # 
+    # [:class]        Repository class, defaults to Qwandry::FlatRepository
+    # [:accept]       Filters paths, only keeping ones matching the accept option
+    # [:reject]       Filters paths, rejecting any paths matching the reject option
+    # 
+    # `:accept` and `:reject` take patterns such as '*.py[oc]', procs, and regular expressions.
+    def add(label, path, options={})
+      if path.is_a?(Array)
+        path.each{|p| add label, p, options} 
+      else
+        repository_class = options[:class] || Qwandry::FlatRepository
+        label = label.to_s
+        @repositories[label] << repository_class.new(label, File.expand_path(path), options)
+      end
+    end
+        
+    def activate(*labels)
+      labels.each{|label| @active.add label.to_s}
+    end
+    
+    def deactivate(*labels)
+      labels.each{|label| @active.delete label.to_s}
+    end
+      
+    # Searches all of the loaded repositories for `name`
+    def find(*pattern)
+      pattern = pattern.join('*')
+      pattern << '*' unless pattern =~ /\*$/
+      
+      packages = []
+      @repositories.select{|label,_| @active.include? label }.each do |label, repos|
+        repos.each do |repo|
+          packages.concat(repo.scan(pattern))
+        end
+      end
+      packages
+    end
+  
+    # Launches a Package or path represented by a String. Unless `editor` will
+    # check against the environment by default.
+    def launch(package, editor=nil)
+      editor ||= @editor || ENV['VISUAL'] || ENV['EDITOR']
+      paths = package.is_a?(String) ? [package] : package.paths
+      system editor, *paths
+    end
+    
+    private
+    def configure_repositories!
+      # Get all the paths on ruby's load path:
+      paths = $:
+    
+      # Reject binary paths, we only want ruby sources:
+      paths = paths.reject{|path| path =~ /#{RUBY_PLATFORM}$/}
+    
+      # Add ruby standard libraries:
+      paths.grep(/lib\/ruby/).each do |path|
+        add :ruby, path, :class=>Qwandry::LibraryRepository
+      end
+    
+      # Add gem repositories:
+      ($:).grep(/gems/).map{|p| p[/.+\/gems\//]}.uniq.each do |path|
+        add :gem, path
+      end
+      
+      activate :ruby, :gem
+    end
+    
+    def custom_configuration!
+      custom_path = ENV['HOME'] && ENV['HOME'] + '/.qwandry/init.rb'
+      if File.exist? custom_path
+        eval IO.read(custom_path)
+      end
+    end
+    
+  end
+end

data/lib/qwandry/library_repository.rb

@@ -0,0 +1,22 @@
+module Qwandry
+  # Directories look like:
+  #     lib1.rb
+  #     lib1/...
+  #     lib2.py
+  #     lib2/...
+  class LibraryRepository < Qwandry::Repository
+    def scan(pattern)
+      results = Hash.new{|h,k| h[k] = package(k)}
+      all_paths.select do |path|
+        basename = File.basename(path)
+        if File.fnmatch?(pattern, basename)
+          # strip any file extension
+          basename.sub! /\.\w+$/,'' unless File.directory?(path)
+          results[basename].paths << path
+        end
+      end
+      
+      results.values.sort_by{|package| package.name}
+    end
+  end
+end

data/lib/qwandry/package.rb

@@ -0,0 +1,13 @@
+module Qwandry
+  class Package
+    attr_reader :name
+    attr_reader :paths
+    attr_reader :repository
+  
+    def initialize(name, paths, repository)
+      @name = name
+      @repository = repository
+      @paths = paths
+    end
+  end
+end

data/lib/qwandry/repository.rb

@@ -0,0 +1,39 @@
+module Qwandry
+  class Repository
+    attr_reader :name
+    attr_reader :path
+    attr_reader :options
+  
+    def initialize(name, path, options={})
+      @name = name
+      @path = path.chomp('/')
+      @options = options
+      
+    end
+    
+    def scan(name)
+      []
+    end
+    
+    def all_paths
+      paths = Dir["#{@path}/*"]
+      paths = paths.select(&matcher(options[:accept])) if options[:accept]
+      paths = paths.reject(&matcher(options[:reject])) if options[:reject]
+      paths
+    end
+  
+    def package(name, paths=[])
+      Package.new(name, paths, self)
+    end
+    
+    private
+    def matcher(pattern)
+      case pattern
+      when Regexp then lambda{|p| p =~ pattern}
+      when String then lambda{|p| File.fnmatch?(pattern, p)}
+      when Proc   then pattern
+      else raise ArgumentError, "Expected a Regexp, String, or Proc"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: qwandry
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Adam Sanderson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-07 00:00:00 -08:00
+default_executable: qw
+dependencies: []
+
+description: "      Open a gem or library's source directory with your default editor.\n"
+email: netghost@gmail.com
+executables: 
+- qw
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+- TODO
+files: 
+- README.markdown
+- Rakefile
+- TODO
+- VERSION
+- bin/qw
+- lib/qwandry.rb
+- lib/qwandry/flat_repository.rb
+- lib/qwandry/launcher.rb
+- lib/qwandry/library_repository.rb
+- lib/qwandry/package.rb
+- lib/qwandry/repository.rb
+has_rdoc: true
+homepage: http://github.com/adamsanderson/qwandry
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Qwandry lets you quickly edit ruby gems and libraries
+test_files: []
+