roll 0.8.0

data/lib/roll/package.rb

@@ -0,0 +1,300 @@
+require 'yaml'
+require 'roll/attributes'
+
+module Roll
+
+  class Package
+    include Attributes
+
+    # Read package information from a YAML file.
+    def self.open(file=nil, options={})
+      unless file
+        file = Dir.glob(filename, File::FNM_CASEFOLD).first
+        raise "Manifest file is required." unless file
+      end
+      data = YAML::load(File.open(file))
+      data.update(options)
+      data.update(:file => file)
+      new(data)
+    end
+
+    # Possible file name (was for Fileable).
+    def self.filename
+      '{,meta/}*.roll'
+    end
+
+    # New Package. Pass in a data hash to populate the object.
+    # TODO Support self setter block?
+    def initialize(data={}) #, &yld)
+      data.each do |k,v|
+        send( "#{k}=", v ) rescue nil
+      end
+      #if yld
+      #  yld.to_h.each do |k,v|
+      #    send( "#{k}=", v ) rescue nil
+      #  end
+      #end
+
+      base = File.basename(file).chomp('.roll')
+      if base.index('-')  # Just in case you want to load ir from a non-conforming file.
+        name, version = base.split('-')
+        name = name.downcase # TODO Is this too restrictive?
+        @name = name
+        @version = version
+      end
+
+      self
+    end
+
+    # Name of the package file (if used).
+    attr_accessor :file
+
+    # Path to the project file (if used).
+    def location
+      File.dirname(@file) if @file
+    end
+
+    # Indicates if this project information was read from a file.
+    # Returns the file's name if so.
+    def read? ; file ; end
+
+    #---------------------#
+    # GENERAL INFORMATION #
+    #---------------------#
+
+    # The title of the project (free-form, defaults to name).
+    attr_accessor :title
+
+    # One-line description of the package (Max 60 chars.)
+    attr_accessor :subtitle, :brief
+
+    # More detailed description of the package.
+    attr_accessor :description, :summary
+
+    # "Unix" name of the project.
+    attr_accessor :name, :project
+
+    # The date the project was started.
+    attr_accessor :created
+
+    # Copyright notice.
+    attr_accessor :copyright
+
+    # Distribution License.
+    attr_accessor :license
+
+    # Project slogan or "trademark" phrase.
+    attr_accessor :slogan
+
+    # General one-word software category.
+    attr_accessor :category
+
+    # Author(s) of this project.
+    # (Usually in "name <email>" format.)
+    attr_accessor :author
+
+    # Contact(s) (defaults to authors).
+    attr_accessor :contact
+
+    # Gerenal Email address (defaults to first contact's address, if given).
+    attr_accessor :email
+
+    # Official domain associated with this package.
+    attr_accessor :domain
+
+    # Project's homepage.
+    attr_accessor :homepage
+
+    # Project's development site.
+    attr_accessor :development, :devsite
+
+    # Internet address(es) to documentation pages.
+    attr_accessor :documentation, :docs
+
+    # Internet address(es) to downloadable packages.
+    attr_accessor :download
+
+    # Internet address for project wiki.
+    attr_accessor :wiki
+
+    # Project's mailing list or other contact email.
+    attr_accessor :list
+
+    # Generate documentation on installation?
+    attr_accessor :document
+
+    def name        ; @name         || project        ; end
+    def title       ; @title        || project        ; end
+    def contact     ; @contact      || author         ; end
+    def email       ; @email        || contact        ; end
+    def license     ; @license      || 'Ruby'         ; end
+
+    # Subtitle is limited to 60 characters.
+    def subtitle ; @subtitle.to_s[0..59] ; end
+
+    # Returns a standard taguri id for the library and release.
+    def project_taguri
+      "tag:#{name}.#{domain},#{created}"  # or released?
+    end
+
+    # Version Information
+
+    module Version
+      include Attributes
+
+      # Version number (eg. '1.0.0').
+      attr_accessor :version
+
+      # Status of this release: alpha, beta, RC1, etc.
+      attr_accessor :status
+
+      # Date of release (defaults to Time.now).
+      attr_accessor :released
+
+      # Build number (if true, defaults to a number based on current date-time).
+      attr_accessor :buildno
+
+      # Current release code name.
+      attr_accessor :codename
+
+      # If buildno is set to true, than returns a time stamp.
+      def buildno
+        bn = stamp.buildno if stamp
+        unless bn
+          if TrueClass === @buildno
+            bn = Time.now.strftime("%H*60+%M")
+          else
+            bn = @buildno
+          end
+        end
+        return bn
+      end
+    end
+
+    include Version
+
+    # Content Descriptions
+
+    module Contents
+      include Attributes
+
+      # Files in this package that are executables.
+      attr_accessor :executable, :executables
+
+      # Library files in this package that are *public*.
+      # This is akin to load_path but specifies specific files
+      # that can be loaded from the outside --where as those
+      # not listed are considerd *private*.
+      #
+      # NOTE: This is not enforced --and may never be. It
+      # complicates library loading. Ie. how to distinguish public
+      # loading from external loading. But it something that can be
+      # consider more carfully in the future. For now it can serve 
+      # as an optional reference.
+      attr_accessor :library, :libraries
+
+      # Location(s) of executables.
+      attr_accessor :bin_path, :bin_paths
+
+      # Root location(s) of libraries (used by Rolls).
+      # If you plan to support Gems, this would be something like:
+      #
+      #   'lib/facets'
+      #
+      # If not, then the default ('lib') is nice b/c it means one less
+      # layer in your project heirarchy.
+      attr_accessor :lib_path, :lib_paths, :load_path, :load_paths
+
+      # Traditional load path (used by RubyGems).
+      # The default is 'lib', which is usually fine.
+      attr_accessor :gem_path, :gem_paths
+
+      # Default lib to load when requiring only on a package name. Eg.
+      #
+      #   require 'facets'
+      #
+      attr_accessor :index_library
+
+      # Root location(s) of libraries.
+      #--
+      # TODO This is an intersting idea. Instead of fixed locations in 
+      # the file system one could register "virtual locations" which map
+      # to real locations. Worth the added flexability?
+      #++
+      #attr_accessor :register
+
+      def executable ; [@executable || 'bin/**/*'].flatten ; end
+      def library    ; [@library    || 'lib/**/*'].flatten ; end
+
+      def gem_path   ; [@gem_path   || 'lib'].flatten ; end
+      def lib_path   ; [@lib_path   || 'lib'].flatten ; end
+
+      def index_library ; @index_library || 'index.rb' ; end
+
+      #def register    ; @register    || { name => 'lib' } ; end
+    end
+
+    include Contents
+
+    # Security Information
+
+    module Security
+      include Attributes
+
+      # Encryption digest type used.
+      #   (md5, sha1, sha128, sha256, sha512).
+      attr_accessor :digest
+
+      # Public key file associated with this library. This is useful
+      # for security purposes especially remote loading. [pubkey.pem]
+      attr_accessor :public_key
+
+      # Private key file associated with this library. This is useful
+      # for security purposes especially remote loading. [_privkey.pem]
+      attr_accessor :private_key
+
+      def digest      ; @digest       || 'md5'          ; end
+      def public_key  ; @public_key   || 'pubkey.pem'   ; end
+      def private_key ; @private_key  || '_privkey.pem' ; end
+    end
+
+    include Security
+
+    # Source Control Managment Information
+
+    module Control
+      include Attributes
+
+      # Specifices the type of revision control system used.
+      #   darcs, svn, cvs, etc.
+      attr_accessor :scm
+
+      # Files that are tracked under revision control.
+      # Default is all less standard exceptions.
+      # '+' and '-' prefixes can be used to augment the list
+      # rather than fully override it.
+      attr_accessor :track, :scm_files
+
+      # Internet address to source code repository.
+      # (http://, ftp://, etc.)
+      attr_accessor :repository, :repo
+
+      # Changelog file.
+      attr_accessor :changelog
+    end
+
+    include Control
+
+    # Validation
+
+    validate "name is required" do
+      name
+    end
+
+    validate "version is required" do
+      version
+    end
+
+  end
+
+end

