roda 3.25.0 → 3.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e98660fac24a8bb7b455591674e9427e4fb07521384ae925888b95d7b38509c
-  data.tar.gz: 5ca8cec4fbff75633280c63375f9b33b5eeb26f7862d05356b5c3e85f0f1a29a
+  metadata.gz: 441b09ae88ce4427866fe7c773ce8476f60e837b7b4477bfc5106c162e8b0a06
+  data.tar.gz: aca50917cc14429a77c16461352c997dff592e52cc9a44d1f4f64688b8b50693
 SHA512:
-  metadata.gz: 1e1ac389fcaad6a03b0ea9a5b89bf895c49421f971ce3a21eacaa7a24f93e061a1318debfd5cc30f2a41c146fdfbe53bd18785e6e2cc53fed938bde8dc078efa
-  data.tar.gz: fc26dccc7384e5619754d5f2ca4fddaf691aa57b301f1e2ea9b8de9a27224a49961ee0b162117363a7805a80860f4f3bb012d6d11ac8ca81f3b25f1505d888ef
+  metadata.gz: bb56cb6dbcb70fbc182d10bf161db009162d6887e9117823b9fab26554670644c3eec1c2e2977008310826fee799d1213ff8d7a85ed261e5f257ed949b9baa2b
+  data.tar.gz: 8d7b4ee8b669e7a3a5f3f4ac79f7d51b879cf9700e9634bd5b52b9c219c1158d0f07f03ce5aeab983bbddd3038febd996738b45047fa1e8e49c6e1dc7e07687d

data/CHANGELOG

@@ -1,3 +1,9 @@
+= 3.26.0 (2019-11-18)
+
+* Combine multiple asset files with a newline when compiling them, avoiding corner cases with comments (ameuret) (#176)
+
+* Add asychronous streaming support to the streaming plugin (janko) (#175)
+
 = 3.25.0 (2019-10-15)
 
 * Support change in tilt 2.0.10 private API to continue to support compiled templates, with up to 33% performance improvement (jeremyevans)

data/doc/release_notes/3.26.0.txt

@@ -0,0 +1,15 @@
+= New Features
+
+* Asynchronous streaming is now supported in the streaming plugin,
+  using the :async option.  When using this option, streaming
+  responses are temporarily buffered in a queue.  By default, the
+  queue is a sized queue with a maximum of 10 elements, but the
+  queue can be specified manually via the :queue option, which
+  can be used with async libraries that support non-blocking
+  queues.  This option is currently only supported on Ruby 2.3+.
+
+= Other Improvements
+
+* When combining multiple compiled assets into a single file, the
+  files are now separated by a newline, fixing issues when a
+  single line comment is used as the last line of a file.

data/lib/roda/plugins/assets.rb

@@ -494,7 +494,7 @@ class Roda
             file = "#{dirs.join('/')}/#{file}" if dirs && o[:group_subdirs]
             file = "#{o[:"#{type}_path"]}#{file}"
             app.read_asset_file(file, type)
-          end.join
+          end.join("\n")
 
           unless o[:concat_only]
             content = compress_asset(content, type)

data/lib/roda/plugins/streaming.rb

@@ -21,6 +21,8 @@ class Roda
     #
     # :callback :: A callback proc to call when the connection is closed.
     # :loop :: Whether to call the stream block continuously until the connection is closed.
+    # :async :: Whether to call the stream block in a separate thread (default: false). Only supported on Ruby 2.3+.
+    # :queue :: A queue object to use for asynchronous streaming (default: `SizedQueue.new(10)`).
     #
     # If the :loop option is used, you can override the
     # handle_stream_error method to change how exceptions
@@ -88,6 +90,52 @@ class Roda
         end
       end
 
+      # Class of the response body if you use #stream with :async set to true.
+      # Uses a separate thread that pushes streaming results to a queue, so that
+      # data can be streamed to clients while it is being prepared by the application.
+      class AsyncStream
+        include Enumerable
+
+        # Handle streaming options, see Streaming for details.
+        def initialize(opts=OPTS, &block)
+          @stream = Stream.new(opts, &block)
+          @queue = opts[:queue] || SizedQueue.new(10) # have some default backpressure
+          @thread = Thread.new { enqueue_chunks }
+        end
+
+        # Continue streaming data until the stream is finished.
+        def each(&out)
+          dequeue_chunks(&out)
+          @thread.join
+        end
+
+        # Stop streaming.
+        def close
+          @queue.close # terminate the producer thread
+          @stream.close
+        end
+
+        private
+
+        # Push each streaming chunk onto the queue.
+        def enqueue_chunks
+          @stream.each do |chunk|
+            @queue.push(chunk)
+          end
+        rescue ClosedQueueError
+          # connection was closed
+        ensure
+          @queue.close
+        end
+
+        # Pop each streaming chunk from the queue and yield it.
+        def dequeue_chunks
+          while chunk = @queue.pop
+            yield chunk
+          end
+        end
+      end
+
       module InstanceMethods
         # Immediately return a streaming response using the current response
         # status and headers, calling the block to get the streaming response.
@@ -105,7 +153,9 @@ class Roda
             end
           end
 
-          throw :halt, @_response.finish_with_body(Stream.new(opts, &block))
+          stream_class = (opts[:async] && RUBY_VERSION >= '2.3') ? AsyncStream : Stream
+
+          throw :halt, @_response.finish_with_body(stream_class.new(opts, &block))
         end
 
         # Handle exceptions raised while streaming when using :loop

data/lib/roda/version.rb

@@ -4,7 +4,7 @@ class Roda
   RodaMajorVersion = 3
 
   # The minor version of Roda, updated for new feature releases of Roda.
-  RodaMinorVersion = 25
+  RodaMinorVersion = 26
 
   # The patch version of Roda, updated only for bug fixes from the last
   # feature release.

data/spec/plugin/assets_spec.rb

@@ -333,6 +333,21 @@ if run_tests
     end
 
     it 'should handle compiling assets, linking to them, and accepting requests for them' do
+      app.plugin :assets, :js=>{:head => %w'comment_1.js comment_2.js'}
+      app.compile_assets
+      html = body('/test')
+      html.scan(/<script/).length.must_equal 1
+      html =~ %r{src="(/assets/app\.head\.[a-f0-9]{64}\.js)"}
+      js = body($1)
+      js.must_equal <<END
+// test
+/*
+a = 1;
+*/
+END
+    end
+
+    it 'should separate compiled assets with new lines' do
       app.compile_assets
       html = body('/test')
       html.scan(/<link/).length.must_equal 1

data/spec/plugin/streaming_spec.rb

@@ -130,4 +130,117 @@ describe "streaming plugin" do
     b.each{|v| a << v}
     a.must_equal %w'a 1 b 1 c 1 e'
   end
+
+  describe "with :async" do
+    it "should stream in a thread" do
+      main_thread = Thread.current
+      minitest = self
+      app(:streaming) do |r|
+        stream(:async=>true) do |out|
+          minitest.refute_equal Thread.current, main_thread
+          %w'a b c'.each do |v|
+            out << v
+          end
+        end
+      end
+
+      s, h, b = req
+      s.must_equal 200
+      h.must_equal('Content-Type'=>'text/html')
+      b.to_a.must_equal %w'a b c'
+    end
+
+    it "should propagate exceptions" do
+      app(:streaming) do |r|
+        stream(:async=>true) do |out|
+          Thread.current.report_on_exception = false if Thread.current.respond_to?(:report_on_exception=)
+          %w'a b'.each{|v| out << v}
+          raise Roda::RodaError, 'foo'
+          out << 'c'
+        end
+      end
+
+      s, h, b = req
+      s.must_equal 200
+      h.must_equal('Content-Type'=>'text/html')
+      a = []
+      proc{b.each{|v| a << v}}.must_raise(Roda::RodaError)
+      a.must_equal %w'a b'
+    end
+
+    it "should terminate the thread on close" do
+      q = Queue.new
+      app(:streaming) do |r|
+        stream(:async=>true) do |out|
+          %w'a b c d e f g h i j'.each{|v| out << v}
+          q.deq
+          out << 'k'
+        end
+      end
+
+      *, b = req
+      e = b.enum_for(:each)
+      10.times{e.next}
+      b.close
+      q.enq 'x'
+      proc{e.next}.must_raise(StopIteration)
+    end
+
+    it "should still run callbacks on close" do
+      callback = false
+      app(:streaming) do |r|
+        stream(:async=>true, :callback=>proc{callback = true}) do |out|
+          %w'a b c'.each{|v| out << v}
+        end
+      end
+
+      *, b = req
+      b.close
+      callback.must_equal true
+    end
+
+    it "should apply backpressure by default" do
+      q = Queue.new
+      a = []
+      app(:streaming) do |r|
+        stream(:async=>true) do |out|
+          %w'a b c d e f g h i j'.each do |v|
+            out << v
+            a << v
+          end
+
+          q.enq 'x'
+
+          out << 'k'
+          a << 'k'
+        end
+      end
+
+      *, b = req
+      q.deq
+      a.must_equal %w'a b c d e f g h i j'
+    end
+
+    it "should handle :queue option to override queue" do
+      q = Queue.new
+      a = []
+      app(:streaming) do |r|
+        stream(:async=>true, queue: SizedQueue.new(5)) do |out|
+          %w'a b c d e'.each do |v|
+            out << v
+            a << v
+          end
+
+          q.enq 'x'
+
+          out << 'f'
+          a << 'f'
+        end
+      end
+
+      *, b = req
+      q.deq
+      a.must_equal %w'a b c d e'
+    end
+  end if RUBY_VERSION >= '2.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 3.25.0
+  version: 3.26.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-15 00:00:00.000000000 Z
+date: 2019-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -236,6 +236,7 @@ extra_rdoc_files:
 - doc/release_notes/3.23.0.txt
 - doc/release_notes/3.24.0.txt
 - doc/release_notes/3.25.0.txt
+- doc/release_notes/3.26.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -297,6 +298,7 @@ files:
 - doc/release_notes/3.23.0.txt
 - doc/release_notes/3.24.0.txt
 - doc/release_notes/3.25.0.txt
+- doc/release_notes/3.26.0.txt
 - doc/release_notes/3.3.0.txt
 - doc/release_notes/3.4.0.txt
 - doc/release_notes/3.5.0.txt