qwandry 0.0.3 → 0.1.0

data/README.markdown

@@ -8,6 +8,12 @@ lurking when your computer can do it faster?
 		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
 		
+You can also use Qwandry with other common languages:
+
+    qw -r python numpy # opens python's numpy library
+    qw -r perl URI     # open perl's URI library
+    qw -r node express # open express if it is installed for node
+		
 Installation
 ------------
 Qwandry is a standard ruby gem, on any system with ruby installed already 

data/TODO

@@ -1,11 +1,4 @@
-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
-- If the user is using rvm, add the ruby src directory to the search path, maybe merge it with the normal ruby
-  - Examples: opening digest could get you both the ruby and the C sources.
-- For editors that don't support multi opening collections of files (ie: ./digest.rb and ./digest/) we could trick them by adding symlinks in a temp dir.
-  - Could be an option... might be a terrible idea :)
-- Instead of requiring users to find and configure other languages, small scripts for perl, python, etc. could introspect on their load paths.
+TODO
+----
+Bugs and feature requests can be found on github:
+https://github.com/adamsanderson/qwandry/issues

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.1.0

data/bin/qw

@@ -1,38 +1,33 @@
 #!/usr/bin/env ruby
-# Add qwandry's library to the load path
+
+# Add Qwandry's library to the load path
 $:.unshift File.dirname(__FILE__) + '/../lib'
-# Require it
+
+# Require Qwandry's library
 require "qwandry.rb"
 
-# Create launcher
-@qwandry = Qwandry::Launcher.new
+# Load Qwandry's configuration files 
+config = Qwandry::Configuration
+config.load_configuration_files
+
+# Create a launcher
+@launcher = 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)
+  opts.on("-r", "--repo LABELS", Array, "Search in LABELS, default: #{config.default.join(',')}","Available Repository Types:", *config.configurations.map{|c| "  #{c}"}) do |names|
+    config.default *names
   end
   
   opts.separator ""
   opts.on("-e", "--editor EDITOR", "Use EDITOR to open the package") do |editor|
-    @editor = editor
+    @launcher.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 = Qwandry.config_dir
     if !dir
@@ -43,7 +38,7 @@ opts = OptionParser.new do |opts|
       Dir[File.dirname(__FILE__) + '/../templates/*'].each do |path|
         FileUtils.cp(path, dir, :verbose=>true) unless File.exist?(path)
       end
-      @qwandry.launch dir
+      @launcher.launch dir
     end
     exit(0)
   end
@@ -57,21 +52,21 @@ end
 opts.parse! ARGV
 if ARGV.length == 0
   puts opts
-  exit(1)
+  exit 1 
 end
 
-# Configure default values
-@qwandry.editor = @editor if @editor
-
+# Find the packages:
 name = ARGV.join(' ')
-packages = @qwandry.find(*ARGV)
+packages = @launcher.find(*ARGV)
 ARGV.clear # for the gets below
 
+# There may be 0, 1, or many matches.  If many, then
+# ask the user which one to launch.
 package = nil
 case packages.length
 when 0
   puts "No packages matched '#{name}'"
-  exit 404 # Package not found -- hehe, super lame.
+  exit 4 # Exit code 4 for No Package
 when 1
   package = packages.first
 else
@@ -84,4 +79,13 @@ else
   package = packages[index]
 end
 
-@qwandry.launch(package) if package
+# If there is a package, then launch it.
+if package
+  if @launcher.launch(package)
+    # Exit code 0 for success
+    exit 0 
+  else
+    # Exit with the status returned by the process used to open the package
+    exit $?.exitstatus 
+  end
+end

data/lib/qwandry.rb

@@ -21,6 +21,7 @@ module Qwandry
   autoload :FlatRepository,             "qwandry/flat_repository"
   autoload :LibraryRepository,          "qwandry/library_repository"
   autoload :Package,                    "qwandry/package"
+  autoload :Configuration,              "qwandry/configuration"
 end
 
 # If defined, Qwandry will use XDG_CONFIG_HOME as the xdg spec. If not it 

data/lib/qwandry/configuration.rb

