turbostreamer 1.9.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5560f65eafd9983a08cc6cd0745101c0909d923dbca5cb012b9f5b884446de37
-  data.tar.gz: 14697af3049c50e3504e46e66a0209cf694c450ba95ac84fa4b723038126460d
+  metadata.gz: 28af7502575ff95a77ab4771bd22fd1010c265f76a246b187333ccbfd8dc0832
+  data.tar.gz: 3814e0e465cecc5f568fc8c7c91eb949835d03c150d7d1f52c7080f75473828d
 SHA512:
-  metadata.gz: 894d614c59b3b002130c00519a5b687cc0814c4bd5358c033858f590f3a5e6082dec8b220cba91b59114eb1236129f1f166f27eb276c4ddbfab7bd796e81bacf
-  data.tar.gz: f0d5a68cf0e48ce0e73f50b879d69dc21fcdd6ed35110b4d8498255eeb33f35fb1b1326ff13619dee729adaca4a79ed787ced23f471931112bef5cf2657c1c03
+  metadata.gz: 817908e5623d3d2e0a3ff5cb4593ebf06f454ce1f1b3417b92b6f45d521dd50b8c2fe1a45358eb34e10e5cf8d39c93ab10c3652e7e09ba526bac4bc2ddcecc66
+  data.tar.gz: c214d24143ffd1e67e237afff5312e5087ea3afba1f3e33b08b71be475757857886b2691c69a2564c8dbe1220ec7597585ab1c893a5926d9af5429a7b4814662

data/README.md

@@ -1,17 +1,23 @@
-# TurboStreamer [![Build Status](https://api.travis-ci.org/malomalo/turbostreamer.svg)](https://travis-ci.org/malomalo/turbostreamer)
+# TurboStreamer
 
