turbostreamer 1.3.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81c2119468be8e96eb8e02da3fe72df9996aaa16fc610d4b0bf2b5f902663004
-  data.tar.gz: 21fc7309b4f17ae08e76b73f70bdc6c9d6a456a37d354aa53c45313b4c5e017d
+  metadata.gz: 5560f65eafd9983a08cc6cd0745101c0909d923dbca5cb012b9f5b884446de37
+  data.tar.gz: 14697af3049c50e3504e46e66a0209cf694c450ba95ac84fa4b723038126460d
 SHA512:
-  metadata.gz: 5353499e01978fa2b6036f2bd26bd4f76a3da28cd07a242aec9be06d67afb9125b49ba179e8d13748945f36c9cfecb276118d88952c600854f88ce4c65e0fb41
-  data.tar.gz: 907614df89e2f67d3a087570eda988f55b498b85d65d4e2756eccafb2acfdcd7911ff4de726edadb3bec02b4428812b68d58ca86fcb8d884dbf1f4beaf304e2b
+  metadata.gz: 894d614c59b3b002130c00519a5b687cc0814c4bd5358c033858f590f3a5e6082dec8b220cba91b59114eb1236129f1f166f27eb276c4ddbfab7bd796e81bacf
+  data.tar.gz: f0d5a68cf0e48ce0e73f50b879d69dc21fcdd6ed35110b4d8498255eeb33f35fb1b1326ff13619dee729adaca4a79ed787ced23f471931112bef5cf2657c1c03

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

@@ -1,17 +1,18 @@
 module ActionView
   class StreamingTemplateRenderer < TemplateRenderer
     
-    def render_template(template, layout_name = nil, locals = {}) #:nodoc:
-      return [super] unless layout_name && template.supports_streaming?
+    def render_template(view, template, layout_name = nil, locals = {}) #:nodoc:
+      template_supports_streaming = (layout_name && template.supports_streaming?) || template.handler == TurboStreamer::Handler
+      return [super.body] unless layout_name && template_supports_streaming
 
       locals ||= {}
       layout   = layout_name && find_layout(layout_name, locals.keys, [formats.first])
 
       Body.new do |buffer|
         if template.handler == TurboStreamer::Handler
-          delayed_render_json(buffer, template, layout, @view, locals)
+          delayed_render_json(buffer, template, layout, view, locals)
         else
-          delayed_render(buffer, template, layout, @view, locals)
+          delayed_render(buffer, template, layout, view, locals)
         end
       end
     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)

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/handler.rb

@@ -12,9 +12,13 @@ class TurboStreamer
       true
     end
     
-    def self.call(template)
+    # TODO: setting source=nil is for rails 5.x compatability, once unsppored
+    # source can be a required param and
+    # `source = template.source if source.nil?` can be removed
+    def self.call(template, source=nil)
+      source = template.source if source.nil?
       # this juggling is required to keep line numbers right in the error
-      %{__already_defined = defined?(json); json||=TurboStreamer::Template.new(self, output_buffer: output_buffer || ActionView::OutputBuffer.new); #{template.source}
+      %{__already_defined = defined?(json); json||=TurboStreamer::Template.new(self, output_buffer: output_buffer || ActionView::OutputBuffer.new); #{source}
         json.target! unless (__already_defined && __already_defined != "method")}
     end
     

data/lib/turbostreamer/template.rb

@@ -106,36 +106,58 @@ class TurboStreamer::Template < TurboStreamer
   #   json.cache_if! !admin?, @person, expires_in: 10.minutes do
   #     json.extract! @person, :name, :age
   #   end
-  def cache_if!(condition, *args)
-    condition ? cache!(*args, &::Proc.new) : yield
+  def cache_if!(condition, *args, &block)
+    condition ? cache!(*args, &block) : yield
   end
 
   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)
@@ -177,7 +199,10 @@ class TurboStreamer::Template < TurboStreamer
     name_options = options.slice(:skip_digest, :virtual_path)
     key = _fragment_name_with_digest(key, name_options)
 
-    if @context.respond_to?(:fragment_cache_key)
+    if @context.respond_to?(:combined_fragment_cache_key)
+      key = @context.combined_fragment_cache_key(key)
+    elsif @context.respond_to?(:fragment_cache_key)
+      # TODO: remove after droping rails 5.1 support
       key = @context.fragment_cache_key(key)
     elsif ::Hash === key
       key = url_for(key).split('://', 2).last
@@ -199,16 +224,6 @@ class TurboStreamer::Template < TurboStreamer
     end
   end
 
-  def _fragment_name_with_digest(key, options)
-    if @context.respond_to?(:cache_fragment_name)
-      # Current compatibility, fragment_name_with_digest is private again and cache_fragment_name
-      # should be used instead.
-      @context.cache_fragment_name(key, options)
-    else
-      key
-    end
-  end
-
   def _partial_options?(options)
     ::Hash === options && options.key?(:as) && options.key?(:partial)
   end

data/lib/turbostreamer/version.rb

@@ -1,3 +1,3 @@
 class TurboStreamer
-  VERSION = '1.3.0'
+  VERSION = '1.9.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: turbostreamer
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Jon Bracy
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-02-22 00:00:00.000000000 Z
+date: 2020-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -192,7 +192,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - jonbracy@gmail.com
 executables: []
@@ -217,7 +217,7 @@ homepage: https://github.com/malomalo/turbostreamer
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--main"
 - README.md
@@ -227,15 +227,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Stream JSON via a Builder-style DSL
 test_files: []