@@ -0,0 +1,135 @@
+module Qwandry
+  class Configuration
+    class << self
+      # Regsisters a new Qwandry configuration.  Use in conjunction with Configuration#add like so:
+      # 
+      #     register 'projects' do
+      #       add '~/Projects/personal'
+      #       add '~/Projects/work'
+      #       add '~/Experiments'
+      #     end
+      # 
+      def register name, &block
+        name = name.to_sym
+        builders[name] << block
+      end
+      
+      # Sets the default configuration to launch, if no `configurations` are passed
+      # in, it returns their names.
+      def default(*configurations)
+        if configurations.empty?
+          @default ||= []
+        else
+          @default = configurations
+        end
+      end
+      
+      # Returns the registered configurations
+      def configurations
+        builders.keys
+      end
+      
+      # Loads a configuration file, and executes it in the context of the Qwandry::Configuration
+      # class.  See default_configuration.rb for an example, or run:
+      # 
+      #     qw --customize
+      # 
+      # For a sample customization file.
+      def load_configuration(path)
+        if File.exist?(path)
+          begin
+            eval IO.read(path), nil, path, 1
+          rescue Exception=>ex
+            STDERR.puts "Warning: error in configuration file: #{path.inspect}"
+            STDERR.puts "Exception: #{ex.message}"
+            STDERR.puts ex.backtrace
+          end
+        end
+      end
+      
+      # Loads the Qwandry default configuration and then the user's custom 
+      # configuration file if it is present.
+      def load_configuration_files
+        # load default configuration files
+        system_config_dir = File.join(File.dirname(__FILE__), 'configuration')
+        Dir[system_config_dir+"/*.rb"].each do |path|
+          load_configuration path
+        end
+        
+        # load user custom init files
+        if config_dir = Qwandry.config_dir
+          custom_path = File.join(config_dir, 'init.rb')
+          load_configuration(custom_path)
+        end
+      end
+            
+      # Loads the repositories for `names` if no names are given, it loads the defaults
+      def repositories(*names)
+        names = default if names.empty?
+        repositories = []
+        
+        names.each do |name|
+          name    = name.to_sym
+          raise ArgumentError, "Unknown Repository type '#{name}'" unless builders.has_key? name
+        
+          builder = builders[name]
+          repositories += builder.repositories
+        end
+        
+        repositories
+      end
+        
+      private
+      
+      def builders
+        @builders ||= Hash.new{|h,name| h[name] = self.new(name) }
+      end
+      
+    end
+    
+    # Creates a new Configuration for building a set of Repositories, this 
+    # should probably only be invoked by Configuration.build, it only exists 
+    # to make the customization DSL relatively easy to work with.
+    def initialize(name)
+      @name = name
+      @blocks = []
+      @repositories = []
+    end
+    
+    def << (block)
+      @blocks << block
+    end
+    
+    def repositories
+      @blocks.each{|block| instance_eval(&block) }
+      @blocks.clear
+      
+      @repositories
+    end
+    
+    # Adds a new Repository to the current configuration.
+    # 
+    # 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.
+    # 
+    #  Examples:
+    #     # Add all my little ruby scripts in the scratch directory
+    #     add '~/scratch', :accept => '*.rb'
+    #     # Add log files in common locations for easy access, but ignore the zipped ones
+    #     add ['/var/log/', '/usr/local/var/log/'], :reject => '*.bz2'
+    # 
+    def add(paths, options={})
+      paths = [paths] if paths.is_a?(String)
+      paths.each do |path|
+        repository_class = options[:class] || Qwandry::FlatRepository
+        @repositories << repository_class.new(@name, File.expand_path(path), options)
+      end
+    end
+    
+  end
+end

data/lib/qwandry/configuration/default.rb

