props_template 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad98bb076e592658c137fd423771b211760ba047a1f6f394efa7a531a25eedc5
-  data.tar.gz: f5495c4eca8b7015ac5d18714a10a16735769128fac62b5693824b1ef0c6e505
+  metadata.gz: f324de590ac7fad6c1152e6e45a80b407044461fb33fc6b265955afd536d2aca
+  data.tar.gz: 945bd9ffa5457a422d65e49fdc16d5f73c1718fad4e38a78923afee24f7fa067
 SHA512:
-  metadata.gz: 629b8dc24b25dc596ee6f2bb9d03abce69e5af292121d118a83e3d53b83f38ef7ccc155e4cc79d4469a6e588c2efa3231ac02b05447ed11aa6c4642fca833d6f
-  data.tar.gz: 83d0aed77e8cba7cf1730307f15a6fed2b972a181a1722c0dbba85a03489c12ca8b47f89b515e48f8a776564f3c35b58c6118be9396e0eb270c48cfbe21794c9
+  metadata.gz: 9c4b2f13494e4ec00f5c2a9510f536d3bff51133b36726dc4ed4aaef2f03940a314fbdd5163406e0826535df45268c7e3b4300e4f3fda8536da5b64a3c3346b8
+  data.tar.gz: 0ce796eb28ce86a5d4fb00301c72ac2b97fd5a500fba43cb32c6d3ab3df2c5c36a628973d6fd9975dca24fdbdb8ea0f2754eaea23f28e4664d65a3d22c4b5097

data/README.md

@@ -1,6 +1,6 @@
 # PropsTemplate
 
-PropsTemplate is a queryable JSON templating library inspired by JBuilder. It has support for layouts, partials, russian-doll caching, multi-fetch and can selectively render nodes in your tree without executing others.
+PropsTemplate is a fast queryable JSON templating library inspired by JBuilder. It has support for layouts, partials, russian-doll caching, multi-fetch and can selectively render nodes in your tree without executing others.
 
 Example:
 
@@ -45,6 +45,29 @@ json.footer partial: 'shared/footer' do
 end
 ```
 
+## Installation
+If you plan to use PropsTemplate alone just add it to your Gemfile.
+
+```
+gem 'props_template'
+```
+
+and run `bundle`
+
+Then add the following to a initializer:
+
+```
+Props.reset_encoder!
+```
+
+PropsTemplate uses a single instance of `Oj::StringWriter` for a process. If you're using a forking server like puma, be sure to add this to your `config/puma.rb`.
+
+```
+on_worker_boot do
+  Props.reset_encoder!
+end
+```
+
 ## API
 
 ### json.set! or json.<your key here>

data/lib/props_template.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'props_template/base_with_extensions'
 require 'props_template/searcher'
 require 'props_template/handler'
@@ -15,7 +13,6 @@ module Props
     self.template_lookup_options = { handlers: [:props] }
 
     delegate :result!, :array!,
-      :commands_to_json!,
       :deferred!,
       :fragments!,
       :set_block_content!,
@@ -49,11 +46,8 @@ module Props
       @builder
     end
 
-    private
-
-    def method_missing(*args, &block)
-      set!(*args, &block)
-    end
+    alias_method :method_missing, :set!
+    private :method_missing
   end
 end
 

data/lib/props_template/base.rb

@@ -1,45 +1,62 @@
 require 'oj'
 require 'active_support'
-
 #todo: active_support/core_ext/string/output_safety.rb
 
 module Props
   class InvalidScopeForArrayError < StandardError; end
   class InvalidScopeForObjError < StandardError; end
 
+  def self.reset_encoder!
+    @@encoder = Oj::StringWriter.new(mode: :rails)
+  end
+
+  def self.encoder
+    @@encoder
+  end
+
   class Base
-    def initialize
-      @commands = [[:push_object]]
-      @stream = Oj::StringWriter.new(mode: :rails)
+    def initialize(encoder = nil)
+      @stream = encoder || Props.encoder
+      @stream.reset
       @scope = nil
+      @key_cache = {}
     end
 
     def set_block_content!(options = {})
-      @commands.push([:push_object])
       @scope = nil
       yield
-      @commands.push([:pop])
+      if @scope.nil?
+        @stream.push_object
+      end
+      @stream.pop
     end
 
     def handle_set_block(key, options)
-      @commands.push([:push_key, key.to_s])
+      @stream.push_key(key)
       set_block_content!(options) do
         yield
       end
     end
 
     def set!(key, value = nil)
-      @scope ||= :object
+      @key_cache[key] ||= key.to_s.freeze
+      key = @key_cache[key]
+
       if @scope == :array
         raise InvalidScopeForObjError.new('Attempted to set! on an array! scope')
       end
+
+      if @scope.nil?
+        @scope = :object
+        @stream.push_object
+      end
+
       if block_given?
         handle_set_block(key, value) do
           yield
         end
       else
-        @commands.push([:push_key, key.to_s])
-        @commands.push([:push_value, value])
+        @stream.push_value(value, key)
       end
 
       @scope = :object
@@ -76,19 +93,18 @@ module Props
         end
       end
     end
+
     #todo, add ability to define contents of array
     def array!(collection, options = {})
       if @scope.nil?
         @scope = :array
+        @stream.push_array
       else
         raise InvalidScopeForArrayError.new('array! expects exclusive use of this block')
       end
-      @commands[-1] = [:push_array]
 
-      if !collection.empty?
-        handle_collection(collection, options) do |item, index|
-          yield item, index
-        end
+      handle_collection(collection, options) do |item, index|
+        yield item, index
       end
 
       @scope = :array
@@ -96,18 +112,19 @@ module Props
       nil
     end
 
-    def commands_to_json!(commands)
-      commands.each do |command|
-        @stream.send(*command)
+    def result!
+      if @scope.nil?
+        @stream.push_object
+        @stream.pop
+      else
+        @stream.pop
       end
+
       json = @stream.to_s
+      @scope = nil
+      @key_cache = {}
       @stream.reset
       json
     end
-
-    def result!
-      @commands.push([:pop])
-      commands_to_json!(@commands)
-    end
   end
 end

data/lib/props_template/base_with_extensions.rb

@@ -4,12 +4,11 @@ require 'props_template/extensions/cache'
 require 'props_template/extensions/deferment'
 require 'props_template/extension_manager'
 require 'props_template/key_formatter'
-
 require 'active_support/core_ext/string/output_safety'
 
 module Props
   class BaseWithExtensions < Base
-    attr_reader :builder, :context, :fragments, :traveled_path, :deferred, :commands
+    attr_reader :builder, :context, :fragments, :traveled_path, :deferred, :stream
 
     def initialize(builder, context = nil, options = {})
       @context = context
@@ -36,21 +35,21 @@ module Props
     def set_block_content!(options = {})
       return super if !@em.has_extensions(options)
 
-      @em.handle(@commands, options) do
+      @em.handle(options) do
         yield
       end
     end
 
     def scoped_state
-      prev_state = [@commands, @em.deferred, @em.fragments]
-      @commands = []
-      @em  = ExtensionManager.new(self)
-      yield
-      next_state = [@commands, @em.deferred, @em.fragments]
-      @commands = prev_state[0]
-      @em = ExtensionManager.new(self, prev_state[1], prev_state[2])
+      prev_state = [@stream, @em.deferred, @em.fragments]
+      @em = ExtensionManager.new(self)
+      prev_scope = @scope
+      @scope = nil
+
+      yield @stream, @em.deferred, @em.fragments
 
-      next_state
+      @scope = prev_scope
+      @em = ExtensionManager.new(self, prev_state[1], prev_state[2])
     end
 
     def set!(key, options = {}, &block)
@@ -100,8 +99,9 @@ module Props
       @em.refine_all_item_options(all_options)
     end
 
-
     def refine_item_options(item, options)
+      return options if options.empty?
+
       if key = options[:key]
         val = if item.respond_to? key
           item.send(key)

data/lib/props_template/debug_writer.rb

@@ -0,0 +1,55 @@
+require 'oj'
+require 'active_support'
+require 'byebug'
+
+module Props
+  class DebugWriter
+    attr_accessor :commands
+
+    def initialize(opts)
+      @stream = Oj::StringWriter.new(opts)
+      @commands = []
+    end
+
+    def push_object
+      @commands.push([:push_object])
+    end
+
+    def push_key(key)
+      @commands.push([:push_key, key])
+    end
+
+    def push_value(value, key = nil)
+      if key
+        @commands.push([:push_value, value, key])
+      else
+        @commands.push([:push_value, value])
+      end
+    end
+
+    def push_array
+      @commands.push([:push_array])
+    end
+
+    def pop
+      @commands.push([:pop])
+    end
+
+    def reset
+      @commands = []
+      @stream.reset
+    end
+
+    def to_s
+      @commands.each do |command|
+        begin
+          @stream.send(*command)
+        rescue => e
+          byebug
+        end
+      end
+
+      @stream.to_s
+    end
+  end
+end

data/lib/props_template/extension_manager.rb

@@ -25,6 +25,8 @@ module Props
     end
 
     def refine_all_item_options(all_options)
+      return all_options if all_options.empty?
+
       all_options = @partialer.find_and_add_template(all_options)
       all_options = @cache.multi_fetch_and_add_results(all_options)
       all_options
@@ -46,12 +48,12 @@ module Props
       options[:defer] || options[:cache] || options[:partial] || options[:key]
     end
 
-    def handle(commands, options)
+    def handle(options)
       return yield if !has_extensions(options)
 
       if options[:defer]
         placeholder = @deferment.handle(options)
-        commands.push([:push_value, placeholder])
+        base.stream.push_value(placeholder)
         @fragment.handle(options)
       else
         handle_cache(options) do
@@ -76,32 +78,39 @@ module Props
 
     private
 
-    def content_for_cache(commands, deferred_paths, fragment_paths)
-      suffix = [
-        [:push_value, deferred_paths],
-        [:push_value, fragment_paths],
-        [:pop]
-      ]
-
-      [[:push_array]] + commands + suffix
-    end
-
     def handle_cache(options)
       if options[:cache]
+        recently_cached = false
+
         state = @cache.cache(*options[:cache]) do
-          commands = content_for_cache(*base.scoped_state {yield})
-          base.commands_to_json!(commands).strip
+          recently_cached = true
+          result = nil
+          start = base.stream.to_s.length
+          base.scoped_state { |stream, deferred_paths, fragment_paths|
+            yield
+            meta = Oj.dump([deferred_paths, fragment_paths]).strip
+            json_in_progress = base.stream.to_s
+            if json_in_progress[start] == ','
+              start += 1
+            end
+            raw = base.stream.to_s[start..-1].strip
+            result = "#{meta}\n#{raw}"
+          }
+          result
         end
 
-        value, next_deferred, next_fragments = Oj.load(state)
-        base.commands.push([:push_value, value])
-        deferred.push(*next_deferred)
+        if !recently_cached
+          meta, raw_json = state.split("\n")
+          next_deferred, next_fragments = Oj.load(meta)
+          base.stream.push_json(raw_json)
+          deferred.push(*next_deferred)
 
-        next_fragments.each do |k, v|
-          if fragments[k]
-            fragments[k].push(*v)
-          else
-            fragments[k] = v
+          next_fragments.each do |k, v|
+            if fragments[k]
+              fragments[k].push(*v)
+            else
+              fragments[k] = v
+            end
           end
         end
       else

data/lib/props_template/railtie.rb

@@ -10,13 +10,5 @@ module Props
         require 'props_template/layout_patch'
       end
     end
-
-    # if Rails::VERSION::MAJOR >= 4
-    #   generators do |app|
-    #     Rails::Generators.configure! app.config.generators
-    #     Rails::Generators.hidden_namespaces.uniq!
-    #     require 'generators/rails/scaffold_controller_generator'
-    #   end
-    # end
   end
 end

data/spec/props_template_spec.rb

@@ -1,6 +1,10 @@
 require_relative './support/helper'
 
 RSpec.describe 'Props::Base' do
+  before do
+    Props.reset_encoder!
+  end
+
   it 'initializes' do
     expect {
       Props::Base.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: props_template
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Johny Ho
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-05 00:00:00.000000000 Z
+date: 2020-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -77,6 +77,7 @@ files:
 - lib/props_template/base.rb
 - lib/props_template/base_with_extensions.rb
 - lib/props_template/core_ext.rb
+- lib/props_template/debug_writer.rb
 - lib/props_template/dependency_tracker.rb
 - lib/props_template/extension_manager.rb
 - lib/props_template/extensions/cache.rb
@@ -95,7 +96,7 @@ homepage: https://github.com/jho406/breezy/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -111,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A JSON builder for your React props
 test_files: