turbostreamer 1.5.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41cf2cabe5c4084620fea525158ec975f1d5d7785b2416aff205c6e97c6ff77f
-  data.tar.gz: 112322a9faa00a0e70e250222dbbdc3ec756879c886b4f448493802ddbc46d88
+  metadata.gz: f88c7e8d509e97aa6d2d2604f4a36c1e2d4cc5bb6b15393390681b93d570a893
+  data.tar.gz: 454ca8f3167263308d397fc66ffaafc3858e4078fed5109a325932c8c890c664
 SHA512:
-  metadata.gz: b51fcf37f22a606e5a7dc072706e9e32468c3e92b5f1b9a2d6adf2102644a680ace31baef8486ac850675ff20182db4cd40e07c92cebaded6faaab2ac98a7bae
-  data.tar.gz: 81706cdc8ec9808cc573d6bb3d871977e0edc22744daa15b1d1c3811c7819b0181971e5553cc7ed416a2052b7bb92267ff1f093a79d9a5e07e69c0873a7486be
+  metadata.gz: 225cfb941767f0f3c45d0b1458aaabd9815f121af909e35534a40f3a71502297ea0dd1b72ca943f0f8d7fb11944ccea64283668d86b3e34c977958e1170edb46
+  data.tar.gz: 22ec94ce3cd8e5e1b81c7373d021297e66bedaadbc7fb780c765cf0c7ff752447b9e13e7de84ec5e114620de3af598d225331a7303ec06d31dc78191971c2295

data/README.md

