libgems 0.0.1

data/lib/libgems/package/tar_reader/entry.rb

@@ -0,0 +1,141 @@
+# encoding: utf-8
+#++
+# Copyright (C) 2004 Mauricio Julio Fernández Pradier
+# See LICENSE.txt for additional licensing information.
+#--
+
+##
+# Class for reading entries out of a tar file
+
+class LibGems::Package::TarReader::Entry
+
+  ##
+  # Header for this tar entry
+
+  attr_reader :header
+
+  ##
+  # Creates a new tar entry for +header+ that will be read from +io+
+
+  def initialize(header, io)
+    @closed = false
+    @header = header
+    @io = io
+    @orig_pos = @io.pos
+    @read = 0
+  end
+
+  def check_closed # :nodoc:
+    raise IOError, "closed #{self.class}" if closed?
+  end
+
+  ##
+  # Number of bytes read out of the tar entry
+
+  def bytes_read
+    @read
+  end
+
+  ##
+  # Closes the tar entry
+
+  def close
+    @closed = true
+  end
+
+  ##
+  # Is the tar entry closed?
+
+  def closed?
+    @closed
+  end
+
+  ##
+  # Are we at the end of the tar entry?
+
+  def eof?
+    check_closed
+
+    @read >= @header.size
+  end
+
+  ##
+  # Full name of the tar entry
+
+  def full_name
+    if @header.prefix != "" then
+      File.join @header.prefix, @header.name
+    else
+      @header.name
+    end
+  end
+
+  ##
+  # Read one byte from the tar entry
+
+  def getc
+    check_closed
+
+    return nil if @read >= @header.size
+
+    ret = @io.getc
+    @read += 1 if ret
+
+    ret
+  end
+
+  ##
+  # Is this tar entry a directory?
+
+  def directory?
+    @header.typeflag == "5"
+  end
+
+  ##
+  # Is this tar entry a file?
+
+  def file?
+    @header.typeflag == "0"
+  end
+
+  ##
+  # The position in the tar entry
+
+  def pos
+    check_closed
+
+    bytes_read
+  end
+
+  ##
+  # Reads +len+ bytes from the tar file entry, or the rest of the entry if
+  # nil
+
+  def read(len = nil)
+    check_closed
+
+    return nil if @read >= @header.size
+
+    len ||= @header.size - @read
+    max_read = [len, @header.size - @read].min
+
+    ret = @io.read max_read
+    @read += ret.size
+
+    ret
+  end
+
+  ##
+  # Rewinds to the beginning of the tar file entry
+
+  def rewind
+    check_closed
+
+    raise LibGems::Package::NonSeekableIO unless @io.respond_to? :pos=
+
+    @io.pos = @orig_pos
+    @read = 0
+  end
+
+end
+

data/lib/libgems/package/tar_writer.rb