data/lib/roll/remote.rb

@@ -0,0 +1,37 @@
+module Roll
+
+  # Remote install cache (hmmm...should this be optional feature?)
+  REMOTE_CACHE = File.expand_path( '~/.lib/site_ruby/1.8/' )
+  FileUtils.mkdir_p REMOTE_CACHE unless File.directory? REMOTE_CACHE
+  $:.unshift REMOTE_CACHE
+
+  #
+
+  def remote_install(fname)
+    # Bit of a shortcoming here since it's not very efficient to
+    # be searching a remote location for multiple matches.
+    # .so suffix must be specified explicity on the remote end.
+    fname = fname + '.rb' unless fname =~ /\.rb$/ or fname =~ /\.so$/
+
+    # get signiture
+    url = File.join( source, 'meta', 'signitures', fname )
+    $stderr << "remote signiture -- " + url if $DEBUG
+    sig = URI.parse( url ).read
+
+    # get file
+    url = File.join( source, fname )
+    $stderr << "remote file -- " + url if $DEBUG
+    file = URI.parse( url ).read
+
+    # verify file and signiture
+    if Signer.verify?( pubkey, sig, file )
+      infile = File.join( REMOTE_CACHE, fname )
+      indir = File.dirname( infile )
+      FileUtils.mkdir_p indir
+      File.open( infile, 'w' ) { |f| f << file }
+    else
+      raise
+    end
+  end
+
+end