@@ -299,12 +299,25 @@ TurboStreamer.encode(encoder: TurboStreamer::WankelEncoder)
 TurboStreamer.encode(encoder: MyEncoder)
 ```
 
+# Setting the default encoder and options
 If you need explicitly set the default:
 
 ```ruby
 TurboStreamer.set_default_encoder(:json, :oj)
 ```
 
+You can also set default options to pass to the encoder if needed:
+
+```ruby
+TurboStreamer.set_default_encoder(:json, :oj, buffer_size: 1_024)
+```
+
+You may also just set the default options for an encoder:
+
+```ruby
+TurboStreamer.set_default_encoder_options(:oj, buffer_size: 2_048)
+```
+
 The idea was to also support [MessagePack](http://msgpack.org/), hence requring
 the mime type when setting a default encoder.
 

data/ext/actionview/streaming_template_renderer.rb

@@ -2,7 +2,8 @@ module ActionView
   class StreamingTemplateRenderer < TemplateRenderer
     
     def render_template(template, layout_name = nil, locals = {}) #:nodoc:
-      return [super] unless layout_name && template.supports_streaming?
+      template_supports_streaming = (layout_name && template.supports_streaming?) || template.handler == TurboStreamer::Handler
+      return [super] unless template_supports_streaming
 
       locals ||= {}
       layout   = layout_name && find_layout(layout_name, locals.keys, [formats.first])

data/lib/turbostreamer/encoders/oj.rb

@@ -5,11 +5,13 @@ class TurboStreamer
 
     attr_reader :output
 
+    BUFFER_SIZE = 4096
+
     def initialize(io, options={})
       @stack = []
       @indexes = []
 
-      @options = {mode: :json}.merge(options)
+      @options = {mode: :json, buffer_size: BUFFER_SIZE}.merge(options)
 
       @output = io
       @stream_writer = ::Oj::StreamWriter.new(io, @options)

data/lib/turbostreamer/template.rb

@@ -113,29 +113,51 @@ class TurboStreamer::Template < TurboStreamer
   private
 
   def _render_partial_with_options(options)
-    options.reverse_merge! locals: {}
+
     options.reverse_merge! ::TurboStreamer::Template.template_lookup_options
-    as = options[:as]
+    as = options[:as]&.to_sym
+    options[:locals] ||= {}
+    options[:locals][:json] = self
 
     if as && options.key?(:collection)
-      as = as.to_sym
-      collection = options.delete(:collection)
-      locals = options.delete(:locals)
-      array! collection do |member|
-        member_locals = locals.clone
-        member_locals.merge! collection: collection
-        member_locals.merge! as => member
-        _render_partial options.merge(locals: member_locals)
-      end
+      # Option 1, nice simple, fast, calls find_template once
+      array! { @context.render(options) }
+
+      # Option 2, the jBuilder way, slow because find_template for every item
+      # in the collection (a method which is known as one of the heaviest parts
+      # of Action View)
+      # as = as.to_sym
+      # collection = options.delete(:collection)
+      # locals = options.delete(:locals)
+      # array! collection do |member|
+      #   member_locals = locals.clone
+      #   member_locals.merge! collection: collection
+      #   member_locals.merge! as => member
+      #   _render_partial options.merge(locals: member_locals)
+      # end
+
+      # Option 3, the fastest, haven't looked into precisely why, but would need
+      # to customeize to the rails version
+      # lookup_context = @context.view_renderer.lookup_context
+      # options[:locals][:json] = self
+      # options[:locals][:collection] = options[:collection]
+      #
+      # pr = ActionView::PartialRenderer.new(lookup_context)
+      # pr.send(:setup, @context, options, as, nil)
+      # path = pr.instance_variable_get(:@path)
+      # a, b, c = pr.send(:retrieve_variable, path, as)
+      # template_keys = pr.send(:retrieve_template_keys, a).compact
+      # # + [:"#{a}__counter", :"#{a}_iteration"]
+      # template = pr.send(:find_partial, path, template_keys)
+      # locals = options[:locals]
+      # array! options[:collection] do |member|
+      #   locals[as] = member
+      #   template.render(@context, locals)
+      # end
     else
-      _render_partial options
+      @context.render(options)
     end
   end
-
-  def _render_partial(options)
-    options[:locals].merge! json: self
-    @context.render options
-  end
   
   def _keys_to_collection_map(collection, options)
     key = options.delete(:key)

data/lib/turbostreamer/version.rb

@@ -1,3 +1,3 @@
 class TurboStreamer
-  VERSION = '1.5.0'
+  VERSION = '1.7.0'
 end

data/lib/turbostreamer.rb

@@ -6,13 +6,13 @@ class TurboStreamer
 
   BLANK = ::Object.new
 
-
   ENCODERS = {
     json: {oj: 'Oj', wankel: 'Wankel'},
     msgpack: {msgpack: 'MessagePack'}
   }
 
   @@default_encoders = {}
+  @@encoder_options = Hash.new { |h, k| h[k] = {} }
   @@key_formatter = nil
 
   undef_method :==
@@ -24,15 +24,22 @@ class TurboStreamer
 
   def initialize(options = {})
     @output_buffer = options[:output_buffer] || ::StringIO.new
-    @encoder = if options[:encoder].is_a?(Symbol)
-      TurboStreamer.get_encoder(options[:mime] || :json, options[:encoder])
+    if options[:encoder].is_a?(Symbol)
+      @encoder = TurboStreamer.get_encoder(options[:mime] || :json, options[:encoder])
+      @encoder_options = @@encoder_options[options[:encoder]]
     elsif options[:encoder].nil?
-      TurboStreamer.default_encoder_for(options[:mime] || :json)
+      @encoder = TurboStreamer.default_encoder_for(options[:mime] || :json)
+      if encoder_symbol = ENCODERS[options[:mime] || :json].find { |k, v| v == @encoder.name.delete_prefix('TurboStreamer::').delete_suffix('Encoder') }&.first
+        @encoder_options = @@encoder_options[encoder_symbol]
+      else
+        @encoder_options = {}
+      end
     else
-      options[:encoder]
+      @encoder = options[:encoder]
+      @encoder_options = {}
     end
-    @encoder = @encoder.new(@output_buffer)
 
+    @encoder = @encoder.new(@output_buffer, @encoder_options)
     @key_formatter = options.fetch(:key_formatter){ @@key_formatter ? @@key_formatter.clone : nil }
 
     yield self if ::Kernel.block_given?
@@ -221,12 +228,17 @@ class TurboStreamer
     @@key_formatter = formatter
   end
 
-  def self.set_default_encoder(mime, encoder)
+  def self.set_default_encoder(mime, encoder, default_options={})
     if encoder.is_a?(Symbol)
       @@default_encoders[mime] = get_encoder(mime, encoder)
     else
       @@default_encoders[mime] = encoder
     end
+    @@encoder_options[encoder] = default_options
+  end
+  
+  def self.set_default_encoder_options(encoder, options)
+    @@encoder_options[encoder] = options
   end
 
   def self.get_encoder(mime, key)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: turbostreamer
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Jon Bracy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-18 00:00:00.000000000 Z
+date: 2019-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -70,16 +70,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement