props_template 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f324de590ac7fad6c1152e6e45a80b407044461fb33fc6b265955afd536d2aca
-  data.tar.gz: 945bd9ffa5457a422d65e49fdc16d5f73c1718fad4e38a78923afee24f7fa067
+  metadata.gz: abee2de45e7fc076a1edad8c9d3edd9f13b3335e0946d6d227fcc4e5370a9e60
+  data.tar.gz: 20bb87744d490b3cae705a1514a965b07ec04cfdc99c5f7deafb627c00fb7484
 SHA512:
-  metadata.gz: 9c4b2f13494e4ec00f5c2a9510f536d3bff51133b36726dc4ed4aaef2f03940a314fbdd5163406e0826535df45268c7e3b4300e4f3fda8536da5b64a3c3346b8
-  data.tar.gz: 0ce796eb28ce86a5d4fb00301c72ac2b97fd5a500fba43cb32c6d3ab3df2c5c36a628973d6fd9975dca24fdbdb8ea0f2754eaea23f28e4664d65a3d22c4b5097
+  metadata.gz: 84b19f30e105c344ea37f0db00524804f998ba01ab84e0cd2f5c47e7c9324061096fd9b089df310a9cfc7a25980b72b01cb2c397649d3ce6ba24e9ca1fc7fd94
+  data.tar.gz: 07257d4609fb4ebbce6621dd804f87abe1b28ab336a41ea1d092611d973d3ea905134b5ad0d690ed9496c62758318825034b1f99b3668b09b3aa7046f49fc9c3

data/README.md

@@ -1,6 +1,13 @@
 # PropsTemplate
 
-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.
+PropsTemplate is a direct-to-Oj, JBuilder-like DSL for building JSON. It has support for Russian-Doll caching, layouts, and of course, its most unique feature: your templates are queryable.
+
+PropsTemplate is fast!
+
+Most libraries would build a hash before feeding it to your serializer of choice, typically Oj. PropsTemplate writes directly to Oj using `Oj::StringWriter` as its rendering your template and skips the need for an intermediate data structure.
+
+PropsTemplate also improves caching. While other libraries spend time unmarshaling, merging, and then serializing to JSON; PropsTemplate simply takes the cached string and [push_json](http://www.ohler.com/oj/doc/Oj/StringWriter.html#push_json-instance_method).
+
 
 Example:
 
@@ -54,24 +61,10 @@ 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>
-Defines the attribute or stucture. All keys are automatically camelized.
+Defines the attribute or stucture. All keys are automatically camelized lower.
 
 ```ruby
 json.set! :author_details, {..options...} do

data/lib/props_template/base.rb

@@ -6,20 +6,10 @@ 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(encoder = nil)
-      @stream = encoder || Props.encoder
-      @stream.reset
+      @stream = Oj::StringWriter.new(mode: :rails)
       @scope = nil
-      @key_cache = {}
     end
 
     def set_block_content!(options = {})
@@ -38,9 +28,12 @@ module Props
       end
     end
 
+    def format_key(key)
+      key.to_s
+    end
+
     def set!(key, value = nil)
-      @key_cache[key] ||= key.to_s.freeze
-      key = @key_cache[key]
+      key = format_key(key)
 
       if @scope == :array
         raise InvalidScopeForObjError.new('Attempted to set! on an array! scope')
@@ -120,10 +113,9 @@ module Props
         @stream.pop
       end
 
-      json = @stream.to_s
+      json = @stream.raw_json
       @scope = nil
       @key_cache = {}
-      @stream.reset
       json
     end
   end

data/lib/props_template/base_with_extensions.rb

@@ -3,8 +3,8 @@ require 'props_template/extensions/partial_renderer'
 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'
+require 'active_support/core_ext/array'
 
 module Props
   class BaseWithExtensions < Base
@@ -16,7 +16,7 @@ module Props
       #todo: refactor so deferred can be its own class
       @em = ExtensionManager.new(self)
       @traveled_path = []
-      @key_formatter = KeyFormatter.new(camelize: :lower)
+      @key_cache = {}
       super()
     end
 
@@ -52,9 +52,12 @@ module Props
       @em = ExtensionManager.new(self, prev_state[1], prev_state[2])
     end
 
-    def set!(key, options = {}, &block)
-      key = @key_formatter.format(key)
+    def format_key(key)
+      @key_cache[key] ||= key.to_s.camelize(:lower)
+      @key_cache[key].dup
+    end
 
+    def set!(key, options = {}, &block)
       if block_given?
         options = @em.refine_options(options)
       end

data/lib/props_template/extensions/partial_renderer.rb

@@ -1,4 +1,3 @@
-require "concurrent/map"
 require 'action_view'
 
 module Props
@@ -81,7 +80,6 @@ module Props
       raise ArgumentError.new(IDENTIFIER_ERROR_MESSAGE % (path))
     end
 
-
     def self.retrieve_variable(path)
       base = path[-1] == "/" ? "" : File.basename(path)
       raise_invalid_identifier(path) unless base =~ /\A_?(.*?)(?:\.\w+)*\z/

data/spec/props_template_spec.rb

@@ -1,10 +1,6 @@
 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.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Johny Ho
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-23 00:00:00.000000000 Z
+date: 2020-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: concurrent-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.1'
 description: A JSON builder for your React props
 email: jho406@gmail.com
 executables: []
@@ -85,7 +71,6 @@ files:
 - lib/props_template/extensions/fragment.rb
 - lib/props_template/extensions/partial_renderer.rb
 - lib/props_template/handler.rb
-- lib/props_template/key_formatter.rb
 - lib/props_template/layout_patch.rb
 - lib/props_template/railtie.rb
 - lib/props_template/searcher.rb

data/lib/props_template/key_formatter.rb

@@ -1,33 +0,0 @@
-require 'active_support/core_ext/array'
-
-module Props
-  class KeyFormatter
-    def initialize(*args)
-      @format = {}
-      @cache = {}
-
-      options = args.extract_options!
-      args.each do |name|
-        @format[name] = []
-      end
-      options.each do |name, parameters|
-        @format[name] = parameters
-      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
-      end
-    end
-  end
-end