props_template 1.0.0.alpha.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd22916bd76997bbac899cc2c7f3ee1dde0de4d757d508bde300c665fefffed2
-  data.tar.gz: 3ed18e6266e026ba545b5389cd70ebd215e825be1aa268afd3510a1c695a633f
+  metadata.gz: 6e8ec3d3579ed65bb2a927d2bf7abb10c9e5f4ee4d5a5147da09e8efb1e6a030
+  data.tar.gz: f21d46d7b34d47ee191b0ddcfe68ceb506d15d316a4ad00e433ca3752d82045a
 SHA512:
-  metadata.gz: e036c21457b476fb4554d7d5e5420a88659da3767750eaa70cabc05bd8f5c6924d23aaeb7e76e3640bf8d05558c2b6ac8e1eed9e4cf437d8f19e3960495cb199
-  data.tar.gz: cc7a63fc308d9b3c5e3c3c49286cf7c69e06d76eca3d51c04255eebf68c8158f44d76768396b1f0750adc204d0cae75dc7bfeb1cebd14e806bf690b50013f02e
+  metadata.gz: db8bb1f529058a5dc7f2be56fe29720f638194e756a229da90deb85b3b885cd8de56dab5609219c73df23d1fe4de2cb80a2edc8803bce6a550ee8a4f16c36f70
+  data.tar.gz: dc997a26a9e941c8468e8b1cf755cb3c81e6b541ca7c56661f3ecaab8a701fed67712fd368e1cea50eb8b3dba76238ae169b3b8abb6e2e07485b5a8349ba5673

data/README.md

@@ -14,6 +14,49 @@ that other libraries perform by using Oj's `StringWriter` in `rails` mode.
 
 ![benchmarks](docs/benchmarks.png)
 
+It's really fast. 
+
+`props_template` is second only to `panko` while being feature packed. The
+`Props::Base` [class](./lib/props_template/base.rb) that be used standalone
+is the fastest among all JSON serializers. Results derived from [alba benchmarks](https://github.com/thoughtbot/alba/tree/main/benchmark).
+
+```
+    props_base_class:     1439.9 i/s
+               panko:     1287.6 i/s - 1.12x  slower
+      props_template:      998.8 i/s - 1.44x  slower
+       turbostreamer:      912.9 i/s - 1.58x  slower
+                alba:      871.0 i/s - 1.65x  slower
+         jserializer:      668.7 i/s - 2.15x  slower
+alba_with_transformation:      604.2 i/s - 2.38x  slower
+              barley:      452.2 i/s - 3.18x  slower
+        barley_cache:      441.4 i/s - 3.26x  slower
+            jbuilder:      432.6 i/s - 3.33x  slower
+     fast_serializer:      390.1 i/s - 3.69x  slower
+               rails:      374.1 i/s - 3.85x  slower
+                rabl:      310.3 i/s - 4.64x  slower
+         blueprinter:      268.4 i/s - 5.36x  slower
+       representable:      187.2 i/s - 7.69x  slower
+          simple_ams:      124.5 i/s - 11.57x  slower
+                 ams:       41.5 i/s - 34.67x  slower
+         alba_inline:       10.9 i/s - 131.64x  slower
+
+Gem versions:
+active_model_serializers: 0.10.16
+alba: 3.10.0
+barley: 0.9.0
+blueprinter: 1.2.1
+jbuilder: 2.14.1
+jserializer: 0.2.1
+panko_serializer: 0.8.4
+rabl: 0.17.0
+representable: 3.2.0
+simple_ams: 0.2.6
+turbostreamer: 1.11.0
+
+Ruby version: 3.4.8
+Apple M4 Pro
+```
+
 Caching is fast too.
 
 While other libraries spend time unmarshaling,
@@ -105,6 +148,12 @@ json.authorDetails, with.some_option do
   json.firstName 'David'
 end
 
+# or with hash options
+
+json.authorDetails, {...options} do
+  json.firstName 'David'
+end
+
 
 # => {"authorDetails": { "firstName": "David" }}
 ```
@@ -125,6 +174,10 @@ json.set! :firstName, 'David'
 json.firstName 'David'
 
 # => { "firstName": "David" }
+
+# or
+
+json.postDetails with.partial("blog_post")
 ```
 
 The block form defines key and structure
@@ -340,6 +393,11 @@ with @post, which you can use inside the partial.
 
 ```ruby
 json.one_post(with.partial("posts/blog_post", locals: {post: @post}))
+
+# or with hash options
+
+json.one_post partial: ["posts/blog_post", locals: {post: @post}] do
+end
 ```
 
 Usage with arrays:

data/lib/props_template/base.rb

@@ -9,13 +9,17 @@ module Props
   class InvalidScopeForChildError < StandardError; end
 
   class Base
+    attr_accessor :item_context
+
     def initialize(encoder = nil)
       @stream = Oj::StringWriter.new(mode: :rails)
       @scope = nil
+      @item_context = nil
     end
 
     def set_content!(options = {})
       @scope = nil
+      @item_context = nil
       yield
       if @scope.nil?
         @stream.push_object
@@ -59,30 +63,17 @@ module Props
       nil
     end
 
-    def refine_item_options(item, options)
-      options
-    end
-
     def handle_collection_item(collection, item, index, options)
+      @item_context = item
+
       set_content!(options) do
         yield
       end
     end
 
-    def refine_all_item_options(all_options)
-      all_options
-    end
-
     def handle_collection(collection, options)
-      all_opts = collection.map do |item|
-        refine_item_options(item, options.clone)
-      end
-
-      all_opts = refine_all_item_options(all_opts)
-
       collection.each_with_index do |item, index|
-        pass_opts = all_opts[index]
-        handle_collection_item(collection, item, index, pass_opts) do
+        handle_collection_item(collection, item, index, options) do
           # todo: remove index?
           yield item, index
         end

data/lib/props_template/base_with_extensions.rb

@@ -29,7 +29,7 @@ module Props
     def set_content!(options = {})
       return super if !@em.has_extensions(options)
 
-      @em.handle(options) do
+      @em.handle(options, item_context) do
         yield
       end
     end
@@ -51,10 +51,6 @@ module Props
     end
 
     def set!(key, options = {}, &block)
-      if block || options.is_a?(Props::Options)
-        options = @em.refine_options(options)
-      end
-
       if !block && options.is_a?(Props::Options)
         options.valid_for_set!
         super {}
@@ -78,16 +74,37 @@ module Props
       nil
     end
 
+    def handle_collection(collection, options)
+      if options[:cache]
+        key, rest = [*options[:cache]]
+
+        if ::Proc === key
+          cache_keys = collection.map do |item|
+            key.call(item)
+          end
+          @em.load_cache(cache_keys, rest || {})
+        end
+      end
+
+      super
+    end
+
     def handle_collection_item(collection, item, index, options)
       if !options[:key]
         @traveled_path.push(index)
       else
-        id, val = options[:key]
+        if (key = options[:key])
+          val = if item.respond_to? key
+            item.send(key)
+          elsif item.is_a? Hash
+            item[key] || item[key.to_sym]
+          end
+        end
 
-        if id.nil?
+        if key.nil?
           @traveled_path.push(index)
         else
-          @traveled_path.push("#{id}=#{val}")
+          @traveled_path.push("#{key}=#{val}")
         end
       end
 
@@ -96,25 +113,5 @@ module Props
       @traveled_path.pop
       nil
     end
-
-    def refine_all_item_options(all_options)
-      @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)
-        elsif item.is_a? Hash
-          item[key] || item[key.to_sym]
-        end
-
-        options[:key] = [options[:key], val]
-      end
-
-      @em.refine_options(options, item)
-    end
   end
 end

data/lib/props_template/extension_manager.rb

@@ -1,6 +1,9 @@
 module Props
   class ExtensionManager
-    attr_reader :base, :builder, :context
+    attr_reader :base, :builder, :context, :cache, :partialer
+
+    delegate :load_cache, to: :cache
+    delegate :find_and_add_template, to: :partialer
 
     def initialize(base, defered = [], fragments = [])
       @base = base
@@ -16,22 +19,6 @@ module Props
       @deferment.disable!
     end
 
-    def refine_options(options, item = nil)
-      options = @partialer.refine_options(options, item)
-      if !@deferment.disabled
-        options = @deferment.refine_options(options, item)
-      end
-
-      Cache.refine_options(options, item)
-    end
-
-    def refine_all_item_options(all_options)
-      return all_options if all_options.empty?
-
-      all_options = @partialer.find_and_add_template(all_options)
-      @cache.multi_fetch_and_add_results(all_options)
-    end
-
     def deferred
       @deferment.deferred
     end
@@ -44,26 +31,35 @@ module Props
       options[:defer] || options[:cache] || options[:partial] || options[:key]
     end
 
-    def handle(options)
+    def handle(options, item_context = nil)
       return yield if !has_extensions(options)
 
-      if options[:defer] && !@deferment.disabled
-        placeholder = @deferment.handle(options)
+      if (key = options[:key]) && item_context
+        val = if item_context.respond_to? key
+          item_context.send(key)
+        elsif item_context.is_a? Hash
+          item_context[key] || item_context[key.to_sym]
+        end
+      end
+
+      deferment_type = @deferment.extract_deferment_type(options, item_context) if !@deferment.disabled
+
+      if deferment_type
+        placeholder = @deferment.handle(options, deferment_type, key, val)
         base.stream.push_value(placeholder)
-        @fragment.handle(options)
+        @fragment.handle(options, item_context)
       else
-        handle_cache(options) do
+        handle_cache(options, item_context) do
           base.set_content! do
             if options[:partial]
-              @fragment.handle(options)
-              @partialer.handle(options)
+              @fragment.handle(options, item_context)
+              @partialer.handle(options, item_context)
             else
               yield
             end
 
-            if options[:key]
-              id, val = options[:key]
-              base.set!(id, val)
+            if key && val
+              base.set!(key, val)
             end
           end
         end
@@ -72,11 +68,13 @@ module Props
 
     private
 
-    def handle_cache(options)
+    def handle_cache(options, item)
       if options[:cache]
         recently_cached = false
 
-        state = @cache.cache(*options[:cache]) do
+        key, rest = Cache
+          .normalize_options(options[:cache], item)
+        state = @cache.cache(key, rest) do
           recently_cached = true
           result = nil
           start = base.stream.to_s.length
@@ -93,7 +91,7 @@ module Props
           result
         end
 
-        meta, raw_json = state.split("\n")
+        meta, raw_json = state.split("\n", 2)
         next_deferred, next_fragments = Oj.load(meta)
         deferred.push(*next_deferred)
         fragments.push(*next_fragments)

data/lib/props_template/extensions/cache.rb

@@ -2,23 +2,22 @@ module Props
   class Cache
     delegate :controller, :safe_concat, to: :@context
 
-    def self.refine_options(options, item = nil)
-      return options if !options[:cache]
+    attr_reader :results
 
-      pass_opts = options.clone
-      key, rest = [*options[:cache]]
+    def initialize(context)
+      @context = context
+      @results = {}
+    end
+
+    def self.normalize_options(options, item = nil)
+      key, rest = [*options]
       rest ||= {}
 
       if item && ::Proc === key
         key = key.call(item)
       end
 
-      pass_opts[:cache] = [key, rest]
-      pass_opts
-    end
-
-    def initialize(context)
-      @context = context
+      [key, rest]
     end
 
     attr_reader :context
@@ -48,36 +47,21 @@ module Props
 
       keys.each do |k|
         ckey = key_to_ckey[k]
-        result[k] = read_caches[ckey]
+
+        if read_caches[ckey]
+          result[k] = read_caches[ckey]
+        end
       end
 
       result
     end
 
-    def multi_fetch_and_add_results(all_options)
-      first_opts = all_options[0]
-
-      if first_opts[:cache] && controller.perform_caching
-        keys = all_options.map { |i| i[:cache][0] }
-        c_opts = first_opts[:cache][1]
-        result = multi_fetch(keys, c_opts)
-
-        all_options.map do |opts|
-          key = opts[:cache][0]
-
-          if result.key? key
-            opts[:cache][1][:result] = result[key]
-          end
-
-          opts
-        end
-      else
-        all_options
-      end
+    def load_cache(keys, options = {})
+      @results = results.merge multi_fetch(keys, options)
     end
 
-    # Copied from jbuilder
-    #
+    # The below was copied from the wonderful jbuilder library Its also MIT
+    # licensed, so no issues there.  Thanks to the jbuilder authors!
 
     def cache(key = nil, options = {})
       if controller.perform_caching
@@ -90,10 +74,9 @@ module Props
     end
 
     def cache_fragment_for(key, options, &block)
-      key = cache_key(key, options)
-
-      return options[:result] if options[:result]
+      return results[key] if results[key]
 
+      key = cache_key(key, options)
       read_fragment_cache(key, options) || write_fragment_cache(key, options, &block)
     end
 

data/lib/props_template/extensions/deferment.rb

@@ -13,37 +13,27 @@ module Props
     end
 
     def refine_options(options, item = nil)
-      return options if !options[:defer]
-      pass_opts = options.clone
-
-      type, rest = [*options[:defer]]
-      rest ||= {
-        placeholder: {}
-      }
-
-      if item
-        type = (Proc === type) ? type.call(item) : type
-      end
-
-      if type
-        pass_opts[:defer] = [type, rest]
-      else
-        pass_opts.delete(:defer)
-      end
+      options.clone
+    end
 
-      pass_opts
+    def extract_deferment_type(options, item)
+      type, _ = [*options[:defer]]
+      (Proc === type) ? type.call(item) : type
     end
 
-    def handle(options)
+    def handle(options, type, key, val)
       return if !options[:defer]
 
-      type, rest = options[:defer]
+      _, rest = [*options[:defer]]
+      rest ||= {
+        placeholder: {}
+      }
+
       placeholder = rest[:placeholder]
       success_action = rest[:success_action]
       fail_action = rest[:fail_action]
 
-      if type.to_sym == :auto && options[:key]
-        key, val = options[:key]
+      if type.to_sym == :auto && key && val
         placeholder = {}
         placeholder[key] = val
       end

data/lib/props_template/extensions/fragment.rb

@@ -7,7 +7,7 @@ module Props
       @fragments = fragments
     end
 
-    def self.fragment_name_from_options(options)
+    def self.fragment_name_from_options(options, item = nil)
       return if !options[:partial]
 
       _, partial_opts = [*options[:partial]]
@@ -15,13 +15,17 @@ module Props
 
       fragment = partial_opts[:fragment]
 
+      if item && ::Proc === fragment
+        fragment = fragment.call(item)
+      end
+
       if String === fragment || Symbol === fragment
         fragment.to_s
       end
     end
 
-    def handle(options)
-      fragment_name = self.class.fragment_name_from_options(options)
+    def handle(options, item_context = nil)
+      fragment_name = self.class.fragment_name_from_options(options, item_context)
       path = @base.traveled_path
         .map { |item| item.is_a?(Array) ? item[0] : item }
         .join(".")

data/lib/props_template/extensions/partial_renderer.rb

@@ -45,22 +45,6 @@ module Props
       end
     end
 
-    def find_and_add_template(all_options)
-      first_opts = all_options[0]
-
-      if first_opts[:partial]
-        partial_opts = block_opts_to_render_opts(@builder, first_opts)
-        template = find_template(partial_opts)
-
-        all_options.map do |opts|
-          opts[:_template] = template
-          opts
-        end
-      else
-        all_options
-      end
-    end
-
     def find_template(partial_opts)
       partial = partial_opts[:partial]
       template_keys = retrieve_template_keys(partial_opts)
@@ -78,7 +62,7 @@ module Props
 
     def block_opts_to_render_opts(builder, options)
       partial, pass_opts = [*options[:partial]]
-      pass_opts ||= {}
+      pass_opts = pass_opts&.clone || {}
       pass_opts[:locals] ||= {}
       pass_opts[:partial] = partial
       pass_opts[:formats] = [:json]
@@ -91,9 +75,17 @@ module Props
       pass_opts
     end
 
-    def handle(options)
-      partial_opts = block_opts_to_render_opts(@builder, options)
-      template = options[:_template] || find_template(partial_opts)
+    def handle(options, item = nil)
+      return options if !options[:partial]
+
+      normalized_options = normalize_options(options, item)
+      partial_opts = block_opts_to_render_opts(@builder, normalized_options)
+      template = if options[:_template]
+        options[:_template]
+      else
+        # mutate the original options to bypass find_template a second time.
+        options[:_template] = find_template(partial_opts)
+      end
 
       render_partial(template, @context, partial_opts)
     end
@@ -133,8 +125,10 @@ module Props
     end
 
     def refine_options(options, item = nil)
-      return options if !options[:partial]
+      options.clone
+    end
 
+    def normalize_options(options, item = nil)
       partial, rest = [*options[:partial]]
       rest = (rest || {}).clone
       locals = (rest[:locals] || {}).clone
@@ -150,20 +144,9 @@ module Props
         raise_invalid_option_as(as) unless /\A[a-z_]\w*\z/.match?(as.to_s)
 
         locals[as] = item
-
-        if (fragment_name = rest[:fragment])
-          if item && ::Proc === fragment_name
-            fragment_name = fragment_name.call(item)
-          end
-
-          rest[:fragment] = fragment_name.to_s
-        end
       end
 
-      pass_opts = options.clone
-      pass_opts[:partial] = [partial, rest]
-
-      pass_opts
+      {partial: [partial, rest]}
     end
   end
 end

data/lib/props_template/searcher.rb

@@ -12,6 +12,7 @@ module Props
       @traveled_path = []
       @partialer = Partialer.new(self, context, builder)
       @fragment_name = nil
+      @found_item = nil
     end
 
     def deferred!
@@ -30,7 +31,7 @@ module Props
         pass_opts[:path_suffix] = traveled_path
       end
 
-      fragment_name = Fragment.fragment_name_from_options(pass_opts)
+      fragment_name = Fragment.fragment_name_from_options(pass_opts, @found_item)
       if fragment_name
         @fragment_name = fragment_name
         @fragment_path = @traveled_path.clone
@@ -38,7 +39,7 @@ module Props
 
       fragment_context = @fragment_name
 
-      [@found_block, @traveled_path, pass_opts, @fragment_path, fragment_context]
+      [@found_block, @traveled_path, pass_opts, @fragment_path, fragment_context, @found_item]
     end
 
     def set_content!(*args)
@@ -97,21 +98,11 @@ module Props
 
         if item
           pass_opts = @partialer.refine_options(options, item)
-
-          if (key = pass_opts[:key])
-            val = if item.respond_to? key
-              item.send(key)
-            elsif item.is_a? Hash
-              item[key] || item[key.to_sym]
-            end
-
-            pass_opts[:key] = [pass_opts[:key], val]
-          end
-
           @traveled_path.push(key_index)
 
           if @depth == @search_path.size - 1
             @found_options = pass_opts
+            @found_item = item
             @found_block = proc {
               yield item, 0
             }
@@ -120,7 +111,7 @@ module Props
 
           @depth += 1
           if pass_opts[:partial]
-            fragment_name = Fragment.fragment_name_from_options(pass_opts)
+            fragment_name = Fragment.fragment_name_from_options(pass_opts, item)
             if fragment_name
               @fragment_name = fragment_name
               @fragment_path = @traveled_path.clone

data/lib/props_template/test.md

@@ -0,0 +1,28 @@
+array
+handle_collection
+  all_opts = collection.map do |item|
+    refine_item_options(item, options)
+  end
+  creates clone of the opts using 
+  refine_item_options clones original options
+    then subsequently the ext refine_item_options
+    gets called first, 
+
+  refine_all_item_options <- operates on the entire collection
+
+  handle_collection_item
+    set_content options
+
+
+ 
+base with ExtensionManager
+    refine_all_item_options - overrided with ext manager
+      - which attahes a _template with partialer
+       to it AND multifetch and attaches it to cache
+       as [key, result]
+
+    refine_item_options
+      - transforms key: :id to key = [key, val]
+      - passes to refine_options
+          which is then asks the searcher the cache and
+          deferment to mutate the option

data/lib/props_template/version.rb

@@ -1,3 +1,3 @@
 module Props
-  VERSION = "1.0.0.alpha.4".freeze
+  VERSION = "1.0.0".freeze
 end

data/lib/props_template.rb

@@ -53,13 +53,14 @@ module Props
         options.delete(:dig)
 
         @builder.set!(key, options, &block)
-        found_block, found_path, found_options, fragment_path, fragment_context = @builder.found!
+        found_block, found_path, found_options, fragment_path, fragment_context, found_item = @builder.found!
         @found_path = found_path || []
         @fragment_context = fragment_context
         @builder = prev_builder
         @fragment_path = fragment_path
 
         if found_block
+          @builder.item_context = found_item
           set!(key, found_options, &found_block)
         end
       else

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: props_template
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Johny Ho
@@ -89,6 +89,7 @@ files:
 - lib/props_template/partial_patch.rb
 - lib/props_template/railtie.rb
 - lib/props_template/searcher.rb
+- lib/props_template/test.md
 - lib/props_template/version.rb
 homepage: https://github.com/thoughtbot/props_template/
 licenses:
@@ -101,7 +102,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="