@@ -0,0 +1,57 @@
+
+# Register the default ruby configuration:
+register :ruby do
+  # Reject binary paths, and then find only the `/lib/ruby` sources:
+  paths = ($:).reject{|path| path =~ /#{RUBY_PLATFORM}$/}.grep(/lib\/ruby/)
+  
+  # Add ruby standard libraries using the LibraryRepository:
+  add paths, :class=>Qwandry::LibraryRepository
+end
+
+# Register the default ruby gems configuration:
+register :gem do
+  # Get the gem paths from the ruby load paths:
+  paths = ($:).grep(/gems/).map{|p| p[/.+\/gems\//]}.uniq
+  
+  # Add all the rubygems' paths:
+  add paths
+end
+
+# Register a perl configuration:
+register :perl do
+  # Execute a perl script to find all of the perl load paths:
+  perl_paths = `perl -e 'foreach $k (@INC){print $k,"\n";}'` rescue ''
+  
+  # Split on new lines, rejecting blank paths and the current directory:
+  perl_paths = perl_paths.split("\n").reject{|path| path == '' || path == '.'}
+  
+  # Add perl paths as a LibraryRepository
+  add perl_paths, :class=>Qwandry::LibraryRepository
+end
+
+# Add python repositories:
+register :python do
+  # Execute a python script to find all of the python load paths:
+  python_paths = `python -c 'import sys;print(\"\\n\".join(sys.path))'` rescue ''
+  
+  # Reject all the blank paths and the current directory.  Also reject anything that looks like a binary
+  python_paths = python_paths.split("\n").reject{|path| path == '' || path == '.' || path =~ /\.zip$/ || path =~/lib-dynload$/}
+  
+  # Add the python paths, instruct Qwandry to skip any compiled files when trying to match a file/library:
+  add python_paths, :class=>Qwandry::LibraryRepository, :reject => /\.(py[oc])|(egg-info)$/
+end
+
+# Add node.js repositories:
+register :node do
+  # Execute a node script to find all of the load paths:
+  node_script_path = File.join(File.dirname(__FILE__),'probe_node.js')
+  node_paths = `node #{node_script_path}` rescue ''
+  
+  node_paths = node_paths.split("\n")
+  # Add the node paths
+  add node_paths
+end
+
+# Qwandry is a ruby app after all, so activate ruby and gem by default.  Other defaults can be set
+# with a custom init.rb
+default :ruby, :gem

data/lib/qwandry/configuration/probe_node.js

@@ -0,0 +1,4 @@
+// If anyone knows a way to pipe a one liner into node to do this, 
+// I'm all ears.
+var sys = require('sys')
+sys.puts(require.paths.join("\n"))

data/lib/qwandry/flat_repository.rb

@@ -1,8 +1,13 @@
 module Qwandry
-  # Directories look like:
-  #       ./lib-0.1
-  #       ./lib-0.2
+  # The FlatRepository assumes that each file or directory in the search path
+  # is a stand alone Package.  For instance:
+  # 
+  #     rails-2.3.2
+  #     rails-3.0.1
+  #     thin
+  # 
   class FlatRepository < Qwandry::Repository
+    # Returns a Package for each matching file or directory.
     def scan(pattern)
       results = []
       all_paths.select do |path|

data/lib/qwandry/launcher.rb

@@ -5,57 +5,19 @@ module Qwandry
     # 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)
+      # Create a glob pattern from the user's input, for instance
+      # ["rails","2.3"] => "rails*2.3*"
       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
+      repositories = Qwandry::Configuration.repositories
+      repositories.each do |repo|
+        packages.concat(repo.scan(pattern))
       end
+      
       packages
     end
   
@@ -76,42 +38,6 @@ module Qwandry
       # Launch the editor with its options and any paths that we have been passed
       system(*(editor_and_options + 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!
-      if config_dir = Qwandry.config_dir
-        custom_path = File.join(config_dir, 'init.rb')
-        if File.exist?(custom_path)
-          begin
-            eval IO.read(custom_path), nil, custom_path, 1
-          rescue Exception=>ex
-            STDERR.puts "Warning: error in custom file: #{custom_path.inspect}"
-            STDERR.puts "Exception: #{ex.message}"
-            STDERR.puts ex.backtrace
-          end
-        end
-      end
-    end
-    
+        
   end
-end
+end

data/lib/qwandry/library_repository.rb

@@ -1,10 +1,15 @@
 module Qwandry
-  # Directories look like:
-  #     lib1.rb
-  #     lib1/...
-  #     lib2.py
-  #     lib2/...
+  # The LibraryRepository assumes that the search path contains files in the root mixed with
+  # directories of the same name which should be opened together.  Ruby's date library is a good
+  # example of this:
+  # 
+  #     date.rb
+  #     date/
+  # 
   class LibraryRepository < Qwandry::Repository
+    
+    # Returns Packages that may contain one or more paths if there are similar
+    # root level files that should be bundled together.
     def scan(pattern)
       results = Hash.new{|h,k| h[k] = package(k)}
       all_paths.select do |path|

data/lib/qwandry/repository.rb

@@ -1,20 +1,27 @@
 module Qwandry
+  # A Repository's primary responsibility is to return a set of Packages that
+  # match the search criteria used in Repository#scan.
+  # 
+  # Subclasses are expected 
   class Repository
     attr_reader :name
     attr_reader :path
     attr_reader :options
-  
+    
+    # Creates a Repository with a give name, search path, and options.
     def initialize(name, path, options={})
       @name = name
       @path = path.chomp('/')
       @options = options
-      
     end
     
+    # Given a name, scan should an array with 0 or more Packages matching the
+    # name.
     def scan(name)
-      []
+      raise NotImplementedError, "Repositories must return an Array of matching packages."
     end
     
+    # Returns all paths that should be tested by Qwandry#scan.
     def all_paths
       paths = Dir["#{@path}/*"]
       paths = paths.select(&matcher(options[:accept])) if options[:accept]
@@ -22,11 +29,13 @@ module Qwandry
       paths
     end
   
+    private
+    # Helper for assembling a new package which may be launched by the Launcher
     def package(name, paths=[])
       Package.new(name, paths, self)
     end
     
-    private
+    # Helper for generating a predicate methods
     def matcher(pattern)
       case pattern
       when Regexp then lambda{|p| p =~ pattern}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: qwandry
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 27
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 3
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors: 
 - Adam Sanderson
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-11 00:00:00 -08:00
+date: 2010-12-30 00:00:00 -07:00
 default_executable: qw
 dependencies: []
 
@@ -35,6 +35,9 @@ files:
 - VERSION
 - bin/qw
 - lib/qwandry.rb
+- lib/qwandry/configuration.rb
+- lib/qwandry/configuration/default.rb
+- lib/qwandry/configuration/probe_node.js
 - lib/qwandry/flat_repository.rb
 - lib/qwandry/launcher.rb
 - lib/qwandry/library_repository.rb