roll 0.8.0 → 1.1.0

data/{LICENSE → COPYING}

@@ -1,7 +1,7 @@
 
                                    ROLL
 
-                 Copyright (c) 2006, 2007 Psi T. Corporation
+                    Copyright (c) 2006, 2007 Thomas Sawyer
 
 
                               THE RUBY LICENSE

data/HISTORY

@@ -0,0 +1,62 @@
+= RELEASE HISTORY
+
+== 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.
+
+Changes:
+
+* Overhauled the entire underlying system.
+* Start-up time is blazing fast, loading's is pretty good too.
+* Metadata uses POM standard, although not dependent (yet?).
+* Environments provide selectable sets of available libraries.
+
+
+== 0.9.4 / 2008-06-05
+
+The .roll file is no longer used. Instead Rolls is now
+using a VERSION file combined with meta/ entries for
+loadpath and dependencies (ie. requires).
+
+Changes:
+
+* VERSION and meta/ entries are used instead of '.roll'.
+
+
+== 0.9.3 / 2007-02-10
+
+Changes:
+
+* Change roll file format and name. It is now .roll.
+* Relative require with #use should now work.
+
+
+== 0.9.2 / 2007-12-17
+
+Changes:
+
+* Changed roll file format from ROLLRC to {name}.roll.
+* The name change enabled an order of magnitude increase in startup time!
+
+
+== 0.9.1 / 2007-11-27
+
+Changes:
+
+* Standard metadate file is now ROLLRC.
+* Improved parsing of ROLLRC file, #release is now a Time object.
+
+
+== 0.9.0 / 2007-11-12
+
+Changes:
+
+* Removed Roll namespace. Library and VersionNumber are now in toplevel.
+* Fixed spelling of 'version' in Library#<=>.
+* Kernel#require and load now route to Library meta-methods.
+* @roll and related methods have been renamed to @package.
+* Reduced scan glob to single pattern. Scanning is over 3x faster!
+

data/README.rdoc

@@ -0,0 +1,169 @@
+= ROLLING WITH RUBY
+
+                  ____
+              ,dP9CGG88@b,
+            ,IP""YICCG888@@b,
+           dIi   ,IICGG8888@b
+          dCIIiciIICCGG8888@@b
+  ________GCCIIIICCCGGG8888@@@________________
+          GGCCCCCCCGGG88888@@@
+          GGGGCCCGGGG88888@@@@...
+          Y8GGGGGG8888888@@@@P.....
+           Y88888888888@@@@@P......
+           `Y8888888@@@@@@@P'......
+              `@@@@@@@@@P'.......
+                  """"........
+
+* home: http://proutils.github.com/roll
+
+
+== DESCRIPTION
+
+Roll is a library manager for Ruby. With Rolls developers can run there
+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.
+
+
+== HOW TO USE
+
+=== Setting Up
+
+To use roll regularly you first need to add it your RUBYOPT environment
+variable.
+
+  $ export RUBYOPT="-roll"
+
+I suspect you will be using RubyGems too, in which case do:
+
+  $ export RUBYOPT="-rubygems -roll"
+
+To support executables you will also need to add a line to your startup
+.bashrc (or equivalent) file.
+
+  export PATH="$PATH:$(roll path)"
+
+This will add the +bin+ locations of the programs encompassed by your
+current roll environment.
+
+(NOTE: The way bin paths are handled will probably change in the future
+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.
+
+
+=== 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
+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.
+
+  $ export RUBYENV="development"
+
+Then you can add the paths you want. For instance my development
+environment is basically constructed like this:
+
+  $ roll in ~/programs/proutils
+  $ roll in ~/programs/rubyworks
+  $ roll in ~/programs/thedeadly
+  $ roll in ~/programs/transcode
+
+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:
+
+  $ roll in --depth 1
+
+That's it. Your project is *READY-TO-ROLL*!
+
+
+== LEARNING MORE
+
+The above provides a brief overview of using roll. But there is more to
+it. To get a deeper understanding of the system and how to use +roll+ to
+it fullest extent, please visit http://proutils.github.org/roll/.
+
+
+== HOW TO INSTALL
+
+=== Manual Installation
+
+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:
+
+  $ tar -xvzf roll-1.0.0
+  $ cd roll-1.0.0
+  $ sudo setup.rb all
+
+On Windows, this last line needs to be 'ruby setup.rb all'.
+
+=== RubyGems Installation
+
+We strongly recommend installing Rolls manually b/c
+Rolls is a peer to RubyGems. However, you can use Gems to
+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.
+
+
+== BY THE WAY
+
+Roll was RubyForge project #1004. She's been around a while! ;)
+
+
+== LICENSE & COPYRIGHT
+
+Roll, Copyright (c) 2006,2007 Thomas Sawyer
+
+Rolls is distributed under the same terms as Ruby.
+
+See the LICENSE file details.
+

data/TODO

@@ -0,0 +1,4 @@
+= TODO List
+
+* Is there a way to directly support plugins?
+

data/bin/roll

@@ -1,44 +1,3 @@
-#! /usr/bin/ruby1.8
-
-# This script builds alist of all roll-redy 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 --bin
-#   fi
-#
-# Currently this only supports bash.
-#
-# TODO Is this the best way to do it, or would it be better
-# to "install" executables to an appropriate bin dir,
-# suing links (soft if possible).
-
-require 'roll/library'
-
-def windows
-  processor, platform, *rest = RUBY_PLATFORM.split("-")
-  platform == 'mswin32'
-end
-
-div = (windows ? ';' : ':')
-
-env_path = ENV['PATH'].split(/[#{div}]/)
-
-# Go thru each roll lib and make sure bin
-# path in path.
-
-new_path = []
-
-Library.list.each do |libname|
-  path = Library[libname].bin_path
-  if path
-    new_path = new_path | path
-  end
-end
-
-bin_path = (["$PATH"] + new_path).join(div)
-
-puts %{export PATH="#{bin_path}";}
-
-
+#!/usr/bin/env ruby
+require 'roll/command'
+Roll::Command.main(*ARGV)

data/lib/oll.rb

@@ -1,2 +1 @@
-require 'roll/library'
-
+require 'roll'

data/lib/roll.rb

@@ -0,0 +1,87 @@
+require 'roll/kernel'
+
+module Roll
+  VERSION = "1.0.0"  #:till: VERSION = "<%= version %>"
+
+  # Get environment.
+
+  def self.env(name=nil)
+    if name
+      env = Environment.new(name)
+    else
+      env = Environment.new
+    end
+    env
+  end
+
+  def self.index(name=nil)
+    #if name
+    #  env = Environment.new(name)
+    #else
+    #  env = Environment.new
+    #end
+    env(name).index.to_s
+  end
+
+  # 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
+    env.save
+  end
+
+  # Add path to current environment.
+
+  def self.in(path, depth=3)
+    env = Environment.new
+
+    lookup = env.lookup
+    lookup.append(path, depth)
+    lookup.save
+
+    env.sync
+    env.save
+
+    return path, lookup.file
+  end
+
+  # Remove path from current environment.
+
+  def self.out(path)
+    env = Environment.new
+
+    lookup = env.lookup
+    lookup.delete(path)
+    lookup.save
+
+    env.sync
+    env.save
+
+    return path, lookup.file
+  end
+
+  # Go thru each roll lib and collect bin paths.
+
+  def self.path
+    binpaths = []
+    Library.list.each do |name|
+      lib = Library[name]
+      if lib.bindir?
+        binpaths << lib.bindir
+      end
+    end
+    binpaths
+  end
+
+  # Verify dependencies are in current environment.
+  #--
+  # TODO: Instead of Dir.pwd, lookup project root.
+  #++
+  def self.verify(root=Dir.pwd)   
+    Library.new(root).verify
+  end
+
+end
+

data/lib/roll/command.rb

@@ -0,0 +1,207 @@
+require 'roll'
+#require 'roll/platform'
+require 'optparse'
+
+#--
+# TODO: clean command to remove dead directories from environment
+#++
+
+module Roll
+
+  # = Command-line Interface
+  #
+  class Command
+
+    # Initialize and execute command.
+    def self.main(*argv)
+      new(*argv).execute
+    end
+
+    # New Command.
+    def initialize(*argv)
+      @argv = argv
+    end
+
+    #
+    def execute
+      cmd = @argv.find{ |e| e !~ /^\-/ }
+
+      options = {}
+
+      parser  = OptionParser.new
+
+      parser.banner = "Usage: roll [COMMAND]"
+
+      __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
+      end
+
+      parser.parse!
+
+      ARGV.shift # remove command
+
+      if cmd
+         __send__(cmd, ARGV, options)
+      else
+        # no command ?
+      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
+      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
+
+    #
+    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
+    end
+
+  end
+
+end