-TurboStreamer gives you a simple DSL for generating JSON that beats massaging giant
-hash structures. This is particularly helpful when the generation process is
-fraught with conditionals and loops.
+[![GitHub Build Status](https://img.shields.io/github/workflow/status/malomalo/turbostreamer/CI?style=flat-square)](https://github.com/malomalo/turbostreamer/actions?query=workflow%3ACI)
 
+[![Gem Version](http://img.shields.io/gem/v/turbostreamer.svg?style=flat-square)](http://badge.fury.io/rb/turbostreamer)
+[![License](https://img.shields.io/github/license/malomalo/turbostreamer.svg?style=flat-square)](http://badge.fury.io/rb/turbostreamer)
+
+TurboStreamer gives you a simple DSL like jBuilder for generating JSON that
+streams directly to a String or IO object.
 
 [Jbuilder](https://github.com/rails/jbuilder) builds a Hash as it renders the
 template and once complete converts the Hash to JSON. TurboStreamer on the other
 hand writes directly to the output as it is rendering the template. Because of
 this some of the magic cannot be done and requires a little more verboseness.
 
-Examples
---------
+Because no time is spent creating a hash caching is also fast. No time is spent
+marshaling and unmarshaling from the cache, instead the string is cached and
+directly inserted into the stream skipping any unmarshaling.
+
+## Examples
 
 ``` ruby
 # app/views/message/show.json.streamer
@@ -31,7 +37,7 @@ json.object! do
   if current_user.admin?
     json.visitors calculate_visitors(@message)
   end
-  
+
   json.tags do
     json.array! do
       @message.tags.each { |tag| json.child! tag }
@@ -66,7 +72,7 @@ This will build the following structure:
   "visitors": 15,
 
   "tags": ['public'],
-  
+
   "comments": [
     { "content": "Hello everyone!", "created_at": "2011-10-29T20:45:28-05:00" },
     { "content": "To you my good sir!", "created_at": "2011-10-29T20:47:28-05:00" }
@@ -151,7 +157,7 @@ json.object! do
       json.url url_for(@message.creator, format: :json)
     end
   end
-  
+
   if current_user.admin?
     json.visitors calculate_visitors(@message)
   end
@@ -299,7 +305,8 @@ TurboStreamer.encode(encoder: TurboStreamer::WankelEncoder)
 TurboStreamer.encode(encoder: MyEncoder)
 ```
 
-# Setting the default encoder and options
+Setting the default encoder and options
+---------------------------------------
 If you need explicitly set the default:
 
 ```ruby
@@ -339,6 +346,20 @@ All backends must have the following functions:
 - `inject(string)` Inject a (usually cached) string into the output; instering any delimiters as needed.
 - `capture(&block)` Capture the output of the block (w/o any delimiters)
 
+Benchmark
+---------
+`gnuplot` is required to run benchmark, to install:
+- `brew install gnuplot` (MacOS)
+
+`yajl` is required to install a development dependency [`wankel`](https://github.com/malomalo/wankel), to install:
+- `brew install yajl` (MacOS)
+
+To run benchmark: `bundle exec rake performance`
+
+This will produce 2 graph images on in folders
+- `performance/dirk`
+- `performance/rolftimmermans`
+
 Special Thanks & Contributors
 -----------------------------
 

data/lib/turbostreamer/dependency_tracker.rb

@@ -1,5 +1,3 @@
-require 'turbostreamer'
-
 dependency_tracker = false
 
 begin

data/lib/turbostreamer/errors.rb

@@ -1,5 +1,3 @@
-
-
 class TurboStreamer
   module Errors
     class MergeError < ::StandardError

data/lib/turbostreamer/handler.rb

@@ -1,7 +1,8 @@
 require "turbostreamer"
 require "active_support/core_ext"
-# This module makes TurboStreamer work with Rails using the template handler API.
 
+# This module makes TurboStreamer work with Rails using the template handler
+# API.
 class TurboStreamer
   class Handler
     
@@ -12,11 +13,7 @@ class TurboStreamer
       true
     end
     
-    # 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?
+    def self.call(template, source)
       # 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); #{source}
         json.target! unless (__already_defined && __already_defined != "method")}

data/lib/turbostreamer/key_formatter.rb

@@ -1,33 +1,29 @@
-require 'active_support/core_ext/array'
+class TurboStreamer::KeyFormatter
+  def initialize(*args)
+    @format = {}
+    @cache = {}
 
-class TurboStreamer
-  class KeyFormatter
-    def initialize(*args)
-      @format = {}
-      @cache = {}
-
-      options = args.extract_options!
-      args.each do |name|
-        @format[name] = []
-      end
-      options.each do |name, paramaters|
-        @format[name] = paramaters
-      end
+    options = args.extract_options!
+    args.each do |name|
+      @format[name] = []
     end
-
-    def initialize_copy(original)
-      @cache = {}
+    options.each do |name, paramaters|
+      @format[name] = paramaters
     end
+  end
+
+  def initialize_copy(original)
+    @cache = {}
+  end
 
-    def format(key)
-      @cache[key] ||= @format.inject(key.to_s) do |result, args|
-        func, args = args
-        if ::Proc === func
-          func.call result, *args
-        else
-          result.send func, *args
-        end
+  def format(key)
+    @cache[key] ||= @format.inject(key.to_s) do |result, args|
+      func, args = args
+      if ::Proc === func
+        func.call result, *args
+      else
+        result.send func, *args
       end
     end
   end
-end
+end

data/lib/turbostreamer/railtie.rb

@@ -1,15 +1,25 @@
 require 'rails/railtie'
-require 'turbostreamer/handler'
-require 'turbostreamer/template'
-
-require File.expand_path('../../../ext/actionview/buffer', __FILE__)
-require File.expand_path('../../../ext/actionview/streaming_template_renderer', __FILE__)
 
 class TurboStreamer
   class Railtie < ::Rails::Railtie
     initializer :turbostreamer do
       ActiveSupport.on_load :action_view do
+        # Require turbostreamer in here so it's only loaded if needed
+        require 'turbostreamer'
+        require File.expand_path('../../../ext/actionview/buffer', __FILE__)
+        require File.expand_path('../../../ext/actionview/streaming_template_renderer', __FILE__)
+
+        # Register Turbostreamer with Rails
         ActionView::Template.register_template_handler :streamer, TurboStreamer::Handler
+        
+        # Setup the default for oj to be rails mode by default unless options
+        # have already been set
+        if TurboStreamer.default_encoder_for(:json).name == 'TurboStreamer::OjEncoder'
+          if !TurboStreamer.has_default_encoder_options?(:oj)
+            TurboStreamer.set_default_encoder_options(:oj, mode: :rails)
+          end
+        end
+        
         require 'turbostreamer/dependency_tracker'
       end
     end

data/lib/turbostreamer/template.rb

@@ -215,7 +215,7 @@ class TurboStreamer::Template < TurboStreamer
     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)
+      @context.cache_fragment_name(key, **options)
     elsif @context.respond_to?(:fragment_name_with_digest)
       # Backwards compatibility for period of time when fragment_name_with_digest was made public.
       @context.fragment_name_with_digest(key)

data/lib/turbostreamer/version.rb

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

data/lib/turbostreamer.rb

@@ -1,9 +1,12 @@
 require 'stringio'
-require 'turbostreamer/key_formatter'
-require 'turbostreamer/errors'
 
 class TurboStreamer
 
+  autoload :Handler, 'turbostreamer/handler'
+  autoload :Template, 'turbostreamer/template'
+  autoload :KeyFormatter, 'turbostreamer/key_formatter'
+  autoload :Errors, 'turbostreamer/errors'
+  
   BLANK = ::Object.new
 
   ENCODERS = {
@@ -228,18 +231,23 @@ class TurboStreamer
     @@key_formatter = formatter
   end
 
-  def self.set_default_encoder(mime, encoder, default_options={})
-    if encoder.is_a?(Symbol)
-      @@default_encoders[mime] = get_encoder(mime, encoder)
+  def self.set_default_encoder(mime, encoder, default_options=nil)
+    @@default_encoders[mime] = if encoder.is_a?(Symbol)
+      get_encoder(mime, encoder)
     else
-      @@default_encoders[mime] = encoder
+      encoder
     end
-    @@encoder_options[encoder] = default_options
+
+    @@encoder_options[encoder] = default_options if default_options
   end
   
   def self.set_default_encoder_options(encoder, options)
     @@encoder_options[encoder] = options
   end
+  
+  def self.has_default_encoder_options?(encoder)
+    @@encoder_options.has_key?(encoder)
+  end
 
   def self.get_encoder(mime, key)
     require "turbostreamer/encoders/#{key}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: turbostreamer
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Jon Bracy
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-24 00:00:00.000000000 Z
+date: 2024-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -192,7 +206,51 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      TurboStreamer is a JBuilder-like DSL for building JSON that streams directly
+      to a string or IO
 email:
 - jonbracy@gmail.com
 executables: []
@@ -227,14 +285,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.5.4
 signing_key:
 specification_version: 4
 summary: Stream JSON via a Builder-style DSL