zipstream 0.0.3 → 0.1.0

data/README.md

@@ -2,6 +2,28 @@
 
 Create zip files to a stream.
 
+Integration with Ruby on Rails means you can create a file, `index.zipstream`, which is a ruby file with a zip object:
+
+    @entries.each do |entry|
+      zip.write "entry-#{entry.id}.txt", entry.to_s
+    end
+
+Which will happily implicitly render from:
+
+    class EntriesController
+      def index
+        @entries = Entry.all
+      end
+    end
+
+Giving you a zip file when rendered. More to come!
+
+## Caveats
+
+Keep in mind that this will use one of your workers/threads/processes until the file is completely downloaded. We are using an iterated rack body which streams so if rack/web servers handle this nicely then you might be in luck.
+
+Tested with Rails 3.1 on REE 1.8.7 and MRI 1.9.3. Specs coming soon (tm).
+
 ## Thanks
 
 Inspired by http://pablotron.org/software/zipstream-php/
@@ -9,3 +31,5 @@ Inspired by http://pablotron.org/software/zipstream-php/
 ## License
 
 Copyright (c) 2011 Samuel Cochran (sj26@sj26.com). Released under the MIT License, see [LICENSE][license] for details.
+
+  [license]: https://github.com/sj26/zipstream/blob/master/LICENSE

data/VERSION

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

data/lib/zipstream.rb

@@ -2,7 +2,7 @@ require 'date'
 require 'zlib'
 
 # Simple, streamable zip file creation
-class ZipStream
+class Zipstream
   VERSION = File.read File.expand_path '../../VERSION', __FILE__
 
   def initialize stream, options={}
@@ -25,6 +25,7 @@ class ZipStream
     crc = Zlib.crc32 data
     zdata_length = zdata.length
     data_length = data.length
+    name = name.to_s
     name_length = name.length
     comment = options[:comment].to_s || ""
     comment_length = comment.length
@@ -125,3 +126,8 @@ protected
     datetime.year << 25 | datetime.month << 21 | datetime.day << 16 | datetime.hour << 11 | datetime.min << 5 | datetime.sec >> 1
   end
 end
+
+require 'zipstream/fiber'
+require 'zipstream/fiber_yielding_stream'
+require 'zipstream/body'
+require 'zipstream/railtie' if defined? Rails

data/lib/zipstream/body.rb

@@ -1,32 +1,21 @@
-require 'zipstream'
-require 'zipstream-fiber-compat' unless defined? Fiber
-
+# Stream a zipfile as a rack response body
+#
 # We use Fibers to deep-yield data being written to the zip stream
-# to use as a rack response body (responds to #each)
-class ZipStream::Body
+# directly to Rack
+class Zipstream::Body
   def initialize &block
-    @stream = FiberYieldingStream.new
-    @fiber = Fiber.new do
-      zip = ZipStream.new @stream
-      block.call zip
-      zip.close
+    @stream = Zipstream::FiberYieldingStream.new
+    @fiber = Zipstream::Fiber.new do
+      Zipstream.new(@stream).tap(&block).close
       # Make sure this returns nil as a sentinel
       nil
     end
   end
 
   def each
-    while !(data = @fiber.resume).nil?
-      yield data
+    # Yield fiber yielded data until we hit our nil sentinel
+    until (yielded = @fiber.resume).nil?
+      yield yielded.first
     end
   end
-
-  # A stream that yields each write to the current fiber
-  class FiberYieldingStream
-    def write data
-      tap { Fiber.yield data }
-    end
-
-    alias << write
-  end
 end

data/lib/zipstream/fiber.rb

@@ -0,0 +1,45 @@
+if defined? Fiber
+  # Use native Fibers if available
+  Zipstream::Fiber = Fiber
+else
+  # Minimal compatibility layer for Fibers
+  # Doesn't seem very comprehensive nor resilient, but it does the job
+  # Credit: http://www.khjk.org/log/2010/jun/fibr.html
+  class Zipstream::Fiber
+    @@fibers = []   # a stack of fibers corresponding to calls of 'resume'
+
+    def initialize &block
+      # lambda makes 'return' work as expected
+      @body = lambda &block
+    end
+
+    def resume *args
+      @@fibers.push self
+      # jumping into fiber
+      jump *args
+    end
+
+    def self.current
+      @@fibers.last
+    end
+
+    def self.yield *args
+      if fiber = @@fibers.pop
+        # jumping out of fiber
+        fiber.send :jump, args
+      end
+    end
+
+  private
+
+    def jump *args
+      callcc do |continuation|
+        destination, @body = @body, continuation
+        destination.call *args
+        @@fibers.pop
+        # return from the last 'resume'
+        @body.call
+      end
+    end
+  end
+end

data/lib/zipstream/fiber_yielding_stream.rb

@@ -0,0 +1,8 @@
+# A super-simple stream that yields each write to the current fiber
+class Zipstream::FiberYieldingStream
+  def write data
+    tap { Zipstream::Fiber.yield data }
+  end
+
+  alias << write
+end

data/lib/zipstream/railtie.rb

@@ -0,0 +1,24 @@
+# Adds zip rendering support to Rails
+class Zipstream::Railtie < Rails::Railtie
+  initializer "zipstream" do
+    # Register Mime::ZIP
+    Mime::Type.register "application/zip", :zip
+
+    # Mark our template handler as rendering zip files
+    Zipstream::Railtie::Template.default_format = Mime::ZIP
+
+    # Tell ActionView we can handle templates
+    ActionView::Template.register_template_handler :zipstream, Zipstream::Railtie::Template
+  end
+
+  # Create a zipstream as a rails template
+  class Template
+    class_attribute :default_format
+
+    def self.call template
+      "Zipstream::Body.new do |zip|
+        #{template.source}
+      end"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zipstream
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-04 00:00:00.000000000 Z
+date: 2011-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70230380021020 !ruby/object:Gem::Requirement
+  requirement: &70190926780580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,7 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *70230380021020
+  version_requirements: *70190926780580
 description: 
 email: sj26@sj26.com
 executables: []
@@ -34,7 +34,9 @@ files:
 - LICENSE
 - VERSION
 - lib/zipstream/body.rb
-- lib/zipstream-fiber-compat.rb
+- lib/zipstream/fiber.rb
+- lib/zipstream/fiber_yielding_stream.rb
+- lib/zipstream/railtie.rb
 - lib/zipstream.rb
 homepage: http://github.com/sj26/zipstream
 licenses: []

data/lib/zipstream-fiber-compat.rb

@@ -1,35 +0,0 @@
-# Credit: http://www.khjk.org/log/2010/jun/fibr.html
-
-class Fiber
-  @@fibers = []   # a stack of fibers corresponding to calls of 'resume'
-
-  def initialize &block
-    @body = lambda &block         # lambda makes 'return' work as expected
-  end
-
-  def resume *args
-    @@fibers.push self
-    jump *args                    # jumping into fiber
-  end
-
-  def self.current
-    @@fibers.last
-  end
-
-  def self.yield *args
-    if fiber = @@fibers.pop
-      fiber.send :jump, args      # jumping out of fiber
-    end
-  end
-
-private
-
-  def jump *args
-    callcc do |continuation|
-      destination, @body = @body, continuation
-      destination.call *args
-      @@fibers.pop
-      @body.call                   # return from the last 'resume'
-    end
-  end
-end if RUBY_VERSION < '1.9'