data/lib/roll/version.rb

@@ -0,0 +1,127 @@
+# TITLE:
+#
+#   VersionNumber
+#
+# DESCRIPTION:
+#
+#   VersionNumber is a simplified form of a Tuple class
+#   desgined specifically for dealing with version numbers.
+#
+# AUTHOR:
+#
+#   - Thomas Sawyer (7rans)
+#
+# LICENSE:
+#
+#   Copyright (c) 2005 Thomas Sawyer
+#
+#   Ruby License
+#
+#   This module is free software. You may use, modify, and/or redistribute this
+#   software under the same terms as Ruby.
+#
+#   This program is distributed in the hope that it will be useful, but WITHOUT
+#   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+#   FOR A PARTICULAR PURPOSE.
+#
+# TODO:
+#
+#   - Maybe add Kernel method #version ?
+#
+#   - If Tuple were standard part of Ruby this probably would
+#     not be needed or at least might be simple sublcass instead.
+
+
+# = VersionNumber
+#
+# VersionNumber is a simplified form of a Tuple class
+# desgined specifically for dealing with version numbers.
+#
+class VersionNumber #< Tuple
+
+  #include Enumerable
+  include Comparable
+
+  def initialize( *args )
+    args = args.join('.').split(/\W+/)
+    @self = args.collect { |i| i.to_i }
+  end
+
+  def to_s ; @self.join('.') ; end
+
+  # This is here only becuase File.join calls it instead of to_s.
+
+  def to_str ; @self.join('.') ; end
+
+  def inspect
+    @self.to_s
+  end
+
+  def [](i)
+    @self.fetch(i,0)
+  end
+
+  # "Spaceship" comparsion operator.
+
+  def <=>( other )
+    #other = other.to_t
+    [@self.size, other.size].max.times do |i|
+      c = @self[i] <=> other[i]
+      return c if c != 0
+    end
+    0
+  end
+
+  # For pessimistic constraint (like '~>' in gems)
+
+  def =~( other )
+    #other = other.to_t
+    upver = other.dup
+    upver[0] += 1
+    @self >= other and @self < upver
+  end
+
+  # Major is the first number in the version series.
+
+  def major ; @self[0] ; end
+
+  # Minor is the second number in the version series.
+
+  def minor ; @self[1] || 0 ; end
+
+  # Teeny is third number in the version series.
+
+  def teeny ; @self[2] || 0 ; end
+
+  # Delegate to the array.
+
+  def method_missing( sym, *args, &blk )
+    @self.send(sym, *args, &blk ) rescue super
+  end
+
+  # Parses a string constraint returning the operation as a lambda.
+
+  def self.constraint_lambda( constraint )
+    op, val = *parse_constraint( constraint )
+    lambda { |t| t.send(op, val) }
+  end
+
+  def self.parse_constraint( constraint )
+    constraint = constraint.strip
+    re = %r{^(=~|~>|<=|>=|==|=|<|>)?\s*(\d+(:?[-.]\d+)*)$}
+    if md = re.match( constraint )
+      if op = md[1]
+        op = '=~' if op == '~>'
+        op = '==' if op == '='
+        val = new( *md[2].split(/\W+/) )
+      else
+        op = '=='
+        val = new( *constraint.split(/\W+/) )
+      end
+    else
+      raise ArgumentError, "invalid constraint"
+    end
+    return op, val
+  end
+
+end