roll 1.1.0 → 1.2.0

data/HISTORY

@@ -1,11 +1,35 @@
 = RELEASE HISTORY
 
+== 1.2.0 / 2010-06-15
+
+This release gets roll command working and improves
+the reliability of the system as a whole, including making
+metadata lookup more consistant (hint: you want a PACKAGE file).
+It is even partially compatible with Gem stores now (exceptions
+being loadpaths other than lib/ and the use of autoload).
+
+Changes:
+
+* Reworked metadata system (in line with evolving POM).
+* Improved search heuristics (usually much faster now).
+
+
+== 1.1.0 / 2010-03-01
+
+This release fix a few bugs and makes a few adjustments,
+but mostly cleans up code behind the scenes.
+
+Changes:
+
+* Fix incorrect multi-match and absolute path lookup
+* Support for Rubinius RUBY_IGNORE_CALLERS
+
+
 == 1.0.0 / 2010-02-11
 
-Roll is finally ready for the masses. This release overhauls
-the underlying system, which is now blazing fast, supports
-customizable library environments, and banashes all traces
-of package management to the domain of other tools.
+This release overhauls the underlying system, which is now very
+fast. It supports customizable library environments, and banashes
+all traces of package management to the domain of other tools.
 
 Changes:
 

data/PACKAGE

@@ -0,0 +1,6 @@
+name : roll
+major: 1
+minor: 2
+patch: 0
+date : 2010-06-15
+omit : true

data/PROFILE

@@ -0,0 +1,22 @@
+---
+title: Roll
+suite: proutils
+summary: Ruby Object-Oriented Library Ledger
+contact: Trans <transfire@gmail.com>
+authors: Thomas Sawyer
+created: 2006-12-10
+
+description:
+  Roll is a library manager for Ruby. Code repositories
+  can be made visible to Ruby just by setting an
+  environment variable. Rolls effectively trivializes
+  Ruby package management.
+
+resources:
+  home: http://proutils.github.com/roll
+  repo: git://github.com/proutils/roll.git
+  mail: http://groups.google.com/group/proutils
+
+copyright:
+  Copyright (c) 2006 Thomas Sawyer
+

data/README.rdoc