@@ -0,0 +1,241 @@
+# -*- coding: utf-8 -*-
+#--
+# Copyright (C) 2004 Mauricio Julio Fernández Pradier
+# See LICENSE.txt for additional licensing information.
+#++
+
+##
+# Allows writing of tar files
+
+class LibGems::Package::TarWriter
+
+  class FileOverflow < StandardError; end
+
+  ##
+  # IO wrapper that allows writing a limited amount of data
+
+  class BoundedStream
+
+    ##
+    # Maximum number of bytes that can be written
+
+    attr_reader :limit
+
+    ##
+    # Number of bytes written
+
+    attr_reader :written
+
+    ##
+    # Wraps +io+ and allows up to +limit+ bytes to be written
+
+    def initialize(io, limit)
+      @io = io
+      @limit = limit
+      @written = 0
+    end
+
+    ##
+    # Writes +data+ onto the IO, raising a FileOverflow exception if the
+    # number of bytes will be more than #limit
+
+    def write(data)
+      if data.size + @written > @limit
+        raise FileOverflow, "You tried to feed more data than fits in the file."
+      end
+      @io.write data
+      @written += data.size
+      data.size
+    end
+
+  end
+
+  ##
+  # IO wrapper that provides only #write
+
+  class RestrictedStream
+
+    ##
+    # Creates a new RestrictedStream wrapping +io+
+
+    def initialize(io)
+      @io = io
+    end
+
+    ##
+    # Writes +data+ onto the IO
+
+    def write(data)
+      @io.write data
+    end
+
+  end
+
+  ##
+  # Creates a new TarWriter, yielding it if a block is given
+
+  def self.new(io)
+    writer = super
+
+    return writer unless block_given?
+
+    begin
+      yield writer
+    ensure
+      writer.close
+    end
+
+    nil
+  end
+
+  ##
+  # Creates a new TarWriter that will write to +io+
+
+  def initialize(io)
+    @io = io
+    @closed = false
+  end
+
+  ##
+  # Adds file +name+ with permissions +mode+, and yields an IO for writing the
+  # file to
+
+  def add_file(name, mode) # :yields: io
+    check_closed
+
+    raise LibGems::Package::NonSeekableIO unless @io.respond_to? :pos=
+
+    name, prefix = split_name name
+
+    init_pos = @io.pos
+    @io.write "\0" * 512 # placeholder for the header
+
+    yield RestrictedStream.new(@io) if block_given?
+
+    size = @io.pos - init_pos - 512
+
+    remainder = (512 - (size % 512)) % 512
+    @io.write "\0" * remainder
+
+    final_pos = @io.pos
+    @io.pos = init_pos
+
+    header = LibGems::Package::TarHeader.new :name => name, :mode => mode,
+                                         :size => size, :prefix => prefix
+
+    @io.write header
+    @io.pos = final_pos
+
+    self
+  end
+
+  ##
+  # Add file +name+ with permissions +mode+ +size+ bytes long.  Yields an IO
+  # to write the file to.
+
+  def add_file_simple(name, mode, size) # :yields: io
+    check_closed
+
+    name, prefix = split_name name
+
+    header = LibGems::Package::TarHeader.new(:name => name, :mode => mode,
+                                         :size => size, :prefix => prefix).to_s
+
+    @io.write header
+    os = BoundedStream.new @io, size
+
+    yield os if block_given?
+
+    min_padding = size - os.written
+    @io.write("\0" * min_padding)
+
+    remainder = (512 - (size % 512)) % 512
+    @io.write("\0" * remainder)
+
+    self
+  end
+
+  ##
+  # Raises IOError if the TarWriter is closed
+
+  def check_closed
+    raise IOError, "closed #{self.class}" if closed?
+  end
+
+  ##
+  # Closes the TarWriter
+
+  def close
+    check_closed
+
+    @io.write "\0" * 1024
+    flush
+
+    @closed = true
+  end
+
+  ##
+  # Is the TarWriter closed?
+
+  def closed?
+    @closed
+  end
+
+  ##
+  # Flushes the TarWriter's IO
+
+  def flush
+    check_closed
+
+    @io.flush if @io.respond_to? :flush
+  end
+
+  ##
+  # Creates a new directory in the tar file +name+ with +mode+
+
+  def mkdir(name, mode)
+    check_closed
+
+    name, prefix = split_name(name)
+
+    header = LibGems::Package::TarHeader.new :name => name, :mode => mode,
+                                         :typeflag => "5", :size => 0,
+                                         :prefix => prefix
+
+    @io.write header
+
+    self
+  end
+
+  ##
+  # Splits +name+ into a name and prefix that can fit in the TarHeader
+
+  def split_name(name) # :nodoc:
+    raise LibGems::Package::TooLongFileName if name.size > 256
+
+    if name.size <= 100 then
+      prefix = ""
+    else
+      parts = name.split(/\//)
+      newname = parts.pop
+      nxt = ""
+
+      loop do
+        nxt = parts.pop
+        break if newname.size + 1 + nxt.size > 100
+        newname = nxt + "/" + newname
+      end
+
+      prefix = (parts + [nxt]).join "/"
+      name = newname
+
+      if name.size > 100 or prefix.size > 155 then
+        raise LibGems::Package::TooLongFileName 
+      end
+    end
+
+    return name, prefix
+  end
+
+end
+

data/lib/libgems/package_task.rb

@@ -0,0 +1,126 @@
+# Copyright (c) 2003, 2004 Jim Weirich, 2009 Eric Hodel
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'libgems'
+begin
+  gem 'rake'
+rescue LibGems::LoadError
+end
+
+require 'rake/packagetask'
+
+##
+# Create a package based upon a LibGems::Specification.  LibGems packages, as well as
+# zip files and tar/gzipped packages can be produced by this task.
+#
+# In addition to the Rake targets generated by Rake::PackageTask, a
+# LibGems::PackageTask will also generate the following tasks:
+#
+# [<b>"<em>package_dir</em>/<em>name</em>-<em>version</em>.gem"</b>]
+#   Create a SlimGems package with the given name and version.
+#
+# Example using a LibGems::Specification:
+#
+#   require 'libgems'
+#   require 'libgems/package_task'
+#
+#   spec = LibGems::Specification.new do |s|
+#     s.platform = LibGems::Platform::RUBY
+#     s.summary = "Ruby based make-like utility."
+#     s.name = 'rake'
+#     s.version = PKG_VERSION
+#     s.requirements << 'none'
+#     s.require_path = 'lib'
+#     s.autorequire = 'rake'
+#     s.files = PKG_FILES
+#     s.description = <<-EOF
+#   Rake is a Make-like program implemented in Ruby. Tasks
+#   and dependencies are specified in standard Ruby syntax.
+#     EOF
+#   end
+#
+#   LibGems::PackageTask.new(spec) do |pkg|
+#     pkg.need_zip = true
+#     pkg.need_tar = true
+#   end
+
+class LibGems::PackageTask < Rake::PackageTask
+
+  ##
+  # Ruby LibGems::Specification containing the metadata for this package.  The
+  # name, version and package_files are automatically determined from the
+  # gemspec and don't need to be explicitly provided.
+
+  attr_accessor :gem_spec
+
+  ##
+  # Create a LibGems Package task library.  Automatically define the gem if a
+  # block is given.  If no block is supplied, then #define needs to be called
+  # to define the task.
+
+  def initialize(gem_spec)
+    init gem_spec
+    yield self if block_given?
+    define if block_given?
+  end
+
+  ##
+  # Initialization tasks without the "yield self" or define operations.
+
+  def init(gem)
+    super gem.full_name, :noversion
+    @gem_spec = gem
+    @package_files += gem_spec.files if gem_spec.files
+  end
+
+  ##
+  # Create the Rake tasks and actions specified by this LibGems::PackageTask.
+  # (+define+ is automatically called if a block is given to +new+).
+
+  def define
+    super
+
+    task :package => [:gem]
+
+    gem_file = gem_spec.file_name
+    gem_path = File.join package_dir, gem_file
+    gem_dir  = File.join package_dir, gem_spec.full_name
+
+    desc "Build the gem file #{gem_file}"
+    task :gem => [gem_path]
+
+    trace = Rake.application.options.trace
+    LibGems.configuration.verbose = trace
+
+    file gem_path => [package_dir, gem_dir] + @gem_spec.files do
+      chdir(gem_dir) do
+        when_writing "Creating #{gem_spec.file_name}" do
+          LibGems::Builder.new(gem_spec).build
+          verbose trace do
+            mv gem_file, '..'
+          end
+        end
+      end
+    end
+  end
+
+end
+