@@ -15,14 +15,29 @@
                   """"........
 
 * home: http://proutils.github.com/roll
+* worl: http://github.com/protuils/roll
 
 
 == DESCRIPTION
 
-Roll is a library manager for Ruby. With Rolls developers can run there
+Roll is a library manager for Ruby. With Rolls developers can run their
 programs in real time --no install phase is required for one program
 to depend on another. This makes it very easy to work on a set of
-interdependent projects.
+interdependent projects --without vendering. It also makes easy to
+create isolated library environments. Yet Rolls does so efficiently
+--there need only be a single copy of any given version of a library
+on disc. And libraries can be stored anywhere. There is no special place
+they must all reside. You simple tell Rolls where they are.
+
+== STATUS
+
+Rolls works fairly well. I have used it for development for years, so
+on the whole it stays in working order. However it is still under
+heavy development, so configuration is still subject to a fair bit
+of change. The loading heuristics are quite advanced, which accounts
+for the speed, but as a trade-off the first library that is not found
+"early" can initilially slow the system as all of an environments
+metadata if loaded.
 
 
 == HOW TO USE
@@ -36,7 +51,7 @@ variable.
 
 I suspect you will be using RubyGems too, in which case do:
 
-  $ export RUBYOPT="-rubygems -roll"
+  $ export RUBYOPT="-roll -rubygems"
 
 To support executables you will also need to add a line to your startup
 .bashrc (or equivalent) file.
@@ -51,72 +66,57 @@ b/c it has some shortcomings.)
 
 === Preparing your Projects
 
-For your projects to be detected by Rolls they must conform to a
-minimal POM[http://proutils.github.com/pom] setup. In particular
-the project must contain a +meta/+ directory with a +name+ and +version+
-entry. That is the bare minimum for a project to to be loadable via
-Rolls. Optionally you may provide a +loadpath+ entry if the load path 
-is not the +lib/+ default, as well as a +released+ date entry.
-
-(NOTE: +meta/+ can be named +.meta/+ if you would prefer to hide the
-directory, though we recommend keeping it visible.)
-
-Here are examples of Ruby Facets +meta/+ entries.
-
-  $ cat facets/meta/name
-  facets
-
-  $ cat facets/meta/version
-  2.8.0
-
-  $ cat facets/meta/loadpath
-  lib/core
-  lib/more
-
-  $ cat facets/meta/ruby
-  1.8+
-
-The +ruby+ entry informs Rolls of the particular implementations and versions
-of Ruby the project should operate under successfully.
-(NOTE: Rolls doesn't actually do anything with the ruby entry yet.)
-
-Lastly, an +active+ entry can be set to +false+ to tell Rolls to skip the
-project when searching for library files. See POM[http://proutils.github.com/pom]
-for more information.
-
+For a project to be detected by Rolls it must conform to a
+minimal POM[http://proutils.github.com/pom] setup. Specifically
+the project must have a <code>PACKAGE</code> file and it must
+have at least one <code>lib/*.rb</code> file. In the future this
+should become a little more flexible, but that is the bare minimum
+for a project to to be loadable via Rolls as of v1.2. The only
+exception is for Gem stores. If you point Rolls torwards a gems/
+location it will attempt to parse the name and version from a
+library's directory name (e.g. facets-2.8.4/). It does not read
+the gemspec (that would be slow). So alternate loadpaths are not
+supported for Gem stores at this time.
+
+Also, note that #autoload will not work with Rolls. Ruby has a bug
+that prevents #autoload from using any custom defined #require method.
+(Why this has never been fixed is both annoying and frustrating
+to say the least.)
+
+See POM[http://proutils.github.com/pom] for more information about
+the POM standard.
 
 === Library Management
 
 Next you need to setup an roll *environment*. The default environment
-is call +production+. You can add a library search location to it
+is called +production+. You can add a library search location to it
 using +roll in+. Eg.
 
   $ roll in /opt/ruby/
 
-As a developer you will often want to use a +development+ environment.
-To change or add and environment, modify the RUBYENV environment variable.
+As a developer you will may want to setup a +development+ environment.
+To change or add an environment use the +use+ command.
 
-  $ export RUBYENV="development"
+  $ roll use development
 
 Then you can add the paths you want. For instance my development
-environment is basically constructed like this:
+environment is essentially constructed like this:
 
   $ roll in ~/programs/proutils
   $ roll in ~/programs/rubyworks
-  $ roll in ~/programs/thedeadly
-  $ roll in ~/programs/transcode
+  $ roll in ~/programs/trans
 
 By default these paths will be searched for POM conforming projects
 up to a depth of three sub-directories. That's suitable for
 most needs. You can specify the the depth explicitly with the 
-<tt>--depth</tt> or <tt>-d</tt> option. For example, lets say you
-just want to add a single ruby project to the current environment.
-You can do so by navigating to the root directory of a project and
-executing:
+<tt>--depth</tt> or <tt>-d</tt> option. You can roll in the 
+current working directory by leaving off the path argument. 
+If the current directory has a +VERSION+ file, a depth of +1+
+will automatically be used.
 
-  $ roll in --depth 1
+  $ roll in
 
-That's it. Your project is *READY-TO-ROLL*!
+So that's it. You are *READY-TO-ROLL*!
 
 
 == LEARNING MORE
@@ -128,19 +128,26 @@ it fullest extent, please visit http://proutils.github.org/roll/.
 
 == HOW TO INSTALL
 
-=== Manual Installation
+=== Manual Installation (Recommended)
 
-You will need Ruby Setup, the standalone setup.rb script, in order
-to install Roll. See: http://setup.rubyforge.org.
-
-Once you have setup.rb, download the Roll tarball and install
-it manually as follows:
+First you need a copy of the roll tarball (or zip) archive.
+You will find them here[http://github.com/proutils/roll/download].
 
   $ tar -xvzf roll-1.0.0
+
+If you already have Ruby Setup installed on your system you can
+use it to install Rolls (See: http://setup.rubyforge.org). 
+
+  $ cd roll-1.0.0
+  $ sudo setup.rb
+
+Otherwise, Rolls includes a copy of Ruby Setup that you can
+use.
+
   $ cd roll-1.0.0
-  $ sudo setup.rb all
+  $ sudo script/setup.
 
-On Windows, this last line needs to be 'ruby setup.rb all'.
+On Windows, this last line needs to be 'ruby script/setup'.
 
 === RubyGems Installation
 
@@ -151,7 +158,7 @@ install it; and this is a convenient way to try it out.
   gem install roll
 
 If you like Rolls, then later you can uninstall the gem and
-install manually.
+do a proper manual install.
 
 
 == BY THE WAY
@@ -161,7 +168,7 @@ Roll was RubyForge project #1004. She's been around a while! ;)
 
 == LICENSE & COPYRIGHT
 
-Roll, Copyright (c) 2006,2007 Thomas Sawyer
+Roll/Rolls Copyright (c) 2006,2007 Thomas Sawyer
 
 Rolls is distributed under the same terms as Ruby.
 

data/bin/roll

@@ -1,3 +1,9 @@
 #!/usr/bin/env ruby
 require 'roll/command'
-Roll::Command.main(*ARGV)
+begin
+  Roll::Command.main(*ARGV)
+rescue => err
+  raise err if $DEBUG
+  $stderr.puts(err.message)
+end
+

data/lib/oll.rb

@@ -1 +1 @@
-require 'roll'
+require 'roll' #File.dirname(__FILE__) + '/roll.rb'

data/lib/roll.rb

@@ -1,10 +1,11 @@
-require 'roll/kernel'
+require 'roll/config'
+require 'roll/library'
+require 'roll/kernel'  # require last
 
 module Roll
-  VERSION = "1.0.0"  #:till: VERSION = "<%= version %>"
+  VERSION = "1.2.0"  # TODO: make verison reference dynamic
 
   # Get environment.
-
   def self.env(name=nil)
     if name
       env = Environment.new(name)
@@ -14,6 +15,17 @@ module Roll
     env
   end
 
+  # Change current environment.
+  def self.use(name)
+    Environment.save(name)
+  end
+
+  # Return Array of environment names.
+  def self.list
+    Environment.list
+  end
+
+  #
   def self.index(name=nil)
     #if name
     #  env = Environment.new(name)
@@ -25,7 +37,6 @@ module Roll
 
   # Synchronize an environment by +name+. If a +name+
   # is not given the current environment is synchronized.
-
   def self.sync(name=nil)
     env = env(name)
     env.sync
@@ -33,7 +44,6 @@ module Roll
   end
 
   # Add path to current environment.
-
   def self.in(path, depth=3)
     env = Environment.new
 
@@ -48,7 +58,6 @@ module Roll
   end
 
   # Remove path from current environment.
-
   def self.out(path)
     env = Environment.new
 
@@ -63,7 +72,6 @@ module Roll
   end
 
   # Go thru each roll lib and collect bin paths.
-
   def self.path
     binpaths = []
     Library.list.each do |name|
@@ -79,8 +87,21 @@ module Roll
   #--
   # TODO: Instead of Dir.pwd, lookup project root.
   #++
-  def self.verify(root=Dir.pwd)   
-    Library.new(root).verify
+  def self.verify(name=nil)
+    if name
+      Library.open(name).verify
+    else
+      Library.new(Dir.pwd).verify
+    end
+  end
+
+  # VersionError is raised when a requested version cannot be found.
+  class VersionError < ::RangeError  # :nodoc:
+  end
+
+  # VersionConflict is raised when selecting another version
+  # of a library when a previous version has already been selected.
+  class VersionConflict < ::LoadError  # :nodoc:
   end
 
 end

data/lib/roll/command.rb

@@ -1,205 +1,68 @@
+#require File.dirname(File.dirname(__FILE__)) + '/roll.rb'
 require 'roll'
-#require 'roll/platform'
-require 'optparse'
-
-#--
-# TODO: clean command to remove dead directories from environment
-#++
 
 module Roll
 
   # = Command-line Interface
-  #
+  #--
+  # TODO: clean command to remove dead directories from environment
+  #++
   class Command
 
+    # Command-line arguments.
+    attr :args
+
+    # Command-line options.
+    attr :opts
+
+    # Instance of OptionParser.
+    attr :op
+
     # Initialize and execute command.
     def self.main(*argv)
-      new(*argv).execute
+      #cmd   = argv.shift
+      idx = argv.index{ |e| e !~ /^\-/ }
+      cmd = idx ? argv.delete_at(idx) : 'help'
+      begin
+        require "roll/commands/#{cmd}"
+      rescue LoadError
+        cmd = 'help'
+        require "roll/commands/#{cmd}"
+      end
+      klass = ::Roll.const_get("Command#{cmd.capitalize}")
+      klass.new(*argv).execute
     end
 
     # New Command.
     def initialize(*argv)
-      @argv = argv
+      # only need optparse when command is run
+      require 'optparse'
+      @op   = OptionParser.new
+      @args = argv
+      @opts = {}
     end
 
     #
     def execute
-      cmd = @argv.find{ |e| e !~ /^\-/ }
-
-      options = {}
-
-      parser  = OptionParser.new
-
-      parser.banner = "Usage: roll [COMMAND]"
+      setup
 
-      __send__("#{cmd}_optparse", parser, options) if cmd
-
-      if !cmd
-        parser.separator "Commands:"
-        parser.separator "    in  [DIR] " + (" " * 23) + "Roll directory into current environment."
-        parser.separator "    out [DIR] " + (" " * 23) + "Remove directory from current environment."
-        parser.separator "    env       " + (" " * 23) + "Show current environment."
-        parser.separator "    index     " + (" " * 23) + "Show current environment index."
-        parser.separator "    sync      " + (" " * 23) + "Synchronize environment indexes."
-        parser.separator "    path      " + (" " * 23) + "Output bin PATH list."
-        parser.separator "    verify    " + (" " * 23) + "Verify project dependencies in current environment."
-        parser.separator "Options:"
-      end
-
-      parser.on_tail("--help", "-h", "Display this help message.") do
-        puts parser
-        exit
+      op.on_tail("--warn", "-w", "Show warnings.") do
+        $VERBOSE = true
       end
 
-      parser.parse!
-
-      ARGV.shift # remove command
-
-      if cmd
-         __send__(cmd, ARGV, options)
-      else
-        # no command ?
+      op.on_tail("--debug", "Run in debugging mode.") do
+        $DEBUG   = true
+        $VERBOSE = true
       end
-    end
-
-    #
-    def env_optparse(op, options)
-      op.banner = "Usage: roll env [NAME]"
-      op.separator "Show current environment."
-      op
-    end
-
-    #
-    def index_optparse(op, options)
-      op.banner = "Usage: roll index [NAME]"
-      op.separator "Show current environment index."
-      op
-    end
-
-    #
-    def sync_optparse(op, options)
-      op.banner = "Usage: roll sync [NAME]"
-      op.separator "Synchronize ledger(s) to their respective environment(s)."
-      op
-    end
-
-    #
-    def in_optparse(op, options)
-      op.banner = "Usage: roll in [PATH]"
-      op.separator "Insert path into current environment."
-      op.separator "Options:"
-      op.on("--depth", "-d [INTEGER]") do |int|
-        options[:depth] = int
-      end
-    end
-
-    #
-    def out_optparse(op, options)
-      op.banner = "Usage: roll out [PATH]"
-      op.separator "Remove path from current environment."
-      op
-    end
 
-    #
-    def path_optparse(op, options)
-      op.banner = "Usage: roll path"
-      op.separator "Generate executable PATH list."
-      op
-    end
-
-    #
-    def verify_optparse(op, options)
-      op.banner = "Usage: roll verify"
-      op.separator "Verify dependencies in current environment."
-      op
-    end
-
-    # Show/Change current environment.
-    #
-    def env(args, opts)
-      puts Roll.env(*args)
-    end
-
-    # Show/Change current environment.
-    #
-    def index(args, opts)
-      puts Roll.index(*args)
-    end
-
-    # Synchronize ledgers.
-    #
-    def sync(args, opts)
-      name = args.first
-      list = name ? [name] : Environment.list
-      list.each do |name|
-        result = Roll.sync(name)
-        if result
-          puts "   saved #{name}"
-        else
-          puts " current #{name}"
-        end
+      op.on_tail("--help", "-h", "Display this help message.") do
+        puts op
+        exit
       end
-    end
 
-    #
-    def in(args, opts)
-      path  = File.expand_path(args.first || Dir.pwd)
-      depth = opts[:depth]
-      path, file = *Roll.in(path, depth)
-      puts "#{path}"
-      puts "  '-> #{file}"
-    end
-
-    #
-    def out(args, opts)
-      path = File.expand_path(args.first || Dir.pwd)
-      path, file = *Roll.out(path)
-      puts "#{file}"
-      puts "  '-> #{path} -> [x]"
-    end
+      op.parse!(args)
 
-    #
-    def verify(args, opts)
-      list = Roll.verify
-      list.each do |(name, constraint)|
-        puts "#{name} #{constraint}"
-      end
-    end
-
-    # This script builds a list of all roll-ready bin locations
-    # and writes that list as an environment setting shell script.
-    # On Linux a call to this to you .bashrc file. Eg.
-    #
-    #   if [ -f ~/.rollrc ]; then
-    #       . roll
-    #   fi
-    #
-    # Currently this only supports bash.
-    #
-    # TODO: It would be better to "install" executables
-    # to an appropriate bin dir, using links (soft if possible).
-    # There could go in ~/.bin or .config/roll/<ledger>.bin/
-    #
-    def path(args, opts)
-      case RUBY_PLATFORM
-      when /mswin/, /wince/
-        div = ';'
-      else
-        div = ':'
-      end
-      env_path = ENV['PATH'].split(/[#{div}]/)
-      # Go thru each roll lib and make sure bin path is in path.
-      binpaths = []
-      Library.list.each do |name|
-        lib = Library[name]
-        if lib.bindir?
-          binpaths << lib.bindir
-        end
-      end
-      #pathenv = (["$PATH"] + binpaths).join(div)
-      pathenv = binpaths.join(div)
-      #puts %{export PATH="#{pathenv}"}
-      puts pathenv
+      call
     end
 
   end